Skip to content

Releases: cloud-annotations/docusaurus-openapi

v0.2.1

06 Dec 04:48
d0a422a
Compare
Choose a tag to compare

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 to themeConfig.api. Defaults to "localStorage", can be set to false to disable or sessionStorage to only persist while the window is open.

Other enhancements and bug fixes

  • Add better auth support (#74)

v0.2.0

05 Dec 01:10
1fe5df5
Compare
Choose a tag to compare

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

  • Fix multi plugin bug (#69)
  • Add yaml support (#68)
  • Generate markdown for full page (#65)
  • Refactor plugin into separate packages (#64)
  • Update documentation (#63)

v0.1.1

25 Nov 00:49
f40016e
Compare
Choose a tag to compare

0.1.1 (Nov 24, 2021)

Enhancements and bug fixes

  • Fix missing status code description (#61)
  • Fix narrow tables style regression (#55)

v0.1.0

05 Nov 00:03
af4f36d
Compare
Choose a tag to compare

0.1.0 (Nov 4, 2021)

Enhancements and bug fixes

  • Update project structure (#52)
  • Update plugin to support Docusaurus 2.0.0 beta (#51)

v0.0.16

22 Apr 19:47
735e404
Compare
Choose a tag to compare
Merge pull request #25 from avaidyam/patch-1

Update useScrollPosition() in DocSidebar for docusaurus v0.74

v0.0.15

26 Mar 15:53
Compare
Choose a tag to compare
bug fixes

v0.0.14

24 Mar 14:24
4cb6edb
Compare
Choose a tag to compare
Merge pull request #20 from pcapanna/master

Validates ApiRequestBodyTable when attribute body.content is not defined

v0.0.13

17 Mar 18:10
b14fcf9
Compare
Choose a tag to compare
Merge pull request #18 from avaidyam/master

Add CI/CD via GitHub Actions