docusaurus-plugin-openapi-docs 0.0.0-413 → 0.0.0-416

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.
@@ -264,7 +264,7 @@ function createDiscriminator(schema) {
264
264
  propertyDescription = schema.properties[propertyName].description;
265
265
  }
266
266
  }
267
- return (0, utils_1.create)("li", {
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)("li", {
375
+ return (0, utils_1.create)("div", {
376
376
  className: "discriminatorItem",
377
377
  children: (0, utils_1.create)("div", {
378
378
  children: [
@@ -425,7 +425,7 @@ function createPropertyDiscriminator(name, schemaName, schema, discriminator, re
425
425
  * Creates the edges or "leaves" of a schema tree. Edges can branch into sub-nodes with createDetails().
426
426
  */
427
427
  function createEdges({ name, schema, required, discriminator, }) {
428
- var _a;
428
+ var _a, _b;
429
429
  const schemaName = (0, schema_1.getSchemaName)(schema);
430
430
  if (discriminator !== undefined && discriminator.propertyName === name) {
431
431
  return createPropertyDiscriminator(name, "string", schema, discriminator, required);
@@ -446,6 +446,10 @@ function createEdges({ name, schema, required, discriminator, }) {
446
446
  if (mergedSchemas.additionalProperties !== undefined) {
447
447
  return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
448
448
  }
449
+ // array of objects
450
+ if (((_a = mergedSchemas.items) === null || _a === void 0 ? void 0 : _a.properties) !== undefined) {
451
+ return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
452
+ }
449
453
  return (0, utils_1.create)("SchemaItem", {
450
454
  collapsible: false,
451
455
  name,
@@ -453,6 +457,7 @@ function createEdges({ name, schema, required, discriminator, }) {
453
457
  schemaDescription: mergedSchemas.description,
454
458
  schemaName: schemaName,
455
459
  qualifierMessage: (0, schema_1.getQualifierMessage)(schema),
460
+ defaultValue: schema.default,
456
461
  });
457
462
  }
458
463
  if (schema.properties !== undefined) {
@@ -462,7 +467,7 @@ function createEdges({ name, schema, required, discriminator, }) {
462
467
  return createDetailsNode(name, schemaName, schema, required);
463
468
  }
464
469
  // array of objects
465
- if (((_a = schema.items) === null || _a === void 0 ? void 0 : _a.properties) !== undefined) {
470
+ if (((_b = schema.items) === null || _b === void 0 ? void 0 : _b.properties) !== undefined) {
466
471
  return createDetailsNode(name, schemaName, schema, required);
467
472
  }
468
473
  // primitives and array of non-objects
@@ -473,6 +478,7 @@ function createEdges({ name, schema, required, discriminator, }) {
473
478
  schemaDescription: schema.description,
474
479
  schemaName: schemaName,
475
480
  qualifierMessage: (0, schema_1.getQualifierMessage)(schema),
481
+ defaultValue: schema.default,
476
482
  });
477
483
  }
478
484
  /**
@@ -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-413",
4
+ "version": "0.0.0-416",
5
5
  "license": "MIT",
6
6
  "keywords": [
7
7
  "openapi",
@@ -67,5 +67,5 @@
67
67
  "engines": {
68
68
  "node": ">=14"
69
69
  },
70
- "gitHead": "f2cafe5a93dc9b203fc039174c56dc7e8c8db8c4"
70
+ "gitHead": "84a35572bf6f740b5b08204fc1947e4da4313a35"
71
71
  }
@@ -320,7 +320,7 @@ function createDiscriminator(schema: SchemaObject) {
320
320
  }
321
321
  }
322
322
 
323
- return create("li", {
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("li", {
459
+ return create("div", {
460
460
  className: "discriminatorItem",
461
461
  children: create("div", {
462
462
  children: [
@@ -568,6 +568,11 @@ function createEdges({
568
568
  return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
569
569
  }
570
570
 
571
+ // array of objects
572
+ if (mergedSchemas.items?.properties !== undefined) {
573
+ return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
574
+ }
575
+
571
576
  return create("SchemaItem", {
572
577
  collapsible: false,
573
578
  name,
@@ -575,6 +580,7 @@ function createEdges({
575
580
  schemaDescription: mergedSchemas.description,
576
581
  schemaName: schemaName,
577
582
  qualifierMessage: getQualifierMessage(schema),
583
+ defaultValue: schema.default,
578
584
  });
579
585
  }
580
586
 
@@ -599,6 +605,7 @@ function createEdges({
599
605
  schemaDescription: schema.description,
600
606
  schemaName: schemaName,
601
607
  qualifierMessage: getQualifierMessage(schema),
608
+ defaultValue: schema.default,
602
609
  });
603
610
  }
604
611
 
@@ -64,7 +64,11 @@ export function getQualifierMessage(schema?: SchemaObject): string | undefined {
64
64
  return undefined;
65
65
  }
66
66
 
67
- if (schema.items) {
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;