docusaurus-plugin-openapi-docs 0.0.0-1023 → 0.0.0-1024
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -222,6 +222,24 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
|
|
|
222
222
|
| --------------- | ---------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
223
223
|
| `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` |
|
|
224
224
|
|
|
225
|
+
## Supported Vendor Extensions
|
|
226
|
+
|
|
227
|
+
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.
|
|
228
|
+
|
|
229
|
+
| Extension | Purpose |
|
|
230
|
+
| ------------------------------------------ | --------------------------------------------------------------------- |
|
|
231
|
+
| `x-codeSamples` | Operation level code snippets displayed in the API Explorer. |
|
|
232
|
+
| `x-tagGroups` | Groups tags in the sidebar navigation. |
|
|
233
|
+
| `x-tags` | Assigns tags to schema objects so they appear with tagged operations. |
|
|
234
|
+
| `x-position` | Controls ordering of items in the sidebar. |
|
|
235
|
+
| `x-logo` / `x-dark-logo` | Provides logos for light and dark themes on the intro page. |
|
|
236
|
+
| `x-deprecated-description` | Custom text shown for deprecated operations. |
|
|
237
|
+
| `x-webhooks` | Defines webhook events. |
|
|
238
|
+
| `x-displayName` | Overrides tag display names. |
|
|
239
|
+
| `x-enumDescription` / `x-enumDescriptions` | Documents enum values. |
|
|
240
|
+
|
|
241
|
+
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.
|
|
242
|
+
|
|
225
243
|
## CLI Usage
|
|
226
244
|
|
|
227
245
|
```bash
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "docusaurus-plugin-openapi-docs",
|
|
3
3
|
"description": "OpenAPI plugin for Docusaurus.",
|
|
4
|
-
"version": "0.0.0-
|
|
4
|
+
"version": "0.0.0-1024",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"keywords": [
|
|
7
7
|
"openapi",
|
|
@@ -65,5 +65,5 @@
|
|
|
65
65
|
"engines": {
|
|
66
66
|
"node": ">=14"
|
|
67
67
|
},
|
|
68
|
-
"gitHead": "
|
|
68
|
+
"gitHead": "5b3af29a7954b19560f857ca7a7fb45702ce9094"
|
|
69
69
|
}
|