-
Notifications
You must be signed in to change notification settings - Fork 66
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.
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
Define trait and extension for adding x-
properties to openapi output
#73
Define trait and extension for adding x-
properties to openapi output
#73
Conversation
instead of |
Or [1] https://swagger.io/docs/specification/openapi-extensions/ |
or |
245b365
to
418a025
Compare
@@ -7,6 +7,8 @@ | |||
$version: "2" | |||
namespace OpenSearch | |||
|
|||
use opensearch.openapi#openApiVendorExtensions |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@nhtruong sorry, just want to hear your thoughts since Smithy is not my thing, BUT wouldn't use opensearch.openapi#
already imply that those are vendor extensions for OpenAPI?
use opensearch.openapi#vendorExtensions
That would be pretty clean, no?
418a025
to
9f4dd74
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! Is this something we can document may be in this repo's developer guide?
…tput Signed-off-by: Thomas Farr <tsfarr@amazon.com>
Signed-off-by: Thomas Farr <tsfarr@amazon.com>
9f4dd74
to
87bfc29
Compare
Description
Defines a custom trait and extension to the OpenAPI converter, to allow adding
x-
properties to schemas and operations in the OpenAPI output.For example:
Results in:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.