Releases: swagger-api/swagger-editor
v5.0.0-alpha.92
5.0.0-alpha.92 (2024-03-29)
Features
v5.0.0-alpha.91
5.0.0-alpha.91 (2024-03-29)
Breaking changes
AsyncAPI preview plugin
AsyncAPI preview plugin now uses @asyncapi/parser v3 instead of v1. The way, how we pass options to the AsyncAPI parser changed.
editorPreviewAsyncAPI.actions.parse FSA creator now accepts options objects in a shape of { parserOptions, parseOptions } as a second argument. parserOptions are passed to the parser constructor during the parser creation and parseOptions are passed to parse function during the parsing.
Here is an example how to override how AsyncAPI parser resolves HTTP(S) URLs:
const AsyncAPIParseOptionsPlugin = () => ({
statePlugins: {
editorPreviewAsyncAPI: {
wrapActions: {
parse:
(oriAction) =>
(content, options = {}) => {
const httpsFetchResolver = {
schema: 'https',
canRead: true,
async read(uri) {
const response = await fetch(uri.toString());
return response.text();
},
};
const httpFetchResolver = {
schema: 'http',
canRead: true,
async read(uri) {
const response = await fetch(uri.toString());
return response.text();
},
};
const parserOptions = {
...options.parserOptions,
__unstable: {
resolver: {
resolvers: [httpsFetchResolver, httpFetchResolver],
},
},
};
const parseOptions = options.parseOptions ?? {};
return oriAction(content, { parserOptions, parseOptions });
},
},
},
},
});Webpack configuration changes
Important
Instructions for building SwaggerEditor@5 with webpack@5 have changed.
Handling process with imports-loader it no longer necessary.
To avoid runtime errors, alias for @stoplight/ordered-object-literal needs to introduced. Please consult the amended Usage section of the main README file for more details.
Features
Performance Improvements
v5.0.0-alpha.90
5.0.0-alpha.90 (2024-03-26)
Features
- use VSCode API + Monaco Editor built from [email protected] (#4860) (5d21610), closes #4848
Important
Instructions for building SwaggerEditor@5 with webpack@5 changed. Before, process injection was handled by webpack.ProvidePlugin . Now it's handled by imports-loader. Please consult the amended Usage section of the main README file for more details. You can find the reasoning for the change in #4848.
v5.0.0-alpha.89
5.0.0-alpha.89 (2024-03-25)
Bug Fixes
- monaco-language-apidom: fix validation issues related to dereferencing (#4847) (b246122), closes #4828
- use @asyncapi/[email protected] (#4846) (bf95220), closes #4845
Performance Improvements
v5.0.0-alpha.88
5.0.0-alpha.88 (2024-02-05)
Bug Fixes
v5.0.0-alpha.87
Swagger Editor v4.12.1 Released!
Swagger Editor v4.12.0 Released!
4.12.0 (2024-01-16)
Bug Fixes
- fix typo in Petstore OpenAPI 2.0 (#4684) (d417e31)
- fixtures: update fixtures to conform with OpenAPI 3.0.3 spec (#4637) (8d82288)
- json-schema-validator: propertly handle unknown definition (#4745) (afd8610), closes #4697
Features
Important
For those looking to integrate SwaggerEditor@4 with older versions of React, we have provided a recipe to assist you in this process. Please refer to the Using older version of React section of the main README for detailed instructions and tips to ensure a smooth integration.
This recipe is tailored to help you navigate any compatibility issues and make the most out of SwaggerEditor@4 with earlier React versions. We encourage you to explore this recipe and reach out to us if you need further assistance.
v5.0.0-alpha.86
5.0.0-alpha.86 (2024-01-09)
Features
- add backward compatible support for React@18 (#4691) (1473a4e), closes #4690
- enhance editing experience for OpenAPI 2.0 (#4686) (bd7c9ab)
- integrate [email protected] (#4689) (3d2f89b), closes #4688
Important
For those looking to integrate SwaggerEditor@5 with older versions of React, we have provided a recipe to assist you in this process. Please refer to the Using older version of React section of the main README for detailed instructions and tips to ensure a smooth integration.
This recipe is tailored to help you navigate any compatibility issues and make the most out of SwaggerEditor@5 with earlier React versions. We encourage you to explore this recipe and reach out to us if you need further assistance.
v5.0.0-alpha.85
5.0.0-alpha.85 (2023-12-19)
Features
- enhance editing experience for OpenAPI 2.0 (#4670) (6c534c5)
- add doc rule for OpenAPI 2.0 Info Object (#3548) (f97b7a8), closes #3104
- add OpenAPI path template linting rule (#3538) (0055a09), closes #3517
- add rules for OpenAPI 2.0 Contact Object (#3550) (cf4fd26), closes #3104
- add rules for OpenAPI 2.0 Info Object (#3547) (cc11101), closes #3104
- add rules for OpenAPI 2.0 License Object (#3551) (75c46f4), closes #3104
- add rules for OpenAPI 2.0 Operation Object (#3561) (5dac8ef), closes #3104
- add rules for OpenAPI 2.0 Path Item Object (#3560) (b515c5e), closes #3104
- add rules for OpenAPI 2.0 Paths Object (#3553) (8feeeb3), closes #3104