Skip to content

Commit cb0ed6e

Browse files
authored
Prepare release v4.5.0 (#1178)
1 parent 8a1d1c4 commit cb0ed6e

File tree

8 files changed

+114
-11
lines changed

8 files changed

+114
-11
lines changed

CHANGELOG.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,30 @@
1+
## 4.5.0 (Jun 27, 2025)
2+
3+
High level enhancements
4+
5+
- Support const values, null type, and vendor extensions for sidebar order
6+
- Improve schema support for array items, type, and format
7+
8+
Other enhancements and bug fixes
9+
10+
- docs: update compatibility for docusaurus 3.8.1 ([#1177](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1177))
11+
- chore(demo): upgrade Docusaurus to v3.8.1 ([#1176](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1176))
12+
- chore: add typings and remove placeholders ([#1175](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1175))
13+
- fix types for plugin openapi ([#1174](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1174))
14+
- refactor: replace Map type with Record ([#1173](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1173))
15+
- refactor(theme): clean up type definitions ([#1172](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1172))
16+
- refactor: change ResponseSamples to CodeSamples ([#1162](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1162))
17+
- refactor: refactor request and response example ([#1161](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1161))
18+
- Change the tab label of anyOf/oneOf ([#1167](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1167))
19+
- docs: fix typos and tables ([#1170](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1170))
20+
- chore: restrict workflows to main repo ([#1169](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1169))
21+
- [Enhancement] Add vendor extension support for positioning sidebar items ([#1160](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1160))
22+
- feat: support allOf, anyOf, and oneOf schemas with properties in array items ([#1156](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1156))
23+
- feat: support null type ([#1155](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1155))
24+
- Add support for apiKey in query and cookie param ([#1151](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1151))
25+
- Add type and format to schema ([#1148](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1148))
26+
- feat: support const for OAS 3.1.1 ([#1143](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/1143))
27+
128
## 4.4.0 (May 2, 2025)
229

330
High level enhancements

demo/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "demo",
3-
"version": "4.4.0",
3+
"version": "4.5.0",
44
"private": true,
55
"scripts": {
66
"docusaurus": "docusaurus",
@@ -26,8 +26,8 @@
2626
"@docusaurus/plugin-google-gtag": "3.8.1",
2727
"@docusaurus/preset-classic": "3.8.1",
2828
"clsx": "^1.1.1",
29-
"docusaurus-plugin-openapi-docs": "^4.4.0",
30-
"docusaurus-theme-openapi-docs": "^4.4.0",
29+
"docusaurus-plugin-openapi-docs": "^4.5.0",
30+
"docusaurus-theme-openapi-docs": "^4.5.0",
3131
"prism-react-renderer": "^2.3.0",
3232
"react": "^19.0.0",
3333
"react-dom": "^19.0.0"

lerna.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"version": "4.4.0",
2+
"version": "4.5.0",
33
"npmClient": "yarn"
44
}

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@
7171
"semver": "^7.3.5",
7272
"start-server-and-test": "^1.14.0",
7373
"ts-jest": "^27.0.6",
74+
"ts-node": "^10.9.2",
7475
"typescript": "^5.1"
7576
},
7677
"lint-staged": {

packages/docusaurus-plugin-openapi-docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,7 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
189189
| `sidebarGenerators` | `object` | `null` | Optional: Customize sidebar rendering with callback functions. |
190190

191191
> You may optionally configure a `sidebarOptions`. In doing so, an individual `sidebar.js` slice with the configured options will be generated within the respective `outputDir`.
192+
> Use `x-position` vendor extension (or the front matter `position`) on operations to explicitly order sidebar items.
192193
193194
`versions` can be configured with the following options:
194195

packages/docusaurus-plugin-openapi-docs/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "docusaurus-plugin-openapi-docs",
33
"description": "OpenAPI plugin for Docusaurus.",
4-
"version": "4.4.0",
4+
"version": "4.5.0",
55
"license": "MIT",
66
"keywords": [
77
"openapi",

packages/docusaurus-theme-openapi-docs/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "docusaurus-theme-openapi-docs",
33
"description": "OpenAPI theme for Docusaurus.",
4-
"version": "4.4.0",
4+
"version": "4.5.0",
55
"license": "MIT",
66
"keywords": [
77
"openapi",
@@ -38,7 +38,7 @@
3838
"@types/postman-collection": "^3.5.11",
3939
"@types/react-modal": "^3.16.3",
4040
"concurrently": "^5.2.0",
41-
"docusaurus-plugin-openapi-docs": "^4.4.0",
41+
"docusaurus-plugin-openapi-docs": "^4.5.0",
4242
"docusaurus-plugin-sass": "^0.2.3",
4343
"eslint-plugin-prettier": "^5.0.1"
4444
},

yarn.lock

Lines changed: 78 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1179,6 +1179,13 @@
11791179
resolved "https://registry.yarnpkg.com/@colors/colors/-/colors-1.5.0.tgz#bb504579c1cae923e6576a4f5da43d25f97bdbd9"
11801180
integrity sha512-ooWCrlZP11i8GImSjTHYHLkvFDP48nS4+204nGb1RiX/WXYHmJA2III9/e2DWVabCESdW7hBAEzHRqUn9OUVvQ==
11811181

1182+
"@cspotcode/source-map-support@^0.8.0":
1183+
version "0.8.1"
1184+
resolved "https://registry.yarnpkg.com/@cspotcode/source-map-support/-/source-map-support-0.8.1.tgz#00629c35a688e05a88b1cda684fb9d5e73f000a1"
1185+
integrity sha512-IchNf6dN4tHoMFIn/7OE8LWZ19Y6q/67Bmf6vnGREv8RSbBVb9LPJxEcnwrcwX6ixSvaiGoomAUvu4YSxXrVgw==
1186+
dependencies:
1187+
"@jridgewell/trace-mapping" "0.3.9"
1188+
11821189
"@csstools/cascade-layer-name-parser@^2.0.5":
11831190
version "2.0.5"
11841191
resolved "https://registry.yarnpkg.com/@csstools/cascade-layer-name-parser/-/cascade-layer-name-parser-2.0.5.tgz#43f962bebead0052a9fed1a2deeb11f85efcbc72"
@@ -2705,7 +2712,7 @@
27052712
"@jridgewell/sourcemap-codec" "^1.4.10"
27062713
"@jridgewell/trace-mapping" "^0.3.24"
27072714

2708-
"@jridgewell/resolve-uri@^3.1.0":
2715+
"@jridgewell/resolve-uri@^3.0.3", "@jridgewell/resolve-uri@^3.1.0":
27092716
version "3.1.2"
27102717
resolved "https://registry.yarnpkg.com/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz#7a0ee601f60f99a20c7c7c5ff0c80388c1189bd6"
27112718
integrity sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw==
@@ -2728,6 +2735,14 @@
27282735
resolved "https://registry.yarnpkg.com/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.0.tgz#3188bcb273a414b0d215fd22a58540b989b9409a"
27292736
integrity sha512-gv3ZRaISU3fjPAgNsriBRqGWQL6quFx04YMPW/zD8XMLsU32mhCCbfbO6KZFLjvYpCZ8zyDEgqsgf+PwPaM7GQ==
27302737

2738+
"@jridgewell/[email protected]":
2739+
version "0.3.9"
2740+
resolved "https://registry.yarnpkg.com/@jridgewell/trace-mapping/-/trace-mapping-0.3.9.tgz#6534fd5933a53ba7cbf3a17615e273a0d1273ff9"
2741+
integrity sha512-3Belt6tdc8bPgAtbcmdtNJlirVoTmEb5e2gC94PnkwEW9jI6CAHUeoG85tjWP5WquqfavoMtMwiG4P926ZKKuQ==
2742+
dependencies:
2743+
"@jridgewell/resolve-uri" "^3.0.3"
2744+
"@jridgewell/sourcemap-codec" "^1.4.10"
2745+
27312746
"@jridgewell/trace-mapping@^0.3.18", "@jridgewell/trace-mapping@^0.3.24", "@jridgewell/trace-mapping@^0.3.25":
27322747
version "0.3.25"
27332748
resolved "https://registry.yarnpkg.com/@jridgewell/trace-mapping/-/trace-mapping-0.3.25.tgz#15f190e98895f3fc23276ee14bc76b675c2e50f0"
@@ -3936,6 +3951,26 @@
39363951
resolved "https://registry.yarnpkg.com/@trysound/sax/-/sax-0.2.0.tgz#cccaab758af56761eb7bf37af6f03f326dd798ad"
39373952
integrity sha512-L7z9BgrNEcYyUYtF+HaEfiS5ebkh9jXqbszz7pC0hRBPaatV0XjSD3+eHrpqFemQfgwiFF0QPIarnIihIDn7OA==
39383953

3954+
"@tsconfig/node10@^1.0.7":
3955+
version "1.0.11"
3956+
resolved "https://registry.yarnpkg.com/@tsconfig/node10/-/node10-1.0.11.tgz#6ee46400685f130e278128c7b38b7e031ff5b2f2"
3957+
integrity sha512-DcRjDCujK/kCk/cUe8Xz8ZSpm8mS3mNNpta+jGCA6USEDfktlNvm1+IuZ9eTcDbNk41BHwpHHeW+N1lKCz4zOw==
3958+
3959+
"@tsconfig/node12@^1.0.7":
3960+
version "1.0.11"
3961+
resolved "https://registry.yarnpkg.com/@tsconfig/node12/-/node12-1.0.11.tgz#ee3def1f27d9ed66dac6e46a295cffb0152e058d"
3962+
integrity sha512-cqefuRsh12pWyGsIoBKJA9luFu3mRxCA+ORZvA4ktLSzIuCUtWVxGIuXigEwO5/ywWFMZ2QEGKWvkZG1zDMTag==
3963+
3964+
"@tsconfig/node14@^1.0.0":
3965+
version "1.0.3"
3966+
resolved "https://registry.yarnpkg.com/@tsconfig/node14/-/node14-1.0.3.tgz#e4386316284f00b98435bf40f72f75a09dabf6c1"
3967+
integrity sha512-ysT8mhdixWK6Hw3i1V2AeRqZ5WfXg1G43mqoYlM2nc6388Fq5jcXyr5mRsqViLx/GJYdoL0bfXD8nmF+Zn/Iow==
3968+
3969+
"@tsconfig/node16@^1.0.2":
3970+
version "1.0.4"
3971+
resolved "https://registry.yarnpkg.com/@tsconfig/node16/-/node16-1.0.4.tgz#0b92dcc0cc1c81f6f306a381f28e31b1a56536e9"
3972+
integrity sha512-vxhUy4J8lyeyinH7Azl1pdd43GJhZH/tP2weN8TntQblOY+A0XbT8DJk1/oCPuOOyg/Ja757rG0CgHcWC8OfMA==
3973+
39393974
39403975
version "2.0.0"
39413976
resolved "https://registry.yarnpkg.com/@tufjs/canonical-json/-/canonical-json-2.0.0.tgz#a52f61a3d7374833fca945b2549bc30a2dd40d0a"
@@ -4903,7 +4938,7 @@ acorn-walk@^7.1.1:
49034938
resolved "https://registry.yarnpkg.com/acorn-walk/-/acorn-walk-7.2.0.tgz#0de889a601203909b0fbe07b8938dc21d2e967bc"
49044939
integrity sha512-OPdCF6GsMIP+Az+aWfAAOEt2/+iVDKE7oy6lJ098aoe59oAmK76qV6Gw60SbZ8jHuG2wH058GF4pLFbYamYrVA==
49054940

4906-
acorn-walk@^8.0.0:
4941+
acorn-walk@^8.0.0, acorn-walk@^8.1.1:
49074942
version "8.3.4"
49084943
resolved "https://registry.yarnpkg.com/acorn-walk/-/acorn-walk-8.3.4.tgz#794dd169c3977edf4ba4ea47583587c5866236b7"
49094944
integrity sha512-ueEepnujpqee2o5aIYnvHU6C0A42MNdsIDeqy5BydrkuC5R1ZuUFnm27EeFJGoEHJQgn3uleRvmTXaJgfXbt4g==
@@ -4915,7 +4950,7 @@ acorn@^7.1.1, acorn@^7.4.0:
49154950
resolved "https://registry.yarnpkg.com/acorn/-/acorn-7.4.1.tgz#feaed255973d2e77555b83dbc08851a6c63520fa"
49164951
integrity sha512-nQyp0o1/mNdbTO1PO6kHkwSrmgZ0MT/jCCpNiwbUjGoRN4dlBhqJtoQuCnEOKzgTVwg0ZWiCoQy6SxMebQVh8A==
49174952

4918-
acorn@^8.0.0, acorn@^8.0.4, acorn@^8.11.0, acorn@^8.14.0, acorn@^8.2.4:
4953+
acorn@^8.0.0, acorn@^8.0.4, acorn@^8.11.0, acorn@^8.14.0, acorn@^8.2.4, acorn@^8.4.1:
49194954
version "8.15.0"
49204955
resolved "https://registry.yarnpkg.com/acorn/-/acorn-8.15.0.tgz#a360898bc415edaac46c8241f6383975b930b816"
49214956
integrity sha512-NZyJarBfL7nWwIq+FDL6Zp/yHEhePMNnnJ0y3qfieCrmNvYct8uvtiV41UvlSe6apAfk0fY1FbWx+NwfmpvtTg==
@@ -5133,6 +5168,11 @@ arch@^2.2.0:
51335168
resolved "https://registry.yarnpkg.com/arch/-/arch-2.2.0.tgz#1bc47818f305764f23ab3306b0bfc086c5a29d11"
51345169
integrity sha512-Of/R0wqp83cgHozfIYLbBMnej79U/SVGOOyuB3VVFv1NRM/PSFMK12x9KVtiYzJqmnU5WR2qp0Z5rHb7sWGnFQ==
51355170

5171+
arg@^4.1.0:
5172+
version "4.1.3"
5173+
resolved "https://registry.yarnpkg.com/arg/-/arg-4.1.3.tgz#269fc7ad5b8e42cb63c896d5666017261c144089"
5174+
integrity sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA==
5175+
51365176
arg@^5.0.0, arg@^5.0.2:
51375177
version "5.0.2"
51385178
resolved "https://registry.yarnpkg.com/arg/-/arg-5.0.2.tgz#c81433cc427c92c4dcf4865142dbca6f15acd59c"
@@ -6626,6 +6666,11 @@ cosmiconfig@^8.1.3, cosmiconfig@^8.3.5:
66266666
parse-json "^5.2.0"
66276667
path-type "^4.0.0"
66286668

6669+
create-require@^1.1.0:
6670+
version "1.1.1"
6671+
resolved "https://registry.yarnpkg.com/create-require/-/create-require-1.1.1.tgz#c1d7e8f1e5f6cfc9ff65f9cd352d37348756c333"
6672+
integrity sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==
6673+
66296674
cross-spawn@^7.0.0, cross-spawn@^7.0.2, cross-spawn@^7.0.3, cross-spawn@^7.0.6:
66306675
version "7.0.6"
66316676
resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-7.0.6.tgz#8a58fe78f00dcd70c370451759dfbfaf03e8ee9f"
@@ -11571,7 +11616,7 @@ make-dir@^2.1.0:
1157111616
pify "^4.0.1"
1157211617
semver "^5.6.0"
1157311618

11574-
11619+
[email protected], make-error@^1.1.1:
1157511620
version "1.3.6"
1157611621
resolved "https://registry.yarnpkg.com/make-error/-/make-error-1.3.6.tgz#2eb2e37ea9b67c4891f684a1394799af484cf7a2"
1157711622
integrity sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==
@@ -17239,6 +17284,25 @@ ts-jest@^27.0.6:
1723917284
semver "7.x"
1724017285
yargs-parser "20.x"
1724117286

17287+
ts-node@^10.9.2:
17288+
version "10.9.2"
17289+
resolved "https://registry.yarnpkg.com/ts-node/-/ts-node-10.9.2.tgz#70f021c9e185bccdca820e26dc413805c101c71f"
17290+
integrity sha512-f0FFpIdcHgn8zcPSbf1dRevwt047YMnaiJM3u2w2RewrB+fob/zePZcrOyQoLMMO7aBIddLcQIEK5dYjkLnGrQ==
17291+
dependencies:
17292+
"@cspotcode/source-map-support" "^0.8.0"
17293+
"@tsconfig/node10" "^1.0.7"
17294+
"@tsconfig/node12" "^1.0.7"
17295+
"@tsconfig/node14" "^1.0.0"
17296+
"@tsconfig/node16" "^1.0.2"
17297+
acorn "^8.4.1"
17298+
acorn-walk "^8.1.1"
17299+
arg "^4.1.0"
17300+
create-require "^1.1.0"
17301+
diff "^4.0.1"
17302+
make-error "^1.1.1"
17303+
v8-compile-cache-lib "^3.0.1"
17304+
yn "3.1.1"
17305+
1724217306
tsconfig-paths@^3.15.0:
1724317307
version "3.15.0"
1724417308
resolved "https://registry.yarnpkg.com/tsconfig-paths/-/tsconfig-paths-3.15.0.tgz#5299ec605e55b1abb23ec939ef15edaf483070d4"
@@ -17777,6 +17841,11 @@ uvu@^0.5.0:
1777717841
kleur "^4.0.3"
1777817842
sade "^1.7.3"
1777917843

17844+
v8-compile-cache-lib@^3.0.1:
17845+
version "3.0.1"
17846+
resolved "https://registry.yarnpkg.com/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz#6336e8d71965cb3d35a1bbb7868445a7c05264bf"
17847+
integrity sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg==
17848+
1778017849
v8-compile-cache@^2.0.3:
1778117850
version "2.4.0"
1778217851
resolved "https://registry.yarnpkg.com/v8-compile-cache/-/v8-compile-cache-2.4.0.tgz#cdada8bec61e15865f05d097c5f4fd30e94dc128"
@@ -18549,6 +18618,11 @@ [email protected]:
1854918618
resolved "https://registry.yarnpkg.com/yeast/-/yeast-0.1.2.tgz#008e06d8094320c372dbc2f8ed76a0ca6c8ac419"
1855018619
integrity sha512-8HFIh676uyGYP6wP13R/j6OJ/1HwJ46snpvzE7aHAN3Ryqh2yX6Xox2B4CUmTwwOIzlG3Bs7ocsP5dZH/R1Qbg==
1855118620

18621+
18622+
version "3.1.1"
18623+
resolved "https://registry.yarnpkg.com/yn/-/yn-3.1.1.tgz#1e87401a09d767c1d5eab26a6e4c185182d2eb50"
18624+
integrity sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q==
18625+
1855218626
yocto-queue@^1.0.0:
1855318627
version "1.2.1"
1855418628
resolved "https://registry.yarnpkg.com/yocto-queue/-/yocto-queue-1.2.1.tgz#36d7c4739f775b3cbc28e6136e21aa057adec418"

0 commit comments

Comments
 (0)