1 | # express-openapi Changelog
|
2 | All notable changes to this project will be documented in this file.
|
3 |
|
4 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
5 | and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
6 |
|
7 | ## 6.0.0 - 2019-12-09
|
8 | ### Added
|
9 | * openapi-request-validator: Adds 'request' to errorCode (fixes #554) (#557)
|
10 |
|
11 | ### Changed
|
12 | * Request validator errors now emit pattern.openapi.requestValidation. (#557)
|
13 |
|
14 | ### Fixed
|
15 | * Reverse requestValidator and responseValidator middleware (fixes #546) (#547)
|
16 | * openapi-request-coercer: Do not throw on untyped array items (#569)
|
17 | * openapi-request-coercer: Fix some data driven test names (#575)
|
18 | * openapi-request-coercer: Fix handling of OAS 3 explode (#574)
|
19 | * openapi-request-coercer: Drop unused member (#570)
|
20 | * openapi-request-validator: Fixes circular $ref (#565)
|
21 |
|
22 | ## 5.0.0 - 2019-10-23
|
23 | ### Added
|
24 | - openapi-framework: Add support for $ref in requestBody (closes #486)
|
25 | - openapi-default-setter: Support default values from schema property in parameter objects (#551)
|
26 | - openapi-jsonschema-parameters: Added support for 'examples' (fixes #513) (#514)
|
27 | - openapi-response-validator: add 'errors' on any error (fixes #512) (#531)
|
28 |
|
29 | ### Changed
|
30 | - openapi-request-validator: renamed validate function (part of #512) (#541)
|
31 | - openapi-response-validator: removes path from message (part of #554) (#556)
|
32 |
|
33 | ### Fixed
|
34 | - Fix OperationHandlerArray (fixes #496)
|
35 | - openapi-response-validator: readme renamed instance variable (part of #512) (#527)
|
36 |
|
37 | ## 4.6.5 - 2019-07-12
|
38 | ### Fixed
|
39 | - openapi-response-validator: remove required writeOnly props from resp validation (#481)
|
40 |
|
41 | ## 4.6.4 - 2019-06-22
|
42 | ### Fixed
|
43 | - openapi-framework: Suppressing unwanted "Ignoring the 2nd definition" warnings (fixes: #368) (#479)
|
44 |
|
45 | ## 4.6.3 - 2019-06-21
|
46 | ### Fixed
|
47 | - Allow to registered errorMiddleware when exposeApiDocs is falsy (fixes #435) (#475)
|
48 | - openapi-framework: Update customFormat argument typing (#471)
|
49 | - openapi-framework: Log an improved warning if the operationId of an operation is not specified (fixes #465) (#466)
|
50 | - openapi-jsonschema-parameters: Adds example keyword (fixes #455) (#456)
|
51 | - openapi-request-validator: Accept reqBody readOnly in nested properties (#472)
|
52 |
|
53 | ## 4.6.1 - 2019-05-14
|
54 | ### Fixed
|
55 | - openapi-request-validator
|
56 | - Removing an uneeded console.log statement (#448)
|
57 |
|
58 | ## 4.6.0 - 2019-05-13
|
59 | ### Added
|
60 | - openapi-request-validator
|
61 | - Logger argument (#61)
|
62 |
|
63 | ### Fixed
|
64 | - reordering createAssignApiDocMiddleware after securityHandler (#429)
|
65 | - openapi-request-validator
|
66 | - Allowing null enums and nullable option (#433)
|
67 | accept requestBody with missing readOnly required prop (fixes #389) (#390)
|
68 | - accept reqBody RO nested ref (fixes #394)
|
69 | - Setting "useDefaults" to true on Ajv (#409)
|
70 | - openapi-response-validator
|
71 | - Correct nullable transform for null examples (fixes #413)
|
72 | - Set "useDefaults: true" on Ajv (#409)
|
73 | - openapi-types
|
74 | - Amended missing usage of PathsObject in OpenAPIV3.Document interface (#440)
|
75 |
|
76 | ## 4.5.0 - 2019-03-19
|
77 | ### Added
|
78 | - openapi-framework: args.logger (#61) (#330)
|
79 |
|
80 | ### Fixed
|
81 | - openapi-framework:
|
82 | - openapi-request-coercer: Don't coerce numbers that cannot be converted i.e. result in NaN (#371)
|
83 | - openapi-request-validator: Allow request validation without parameters (#382)
|
84 | - Set default basePath (issue #376) (#377)
|
85 |
|
86 | ## 4.4.0 - 2019-02-15
|
87 | ### Added
|
88 | - openapi-framework:
|
89 | - Dependency injection for operations (#357)
|
90 |
|
91 | ## 4.3.3 - 2019-02-12
|
92 | ### Fixed
|
93 | - openapi-framework:
|
94 | - Multiple operations in single file creating duplicate routes (#353)
|
95 |
|
96 | ## 4.3.2 - 2019-02-06
|
97 | ### Added
|
98 | - Note in README about args.operations
|
99 |
|
100 | ### Fixed
|
101 | - openapi-framework:
|
102 | - args.operations resulting in duplicate routes
|
103 |
|
104 | ## 4.3.1 - 2019-02-06
|
105 | ### Fixed
|
106 | - openapi-framework:
|
107 | - Removed string as an acceptable type for args.operations
|
108 |
|
109 | ## 4.3.0 - 2019-02-06
|
110 | ### Added
|
111 | - openapi-framework:
|
112 | - Added experimental support for args.operations (#336)
|
113 |
|
114 | ## 4.2.0 - 2019-01-31
|
115 | ### Fixed
|
116 | - openapi-framework:
|
117 | - add Logger (#61) (#322)
|
118 | - Fixes support for args.securityHandlers in OpenAPIV3 (#323)
|
119 | - openapi-types: OpenAPIV3: relax security requirement object types (#327)
|
120 | - openapi-default-setter:
|
121 | - openapi-types: OpenAPIV3: relax security requirement object types (#327)
|
122 | - openapi-request-coercer:
|
123 | - openapi-types: OpenAPIV3: relax security requirement object types (#327)
|
124 | - openapi-request-validator:
|
125 | - Handle missing or invalid 'Content-Type' (#326)
|
126 | - openapi-jsonschema-parameters:
|
127 | - openapi-types: OpenAPIV3: relax security requirement object types (#327)
|
128 | - openapi-types: OpenAPIV3: relax security requirement object types (#327)
|
129 | - openapi-response-validator:
|
130 | - Deep clone schemas before transforming nullable values. (#324)
|
131 | - Handle ?XX status codes. (#325)
|
132 | - openapi-types: OpenAPIV3: relax security requirement object types (#327)
|
133 | - openapi-schema-validator:
|
134 | - openapi-types: OpenAPIV3: relax security requirement object types (#327)
|
135 | - openapi-security-handler:
|
136 | - openapi-types: OpenAPIV3: relax security requirement object types (#327)
|
137 | - openapi-types: OpenAPIV3: relax security requirement object types (#327)
|
138 |
|
139 | ## 4.1.2 - 2019-01-22
|
140 | ### Fixed
|
141 | - openapi-framework: Allowing to set a property of BaseSchemaObject as a reference to another SchemaObject (#312)
|
142 |
|
143 | ## 4.1.0 - 2019-01-11
|
144 | ### Fixed
|
145 | - retrieving validation keywords in both root and schema attribute of a definition for all types of parameters (fixes #301)
|
146 | - pass schema definitions for OpenApiV3 (#280)
|
147 | - no request body validation for methods w/o parameters (closes #294)
|
148 | - Resolve response and parameter references for OpenAPI 3.0 (fixes #293)
|
149 |
|
150 | ## 4.0.0 - 2019-01-09
|
151 | ### Added
|
152 | - Support for V3 servers attribute (#295)
|
153 |
|
154 | ### Changed
|
155 | - Security middleware is now executed before other middleware (closes #286)
|
156 |
|
157 | ### Fixed
|
158 | - openapi-framework@0.18.0:
|
159 | - no request body validation for methods w/o parameters (closes #294)
|
160 | - Resolve response and parameter references for OpenAPI 3.0 (fixes #293)
|
161 |
|
162 | ## 3.7.0 - 2018-12-31
|
163 | ### Fixed
|
164 | - openapi-framework@0.16.0: support refs in requestBody schema to both definitions and components.schemas
|
165 |
|
166 | ## 3.6.0 - 2018-12-20
|
167 | ### Fixed
|
168 | - Updated openapi-framework to handle OpenAPI V3 requestBody and components.
|
169 |
|
170 | ## 3.5.0 - 2018-12-12
|
171 | ### Added
|
172 | - Updated openapi-framework to 0.13.0 for OpenAPI V3 response application/json validation support.
|
173 |
|
174 | ## 3.4.0 - 2018-12-11
|
175 | ### Added
|
176 | - Updated openapi-framework to 0.12.0 for OpenAPI V3 response nullable property support.
|
177 |
|
178 | ## 3.3.0 - 2018-11-21
|
179 | ### Added
|
180 | - Updated openapi-framework to 0.10.0 for OpenAPI V3 request coercion support.
|
181 |
|
182 | ## 3.2.0 - 2018-11-20
|
183 | ### Added
|
184 | - Updated openapi-framework to 0.9.0 for OpenAPI V3 requestBody.consumes support.
|
185 |
|
186 | ## 3.1.0 - 2018-10-25
|
187 | ### Added
|
188 | - `ExpressOpenAPIArgs` now extends `OpenAPIFrameworkArgs`
|
189 | - `args.enableObjectCoercion`
|
190 |
|
191 | ## 3.0.3 - 2018-10-17
|
192 | ### Fixed
|
193 | - Typescript documentation in README.
|
194 | - Adding `Operation` back as an exported type.
|
195 |
|
196 | ## 3.0.2 - 2018-10-12
|
197 | ### Fixed
|
198 | - Types reference had wrong path in `package.json`.
|
199 |
|
200 | ## 3.0.1 - 2018-10-06
|
201 | ### Added
|
202 | - Fixing `type: 'file'` breaking OpenAPI V2 request validation. Downstream projects
|
203 | should handle file validation independently. See #188 and #223.
|
204 |
|
205 | ## 3.0.0 - 2018-10-04
|
206 | ### Added
|
207 | - project is now built with typescript (#174)
|
208 | - CHANGELOG.md
|
209 |
|
210 | ### Changed
|
211 | - `export function initialize` instead of `module.exports = { initialize };`
|
212 | - `res.validateResponse` no longer has status set. It's recommended to handle this in your error middleware.
|
213 | - `securityHandlers` no longer accept a `cb` parameter. They instead return promises.
|
214 | - Typings now use declarations from other packages where possible.
|
215 |
|
216 | ### Fixed
|
217 | - `securityHandlers` no longer return challenge attributes (see #197).
|