serverless-aws-documentation
serverless-aws-documentation copied to clipboard
Does this plugin support example values ?
Does this plugin support example values ? https://swagger.io/docs/specification/adding-examples/
Unless I'm mistaken, this plugin specifies the schema in the format required for AWS API Gateway, which uses JSON schema rather than Swagger (although they do look similar). JSON schemas don't seem to have support for examples so I don't think you would be able specify them in this plugin.
See: https://json-schema.org/specification.html
Examples are new in draft 6 of the JSON schema, see https://json-schema.org/understanding-json-schema/reference/generic.html#annotations
Does seem to be an issue, I get an error when I try to include
Came up with the same question, it seems API Gateway doesn't accept example
tags
https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-known-issues.html