docusaurus-plugin-openapi-docs 0.0.0-419 → 0.0.0-422

package/lib/markdown/createStatusCodes.js

@@ -10,7 +10,7 @@ exports.createStatusCodes = void 0;
 const createDescription_1 = require("./createDescription");
 const createDetails_1 = require("./createDetails");
 const createDetailsSummary_1 = require("./createDetailsSummary");
-const createSchemaDetails_1 = require("./createSchemaDetails");
+const createResponseSchema_1 = require("./createResponseSchema");
 const utils_1 = require("./utils");
 const utils_2 = require("./utils");
 function createResponseHeaders(responseHeaders) {
@@ -114,7 +114,7 @@ function createStatusCodes({ responses }) {
                                                     ],
                                                 }),
                                             (0, utils_1.create)("div", {
-                                                children: (0, createSchemaDetails_1.createSchemaDetails)({
+                                                children: (0, createResponseSchema_1.createResponseSchema)({
                                                     title: "Schema",
                                                     body: {
                                                         content: responses[code].content,
@@ -140,7 +140,7 @@ function createStatusCodes({ responses }) {
                                 ],
                             })),
                             (0, utils_2.guard)(!responseExamples, () => (0, utils_1.create)("div", {
-                                children: (0, createSchemaDetails_1.createSchemaDetails)({
+                                children: (0, createResponseSchema_1.createResponseSchema)({
                                     title: "Schema",
                                     body: {
                                         content: responses[code].content,

package/lib/openapi/createExample.js

@@ -11,11 +11,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.sampleFromSchema = void 0;
 const chalk_1 = __importDefault(require("chalk"));
+const createRequestSchema_1 = require("../markdown/createRequestSchema");
 const primitives = {
     string: {
         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",
@@ -41,21 +43,15 @@ const sampleFromSchema = (schema = {}) => {
             return example;
         }
         if (allOf) {
-            // TODO: We are just assuming it will always be an object for now
-            let obj = {
-                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 } = (0, createRequestSchema_1.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 (0, exports.sampleFromSchema)(obj);
+            return (0, exports.sampleFromSchema)(mergedSchemas);
         }
         if (!type) {
             if (properties) {
@@ -71,6 +67,20 @@ const sampleFromSchema = (schema = {}) => {
         if (type === "object") {
             let obj = {};
             for (let [name, prop] of Object.entries(properties !== null && properties !== void 0 ? 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;
                 }
@@ -93,6 +103,9 @@ const sampleFromSchema = (schema = {}) => {
             }
             return normalizeArray(schema.enum)[0];
         }
+        if (schema.readOnly && schema.readOnly === true) {
+            return undefined;
+        }
         return primitive(schema);
     }
     catch (err) {
@@ -106,7 +119,7 @@ function primitive(schema = {}) {
     if (type === undefined) {
         return;
     }
-    let fn = primitives[type].default;
+    let fn = schema.default ? () => schema.default : primitives[type].default;
     if (format !== undefined) {
         fn = primitives[type][format] || fn;
     }

package/lib/openapi/openapi.d.ts

@@ -6,7 +6,7 @@ interface OpenApiFiles {
     data: OpenApiObject;
 }
 export declare function readOpenapiFiles(openapiPath: string, options: APIOptions): Promise<OpenApiFiles[]>;
-export declare function processOpenapiFiles(files: OpenApiFiles[], sidebarOptions: SidebarOptions): Promise<[ApiMetadata[], TagObject[]]>;
+export declare function processOpenapiFiles(files: OpenApiFiles[], sidebarOptions: SidebarOptions): Promise<[ApiMetadata[], TagObject[][]]>;
 export declare function processOpenapiFile(openapiData: OpenApiObject, sidebarOptions: SidebarOptions): Promise<[ApiMetadata[], TagObject[]]>;
 export declare function getTagDisplayName(tagName: string, tags: TagObject[]): string;
 export {};

package/lib/openapi/openapi.js

@@ -59,7 +59,7 @@ async function createPostmanCollection(openapiData) {
     return await jsonToCollection(data);
 }
 function createItems(openapiData, sidebarOptions) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
     // TODO: Find a better way to handle this
     let items = [];
     const infoId = (0, kebabCase_1.default)(openapiData.info.title);
@@ -100,8 +100,8 @@ function createItems(openapiData, sidebarOptions) {
             securitySchemes: (_b = openapiData.components) === null || _b === void 0 ? void 0 : _b.securitySchemes,
             info: {
                 ...openapiData.info,
-                tags: (_c = openapiData.tags) === null || _c === void 0 ? void 0 : _c.map((tagName) => { var _a; return getTagDisplayName(tagName.name, (_a = openapiData.tags) !== null && _a !== void 0 ? _a : []); }),
-                title: (_d = openapiData.info.title) !== null && _d !== void 0 ? _d : "Introduction",
+                tags: openapiData.tags,
+                title: (_c = openapiData.info.title) !== null && _c !== void 0 ? _c : "Introduction",
                 logo: openapiData.info["x-logo"],
                 darkLogo: openapiData.info["x-dark-logo"],
             },
@@ -111,18 +111,18 @@ function createItems(openapiData, sidebarOptions) {
     for (let [path, pathObject] of Object.entries(openapiData.paths)) {
         const { $ref, description, parameters, servers, summary, ...rest } = pathObject;
         for (let [method, operationObject] of Object.entries({ ...rest })) {
-            const title = (_f = (_e = operationObject.summary) !== null && _e !== void 0 ? _e : operationObject.operationId) !== null && _f !== void 0 ? _f : "Missing summary";
+            const title = (_e = (_d = operationObject.summary) !== null && _d !== void 0 ? _d : operationObject.operationId) !== null && _e !== void 0 ? _e : "Missing summary";
             if (operationObject.description === undefined) {
                 operationObject.description =
-                    (_h = (_g = operationObject.summary) !== null && _g !== void 0 ? _g : operationObject.operationId) !== null && _h !== void 0 ? _h : "";
+                    (_g = (_f = operationObject.summary) !== null && _f !== void 0 ? _f : operationObject.operationId) !== null && _g !== void 0 ? _g : "";
             }
             const baseId = operationObject.operationId
                 ? (0, kebabCase_1.default)(operationObject.operationId)
                 : (0, kebabCase_1.default)(operationObject.summary);
-            const servers = (_k = (_j = operationObject.servers) !== null && _j !== void 0 ? _j : pathObject.servers) !== null && _k !== void 0 ? _k : openapiData.servers;
-            const security = (_l = operationObject.security) !== null && _l !== void 0 ? _l : openapiData.security;
+            const servers = (_j = (_h = operationObject.servers) !== null && _h !== void 0 ? _h : pathObject.servers) !== null && _j !== void 0 ? _j : openapiData.servers;
+            const security = (_k = operationObject.security) !== null && _k !== void 0 ? _k : openapiData.security;
             // Add security schemes so we know how to handle security.
-            const securitySchemes = (_m = openapiData.components) === null || _m === void 0 ? void 0 : _m.securitySchemes;
+            const securitySchemes = (_l = openapiData.components) === null || _l === void 0 ? void 0 : _l.securitySchemes;
             // Make sure schemes are lowercase. See: https://github.com/cloud-annotations/docusaurus-plugin-openapi/issues/79
             if (securitySchemes) {
                 for (let securityScheme of Object.values(securitySchemes)) {
@@ -132,12 +132,12 @@ function createItems(openapiData, sidebarOptions) {
                 }
             }
             let jsonRequestBodyExample;
-            const body = (_p = (_o = operationObject.requestBody) === null || _o === void 0 ? void 0 : _o.content) === null || _p === void 0 ? void 0 : _p["application/json"];
+            const body = (_o = (_m = operationObject.requestBody) === null || _m === void 0 ? void 0 : _m.content) === null || _o === void 0 ? void 0 : _o["application/json"];
             if (body === null || body === void 0 ? void 0 : body.schema) {
                 jsonRequestBodyExample = (0, createExample_1.sampleFromSchema)(body.schema);
             }
             // Handle vendor JSON media types
-            const bodyContent = (_q = operationObject.requestBody) === null || _q === void 0 ? void 0 : _q.content;
+            const bodyContent = (_p = operationObject.requestBody) === null || _p === void 0 ? void 0 : _p.content;
             if (bodyContent) {
                 const firstBodyContentKey = Object.keys(bodyContent)[0];
                 if (firstBodyContentKey.endsWith("+json")) {
@@ -159,7 +159,7 @@ function createItems(openapiData, sidebarOptions) {
                 frontMatter: {},
                 api: {
                     ...defaults,
-                    tags: (_r = operationObject.tags) === null || _r === void 0 ? void 0 : _r.map((tagName) => { var _a; return getTagDisplayName(tagName, (_a = openapiData.tags) !== null && _a !== void 0 ? _a : []); }),
+                    tags: operationObject.tags,
                     method,
                     path,
                     servers,

package/lib/openapi/types.d.ts

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

package/lib/sidebars/index.d.ts

@@ -1,4 +1,4 @@
 import { ProcessedSidebar } from "@docusaurus/plugin-content-docs/src/sidebars/types";
 import { TagObject } from "../openapi/types";
 import type { SidebarOptions, APIOptions, ApiMetadata } from "../types";
-export default function generateSidebarSlice(sidebarOptions: SidebarOptions, options: APIOptions, api: ApiMetadata[], tags: TagObject[], docPath: string): ProcessedSidebar;
+export default function generateSidebarSlice(sidebarOptions: SidebarOptions, options: APIOptions, api: ApiMetadata[], tags: TagObject[][], docPath: string): ProcessedSidebar;

package/lib/sidebars/index.js

@@ -33,9 +33,16 @@ function groupByTags(items, sidebarOptions, options, tags, docPath) {
         };
     });
     // TODO: make sure we only take the first tag
-    const apiTags = (0, uniq_1.default)(apiItems
+    const operationTags = (0, uniq_1.default)(apiItems
         .flatMap((item) => item.api.tags)
         .filter((item) => !!item));
+    // Only include operation tags that are globally defined
+    const apiTags = [];
+    tags.flat().forEach((tag) => {
+        if (operationTags.includes(tag.name)) {
+            apiTags.push(tag.name);
+        }
+    });
     const basePath = docPath
         ? outputDir.split(docPath)[1].replace(/^\/+/g, "")
         : outputDir.slice(outputDir.indexOf("/", 1)).replace(/^\/+/g, "");
@@ -66,11 +73,12 @@ function groupByTags(items, sidebarOptions, options, tags, docPath) {
     }
     const tagged = apiTags
         .map((tag) => {
+        var _a;
         // Map info object to tag
         const taggedInfoObject = intros.find((i) => i.tags ? i.tags.includes(tag) : undefined);
         const tagObject = tags.flat().find((t) => {
             var _a;
-            return (_a = (tag === t.name || tag === t["x-displayName"])) !== null && _a !== void 0 ? _a : {
+            return (_a = tag === t.name) !== null && _a !== void 0 ? _a : {
                 name: tag,
                 description: `${tag} Index`,
             };
@@ -105,7 +113,7 @@ function groupByTags(items, sidebarOptions, options, tags, docPath) {
         }
         return {
             type: "category",
-            label: tag,
+            label: (_a = tagObject === null || tagObject === void 0 ? void 0 : tagObject["x-displayName"]) !== null && _a !== void 0 ? _a : tag,
             link: linkConfig,
             collapsible: sidebarCollapsible,
             collapsed: sidebarCollapsed,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-419",
+  "version": "0.0.0-422",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -67,5 +67,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "c5df2d9c69e2d3881b329ba3586cbc3853ba553b"
+  "gitHead": "14d14041e6826bf3a0c6e851d3d8a2ac464811f4"
 }

package/src/markdown/createRequestBodyDetails.ts

@@ -6,7 +6,7 @@
  * ========================================================================== */
 
 import { MediaTypeObject } from "../openapi/types";
-import { createSchemaDetails } from "./createSchemaDetails";
+import { createRequestSchema } from "./createRequestSchema";
 
 interface Props {
   title: string;
@@ -20,5 +20,5 @@ interface Props {
 }
 
 export function createRequestBodyDetails({ title, body }: Props): any {
-  return createSchemaDetails({ title, body });
+  return createRequestSchema({ title, body });
 }

package/src/markdown/{createSchemaDetails.ts → createRequestSchema.ts}

@@ -17,7 +17,7 @@ const jsonSchemaMergeAllOf = require("json-schema-merge-allof");
 /**
  * Returns a merged representation of allOf array of schemas.
  */
-function mergeAllOf(allOf: SchemaObject[]) {
+export function mergeAllOf(allOf: SchemaObject[]) {
   const mergedSchemas = jsonSchemaMergeAllOf(allOf, {
     resolvers: {
       readOnly: function () {
@@ -534,8 +534,6 @@ function createEdges({
 }: EdgeProps): any {
   const schemaName = getSchemaName(schema);
 
-  // if (name === "id") console.log(name, schema, required);
-
   if (discriminator !== undefined && discriminator.propertyName === name) {
     return createPropertyDiscriminator(
       name,
@@ -578,6 +576,10 @@ function createEdges({
       return createDetailsNode(name, mergedSchemaName, mergedSchemas, required);
     }
 
+    if (mergedSchemas.readOnly && mergedSchemas.readOnly === true) {
+      return undefined;
+    }
+
     return create("SchemaItem", {
       collapsible: false,
       name,
@@ -585,7 +587,7 @@ function createEdges({
       schemaDescription: mergedSchemas.description,
       schemaName: schemaName,
       qualifierMessage: getQualifierMessage(schema),
-      defaultValue: schema.default,
+      defaultValue: mergedSchemas.default,
     });
   }
 
@@ -602,6 +604,10 @@ function createEdges({
     return createDetailsNode(name, schemaName, schema, required);
   }
 
+  if (schema.readOnly && schema.readOnly === true) {
+    return undefined;
+  }
+
   // primitives and array of non-objects
   return create("SchemaItem", {
     collapsible: false,
@@ -694,7 +700,7 @@ interface Props {
   };
 }
 
-export function createSchemaDetails({ title, body, ...rest }: Props) {
+export function createRequestSchema({ title, body, ...rest }: Props) {
   if (
     body === undefined ||
     body.content === undefined ||