docusaurus-plugin-openapi-docs 0.0.0-1008 → 0.0.0-1010
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 +10 -9
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -48,7 +48,7 @@ Key Features:
|
|
|
48
48
|
|
|
49
49
|
## Bootstrapping from Template (new Docusaurus site)
|
|
50
50
|
|
|
51
|
-
Run the following to bootstrap a
|
|
51
|
+
Run the following to bootstrap a Docusaurus v3 site (classic theme) with `docusaurus-openapi-docs`:
|
|
52
52
|
|
|
53
53
|
```bash
|
|
54
54
|
npx create-docusaurus@3.7.0 my-website --package-manager yarn
|
|
@@ -192,12 +192,13 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
|
|
|
192
192
|
|
|
193
193
|
`versions` can be configured with the following options:
|
|
194
194
|
|
|
195
|
-
| Name
|
|
196
|
-
|
|
|
197
|
-
| `specPath`
|
|
198
|
-
| `
|
|
199
|
-
| `label`
|
|
200
|
-
| `baseUrl`
|
|
195
|
+
| Name | Type | Default | Description |
|
|
196
|
+
| ------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------- |
|
|
197
|
+
| `specPath` | `string` | `null` | Designated URL or path to the source of an OpenAPI specification file or a directory of micro OpenAPI specification files. |
|
|
198
|
+
| `outputDir` | `string` | `null` | Desired output path for versioned, generated MDX files. |
|
|
199
|
+
| `label` | `string` | `null` | _Optional:_ Version label used when generating the version selector dropdown menu. |
|
|
200
|
+
| `baseUrl` | `string` | `null` | _Optional:_ Version base URL used when generating the version selector dropdown menu. |
|
|
201
|
+
| `downloadUrl` | `string` | `null` | _Optional:_ Designated URL for downloading the versioned OpenAPI specification. |
|
|
201
202
|
|
|
202
203
|
> All versions will automatically inherit `sidebarOptions` from the parent/base config.
|
|
203
204
|
|
|
@@ -329,11 +330,11 @@ yarn docusaurus gen-api-docs:version petstore:all
|
|
|
329
330
|
|
|
330
331
|
> This will generate API docs for all of the OpenAPI specification (OAS) files referenced in your `versions` config and will also generate a `versions.json` file.
|
|
331
332
|
|
|
332
|
-
>
|
|
333
|
+
> Substitute `all` with a specific version ID to generate or clean a specific version. Generating for `all` or a single version ID will automatically update the `versions.json` file.
|
|
333
334
|
|
|
334
335
|
## Developer Quick Start
|
|
335
336
|
|
|
336
|
-
> Looking to make a contribution? Make sure to
|
|
337
|
+
> Looking to make a contribution? Make sure to check out our contributing guide.
|
|
337
338
|
|
|
338
339
|
After [forking](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/fork) the main repository, run the following:
|
|
339
340
|
|
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-1010",
|
|
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": "5348bdfc01228df1025d380a949689f833dcfc13"
|
|
69
69
|
}
|