docusaurus-theme-openapi-docs 1.4.2 → 1.4.4

package/lib/theme/styles.css

@@ -0,0 +1,428 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+
+:root {
+  --openapi-required: var(--ifm-color-danger);
+  --openapi-code-blue: var(--ifm-color-info);
+  --openapi-code-red: var(--ifm-color-danger);
+  --openapi-code-orange: var(--ifm-color-warning);
+  --openapi-code-green: var(--ifm-color-success);
+  --openapi-card-background-color: var(--ifm-color-gray-100);
+  --openapi-card-border-radius: var(--ifm-pre-border-radius);
+  --openapi-input-border: var(--ifm-color-primary);
+}
+
+[data-theme="dark"] {
+  --openapi-card-background-color: var(--ifm-color-gray-900) !important;
+}
+
+.docs-wrapper {
+  height: 100%;
+}
+
+.docItemContainer header + *,
+.docItemContainer article > *:first-child {
+  margin-top: 0;
+}
+
+@media (min-width: 997px) {
+  .docItemCol {
+    max-width: 75% !important;
+  }
+
+  /* Prevent hydration FOUC, as the mobile TOC needs to be server-rendered */
+  .tocMobile {
+    display: none;
+  }
+}
+
+/* Begin OpenAPI theme styles */
+[data-theme="dark"] {
+  --openapi-card-background-color: var(--ifm-color-gray-900) !important;
+}
+
+.apiItemContainer article > *:first-child,
+.apiItemContainer header + * {
+  margin-top: 0;
+}
+
+.theme-api-markdown div[class^="collapsibleContent"] {
+  margin-top: 0 !important;
+  padding-left: 2px;
+}
+
+/* Main details */
+
+.theme-api-markdown details {
+  margin: unset;
+  max-width: 600px;
+  background-color: transparent;
+  color: var(--ifm-font-color-base);
+  padding: unset;
+  border: unset !important;
+  box-shadow: unset !important;
+  --docusaurus-details-decoration-color: var(--ifm-font-color-base);
+}
+
+.theme-api-markdown details ul {
+  padding-left: 0;
+  font-size: 14px;
+}
+
+.theme-api-markdown details li {
+  list-style: none;
+  padding-bottom: 5px;
+  padding-top: 5px;
+}
+
+.theme-api-markdown details > div > div {
+  padding-top: unset !important;
+  border-top: unset !important;
+}
+
+.theme-api-markdown details p {
+  margin-bottom: 0;
+}
+
+/* Demo panel details */
+
+.theme-api-markdown .details__demo-panel {
+  margin-bottom: 1rem;
+  background: var(--openapi-card-background-color);
+  border-radius: var(--openapi-card-border-radius);
+}
+
+.theme-api-markdown .details__demo-panel > summary {
+  padding-left: 1rem;
+  padding-top: 1rem;
+  cursor: pointer;
+}
+
+.theme-api-markdown .details__demo-panel > div > div > pre {
+  border-top-left-radius: 0;
+  border-top-right-radius: 0;
+}
+
+.theme-api-markdown .details__demo-panel > summary::marker {
+  display: none;
+  content: "";
+}
+
+.theme-api-markdown .details__demo-panel > summary::-webkit-details-marker {
+  display: none;
+  content: "";
+}
+
+.theme-api-markdown .details__demo-panel > pre {
+  margin-bottom: 0;
+  padding-top: 0;
+}
+
+/* Demo panel request */
+
+.theme-api-markdown .details__request-summary {
+  display: flex;
+  justify-content: space-between;
+  align-items: center;
+}
+
+.theme-api-markdown .details__request-summary > button {
+  margin-bottom: 1rem;
+  margin-right: 1rem;
+}
+
+/* Demo panel response */
+
+.theme-api-markdown .details__response-summary {
+  display: flex;
+  justify-content: space-between;
+  align-items: center;
+}
+
+.theme-api-markdown .details__response-summary > button {
+  margin-bottom: 1rem;
+  margin-right: 1rem;
+}
+
+/* Code block */
+
+.theme-api-markdown code {
+  max-width: 600px;
+  max-height: 500px;
+  overflow: auto;
+}
+
+/* Version button */
+
+.version-button div {
+  display: block;
+}
+
+.version-button div > button > span::after {
+  border-color: currentcolor transparent;
+  border-style: solid;
+  border-width: 0.4em 0.4em 0;
+  content: "";
+  margin-left: 0.3em;
+  position: relative;
+  transform: translateY(-50%);
+  display: inline-block;
+  font-size: 0.8rem;
+  top: 1px;
+}
+
+/* Params, Schema and Discriminator Items */
+
+[class^="paramsItem"]::before,
+[class^="schemaItem"]::before {
+  position: absolute;
+  top: 10px;
+  left: 0;
+  width: 0.7rem;
+  /* width of horizontal line */
+  height: 0.5rem;
+  /* vertical position of line */
+  vertical-align: top;
+  border-bottom: thin solid var(--ifm-color-gray-500);
+  content: "";
+  display: inline-block;
+}
+
+.schemaItem {
+  list-style: none;
+  position: relative;
+  margin: 0 !important;
+  padding: 5px 0 5px 1rem;
+  border-left: thin solid var(--ifm-color-gray-500) !important;
+}
+
+.discriminatorItem {
+  list-style: none;
+  position: relative;
+  margin: 0 !important;
+  padding: 5px 0 5px 0 !important;
+  border-left: thin solid var(--ifm-color-gray-500) !important;
+}
+
+.discriminatorTabsContainer {
+  padding-left: 0 !important;
+}
+
+.schemaItem:hover {
+  background-color: var(--ifm-menu-color-background-active);
+}
+
+.schemaItem:focus {
+  background-color: var(--ifm-menu-color-background-active);
+}
+
+.paramsItem:hover {
+  background-color: var(--ifm-menu-color-background-active);
+}
+
+.paramsItem:focus {
+  background-color: var(--ifm-menu-color-background-active);
+}
+
+/* CodeTabs */
+
+.code__tab--python::after {
+  content: "";
+  width: 28px;
+  height: 28px;
+  background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/python/python-original.svg");
+  margin-block: auto;
+}
+
+.code__tab--python {
+  color: var(--ifm-color-success);
+  padding-left: 1.4rem;
+  padding-right: 1.4rem;
+}
+
+.code__tab--python.tabs__item--active {
+  border-bottom-color: var(--ifm-color-success);
+  background-color: var(--ifm-color-emphasis-100);
+}
+
+.language-python {
+  max-height: 500px;
+  overflow: auto;
+}
+
+.code__tab--go::after {
+  content: "";
+  width: 28px;
+  height: 28px;
+  background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/go/go-original-wordmark.svg");
+  margin-block: auto;
+}
+
+.code__tab--go {
+  color: var(--ifm-color-info);
+  padding-left: 1.4rem;
+  padding-right: 1.4rem;
+}
+
+.code__tab--go.tabs__item--active {
+  border-bottom-color: var(--ifm-color-info);
+  background-color: var(--ifm-color-emphasis-100);
+}
+
+.language-go {
+  max-height: 500px;
+  overflow: auto;
+}
+
+.code__tab--javascript::after {
+  content: "";
+  width: 28px;
+  height: 28px;
+  background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/javascript/javascript-original.svg");
+  margin-block: auto;
+}
+
+.code__tab--javascript {
+  color: var(--ifm-color-warning);
+  padding-left: 1.4rem;
+  padding-right: 1.4rem;
+}
+
+.code__tab--javascript.tabs__item--active {
+  border-bottom-color: var(--ifm-color-warning);
+  background-color: var(--ifm-color-emphasis-100);
+}
+
+.language-javascript {
+  max-height: 500px;
+  overflow: auto;
+}
+
+.code__tab--bash::after {
+  content: "";
+  width: 28px;
+  height: 28px;
+  background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/linux/linux-original.svg");
+  margin-block: auto;
+}
+
+.code__tab--bash {
+  color: var(--ifm-color-danger);
+  padding-left: 1.4rem;
+  padding-right: 1.4rem;
+}
+
+.code__tab--bash.tabs__item--active {
+  border-bottom-color: var(--ifm-color-danger);
+  background-color: var(--ifm-color-emphasis-100);
+}
+
+.language-bash {
+  max-height: 500px;
+  overflow: auto;
+}
+
+.code__tab--ruby::after {
+  content: "";
+  width: 28px;
+  height: 28px;
+  background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/ruby/ruby-plain.svg");
+  margin-block: auto;
+}
+
+.code__tab--ruby {
+  color: var(--ifm-color-danger);
+  padding-left: 1.4rem;
+  padding-right: 1.4rem;
+}
+
+.code__tab--ruby.tabs__item--active {
+  border-bottom-color: var(--ifm-color-danger);
+  background-color: var(--ifm-color-emphasis-100);
+}
+
+.language-ruby {
+  max-height: 500px;
+  overflow: auto;
+}
+
+.code__tab--csharp::after {
+  content: "";
+  width: 28px;
+  height: 28px;
+  background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/csharp/csharp-original.svg");
+  margin-block: auto;
+}
+
+.code__tab--csharp {
+  color: var(--ifm-color-gray-500);
+  padding-left: 1.4rem;
+  padding-right: 1.4rem;
+}
+
+.code__tab--csharp.tabs__item--active {
+  border-bottom-color: var(--ifm-color-gray-500);
+  background-color: var(--ifm-color-emphasis-100);
+}
+
+.language-csharp {
+  max-height: 500px;
+  overflow: auto;
+}
+
+.code__tab--nodejs::after {
+  content: "";
+  width: 28px;
+  height: 28px;
+  background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/nodejs/nodejs-original.svg");
+  margin-block: auto;
+}
+
+.code__tab--nodejs {
+  color: var(--ifm-color-success);
+  padding-left: 1.4rem;
+  padding-right: 1.4rem;
+}
+
+.code__tab--nodejs.tabs__item--active {
+  border-bottom-color: var(--ifm-color-success);
+  background-color: var(--ifm-color-emphasis-100);
+}
+
+.language-nodejs {
+  max-height: 500px;
+  overflow: auto;
+}
+
+.code__tab--php::after {
+  content: "";
+  width: 28px;
+  height: 28px;
+  background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/php/php-original.svg");
+  margin-block: auto;
+}
+
+.code__tab--php {
+  color: var(--ifm-color-gray-500);
+  padding-left: 1.4rem;
+  padding-right: 1.4rem;
+}
+
+.code__tab--php.tabs__item--active {
+  border-bottom-color: var(--ifm-color-gray-500);
+  background-color: var(--ifm-color-emphasis-100);
+}
+
+.language-php {
+  max-height: 500px;
+  overflow: auto;
+}
+
+/* Prism code styles */
+.prism-code.language-json {
+  white-space: pre !important;
+}

