From 4c5bd6f123ecc680e2f6d7acaa7aeaf75a9375c1 Mon Sep 17 00:00:00 2001 From: Chase Coalwell Date: Tue, 6 Oct 2020 11:27:57 -0700 Subject: [PATCH] Add example of dependency for openapi plugin --- docs/source/1.0/guides/converting-to-openapi.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/source/1.0/guides/converting-to-openapi.rst b/docs/source/1.0/guides/converting-to-openapi.rst index 91d1c7ce090..6b0e83394de 100644 --- a/docs/source/1.0/guides/converting-to-openapi.rst +++ b/docs/source/1.0/guides/converting-to-openapi.rst @@ -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