docusaurus-plugin-openapi-docs 0.0.0-1103 → 0.0.0-1105
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 +7 -5
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -253,11 +253,12 @@ petstore: {
|
|
|
253
253
|
|
|
254
254
|
The `docusaurus-theme-openapi-docs` theme can be configured with the following options in `themeConfig.api`:
|
|
255
255
|
|
|
256
|
-
| Name
|
|
257
|
-
|
|
|
258
|
-
| `proxy`
|
|
259
|
-
| `authPersistance`
|
|
260
|
-
| `requestTimeout`
|
|
256
|
+
| Name | Type | Default | Description |
|
|
257
|
+
| -------------------- | -------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
|
|
258
|
+
| `proxy` | `string` | `null` | _Optional:_ Site-wide proxy URL to prepend to base URL when performing API requests. Can be overridden per-spec via plugin config. |
|
|
259
|
+
| `authPersistance` | `string` | `null` | _Optional:_ Determines how auth credentials are persisted. Options: `"localStorage"`, `"sessionStorage"`, or `false` to disable. |
|
|
260
|
+
| `requestTimeout` | `number` | `30000` | _Optional:_ Request timeout in milliseconds for API requests made from the browser. Defaults to 30 seconds. |
|
|
261
|
+
| `requestCredentials` | `string` | `"same-origin"` | _Optional:_ Controls cookie behavior for API requests. Options: `"omit"`, `"same-origin"`, or `"include"`. |
|
|
261
262
|
|
|
262
263
|
Example:
|
|
263
264
|
|
|
@@ -269,6 +270,7 @@ Example:
|
|
|
269
270
|
proxy: "https://cors.pan.dev", // Site-wide proxy (can be overridden per-spec in plugin config)
|
|
270
271
|
authPersistance: "localStorage",
|
|
271
272
|
requestTimeout: 60000, // 60 seconds
|
|
273
|
+
requestCredentials: "omit", // Prevent cookies from being sent with requests
|
|
272
274
|
},
|
|
273
275
|
},
|
|
274
276
|
}
|
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-1105",
|
|
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": "5a573d71d569e71efd1a08fc4abbd4c822533e55"
|
|
69
69
|
}
|