Skip to content

docs: document supported/unsupported vendor extensions #1184

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 30, 2025
Merged

docs: document supported/unsupported vendor extensions #1184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions demo/docs/intro.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,25 @@ Key Features:
- **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.
- **Extensible:** Recognizes common vendor extensions for customizing your docs. See [Vendor Extensions](./vendor-extensions) for details.

## Supported Vendor Extensions

The plugin extracts a number of vendor extensions from the OpenAPI spec to enrich the generated docs. The theme renders some of these values as part of the UI.

| Extension | Purpose |
| ------------------------------------------ | ----------------------------------------- |
| `x-codeSamples` | Operation level code snippets displayed in the API Explorer. |
| `x-tagGroups` | Groups tags in the sidebar navigation. |
| `x-tags` | Assigns tags to schema objects so they appear with tagged operations. |
| `x-position` | Controls ordering of items in the sidebar. |
| `x-logo` / `x-dark-logo` | Provides logos for light and dark themes on the intro page. |
| `x-deprecated-description` | Custom text shown for deprecated operations. |
| `x-webhooks` | Defines webhook events. |
| `x-displayName` | Overrides tag display names. |
| `x-enumDescription` / `x-enumDescriptions` | Documents enum values. |

Other ReDoc specific extensions such as `x-circular-ref`, `x-code-samples` (deprecated), `x-examples`, `x-ignoredHeaderParameters`, `x-nullable`, `x-servers`, `x-traitTag`, `x-additionalPropertiesName`, and `x-explicitMappingOnly` are ignored when extracting custom data.

---

Expand Down
24 changes: 24 additions & 0 deletions demo/docs/vendor-extensions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
id: vendor-extensions
hide_title: true
sidebar_label: Vendor Extensions
title: Vendor Extensions
---

## Overview

The OpenAPI plugin and theme recognize several [vendor extensions](https://swagger.io/specification/#specification-extensions) for customizing the generated documentation. Supported extensions include:

| Extension | Purpose |
|-----------|---------|
| `x-codeSamples` | Provide language specific code snippets for operations. These are displayed in the API Explorer panel. |
| `x-tagGroups` | Group tags in the sidebar navigation. |
| `x-tags` | Assign tags to schema objects so they appear with tagged operations when `groupPathsBy: tag` is enabled. |
| `x-position` | Explicit ordering of operations in the generated sidebar. |
| `x-logo` / `x-dark-logo` | Display light and dark logos on the introduction page. |
| `x-deprecated-description` | Custom text shown alongside deprecated operations. |
| `x-webhooks` | Define webhook events under the `x-webhooks` key. |
| `x-displayName` | Override tag names used for grouping. |
| `x-enumDescription` / `x-enumDescriptions` | Document individual enum values. |

Other ReDoc extensions such as `x-circular-ref`, `x-code-samples` (deprecated), `x-examples`, `x-ignoredHeaderParameters`, `x-nullable`, `x-servers`, `x-traitTag`, `x-additionalPropertiesName`, and `x-explicitMappingOnly` are detected but ignored when extracting custom extensions.
4 changes: 4 additions & 0 deletions demo/sidebars.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ const sidebars: SidebarsConfig = {
type: "doc",
id: "advanced",
},
{
type: "doc",
id: "vendor-extensions",
},
{
type: "category",
label: "Customization",
Expand Down
18 changes: 18 additions & 0 deletions packages/docusaurus-plugin-openapi-docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,24 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
| --------------- | ---------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `createDocItem` | `function` | `null` | Optional: Returns a `SidebarItemDoc` object containing metadata for a sidebar item.<br/><br/>**Function type:** `(item: ApiPageMetadata \| SchemaPageMetadata, context: { sidebarOptions: SidebarOptions; basePath: string }) => SidebarItemDoc` |

## Supported Vendor Extensions

The plugin extracts a number of vendor extensions from the OpenAPI spec to enrich the generated docs. The theme renders some of these values as part of the UI.

| Extension | Purpose |
| ------------------------------------------ | --------------------------------------------------------------------- |
| `x-codeSamples` | Operation level code snippets displayed in the API Explorer. |
| `x-tagGroups` | Groups tags in the sidebar navigation. |
| `x-tags` | Assigns tags to schema objects so they appear with tagged operations. |
| `x-position` | Controls ordering of items in the sidebar. |
| `x-logo` / `x-dark-logo` | Provides logos for light and dark themes on the intro page. |
| `x-deprecated-description` | Custom text shown for deprecated operations. |
| `x-webhooks` | Defines webhook events. |
| `x-displayName` | Overrides tag display names. |
| `x-enumDescription` / `x-enumDescriptions` | Documents enum values. |

Other ReDoc specific extensions such as `x-circular-ref`, `x-code-samples` (deprecated), `x-examples`, `x-ignoredHeaderParameters`, `x-nullable`, `x-servers`, `x-traitTag`, `x-additionalPropertiesName`, and `x-explicitMappingOnly` are ignored when extracting custom data.

## CLI Usage

```bash
Expand Down