docusaurus-theme-openapi-docs 1.4.3 → 1.4.5

package/src/theme/styles.css

@@ -0,0 +1,429 @@
+/* ============================================================================
+ * 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);
+  --openapi-input-background: var(--openapi-card-background-color);
+}
+
+[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/src/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/theme/ApiDemoPanel/styles.module.css

@@ -1,44 +0,0 @@
-:root {
-  /* VS Dark mode */
-  --openapi-monaco-background-color-dark: var(--ifm-color-gray-900);
-  --openapi-code-bright-dark: var(--ifm-color-secondary-lighter);
-  --openapi-code-dim-dark: var(--ifm-color-secondary-dark);
-  --openapi-code-blue-dark: var(--ifm-color-primary);
-  --openapi-code-green-dark: var(--ifm-color-success);
-  --openapi-code-select-dark: var(--ifm-color-secondary-lightest);
-
-  /* VS Light mode */
-  --openapi-monaco-background-color-light: var(--ifm-color-gray-100);
-  --openapi-code-bright-light: var(--ifm-color-black);
-  --openapi-code-dim-light: var(--ifm-color-black);
-  --openapi-code-blue-light: var(--ifm-color-primary);
-  --openapi-code-green-light: var(--ifm-color-success);
-  --openapi-code-select-light: var(--ifm-color-secondary-light);
-
-  --openapi-card-background-color: var(--ifm-color-gray-100);
-  --openapi-card-border-radius: var(--ifm-pre-border-radius);
-  --openapi-monaco-border-color: var(--openapi-card-background-color);
-  --openapi-input-border: var(--ifm-color-primary);
-}
-
-[data-theme="dark"] {
-  --openapi-card-background-color: var(--ifm-color-gray-900) !important;
-}
-
-.optionsPanel:empty {
-  display: none;
-}
-
-.optionsPanel {
-  background: var(--openapi-card-background-color);
-  border-radius: var(--openapi-card-border-radius);
-  color: var(--ifm-pre-color);
-  line-height: var(--ifm-pre-line-height);
-  margin-bottom: var(--ifm-spacing-vertical);
-  margin-top: 0;
-  overflow: auto;
-  padding: var(--ifm-pre-padding);
-
-  /* hack for view calculation when monaco is hidden */
-  position: relative;
-}

package/lib/theme/ApiItem/Content/index.js

