serverless-aws-documentation icon indicating copy to clipboard operation
serverless-aws-documentation copied to clipboard

Does this plugin support example values ?

Open agostnello opened this issue 6 years ago • 4 comments

Does this plugin support example values ? https://swagger.io/docs/specification/adding-examples/

agostnello avatar Dec 30 '18 13:12 agostnello

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

NoxHarmonium avatar Jan 10 '19 23:01 NoxHarmonium

Examples are new in draft 6 of the JSON schema, see https://json-schema.org/understanding-json-schema/reference/generic.html#annotations

OAFCROB avatar Jan 08 '20 14:01 OAFCROB

Does seem to be an issue, I get an error when I try to include

mcrobbj avatar Mar 21 '20 07:03 mcrobbj

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

chemalopezp avatar Mar 26 '20 21:03 chemalopezp