docusaurus-plugin-openapi-docs 0.0.0-613 → 0.0.0-615
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.d.ts +1 -8
- package/lib/markdown/createRequestSchema.js +4 -684
- package/lib/markdown/createResponseSchema.d.ts +1 -8
- package/lib/markdown/createResponseSchema.js +3 -685
- package/lib/markdown/createSchema.d.ts +12 -0
- package/lib/markdown/createSchema.js +594 -0
- package/lib/openapi/createRequestExample.js +3 -3
- package/lib/openapi/createResponseExample.js +3 -3
- package/package.json +2 -2
- package/src/markdown/createRequestSchema.ts +2 -891
- package/src/markdown/createResponseSchema.ts +2 -894
- package/src/markdown/createSchema.ts +793 -0
- package/src/openapi/createRequestExample.ts +1 -1
- package/src/openapi/createResponseExample.ts +1 -1
|
@@ -6,692 +6,12 @@
|
|
|
6
6
|
* LICENSE file in the root directory of this source tree.
|
|
7
7
|
* ========================================================================== */
|
|
8
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
-
exports.createRequestSchema =
|
|
10
|
-
const createArrayBracket_1 = require("./createArrayBracket");
|
|
9
|
+
exports.createRequestSchema = void 0;
|
|
11
10
|
const createDescription_1 = require("./createDescription");
|
|
12
11
|
const createDetails_1 = require("./createDetails");
|
|
13
12
|
const createDetailsSummary_1 = require("./createDetailsSummary");
|
|
14
|
-
const
|
|
13
|
+
const createSchema_1 = require("./createSchema");
|
|
15
14
|
const utils_1 = require("./utils");
|
|
16
|
-
const jsonSchemaMergeAllOf = require("json-schema-merge-allof");
|
|
17
|
-
/**
|
|
18
|
-
* Returns a merged representation of allOf array of schemas.
|
|
19
|
-
*/
|
|
20
|
-
function mergeAllOf(allOf) {
|
|
21
|
-
const mergedSchemas = jsonSchemaMergeAllOf(allOf, {
|
|
22
|
-
resolvers: {
|
|
23
|
-
readOnly: function () {
|
|
24
|
-
return true;
|
|
25
|
-
},
|
|
26
|
-
example: function () {
|
|
27
|
-
return true;
|
|
28
|
-
},
|
|
29
|
-
"x-examples": function () {
|
|
30
|
-
return true;
|
|
31
|
-
},
|
|
32
|
-
},
|
|
33
|
-
ignoreAdditionalProperties: true,
|
|
34
|
-
});
|
|
35
|
-
const required = allOf.reduce((acc, cur) => {
|
|
36
|
-
if (Array.isArray(cur.required)) {
|
|
37
|
-
const next = [...acc, ...cur.required];
|
|
38
|
-
return next;
|
|
39
|
-
}
|
|
40
|
-
return acc;
|
|
41
|
-
}, []);
|
|
42
|
-
return { mergedSchemas, required };
|
|
43
|
-
}
|
|
44
|
-
exports.mergeAllOf = mergeAllOf;
|
|
45
|
-
/**
|
|
46
|
-
* For handling nested anyOf/oneOf.
|
|
47
|
-
*/
|
|
48
|
-
function createAnyOneOf(schema) {
|
|
49
|
-
const type = schema.oneOf ? "oneOf" : "anyOf";
|
|
50
|
-
return (0, utils_1.create)("div", {
|
|
51
|
-
children: [
|
|
52
|
-
(0, utils_1.create)("span", {
|
|
53
|
-
className: "badge badge--info",
|
|
54
|
-
children: type,
|
|
55
|
-
}),
|
|
56
|
-
(0, utils_1.create)("SchemaTabs", {
|
|
57
|
-
children: schema[type].map((anyOneSchema, index) => {
|
|
58
|
-
const label = anyOneSchema.title
|
|
59
|
-
? anyOneSchema.title
|
|
60
|
-
: `MOD${index + 1}`;
|
|
61
|
-
const anyOneChildren = [];
|
|
62
|
-
if (anyOneSchema.properties !== undefined) {
|
|
63
|
-
anyOneChildren.push(createProperties(anyOneSchema));
|
|
64
|
-
delete anyOneSchema.properties;
|
|
65
|
-
}
|
|
66
|
-
if (anyOneSchema.allOf !== undefined) {
|
|
67
|
-
anyOneChildren.push(createNodes(anyOneSchema));
|
|
68
|
-
delete anyOneSchema.allOf;
|
|
69
|
-
}
|
|
70
|
-
if (anyOneSchema.items !== undefined) {
|
|
71
|
-
anyOneChildren.push(createItems(anyOneSchema));
|
|
72
|
-
delete anyOneSchema.items;
|
|
73
|
-
}
|
|
74
|
-
if (anyOneSchema.type === "string" ||
|
|
75
|
-
anyOneSchema.type === "number" ||
|
|
76
|
-
anyOneSchema.type === "integer" ||
|
|
77
|
-
anyOneSchema.type === "boolean") {
|
|
78
|
-
anyOneChildren.push(createNodes(anyOneSchema));
|
|
79
|
-
}
|
|
80
|
-
if (anyOneChildren.length) {
|
|
81
|
-
if (schema.type === "array") {
|
|
82
|
-
return (0, utils_1.create)("TabItem", {
|
|
83
|
-
label: label,
|
|
84
|
-
value: `${index}-item-properties`,
|
|
85
|
-
children: [
|
|
86
|
-
(0, createArrayBracket_1.createOpeningArrayBracket)(),
|
|
87
|
-
anyOneChildren,
|
|
88
|
-
(0, createArrayBracket_1.createClosingArrayBracket)(),
|
|
89
|
-
]
|
|
90
|
-
.filter(Boolean)
|
|
91
|
-
.flat(),
|
|
92
|
-
});
|
|
93
|
-
}
|
|
94
|
-
return (0, utils_1.create)("TabItem", {
|
|
95
|
-
label: label,
|
|
96
|
-
value: `${index}-item-properties`,
|
|
97
|
-
children: anyOneChildren.filter(Boolean).flat(),
|
|
98
|
-
});
|
|
99
|
-
}
|
|
100
|
-
return undefined;
|
|
101
|
-
}),
|
|
102
|
-
}),
|
|
103
|
-
],
|
|
104
|
-
});
|
|
105
|
-
}
|
|
106
|
-
function createProperties(schema) {
|
|
107
|
-
const discriminator = schema.discriminator;
|
|
108
|
-
return Object.entries(schema.properties).map(([key, val]) => {
|
|
109
|
-
return createEdges({
|
|
110
|
-
name: key,
|
|
111
|
-
schema: val,
|
|
112
|
-
required: Array.isArray(schema.required)
|
|
113
|
-
? schema.required.includes(key)
|
|
114
|
-
: false,
|
|
115
|
-
discriminator,
|
|
116
|
-
});
|
|
117
|
-
});
|
|
118
|
-
}
|
|
119
|
-
function createAdditionalProperties(schema) {
|
|
120
|
-
// TODO?:
|
|
121
|
-
// {
|
|
122
|
-
// description: 'Integration configuration. See \n' +
|
|
123
|
-
// '[Integration Configurations](https://prisma.pan.dev/api/cloud/api-integration-config/).\n',
|
|
124
|
-
// example: { webhookUrl: 'https://hooks.slack.com/abcdef' },
|
|
125
|
-
// externalDocs: { url: 'https://prisma.pan.dev/api/cloud/api-integration-config' },
|
|
126
|
-
// type: 'object'
|
|
127
|
-
// }
|
|
128
|
-
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
129
|
-
// TODO?:
|
|
130
|
-
// {
|
|
131
|
-
// items: {
|
|
132
|
-
// properties: {
|
|
133
|
-
// aliasField: [Object],
|
|
134
|
-
// displayName: [Object],
|
|
135
|
-
// fieldName: [Object],
|
|
136
|
-
// maxLength: [Object],
|
|
137
|
-
// options: [Object],
|
|
138
|
-
// redlockMapping: [Object],
|
|
139
|
-
// required: [Object],
|
|
140
|
-
// type: [Object],
|
|
141
|
-
// typeaheadUri: [Object],
|
|
142
|
-
// value: [Object]
|
|
143
|
-
// },
|
|
144
|
-
// type: 'object'
|
|
145
|
-
// },
|
|
146
|
-
// type: 'array'
|
|
147
|
-
// }
|
|
148
|
-
const additionalProperties = schema.additionalProperties;
|
|
149
|
-
const type = additionalProperties === null || additionalProperties === void 0 ? void 0 : additionalProperties.type;
|
|
150
|
-
// Handle free-form objects
|
|
151
|
-
if (String(additionalProperties) === "true" && schema.type === "object") {
|
|
152
|
-
return (0, utils_1.create)("SchemaItem", {
|
|
153
|
-
name: "property name*",
|
|
154
|
-
required: false,
|
|
155
|
-
schemaName: "any",
|
|
156
|
-
qualifierMessage: (0, schema_1.getQualifierMessage)(schema.additionalProperties),
|
|
157
|
-
schema: schema,
|
|
158
|
-
collapsible: false,
|
|
159
|
-
discriminator: false,
|
|
160
|
-
});
|
|
161
|
-
}
|
|
162
|
-
if ((type === "object" || type === "array") &&
|
|
163
|
-
((additionalProperties === null || additionalProperties === void 0 ? void 0 : additionalProperties.properties) ||
|
|
164
|
-
(additionalProperties === null || additionalProperties === void 0 ? void 0 : additionalProperties.items) ||
|
|
165
|
-
(additionalProperties === null || additionalProperties === void 0 ? void 0 : additionalProperties.allOf) ||
|
|
166
|
-
(additionalProperties === null || additionalProperties === void 0 ? void 0 : additionalProperties.additionalProperties) ||
|
|
167
|
-
(additionalProperties === null || additionalProperties === void 0 ? void 0 : additionalProperties.oneOf) ||
|
|
168
|
-
(additionalProperties === null || additionalProperties === void 0 ? void 0 : additionalProperties.anyOf))) {
|
|
169
|
-
const title = additionalProperties.title;
|
|
170
|
-
const schemaName = (0, schema_1.getSchemaName)(additionalProperties);
|
|
171
|
-
const required = (_a = schema.required) !== null && _a !== void 0 ? _a : false;
|
|
172
|
-
return createDetailsNode("property name*", title !== null && title !== void 0 ? title : schemaName, additionalProperties, required, schema.nullable);
|
|
173
|
-
}
|
|
174
|
-
if (((_b = schema.additionalProperties) === null || _b === void 0 ? void 0 : _b.type) === "string" ||
|
|
175
|
-
((_c = schema.additionalProperties) === null || _c === void 0 ? void 0 : _c.type) === "object" ||
|
|
176
|
-
((_d = schema.additionalProperties) === null || _d === void 0 ? void 0 : _d.type) === "boolean" ||
|
|
177
|
-
((_e = schema.additionalProperties) === null || _e === void 0 ? void 0 : _e.type) === "integer" ||
|
|
178
|
-
((_f = schema.additionalProperties) === null || _f === void 0 ? void 0 : _f.type) === "number") {
|
|
179
|
-
const additionalProperties = (_g = schema.additionalProperties) === null || _g === void 0 ? void 0 : _g.additionalProperties;
|
|
180
|
-
if (additionalProperties !== undefined) {
|
|
181
|
-
const type = (_j = (_h = schema.additionalProperties) === null || _h === void 0 ? void 0 : _h.additionalProperties) === null || _j === void 0 ? void 0 : _j.type;
|
|
182
|
-
const schemaName = (0, schema_1.getSchemaName)((_k = schema.additionalProperties) === null || _k === void 0 ? void 0 : _k.additionalProperties);
|
|
183
|
-
return (0, utils_1.create)("SchemaItem", {
|
|
184
|
-
name: "property name*",
|
|
185
|
-
required: false,
|
|
186
|
-
schemaName: schemaName !== null && schemaName !== void 0 ? schemaName : type,
|
|
187
|
-
qualifierMessage: (_l = schema.additionalProperties) !== null && _l !== void 0 ? _l : (0, schema_1.getQualifierMessage)(schema.additionalProperties),
|
|
188
|
-
schema: schema,
|
|
189
|
-
collapsible: false,
|
|
190
|
-
discriminator: false,
|
|
191
|
-
});
|
|
192
|
-
}
|
|
193
|
-
const schemaName = (0, schema_1.getSchemaName)(schema.additionalProperties);
|
|
194
|
-
return (0, utils_1.create)("SchemaItem", {
|
|
195
|
-
name: "property name*",
|
|
196
|
-
required: false,
|
|
197
|
-
schemaName: schemaName,
|
|
198
|
-
qualifierMessage: (0, schema_1.getQualifierMessage)(schema),
|
|
199
|
-
schema: schema.additionalProperties,
|
|
200
|
-
collapsible: false,
|
|
201
|
-
discriminator: false,
|
|
202
|
-
});
|
|
203
|
-
}
|
|
204
|
-
return Object.entries(schema.additionalProperties).map(([key, val]) => createEdges({
|
|
205
|
-
name: key,
|
|
206
|
-
schema: val,
|
|
207
|
-
required: Array.isArray(schema.required)
|
|
208
|
-
? schema.required.includes(key)
|
|
209
|
-
: false,
|
|
210
|
-
}));
|
|
211
|
-
}
|
|
212
|
-
// TODO: figure out how to handle array of objects
|
|
213
|
-
function createItems(schema) {
|
|
214
|
-
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
215
|
-
if (((_a = schema.items) === null || _a === void 0 ? void 0 : _a.properties) !== undefined) {
|
|
216
|
-
return [
|
|
217
|
-
(0, createArrayBracket_1.createOpeningArrayBracket)(),
|
|
218
|
-
createProperties(schema.items),
|
|
219
|
-
(0, createArrayBracket_1.createClosingArrayBracket)(),
|
|
220
|
-
].flat();
|
|
221
|
-
}
|
|
222
|
-
if (((_b = schema.items) === null || _b === void 0 ? void 0 : _b.additionalProperties) !== undefined) {
|
|
223
|
-
return [
|
|
224
|
-
(0, createArrayBracket_1.createOpeningArrayBracket)(),
|
|
225
|
-
createAdditionalProperties(schema.items),
|
|
226
|
-
(0, createArrayBracket_1.createClosingArrayBracket)(),
|
|
227
|
-
].flat();
|
|
228
|
-
}
|
|
229
|
-
if (((_c = schema.items) === null || _c === void 0 ? void 0 : _c.oneOf) !== undefined || ((_d = schema.items) === null || _d === void 0 ? void 0 : _d.anyOf) !== undefined) {
|
|
230
|
-
return [
|
|
231
|
-
(0, createArrayBracket_1.createOpeningArrayBracket)(),
|
|
232
|
-
createAnyOneOf(schema.items),
|
|
233
|
-
(0, createArrayBracket_1.createClosingArrayBracket)(),
|
|
234
|
-
].flat();
|
|
235
|
-
}
|
|
236
|
-
if (((_e = schema.items) === null || _e === void 0 ? void 0 : _e.allOf) !== undefined) {
|
|
237
|
-
// TODO: figure out if and how we should pass merged required array
|
|
238
|
-
const { mergedSchemas, } = mergeAllOf((_f = schema.items) === null || _f === void 0 ? void 0 : _f.allOf);
|
|
239
|
-
// Handles combo anyOf/oneOf + properties
|
|
240
|
-
if ((mergedSchemas.oneOf !== undefined ||
|
|
241
|
-
mergedSchemas.anyOf !== undefined) &&
|
|
242
|
-
mergedSchemas.properties) {
|
|
243
|
-
return [
|
|
244
|
-
(0, createArrayBracket_1.createOpeningArrayBracket)(),
|
|
245
|
-
createAnyOneOf(mergedSchemas),
|
|
246
|
-
createProperties(mergedSchemas),
|
|
247
|
-
(0, createArrayBracket_1.createClosingArrayBracket)(),
|
|
248
|
-
].flat();
|
|
249
|
-
}
|
|
250
|
-
// Handles only anyOf/oneOf
|
|
251
|
-
if (mergedSchemas.oneOf !== undefined ||
|
|
252
|
-
mergedSchemas.anyOf !== undefined) {
|
|
253
|
-
return [
|
|
254
|
-
(0, createArrayBracket_1.createOpeningArrayBracket)(),
|
|
255
|
-
createAnyOneOf(mergedSchemas),
|
|
256
|
-
(0, createArrayBracket_1.createClosingArrayBracket)(),
|
|
257
|
-
].flat();
|
|
258
|
-
}
|
|
259
|
-
// Handles properties
|
|
260
|
-
if (mergedSchemas.properties !== undefined) {
|
|
261
|
-
return [
|
|
262
|
-
(0, createArrayBracket_1.createOpeningArrayBracket)(),
|
|
263
|
-
createProperties(mergedSchemas),
|
|
264
|
-
(0, createArrayBracket_1.createClosingArrayBracket)(),
|
|
265
|
-
].flat();
|
|
266
|
-
}
|
|
267
|
-
}
|
|
268
|
-
if (((_g = schema.items) === null || _g === void 0 ? void 0 : _g.type) === "string" ||
|
|
269
|
-
((_h = schema.items) === null || _h === void 0 ? void 0 : _h.type) === "number" ||
|
|
270
|
-
((_j = schema.items) === null || _j === void 0 ? void 0 : _j.type) === "integer" ||
|
|
271
|
-
((_k = schema.items) === null || _k === void 0 ? void 0 : _k.type) === "boolean" ||
|
|
272
|
-
((_l = schema.items) === null || _l === void 0 ? void 0 : _l.type) === "object") {
|
|
273
|
-
return [
|
|
274
|
-
(0, createArrayBracket_1.createOpeningArrayBracket)(),
|
|
275
|
-
createNodes(schema.items),
|
|
276
|
-
(0, createArrayBracket_1.createClosingArrayBracket)(),
|
|
277
|
-
].flat();
|
|
278
|
-
}
|
|
279
|
-
// TODO: clean this up or eliminate it?
|
|
280
|
-
return [
|
|
281
|
-
(0, createArrayBracket_1.createOpeningArrayBracket)(),
|
|
282
|
-
Object.entries(schema.items).map(([key, val]) => createEdges({
|
|
283
|
-
name: key,
|
|
284
|
-
schema: val,
|
|
285
|
-
required: Array.isArray(schema.required)
|
|
286
|
-
? schema.required.includes(key)
|
|
287
|
-
: false,
|
|
288
|
-
})),
|
|
289
|
-
(0, createArrayBracket_1.createClosingArrayBracket)(),
|
|
290
|
-
].flat();
|
|
291
|
-
}
|
|
292
|
-
/**
|
|
293
|
-
* For handling discriminators that do not map to a same-level property
|
|
294
|
-
*/
|
|
295
|
-
// function createDiscriminator(schema: SchemaObject) {
|
|
296
|
-
// const discriminator = schema.discriminator;
|
|
297
|
-
// const propertyName = discriminator?.propertyName;
|
|
298
|
-
// const propertyType = "string"; // should always be string
|
|
299
|
-
// const mapping: any = discriminator?.mapping;
|
|
300
|
-
// // Explicit mapping is required since we can't support implicit
|
|
301
|
-
// if (mapping === undefined) {
|
|
302
|
-
// return undefined;
|
|
303
|
-
// }
|
|
304
|
-
// // Attempt to get the property description we want to display
|
|
305
|
-
// // TODO: how to make it predictable when handling allOf
|
|
306
|
-
// let propertyDescription;
|
|
307
|
-
// const firstMappingSchema = mapping[Object.keys(mapping)[0]];
|
|
308
|
-
// if (firstMappingSchema.properties !== undefined) {
|
|
309
|
-
// propertyDescription =
|
|
310
|
-
// firstMappingSchema.properties![propertyName!].description;
|
|
311
|
-
// }
|
|
312
|
-
// if (firstMappingSchema.allOf !== undefined) {
|
|
313
|
-
// const { mergedSchemas }: { mergedSchemas: SchemaObject } = mergeAllOf(
|
|
314
|
-
// firstMappingSchema.allOf
|
|
315
|
-
// );
|
|
316
|
-
// if (mergedSchemas.properties !== undefined) {
|
|
317
|
-
// propertyDescription =
|
|
318
|
-
// mergedSchemas.properties[propertyName!]?.description;
|
|
319
|
-
// }
|
|
320
|
-
// }
|
|
321
|
-
// if (propertyDescription === undefined) {
|
|
322
|
-
// if (
|
|
323
|
-
// schema.properties !== undefined &&
|
|
324
|
-
// schema.properties![propertyName!] !== undefined
|
|
325
|
-
// ) {
|
|
326
|
-
// propertyDescription = schema.properties![propertyName!].description;
|
|
327
|
-
// }
|
|
328
|
-
// }
|
|
329
|
-
// return create("div", {
|
|
330
|
-
// className: "discriminatorItem",
|
|
331
|
-
// children: create("div", {
|
|
332
|
-
// children: [
|
|
333
|
-
// create("strong", {
|
|
334
|
-
// style: { paddingLeft: "1rem" },
|
|
335
|
-
// children: propertyName,
|
|
336
|
-
// }),
|
|
337
|
-
// guard(propertyType, (name) =>
|
|
338
|
-
// create("span", {
|
|
339
|
-
// style: { opacity: "0.6" },
|
|
340
|
-
// children: ` ${propertyType}`,
|
|
341
|
-
// })
|
|
342
|
-
// ),
|
|
343
|
-
// guard(getQualifierMessage(schema.discriminator as any), (message) =>
|
|
344
|
-
// create("div", {
|
|
345
|
-
// style: {
|
|
346
|
-
// paddingLeft: "1rem",
|
|
347
|
-
// },
|
|
348
|
-
// children: createDescription(message),
|
|
349
|
-
// })
|
|
350
|
-
// ),
|
|
351
|
-
// guard(propertyDescription, (description) =>
|
|
352
|
-
// create("div", {
|
|
353
|
-
// style: {
|
|
354
|
-
// paddingLeft: "1rem",
|
|
355
|
-
// },
|
|
356
|
-
// children: createDescription(description),
|
|
357
|
-
// })
|
|
358
|
-
// ),
|
|
359
|
-
// create("DiscriminatorTabs", {
|
|
360
|
-
// children: Object.keys(mapping!).map((key, index) => {
|
|
361
|
-
// if (mapping[key].allOf !== undefined) {
|
|
362
|
-
// const { mergedSchemas }: { mergedSchemas: SchemaObject } =
|
|
363
|
-
// mergeAllOf(mapping[key].allOf);
|
|
364
|
-
// // Cleanup duplicate property from mapping schema
|
|
365
|
-
// delete mergedSchemas.properties![propertyName!];
|
|
366
|
-
// mapping[key] = mergedSchemas;
|
|
367
|
-
// }
|
|
368
|
-
// if (mapping[key].properties !== undefined) {
|
|
369
|
-
// // Cleanup duplicate property from mapping schema
|
|
370
|
-
// delete mapping[key].properties![propertyName!];
|
|
371
|
-
// }
|
|
372
|
-
// const label = key;
|
|
373
|
-
// return create("TabItem", {
|
|
374
|
-
// label: label,
|
|
375
|
-
// value: `${index}-item-discriminator`,
|
|
376
|
-
// children: [
|
|
377
|
-
// create("div", {
|
|
378
|
-
// style: { marginLeft: "-4px" },
|
|
379
|
-
// children: createNodes(mapping[key]),
|
|
380
|
-
// }),
|
|
381
|
-
// ],
|
|
382
|
-
// });
|
|
383
|
-
// }),
|
|
384
|
-
// }),
|
|
385
|
-
// ],
|
|
386
|
-
// }),
|
|
387
|
-
// });
|
|
388
|
-
// }
|
|
389
|
-
function createDetailsNode(name, schemaName, schema, required, nullable) {
|
|
390
|
-
return (0, utils_1.create)("SchemaItem", {
|
|
391
|
-
collapsible: true,
|
|
392
|
-
className: "schemaItem",
|
|
393
|
-
children: [
|
|
394
|
-
(0, createDetails_1.createDetails)({
|
|
395
|
-
children: [
|
|
396
|
-
(0, createDetailsSummary_1.createDetailsSummary)({
|
|
397
|
-
children: [
|
|
398
|
-
(0, utils_1.create)("strong", { children: name }),
|
|
399
|
-
(0, utils_1.create)("span", {
|
|
400
|
-
style: { opacity: "0.6" },
|
|
401
|
-
children: ` ${schemaName}`,
|
|
402
|
-
}),
|
|
403
|
-
(0, utils_1.guard)((schema.nullable && schema.nullable === true) ||
|
|
404
|
-
(nullable && nullable === true), () => [
|
|
405
|
-
(0, utils_1.create)("strong", {
|
|
406
|
-
style: {
|
|
407
|
-
fontSize: "var(--ifm-code-font-size)",
|
|
408
|
-
color: "var(--openapi-nullable)",
|
|
409
|
-
},
|
|
410
|
-
children: " nullable",
|
|
411
|
-
}),
|
|
412
|
-
]),
|
|
413
|
-
(0, utils_1.guard)(Array.isArray(required)
|
|
414
|
-
? required.includes(name)
|
|
415
|
-
: required === true, () => [
|
|
416
|
-
(0, utils_1.create)("strong", {
|
|
417
|
-
style: {
|
|
418
|
-
fontSize: "var(--ifm-code-font-size)",
|
|
419
|
-
color: "var(--openapi-required)",
|
|
420
|
-
},
|
|
421
|
-
children: " required",
|
|
422
|
-
}),
|
|
423
|
-
]),
|
|
424
|
-
],
|
|
425
|
-
}),
|
|
426
|
-
(0, utils_1.create)("div", {
|
|
427
|
-
style: { marginLeft: "1rem" },
|
|
428
|
-
children: [
|
|
429
|
-
(0, utils_1.guard)((0, schema_1.getQualifierMessage)(schema), (message) => (0, utils_1.create)("div", {
|
|
430
|
-
style: { marginTop: ".5rem", marginBottom: ".5rem" },
|
|
431
|
-
children: (0, createDescription_1.createDescription)(message),
|
|
432
|
-
})),
|
|
433
|
-
(0, utils_1.guard)(schema.description, (description) => (0, utils_1.create)("div", {
|
|
434
|
-
style: { marginTop: ".5rem", marginBottom: ".5rem" },
|
|
435
|
-
children: (0, createDescription_1.createDescription)(description),
|
|
436
|
-
})),
|
|
437
|
-
createNodes(schema),
|
|
438
|
-
],
|
|
439
|
-
}),
|
|
440
|
-
],
|
|
441
|
-
}),
|
|
442
|
-
],
|
|
443
|
-
});
|
|
444
|
-
}
|
|
445
|
-
function createOneOfProperty(name, schemaName, schema, required, nullable) {
|
|
446
|
-
return (0, utils_1.create)("SchemaItem", {
|
|
447
|
-
collapsible: true,
|
|
448
|
-
className: "schemaItem",
|
|
449
|
-
children: [
|
|
450
|
-
(0, createDetails_1.createDetails)({
|
|
451
|
-
children: [
|
|
452
|
-
(0, createDetailsSummary_1.createDetailsSummary)({
|
|
453
|
-
children: [
|
|
454
|
-
(0, utils_1.create)("strong", { children: name }),
|
|
455
|
-
(0, utils_1.create)("span", {
|
|
456
|
-
style: { opacity: "0.6" },
|
|
457
|
-
children: ` ${schemaName}`,
|
|
458
|
-
}),
|
|
459
|
-
(0, utils_1.guard)((schema.nullable && schema.nullable === true) ||
|
|
460
|
-
(nullable && nullable === true), () => [
|
|
461
|
-
(0, utils_1.create)("strong", {
|
|
462
|
-
style: {
|
|
463
|
-
fontSize: "var(--ifm-code-font-size)",
|
|
464
|
-
color: "var(--openapi-nullable)",
|
|
465
|
-
},
|
|
466
|
-
children: " nullable",
|
|
467
|
-
}),
|
|
468
|
-
]),
|
|
469
|
-
(0, utils_1.guard)(Array.isArray(required)
|
|
470
|
-
? required.includes(name)
|
|
471
|
-
: required === true, () => [
|
|
472
|
-
(0, utils_1.create)("strong", {
|
|
473
|
-
style: {
|
|
474
|
-
fontSize: "var(--ifm-code-font-size)",
|
|
475
|
-
color: "var(--openapi-required)",
|
|
476
|
-
},
|
|
477
|
-
children: " required",
|
|
478
|
-
}),
|
|
479
|
-
]),
|
|
480
|
-
],
|
|
481
|
-
}),
|
|
482
|
-
(0, utils_1.create)("div", {
|
|
483
|
-
style: { marginLeft: "1rem" },
|
|
484
|
-
children: [
|
|
485
|
-
(0, utils_1.guard)((0, schema_1.getQualifierMessage)(schema), (message) => (0, utils_1.create)("div", {
|
|
486
|
-
style: { marginTop: ".5rem", marginBottom: ".5rem" },
|
|
487
|
-
children: (0, createDescription_1.createDescription)(message),
|
|
488
|
-
})),
|
|
489
|
-
(0, utils_1.guard)(schema.description, (description) => (0, utils_1.create)("div", {
|
|
490
|
-
style: { marginTop: ".5rem", marginBottom: ".5rem" },
|
|
491
|
-
children: (0, createDescription_1.createDescription)(description),
|
|
492
|
-
})),
|
|
493
|
-
],
|
|
494
|
-
}),
|
|
495
|
-
(0, utils_1.create)("div", {
|
|
496
|
-
children: [
|
|
497
|
-
(0, utils_1.create)("span", {
|
|
498
|
-
className: "badge badge--info",
|
|
499
|
-
children: "oneOf",
|
|
500
|
-
}),
|
|
501
|
-
(0, utils_1.create)("SchemaTabs", {
|
|
502
|
-
children: schema["oneOf"].map((property, index) => {
|
|
503
|
-
var _a;
|
|
504
|
-
const label = (_a = property.type) !== null && _a !== void 0 ? _a : `MOD${index + 1}`;
|
|
505
|
-
return (0, utils_1.create)("TabItem", {
|
|
506
|
-
label: label,
|
|
507
|
-
value: `${index}-property`,
|
|
508
|
-
children: [
|
|
509
|
-
(0, utils_1.create)("p", { children: label }),
|
|
510
|
-
(0, utils_1.guard)(schema.description, (description) => (0, utils_1.create)("div", {
|
|
511
|
-
style: { marginTop: ".5rem", marginBottom: ".5rem" },
|
|
512
|
-
children: (0, createDescription_1.createDescription)(description),
|
|
513
|
-
})),
|
|
514
|
-
],
|
|
515
|
-
});
|
|
516
|
-
}),
|
|
517
|
-
}),
|
|
518
|
-
],
|
|
519
|
-
}),
|
|
520
|
-
],
|
|
521
|
-
}),
|
|
522
|
-
],
|
|
523
|
-
});
|
|
524
|
-
}
|
|
525
|
-
/**
|
|
526
|
-
* For handling discriminators that map to a same-level property (like 'petType').
|
|
527
|
-
* Note: These should only be encountered while iterating through properties.
|
|
528
|
-
*/
|
|
529
|
-
function createPropertyDiscriminator(name, schemaName, schema, discriminator, required) {
|
|
530
|
-
if (schema === undefined) {
|
|
531
|
-
return undefined;
|
|
532
|
-
}
|
|
533
|
-
if (discriminator.mapping === undefined) {
|
|
534
|
-
return undefined;
|
|
535
|
-
}
|
|
536
|
-
return (0, utils_1.create)("SchemaItem", {
|
|
537
|
-
name,
|
|
538
|
-
required: Array.isArray(required) ? required.includes(name) : required,
|
|
539
|
-
schemaName: schemaName,
|
|
540
|
-
qualifierMessage: (0, schema_1.getQualifierMessage)(schema),
|
|
541
|
-
schema: schema,
|
|
542
|
-
collapsible: false,
|
|
543
|
-
discriminator: true,
|
|
544
|
-
children: [
|
|
545
|
-
(0, utils_1.create)("DiscriminatorTabs", {
|
|
546
|
-
children: Object.keys(discriminator === null || discriminator === void 0 ? void 0 : discriminator.mapping).map((key, index) => {
|
|
547
|
-
const label = key;
|
|
548
|
-
return (0, utils_1.create)("TabItem", {
|
|
549
|
-
label: label,
|
|
550
|
-
value: `${index}-item-discriminator`,
|
|
551
|
-
children: createNodes(discriminator === null || discriminator === void 0 ? void 0 : discriminator.mapping[key]),
|
|
552
|
-
});
|
|
553
|
-
}),
|
|
554
|
-
}),
|
|
555
|
-
],
|
|
556
|
-
});
|
|
557
|
-
}
|
|
558
|
-
/**
|
|
559
|
-
* Creates the edges or "leaves" of a schema tree. Edges can branch into sub-nodes with createDetails().
|
|
560
|
-
*/
|
|
561
|
-
function createEdges({ name, schema, required, discriminator, }) {
|
|
562
|
-
var _a, _b, _c, _d;
|
|
563
|
-
const schemaName = (0, schema_1.getSchemaName)(schema);
|
|
564
|
-
if (discriminator !== undefined && discriminator.propertyName === name) {
|
|
565
|
-
return createPropertyDiscriminator(name, "string", schema, discriminator, required);
|
|
566
|
-
}
|
|
567
|
-
if (schema.oneOf !== undefined || schema.anyOf !== undefined) {
|
|
568
|
-
return createOneOfProperty(name, schemaName, schema, required, schema.nullable);
|
|
569
|
-
}
|
|
570
|
-
if (schema.allOf !== undefined) {
|
|
571
|
-
const { mergedSchemas, required, } = mergeAllOf(schema.allOf);
|
|
572
|
-
const mergedSchemaName = (0, schema_1.getSchemaName)(mergedSchemas);
|
|
573
|
-
if (mergedSchemas.oneOf !== undefined ||
|
|
574
|
-
mergedSchemas.anyOf !== undefined) {
|
|
575
|
-
return createDetailsNode(name, mergedSchemaName, mergedSchemas, required, schema.nullable);
|
|
576
|
-
}
|
|
577
|
-
if (mergedSchemas.properties !== undefined) {
|
|
578
|
-
return createDetailsNode(name, mergedSchemaName, mergedSchemas, required, schema.nullable);
|
|
579
|
-
}
|
|
580
|
-
if (mergedSchemas.additionalProperties !== undefined) {
|
|
581
|
-
return createDetailsNode(name, mergedSchemaName, mergedSchemas, required, schema.nullable);
|
|
582
|
-
}
|
|
583
|
-
// array of objects
|
|
584
|
-
if (((_a = mergedSchemas.items) === null || _a === void 0 ? void 0 : _a.properties) !== undefined) {
|
|
585
|
-
return createDetailsNode(name, mergedSchemaName, mergedSchemas, required, schema.nullable);
|
|
586
|
-
}
|
|
587
|
-
if (mergedSchemas.readOnly && mergedSchemas.readOnly === true) {
|
|
588
|
-
return undefined;
|
|
589
|
-
}
|
|
590
|
-
return (0, utils_1.create)("SchemaItem", {
|
|
591
|
-
collapsible: false,
|
|
592
|
-
name,
|
|
593
|
-
required: Array.isArray(required) ? required.includes(name) : required,
|
|
594
|
-
schemaName: schemaName,
|
|
595
|
-
qualifierMessage: (0, schema_1.getQualifierMessage)(schema),
|
|
596
|
-
schema: mergedSchemas,
|
|
597
|
-
});
|
|
598
|
-
}
|
|
599
|
-
if (schema.properties !== undefined) {
|
|
600
|
-
return createDetailsNode(name, schemaName, schema, required, schema.nullable);
|
|
601
|
-
}
|
|
602
|
-
if (schema.additionalProperties !== undefined) {
|
|
603
|
-
return createDetailsNode(name, schemaName, schema, required, schema.nullable);
|
|
604
|
-
}
|
|
605
|
-
// array of objects
|
|
606
|
-
if (((_b = schema.items) === null || _b === void 0 ? void 0 : _b.properties) !== undefined) {
|
|
607
|
-
return createDetailsNode(name, schemaName, schema, required, schema.nullable);
|
|
608
|
-
}
|
|
609
|
-
if (((_c = schema.items) === null || _c === void 0 ? void 0 : _c.anyOf) !== undefined || ((_d = schema.items) === null || _d === void 0 ? void 0 : _d.oneOf) !== undefined) {
|
|
610
|
-
return createDetailsNode(name, schemaName, schema, required, schema.nullable);
|
|
611
|
-
}
|
|
612
|
-
if (schema.readOnly && schema.readOnly === true) {
|
|
613
|
-
return undefined;
|
|
614
|
-
}
|
|
615
|
-
// primitives and array of non-objects
|
|
616
|
-
return (0, utils_1.create)("SchemaItem", {
|
|
617
|
-
collapsible: false,
|
|
618
|
-
name,
|
|
619
|
-
required: Array.isArray(required) ? required.includes(name) : required,
|
|
620
|
-
schemaName: schemaName,
|
|
621
|
-
qualifierMessage: (0, schema_1.getQualifierMessage)(schema),
|
|
622
|
-
schema: schema,
|
|
623
|
-
});
|
|
624
|
-
}
|
|
625
|
-
/**
|
|
626
|
-
* Creates a hierarchical level of a schema tree. Nodes produce edges that can branch into sub-nodes with edges, recursively.
|
|
627
|
-
*/
|
|
628
|
-
function createNodes(schema) {
|
|
629
|
-
const nodes = [];
|
|
630
|
-
// if (schema.discriminator !== undefined) {
|
|
631
|
-
// return createDiscriminator(schema);
|
|
632
|
-
// }
|
|
633
|
-
if (schema.oneOf !== undefined || schema.anyOf !== undefined) {
|
|
634
|
-
nodes.push(createAnyOneOf(schema));
|
|
635
|
-
}
|
|
636
|
-
if (schema.allOf !== undefined) {
|
|
637
|
-
const { mergedSchemas } = mergeAllOf(schema.allOf);
|
|
638
|
-
// allOf seems to always result in properties
|
|
639
|
-
if (mergedSchemas.properties !== undefined) {
|
|
640
|
-
nodes.push(createProperties(mergedSchemas));
|
|
641
|
-
}
|
|
642
|
-
}
|
|
643
|
-
if (schema.properties !== undefined) {
|
|
644
|
-
nodes.push(createProperties(schema));
|
|
645
|
-
}
|
|
646
|
-
if (schema.additionalProperties !== undefined) {
|
|
647
|
-
nodes.push(createAdditionalProperties(schema));
|
|
648
|
-
}
|
|
649
|
-
// TODO: figure out how to handle array of objects
|
|
650
|
-
if (schema.items !== undefined) {
|
|
651
|
-
nodes.push(createItems(schema));
|
|
652
|
-
}
|
|
653
|
-
if (nodes.length && nodes.length > 0) {
|
|
654
|
-
return nodes.filter(Boolean).flat();
|
|
655
|
-
}
|
|
656
|
-
// primitive
|
|
657
|
-
if (schema.type !== undefined) {
|
|
658
|
-
if (schema.allOf) {
|
|
659
|
-
//handle circular result in allOf
|
|
660
|
-
if (schema.allOf.length && typeof schema.allOf[0] === "string") {
|
|
661
|
-
return (0, utils_1.create)("div", {
|
|
662
|
-
style: {
|
|
663
|
-
marginTop: ".5rem",
|
|
664
|
-
marginBottom: ".5rem",
|
|
665
|
-
marginLeft: "1rem",
|
|
666
|
-
},
|
|
667
|
-
children: (0, createDescription_1.createDescription)(schema.allOf[0]),
|
|
668
|
-
});
|
|
669
|
-
}
|
|
670
|
-
}
|
|
671
|
-
return (0, utils_1.create)("div", {
|
|
672
|
-
style: {
|
|
673
|
-
marginTop: ".5rem",
|
|
674
|
-
marginBottom: ".5rem",
|
|
675
|
-
marginLeft: "1rem",
|
|
676
|
-
},
|
|
677
|
-
children: (0, createDescription_1.createDescription)(schema.type),
|
|
678
|
-
});
|
|
679
|
-
}
|
|
680
|
-
// handle circular references
|
|
681
|
-
if (typeof schema === "string") {
|
|
682
|
-
return (0, utils_1.create)("div", {
|
|
683
|
-
style: {
|
|
684
|
-
marginTop: ".5rem",
|
|
685
|
-
marginBottom: ".5rem",
|
|
686
|
-
marginLeft: "1rem",
|
|
687
|
-
},
|
|
688
|
-
children: [(0, createDescription_1.createDescription)(schema)],
|
|
689
|
-
});
|
|
690
|
-
}
|
|
691
|
-
// Unknown node/schema type should return undefined
|
|
692
|
-
// So far, haven't seen this hit in testing
|
|
693
|
-
return "any";
|
|
694
|
-
}
|
|
695
15
|
function createRequestSchema({ title, body, ...rest }) {
|
|
696
16
|
var _a;
|
|
697
17
|
if (body === undefined ||
|
|
@@ -752,7 +72,7 @@ function createRequestSchema({ title, body, ...rest }) {
|
|
|
752
72
|
}),
|
|
753
73
|
(0, utils_1.create)("ul", {
|
|
754
74
|
style: { marginLeft: "1rem" },
|
|
755
|
-
children: createNodes(firstBody),
|
|
75
|
+
children: (0, createSchema_1.createNodes)(firstBody),
|
|
756
76
|
}),
|
|
757
77
|
],
|
|
758
78
|
}),
|
|
@@ -815,7 +135,7 @@ function createRequestSchema({ title, body, ...rest }) {
|
|
|
815
135
|
}),
|
|
816
136
|
(0, utils_1.create)("ul", {
|
|
817
137
|
style: { marginLeft: "1rem" },
|
|
818
|
-
children: createNodes(firstBody),
|
|
138
|
+
children: (0, createSchema_1.createNodes)(firstBody),
|
|
819
139
|
}),
|
|
820
140
|
],
|
|
821
141
|
}),
|