docusaurus-plugin-openapi-docs 0.0.0-412 → 0.0.0-415
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
CHANGED
|
@@ -246,7 +246,7 @@ yarn docusaurus gen-api-docs:version petstore:all
|
|
|
246
246
|
Run the following to bootstrap a Docsaurus v2 site (classic theme) with `docusaurus-openapi-docs`:
|
|
247
247
|
|
|
248
248
|
```bash
|
|
249
|
-
npx create-docusaurus@2.0.
|
|
249
|
+
npx create-docusaurus@2.0.1 my-website --package-manager yarn
|
|
250
250
|
```
|
|
251
251
|
|
|
252
252
|
> When prompted to select a template choose `Git repository`.
|
|
@@ -264,7 +264,7 @@ function createDiscriminator(schema) {
|
|
|
264
264
|
propertyDescription = schema.properties[propertyName].description;
|
|
265
265
|
}
|
|
266
266
|
}
|
|
267
|
-
return (0, utils_1.create)("
|
|
267
|
+
return (0, utils_1.create)("div", {
|
|
268
268
|
className: "discriminatorItem",
|
|
269
269
|
children: (0, utils_1.create)("div", {
|
|
270
270
|
children: [
|
|
@@ -372,7 +372,7 @@ function createPropertyDiscriminator(name, schemaName, schema, discriminator, re
|
|
|
372
372
|
if (discriminator.mapping === undefined) {
|
|
373
373
|
return undefined;
|
|
374
374
|
}
|
|
375
|
-
return (0, utils_1.create)("
|
|
375
|
+
return (0, utils_1.create)("div", {
|
|
376
376
|
className: "discriminatorItem",
|
|
377
377
|
children: (0, utils_1.create)("div", {
|
|
378
378
|
children: [
|
package/lib/markdown/schema.js
CHANGED
|
@@ -54,11 +54,18 @@ function getQualifierMessage(schema) {
|
|
|
54
54
|
if (!schema) {
|
|
55
55
|
return undefined;
|
|
56
56
|
}
|
|
57
|
-
if (schema.items
|
|
57
|
+
if (schema.items &&
|
|
58
|
+
schema.minItems === undefined &&
|
|
59
|
+
schema.maxItems === undefined) {
|
|
58
60
|
return getQualifierMessage(schema.items);
|
|
59
61
|
}
|
|
60
62
|
let message = "**Possible values:** ";
|
|
61
63
|
let qualifierGroups = [];
|
|
64
|
+
if (schema.items && schema.items.enum) {
|
|
65
|
+
if (schema.items.enum) {
|
|
66
|
+
qualifierGroups.push(`[${schema.items.enum.map((e) => `\`${e}\``).join(", ")}]`);
|
|
67
|
+
}
|
|
68
|
+
}
|
|
62
69
|
if (schema.minLength || schema.maxLength) {
|
|
63
70
|
let lengthQualifier = "";
|
|
64
71
|
let minLength;
|
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-415",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"keywords": [
|
|
7
7
|
"openapi",
|
|
@@ -28,8 +28,8 @@
|
|
|
28
28
|
"watch": "tsc --watch"
|
|
29
29
|
},
|
|
30
30
|
"devDependencies": {
|
|
31
|
-
"@docusaurus/module-type-aliases": "2.0.
|
|
32
|
-
"@docusaurus/types": "2.0.
|
|
31
|
+
"@docusaurus/module-type-aliases": "2.0.1",
|
|
32
|
+
"@docusaurus/types": "2.0.1",
|
|
33
33
|
"@types/fs-extra": "^9.0.13",
|
|
34
34
|
"@types/js-yaml": "^4.0.5",
|
|
35
35
|
"@types/json-pointer": "^1.0.31",
|
|
@@ -40,10 +40,10 @@
|
|
|
40
40
|
},
|
|
41
41
|
"dependencies": {
|
|
42
42
|
"@apidevtools/json-schema-ref-parser": "^9.0.9",
|
|
43
|
-
"@docusaurus/mdx-loader": "2.0.
|
|
44
|
-
"@docusaurus/plugin-content-docs": "2.0.
|
|
45
|
-
"@docusaurus/utils": "2.0.
|
|
46
|
-
"@docusaurus/utils-validation": "2.0.
|
|
43
|
+
"@docusaurus/mdx-loader": "2.0.1",
|
|
44
|
+
"@docusaurus/plugin-content-docs": "2.0.1",
|
|
45
|
+
"@docusaurus/utils": "2.0.1",
|
|
46
|
+
"@docusaurus/utils-validation": "2.0.1",
|
|
47
47
|
"@paloaltonetworks/openapi-to-postmanv2": "3.1.0-hotfix.1",
|
|
48
48
|
"@paloaltonetworks/postman-collection": "^4.1.0",
|
|
49
49
|
"@redocly/openapi-core": "^1.0.0-beta.103",
|
|
@@ -67,5 +67,5 @@
|
|
|
67
67
|
"engines": {
|
|
68
68
|
"node": ">=14"
|
|
69
69
|
},
|
|
70
|
-
"gitHead": "
|
|
70
|
+
"gitHead": "0d7099d46d0ca94ff39f4998c9b7d86a23975da2"
|
|
71
71
|
}
|
|
@@ -320,7 +320,7 @@ function createDiscriminator(schema: SchemaObject) {
|
|
|
320
320
|
}
|
|
321
321
|
}
|
|
322
322
|
|
|
323
|
-
return create("
|
|
323
|
+
return create("div", {
|
|
324
324
|
className: "discriminatorItem",
|
|
325
325
|
children: create("div", {
|
|
326
326
|
children: [
|
|
@@ -456,7 +456,7 @@ function createPropertyDiscriminator(
|
|
|
456
456
|
return undefined;
|
|
457
457
|
}
|
|
458
458
|
|
|
459
|
-
return create("
|
|
459
|
+
return create("div", {
|
|
460
460
|
className: "discriminatorItem",
|
|
461
461
|
children: create("div", {
|
|
462
462
|
children: [
|
package/src/markdown/schema.ts
CHANGED
|
@@ -64,7 +64,11 @@ export function getQualifierMessage(schema?: SchemaObject): string | undefined {
|
|
|
64
64
|
return undefined;
|
|
65
65
|
}
|
|
66
66
|
|
|
67
|
-
if (
|
|
67
|
+
if (
|
|
68
|
+
schema.items &&
|
|
69
|
+
schema.minItems === undefined &&
|
|
70
|
+
schema.maxItems === undefined
|
|
71
|
+
) {
|
|
68
72
|
return getQualifierMessage(schema.items);
|
|
69
73
|
}
|
|
70
74
|
|
|
@@ -72,6 +76,14 @@ export function getQualifierMessage(schema?: SchemaObject): string | undefined {
|
|
|
72
76
|
|
|
73
77
|
let qualifierGroups = [];
|
|
74
78
|
|
|
79
|
+
if (schema.items && schema.items.enum) {
|
|
80
|
+
if (schema.items.enum) {
|
|
81
|
+
qualifierGroups.push(
|
|
82
|
+
`[${schema.items.enum.map((e) => `\`${e}\``).join(", ")}]`
|
|
83
|
+
);
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
|
|
75
87
|
if (schema.minLength || schema.maxLength) {
|
|
76
88
|
let lengthQualifier = "";
|
|
77
89
|
let minLength;
|