docusaurus-plugin-openapi-docs 0.0.0-735 → 0.0.0-736

package/src/markdown/createSchema.ts

@@ -186,7 +186,7 @@ function createAdditionalProperties(schema: SchemaObject) {
       title ?? schemaName,
       additionalProperties,
       required,
-      schema.nullable
+      schema.nullable,
     );
   }
 
@@ -202,7 +202,7 @@ function createAdditionalProperties(schema: SchemaObject) {
     if (additionalProperties !== undefined) {
       const type = schema.additionalProperties?.additionalProperties?.type;
       const schemaName = getSchemaName(
-        schema.additionalProperties?.additionalProperties!
+        schema.additionalProperties?.additionalProperties!,
       );
       return create("SchemaItem", {
         name: "property name*",
@@ -234,7 +234,7 @@ function createAdditionalProperties(schema: SchemaObject) {
       required: Array.isArray(schema.required)
         ? schema.required.includes(key)
         : false,
-    })
+    }),
   );
 }
 
@@ -333,7 +333,7 @@ function createItems(schema: SchemaObject) {
         required: Array.isArray(schema.required)
           ? schema.required.includes(key)
           : false,
-      })
+      }),
     ),
     createClosingArrayBracket(),
   ].flat();
@@ -347,7 +347,7 @@ function createDetailsNode(
   schemaName: string,
   schema: SchemaObject,
   required: string[] | boolean,
-  nullable: boolean | unknown
+  nullable: boolean | unknown,
 ): any {
   return create("SchemaItem", {
     collapsible: true,
@@ -381,7 +381,7 @@ function createDetailsNode(
                       create("span", {
                         className: "openapi-schema__divider",
                       }),
-                    ]
+                    ],
                   ),
                   guard(nullable, () => [
                     create("span", {
@@ -398,7 +398,7 @@ function createDetailsNode(
                         className: "openapi-schema__required",
                         children: "required",
                       }),
-                    ]
+                    ],
                   ),
                   guard(schema.deprecated, () => [
                     create("span", {
@@ -417,13 +417,13 @@ function createDetailsNode(
                 create("div", {
                   style: { marginTop: ".5rem", marginBottom: ".5rem" },
                   children: createDescription(message),
-                })
+                }),
               ),
               guard(schema.description, (description) =>
                 create("div", {
                   style: { marginTop: ".5rem", marginBottom: ".5rem" },
                   children: createDescription(description),
-                })
+                }),
               ),
               createNodes(schema, SCHEMA_TYPE),
             ],
@@ -442,7 +442,7 @@ function createAnyOneOfProperty(
   schemaName: string,
   schema: SchemaObject,
   required: string[] | boolean,
-  nullable: boolean | unknown
+  nullable: boolean | unknown,
 ): any {
   return create("SchemaItem", {
     collapsible: true,
@@ -469,7 +469,7 @@ function createAnyOneOfProperty(
                     },
                     children: " nullable",
                   }),
-                ]
+                ],
               ),
               guard(
                 Array.isArray(required)
@@ -483,7 +483,7 @@ function createAnyOneOfProperty(
                     },
                     children: " required",
                   }),
-                ]
+                ],
               ),
             ],
           }),
@@ -494,13 +494,13 @@ function createAnyOneOfProperty(
                 create("div", {
                   style: { marginTop: ".5rem", marginBottom: ".5rem" },
                   children: createDescription(message),
-                })
+                }),
               ),
               guard(schema.description, (description) =>
                 create("div", {
                   style: { marginTop: ".5rem", marginBottom: ".5rem" },
                   children: createDescription(description),
-                })
+                }),
               ),
             ],
           }),
