CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

2.3.9 (2022-07-19)

• path parameter parsing bugfix

2.3.8 (2022-07-06)

• Support parameter's JSON form

2.3.7 (2022-07-06)

• Support example in queryStringParameter, pathParameter

2.3.6 (2022-07-06)

• Support snake_case column name

2.3.5 (2022-06-16)

• DESC, EXAMPLE is optional now.
• Support type extends

2.3.4 (2022-06-07)

• Update README.md file.
• Verified serverless framework version 1.61.2 or higher.

2.3.3 (2022-06-02)

Features

• Forked from serverless-auto-swagger
• Model description and example values can be configured.

2.3.0 (2022-03-10)

Features

• use lowercase http method (#53) (3c67fc1)

Bug Fixes

• change null to None for Python (#54) (447044d)

2.2.0 (2022-02-23)

Features

• add option to exclude specific stages (#46) (#47) (89335dd)
  • Example of new option: excludeStages: ['prod'] (skip deployment of swagger.json and Swagger UI in prod stage)

2.1.0 (2022-02-21)

Features

• add option to use REST API for swagger lambdas (#44) (e034ab3)
  • apiType: 'http' | 'httpApi' – defaults to httpApi if not specified

Bug Fixes

• use unique operationId per function path (#43) (d28e6af)

2.0.0 (2022-02-21)

⚠ BREAKING CHANGES

• apiKeyName no longer exists in custom configuration. Use apiKeyHeaders: ['x-api-key'] in place of apiKeyName: 'x-api-key'

Features

• add apiKeyHeaders array for multiple security headers (#35) (7b43838)

Changes

• Remove apiKeyName in favor of apiKeyHeaders (87cf65a)

1.8.0 (2022-02-17)

Features

• Update Swagger-UI to 4.5.0, Add missing icons (#32) (52118a5)

1.7.0 (2022-02-08)

⚠ BREAKING CHANGES

• schemes now defaults to the scheme used to serve the API specification if not provided (#32)

Features

• add basePath and schemes to custom config (#32) (52118a5)

Bug Fixes

• make operationId unique (#31) (f514234), closes #30

1.6.0 (2022-02-08)

1.5.1 (2022-02-05)

1.5.0 (2022-02-02)

(Contains undocumented updates from 1.4.0)

Features

• config: allow user to choose swagger path (5ceeb9c)
• exclude: allow user to exclude events (c0bbe15)
• queryStringParameters: allow user to define query string params (294926e)
• script: adding publish script to call np (4932248)
• swaggerFiles: allow user to add json openAPI 2.0 files (ba130a2)

Bug Fixes

• Add required parameter to Swagger for queryStringParameters (#20) (6a6c89d), closes #11
• types: fixing responses on http, and conflicting types in tests (138626f)

1.3.1 (2021-11-23)

1.2.0 (2021-09-29)

Features

• deployment: auto swagger works with sls deploy (8f0350b)
• initial commit: the initial commit (624e4b4)