Skip to content

Commit

Permalink
Add example of dependency for openapi plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
Chase Coalwell authored and srchase committed Oct 13, 2020
1 parent 8c07e24 commit 85f9dd4
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/source/1.0/guides/converting-to-openapi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -121,9 +121,18 @@ specification from a Smithy model using a buildscript dependency:
buildscript {
dependencies {
classpath("software.amazon.smithy:smithy-openapi:__smithy_version__")
// The openapi plugin configured in the smithy-build.json example below
// uses the restJson1 protocol defined in the aws-traits package. This
// additional dependency must added to use that protocol.
classpath("software.amazon.smithy:smithy-aws-traits:__smithy_version__")
}
}
dependencies {
// The dependency for restJson1 is required here too.
implementation("software.amazon.smithy:smithy-aws-traits:__smithy_version__")
}
The Smithy Gradle plugin relies on a ``smithy-build.json`` file found at the
root of a project to define the actual process of building the OpenAPI
specification. The following example defines a ``smithy-build.json`` file
Expand Down

0 comments on commit 85f9dd4

Please sign in to comment.