docusaurus-plugin-openapi-docs 0.0.0-420 → 0.0.0-423

package/src/markdown/createStatusCodes.ts

@@ -9,7 +9,7 @@ import { ApiItem } from "../types";
 import { createDescription } from "./createDescription";
 import { createDetails } from "./createDetails";
 import { createDetailsSummary } from "./createDetailsSummary";
-import { createSchemaDetails } from "./createSchemaDetails";
+import { createResponseSchema } from "./createResponseSchema";
 import { create } from "./utils";
 import { guard } from "./utils";
 
@@ -79,7 +79,11 @@ function createResponseExamples(responseExamples: any) {
         value: `${finalFormattedName}`,
         children: [
           create("ResponseSamples", {
-            responseExample: JSON.stringify(exampleValue.value, null, 2),
+            responseExample: JSON.stringify(
+              exampleValue.value ?? exampleValue,
+              null,
+              2
+            ),
           }),
         ],
       });
@@ -106,7 +110,9 @@ export function createStatusCodes({ responses }: Props) {
           const responseContentKey: any =
             responseContent && Object.keys(responseContent)[0];
           const responseExamples: any =
-            responseContentKey && responseContent[responseContentKey].examples;
+            responseContentKey &&
+            (responseContent[responseContentKey].examples ||
+              responseContent[responseContentKey].example);
 
           return create("TabItem", {
             label: code,
@@ -126,7 +132,7 @@ export function createStatusCodes({ responses }: Props) {
                           createDetails({
                             "data-collaposed": false,
                             open: true,
-                            style: { textAlign: "left" },
+                            style: { textAlign: "left", marginBottom: "1rem" },
                             children: [
                               createDetailsSummary({
                                 children: [
@@ -139,7 +145,7 @@ export function createStatusCodes({ responses }: Props) {
                             ],
                           }),
                         create("div", {
-                          children: createSchemaDetails({
+                          children: createResponseSchema({
                             title: "Schema",
                             body: {
                               content: responses[code].content,
@@ -152,7 +158,7 @@ export function createStatusCodes({ responses }: Props) {
                   ],
                 })
               ),
-              guard(responseHeaders, () =>
+              guard(responseHeaders && !responseExamples, () =>
                 createDetails({
                   "data-collaposed": false,
                   open: true,
@@ -169,7 +175,7 @@ export function createStatusCodes({ responses }: Props) {
               ),
               guard(!responseExamples, () =>
                 create("div", {
-                  children: createSchemaDetails({
+                  children: createResponseSchema({
                     title: "Schema",
                     body: {
                       content: responses[code].content,

package/src/openapi/createExample.ts

@@ -7,6 +7,7 @@
 
 import chalk from "chalk";
 
+import { mergeAllOf } from "../markdown/createRequestSchema";
 import { SchemaObject } from "./types";
 
 interface OASTypeToTypeMap {
@@ -29,6 +30,7 @@ const primitives: Primitives = {
     default: () => "string",
     email: () => "user@example.com",
     date: () => new Date().toISOString().substring(0, 10),
+    "date-time": () => new Date().toISOString().substring(0, 10),
     uuid: () => "3fa85f64-5717-4562-b3fc-2c963f66afa6",
     hostname: () => "example.com",
     ipv4: () => "198.51.100.42",
@@ -58,21 +60,16 @@ export const sampleFromSchema = (schema: SchemaObject = {}): any => {
     }
 
     if (allOf) {
-      // TODO: We are just assuming it will always be an object for now
-      let obj: SchemaObject = {
-        type: "object",
-        properties: {},
-        required: [], // NOTE: We shouldn't need to worry about required
-      };
-      for (let item of allOf) {
-        if (item.properties) {
-          obj.properties = {
-            ...obj.properties,
-            ...item.properties,
-          };
+      const { mergedSchemas }: { mergedSchemas: SchemaObject } =
+        mergeAllOf(allOf);
+      if (mergedSchemas.properties) {
+        for (const [key, value] of Object.entries(mergedSchemas.properties)) {
+          if (value.readOnly && value.readOnly === true) {
+            delete mergedSchemas.properties[key];
+          }
         }
       }
-      return sampleFromSchema(obj);
+      return sampleFromSchema(mergedSchemas);
     }
 
     if (!type) {
@@ -88,6 +85,22 @@ export const sampleFromSchema = (schema: SchemaObject = {}): any => {
     if (type === "object") {
       let obj: any = {};
       for (let [name, prop] of Object.entries(properties ?? {})) {
+        if (prop.properties) {
+          for (const [key, value] of Object.entries(prop.properties)) {
+            if (value.readOnly && value.readOnly === true) {
+              delete prop.properties[key];
+            }
+          }
+        }
+
+        if (prop.items && prop.items.properties) {
+          for (const [key, value] of Object.entries(prop.items.properties)) {
+            if (value.readOnly && value.readOnly === true) {
+              delete prop.items.properties[key];
+            }
+          }
+        }
+
         if (prop.deprecated) {
           continue;
         }
@@ -115,6 +128,10 @@ export const sampleFromSchema = (schema: SchemaObject = {}): any => {
       return normalizeArray(schema.enum)[0];
     }
 
+    if (schema.readOnly && schema.readOnly === true) {
+      return undefined;
+    }
+
     return primitive(schema);
   } catch (err) {
     console.error(
@@ -131,7 +148,7 @@ function primitive(schema: SchemaObject = {}) {
     return;
   }
 
-  let fn = primitives[type].default;
+  let fn = schema.default ? () => schema.default : primitives[type].default;
 
   if (format !== undefined) {
     fn = primitives[type][format] || fn;

package/src/openapi/openapi.ts

@@ -124,9 +124,7 @@ function createItems(
       securitySchemes: openapiData.components?.securitySchemes,
       info: {
         ...openapiData.info,
-        tags: openapiData.tags?.map((tagName) =>
-          getTagDisplayName(tagName.name!, openapiData.tags ?? [])
-        ),
+        tags: openapiData.tags,
         title: openapiData.info.title ?? "Introduction",
         logo: openapiData.info["x-logo"]! as any,
         darkLogo: openapiData.info["x-dark-logo"]! as any,
@@ -200,9 +198,7 @@ function createItems(
         frontMatter: {},
         api: {
           ...defaults,
-          tags: operationObject.tags?.map((tagName) =>
-            getTagDisplayName(tagName, openapiData.tags ?? [])
-          ),
+          tags: operationObject.tags,
           method,
           path,
           servers,
@@ -303,7 +299,7 @@ export async function readOpenapiFiles(
 export async function processOpenapiFiles(
   files: OpenApiFiles[],
   sidebarOptions: SidebarOptions
-): Promise<[ApiMetadata[], TagObject[]]> {
+): Promise<[ApiMetadata[], TagObject[][]]> {
   const promises = files.map(async (file) => {
     if (file.data !== undefined) {
       const processedFile = await processOpenapiFile(file.data, sidebarOptions);
@@ -338,7 +334,7 @@ export async function processOpenapiFiles(
       // Remove undefined tags due to transient parsing errors
       return x !== undefined;
     });
-  return [items as ApiMetadata[], tags[0] as TagObject[]];
+  return [items as ApiMetadata[], tags as TagObject[][]];
 }
 
 export async function processOpenapiFile(

package/src/openapi/types.ts

@@ -41,7 +41,7 @@ export interface InfoObject {
   contact?: ContactObject;
   license?: LicenseObject;
   version: string;
-  tags?: String[];
+  tags?: TagObject[];
   "x-logo"?: LogoObject;
   "x-dark-logo"?: LogoObject;
   logo?: LogoObject;

package/src/sidebars/index.ts

@@ -37,7 +37,7 @@ function groupByTags(
   items: ApiPageMetadata[],
   sidebarOptions: SidebarOptions,
   options: APIOptions,
-  tags: TagObject[],
+  tags: TagObject[][],
   docPath: string
 ): ProcessedSidebar {
   const { outputDir, label } = options;
@@ -65,9 +65,10 @@ function groupByTags(
       .flatMap((item) => item.api.tags)
       .filter((item): item is string => !!item)
   );
+
+  // Only include operation tags that are globally defined
   const apiTags: string[] = [];
-  // eslint-disable-next-line array-callback-return
-  tags.map((tag) => {
+  tags.flat().forEach((tag) => {
     if (operationTags.includes(tag.name!)) {
       apiTags.push(tag.name!);
     }
@@ -114,7 +115,7 @@ function groupByTags(
       );
       const tagObject = tags.flat().find(
         (t) =>
-          (tag === t.name || tag === t["x-displayName"]) ?? {
+          tag === t.name ?? {
             name: tag,
             description: `${tag} Index`,
           }
@@ -155,7 +156,7 @@ function groupByTags(
 
       return {
         type: "category" as const,
-        label: tag,
+        label: tagObject?.["x-displayName"] ?? tag,
         link: linkConfig,
         collapsible: sidebarCollapsible,
         collapsed: sidebarCollapsed,
@@ -198,7 +199,7 @@ export default function generateSidebarSlice(
   sidebarOptions: SidebarOptions,
   options: APIOptions,
   api: ApiMetadata[],
-  tags: TagObject[],
+  tags: TagObject[][],
   docPath: string
 ) {
   let sidebarSlice: ProcessedSidebar = [];