Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add example of dependency for openapi plugin #594

Merged
merged 1 commit into from
Oct 13, 2020
Merged

Add example of dependency for openapi plugin #594

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/source/1.0/guides/converting-to-openapi.rst
View file
Open in desktop
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 {
srchase marked this conversation as resolved.
Show resolved Hide resolved
// 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