index.ts

/* ============================================================================
 * Copyright (c) Palo Alto Networks
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 * ========================================================================== */

import { createAuthentication } from "./createAuthentication";
import { createContactInfo } from "./createContactInfo";
// import { createDeprecationNotice } from "./createDeprecationNotice";
import { createDescription } from "./createDescription";
import { createDownload } from "./createDownload";
import { createEndpoint } from "./createEndpoint";
import { createLicense } from "./createLicense";
import { createLogo } from "./createLogo";
import { createParamsDetails } from "./createParamsDetails";
// import { createRequestBodyDetails } from "./createRequestBodyDetails";
import { createRequestSchema } from "./createRequestSchema";
import { createStatusCodes } from "./createStatusCodes";
import { createTermsOfService } from "./createTermsOfService";
// import { createVendorExtensions } from "./createVendorExtensions";
import { createVersionBadge } from "./createVersionBadge";
import { greaterThan, lessThan, render } from "./utils";
import {
  ContactObject,
  LicenseObject,
  // MediaTypeObject,
  SecuritySchemeObject,
} from "../openapi/types";
import { ApiPageMetadata, InfoPageMetadata, TagPageMetadata } from "../types";

// interface Props {
//   title: string;
//   body: {
//     content?: {
//       [key: string]: MediaTypeObject;
//     };
//     description?: string;
//     required?: boolean;
//   };
// }

export function createApiPageMD({
  // title,
  api: {
    // deprecated,
    // "x-deprecated-description": deprecatedDescription,
    description,
    // extensions,
    parameters,
    requestBody,
    responses,
    path,
    method,
  },
}: // frontMatter,
ApiPageMetadata) {
  // return render([
  //   `import ApiTabs from "@theme/ApiTabs";\n`,
  //   `import MimeTabs from "@theme/MimeTabs";\n`,
  //   `import ParamsItem from "@theme/ParamsItem";\n`,
  //   `import ResponseSamples from "@theme/ResponseSamples";\n`,
  //   `import SchemaItem from "@theme/SchemaItem";\n`,
  //   `import SchemaTabs from "@theme/SchemaTabs";\n`,
  //   `import DiscriminatorTabs from "@theme/DiscriminatorTabs";\n`,
  //   `import SchemaTable from "@theme/SchemaTable";\n`,
  //   `import RequestBodyDetails from "@theme/RequestBodyDetails";\n`,
  //   `import TabItem from "@theme/TabItem";\n\n`,
  //   `## ${title.replace(lessThan, "<").replace(greaterThan, ">")}\n\n`,
  //   frontMatter.show_extensions && createVendorExtensions(extensions),
  //   createDeprecationNotice({ deprecated, description: deprecatedDescription }),
  //   createDescription(description),
  //   createParamsDetails({ parameters, type: "path" }),
  //   createParamsDetails({ parameters, type: "query" }),
  //   createParamsDetails({ parameters, type: "header" }),
  //   createParamsDetails({ parameters, type: "cookie" }),
  //   createRequestBodyDetails({
  //     title: "Request Body",
  //     body: requestBody,
  //   } as Props),
  //   createStatusCodes({ responses }),
  // ]);

  return render([
    `import Layout from "@theme/Layout";\n`,
    `import Endpoint from "@theme/Endpoint";\n`,
    `import ParamDetails from "@theme/ParamDetails";\n`,
    `import RequestBodyDetailsBase from "@theme/RequestBodyDetails/base";\n`,
    `import RequestBodyDetails from "@theme/RequestBodyDetails";\n`,
    `import Table from "@theme/SchemaTable";\n`,
    `import MimeTabs from "@theme/MimeTabs";\n`,
    `import ApiTabs from "@theme/ApiTabs";\n`,
    `import SchemaTabs from "@theme/SchemaTabs";\n`,
    `import ResponseSamples from "@theme/ResponseSamples";\n`,
    `import TabItem from "@theme/TabItem";\n`,
    // create("Layout", {
    //   children: [
    description ? `\n\n${description.trim()}\n\n` : "",
    createEndpoint(method, path),
    createParamsDetails({ parameters, type: "path" }),
    createParamsDetails({ parameters, type: "query" }),
    createParamsDetails({ parameters, type: "header" }),
    createParamsDetails({ parameters, type: "cookie" }),
    requestBody
      ? createRequestSchema({ body: requestBody, title: "Request body" })
      : "",
    createStatusCodes({ responses }),
    //   ],
    // }
    // ),
  ]);
}

export function createInfoPageMD({
  info: {
    title,
    version,
    description,
    contact,
    license,
    termsOfService,
    logo,
    darkLogo,
  },
  securitySchemes,
  downloadUrl,
}: InfoPageMetadata) {
  return render([
    `import ApiLogo from "@theme/ApiLogo";\n`,
    `import SchemaTabs from "@theme/SchemaTabs";\n`,
    `import TabItem from "@theme/TabItem";\n`,
    `import Export from "@theme/ApiExplorer/Export";\n\n`,

    createVersionBadge(version),
    createDownload(downloadUrl),
    `# ${title.replace(lessThan, "<").replace(greaterThan, ">")}\n\n`,
    createLogo(logo, darkLogo),
    createDescription(description),
    createAuthentication(securitySchemes as unknown as SecuritySchemeObject),
    createContactInfo(contact as ContactObject),
    createTermsOfService(termsOfService),
    createLicense(license as LicenseObject),
  ]);
}

export function createTagPageMD({ tag: { description } }: TagPageMetadata) {
  return render([createDescription(description)]);
}