You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: harmonize top-level README with plugin README (#1446)
Resolve drift uncovered during the v5.0.2 release scrub. Both READMEs
and the demo intro page should describe the same plugin surface.
- Top-level README: add the missing `Supported Vendor Extensions`
section (table + ignored-extensions paragraph), the `x-position`
hint under `sidebarOptions`, the `maskCredentials` example-config
line, and the `Extensible` Key Feature bullet. Move the
`maskCredentials` row up next to `showExtensions` so related
rendering toggles sit together.
- Plugin README: add the `Extensible` Key Feature bullet and linkify
`@bourdakos1` to match the top-level README.
`demo/docs/intro.mdx` already had this content and is unchanged.
Copy file name to clipboardExpand all lines: README.md
+22-1Lines changed: 22 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,6 +36,7 @@ Key Features:
36
36
-**Fast:** Convert large OpenAPI specs into MDX docs in seconds. 🔥
37
37
-**Stylish:** Based on the same [Infima styling framework](https://infima.dev/) that powers the Docusaurus UI.
38
38
-**Flexible:** Supports single, multi and _even micro_ OpenAPI specs.
39
+
-**Extensible:** Recognizes common vendor extensions for customizing your docs. See [Supported Vendor Extensions](#supported-vendor-extensions) for details.
39
40
40
41
## Compatibility Matrix
41
42
@@ -125,6 +126,7 @@ import type * as OpenApiPlugin from "docusaurus-plugin-openapi-docs";
125
126
petstore: {
126
127
specPath: "examples/petstore.yaml",
127
128
outputDir: "docs/petstore",
129
+
maskCredentials: false, // Disable credential masking in code snippets
128
130
sidebarOptions: {
129
131
groupPathsBy: "tag",
130
132
},
@@ -165,6 +167,7 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
|`hideSendButton`|`boolean`|`null`|_Optional:_ If set to `true`, hides the “Send API Request” button in the API demo panel. |
167
169
|`showExtensions`|`boolean`|`null`|_Optional:_ If set to `true`, renders operation‑level vendor‑extensions in descriptions. |
170
+
|`maskCredentials`|`boolean`|`true`|_Optional:_ If set to `false`, disables credential masking in generated code snippets. By default, credentials are masked for security. |
168
171
|`sidebarOptions`|`object`|`null`|_Optional:_ Set of options for sidebar configuration. See below for a list of supported options. |
169
172
|`version`|`string`|`null`|_Optional:_ Version assigned to a single or micro‑spec API specified in `specPath`. |
170
173
|`label`|`string`|`null`|_Optional:_ Version label used when generating the version‑selector dropdown menu. |
@@ -174,7 +177,6 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
174
177
|`showSchemas`|`boolean`|`null`|_Optional:_ If set to `true`, generates standalone schema pages and adds them to the sidebar. |
175
178
|`showInfoPage`|`boolean`|`true`|_Optional:_ If set to `false`, disables generation of the info page (overview page with API title and description). |
176
179
|`schemasOnly`|`boolean`|`false`|_Optional:_ If set to `true`, generates only schema pages (no API endpoint pages). Also available as `--schemas-only` CLI flag. |
177
-
|`maskCredentials`|`boolean`|`true`|_Optional:_ If set to `false`, disables credential masking in generated code snippets. By default, credentials are masked for security. |
178
180
|`externalJsonProps`|`boolean`|`true`|_Optional:_ If set to `false`, disables externalization of large JSON props. By default, large JSON is written to external files for better build performance. |
179
181
180
182
### sidebarOptions
@@ -191,6 +193,7 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
191
193
|`sidebarGenerators`|`object`|`null`| Optional: Customize sidebar rendering with callback functions. |
192
194
193
195
> You may optionally configure a `sidebarOptions`. In doing so, an individual `sidebar.js` slice with the configured options will be generated within the respective `outputDir`.
196
+
> Use `x-position` vendor extension (or the front matter `position`) on operations to explicitly order sidebar items.
194
197
195
198
`versions` can be configured with the following options:
196
199
@@ -272,6 +275,24 @@ Example:
272
275
}
273
276
```
274
277
278
+
## Supported Vendor Extensions
279
+
280
+
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.
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.
Copy file name to clipboardExpand all lines: packages/docusaurus-plugin-openapi-docs/README.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,6 +36,7 @@ Key Features:
36
36
-**Fast:** Convert large OpenAPI specs into MDX docs in seconds. 🔥
37
37
-**Stylish:** Based on the same [Infima styling framework](https://infima.dev/) that powers the Docusaurus UI.
38
38
-**Flexible:** Supports single, multi and _even micro_ OpenAPI specs.
39
+
-**Extensible:** Recognizes common vendor extensions for customizing your docs. See [Supported Vendor Extensions](#supported-vendor-extensions) for details.
39
40
40
41
## Compatibility Matrix
41
42
@@ -437,7 +438,7 @@ yarn watch:demo
437
438
438
439
## Credits
439
440
440
-
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.
441
+
Special thanks to [@bourdakos1](https://github.com/bourdakos1) (Nick Bourdakos), the author of [docusaurus-openapi](https://github.com/cloud-annotations/docusaurus-openapi), which this project is heavily based on.
441
442
442
443
For more insight into why we decided to completely fork see [#47](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/47)
0 commit comments