docusaurus-theme-openapi-docs 4.3.7 → 4.5.0

package/src/theme/SchemaItem/index.tsx

@@ -65,6 +65,7 @@ export default function SchemaItem(props: Props) {
   let example: string | undefined;
   let nullable;
   let enumDescriptions: [string, string][] = [];
+  let constValue: string | undefined;
 
   if (schema) {
     deprecated = schema.deprecated;
@@ -75,6 +76,7 @@ export default function SchemaItem(props: Props) {
     nullable =
       schema.nullable ||
       (Array.isArray(schema.type) && schema.type.includes("null")); // support JSON Schema nullable
+    constValue = schema.const;
   }
 
   const renderRequired = guard(
@@ -161,6 +163,30 @@ export default function SchemaItem(props: Props) {
     return undefined;
   }
 
+  function renderConstValue() {
+    if (constValue !== undefined) {
+      if (typeof constValue === "string") {
+        return (
+          <div>
+            <strong>Constant value: </strong>
+            <span>
+              <code>{constValue}</code>
+            </span>
+          </div>
+        );
+      }
+      return (
+        <div>
+          <strong>Constant value: </strong>
+          <span>
+            <code>{JSON.stringify(constValue)}</code>
+          </span>
+        </div>
+      );
+    }
+    return undefined;
+  }
+
   const schemaContent = (
     <div>
       <span className="openapi-schema__container">
@@ -184,6 +210,7 @@ export default function SchemaItem(props: Props) {
       {renderSchemaDescription}
       {renderEnumDescriptions}
       {renderQualifierMessage}
+      {renderConstValue()}
       {renderDefaultValue()}
       {renderExample()}
       {collapsibleSchemaContent ?? collapsibleSchemaContent}

package/src/theme/styles.scss

@@ -38,7 +38,7 @@
 @use "./SchemaTabs/SchemaTabs";
 @use "./OperationTabs/OperationTabs";
 /* Code Samples */
-@use "./ResponseSamples/ResponseSamples";
+@use "./CodeSamples/CodeSamples";
 /* Markdown Styling */
 @use "./Markdown/Details/Details";
 

package/src/types.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import type { FrontMatterTag } from "@docusaurus/utils";
+import type { DocFrontMatter as DocusaurusDocFrontMatter } from "@docusaurus/plugin-content-docs";
 import type { JSONSchema4, JSONSchema6, JSONSchema7 } from "json-schema";
 
 export interface ThemeConfig {
@@ -15,10 +15,6 @@ export interface ThemeConfig {
   };
 }
 
-interface Map<T> {
-  [key: string]: T;
-}
-
 export type JSONSchema = JSONSchema4 | JSONSchema6 | JSONSchema7;
 export type SchemaObject = Omit<
   JSONSchema,
@@ -38,7 +34,7 @@ export type SchemaObject = Omit<
   anyOf?: SchemaObject[];
   not?: SchemaObject;
   items?: SchemaObject;
-  properties?: Map<SchemaObject>;
+  properties?: Record<string, SchemaObject>;
   additionalProperties?: boolean | SchemaObject;
 
   // OpenAPI additions
@@ -54,7 +50,7 @@ export type SchemaObject = Omit<
 
 export interface DiscriminatorObject {
   propertyName: string;
-  mapping?: Map<string>;
+  mapping?: Record<string, string>;
 }
 
 export interface XMLObject {
@@ -70,113 +66,7 @@ export interface ExternalDocumentationObject {
   url: string;
 }
 
-export type FileChange = {
-  author?: string;
-  /** Date can be any
-   * [parsable date string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse).
-   */
-  date?: Date | string;
-};
-
-export type DocFrontMatter = {
-  /**
-   * The last part of the doc ID (will be refactored in the future to be the
-   * full ID instead)
-   * @see {@link DocMetadata.id}
-   */
-  id?: string;
-  /**
-   * Will override the default title collected from h1 heading.
-   * @see {@link DocMetadata.title}
-   */
-  title?: string;
-  /**
-   * Front matter tags, unnormalized.
-   * @see {@link DocMetadata.tags}
-   */
-  tags?: FrontMatterTag[];
-  /**
-   * If there isn't a Markdown h1 heading (which, if there is, we don't
-   * remove), this front matter will cause the front matter title to not be
-   * displayed in the doc page.
-   */
-  hide_title?: boolean;
-  /** Hide the TOC on the right. */
-  hide_table_of_contents?: boolean;
-  /** Used in the head meta. */
-  keywords?: string[];
-  /** Used in the head meta. Should use `assets.image` in priority. */
-  image?: string;
-  /**
-   * Will override the default excerpt.
-   * @see {@link DocMetadata.description}
-   */
-  description?: string;
-  /**
-   * Custom slug appended after /<baseUrl>/<routeBasePath>/<versionPath>
-   * @see {@link DocMetadata.slug}
-   */
-  slug?: string;
-  /** Customizes the sidebar label for this doc. Will default to its title. */
-  sidebar_label?: string;
-  /**
-   * Controls the position of a doc inside the generated sidebar slice when
-   * using autogenerated sidebar items.
-   *
-   * @see https://docusaurus.io/docs/sidebar#autogenerated-sidebar-metadata
-   */
-  sidebar_position?: number;
-  /**
-   * Gives the corresponding sidebar label a special class name when using
-   * autogenerated sidebars.
-   */
-  sidebar_class_name?: string;
-  /**
-   * Will be propagated to the final sidebars data structure. Useful if you
-   * have swizzled sidebar-related code or simply querying doc data through
-   * sidebars.
-   */
-  sidebar_custom_props?: { [key: string]: unknown };
-  /**
-   * Changes the sidebar association of the current doc. Use `null` to make
-   * the current doc not associated to any sidebar.
-   */
-  displayed_sidebar?: string | null;
-  /**
-   * Customizes the pagination label for this doc. Will default to the sidebar
-   * label.
-   */
-  pagination_label?: string;
-  /** Overrides the default URL computed for this doc. */
-  custom_edit_url?: string | null;
-  /**
-   * Whether number prefix parsing is disabled on this doc.
-   * @see https://docusaurus.io/docs/sidebar#using-number-prefixes
-   */
-  parse_number_prefixes?: boolean;
-  /**
-   * Minimum TOC heading level. Must be between 2 and 6 and lower or equal to
-   * the max value.
-   */
-  toc_min_heading_level?: number;
-  /** Maximum TOC heading level. Must be between 2 and 6. */
-  toc_max_heading_level?: number;
-  /**
-   * The ID of the documentation you want the "Next" pagination to link to.
-   * Use `null` to disable showing "Next" for this page.
-   * @see {@link DocMetadata.next}
-   */
-  pagination_next?: string | null;
-  /**
-   * The ID of the documentation you want the "Previous" pagination to link
-   * to. Use `null` to disable showing "Previous" for this page.
-   * @see {@link DocMetadata.prev}
-   */
-  pagination_prev?: string | null;
-  /** Should this doc be excluded from production builds? */
-  draft?: boolean;
-  /** Allows overriding the last updated author and/or date. */
-  last_update?: FileChange;
+export interface DocFrontMatter extends DocusaurusDocFrontMatter {
   /** Provides OpenAPI Docs with a reference path to their respective Info Doc */
   info_path?: string;
-};
+}

package/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["./src/index.ts","./src/plugin-content-docs.d.ts","./src/postman-code-generators.d.ts","./src/react-magic-dropzone.d.ts","./src/theme-classic.d.ts","./src/theme-openapi.d.ts","./src/theme-translations.d.ts","./src/types.ts","./src/markdown/createDescription.ts","./src/markdown/schema.ts","./src/markdown/utils.test.ts","./src/markdown/utils.ts","./src/theme/ApiExplorer/buildPostmanRequest.ts","./src/theme/ApiExplorer/index.tsx","./src/theme/ApiExplorer/persistanceMiddleware.ts","./src/theme/ApiExplorer/postman-collection.d.ts","./src/theme/ApiExplorer/react-modal.d.ts","./src/theme/ApiExplorer/storage-utils.ts","./src/theme/ApiExplorer/Accept/index.tsx","./src/theme/ApiExplorer/Accept/slice.ts","./src/theme/ApiExplorer/ApiCodeBlock/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/Container/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/Content/Element.tsx","./src/theme/ApiExplorer/ApiCodeBlock/Content/String.tsx","./src/theme/ApiExplorer/ApiCodeBlock/CopyButton/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/ExitButton/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/ExpandButton/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/Line/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/WordWrapButton/index.tsx","./src/theme/ApiExplorer/Authorization/auth-types.ts","./src/theme/ApiExplorer/Authorization/index.tsx","./src/theme/ApiExplorer/Authorization/slice.ts","./src/theme/ApiExplorer/Body/index.tsx","./src/theme/ApiExplorer/Body/slice.ts","./src/theme/ApiExplorer/CodeSnippets/code-snippets-types.ts","./src/theme/ApiExplorer/CodeSnippets/index.tsx","./src/theme/ApiExplorer/CodeSnippets/languages.ts","./src/theme/ApiExplorer/CodeTabs/index.tsx","./src/theme/ApiExplorer/ContentType/index.tsx","./src/theme/ApiExplorer/ContentType/slice.ts","./src/theme/ApiExplorer/Export/index.tsx","./src/theme/ApiExplorer/FloatingButton/index.tsx","./src/theme/ApiExplorer/FormFileUpload/index.tsx","./src/theme/ApiExplorer/FormItem/index.tsx","./src/theme/ApiExplorer/FormMultiSelect/index.tsx","./src/theme/ApiExplorer/FormSelect/index.tsx","./src/theme/ApiExplorer/FormTextInput/index.tsx","./src/theme/ApiExplorer/LiveEditor/index.tsx","./src/theme/ApiExplorer/MethodEndpoint/index.tsx","./src/theme/ApiExplorer/ParamOptions/index.tsx","./src/theme/ApiExplorer/ParamOptions/slice.ts","./src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamArrayFormItem.tsx","./src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamBooleanFormItem.tsx","./src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamMultiSelectFormItem.tsx","./src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamSelectFormItem.tsx","./src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamTextFormItem.tsx","./src/theme/ApiExplorer/Request/index.tsx","./src/theme/ApiExplorer/Request/makeRequest.ts","./src/theme/ApiExplorer/Response/index.tsx","./src/theme/ApiExplorer/Response/slice.ts","./src/theme/ApiExplorer/SecuritySchemes/index.tsx","./src/theme/ApiExplorer/Server/index.tsx","./src/theme/ApiExplorer/Server/slice.ts","./src/theme/ApiItem/hooks.ts","./src/theme/ApiItem/index.tsx","./src/theme/ApiItem/store.ts","./src/theme/ApiItem/Layout/index.tsx","./src/theme/ApiLogo/index.tsx","./src/theme/ApiTabs/index.tsx","./src/theme/ArrayBrackets/index.tsx","./src/theme/DiscriminatorTabs/index.tsx","./src/theme/MimeTabs/index.tsx","./src/theme/OperationTabs/index.tsx","./src/theme/ParamsDetails/index.tsx","./src/theme/ParamsItem/index.tsx","./src/theme/RequestSchema/index.tsx","./src/theme/ResponseExamples/index.tsx","./src/theme/ResponseHeaders/index.tsx","./src/theme/ResponseSamples/index.tsx","./src/theme/ResponseSchema/index.tsx","./src/theme/Schema/index.tsx","./src/theme/SchemaItem/index.tsx","./src/theme/SchemaTabs/index.tsx","./src/theme/SkeletonLoader/index.tsx","./src/theme/StatusCodes/index.tsx"],"version":"5.7.3"}
+{"root":["./src/index.ts","./src/plugin-content-docs.d.ts","./src/postman-code-generators.d.ts","./src/react-magic-dropzone.d.ts","./src/theme-classic.d.ts","./src/theme-openapi.d.ts","./src/types.ts","./src/markdown/createDescription.ts","./src/markdown/schema.ts","./src/markdown/utils.test.ts","./src/markdown/utils.ts","./src/theme/ApiExplorer/buildPostmanRequest.ts","./src/theme/ApiExplorer/index.tsx","./src/theme/ApiExplorer/persistanceMiddleware.ts","./src/theme/ApiExplorer/storage-utils.ts","./src/theme/ApiExplorer/Accept/index.tsx","./src/theme/ApiExplorer/Accept/slice.ts","./src/theme/ApiExplorer/ApiCodeBlock/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/Container/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/Content/Element.tsx","./src/theme/ApiExplorer/ApiCodeBlock/Content/String.tsx","./src/theme/ApiExplorer/ApiCodeBlock/CopyButton/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/ExitButton/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/ExpandButton/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/Line/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/WordWrapButton/index.tsx","./src/theme/ApiExplorer/Authorization/auth-types.ts","./src/theme/ApiExplorer/Authorization/index.tsx","./src/theme/ApiExplorer/Authorization/slice.ts","./src/theme/ApiExplorer/Body/index.tsx","./src/theme/ApiExplorer/Body/slice.ts","./src/theme/ApiExplorer/CodeSnippets/code-snippets-types.ts","./src/theme/ApiExplorer/CodeSnippets/index.tsx","./src/theme/ApiExplorer/CodeSnippets/languages.ts","./src/theme/ApiExplorer/CodeTabs/index.tsx","./src/theme/ApiExplorer/ContentType/index.tsx","./src/theme/ApiExplorer/ContentType/slice.ts","./src/theme/ApiExplorer/Export/index.tsx","./src/theme/ApiExplorer/FloatingButton/index.tsx","./src/theme/ApiExplorer/FormFileUpload/index.tsx","./src/theme/ApiExplorer/FormItem/index.tsx","./src/theme/ApiExplorer/FormMultiSelect/index.tsx","./src/theme/ApiExplorer/FormSelect/index.tsx","./src/theme/ApiExplorer/FormTextInput/index.tsx","./src/theme/ApiExplorer/LiveEditor/index.tsx","./src/theme/ApiExplorer/MethodEndpoint/index.tsx","./src/theme/ApiExplorer/ParamOptions/index.tsx","./src/theme/ApiExplorer/ParamOptions/slice.ts","./src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamArrayFormItem.tsx","./src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamBooleanFormItem.tsx","./src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamMultiSelectFormItem.tsx","./src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamSelectFormItem.tsx","./src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamTextFormItem.tsx","./src/theme/ApiExplorer/Request/index.tsx","./src/theme/ApiExplorer/Request/makeRequest.ts","./src/theme/ApiExplorer/Response/index.tsx","./src/theme/ApiExplorer/Response/slice.ts","./src/theme/ApiExplorer/SecuritySchemes/index.tsx","./src/theme/ApiExplorer/Server/index.tsx","./src/theme/ApiExplorer/Server/slice.ts","./src/theme/ApiItem/hooks.ts","./src/theme/ApiItem/index.tsx","./src/theme/ApiItem/store.ts","./src/theme/ApiItem/Layout/index.tsx","./src/theme/ApiLogo/index.tsx","./src/theme/ApiTabs/index.tsx","./src/theme/ArrayBrackets/index.tsx","./src/theme/CodeSamples/index.tsx","./src/theme/DiscriminatorTabs/index.tsx","./src/theme/MimeTabs/index.tsx","./src/theme/OperationTabs/index.tsx","./src/theme/ParamsDetails/index.tsx","./src/theme/ParamsItem/index.tsx","./src/theme/RequestSchema/index.tsx","./src/theme/ResponseExamples/index.tsx","./src/theme/ResponseHeaders/index.tsx","./src/theme/ResponseSchema/index.tsx","./src/theme/Schema/index.tsx","./src/theme/SchemaItem/index.tsx","./src/theme/SchemaTabs/index.tsx","./src/theme/SkeletonLoader/index.tsx","./src/theme/StatusCodes/index.tsx"],"version":"5.8.3"}

package/lib/theme/ResponseSamples/_ResponseSamples.scss

@@ -1,3 +0,0 @@
-.openapi-code__response-samples-container {
-  margin-top: 2rem;
-}

package/lib/theme/ResponseSamples/index.d.ts

@@ -1,8 +0,0 @@
-import React from "react";
-import { Language } from "prism-react-renderer";
-export interface Props {
-    readonly responseExample: string;
-    readonly language: Language;
-}
-declare function ResponseSamples({ responseExample, language, }: Props): React.JSX.Element;
-export default ResponseSamples;

package/src/theme/ApiExplorer/postman-collection.d.ts

@@ -1,10 +0,0 @@
-/* ============================================================================
- * 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.
- * ========================================================================== */
-
-declare module "postman-collection" {
-  export = Request.sdk;
-}

package/src/theme/ApiExplorer/react-modal.d.ts

@@ -1,8 +0,0 @@
-/* ============================================================================
- * 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.
- * ========================================================================== */
-
-declare module "react-modal";

package/src/theme/ResponseSamples/_ResponseSamples.scss

@@ -1,3 +0,0 @@
-.openapi-code__response-samples-container {
-  margin-top: 2rem;
-}

package/src/theme-translations.d.ts

@@ -1,9 +0,0 @@
-/* ============================================================================
- * 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.
- * ========================================================================== */
-
-// TODO: Remove this when https://github.com/facebook/docusaurus/issues/6087 is resolved.
-declare module "@docusaurus/theme-translations";