package/lib/theme-classic.d.ts

@@ -6,3 +6,8 @@
  * ========================================================================== */
 
 /// <reference types="@docusaurus/theme-classic" />
+
+declare module "@docusaurus/theme-common/internal" {
+  function useDoc(): any;
+  export const { useDoc };
+}

package/lib-next/index.js

@@ -4,20 +4,22 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+
 import path from "path";
 import { ProvidePlugin } from "webpack";
 export default function docusaurusThemeOpenAPI() {
   return {
     name: "docusaurus-theme-openapi",
-
+    getClientModules() {
+      const modules = [require.resolve("./theme/styles.css")];
+      return modules;
+    },
     getThemePath() {
       return path.join(__dirname, "..", "lib-next", "theme");
     },
-
     getTypeScriptThemePath() {
       return path.resolve(__dirname, "..", "src", "theme");
     },
-
     configureWebpack() {
       return {
         plugins: [

package/lib-next/markdown/createDescription.js

@@ -4,10 +4,10 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+
 export function createDescription(description) {
   if (!description) {
     return "";
   }
-
   return `\n\n${description}\n\n`;
 }

package/lib-next/markdown/schema.js

@@ -4,11 +4,11 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+
 function prettyName(schema, circular) {
   if (schema.format) {
     return schema.format;
   }
-
   if (schema.allOf) {
     if (typeof schema.allOf[0] === "string") {
       // @ts-ignore
@@ -16,34 +16,30 @@ function prettyName(schema, circular) {
         return schema.allOf[0];
       }
     }
-
     return "object";
   }
-
   if (schema.oneOf) {
     return "object";
   }
-
   if (schema.anyOf) {
     return "object";
   }
-
   if (schema.type === "object") {
-    return schema.xml?.name ?? schema.type; // return schema.type;
+    return schema.xml?.name ?? schema.type;
+    // return schema.type;
   }
 
   if (schema.type === "array") {
-    return schema.xml?.name ?? schema.type; // return schema.type;
+    return schema.xml?.name ?? schema.type;
+    // return schema.type;
   }
 
   return schema.title ?? schema.type;
 }
-
 export function getSchemaName(schema, circular) {
   if (schema.items) {
     return prettyName(schema.items, circular) + "[]";
   }
-
   return prettyName(schema, circular) ?? "";
 }
 export function getQualifierMessage(schema) {
@@ -55,7 +51,6 @@ export function getQualifierMessage(schema) {
   if (!schema) {
     return undefined;
   }
-
   if (
     schema.items &&
     schema.minItems === undefined &&
@@ -63,10 +58,8 @@ export function getQualifierMessage(schema) {
   ) {
     return getQualifierMessage(schema.items);
   }
-
   let message = "**Possible values:** ";
   let qualifierGroups = [];
-
   if (schema.items && schema.items.enum) {
     if (schema.items.enum) {
       qualifierGroups.push(
@@ -74,39 +67,30 @@ export function getQualifierMessage(schema) {
       );
     }
   }
-
   if (schema.minLength || schema.maxLength) {
     let lengthQualifier = "";
     let minLength;
     let maxLength;
-
     if (schema.minLength && schema.minLength > 1) {
       minLength = `\`>= ${schema.minLength} characters\``;
     }
-
     if (schema.minLength && schema.minLength === 1) {
       minLength = `\`non-empty\``;
     }
-
     if (schema.maxLength) {
       maxLength = `\`<= ${schema.maxLength} characters\``;
     }
-
     if (minLength && !maxLength) {
       lengthQualifier += minLength;
     }
-
     if (maxLength && !minLength) {
       lengthQualifier += maxLength;
     }
-
     if (minLength && maxLength) {
       lengthQualifier += `${minLength} and ${maxLength}`;
     }
-
     qualifierGroups.push(lengthQualifier);
   }
-
   if (
     schema.minimum ||
     schema.maximum ||
@@ -116,7 +100,6 @@ export function getQualifierMessage(schema) {
     let minmaxQualifier = "";
     let minimum;
     let maximum;
-
     if (typeof schema.exclusiveMinimum === "number") {
       minimum = `\`> ${schema.exclusiveMinimum}\``;
     } else if (schema.minimum && !schema.exclusiveMinimum) {
@@ -124,7 +107,6 @@ export function getQualifierMessage(schema) {
     } else if (schema.minimum && schema.exclusiveMinimum === true) {
       minimum = `\`> ${schema.minimum}\``;
     }
-
     if (typeof schema.exclusiveMaximum === "number") {
       maximum = `\`< ${schema.exclusiveMaximum}\``;
     } else if (schema.maximum && !schema.exclusiveMaximum) {
@@ -132,50 +114,40 @@ export function getQualifierMessage(schema) {
     } else if (schema.maximum && schema.exclusiveMaximum === true) {
       maximum = `\`< ${schema.maximum}\``;
     }
-
     if (minimum && !maximum) {
       minmaxQualifier += minimum;
     }
-
     if (maximum && !minimum) {
       minmaxQualifier += maximum;
     }
-
     if (minimum && maximum) {
       minmaxQualifier += `${minimum} and ${maximum}`;
     }
-
     qualifierGroups.push(minmaxQualifier);
   }
-
   if (schema.pattern) {
     qualifierGroups.push(
       `Value must match regular expression \`${schema.pattern}\``
     );
-  } // Check if discriminator mapping
+  }
 
+  // Check if discriminator mapping
   const discriminator = schema;
-
   if (discriminator.mapping) {
     const values = Object.keys(discriminator.mapping);
     qualifierGroups.push(`[${values.map((e) => `\`${e}\``).join(", ")}]`);
   }
-
   if (schema.enum) {
     qualifierGroups.push(`[${schema.enum.map((e) => `\`${e}\``).join(", ")}]`);
   }
-
   if (schema.minItems) {
     qualifierGroups.push(`\`>= ${schema.minItems}\``);
   }
-
   if (schema.maxItems) {
     qualifierGroups.push(`\`<= ${schema.maxItems}\``);
   }
-
   if (qualifierGroups.length === 0) {
     return undefined;
   }
-
   return message + qualifierGroups.join(", ");
 }

package/lib-next/markdown/utils.js

@@ -4,14 +4,13 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+
 export function create(tag, props) {
   const { children, ...rest } = props;
   let propString = "";
-
   for (const [key, value] of Object.entries(rest)) {
     propString += ` ${key}={${JSON.stringify(value)}}`;
   }
-
   return `<${tag}${propString}>${render(children)}</${tag}>`;
 }
 export function guard(value, cb) {
@@ -19,13 +18,11 @@ export function guard(value, cb) {
     const children = cb(value);
     return render(children);
   }
-
   return "";
 }
 export function render(children) {
   if (Array.isArray(children)) {
     return children.filter((c) => c !== undefined).join("");
   }
-
   return children ?? "";
 }

package/lib-next/theme/ApiDemoPanel/Accept/index.js

@@ -4,21 +4,19 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+
 import React from "react";
 import { useTypedDispatch, useTypedSelector } from "../../ApiItem/hooks";
 import FormItem from "./../FormItem";
 import FormSelect from "./../FormSelect";
 import { setAccept } from "./slice";
-
 function Accept() {
   const value = useTypedSelector((state) => state.accept.value);
   const options = useTypedSelector((state) => state.accept.options);
   const dispatch = useTypedDispatch();
-
   if (options.length <= 1) {
     return null;
   }
-
   return (
     <FormItem label="Accept">
       <FormSelect
@@ -29,5 +27,4 @@ function Accept() {
     </FormItem>
   );
 }
-
 export default Accept;