Releases: cloud-annotations/docusaurus-openapi
v0.7.1
What's Changed
- Docusaurus v3 support 🎉
Big thanks to @sean-perkins, @techwritermat and @andremartinssw for their efforts!
Breaking Changes
- From v0.7.0 onward, this plugin will only be compatible with Docusaurus v3.
- Due to the use of MDXv3 there are several markdown related breaking changes. See https://docusaurus.io/docs/migration/v3#common-mdx-problems for more info.
Full Changelog: v0.6.4...v0.7.1
v0.6.4
What's Changed
- docs: update template version by @yzhe819 in #225
- Add existing site install instructions by @baptisteArno in #229
- Fix invalid ignore pattern for underscore files by @baptisteArno in #233
- Hide required labels on response schemas by @baptisteArno in #230
- Ensure path-level parameters are passed to the theme by @danieleds in #235
- Convert some relative imports in theme package by @chris48s in #237
- Fixes and enhancements for array query param handling by @chris48s in #241
- Prepare release v0.6.4 by @chris48s in #242
New Contributors
- @baptisteArno made their first contribution in #229
- @chris48s made their first contribution in #237
Full Changelog: v0.6.3...v0.6.4
v0.6.3
What's Changed
- Support for loading custom Markdown files by @danieleds in #193
- Enable multiselect in form-urlencoded body by @danieleds in #220
- fix: make sure to encode values in query and path parameters by @danieleds in #219
- Fix spelling error in README by @ankitshubham97 in #221
- fix: compatability with docusaurus 2.2.0 by @sean-perkins in #223
- Prepare release v0.6.3 by @sean-perkins in #224
New Contributors
- @ankitshubham97 made their first contribution in #221
Full Changelog: v0.6.2...v0.6.3
v0.4.2
v0.4.1
v0.4.0
0.4.0 (Dec 23, 2021)
High level enhancements
-
Docusaurus beta.14 support
// Be sure to update @docusaurus/core: "dependencies": { "@docusaurus/core": "2.0.0-beta.14", // ... }
-
With the release of Docusaurus beta.14 (Thanks @slorber!), we can now support configuration of
webpack-dev-server
's proxy via ourdocusaurus-plugin-proxy
plugin.This can be useful when you have a separate API backend development server and you want to send API requests on the same domain.
With the following, a request to
/api/users
will now proxy the request tohttp://localhost:3001/api/users
:// docusaurus.config.js const config = { plugins: [["docusaurus-plugin-proxy", { "/api": "http://localhost:3001" }]], // ... };
To proxy
/api/users
tohttp://localhost:3001/users
, the path can be rewritten:// docusaurus.config.js const config = { plugins: [ [ "docusaurus-plugin-proxy", { "/api": { target: "http://localhost:3001", pathRewrite: { "^/api": "" }, }, }, ], ], // ... };
For more config options, see devServer.proxy.
-
Better yarn 3 support
Other enhancements and bug fixes
v0.3.1
0.3.1 (Dec 21, 2021)
High level enhancements
-
Added support for more schema qualifiers:
- maxLength - minLength - maximum - minumum - exclusiveMaximum - exclusiveMinimum - pattern
Example:
slug: type: string description: The human-readable, unique identifier, used to identify the document. minLength: 1 maxLength: 40 pattern: "^[a-zA-Z0-9_-]*$"
Displays:
slug
stringPossible values: 1 ≤ length ≤ 40, Value must match regular expression
^[a-zA-Z0-9_-]*$
The human-readable, unique identifier, used to identify the document.
Other enhancements and bug fixes
v0.3.0
0.3.0 (Dec 16, 2021)
High level enhancements
-
Docusaurus beta.13 support (Thanks @Josh-Cena!)
// Be sure to update @docusaurus/core: "dependencies": { "@docusaurus/core": "2.0.0-beta.13", // ... }
-
The OpenAPI
info
stanza will now generate an "Introduction" pageopenapi: 3.0.3 info: title: Swagger Petstore version: 1.0.0 description: | This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters.
-
Request bodies will now render JSON Schema with the use of
allOf
keywordsrequestBody: content: description: Example request application/json: schema: allOf: - $ref: "#/components/schema/Example1" - $ref: "#/components/schema/Example2"
-
Enum options will now be displayed in schema tables
status
stringEnum:
"available"
,"pending"
,"sold"
Pet status in the store
Other enhancements and bug fixes
v0.2.3
v0.2.2
0.2.2 (Dec 6, 2021)
Fix broken package