UNPKG

fastify-oas

Version:

Fastify OpenAPI specification generator plugin

430 lines (221 loc) 16.8 kB
# Changelog All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. ### [3.0.8](https://gitlab.com/m03geek/fastify-oas/compare/v3.0.7...v3.0.8) (2020-12-06) ### Misc * use node 14 ([afa51f6](https://gitlab.com/m03geek/fastify-oas/commit/afa51f6f3104e767c83fb5868a26b8f9bb3c7669)) ### [3.0.7](https://gitlab.com/m03geek/fastify-oas/compare/v3.0.6...v3.0.7) (2020-12-06) ### Misc * disable non working test ([11a8d57](https://gitlab.com/m03geek/fastify-oas/commit/11a8d57e8a3110aaf5f807c25ddca3b7a3559e40)) ### [3.0.6](https://gitlab.com/m03geek/fastify-oas/compare/v3.0.5...v3.0.6) (2020-12-06) ### Misc * remove husky ([324d08f](https://gitlab.com/m03geek/fastify-oas/commit/324d08f78d594c29108c4e5ea069402b086987b6)) ### [3.0.5](https://gitlab.com/m03geek/fastify-oas/compare/v3.0.4...v3.0.5) (2020-12-06) ### Bug Fixes - stupid hasky downgrade ([76aeb78](https://gitlab.com/m03geek/fastify-oas/commit/76aeb78d788db4720feef5aaa6bd3f22febcf24b)) ### [3.0.4](https://gitlab.com/m03geek/fastify-oas/compare/v3.0.3...v3.0.4) (2020-12-06) ### Bug Fixes - bump swagger-ui-dist to 3.36.1 ([9fecca7](https://gitlab.com/m03geek/fastify-oas/commit/9fecca7e05d74f23427a7d3e1c9a7205c0d72502)) - bump swagger-ui-dist to 3.37.2 ([a8d9119](https://gitlab.com/m03geek/fastify-oas/commit/a8d91190095f5b4ffba198d1d859b197afb234d5)) - children.length type error ([c579091](https://gitlab.com/m03geek/fastify-oas/commit/c579091d572b1c4e4456ef64366e5bcdbcf5eaef)) - redoc complains on csp violation ([6460989](https://gitlab.com/m03geek/fastify-oas/commit/6460989e45bba9f3d3379802086388eee5c85faa)) - strip item objects of non-allowed props ([2be1b07](https://gitlab.com/m03geek/fastify-oas/commit/2be1b07ccface79f630ba4dbd701a1ff600b303c)), closes [#54](https://gitlab.com/m03geek/fastify-oas/issues/54) ### Misc - **deps:** bump ([2d9ed4d](https://gitlab.com/m03geek/fastify-oas/commit/2d9ed4d3b30e0196b885a335bb9fa62466d16c84)) ### [3.0.3](https://gitlab.com/m03geek/fastify-oas/compare/v3.0.2...v3.0.3) (2020-08-25) ### Style - **lint:** apply linter ([e605e39](https://gitlab.com/m03geek/fastify-oas/commit/e605e39bb8251e24dc722461a9cb191283df14ea)) ### [3.0.2](https://gitlab.com/m03geek/fastify-oas/compare/v3.0.1...v3.0.2) (2020-08-20) ### Bug Fixes - add support for url parameters ([6c336e4](https://gitlab.com/m03geek/fastify-oas/commit/6c336e4bb1e1ad316dae96465bb84027857b3783)) - added test for url parameters in genPaths ([6a19600](https://gitlab.com/m03geek/fastify-oas/commit/6a1960085a674303d9084e2b4e8ce4f868f0a784)) ### [3.0.1](https://gitlab.com/m03geek/fastify-oas/compare/v3.0.0...v3.0.1) (2020-08-15) ### Bug Fixes - fixed a typo in constructor.js (getPath → getQuery) ([a7bb0fd](https://gitlab.com/m03geek/fastify-oas/commit/a7bb0fd42ecb032901d0ebb2ab2d26199751f035)) ### Misc - **deps:** update ([f209e38](https://gitlab.com/m03geek/fastify-oas/commit/f209e384a2834babd24ac3c6e57d42a15c3c2926)) ## [3.0.0](https://gitlab.com/m03geek/fastify-oas/compare/v2.7.2...v3.0.0) (2020-08-05) ### Misc - lock update ([ea2207c](https://gitlab.com/m03geek/fastify-oas/commit/ea2207c5fc8a506e3f4bc93af3757d1271c42813)) - **deps:** update ([a4afb9c](https://gitlab.com/m03geek/fastify-oas/commit/a4afb9c7683330e2b47dc1713a89cbc5036a6c76)) ## [3.0.0-rc.3](https://gitlab.com/m03geek/fastify-oas/compare/v3.0.0-rc.2...v3.0.0-rc.3) (2020-07-08) ### Style - lint fix ([6fd4d00](https://gitlab.com/m03geek/fastify-oas/commit/6fd4d00b6353dea0d3fb5e4693b13b00e54ec17f)) ### Misc - **release:** 3.0.0-rc.3 ([94c245d](https://gitlab.com/m03geek/fastify-oas/commit/94c245d7d26a249478c8d44c41d33df58b71bcd3)) ## [3.0.0-rc.2](https://gitlab.com/m03geek/fastify-oas/compare/v3.0.0-rc.1...v3.0.0-rc.2) (2020-05-22) ### Bug Fixes - remove node 8 support ([a325e0b](https://gitlab.com/m03geek/fastify-oas/commit/a325e0b8d572e00e2775aa2d773424809320e557)) ### Misc - **release:** 3.0.0-rc.2 ([417649e](https://gitlab.com/m03geek/fastify-oas/commit/417649eed4c58d7a15b01dcb9e4194dbfb1cb93d)) ## [3.0.0-rc.1](https://gitlab.com/m03geek/fastify-oas/compare/v3.0.0-rc.0...v3.0.0-rc.1) (2020-05-22) ### Features - quick and dirty fix for refs ([18077fa](https://gitlab.com/m03geek/fastify-oas/commit/18077fa28067f6d0258c11261f9be9592b3e5518)) ### Bug Fixes - **lint:** linter fix ([60e8f04](https://gitlab.com/m03geek/fastify-oas/commit/60e8f045eccbc2d055046d3a11e103cd5bc87168)) - test and types fix ([19b5268](https://gitlab.com/m03geek/fastify-oas/commit/19b5268c621c6693788fd1f067246e53516c06ce)) ### Misc - **release:** 3.0.0-rc.1 ([97c611f](https://gitlab.com/m03geek/fastify-oas/commit/97c611f3beb8bdf16dfdfa04701fd06ffc9ee9c1)) ## [3.0.0-rc.0](https://gitlab.com/m03geek/fastify-oas/compare/v2.7.0...v3.0.0-rc.0) (2020-05-03) ### ⚠ BREAKING CHANGES - **fastify:** fastify 3.0 support ### Features - **fastify:** allow fastify 3.0 ([3b0ab5f](https://gitlab.com/m03geek/fastify-oas/commit/3b0ab5f6dd80a1e9e6c0d4b2ee932946a67a3ff9)) ### Misc - **release:** 3.0.0-rc.0 ([166f30f](https://gitlab.com/m03geek/fastify-oas/commit/166f30fb5c7810405f4c8340b0729ab02c93a0ab)) ### [2.7.2](https://gitlab.com/m03geek/fastify-oas/compare/v2.7.1...v2.7.2) (2020-08-05) ### [2.7.1](https://gitlab.com/m03geek/fastify-oas/compare/v2.7.0...v2.7.1) (2020-07-08) ### Bug Fixes - Use in body or in response ([fdfc738](https://gitlab.com/m03geek/fastify-oas/commit/fdfc73886db44899918b6590dc101fb55c614eb1)) ## [2.7.0](https://gitlab.com/m03geek/fastify-oas/compare/v2.6.2...v2.7.0) (2020-05-03) ## [3.0.0-rc.2](https://gitlab.com/m03geek/fastify-oas/compare/v3.0.0-rc.1...v3.0.0-rc.2) (2020-05-22) ### Bug Fixes - remove node 8 support ([a325e0b](https://gitlab.com/m03geek/fastify-oas/commit/a325e0b8d572e00e2775aa2d773424809320e557)) ## [3.0.0-rc.1](https://gitlab.com/m03geek/fastify-oas/compare/v3.0.0-rc.0...v3.0.0-rc.1) (2020-05-22) ### Features - quick and dirty fix for refs ([18077fa](https://gitlab.com/m03geek/fastify-oas/commit/18077fa28067f6d0258c11261f9be9592b3e5518)) ### Bug Fixes - **lint:** linter fix ([60e8f04](https://gitlab.com/m03geek/fastify-oas/commit/60e8f045eccbc2d055046d3a11e103cd5bc87168)) - test and types fix ([19b5268](https://gitlab.com/m03geek/fastify-oas/commit/19b5268c621c6693788fd1f067246e53516c06ce)) ## [2.7.0](https://gitlab.com/m03geek/fastify-oas/compare/v2.6.2...v2.7.0) (2020-05-03) ### Features - extended doc options ([65df4ea](https://gitlab.com/m03geek/fastify-oas/commit/65df4eab8136ab820a0e98890567d5971b49008c)) ### Bug Fixes - redirect fix ([6ca211b](https://gitlab.com/m03geek/fastify-oas/commit/6ca211bbc67c10b5884f32a5b830a064f47e4276)) ### [2.6.2](https://gitlab.com/m03geek/fastify-oas/compare/v2.6.1...v2.6.2) (2020-03-28) ### Bug Fixes - node 8 compat ([6ea4a05](https://gitlab.com/m03geek/fastify-oas/commit/6ea4a0554a420ef9ff0b8b01959dabb67421b514)) ### [2.6.1](https://gitlab.com/m03geek/fastify-oas/compare/v2.6.0...v2.6.1) (2020-03-28) ### Bug Fixes - **ts:** fix types ([9e4d612](https://gitlab.com/m03geek/fastify-oas/commit/9e4d6122ecb318627c9ed2fe229c946feca0e5a5)) ## [2.6.0](https://gitlab.com/m03geek/fastify-oas/compare/v2.5.2...v2.6.0) (2020-03-28) ### Features - allow inclusion of 'examples' keyword ([59fbdd7](https://gitlab.com/m03geek/fastify-oas/commit/59fbdd7e08ae1d28e66d2a39b191f1a7179bc516)), closes [#26](https://gitlab.com/m03geek/fastify-oas/issues/26) ### [2.5.2](https://gitlab.com/m03geek/fastify-oas/compare/v2.5.1...v2.5.2) (2020-02-24) ### Bug Fixes - **deps:** fix fastify working versions ([fbfccc1](https://gitlab.com/m03geek/fastify-oas/commit/fbfccc1eca1c2cfff46a2ffea525ab140d0487d7)) ### [2.5.1](https://gitlab.com/m03geek/fastify-oas/compare/v2.5.0...v2.5.1) (2020-02-18) ### Bug Fixes - add null check ([6d22653](https://gitlab.com/m03geek/fastify-oas/commit/6d22653)) ## [2.5.0](https://gitlab.com/m03geek/fastify-oas/compare/v2.4.0...v2.5.0) (2019-10-31) ### Features - **openapi:** support \$ref-way style shared schema references ([d401740](https://gitlab.com/m03geek/fastify-oas/commit/d401740)) ## [2.4.0](https://gitlab.com/m03geek/fastify-oas/compare/v2.3.3...v2.4.0) (2019-10-21) ### Features - **openapi:** collect fastify schemas recursively ([6c47a88](https://gitlab.com/m03geek/fastify-oas/commit/6c47a88)) ### [2.3.3](https://gitlab.com/m03geek/fastify-oas/compare/v2.3.2...v2.3.3) (2019-09-11) ### [2.3.2](https://gitlab.com/m03geek/fastify-oas/compare/v2.3.1...v2.3.2) (2019-09-11) ### Bug Fixes - **typescript:** move some exported members to deps ([63cfb9c](https://gitlab.com/m03geek/fastify-oas/commit/63cfb9c)) ### [2.3.1](https://gitlab.com/m03geek/fastify-oas/compare/v2.3.0...v2.3.1) (2019-07-15) ## [2.3.0](https://gitlab.com/m03geek/fastify-oas/compare/v2.2.0...v2.3.0) (2019-07-15) ### Features - **openapi:** return default response for empty schema ([0d9457b](https://gitlab.com/m03geek/fastify-oas/commit/0d9457b)) ### Tests - **openapi:** fix openapi spec compatibility ([0ab6314](https://gitlab.com/m03geek/fastify-oas/commit/0ab6314)) ## [2.2.0](https://gitlab.com/m03geek/fastify-oas/compare/v2.1.3...v2.2.0) (2019-06-18) ### Features - **openapi:** convert multiple and nullable types to OpenAPI ([34f9d47](https://gitlab.com/m03geek/fastify-oas/commit/34f9d47)) ## [2.1.3](https://gitlab.com/m03geek/fastify-oas/compare/v2.1.2...v2.1.3) (2019-04-17) ## [2.1.2](https://gitlab.com/m03geek/fastify-oas/compare/v2.1.1...v2.1.2) (2019-04-12) ## [2.1.1](https://gitlab.com/m03geek/fastify-oas/compare/v2.1.0...v2.1.1) (2019-04-12) ### Bug Fixes - package.json & package-lock.json to reduce vulnerabilities ([8d5a453](https://gitlab.com/m03geek/fastify-oas/commit/8d5a453)) - **swagger:** add operationId support ([9ef427a](https://gitlab.com/m03geek/fastify-oas/commit/9ef427a)) # [2.1.0](https://gitlab.com/m03geek/fastify-oas/compare/v2.0.0...v2.1.0) (2019-04-01) ### Features - **openapi:** add style and explode support ([25f2f98](https://gitlab.com/m03geek/fastify-oas/commit/25f2f98)) # [2.0.0](https://gitlab.com/m03geek/fastify-oas/compare/v2.0.0-rc.4...v2.0.0) (2019-02-26) <a name="2.0.0-rc.4"></a> # [2.0.0-rc.4](https://gitlab.com/m03geek/fastify-oas/compare/v2.0.0-rc.3...v2.0.0-rc.4) (2019-01-23) ### Bug Fixes - **types:** typo fix ([ff9858e](https://gitlab.com/m03geek/fastify-oas/commit/ff9858e)) <a name="2.0.0-rc.3"></a> # [2.0.0-rc.3](https://gitlab.com/m03geek/fastify-oas/compare/v2.0.0-rc.2...v2.0.0-rc.3) (2019-01-14) ### Bug Fixes - add pattern to valid params ([9e8b766](https://gitlab.com/m03geek/fastify-oas/commit/9e8b766)) ### Features - Support operationId ([cbbda88](https://gitlab.com/m03geek/fastify-oas/commit/cbbda88)) <a name="2.0.0-rc.2"></a> # [2.0.0-rc.2](https://gitlab.com/m03geek/fastify-oas/compare/v2.0.0-rc.1...v2.0.0-rc.2) (2018-12-26) <a name="2.0.0-rc.1"></a> # [2.0.0-rc.1](https://gitlab.com/m03geek/fastify-oas/compare/v2.0.0-rc.0...v2.0.0-rc.1) (2018-12-26) ### Bug Fixes - **plugin:** proper plugin version check ([b906898](https://gitlab.com/m03geek/fastify-oas/commit/b906898)) <a name="2.0.0-rc.0"></a> # [2.0.0-rc.0](https://gitlab.com/m03geek/fastify-oas/compare/v1.1.1...v2.0.0-rc.0) (2018-12-26) ### Features - add fastify v2 support ([450fd7b](https://gitlab.com/m03geek/fastify-oas/commit/450fd7b)) ### BREAKING CHANGES - drop fastify v1 support ## [1.1.1](https://gitlab.com/m03geek/fastify-oas/compare/v1.1.0...v1.1.1) (2018-12-17) ### Bug Fixes - remove console.log ([ce1dc54](https://gitlab.com/m03geek/fastify-oas/commit/ce1dc54)) # [1.1.0](https://gitlab.com/m03geek/fastify-oas/compare/v1.0.0...v1.1.0) (2018-12-17) ### Features - add hideUntagged option ([8d7f4e5](https://gitlab.com/m03geek/fastify-oas/commit/8d7f4e5)) # [1.0.0](https://gitlab.com/m03geek/fastify-oas/compare/v0.6.2...v1.0.0) (2018-12-16) ### Bug Fixes - **redoc:** add tagGroups support ([be728e1](https://gitlab.com/m03geek/fastify-oas/commit/be728e1)) - **swagger:** add title support ([75530a8](https://gitlab.com/m03geek/fastify-oas/commit/75530a8)) ### Features - **docs:** add notice about fastify version support ([dc73245](https://gitlab.com/m03geek/fastify-oas/commit/dc73245)) ## [0.6.2](https://gitlab.com/m03geek/fastify-oas/compare/v0.6.1...v0.6.2) (2018-11-22) ### Bug Fixes - **body:** required params fix ([590e219](https://gitlab.com/m03geek/fastify-oas/commit/590e219)) ## [0.6.1](https://gitlab.com/m03geek/fastify-oas/compare/v0.6.0...v0.6.1) (2018-11-16) # [0.6.0](https://gitlab.com/m03geek/fastify-oas/compare/v0.5.3...v0.6.0) (2018-11-08) ### Features - add redoc ([7508231](https://gitlab.com/m03geek/fastify-oas/commit/7508231)) ## [0.5.3](https://gitlab.com/m03geek/fastify-oas/compare/v0.5.2...v0.5.3) (2018-10-31) ### Bug Fixes - **typescript:** typings fix ([ed7a237](https://gitlab.com/m03geek/fastify-oas/commit/ed7a237)) ## [0.5.2](https://gitlab.com/m03geek/fastify-oas/compare/v0.5.1...v0.5.2) (2018-10-31) ## [0.5.1](https://gitlab.com/m03geek/fastify-oas/compare/v0.5.0...v0.5.1) (2018-10-31) ### Bug Fixes - **typedoc:** fix typedocs ([7993a36](https://gitlab.com/m03geek/fastify-oas/commit/7993a36)) # [0.5.0](https://gitlab.com/m03geek/fastify-oas/compare/v0.4.9...v0.5.0) (2018-10-31) ### Features - add typescript definitions and typedocs ([6ce96d1](https://gitlab.com/m03geek/fastify-oas/commit/6ce96d1)) ## [0.4.9](https://gitlab.com/m03geek/fastify-oas/compare/v0.4.8...v0.4.9) (2018-10-17) ## [0.4.8](https://gitlab.com/m03geek/fastify-oas/compare/v0.4.7...v0.4.8) (2018-09-25) ## [0.4.7](https://gitlab.com/m03geek/fastify-oas/compare/v0.4.6...v0.4.7) (2018-09-25) ## [0.4.6](https://gitlab.com/m03geek/fastify-oas/compare/v0.4.5...v0.4.6) (2018-08-12) ### Bug Fixes - **changelog:** fix changelog links ([59a0053](https://gitlab.com/m03geek/fastify-oas/commit/59a0053)) ## [0.4.5](https://gitlab.com/m03geek/fastify-oas/compare/v0.4.4...v0.4.5) (2018-08-12) ### Bug Fixes - **helpers:** fix enum handling ([bfc483c](https://gitlab.com/m03geek/fastify-oas/commit/bfc483c)), closes [#3](https://gitlab.com/m03geek/fastify-oas/issues/3) ## [0.4.4](https://gitlab.com/m03geek/fastify-oas/compare/v0.4.3...v0.4.4) (2018-08-06) ### Bug Fixes - **schema:** use schemaKey if \$id is missing ([1ac51eb](https://gitlab.com/m03geek/fastify-oas/commit/1ac51eb)) ## [0.4.3](https://gitlab.com/m03geek/fastify-oas/compare/v0.4.2...v0.4.3) (2018-08-06) ### Bug Fixes - **schemas:** fix add schemas as models ([942e9ce](https://gitlab.com/m03geek/fastify-oas/commit/942e9ce)) ## [0.4.2](https://gitlab.com/m03geek/fastify-oas/compare/v0.4.1...v0.4.2) (2018-08-06) ### Bug Fixes - **routes:** fix routes with separate schemas ([d132258](https://gitlab.com/m03geek/fastify-oas/commit/d132258)) - **schemas:** fix schemas generation ([82e4fbc](https://gitlab.com/m03geek/fastify-oas/commit/82e4fbc)) ## [0.4.1](https://gitlab.com/m03geek/fastify-oas/compare/v0.4.0...v0.4.1) (2018-08-05) # [0.4.0](https://gitlab.com/m03geek/fastify-oas/compare/v0.3.8...v0.4.0) (2018-08-05) ## [0.3.8](https://gitlab.com/m03geek/fastify-oas/compare/v0.3.7...v0.3.8) (2018-08-04) ## [0.3.7](https://gitlab.com/m03geek/fastify-oas/compare/v0.3.6...v0.3.7) (2018-08-04) ### Bug Fixes - package name ([309d254](https://gitlab.com/m03geek/fastify-oas/commit/309d254)) ## [0.3.6](https://gitlab.com/m03geek/fastify-oas/compare/v0.3.5...v0.3.6) (2018-08-04) ## [0.3.5](https://gitlab.com/m03geek/fastify-oas/compare/v0.3.4...v0.3.5) (2018-08-04) ## [0.3.4](https://gitlab.com/m03geek/fastify-oas/compare/v0.3.3...v0.3.4) (2018-08-03) ## [0.3.3](https://gitlab.com/m03geek/fastify-oas/compare/v0.3.2...v0.3.3) (2018-08-03) ## [0.3.2](https://gitlab.com/m03geek/fastify-oas/compare/v0.3.1...v0.3.2) (2018-08-03) ## [0.3.1](https://gitlab.com/m03geek/fastify-oas/compare/v0.3.0...v0.3.1) (2018-08-03) # [0.3.0](https://gitlab.com/m03geek/fastify-oas/compare/v0.2.0...v0.3.0) (2018-08-03) ### Bug Fixes - response and body generation ([4640cfc](https://gitlab.com/m03geek/fastify-oas/commit/4640cfc)) ### Features - add externalDocs and tags support ([2335359](https://gitlab.com/m03geek/fastify-oas/commit/2335359)) # [0.2.0](https://gitlab.com/m03geek/fastify-oas/compare/cfe110c...v0.2.0) (2018-07-28) ### Features - add helpers for oas ([54d4d33](https://gitlab.com/m03geek/fastify-oas/commit/54d4d33)) - add main file ([4f70f99](https://gitlab.com/m03geek/fastify-oas/commit/4f70f99)) - add openapi generator ([862561a](https://gitlab.com/m03geek/fastify-oas/commit/862561a)) - add swagger routes ([cb959fb](https://gitlab.com/m03geek/fastify-oas/commit/cb959fb)) - add swagger ui ([cfe110c](https://gitlab.com/m03geek/fastify-oas/commit/cfe110c))