@@ -520,7 +520,7 @@ function createPropertyDiscriminator(
   schemaName: string,
   schema: SchemaObject,
   discriminator: any,
-  required: string[] | boolean
+  required: string[] | boolean,
 ): any {
   if (schema === undefined) {
     return undefined;
@@ -545,7 +545,7 @@ function createPropertyDiscriminator(
               create("span", {
                 className: "openapi-schema__name",
                 children: ` ${schemaName}`,
-              })
+              }),
             ),
             guard(required, () => [
               create("span", {
@@ -561,7 +561,7 @@ function createPropertyDiscriminator(
               paddingLeft: "1rem",
             },
             children: createDescription(message),
-          })
+          }),
         ),
         guard(schema.description, (description) =>
           create("div", {
@@ -569,7 +569,7 @@ function createPropertyDiscriminator(
               paddingLeft: "1rem",
             },
             children: createDescription(description),
-          })
+          }),
         ),
         create("DiscriminatorTabs", {
           className: "openapi-tabs__discriminator",
@@ -623,7 +623,7 @@ function createEdges({
       "string",
       schema,
       discriminator,
-      required
+      required,
     );
   }
 
@@ -633,13 +633,13 @@ function createEdges({
       schemaName,
       schema,
       required,
-      schema.nullable
+      schema.nullable,
     );
   }
 
   if (schema.allOf !== undefined) {
     const { mergedSchemas }: { mergedSchemas: SchemaObject } = mergeAllOf(
-      schema.allOf
+      schema.allOf,
     );
 
     if (SCHEMA_TYPE === "request") {
@@ -664,7 +664,7 @@ function createEdges({
         mergedSchemaName,
         mergedSchemas,
         required,
-        schema.nullable
+        schema.nullable,
       );
     }
 
@@ -674,7 +674,7 @@ function createEdges({
         mergedSchemaName,
         mergedSchemas,
         required,
-        schema.nullable
+        schema.nullable,
       );
     }
 
@@ -684,7 +684,7 @@ function createEdges({
         mergedSchemaName,
         mergedSchemas,
         required,
-        schema.nullable
+        schema.nullable,
       );
     }
 
@@ -695,7 +695,7 @@ function createEdges({
         mergedSchemaName,
         mergedSchemas,
         required,
-        schema.nullable
+        schema.nullable,
       );
     }
 
@@ -715,7 +715,7 @@ function createEdges({
       schemaName,
       schema,
       required,
-      schema.nullable
+      schema.nullable,
     );
   }
 
@@ -725,7 +725,7 @@ function createEdges({
       schemaName,
       schema,
       required,
-      schema.nullable
+      schema.nullable,
     );
   }
 
@@ -736,7 +736,7 @@ function createEdges({
       schemaName,
       schema,
       required,
-      schema.nullable
+      schema.nullable,
     );
   }
 
@@ -746,7 +746,7 @@ function createEdges({
       schemaName,
       schema,
       required,
-      schema.nullable
+      schema.nullable,
     );
   }
 
@@ -766,7 +766,7 @@ function createEdges({
  */
 export function createNodes(
   schema: SchemaObject,
-  schemaType: "request" | "response"
+  schemaType: "request" | "response",
 ): any {
   SCHEMA_TYPE = schemaType;
   if (SCHEMA_TYPE === "request") {
@@ -843,7 +843,7 @@ export function createNodes(
               paddingTop: "1rem",
             },
             children: createDescription(message),
-          })
+          }),
         ),
       ],
     });
@@ -864,7 +864,7 @@ export function createNodes(
               paddingTop: "1rem",
             },
             children: createDescription(message),
-          })
+          }),
         ),
       ],
     });

package/src/markdown/createStatusCodes.ts

@@ -95,22 +95,22 @@ function createResponseHeaders(responseHeaders: any) {
                           guard(example, () => `Example: ${example}`),
                           createDescription(description),
                         ],
-                      })
+                      }),
                     ),
                   ],
                 }),
               ],
             });
-          }
+          },
         ),
       ],
-    })
+    }),
   );
 }
 
 export function createResponseExamples(
   responseExamples: any,
-  mimeType: string
+  mimeType: string,
 ) {
   let language = "shell";
   if (mimeType.endsWith("json")) {
@@ -153,7 +153,7 @@ export function createResponseExamples(
           }),
         ],
       });
-    }
+    },
   );
 }
 

package/src/markdown/schema.ts

