deliveryhero / serverless-aws-documentation

Serverless 1.0 plugin to add documentation and models to the serverless generated API Gateway
MIT License
310 stars 148 forks source link

Cannot assign "example" to model types. #163

Closed niclego closed 3 years ago

niclego commented 4 years ago

I would like to be able to assign examples to model types so in swagger hub I can see an example object.

This photo is what I would expect to work in the model definition: Screen Shot 2020-10-12 at 7 53 40 PM

This photo is what I want to be able to customize in swagger hub: Screen Shot 2020-10-12 at 7 56 28 PM

I could also be doing this incorrectly.. is there a way to set these default values ( string, 0) to something else?

Thanks in advance.

nhammond101 commented 3 years ago

The example tag isn't supported by API Gateway - see https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-known-issues.html, specifically

Screenshot 2020-12-23 at 15 31 39
nhammond101 commented 3 years ago

Duplicate of #107