From 5b21bf49a9580bfc8571bf350541f3570d96fffd Mon Sep 17 00:00:00 2001 From: Steven Serrata Date: Thu, 16 Mar 2023 09:58:37 -0400 Subject: [PATCH 01/14] Switch to BASH icon --- packages/docusaurus-theme-openapi-docs/src/theme/styles.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/styles.css b/packages/docusaurus-theme-openapi-docs/src/theme/styles.css index d552d2ff3..3b2d2688a 100644 --- a/packages/docusaurus-theme-openapi-docs/src/theme/styles.css +++ b/packages/docusaurus-theme-openapi-docs/src/theme/styles.css @@ -319,7 +319,7 @@ content: ""; width: 28px; height: 28px; - background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/linux/linux-original.svg"); + background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/bash/bash-original.svg"); margin-block: auto; } From d507880a50c5591f87dea770e26657e92b9f80bd Mon Sep 17 00:00:00 2001 From: Steven Serrata Date: Thu, 16 Mar 2023 09:59:01 -0400 Subject: [PATCH 02/14] Ugprade to postman-code-generators 1.5.0-patch.1 --- packages/docusaurus-theme-openapi-docs/package.json | 2 +- yarn.lock | 9 +++++---- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/packages/docusaurus-theme-openapi-docs/package.json b/packages/docusaurus-theme-openapi-docs/package.json index 49d267ae0..1cedf56a7 100644 --- a/packages/docusaurus-theme-openapi-docs/package.json +++ b/packages/docusaurus-theme-openapi-docs/package.json @@ -45,7 +45,7 @@ "dependencies": { "@docusaurus/theme-common": ">=2.0.1 <2.3.0", "@mdx-js/react": "^1.6.21", - "@paloaltonetworks/postman-code-generators": "^1.1.15", + "@paloaltonetworks/postman-code-generators": "^1.5.0-patch.1", "@paloaltonetworks/postman-collection": "^4.1.0", "@reduxjs/toolkit": "^1.7.1", "buffer": "^6.0.3", diff --git a/yarn.lock b/yarn.lock index 2cfce3e28..fc0941e50 100644 --- a/yarn.lock +++ b/yarn.lock @@ -3101,13 +3101,14 @@ path-browserify "1.0.1" yaml "1.10.2" -"@paloaltonetworks/postman-code-generators@^1.1.15": - version "1.1.15" - resolved "https://registry.yarnpkg.com/@paloaltonetworks/postman-code-generators/-/postman-code-generators-1.1.15.tgz#822eb45b538e47559ef2b6552223923cd8a62571" - integrity sha512-GVVqC+Uhe5Bt6VH/j26ooYZhv3lnrTdx59Fj3/DNeHV3aJAaWFtktu9pqj90nbxR56Sg/3CymaoZl/vyLiLJmg== +"@paloaltonetworks/postman-code-generators@^1.5.0-patch.1": + version "1.5.0-patch.1" + resolved "https://registry.yarnpkg.com/@paloaltonetworks/postman-code-generators/-/postman-code-generators-1.5.0-patch.1.tgz#2877892e93cda2e80bd72853af19680764f7f7d6" + integrity sha512-Lv5IvSrU03rHBV9DJ5bBtqfz1kJFB+4f68z6mDNhxXzIwBBhTCJO26GHMFv0nfbpQQ9nYfk5zg3YCOAjHyZD5Q== dependencies: "@paloaltonetworks/postman-collection" "^4.1.0" async "^3.2.4" + lodash "4.17.21" path "^0.12.7" shelljs "^0.8.5" From 67d88a5a44ff4c3224d757a44510502883c5dfce Mon Sep 17 00:00:00 2001 From: Steven Serrata Date: Fri, 17 Mar 2023 10:22:50 -0400 Subject: [PATCH 03/14] Add powershell and enable all langs --- demo/docusaurus.config.js | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/demo/docusaurus.config.js b/demo/docusaurus.config.js index 1342b2cff..3ae11544b 100644 --- a/demo/docusaurus.config.js +++ b/demo/docusaurus.config.js @@ -136,7 +136,7 @@ const config = { copyright: `Copyright © ${new Date().getFullYear()} Palo Alto Networks, Inc. Built with Docusaurus ${DOCUSAURUS_VERSION}.`, }, prism: { - additionalLanguages: ["ruby", "csharp", "php", "java"], + additionalLanguages: ["ruby", "csharp", "php", "java", "powershell"], }, languageTabs: [ { @@ -161,28 +161,33 @@ const config = { logoClass: "nodejs", variant: "axios", }, - // { - // highlight: "ruby", - // language: "ruby", - // logoClass: "ruby", - // }, + { + highlight: "ruby", + language: "ruby", + logoClass: "ruby", + }, { highlight: "csharp", language: "csharp", logoClass: "csharp", variant: "httpclient", }, - // { - // highlight: "php", - // language: "php", - // logoClass: "php", - // }, + { + highlight: "php", + language: "php", + logoClass: "php", + }, { highlight: "java", language: "java", logoClass: "java", variant: "unirest", }, + { + highlight: "powershell", + language: "powershell", + logoClass: "powershell", + }, ], algolia: { apiKey: "441074cace987cbf4640c039ebed303c", From 015d1bd7e695fcdfe149f26095e38139fab24311 Mon Sep 17 00:00:00 2001 From: Steven Serrata Date: Fri, 17 Mar 2023 10:23:06 -0400 Subject: [PATCH 04/14] Add powershell --- .../src/theme/ApiDemoPanel/Curl/index.tsx | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/ApiDemoPanel/Curl/index.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/ApiDemoPanel/Curl/index.tsx index 974cc43d5..dd4e4ff98 100644 --- a/packages/docusaurus-theme-openapi-docs/src/theme/ApiDemoPanel/Curl/index.tsx +++ b/packages/docusaurus-theme-openapi-docs/src/theme/ApiDemoPanel/Curl/index.tsx @@ -111,6 +111,16 @@ export const languageSet: Language[] = [ }, variant: "OkHttp", }, + { + highlight: "powershell", + language: "powershell", + logoClass: "powershell", + options: { + followRedirect: true, + trimRequestBody: true, + }, + variant: "RestMethod", + }, ]; export interface Props { From 06b756c221793d6222869414baa572be20ee0632 Mon Sep 17 00:00:00 2001 From: Steven Serrata Date: Fri, 17 Mar 2023 10:23:40 -0400 Subject: [PATCH 05/14] Add powershell styles and add background to bash icon --- .../src/theme/styles.css | 34 ++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/styles.css b/packages/docusaurus-theme-openapi-docs/src/theme/styles.css index 3b2d2688a..7ce012961 100644 --- a/packages/docusaurus-theme-openapi-docs/src/theme/styles.css +++ b/packages/docusaurus-theme-openapi-docs/src/theme/styles.css @@ -17,10 +17,14 @@ --openapi-card-border-radius: var(--ifm-pre-border-radius); --openapi-input-border: var(--ifm-color-primary); --openapi-input-background: var(--openapi-card-background-color); + --bash-background-color: transparent; + --bash-border-radius: none; } [data-theme="dark"] { --openapi-card-background-color: var(--ifm-color-gray-900) !important; + --bash-background-color: lightgrey; + --bash-border-radius: 20px; } .docs-wrapper { @@ -319,7 +323,9 @@ content: ""; width: 28px; height: 28px; - background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/bash/bash-original.svg"); + background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/bash/bash-plain.svg"); + background-color: var(--bash-background-color); + border-radius: var(--bash-border-radius); margin-block: auto; } @@ -471,6 +477,32 @@ overflow: auto; } +.code__tab--powershell::after { + content: ""; + width: 28px; + height: 28px; + background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/windows8/windows8-original.svg"); + margin-block: auto; +} + +.code__tab--powershell { + color: var(--ifm-color-info); + padding-left: 1.4rem; + padding-right: 1.4rem; + padding-top: 1rem !important; + padding-bottom: 1rem !important; +} + +.code__tab--powershell.tabs__item--active { + border-bottom-color: var(--ifm-color-info); + background-color: var(--ifm-color-emphasis-100); +} + +.language-powershell { + max-height: 500px; + overflow: auto; +} + /* Prism code styles */ .prism-code.language-java { white-space: pre !important; From a7cba6947430ab22df875e5eb1a3418eb97a72b8 Mon Sep 17 00:00:00 2001 From: Steven Serrata Date: Fri, 17 Mar 2023 10:27:54 -0400 Subject: [PATCH 06/14] Switch to python requests variant --- demo/docusaurus.config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/demo/docusaurus.config.js b/demo/docusaurus.config.js index 3ae11544b..079a4f015 100644 --- a/demo/docusaurus.config.js +++ b/demo/docusaurus.config.js @@ -148,7 +148,7 @@ const config = { highlight: "python", language: "python", logoClass: "python", - variant: "http.client", + variant: "requests", }, { highlight: "go", From a8cca565f4bcc8705818ed221a95e60b5fe20137 Mon Sep 17 00:00:00 2001 From: Steven Serrata Date: Fri, 17 Mar 2023 10:28:07 -0400 Subject: [PATCH 07/14] Add title to code blocks --- .../src/theme/ApiDemoPanel/Curl/index.tsx | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/ApiDemoPanel/Curl/index.tsx b/packages/docusaurus-theme-openapi-docs/src/theme/ApiDemoPanel/Curl/index.tsx index dd4e4ff98..eafaa89d6 100644 --- a/packages/docusaurus-theme-openapi-docs/src/theme/ApiDemoPanel/Curl/index.tsx +++ b/packages/docusaurus-theme-openapi-docs/src/theme/ApiDemoPanel/Curl/index.tsx @@ -290,7 +290,11 @@ function Curl({ postman, codeSamples }: Props) { } attributes={{ className: `code__tab--${lang.logoClass}` }} > - + {codeText} From c13d3ee2d6141507592860926a7bc781d4109247 Mon Sep 17 00:00:00 2001 From: Steven Serrata Date: Fri, 17 Mar 2023 10:28:49 -0400 Subject: [PATCH 08/14] Unhide send button for Petstore --- demo/docusaurus.config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/demo/docusaurus.config.js b/demo/docusaurus.config.js index 079a4f015..d4d5c2302 100644 --- a/demo/docusaurus.config.js +++ b/demo/docusaurus.config.js @@ -238,7 +238,7 @@ const config = { template: "api.mustache", // Customize API MDX with mustache template downloadUrl: "https://raw.githubusercontent.com/PaloAltoNetworks/docusaurus-openapi-docs/main/demo/examples/petstore.yaml", - hideSendButton: true, + hideSendButton: false, }, cos: { specPath: "examples/openapi-cos.json", From 2948e4542f8de539947f9d2a8b1ead0166b54dc9 Mon Sep 17 00:00:00 2001 From: Steven Serrata Date: Fri, 17 Mar 2023 10:49:31 -0400 Subject: [PATCH 09/14] Adjust size of code block logos --- .../src/theme/styles.css | 42 ++++++++++--------- 1 file changed, 22 insertions(+), 20 deletions(-) diff --git a/packages/docusaurus-theme-openapi-docs/src/theme/styles.css b/packages/docusaurus-theme-openapi-docs/src/theme/styles.css index 7ce012961..db4729241 100644 --- a/packages/docusaurus-theme-openapi-docs/src/theme/styles.css +++ b/packages/docusaurus-theme-openapi-docs/src/theme/styles.css @@ -19,6 +19,8 @@ --openapi-input-background: var(--openapi-card-background-color); --bash-background-color: transparent; --bash-border-radius: none; + --code-tab-logo-width: 26px; + --code-tab-logo-height: 26px; } [data-theme="dark"] { @@ -243,8 +245,8 @@ .code__tab--python::after { content: ""; - width: 28px; - height: 28px; + width: var(--code-tab-logo-width); + height: var(--code-tab-logo-height); background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/python/python-original.svg"); margin-block: auto; } @@ -269,8 +271,8 @@ .code__tab--go::after { content: ""; - width: 28px; - height: 28px; + width: var(--code-tab-logo-width); + height: var(--code-tab-logo-height); background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/go/go-original-wordmark.svg"); margin-block: auto; } @@ -295,8 +297,8 @@ .code__tab--javascript::after { content: ""; - width: 28px; - height: 28px; + width: var(--code-tab-logo-width); + height: var(--code-tab-logo-height); background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/javascript/javascript-original.svg"); margin-block: auto; } @@ -321,8 +323,8 @@ .code__tab--bash::after { content: ""; - width: 28px; - height: 28px; + width: var(--code-tab-logo-width); + height: var(--code-tab-logo-height); background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/bash/bash-plain.svg"); background-color: var(--bash-background-color); border-radius: var(--bash-border-radius); @@ -349,8 +351,8 @@ .code__tab--ruby::after { content: ""; - width: 28px; - height: 28px; + width: var(--code-tab-logo-width); + height: var(--code-tab-logo-height); background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/ruby/ruby-plain.svg"); margin-block: auto; } @@ -375,8 +377,8 @@ .code__tab--csharp::after { content: ""; - width: 28px; - height: 28px; + width: var(--code-tab-logo-width); + height: var(--code-tab-logo-height); background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/csharp/csharp-original.svg"); margin-block: auto; } @@ -401,8 +403,8 @@ .code__tab--nodejs::after { content: ""; - width: 28px; - height: 28px; + width: var(--code-tab-logo-width); + height: var(--code-tab-logo-height); background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/nodejs/nodejs-original.svg"); margin-block: auto; } @@ -427,8 +429,8 @@ .code__tab--php::after { content: ""; - width: 28px; - height: 28px; + width: var(--code-tab-logo-width); + height: var(--code-tab-logo-height); background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/php/php-original.svg"); margin-block: auto; } @@ -453,8 +455,8 @@ .code__tab--java::after { content: ""; - width: 28px; - height: 28px; + width: var(--code-tab-logo-width); + height: var(--code-tab-logo-height); background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/java/java-original.svg"); margin-block: auto; } @@ -479,8 +481,8 @@ .code__tab--powershell::after { content: ""; - width: 28px; - height: 28px; + width: var(--code-tab-logo-width); + height: var(--code-tab-logo-height); background: url("https://raw.githubusercontent.com/devicons/devicon/master/icons/windows8/windows8-original.svg"); margin-block: auto; } From b830732b0e1928c5d6ba18d021bd3ed0cadf585c Mon Sep 17 00:00:00 2001 From: Steven Serrata Date: Fri, 17 Mar 2023 14:38:39 -0400 Subject: [PATCH 10/14] Downgrade to legacy postman-code-generators --- packages/docusaurus-theme-openapi-docs/package.json | 2 +- yarn.lock | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/packages/docusaurus-theme-openapi-docs/package.json b/packages/docusaurus-theme-openapi-docs/package.json index 1cedf56a7..eda0837c9 100644 --- a/packages/docusaurus-theme-openapi-docs/package.json +++ b/packages/docusaurus-theme-openapi-docs/package.json @@ -45,7 +45,7 @@ "dependencies": { "@docusaurus/theme-common": ">=2.0.1 <2.3.0", "@mdx-js/react": "^1.6.21", - "@paloaltonetworks/postman-code-generators": "^1.5.0-patch.1", + "@paloaltonetworks/postman-code-generators": "1.1.15-patch.1", "@paloaltonetworks/postman-collection": "^4.1.0", "@reduxjs/toolkit": "^1.7.1", "buffer": "^6.0.3", diff --git a/yarn.lock b/yarn.lock index fc0941e50..1a4443ba6 100644 --- a/yarn.lock +++ b/yarn.lock @@ -3101,10 +3101,10 @@ path-browserify "1.0.1" yaml "1.10.2" -"@paloaltonetworks/postman-code-generators@^1.5.0-patch.1": - version "1.5.0-patch.1" - resolved "https://registry.yarnpkg.com/@paloaltonetworks/postman-code-generators/-/postman-code-generators-1.5.0-patch.1.tgz#2877892e93cda2e80bd72853af19680764f7f7d6" - integrity sha512-Lv5IvSrU03rHBV9DJ5bBtqfz1kJFB+4f68z6mDNhxXzIwBBhTCJO26GHMFv0nfbpQQ9nYfk5zg3YCOAjHyZD5Q== +"@paloaltonetworks/postman-code-generators@1.1.15-patch.1": + version "1.1.15-patch.1" + resolved "https://registry.yarnpkg.com/@paloaltonetworks/postman-code-generators/-/postman-code-generators-1.1.15-patch.1.tgz#07a5e1fad6cf531c9576d394368b63dce1b9b375" + integrity sha512-gyGsLL5iaD/++8a9V8Uv7j82jy2Os6ONo5AFdtWQvkyZv86vvFKoYXJ08QfA5fuw7GVkyO6rMQMzdUJIh5zqJg== dependencies: "@paloaltonetworks/postman-collection" "^4.1.0" async "^3.2.4" From 9503a0bfda342c710af66b587883e5e9887ef319 Mon Sep 17 00:00:00 2001 From: Steven Serrata Date: Fri, 17 Mar 2023 14:51:14 -0400 Subject: [PATCH 11/14] Disable csharp --- demo/docusaurus.config.js | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/demo/docusaurus.config.js b/demo/docusaurus.config.js index d4d5c2302..5130d8d4f 100644 --- a/demo/docusaurus.config.js +++ b/demo/docusaurus.config.js @@ -166,12 +166,12 @@ const config = { language: "ruby", logoClass: "ruby", }, - { - highlight: "csharp", - language: "csharp", - logoClass: "csharp", - variant: "httpclient", - }, + // { + // highlight: "csharp", + // language: "csharp", + // logoClass: "csharp", + // variant: "httpclient", + // }, { highlight: "php", language: "php", From 97acc6c70950d840cc39d253ae98925b51765661 Mon Sep 17 00:00:00 2001 From: Steven Serrata Date: Fri, 17 Mar 2023 14:59:40 -0400 Subject: [PATCH 12/14] Disable powershell --- demo/docusaurus.config.js | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/demo/docusaurus.config.js b/demo/docusaurus.config.js index 5130d8d4f..5fcd4af28 100644 --- a/demo/docusaurus.config.js +++ b/demo/docusaurus.config.js @@ -166,12 +166,12 @@ const config = { language: "ruby", logoClass: "ruby", }, - // { - // highlight: "csharp", - // language: "csharp", - // logoClass: "csharp", - // variant: "httpclient", - // }, + { + highlight: "csharp", + language: "csharp", + logoClass: "csharp", + variant: "httpclient", + }, { highlight: "php", language: "php", @@ -183,11 +183,11 @@ const config = { logoClass: "java", variant: "unirest", }, - { - highlight: "powershell", - language: "powershell", - logoClass: "powershell", - }, + // { + // highlight: "powershell", + // language: "powershell", + // logoClass: "powershell", + // }, ], algolia: { apiKey: "441074cace987cbf4640c039ebed303c", From 308e2b2e23d50bf7ae4d0f47f281ac4268b3dd37 Mon Sep 17 00:00:00 2001 From: Steven Serrata Date: Fri, 17 Mar 2023 15:32:23 -0400 Subject: [PATCH 13/14] Enable powershell --- demo/docusaurus.config.js | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/demo/docusaurus.config.js b/demo/docusaurus.config.js index 5fcd4af28..d4d5c2302 100644 --- a/demo/docusaurus.config.js +++ b/demo/docusaurus.config.js @@ -183,11 +183,11 @@ const config = { logoClass: "java", variant: "unirest", }, - // { - // highlight: "powershell", - // language: "powershell", - // logoClass: "powershell", - // }, + { + highlight: "powershell", + language: "powershell", + logoClass: "powershell", + }, ], algolia: { apiKey: "441074cace987cbf4640c039ebed303c", From 44b329e75ac5e3ef92fc92c89cd643499d373f4e Mon Sep 17 00:00:00 2001 From: Steven Serrata Date: Fri, 17 Mar 2023 15:32:41 -0400 Subject: [PATCH 14/14] Switch to postman-code-generators 1.1.15-patch.2 --- packages/docusaurus-theme-openapi-docs/package.json | 2 +- yarn.lock | 9 ++++----- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/packages/docusaurus-theme-openapi-docs/package.json b/packages/docusaurus-theme-openapi-docs/package.json index eda0837c9..c4fbca6b6 100644 --- a/packages/docusaurus-theme-openapi-docs/package.json +++ b/packages/docusaurus-theme-openapi-docs/package.json @@ -45,7 +45,7 @@ "dependencies": { "@docusaurus/theme-common": ">=2.0.1 <2.3.0", "@mdx-js/react": "^1.6.21", - "@paloaltonetworks/postman-code-generators": "1.1.15-patch.1", + "@paloaltonetworks/postman-code-generators": "1.1.15-patch.2", "@paloaltonetworks/postman-collection": "^4.1.0", "@reduxjs/toolkit": "^1.7.1", "buffer": "^6.0.3", diff --git a/yarn.lock b/yarn.lock index 1a4443ba6..09e9d5471 100644 --- a/yarn.lock +++ b/yarn.lock @@ -3101,14 +3101,13 @@ path-browserify "1.0.1" yaml "1.10.2" -"@paloaltonetworks/postman-code-generators@1.1.15-patch.1": - version "1.1.15-patch.1" - resolved "https://registry.yarnpkg.com/@paloaltonetworks/postman-code-generators/-/postman-code-generators-1.1.15-patch.1.tgz#07a5e1fad6cf531c9576d394368b63dce1b9b375" - integrity sha512-gyGsLL5iaD/++8a9V8Uv7j82jy2Os6ONo5AFdtWQvkyZv86vvFKoYXJ08QfA5fuw7GVkyO6rMQMzdUJIh5zqJg== +"@paloaltonetworks/postman-code-generators@1.1.15-patch.2": + version "1.1.15-patch.2" + resolved "https://registry.yarnpkg.com/@paloaltonetworks/postman-code-generators/-/postman-code-generators-1.1.15-patch.2.tgz#012051485269a2da6bd9a6b60031ddbc53e5e363" + integrity sha512-tRnAKtV4M8wLxcVnAx6ZCjCqbrR1xiqJNQkf1A71K8UxEP3N/+EspT82N5c0555w02oYFk21ViHuzuhm4gaGLw== dependencies: "@paloaltonetworks/postman-collection" "^4.1.0" async "^3.2.4" - lodash "4.17.21" path "^0.12.7" shelljs "^0.8.5"