docusaurus-plugin-openapi-docs 0.0.0-529 → 0.0.0-530
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/lib/markdown/createRequestSchema.js +2 -0
- package/lib/markdown/createResponseSchema.js +2 -0
- package/lib/openapi/createRequestExample.js +6 -4
- package/lib/openapi/createResponseExample.js +7 -4
- package/package.json +2 -2
- package/src/markdown/createRequestSchema.ts +2 -0
- package/src/markdown/createResponseSchema.ts +2 -0
- package/src/openapi/createRequestExample.ts +10 -4
- package/src/openapi/createResponseExample.ts +13 -4
|
@@ -480,6 +480,7 @@ function createEdges({ name, schema, required, discriminator, }) {
|
|
|
480
480
|
collapsible: false,
|
|
481
481
|
name,
|
|
482
482
|
required: Array.isArray(required) ? required.includes(name) : required,
|
|
483
|
+
deprecated: mergedSchemas.deprecated,
|
|
483
484
|
schemaDescription: mergedSchemas.description,
|
|
484
485
|
schemaName: schemaName,
|
|
485
486
|
qualifierMessage: (0, schema_1.getQualifierMessage)(schema),
|
|
@@ -507,6 +508,7 @@ function createEdges({ name, schema, required, discriminator, }) {
|
|
|
507
508
|
collapsible: false,
|
|
508
509
|
name,
|
|
509
510
|
required: Array.isArray(required) ? required.includes(name) : required,
|
|
511
|
+
deprecated: schema.deprecated,
|
|
510
512
|
schemaDescription: schema.description,
|
|
511
513
|
schemaName: schemaName,
|
|
512
514
|
qualifierMessage: (0, schema_1.getQualifierMessage)(schema),
|
|
@@ -479,6 +479,7 @@ function createEdges({ name, schema, required, discriminator, }) {
|
|
|
479
479
|
collapsible: false,
|
|
480
480
|
name,
|
|
481
481
|
required: false,
|
|
482
|
+
deprecated: mergedSchemas.deprecated,
|
|
482
483
|
schemaDescription: mergedSchemas.description,
|
|
483
484
|
schemaName: schemaName,
|
|
484
485
|
qualifierMessage: (0, schema_1.getQualifierMessage)(schema),
|
|
@@ -506,6 +507,7 @@ function createEdges({ name, schema, required, discriminator, }) {
|
|
|
506
507
|
collapsible: false,
|
|
507
508
|
name,
|
|
508
509
|
required: false,
|
|
510
|
+
deprecated: schema.deprecated,
|
|
509
511
|
schemaDescription: schema.description,
|
|
510
512
|
schemaName: schemaName,
|
|
511
513
|
qualifierMessage: (0, schema_1.getQualifierMessage)(schema),
|
|
@@ -76,7 +76,7 @@ const sampleRequestFromSchema = (schema = {}) => {
|
|
|
76
76
|
const { mergedSchemas } = (0, createRequestSchema_1.mergeAllOf)(allOf);
|
|
77
77
|
if (mergedSchemas.properties) {
|
|
78
78
|
for (const [key, value] of Object.entries(mergedSchemas.properties)) {
|
|
79
|
-
if (value.readOnly && value.readOnly === true) {
|
|
79
|
+
if ((value.readOnly && value.readOnly === true) || value.deprecated) {
|
|
80
80
|
delete mergedSchemas.properties[key];
|
|
81
81
|
}
|
|
82
82
|
}
|
|
@@ -99,14 +99,16 @@ const sampleRequestFromSchema = (schema = {}) => {
|
|
|
99
99
|
for (let [name, prop] of Object.entries(properties !== null && properties !== void 0 ? properties : {})) {
|
|
100
100
|
if (prop.properties) {
|
|
101
101
|
for (const [key, value] of Object.entries(prop.properties)) {
|
|
102
|
-
if (value.readOnly && value.readOnly === true)
|
|
102
|
+
if ((value.readOnly && value.readOnly === true) ||
|
|
103
|
+
value.deprecated) {
|
|
103
104
|
delete prop.properties[key];
|
|
104
105
|
}
|
|
105
106
|
}
|
|
106
107
|
}
|
|
107
108
|
if (prop.items && prop.items.properties) {
|
|
108
109
|
for (const [key, value] of Object.entries(prop.items.properties)) {
|
|
109
|
-
if (value.readOnly && value.readOnly === true)
|
|
110
|
+
if ((value.readOnly && value.readOnly === true) ||
|
|
111
|
+
value.deprecated) {
|
|
110
112
|
delete prop.items.properties[key];
|
|
111
113
|
}
|
|
112
114
|
}
|
|
@@ -137,7 +139,7 @@ const sampleRequestFromSchema = (schema = {}) => {
|
|
|
137
139
|
}
|
|
138
140
|
return normalizeArray(schema.enum)[0];
|
|
139
141
|
}
|
|
140
|
-
if (schema.readOnly && schema.readOnly === true) {
|
|
142
|
+
if ((schema.readOnly && schema.readOnly === true) || schema.deprecated) {
|
|
141
143
|
return undefined;
|
|
142
144
|
}
|
|
143
145
|
return primitive(schema);
|
|
@@ -68,7 +68,8 @@ const sampleResponseFromSchema = (schema = {}) => {
|
|
|
68
68
|
const { mergedSchemas } = (0, createResponseSchema_1.mergeAllOf)(allOf);
|
|
69
69
|
if (mergedSchemas.properties) {
|
|
70
70
|
for (const [key, value] of Object.entries(mergedSchemas.properties)) {
|
|
71
|
-
if (value.writeOnly && value.writeOnly === true)
|
|
71
|
+
if ((value.writeOnly && value.writeOnly === true) ||
|
|
72
|
+
value.deprecated) {
|
|
72
73
|
delete mergedSchemas.properties[key];
|
|
73
74
|
}
|
|
74
75
|
}
|
|
@@ -99,14 +100,16 @@ const sampleResponseFromSchema = (schema = {}) => {
|
|
|
99
100
|
for (let [name, prop] of Object.entries(properties !== null && properties !== void 0 ? properties : {})) {
|
|
100
101
|
if (prop.properties) {
|
|
101
102
|
for (const [key, value] of Object.entries(prop.properties)) {
|
|
102
|
-
if (value.writeOnly && value.writeOnly === true)
|
|
103
|
+
if ((value.writeOnly && value.writeOnly === true) ||
|
|
104
|
+
value.deprecated) {
|
|
103
105
|
delete prop.properties[key];
|
|
104
106
|
}
|
|
105
107
|
}
|
|
106
108
|
}
|
|
107
109
|
if (prop.items && prop.items.properties) {
|
|
108
110
|
for (const [key, value] of Object.entries(prop.items.properties)) {
|
|
109
|
-
if (value.writeOnly && value.writeOnly === true)
|
|
111
|
+
if ((value.writeOnly && value.writeOnly === true) ||
|
|
112
|
+
value.deprecated) {
|
|
110
113
|
delete prop.items.properties[key];
|
|
111
114
|
}
|
|
112
115
|
}
|
|
@@ -137,7 +140,7 @@ const sampleResponseFromSchema = (schema = {}) => {
|
|
|
137
140
|
}
|
|
138
141
|
return normalizeArray(schema.enum)[0];
|
|
139
142
|
}
|
|
140
|
-
if (schema.writeOnly && schema.writeOnly === true) {
|
|
143
|
+
if ((schema.writeOnly && schema.writeOnly === true) || schema.deprecated) {
|
|
141
144
|
return undefined;
|
|
142
145
|
}
|
|
143
146
|
return primitive(schema);
|
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-530",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"keywords": [
|
|
7
7
|
"openapi",
|
|
@@ -68,5 +68,5 @@
|
|
|
68
68
|
"engines": {
|
|
69
69
|
"node": ">=14"
|
|
70
70
|
},
|
|
71
|
-
"gitHead": "
|
|
71
|
+
"gitHead": "a31ab6ddf963c070ad5bcb15edaa6ef50e6cd3b7"
|
|
72
72
|
}
|
|
@@ -597,6 +597,7 @@ function createEdges({
|
|
|
597
597
|
collapsible: false,
|
|
598
598
|
name,
|
|
599
599
|
required: Array.isArray(required) ? required.includes(name) : required,
|
|
600
|
+
deprecated: mergedSchemas.deprecated,
|
|
600
601
|
schemaDescription: mergedSchemas.description,
|
|
601
602
|
schemaName: schemaName,
|
|
602
603
|
qualifierMessage: getQualifierMessage(schema),
|
|
@@ -630,6 +631,7 @@ function createEdges({
|
|
|
630
631
|
collapsible: false,
|
|
631
632
|
name,
|
|
632
633
|
required: Array.isArray(required) ? required.includes(name) : required,
|
|
634
|
+
deprecated: schema.deprecated,
|
|
633
635
|
schemaDescription: schema.description,
|
|
634
636
|
schemaName: schemaName,
|
|
635
637
|
qualifierMessage: getQualifierMessage(schema),
|
|
@@ -597,6 +597,7 @@ function createEdges({
|
|
|
597
597
|
collapsible: false,
|
|
598
598
|
name,
|
|
599
599
|
required: false,
|
|
600
|
+
deprecated: mergedSchemas.deprecated,
|
|
600
601
|
schemaDescription: mergedSchemas.description,
|
|
601
602
|
schemaName: schemaName,
|
|
602
603
|
qualifierMessage: getQualifierMessage(schema),
|
|
@@ -630,6 +631,7 @@ function createEdges({
|
|
|
630
631
|
collapsible: false,
|
|
631
632
|
name,
|
|
632
633
|
required: false,
|
|
634
|
+
deprecated: schema.deprecated,
|
|
633
635
|
schemaDescription: schema.description,
|
|
634
636
|
schemaName: schemaName,
|
|
635
637
|
qualifierMessage: getQualifierMessage(schema),
|
|
@@ -98,7 +98,7 @@ export const sampleRequestFromSchema = (schema: SchemaObject = {}): any => {
|
|
|
98
98
|
mergeAllOf(allOf);
|
|
99
99
|
if (mergedSchemas.properties) {
|
|
100
100
|
for (const [key, value] of Object.entries(mergedSchemas.properties)) {
|
|
101
|
-
if (value.readOnly && value.readOnly === true) {
|
|
101
|
+
if ((value.readOnly && value.readOnly === true) || value.deprecated) {
|
|
102
102
|
delete mergedSchemas.properties[key];
|
|
103
103
|
}
|
|
104
104
|
}
|
|
@@ -121,7 +121,10 @@ export const sampleRequestFromSchema = (schema: SchemaObject = {}): any => {
|
|
|
121
121
|
for (let [name, prop] of Object.entries(properties ?? {})) {
|
|
122
122
|
if (prop.properties) {
|
|
123
123
|
for (const [key, value] of Object.entries(prop.properties)) {
|
|
124
|
-
if (
|
|
124
|
+
if (
|
|
125
|
+
(value.readOnly && value.readOnly === true) ||
|
|
126
|
+
value.deprecated
|
|
127
|
+
) {
|
|
125
128
|
delete prop.properties[key];
|
|
126
129
|
}
|
|
127
130
|
}
|
|
@@ -129,7 +132,10 @@ export const sampleRequestFromSchema = (schema: SchemaObject = {}): any => {
|
|
|
129
132
|
|
|
130
133
|
if (prop.items && prop.items.properties) {
|
|
131
134
|
for (const [key, value] of Object.entries(prop.items.properties)) {
|
|
132
|
-
if (
|
|
135
|
+
if (
|
|
136
|
+
(value.readOnly && value.readOnly === true) ||
|
|
137
|
+
value.deprecated
|
|
138
|
+
) {
|
|
133
139
|
delete prop.items.properties[key];
|
|
134
140
|
}
|
|
135
141
|
}
|
|
@@ -168,7 +174,7 @@ export const sampleRequestFromSchema = (schema: SchemaObject = {}): any => {
|
|
|
168
174
|
return normalizeArray(schema.enum)[0];
|
|
169
175
|
}
|
|
170
176
|
|
|
171
|
-
if (schema.readOnly && schema.readOnly === true) {
|
|
177
|
+
if ((schema.readOnly && schema.readOnly === true) || schema.deprecated) {
|
|
172
178
|
return undefined;
|
|
173
179
|
}
|
|
174
180
|
|
|
@@ -88,7 +88,10 @@ export const sampleResponseFromSchema = (schema: SchemaObject = {}): any => {
|
|
|
88
88
|
mergeAllOf(allOf);
|
|
89
89
|
if (mergedSchemas.properties) {
|
|
90
90
|
for (const [key, value] of Object.entries(mergedSchemas.properties)) {
|
|
91
|
-
if (
|
|
91
|
+
if (
|
|
92
|
+
(value.writeOnly && value.writeOnly === true) ||
|
|
93
|
+
value.deprecated
|
|
94
|
+
) {
|
|
92
95
|
delete mergedSchemas.properties[key];
|
|
93
96
|
}
|
|
94
97
|
}
|
|
@@ -121,7 +124,10 @@ export const sampleResponseFromSchema = (schema: SchemaObject = {}): any => {
|
|
|
121
124
|
for (let [name, prop] of Object.entries(properties ?? {})) {
|
|
122
125
|
if (prop.properties) {
|
|
123
126
|
for (const [key, value] of Object.entries(prop.properties)) {
|
|
124
|
-
if (
|
|
127
|
+
if (
|
|
128
|
+
(value.writeOnly && value.writeOnly === true) ||
|
|
129
|
+
value.deprecated
|
|
130
|
+
) {
|
|
125
131
|
delete prop.properties[key];
|
|
126
132
|
}
|
|
127
133
|
}
|
|
@@ -129,7 +135,10 @@ export const sampleResponseFromSchema = (schema: SchemaObject = {}): any => {
|
|
|
129
135
|
|
|
130
136
|
if (prop.items && prop.items.properties) {
|
|
131
137
|
for (const [key, value] of Object.entries(prop.items.properties)) {
|
|
132
|
-
if (
|
|
138
|
+
if (
|
|
139
|
+
(value.writeOnly && value.writeOnly === true) ||
|
|
140
|
+
value.deprecated
|
|
141
|
+
) {
|
|
133
142
|
delete prop.items.properties[key];
|
|
134
143
|
}
|
|
135
144
|
}
|
|
@@ -168,7 +177,7 @@ export const sampleResponseFromSchema = (schema: SchemaObject = {}): any => {
|
|
|
168
177
|
return normalizeArray(schema.enum)[0];
|
|
169
178
|
}
|
|
170
179
|
|
|
171
|
-
if (schema.writeOnly && schema.writeOnly === true) {
|
|
180
|
+
if ((schema.writeOnly && schema.writeOnly === true) || schema.deprecated) {
|
|
172
181
|
return undefined;
|
|
173
182
|
}
|
|
174
183
|
|