diff --git a/CHANGELOG.md b/CHANGELOG.md index 8ce96e91b..0b39b66f4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,13 @@ +## 2.2.1 (Jul 3, 2024) + +High level enhancements + +- Fixed regression bug + +Other enhancements and bug fixes + +- Fall back to languageSet if no languageTabs provided ([#871](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/871)) + ## 2.2.0 (Jul 3, 2024) High level enhancements diff --git a/README.md b/README.md index c7b689d66..6fd60456d 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@
-OpenAPI plugin for generating API reference docs in Docusaurus v2. +OpenAPI plugin for generating API reference docs in Docusaurus v3.

@@ -28,11 +28,11 @@ OpenAPI plugin for generating API reference docs in Docusaurus v2. ## Overview -The `docusaurus-plugin-openapi-docs` package extends the Docusaurus CLI with commands for generating MDX using the OpenAPI specification as the source. The resulting MDX is fully compatible with [plugin-content-docs](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs) and can be used to render beautiful reference API docs by setting `docItemComponent` to `@theme/ApiItem`, a custom component included in the `docusaurus-theme-openapi-docs` theme. +The `docusaurus-plugin-openapi-docs` package extends the Docusaurus CLI with commands for generating MDX using the OpenAPI specification as the source. The resulting MDX is fully compatible with [plugin-content-docs](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs) and can be used to render beautiful reference API docs when combined with the `docusaurus-theme-openapi-docs` theme. Key Features: -- **Compatible:** Works with Swagger 2.0 and OpenAPI 3.0. +- **Compatible:** Works with Swagger 2.0 and OpenAPI 3.x. - **Fast:** Convert large OpenAPI specs into MDX docs in seconds. 🔥 - **Stylish:** Based on the same [Infima styling framework](https://infima.dev/) that powers the Docusaurus UI. - **Flexible:** Supports single, multi and _even micro_ OpenAPI specs. @@ -41,16 +41,16 @@ Key Features: | Docusaurus OpenAPI Docs | Docusaurus | | ----------------------- | --------------- | -| 3.0.0-beta.x (beta) | `3.0.1 - 3.1.1` | -| 2.0.x (current) | `2.4.1 - 2.4.3` | +| 3.0.1 (current) | `3.0.1 - 3.4.0` | +| 2.2.1 (legacy) | `2.4.1 - 2.4.3` | | 1.7.3 (legacy) | `2.0.1 - 2.2.0` | ## Bootstrapping from Template (new Docusaurus site) -Run the following to bootstrap a Docsaurus v2 site (classic theme) with `docusaurus-openapi-docs`: +Run the following to bootstrap a Docsaurus v3 site (classic theme) with `docusaurus-openapi-docs`: ```bash -npx create-docusaurus@2.4.3 my-website --package-manager yarn +npx create-docusaurus@3.4.0 my-website --package-manager yarn ``` > When prompted to select a template choose `Git repository`. @@ -61,57 +61,59 @@ Template Repository URL: https://github.com/PaloAltoNetworks/docusaurus-template-openapi-docs.git ``` -> When asked how the template repo should be cloned choose "copy" (unless you know better). +> When asked how the template repo should be cloned choose "copy". ```bash cd my-website yarn start ``` +If all goes well, you should be greeted by a brand new Docusaurus site that includes API reference docs for the ubiquitous Petstore API! + ## Installation (existing Docusaurus site) -Plugin: +> Both the plugin and theme are currently designed to pair with a specific Docusaurus release. The Docusaurus badge in the `README.md` and at the top of this page will always reflect the current compatible versions. + +### Plugin ```bash yarn add docusaurus-plugin-openapi-docs ``` -Theme: +### Theme ```bash yarn add docusaurus-theme-openapi-docs ``` -## Configuring `docusaurus.config.js` (Plugin and theme usage) +## Configuring `docusaurus.config.ts` (Plugin and theme usage) -Here is an example of properly configuring `docusaurus.config.js` file for `docusaurus-plugin-openapi-docs` and `docusaurus-theme-openapi-docs` usage. +Here is an example of properly configuring `docusaurus.config.ts` for `docusaurus-plugin-openapi-docs` and `docusaurus-theme-openapi-docs` usage. -```js -// docusaurus.config.js +> Note: Instructions may differ slightly for sites that haven't migrated to typescript. + +```typescript +// docusaurus.config.ts +// note that parts of the complete config were left out for brevity +import type * as Preset from "@docusaurus/preset-classic"; +import type { Config } from "@docusaurus/types"; +import type * as Plugin from "@docusaurus/types/src/plugin"; +import type * as OpenApiPlugin from "docusaurus-plugin-openapi-docs"; { presets: [ [ "classic", - /** @type {import('@docusaurus/preset-classic').Options} */ - ({ + { docs: { - sidebarPath: require.resolve("./sidebars.js"), - editUrl: - "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/", - docLayoutComponent: "@theme/DocPage", - docItemComponent: "@theme/ApiItem" // derived from docusaurus-theme-openapi-docs - }, - blog: { - showReadingTime: true, - editUrl: - "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/" + sidebarPath: "./sidebars.ts", + docItemComponent: "@theme/ApiItem", // Derived from docusaurus-theme-openapi }, theme: { - customCss: require.resolve("./src/css/custom.css") - } - }) - ] + customCss: "./src/css/custom.css", + }, + } satisfies Preset.Options, + ], ], plugins: [ @@ -119,19 +121,15 @@ Here is an example of properly configuring `docusaurus.config.js` file for `docu 'docusaurus-plugin-openapi-docs', { id: "api", // plugin id - docsPluginId: "classic", // id of plugin-content-docs or preset for rendering docs + docsPluginId: "classic", // configured for preset-classic config: { - petstore: { // the referenced when running CLI commands - specPath: "examples/petstore.yaml", // path to OpenAPI spec, URLs supported - outputDir: "api/petstore", // output directory for generated files - sidebarOptions: { // optional, instructs plugin to generate sidebar.js - groupPathsBy: "tag", // group sidebar items by operation "tag" + petstore: { + specPath: "examples/petstore.yaml", + outputDir: "docs/petstore", + sidebarOptions: { + groupPathsBy: "tag", }, - }, - burgers: { - specPath: "examples/food/burgers/openapi.yaml", - outputDir: "api/food/burgers", - } + } satisfies OpenApiPlugin.Options, } }, ] @@ -226,11 +224,12 @@ Commands: write-translations [options] [siteDir] Extract required translations of your site. write-heading-ids [options] [siteDir] [files...] Generate heading ids in Markdown content. docs:version Tag a new docs version - gen-api-docs Generates OpenAPI docs in MDX file format and sidebar.js (if enabled). - gen-api-docs:version Generates versioned OpenAPI docs in MDX file format, versions.js and sidebar.js (if enabled). - clean-api-docs Clears the generated OpenAPI docs MDX files and sidebar.js (if enabled). - clean-api-docs:version Clears the versioned, generated OpenAPI docs MDX files, versions.json and sidebar.js (if + gen-api-docs [options] Generates OpenAPI docs in MDX file format and sidebar.ts (if enabled). + gen-api-docs:version [options] Generates versioned OpenAPI docs in MDX file format, versions.js and sidebar.ts (if enabled). + clean-api-docs [options] Clears the generated OpenAPI docs MDX files and sidebar.ts (if enabled). + clean-api-docs:version [options] Clears the versioned, generated OpenAPI docs MDX files, versions.json and sidebar.ts + (if enabled) ``` ### Generating OpenAPI Docs @@ -252,10 +251,10 @@ yarn docusaurus gen-api-docs Example: ```bash -yarn docusaurus gen-api-docs burgers +yarn docusaurus gen-api-docs petstore ``` -> The example above will only generate API docs relative to `burgers`. +> The example above will only generate API docs relative to `petstore`. ### Cleaning API Docs @@ -274,7 +273,7 @@ yarn docusaurus clean-api-docs Example: ```bash -yarn docusaurus clean-api-docs burgers +yarn docusaurus clean-api-docs petstore ``` > The example above will remove all API docs relative to `burgers`. diff --git a/demo/package.json b/demo/package.json index aad62d64d..1af9d074a 100644 --- a/demo/package.json +++ b/demo/package.json @@ -1,6 +1,6 @@ { "name": "demo", - "version": "2.2.0", + "version": "2.2.1", "private": true, "scripts": { "docusaurus": "docusaurus", @@ -27,7 +27,7 @@ "@mdx-js/react": "^1.6.22", "clsx": "^1.1.1", "docusaurus-plugin-openapi-docs": "^2.2.0", - "docusaurus-theme-openapi-docs": "^2.2.0", + "docusaurus-theme-openapi-docs": "^2.2.1", "prism-react-renderer": "^1.3.1", "react": "^18.2.0", "react-dom": "^18.2.0" diff --git a/lerna.json b/lerna.json index 91d66593d..49c34af7e 100644 --- a/lerna.json +++ b/lerna.json @@ -1,5 +1,5 @@ { - "version": "2.2.0", + "version": "2.2.1", "npmClient": "yarn", "useWorkspaces": true } diff --git a/packages/docusaurus-plugin-openapi-docs/README.md b/packages/docusaurus-plugin-openapi-docs/README.md index a775eeccb..6fd60456d 100644 --- a/packages/docusaurus-plugin-openapi-docs/README.md +++ b/packages/docusaurus-plugin-openapi-docs/README.md @@ -6,23 +6,33 @@
-OpenAPI plugin for generating API reference docs in Docusaurus v2. +OpenAPI plugin for generating API reference docs in Docusaurus v3. + + +

