Serverless Aws Documentation Versions Save

Serverless 1.0 plugin to add documentation and models to the serverless generated API Gateway

v1.1.0

6 years ago

Features

  • The plugin now uses API gateway from another stack that is specified in provider.apiGateway in the serverless.yml. Thanks to @dspasojevic
  • You can now download your documentation from AWS gateway with the serverless downloadDocumentation command. Thanks to @aaleksandrov

v1.0.1

6 years ago

Fix bugs that came up with the serverless-plugin-split-stacks plugin.

v1.0.0

6 years ago

Added support for "$ref": "{{model:MyModel}}" to reference other models.

v0.8.0

6 years ago

Features

  • add support for multiple events for a single function
  • Add support for the swagger 'tags' property on methods

Special Thanks

Special thanks to @tomsaleeba for his great work of adding both features stated above ?

0.7.0

7 years ago

Features

  • remove "aws-sdk" package dependency
  • add --doc-safe-mode flag for serverless deploy command to not add the query parameters and request headers to the API Gateway CloudFormation template

Bugfixes

  • Now adds query parameters and request headers to the documentation

Breaking Changes

  • not compatible with anymore Serverless 1.3 and below

Special Thanks

Special thanks to @kabo who added the --doc-save-mode and fixed request headers in the documentation output

0.6.0

7 years ago

Features

  • generate automatic version when no version is defined
  • schema in model is now optional

0.5.7

7 years ago

Bugfixes

  • fixes bug that made it impossible to add method response documentation when there already were method responses (either just an empty array or responses that don't match the ones stated in the documentation part).

0.5.6

7 years ago

Bugfixes

  • fixes overwriting already set method responses

Thanks to @shevchenkos for the last two contributions ?

0.5.5

7 years ago

Bugfixes

  • adds response headers to method responses as response parameters

0.5.4

7 years ago

Bugfixes

  • Fixes problem with missing API ID in outputs (#9)