Skip to content

Commit

Permalink
Fix collection and gradle doc issues
Browse files Browse the repository at this point in the history
  • Loading branch information
mtdowling committed Aug 27, 2019
1 parent fe4830a commit 23a72a1
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 12 deletions.
16 changes: 8 additions & 8 deletions docs/source/guides/building-models/gradle-plugin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The following example configures a project to use the Smithy Gradle plugin:

plugins {
java
id("software.amazon.smithy").version("0.4.0")
id("software.amazon.smithy").version("0.3.0")
}


Expand Down Expand Up @@ -140,7 +140,7 @@ The following example ``build.gradle.kts`` will build a Smithy model using a

plugins {
java
id("software.amazon.smithy").version("0.4.0")
id("software.amazon.smithy").version("0.3.0")
}

// The SmithyExtension is used to customize the build. This example
Expand All @@ -153,12 +153,12 @@ The following example ``build.gradle.kts`` will build a Smithy model using a
}

dependencies {
api("software.amazon.smithy:smithy-model:0.9.2")
implementation("software.amazon.smithy:smithy-model:0.9.2")

// These are just examples of dependencies. This model has a dependency on
// a "common" model package and uses the external AWS traits.
api("com.foo.baz:foo-model-internal-common:1.0.0")
api("software.amazon.smithy:smithy-aws-traits:0.4.0")
implementation("com.foo.baz:foo-model-internal-common:1.0.0")
implementation("software.amazon.smithy:smithy-aws-traits:0.4.0")
}


Expand Down Expand Up @@ -187,7 +187,7 @@ build that uses the "external" projection.

plugins {
java
id("software.amazon.smithy").version("0.4.0")
id("software.amazon.smithy").version("0.3.0")
}

buildscript {
Expand Down Expand Up @@ -220,12 +220,12 @@ build that uses the "external" projection.
}

dependencies {
api("software.amazon.smithy:smithy-model:0.9.2")
implementation("software.amazon.smithy:smithy-model:0.9.2")

// Any dependencies that the projected model needs must be (re)declared
// here. For example, let's assume that the smithy-aws-traits package is
// needed in the projected model too.
api("software.amazon.smithy:smithy-aws-traits:0.4.0")
implementation("software.amazon.smithy:smithy-aws-traits:0.4.0")
}


Expand Down
7 changes: 3 additions & 4 deletions docs/source/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -417,7 +417,7 @@ cities, so there's no way we could provide a City identifier.
// return truncated results. Applying this trait to the service
// sets default pagination configuration settings on each operation.
@paginated(items: "items")
@readonly @collection
@readonly
operation ListCities(ListCitiesInput) -> ListCitiesOutput

structure ListCitiesInput {
Expand Down Expand Up @@ -683,7 +683,7 @@ Complete example

// The paginated trait indicates that the operation may
// return truncated results.
@readonly @collection
@readonly
@paginated(items: "items")
operation ListCities(ListCitiesInput) -> ListCitiesOutput

Expand Down Expand Up @@ -881,8 +881,7 @@ Complete example
"input":"ListCitiesInput",
"output":"ListCitiesOutput",
"paginated": {"items":"items"},
"readonly":true,
"collection":true
"readonly":true
},
"ListCitiesInput": {
"type":"structure",
Expand Down

0 comments on commit 23a72a1

Please sign in to comment.