Releases: cloud-annotations/docusaurus-openapi
Releases · cloud-annotations/docusaurus-openapi
v0.2.1
0.2.1 (Dec 5, 2021)
High level enhancements
- The demo panel now allows you to choose the security scheme from a dropdown that is populated by the OpenAPI definition (only showing the dropdown if more than one is listed)
- Adds support for using multiple auth modes simultaneously (Eg:
(BearerAuth) OR (ApiKeyAuth AND BasicAuth)
) - Adds an
authPersistence
option tothemeConfig.api
. Defaults to"localStorage"
, can be set tofalse
to disable orsessionStorage
to only persist while the window is open.
Other enhancements and bug fixes
- Add better auth support (#74)
v0.2.0
0.2.0 (Dec 4, 2021)
💥 Breaking Changes
The plugin option openapiPath
has been renamed to path
and no longer needs to be wrapped in require.resolve
.
As recomended my the Docusaurus documentation, the plugin docusaurus-plugin-api
has been properly split into 3 packages:
docusaurus-preset-api
docusaurus-plugin-api
docusaurus-theme-api
The package docusaurus-plugin-api
will no longer work on it's own without docusaurus-theme-api
. Instead, the preset docusaurus-preset-api
can be used on it's own and act as a drop-in replacement for @docusaurus/preset-classic
.
Example usage:
// docusaurus.config.js
const config = {
- plugins: [
- [
- "docusaurus-plugin-openapi",
- {
- openapiPath: require.resolve("./examples/openapi.json"),
- },
- ],
- ],
presets: [
[
- "@docusaurus/preset-classic",
+ "docusaurus-preset-openapi",
{
+ api: {
+ path: "examples/openapi.json",
+ }
docs: {
// doc options ...
},
blog: {
// blog options ...
},
theme: {
customCss: require.resolve("./src/css/custom.css"),
},
},
],
],
}
Other enhancements and bug fixes
v0.1.1
v0.1.0
v0.0.16
Merge pull request #25 from avaidyam/patch-1 Update useScrollPosition() in DocSidebar for docusaurus v0.74
v0.0.15
bug fixes
v0.0.14
Merge pull request #20 from pcapanna/master Validates ApiRequestBodyTable when attribute body.content is not defined
v0.0.13
Merge pull request #18 from avaidyam/master Add CI/CD via GitHub Actions