Releases: swagger-api/swagger-ui
Releases · swagger-api/swagger-ui
Swagger UI v5.0.0 Released!
5.0.0 (2023-06-12)
Release summary
v5.0.0 release brings support for OpenAPI 3.1.0 specification. Support for OpenAPI 3.1.0 has been introduced in fully backward compatible way.
Features
- samples: add support for examples keyword (#8908) (4b0b285), closes #8577
- samples: add support for const keyword (#8884) (bdad2fe), closes #8577
- samples: add support for contains, minContains, maxContains keywords (#8896) (6549eff), closes #8577
- samples: add support for contentEncoding keyword (#8899) (0483964), closes #8577
- samples: add support for contentMediaType keyword (#8903) (1925622), closes #8577
- samples: add support for contentSchema keyword (#8907) (6c622a8), closes #8577
- samples: add support for custom formats, encoders and media types (#8905) (d72b72c), closes #8577
- samples: add support for inferring schema type (#8909) (ce417d5), closes #8577
- samples: add support for new values of format keyword (#8882) (28b1233), closes #8577
- samples: add support for proper schema merging (#8910) (7bf0dd9), closes #8577
- samples: add support for regex string format (#8891) (8a91492), closes #8577
- samples: add support for type keyword defined as list of types (#8883) (3587696), closes #8577
- samples: add support for uniqueItems keyword (#8893) (1114965), closes #8577
- samples: support multipleOf keyword (#8890) (68cfe46), closes #8577
- samples: support new semantics of exclusive number ranges (#8885) (836659d), closes #8577
- introduce samples framework for JSON Schema 2020-12 (ac3b69f), closes #8577
- oas31: enable overrides for samples plugin (#8731) (df9aadf), closes #8577
- docker: add support for
PORT_IPV6environment variable (#8878) - docker: add support for multi platform images
- auth: persist cookie based apiKey in document.cookie (#8689) (7ac9a8f), closes #8683
- oas31: add support for includeReadOnly/WriteOnly options in new JSON Schema 2020-12 renderer (#8675) (75b41e0), closes #8513
- oas31: prepare to render JSON Schema 2020-12 in Operations and Webhooks (#8670) (79e0c4e), closes #8513
- oas31: render JSON Schema 2020-12 in Operations and Webhooks (#8673) (2f0282d), closes #8513
- oas31: add support for Schema Object example keyword (#8652) (7d14577), closes #8513
- oas31: add support for Schema Object discriminator keyword (#8658) (11bb4f9), closes #8513
- oas31: add support for Schema Object externalDocs keyword (#8659) (01d2376), closes #8513
- oas31: add support for Schema Object xml keyword (#8657) (9bb5a21), closes #8513
- json-schema-2020-12: add support for contentEncoding keyword (#8644) (9208818), closes #8513
- json-schema-2020-12: add support for contentMediaType keyword (#8640) (c15e69e), closes #8513
- json-schema-2020-12: add support for contentSchema keyword (#8645) (f549a1d), closes #8513
- json-schema-2020-12: add support for default keyword (#8647) (e6d5099), closes #8513
- json-schema-2020-12: add support for deprecated keyword (#8648) (aed6bb3), closes #8513
- json-schema-2020-12: add support for readOnly keyword (#8649) (964a11a), closes #8513
- json-schema-2020-12: add support for writeOnly keyword (#8650) ([d7b489c](d7b489c283c5e87...
Swagger UI v4.19.1 Released!
Swagger UI v5.0.0-beta.0 Released!
5.0.0-beta.0 (2023-06-11)
Release summary
This release brings support for generating examples from JSON Schema 2020-12. Some rendering enhancements have also been added. JSON Schema 2020-12 is default JSON Schema dialect for OpenAPI 3.1.0 specification.
Bug Fixes
- export standalone preset from the npm package (#8906) (cdd0bdd), closes #8163
- json-schema-2020-12: custom OAS 3.1 formats in type inferrence (#8912) (12c7493)
- oas31: fix rendering of Schema Object inside Operation Object (#8887) (f30d89a)
Features
- samples: add support for examples keyword (#8908) (4b0b285), closes #8577
- samples: add support for const keyword (#8884) (bdad2fe), closes #8577
- samples: add support for contains, minContains, maxContains keywords (#8896) (6549eff), closes #8577
- samples: add support for contentEncoding keyword (#8899) (0483964), closes #8577
- samples: add support for contentMediaType keyword (#8903) (1925622), closes #8577
- samples: add support for contentSchema keyword (#8907) (6c622a8), closes #8577
- samples: add support for custom formats, encoders and media types (#8905) (d72b72c), closes #8577
- samples: add support for inferring schema type (#8909) (ce417d5), closes #8577
- samples: add support for new values of format keyword (#8882) (28b1233), closes #8577
- samples: add support for proper schema merging (#8910) (7bf0dd9), closes #8577
- samples: add support for regex string format (#8891) (8a91492), closes #8577
- samples: add support for type keyword defined as list of types (#8883) (3587696), closes #8577
- samples: add support for uniqueItems keyword (#8893) (1114965), closes #8577
- samples: support multipleOf keyword (#8890) (68cfe46), closes #8577
- samples: support new semantics of exclusive number ranges (#8885) (836659d), closes #8577
Swagger UI v5.0.0-alpha.15 Released!
5.0.0-alpha.15 (2023-06-05)
Features
- introduce samples framework for JSON Schema 2020-12 (ac3b69f), closes #8577
- oas31: enable overrides for samples plugin (#8731) (df9aadf), closes #8577
- docker: add support for
PORT_IPV6environment variable (#8878) - docker: add support for multi platform images
Enhancements
- docker: use templating to handle environment variables (#8878)
Swagger UI v5.0.0-alpha.14 Released!
5.0.0-alpha.14 (2023-05-25)
Features
Bug Fixes
- json-schema-2020-12: fix predicate in hasKeyword function (#8692) (1931b45), closes #8686
- oas31: avoid capitalizing first character of components.schemas (#8710) (4ad45f8), closes #8611
- oas31: fix bug in detecting cycles for OpenAPI 3.1.0 (swagger-client@3.19.8)
Enhancements
Swagger UI v4.19.0 Released!
Swagger UI v4.15.4 Released!
Swagger UI v5.0.0-alpha.13 Released!
5.0.0-alpha.13 (2023-05-16)
Release summary
This release brings full support for rendering JSON Schema 2020-12, which comes as a default JSON Schema dialect for OpenAPI 3.1.0 specification.
components.schemas:
Path Operations:
Webhooks Operations:
Bug Fixes
- json-schema-2020-12: fix rendering of items keywords (#8674) (67132cc), closes #8513
- oas31: fix deep linking for Webhooks and Callbacks (#8680) (872e382), closes #8679
- oas31: fix expansion margin in OpenAPI 3.1 base dialect keywords (#8664) (bd406ee), closes #8513
Features
- oas31: add support for includeReadOnly/WriteOnly options in new JSON Schema 2020-12 renderer (#8675) (75b41e0), closes #8513
- oas31: prepare to render JSON Schema 2020-12 in Operations and Webhooks (#8670) (79e0c4e), closes #8513
- oas31: render JSON Schema 2020-12 in Operations and Webhooks (#8673) (2f0282d), closes #8513
Swagger UI v5.0.0-alpha.12 Released!
5.0.0-alpha.12 (2023-05-12)
Release summary
This release brings full support for rendering JSON Schema 2020-12, that comes as a default JSON Schema dialect for OpenAPI 3.1.0 specification. This new JSON Schema 2020-12 renderer is currently utilized only in bottom section of SwaggerUI which renders OpenAPI 3.1.0 components.schemas field. Below is a preview of how the rendered JSON Schema 2020-12 looks like.
Supported vocabularies in new JSON Schema 2020-12 renderer:
Bug Fixes
Features
- oas31: add support for Schema Object example keyword (#8652) (7d14577), closes #8513
- oas31: add support for Schema Object discriminator keyword (#8658) (11bb4f9), closes #8513
- oas31: add support for Schema Object externalDocs keyword (#8659) (01d2376), closes #8513
- oas31: add support for Schema Object xml keyword (#8657) (9bb5a21), closes #8513
Swagger UI v5.0.0-alpha.11 Released!
5.0.0-alpha.11 (2023-05-11)
Release summary
This release brings support (still partial) for rendering JSON Schema 2020-12, that comes as a default JSON Schema dialect for OpenAPI 3.1.0 specification. This new JSON Schema 2020-12 renderer is currently utilized only in bottom section of SwaggerUI which renders OpenAPI 3.1.0 components.schemas field. Below is a preview of how the rendered JSON Schema 2020-12 looks like.
Supported vocabularies in new JSON Schema 2020-12 renderer:
- Core vocabulary
- Validation vocabulary
- OpenAPI 3.1.0 base vocabulary (support is comming soon)
Features
- json-schema-2020-12: add support for contentEncoding keyword (#8644) (9208818), closes #8513
- json-schema-2020-12: add support for contentMediaType keyword (#8640) (c15e69e), closes #8513
- json-schema-2020-12: add support for contentSchema keyword (#8645) (f549a1d), closes #8513
- json-schema-2020-12: add support for default keyword (#8647) (e6d5099), closes #8513
- json-schema-2020-12: add support for deprecated keyword (#8648) (aed6bb3), closes #8513
- json-schema-2020-12: add support for readOnly keyword (#8649) (964a11a), closes #8513
- json-schema-2020-12: add support for writeOnly keyword (#8650) (d7b489c), closes #8513