+ +[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/LICENSE) [![npm latest package](https://img.shields.io/npm/v/docusaurus-plugin-openapi-docs/latest.svg)](https://www.npmjs.com/package/docusaurus-plugin-openapi-docs) [![npm downloads](https://img.shields.io/npm/dm/docusaurus-plugin-openapi-docs.svg)](https://www.npmjs.com/package/docusaurus-plugin-openapi-docs) [![npm canary package](https://img.shields.io/npm/v/docusaurus-plugin-openapi-docs/canary.svg)](https://www.npmjs.com/package/docusaurus-plugin-openapi-docs) [![npm beta package](https://img.shields.io/npm/v/docusaurus-plugin-openapi-docs/beta.svg)](https://www.npmjs.com/package/docusaurus-plugin-openapi-docs) +
+[![build](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/actions/workflows/validate.yaml/badge.svg)](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/actions/workflows/validate.yaml) [![prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier) [![Cypress.io](https://img.shields.io/badge/tested%20with-Cypress-04C38E.svg)](https://www.cypress.io/) [![jest](https://jestjs.io/img/jest-badge.svg)](https://github.com/facebook/jest) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/HEAD/CONTRIBUTING.md#pull-requests) +

-delete-a-pet +

+--- + ## Overview -The `docusaurus-plugin-openapi-docs` package extends the Docusaurus CLI with commands for generating MDX using the OpenAPI specification as the source. The resulting MDX is fully compatible with [plugin-content-docs](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs) and can be used to render beautiful reference API docs by setting `docItemComponent` to `@theme/ApiItem`, a custom component included in the `docusaurus-theme-openapi-docs` theme. +The `docusaurus-plugin-openapi-docs` package extends the Docusaurus CLI with commands for generating MDX using the OpenAPI specification as the source. The resulting MDX is fully compatible with [plugin-content-docs](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs) and can be used to render beautiful reference API docs when combined with the `docusaurus-theme-openapi-docs` theme. Key Features: -- **Compatible:** Works with Swagger 2.0 and OpenAPI 3.0. +- **Compatible:** Works with Swagger 2.0 and OpenAPI 3.x. - **Fast:** Convert large OpenAPI specs into MDX docs in seconds. 🔥 - **Stylish:** Based on the same [Infima styling framework](https://infima.dev/) that powers the Docusaurus UI. - **Flexible:** Supports single, multi and _even micro_ OpenAPI specs. @@ -31,16 +41,16 @@ Key Features: | Docusaurus OpenAPI Docs | Docusaurus | | ----------------------- | --------------- | -| 3.0.0-beta.x (beta) | `3.0.1 - 3.1.1` | -| 2.0.x (current) | `2.4.1 - 2.4.3` | +| 3.0.1 (current) | `3.0.1 - 3.4.0` | +| 2.2.1 (legacy) | `2.4.1 - 2.4.3` | | 1.7.3 (legacy) | `2.0.1 - 2.2.0` | ## Bootstrapping from Template (new Docusaurus site) -Run the following to bootstrap a Docsaurus v2 site (classic theme) with `docusaurus-openapi-docs`: +Run the following to bootstrap a Docsaurus v3 site (classic theme) with `docusaurus-openapi-docs`: ```bash -npx create-docusaurus@2.4.3 my-website --package-manager yarn +npx create-docusaurus@3.4.0 my-website --package-manager yarn ``` > When prompted to select a template choose `Git repository`. @@ -51,57 +61,59 @@ Template Repository URL: https://github.com/PaloAltoNetworks/docusaurus-template-openapi-docs.git ``` -> When asked how the template repo should be cloned choose "copy" (unless you know better). +> When asked how the template repo should be cloned choose "copy". ```bash cd my-website yarn start ``` +If all goes well, you should be greeted by a brand new Docusaurus site that includes API reference docs for the ubiquitous Petstore API! + ## Installation (existing Docusaurus site) -Plugin: +> Both the plugin and theme are currently designed to pair with a specific Docusaurus release. The Docusaurus badge in the `README.md` and at the top of this page will always reflect the current compatible versions. + +### Plugin ```bash yarn add docusaurus-plugin-openapi-docs ``` -Theme: +### Theme ```bash yarn add docusaurus-theme-openapi-docs ``` -## Configuring `docusaurus.config.js` (Plugin and theme usage) +## Configuring `docusaurus.config.ts` (Plugin and theme usage) -Here is an example of properly configuring `docusaurus.config.js` file for `docusaurus-plugin-openapi-docs` and `docusaurus-theme-openapi-docs` usage. +Here is an example of properly configuring `docusaurus.config.ts` for `docusaurus-plugin-openapi-docs` and `docusaurus-theme-openapi-docs` usage. -```js -// docusaurus.config.js +> Note: Instructions may differ slightly for sites that haven't migrated to typescript. + +```typescript +// docusaurus.config.ts +// note that parts of the complete config were left out for brevity +import type * as Preset from "@docusaurus/preset-classic"; +import type { Config } from "@docusaurus/types"; +import type * as Plugin from "@docusaurus/types/src/plugin"; +import type * as OpenApiPlugin from "docusaurus-plugin-openapi-docs"; { presets: [ [ "classic", - /** @type {import('@docusaurus/preset-classic').Options} */ - ({ + { docs: { - sidebarPath: require.resolve("./sidebars.js"), - editUrl: - "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/", - docLayoutComponent: "@theme/DocPage", - docItemComponent: "@theme/ApiItem" // derived from docusaurus-theme-openapi-docs - }, - blog: { - showReadingTime: true, - editUrl: - "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/" + sidebarPath: "./sidebars.ts", + docItemComponent: "@theme/ApiItem", // Derived from docusaurus-theme-openapi }, theme: { - customCss: require.resolve("./src/css/custom.css") - } - }) - ] + customCss: "./src/css/custom.css", + }, + } satisfies Preset.Options, + ], ], plugins: [ @@ -109,19 +121,15 @@ Here is an example of properly configuring `docusaurus.config.js` file for `docu 'docusaurus-plugin-openapi-docs', { id: "api", // plugin id - docsPluginId: "classic", // id of plugin-content-docs or preset for rendering docs + docsPluginId: "classic", // configured for preset-classic config: { - petstore: { // the referenced when running CLI commands - specPath: "examples/petstore.yaml", // path to OpenAPI spec, URLs supported - outputDir: "api/petstore", // output directory for generated files - sidebarOptions: { // optional, instructs plugin to generate sidebar.js - groupPathsBy: "tag", // group sidebar items by operation "tag" + petstore: { + specPath: "examples/petstore.yaml", + outputDir: "docs/petstore", + sidebarOptions: { + groupPathsBy: "tag", }, - }, - burgers: { - specPath: "examples/food/burgers/openapi.yaml", - outputDir: "api/food/burgers", - } + } satisfies OpenApiPlugin.Options, } }, ] @@ -136,10 +144,11 @@ Here is an example of properly configuring `docusaurus.config.js` file for `docu The `docusaurus-plugin-openapi-docs` plugin can be configured with the following options: -| Name | Type | Default | Description | -| -------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | `string` | `null` | A unique plugin id. | -| `docsPluginId` | `string` | `null` | The ID associated with the `plugin-content-docs` or `preset` instance used to render the OpenAPI docs (e.g. "your-plugin-id", "classic", "default"). | +| Name | Type | Default | Description | +| -------------- | -------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `id` | `string` | `null` | A unique plugin ID. | +| `docsPlugin` | `string` | `@docusaurus/plugin-content-docs` | The plugin used to render the OpenAPI docs (ignored if the plugin instance referenced by `docsPluginId` is a `preset`). | +| `docsPluginId` | `string` | `null` | The plugin ID associated with the `preset` or configured `docsPlugin` instance used to render the OpenAPI docs (e.g. "your-plugin-id", "classic", "default"). | ### config @@ -148,7 +157,7 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following | Name | Type | Default | Description | | -------------------- | --------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | | `specPath` | `string` | `null` | Designated URL or path to the source of an OpenAPI specification file or directory of multiple OpenAPI specification files. | -| `ouputDir` | `string` | `null` | Desired output path for generated MDX files. | +| `ouputDir` | `string` | `null` | Desired output path for generated MDX and sidebar files. | | `proxy` | `string` | `null` | _Optional:_ Proxy URL to prepend to base URL when performing API requests from browser. | | `template` | `string` | `null` | _Optional:_ Customize MDX content with a desired template. | | `downloadUrl` | `string` | `null` | _Optional:_ Designated URL for downloading OpenAPI specification. (requires `info` section/doc) | @@ -166,7 +175,7 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following | Name | Type | Default | Description | | -------------------- | --------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `groupPathsBy` | `string` | `null` | Organize and group sidebar slice by specified option. Note: Currently, `groupPathsBy` only contains support for grouping by `tag`. | +| `groupPathsBy` | `string` | `null` | Organize and group sidebar slice by specified option. Note: Currently, `groupPathsBy` only contains support for grouping by `tag` and `tagGroup`. | | `categoryLinkSource` | `string` | `null` | Defines what source to use for rendering category link pages when grouping paths by tag.

The supported options are as follows:

`tag`: Sets the category link config type to `generated-index` and uses the tag description as the link config description.

`info`: Sets the category link config type to `doc` and renders the `info` section as the category link (recommended only for multi/micro-spec scenarios).

`none`: Does not create pages for categories, only groups that can be expanded/collapsed. | | `sidebarCollapsible` | `boolean` | `true` | Whether sidebar categories are collapsible by default. | | `sidebarCollapsed` | `boolean` | `true` | Whether sidebar categories are collapsed by default. | @@ -189,11 +198,12 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following `markdownGenerators` can be configured with the following options: -| Name | Type | Default | Description | -| ------------------ | ---------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `createApiPageMD` | `function` | `null` | _Optional:_ Returns a string of the raw markdown body for API pages.

**Function type:** `(pageData: ApiPageMetadata) => string` | -| `createInfoPageMD` | `function` | `null` | _Optional:_ Returns a string of the raw markdown body for info pages.

**Function type:** `(pageData: InfoPageMetadata) => string` | -| `createTagPageMD` | `function` | `null` | _Optional:_ Returns a string of the raw markdown body for tag pages.

**Function type:** `(pageData: TagPageMetadata) => string` | +| Name | Type | Default | Description | +| -------------------- | ---------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | +| `createApiPageMD` | `function` | `null` | _Optional:_ Returns a string of the raw markdown body for API pages.

**Function type:** `(pageData: ApiPageMetadata) => string` | +| `createInfoPageMD` | `function` | `null` | _Optional:_ Returns a string of the raw markdown body for info pages.

**Function type:** `(pageData: InfoPageMetadata) => string` | +| `createTagPageMD` | `function` | `null` | _Optional:_ Returns a string of the raw markdown body for tag pages.

**Function type:** `(pageData: TagPageMetadata) => string` | +| `createSchemaPageMD` | `function` | `null` | _Optional:_ Returns a string of the raw markdown body for schema pages.

**Function type:** `(pageData: SchemaPageMetadata) => string` | ## CLI Usage @@ -214,11 +224,12 @@ Commands: write-translations [options] [siteDir] Extract required translations of your site. write-heading-ids [options] [siteDir] [files...] Generate heading ids in Markdown content. docs:version Tag a new docs version - gen-api-docs Generates OpenAPI docs in MDX file format and sidebar.js (if enabled). - gen-api-docs:version Generates versioned OpenAPI docs in MDX file format, versions.js and sidebar.js (if enabled). - clean-api-docs Clears the generated OpenAPI docs MDX files and sidebar.js (if enabled). - clean-api-docs:version Clears the versioned, generated OpenAPI docs MDX files, versions.json and sidebar.js (if + gen-api-docs [options] Generates OpenAPI docs in MDX file format and sidebar.ts (if enabled). + gen-api-docs:version [options] Generates versioned OpenAPI docs in MDX file format, versions.js and sidebar.ts (if enabled). + clean-api-docs [options] Clears the generated OpenAPI docs MDX files and sidebar.ts (if enabled). + clean-api-docs:version [options] Clears the versioned, generated OpenAPI docs MDX files, versions.json and sidebar.ts + (if enabled) ``` ### Generating OpenAPI Docs @@ -240,10 +251,10 @@ yarn docusaurus gen-api-docs Example: ```bash -yarn docusaurus gen-api-docs burgers +yarn docusaurus gen-api-docs petstore ``` -> The example above will only generate API docs relative to `burgers`. +> The example above will only generate API docs relative to `petstore`. ### Cleaning API Docs @@ -262,7 +273,7 @@ yarn docusaurus clean-api-docs Example: ```bash -yarn docusaurus clean-api-docs burgers +yarn docusaurus clean-api-docs petstore ``` > The example above will remove all API docs relative to `burgers`. @@ -299,6 +310,20 @@ yarn build-packages yarn watch:demo ``` +## Credits + +Special thanks to @bourdakos1 (Nick Bourdakos), the author of [docusaurus-openapi](https://github.com/cloud-annotations/docusaurus-openapi), which this project is heavily based on. + +For more insight into why we decided to completely fork see [#47](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/47) + +## Contributors + + + + + ## Support -Please read [SUPPORT.md](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/main/SUPPORT.md) for details on how to get support for this project. +See [SUPPORT.md](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/main/SUPPORT.md) for our support agreement and guidelines. + +If you believe you found a bug or have an idea you'd like to suggest you may [report an issue](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/issues/new/choose) or [start a discussion](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/discussions/new/choose). diff --git a/packages/docusaurus-plugin-openapi-docs/package.json b/packages/docusaurus-plugin-openapi-docs/package.json index 599116f1d..bf93bfed3 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": "2.2.0", + "version": "2.2.1", "license": "MIT", "keywords": [ "openapi", diff --git a/packages/docusaurus-theme-openapi-docs/package.json b/packages/docusaurus-theme-openapi-docs/package.json index 5fca1c869..1c21cec3c 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": "2.2.0", + "version": "2.2.1", "license": "MIT", "keywords": [ "openapi",