@@ -49,7 +49,7 @@ function prettyName(schema: SchemaObject, circular?: boolean) {
 
 export function getSchemaName(
   schema: SchemaObject,
-  circular?: boolean
+  circular?: boolean,
 ): string {
   if (schema.items) {
     return prettyName(schema.items, circular) + "[]";
@@ -83,7 +83,7 @@ export function getQualifierMessage(schema?: SchemaObject): string | undefined {
   if (schema.items && schema.items.enum) {
     if (schema.items.enum) {
       qualifierGroups.push(
-        `[${schema.items.enum.map((e) => `\`${e}\``).join(", ")}]`
+        `[${schema.items.enum.map((e) => `\`${e}\``).join(", ")}]`,
       );
     }
   }
@@ -154,7 +154,7 @@ export function getQualifierMessage(schema?: SchemaObject): string | undefined {
 
   if (schema.pattern) {
     qualifierGroups.push(
-      `Value must match regular expression \`${schema.pattern}\``
+      `Value must match regular expression \`${schema.pattern}\``,
     );
   }
 

package/src/markdown/utils.ts

@@ -22,7 +22,7 @@ export function create(tag: string, props: Props): string {
 
 export function guard<T>(
   value: T | undefined,
-  cb: (value: T) => Children
+  cb: (value: T) => Children,
 ): string {
   if (!!value || value === 0) {
     const children = cb(value);

package/src/openapi/createRequestExample.ts

@@ -67,7 +67,7 @@ function sampleRequestFromProp(name: string, prop: any, obj: any): any {
     obj[name] = sampleRequestFromSchema(prop.anyOf[0]);
   } else if (prop.allOf) {
     const { mergedSchemas }: { mergedSchemas: SchemaObject } = mergeAllOf(
-      prop.allOf
+      prop.allOf,
     );
     sampleRequestFromProp(name, mergedSchemas, obj);
   } else {
@@ -150,7 +150,7 @@ export const sampleRequestFromSchema = (schema: SchemaObject = {}): any => {
 
         if (prop.items && prop.items.properties) {
           for (const [key, value] of Object.entries(
-            prop.items.properties
+            prop.items.properties,
           ) as any) {
             if (
               (value.readOnly && value.readOnly === true) ||
@@ -204,7 +204,10 @@ export const sampleRequestFromSchema = (schema: SchemaObject = {}): any => {
     return primitive(schemaCopy);
   } catch (err) {
     console.error(
-      chalk.yellow("WARNING: failed to create example from schema object:", err)
+      chalk.yellow(
+        "WARNING: failed to create example from schema object:",
+        err,
+      ),
     );
     return;
   }

package/src/openapi/createResponseExample.ts

@@ -67,7 +67,7 @@ function sampleResponseFromProp(name: string, prop: any, obj: any): any {
     obj[name] = sampleResponseFromSchema(prop.anyOf[0]);
   } else if (prop.allOf) {
     const { mergedSchemas }: { mergedSchemas: SchemaObject } = mergeAllOf(
-      prop.allOf
+      prop.allOf,
     );
     sampleResponseFromProp(name, mergedSchemas, obj);
   } else {
@@ -153,7 +153,7 @@ export const sampleResponseFromSchema = (schema: SchemaObject = {}): any => {
 
         if (prop.items && prop.items.properties) {
           for (const [key, value] of Object.entries(
-            prop.items.properties
+            prop.items.properties,
           ) as any) {
             if (
               (value.writeOnly && value.writeOnly === true) ||
@@ -207,7 +207,10 @@ export const sampleResponseFromSchema = (schema: SchemaObject = {}): any => {
     return primitive(schemaCopy);
   } catch (err) {
     console.error(
-      chalk.yellow("WARNING: failed to create example from schema object:", err)
+      chalk.yellow(
+        "WARNING: failed to create example from schema object:",
+        err,
+      ),
     );
     return;
   }

package/src/openapi/openapi.test.ts

@@ -18,10 +18,10 @@ describe("openapi", () => {
   describe("readOpenapiFiles", () => {
     it("readOpenapiFiles", async () => {
       const results = await readOpenapiFiles(
-        posixPath(path.join(__dirname, "__fixtures__/examples"))
+        posixPath(path.join(__dirname, "__fixtures__/examples")),
       );
       const categoryMeta = results.find((x) =>
-        x.source.endsWith("_category_.json")
+        x.source.endsWith("_category_.json"),
       );
       expect(categoryMeta).toBeFalsy();
       // console.log(results);
@@ -33,7 +33,7 @@ describe("openapi", () => {
       expect(yaml?.data["x-tagGroups"]).toBeDefined();
 
       expect(
-        yaml?.data.components?.schemas?.HelloString["x-tags"]
+        yaml?.data.components?.schemas?.HelloString["x-tags"],
       ).toBeDefined();
     });
   });

package/src/openapi/openapi.ts

@@ -39,7 +39,7 @@ function jsonToCollection(data: OpenApiObject): Promise<Collection> {
   return new Promise((resolve, reject) => {
     let schemaPack = new Converter.SchemaPack(
       { type: "json", data },
-      { schemaFaker: false }
+      { schemaFaker: false },
     );
     schemaPack.computedOptions.schemaFaker = false;
     schemaPack.convert((_err: any, conversionResult: any) => {
@@ -55,7 +55,7 @@ function jsonToCollection(data: OpenApiObject): Promise<Collection> {
  * Creates a Postman Collection object from an OpenAPI definition.
  */
 async function createPostmanCollection(
-  openapiData: OpenApiObject
+  openapiData: OpenApiObject,
 ): Promise<Collection> {
   // Create copy of openapiData
   const data = cloneDeep(openapiData) as OpenApiObject;
@@ -82,7 +82,7 @@ type PartialPage<T> = Omit<T, "permalink" | "source" | "sourceDirName">;
 function createItems(
   openapiData: OpenApiObject,
   options: APIOptions,
-  sidebarOptions: SidebarOptions
+  sidebarOptions: SidebarOptions,
 ): ApiMetadata[] {
   // TODO: Find a better way to handle this
   let items: PartialPage<ApiMetadata>[] = [];
@@ -106,7 +106,7 @@ function createItems(
       description: openapiData.info.description
         ? openapiData.info.description.replace(
             /((?:^|[^\\])(?:\\{2})*)"/g,
-            "$1'"
+            "$1'",
           )
         : "",
       frontMatter: {
@@ -210,7 +210,7 @@ function createItems(
           defaults.parameters = unionBy(
             operationObject.parameters,
             parameters,
-            "name"
+            "name",
           );
         } else {
           defaults.parameters = parameters;
@@ -232,7 +232,7 @@ function createItems(
         description: operationObject.description
           ? operationObject.description.replace(
               /((?:^|[^\\])(?:\\{2})*)"/g,
-              "$1'"
+              "$1'",
             )
           : "",
         frontMatter: {
@@ -269,7 +269,7 @@ function createItems(
 
   // Gather x-webhooks endpoints
   for (let [path, pathObject] of Object.entries(
-    openapiData["x-webhooks"] ?? {}
+    openapiData["x-webhooks"] ?? {},
   )) {
     path = "webhook";
     const { $ref, description, parameters, servers, summary, ...rest } =
@@ -354,7 +354,7 @@ function createItems(
           defaults.parameters = unionBy(
             operationObject.parameters,
             parameters,
-            "name"
+            "name",
           );
         } else {
           defaults.parameters = parameters;
@@ -376,7 +376,7 @@ function createItems(
         description: operationObject.description
           ? operationObject.description.replace(
               /((?:^|[^\\])(?:\\{2})*)"/g,
-              "$1'"
+              "$1'",
             )
           : "",
         frontMatter: {
@@ -418,7 +418,7 @@ function createItems(
   ) {
     // Gather schemas
     for (let [schema, schemaObject] of Object.entries(
-      openapiData?.components?.schemas ?? {}
+      openapiData?.components?.schemas ?? {},
     )) {
       if (options?.showSchemas === true || schemaObject["x-tags"]) {
         const baseIdSpaces =
@@ -442,7 +442,7 @@ function createItems(
           description: schemaObject.description
             ? schemaObject.description.replace(
                 /((?:^|[^\\])(?:\\{2})*)"/g,
-                "$1'"
+                "$1'",
               )
             : "",
           frontMatter: {
@@ -471,7 +471,7 @@ function createItems(
     const operationTags = uniq(
       apiItems
         .flatMap((item) => item.api.tags)
-        .filter((item): item is string => !!item)
+        .filter((item): item is string => !!item),
     );
 
     // eslint-disable-next-line array-callback-return
@@ -481,7 +481,7 @@ function createItems(
       .map((tag) => {
         const description = getTagDisplayName(
           tag.name!,
-          openapiData.tags ?? []
+          openapiData.tags ?? [],
         );
         const tagId = kebabCase(tag.name);
         const splitDescription = description.match(/[^\r\n]+/g);
@@ -514,7 +514,7 @@ function createItems(
  */
 function bindCollectionToApiItems(
   items: ApiMetadata[],
-  postmanCollection: sdk.Collection
+  postmanCollection: sdk.Collection,
 ) {
   postmanCollection.forEachItem((item: any) => {
     const method = item.request.method.toLowerCase();
@@ -545,7 +545,7 @@ interface OpenApiFiles {
 }
 
 export async function readOpenapiFiles(
-  openapiPath: string
+  openapiPath: string,
 ): Promise<OpenApiFiles[]> {
   if (!isURL(openapiPath)) {
     const stat = await fs.lstat(openapiPath);
@@ -562,19 +562,19 @@ export async function readOpenapiFiles(
           // TODO: make a function for this
           const fullPath = posixPath(path.join(openapiPath, source));
           const data = (await loadAndResolveSpec(
-            fullPath
+            fullPath,
           )) as unknown as OpenApiObject;
           return {
             source: fullPath, // This will be aliased in process.
             sourceDirName: path.dirname(source),
             data,
           };
-        })
+        }),
       );
     }
   }
   const data = (await loadAndResolveSpec(
-    openapiPath
+    openapiPath,
   )) as unknown as OpenApiObject;
   return [
     {
@@ -588,14 +588,14 @@ export async function readOpenapiFiles(
 export async function processOpenapiFiles(
   files: OpenApiFiles[],
   options: APIOptions,
-  sidebarOptions: SidebarOptions
+  sidebarOptions: SidebarOptions,
 ): Promise<[ApiMetadata[], TagObject[][], TagGroupObject[]]> {
   const promises = files.map(async (file) => {
     if (file.data !== undefined) {
       const processedFile = await processOpenapiFile(
         file.data,
         options,
-        sidebarOptions
+        sidebarOptions,
       );
       const itemsObjectsArray = processedFile[0].map((item) => ({
         ...item,
@@ -606,8 +606,8 @@ export async function processOpenapiFiles(
     }
     console.warn(
       chalk.yellow(
-        `WARNING: the following OpenAPI spec returned undefined: ${file.source}`
-      )
+        `WARNING: the following OpenAPI spec returned undefined: ${file.source}`,
+      ),
     );
     return [];
   });
@@ -651,7 +651,7 @@ export async function processOpenapiFiles(
 export async function processOpenapiFile(
   openapiData: OpenApiObject,
   options: APIOptions,
-  sidebarOptions: SidebarOptions
+  sidebarOptions: SidebarOptions,
 ): Promise<[ApiMetadata[], TagObject[], TagGroupObject[]]> {
   const postmanCollection = await createPostmanCollection(openapiData);
   const items = createItems(openapiData, options, sidebarOptions);

package/src/openapi/utils/loadAndResolveSpec.ts

@@ -61,7 +61,7 @@ function serializer(replacer: any, cycleReplacer: any) {
 
 export function convertSwagger2OpenAPI(spec: object) {
   console.warn(
-    "[ReDoc Compatibility mode]: Converting OpenAPI 2.0 to OpenAPI 3.0"
+    "[ReDoc Compatibility mode]: Converting OpenAPI 2.0 to OpenAPI 3.0",
   );
   return new Promise((resolve, reject) =>
     convertObj(
@@ -79,8 +79,8 @@ export function convertSwagger2OpenAPI(spec: object) {
           return reject(err);
         }
         resolve(res && res.openapi);
-      }
-    )
+      },
+    ),
   );
 }