diff --git a/CHANGELOG.md b/CHANGELOG.md index 5150fb7af..b987d9322 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,108 @@ +## 4.2.0 (Nov 1, 2024) + +High level enhancements + +- Massive refactor of plugin and theme that dramatically optimizes and reduces generated MDX. +- Added sample JSON code snippet component to schema pages. +- Improvements to how allOf, additonalProperties and discriminators are processed/handled. + +Other enhancements and bug fixes + +### Features/Enhancements + +- **discriminators** + - Improve handling of discriminators ([#1009](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1009)) +- **schema** + - Migrate schema page to Schema component and refactor layout ([#1001](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1001)) + - Refactor to use new theme components + - Add new RequestSchema and Schema components +- **additional properties** + - Add additionalProperties examples to tests + - Support object as primitive additional properties + - Improve Items support for allOf and primitives +- **allOf handling** + - Refactor items allOf to new pattern/library + - Extend allOf tests + - Migrate to allof-merge library to improve merging + - Improve handling of top-level primitives + - Improve support for allOf + - Avoid returning on first schema match and improve support for AnyOneOf +- **UI/UX improvements** + - Implement skeleton loader component + - Try lazy loading on all + - Implement lazy loading without BrowserOnly + - Render loading spinner instead of text + - Add language tabs back + - Add default logo for http and shell + - Add margin top to enum descriptions + - Change label from generated to auto + - Add Summary component, cleanup PropertyDiscriminator and SchemaNodeDetails + - Rename Edge to SchemaEdge and fix props and types + - Rename SchemaComponent to SchemaNode + - Cleanup Properties and add missing props + - Port x-enumDescription fix from [#981](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/981) + - Add additional schema support to edge + - Support single mime type schemas + - Make props optional + - Add DetailsNode component and markdown rendering for description and qualifier + - Add StatusCodes component + - Use ExecutionEnvironment to avoid SSR + - Render ParamsDetails client-side + - Add response examples + - Add ResponseExamples component + - Import new ResponseSchema component + - Switch to new ResponseSchema component + - Add new ResponseSchema component + - Reduce params details to single component for all types + - Switch to docusaurus Details component + - Fix details summaries + - Add ParamsDetails to imports + - Refactor createParamsDetails to use component + - Add className to Props + - Add new ParamsDetails component + +### Bug Fixes + +- **allOf items** + - [Fix] All of items in array for API response ([#995](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/995)) + - Fix linter errors + - Update test snapshot + - Fix create allof request/response samples +- **empty language tabs** + - Fix bug in CodeSnippets component ([#988](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/988)) +- **contact info** + - Fix bug in createContactInfo.ts, protocol was set to mailto even though it was a URL ([#992](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/992)) +- **import names** + - Fix import name + +### Refactoring + +- **schema** + - Refactor create schema tests to cypress ([#997](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/997)) + - Rename 'from schema' to 'generated' and cleanup examples +- **imports** + - Remove unused imports + - Cleanup API doc template imports + - Update imports + - Remove unused imports + - Update imports +- **code cleanup** + - Remove unused import + - Cleanup AdditionalProperties types and logic + - Cleanup PropertyDiscriminator and Markdown types + - Cleanup code comments + - Remove unnecessary div + - Revert CSR experiment + - Remove unnecessary div + - Remove code comment + +### Other + +- **internal** + - Migrate branch 'main' into params-details + - Update build-perf.yml + - Update build-perf.yml + ## 4.1.0 (Oct 4, 2024) High level enhancements diff --git a/README.md b/README.md index 5756170e8..9fac7bf9c 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ Key Features: | Docusaurus OpenAPI Docs | Docusaurus | | ----------------------- | --------------- | -| 4.0.x (current) | `3.5.0 - 3.5.2` | +| 4.x.x (current) | `3.5.0 - 3.5.2` | | 3.0.x (end-of-support) | `3.0.1 - 3.4.0` | | 2.2.3 (legacy) | `2.4.1 - 2.4.3` | | 1.7.3 (end-of-support) | `2.0.1 - 2.2.0` | diff --git a/demo/package.json b/demo/package.json index dc45fa330..1f0dc8b77 100644 --- a/demo/package.json +++ b/demo/package.json @@ -1,6 +1,6 @@ { "name": "demo", - "version": "4.1.0", + "version": "4.2.0", "private": true, "scripts": { "docusaurus": "docusaurus", @@ -25,8 +25,8 @@ "@docusaurus/plugin-google-gtag": "3.5.2", "@docusaurus/preset-classic": "3.5.2", "clsx": "^1.1.1", - "docusaurus-plugin-openapi-docs": "^4.1.0", - "docusaurus-theme-openapi-docs": "^4.1.0", + "docusaurus-plugin-openapi-docs": "^4.2.0", + "docusaurus-theme-openapi-docs": "^4.2.0", "prism-react-renderer": "^2.3.0", "react": "^18.2.0", "react-dom": "^18.2.0" diff --git a/lerna.json b/lerna.json index b60acb1e9..8419cd22c 100644 --- a/lerna.json +++ b/lerna.json @@ -1,4 +1,4 @@ { - "version": "4.1.0", + "version": "4.2.0", "npmClient": "yarn" } diff --git a/packages/docusaurus-plugin-openapi-docs/package.json b/packages/docusaurus-plugin-openapi-docs/package.json index 306a977c2..6a78542e2 100644 --- a/packages/docusaurus-plugin-openapi-docs/package.json +++ b/packages/docusaurus-plugin-openapi-docs/package.json @@ -1,7 +1,7 @@ { "name": "docusaurus-plugin-openapi-docs", "description": "OpenAPI plugin for Docusaurus.", - "version": "4.1.0", + "version": "4.2.0", "license": "MIT", "keywords": [ "openapi", diff --git a/packages/docusaurus-theme-openapi-docs/package.json b/packages/docusaurus-theme-openapi-docs/package.json index f365baaee..8240aa847 100644 --- a/packages/docusaurus-theme-openapi-docs/package.json +++ b/packages/docusaurus-theme-openapi-docs/package.json @@ -1,7 +1,7 @@ { "name": "docusaurus-theme-openapi-docs", "description": "OpenAPI theme for Docusaurus.", - "version": "4.1.0", + "version": "4.2.0", "license": "MIT", "keywords": [ "openapi", @@ -43,7 +43,7 @@ "clsx": "^1.1.1", "copy-text-to-clipboard": "^3.1.0", "crypto-js": "^4.1.1", - "docusaurus-plugin-openapi-docs": "^4.1.0", + "docusaurus-plugin-openapi-docs": "^4.2.0", "docusaurus-plugin-sass": "^0.2.3", "file-saver": "^2.0.5", "lodash": "^4.17.20",