@@ -1,65 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = DocItemContent;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-var _internal = require("@docusaurus/theme-common/internal");
-
-var _Heading = _interopRequireDefault(require("@theme/Heading"));
-
-var _MDXContent = _interopRequireDefault(require("@theme/MDXContent"));
-
-var _clsx = _interopRequireDefault(require("clsx"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/* ============================================================================
- * 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.
- * ========================================================================== */
-// @ts-ignore
-
-/**
- Title can be declared inside md content or declared through
- front matter and added manually. To make both cases consistent,
- the added title is added under the same div.markdown block
- See https://github.com/facebook/docusaurus/pull/4882#issuecomment-853021120
-
- We render a "synthetic title" if:
- - user doesn't ask to hide it with front matter
- - the markdown content does not already contain a top-level h1 heading
-*/
-function useSyntheticTitle() {
-  const {
-    metadata,
-    frontMatter,
-    contentTitle
-  } = (0, _internal.useDoc)();
-  const shouldRender = !frontMatter.hide_title && typeof contentTitle === "undefined";
-
-  if (!shouldRender) {
-    return null;
-  }
-
-  return metadata.title;
-}
-
-function DocItemContent({
-  children
-}) {
-  const syntheticTitle = useSyntheticTitle();
-  return <div className={(0, _clsx.default)(_themeCommon.ThemeClassNames.docs.docMarkdown, "theme-api-markdown", "markdown")}>
-      {syntheticTitle && <header>
-          <_Heading.default as="h1">{syntheticTitle}</_Heading.default>
-        </header>}
-      <_MDXContent.default>{children}</_MDXContent.default>
-    </div>;
-}

package/lib/theme/ApiItem/Footer/index.js

@@ -1,78 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = DocItemFooter;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-var _internal = require("@docusaurus/theme-common/internal");
-
-var _EditThisPage = _interopRequireDefault(require("@theme/EditThisPage"));
-
-var _LastUpdated = _interopRequireDefault(require("@theme/LastUpdated"));
-
-var _TagsListInline = _interopRequireDefault(require("@theme/TagsListInline"));
-
-var _clsx = _interopRequireDefault(require("clsx"));
-
-var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/* ============================================================================
- * 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.
- * ========================================================================== */
-function TagsRow(props) {
-  return <div className={(0, _clsx.default)(_themeCommon.ThemeClassNames.docs.docFooterTagsRow, "row margin-bottom--sm")}>
-      <div className="col">
-        <_TagsListInline.default {...props} />
-      </div>
-    </div>;
-}
-
-function EditMetaRow({
-  editUrl,
-  lastUpdatedAt,
-  lastUpdatedBy,
-  formattedLastUpdatedAt
-}) {
-  return <div className={(0, _clsx.default)(_themeCommon.ThemeClassNames.docs.docFooterEditMetaRow, "row")}>
-      <div className="col">{editUrl && <_EditThisPage.default editUrl={editUrl} />}</div>
-
-      <div className={(0, _clsx.default)("col", _stylesModule.default.lastUpdated)}>
-        {(lastUpdatedAt || lastUpdatedBy) && <_LastUpdated.default lastUpdatedAt={lastUpdatedAt} formattedLastUpdatedAt={formattedLastUpdatedAt} lastUpdatedBy={lastUpdatedBy} />}
-      </div>
-    </div>;
-}
-
-function DocItemFooter() {
-  const {
-    metadata
-  } = (0, _internal.useDoc)();
-  const {
-    editUrl,
-    lastUpdatedAt,
-    formattedLastUpdatedAt,
-    lastUpdatedBy,
-    tags
-  } = metadata;
-  const canDisplayTagsRow = tags.length > 0;
-  const canDisplayEditMetaRow = !!(editUrl || lastUpdatedAt || lastUpdatedBy);
-  const canDisplayFooter = canDisplayTagsRow || canDisplayEditMetaRow;
-
-  if (!canDisplayFooter) {
-    return null;
-  }
-
-  return <footer className={(0, _clsx.default)(_themeCommon.ThemeClassNames.docs.docFooter, "docusaurus-mt-lg")}>
-      {canDisplayTagsRow && <TagsRow tags={tags} />}
-      {canDisplayEditMetaRow && <EditMetaRow editUrl={editUrl} lastUpdatedAt={lastUpdatedAt} lastUpdatedBy={lastUpdatedBy} formattedLastUpdatedAt={formattedLastUpdatedAt} />}
-    </footer>;
-}

package/lib/theme/ApiItem/Footer/styles.module.css

@@ -1,18 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-.lastUpdated {
-  margin-top: 0.2rem;
-  font-style: italic;
-  font-size: smaller;
-}
-
-@media (min-width: 997px) {
-  .lastUpdated {
-    text-align: right;
-  }
-}

package/lib/theme/ApiItem/Metadata/index.js

@@ -1,32 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = DocItemMetadata;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-var _internal = require("@docusaurus/theme-common/internal");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/* ============================================================================
- * 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.
- * ========================================================================== */
-// @ts-ignore
-function DocItemMetadata() {
-  var _assets$image;
-
-  const {
-    metadata,
-    frontMatter,
-    assets
-  } = (0, _internal.useDoc)();
-  return <_themeCommon.PageMetadata title={metadata.title} description={metadata.description} keywords={frontMatter.keywords} image={(_assets$image = assets.image) !== null && _assets$image !== void 0 ? _assets$image : frontMatter.image} />;
-}

package/lib/theme/ApiItem/Paginator/index.js

@@ -1,33 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = DocItemPaginator;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _internal = require("@docusaurus/theme-common/internal");
-
-var _DocPaginator = _interopRequireDefault(require("@theme/DocPaginator"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/* ============================================================================
- * 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.
- * ========================================================================== */
-// @ts-ignore
-
-/**
- * This extra component is needed, because <DocPaginator> should remain generic.
- * DocPaginator is used in non-docs contexts too: generated-index pages...
- */
-function DocItemPaginator() {
-  const {
-    metadata
-  } = (0, _internal.useDoc)();
-  return <_DocPaginator.default previous={metadata.previous} next={metadata.next} />;
-}