Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master' into DOCS-5564_Config_Or…
Browse files Browse the repository at this point in the history
…ch_latest
  • Loading branch information
sra-hub committed Dec 12, 2024
2 parents 54e6664 + cbd2014 commit f7a8379
Show file tree
Hide file tree
Showing 78 changed files with 9,406 additions and 6,508 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,5 @@ products/**/*.api.mdx
products/**/*.info.mdx
products/**/*.tag.mdx
products/**/sidebar.js
products/**/sidebar.ts
products/**/versions.json
2 changes: 1 addition & 1 deletion CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ products/splunk/* @PaloAltoNetworks/design-hive

# SWFW "Orchestration Hub"
products/terraform/docs/swfw/* @PaloAltoNetworks/pso_prisma_maintainers
products/terraform/sidebars.js @PaloAltoNetworks/pso_prisma_maintainers
products/terraform/sidebars.ts @PaloAltoNetworks/pso_prisma_maintainers

# Prisma Cloud team
openapi-specs/cspm/* @PaloAltoNetworks/pan-dev-prisma-cloud
Expand Down
27 changes: 18 additions & 9 deletions docusaurus.config.js → docusaurus.config.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
import Mermaid from "@theme/Mermaid";

/**
* Copyright (c) 2017-present, Facebook, Inc.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

let baseUrl
if (process.env.CI_MERGE_REQUEST_IID) {
if (process.env.CI_PROJECT_DIR == "dev") {
baseUrl = "/";
Expand All @@ -18,6 +20,9 @@ if (process.env.CI_MERGE_REQUEST_IID) {
}

const config = {
future: {
experimental_faster: (process.env.DOCUSAURUS_FASTER ?? "true") === "true",
},
title: "Develop with Palo Alto Networks",
tagline:
"Explore our API Doc, Quickstarts, and Blog or dive right in and play in our sandbox. We have all the tools you needs to make the next big security innovation. SDKs in your favorite languages, detailed walk-throughs for sample apps, and all the resources you’ll need to flourish.",
Expand All @@ -28,15 +33,19 @@ const config = {
favicon: "img/PANW_Parent_Glyph_Red.svg",
organizationName: "PaloAltoNetworks",
projectName: "pan.dev",
<<<<<<< HEAD:docusaurus.config.js
=======
markdown: { format: "detect", mermaid: true },
>>>>>>> origin/master:docusaurus.config.ts
themeConfig: {
prism: {
additionalLanguages: ["csharp", "php", "hcl"],
additionalLanguages: ["csharp", "php", "hcl", "json", "bash"],
},
languageTabs: [
{
highlight: "bash",
language: "curl",
logoClass: "bash",
logoClass: "curl",
},
{
highlight: "python",
Expand Down Expand Up @@ -602,9 +611,6 @@ const config = {
copyright: `Copyright © ${new Date().getFullYear()} Palo Alto Networks, Inc.`,
},
},
markdown: {
mermaid: true,
},
themes: ["docusaurus-theme-openapi-docs", "@docusaurus/theme-mermaid"],
presets: [
[
Expand Down Expand Up @@ -855,7 +861,7 @@ const config = {
id: "default",
routeBasePath: "/",
path: "products",
sidebarPath: "./sidebars.js",
sidebarPath: "./sidebars.ts",
editUrl: "https://github.com/PaloAltoNetworks/pan.dev/tree/master",
include: ["**/*.{md,mdx}"],
docItemComponent: "@theme/ApiItem",
Expand All @@ -879,6 +885,7 @@ const config = {
onBrokenLinks: "warn",
onBrokenMarkdownLinks: "warn",
trailingSlash: true,
<<<<<<< HEAD:docusaurus.config.js
webpack: {
jsLoader: (isServer) => ({
loader: require.resolve("esbuild-loader"),
Expand All @@ -889,6 +896,8 @@ const config = {
},
}),
},
=======
>>>>>>> origin/master:docusaurus.config.ts
customFields: {
firebaseApiKey: process.env.REACT_APP_FIREBASE_APIKEY,
recaptchaApiKey: process.env.REACT_APP_RECAPTCHA_APIKEY,
Expand All @@ -900,7 +909,7 @@ const config = {
Takes in list of products to filter based on directory, outputs list of globby include for the doc plugin
*/
function docsPluginInclude(filters) {
include = [];
let include = [] as any;
filters.forEach((product) => {
let product_include = product + "/**/*.{md,mdx}";
include.push(product_include);
Expand All @@ -912,7 +921,7 @@ async function createConfig() {
let filters =
process.env.PRODUCTS_INCLUDE && process.env.PRODUCTS_INCLUDE.split(",");
if (filters) {
config.plugins[4][1].include = docsPluginInclude(filters);
config.plugins[4][1]["include"] = docsPluginInclude(filters);
}
return config;
}
Expand Down
4 changes: 4 additions & 0 deletions openapi-specs/cspm/AssetMicroService.json
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@
{
"name": "Id Translations",
"description": "Id Translation APIs to query data from Unified Asset Inventory (UAI)"
},
{
"name": "Asset Explorer",
"description": "no idea what the description should be"
}
],
"paths": {
Expand Down
89 changes: 0 additions & 89 deletions openapi-specs/cspm/CDEMMicroServices.json
Original file line number Diff line number Diff line change
Expand Up @@ -1067,95 +1067,6 @@
]
}
},
"/asm/api/v1/asset/{asset_id}": {
"get": {
"tags": [
"Discovery and Exposure Management"
],
"summary": "Get Asset Details by ID",
"description": "Get asset overview or details by asset id.",
"operationId": "get-asset-details",
"parameters": [
{
"name": "asset_id",
"in": "path",
"description": "Asset ID",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "snapshot_date",
"in": "query",
"description": "Snapshot date",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "asset_type",
"in": "query",
"description": "Asset type",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "manage_type",
"in": "query",
"description": "Manage type",
"required": false,
"schema": {
"type": "string",
"default": "UNMANAGED"
}
},
{
"name": "all_asset_details",
"in": "query",
"description": "Set it true to fetch all asset details.",
"required": false,
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"description": "Data not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"x-public": "true",
"security": [
{
"x-redlock-auth": []
}
]
}
},
"/asm/api/v1/asset/{asset_id}/vulnerability": {
"get": {
"tags": [
Expand Down
6 changes: 3 additions & 3 deletions openapi-specs/cspm/IAMV2MicroService.json
Original file line number Diff line number Diff line change
Expand Up @@ -1395,7 +1395,7 @@
{
"name": "resourceId",
"in": "path",
"description": "The resource ID",
"description": "The resource ID. Encoded ARN for AWS, ID for Azure (examples: arn:aws:iam::accountId:role/roleName, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)",
"required": true,
"schema": {
"type": "string"
Expand Down Expand Up @@ -1504,7 +1504,7 @@
{
"name": "resourceId",
"in": "path",
"description": "The resource ID",
"description": "The resource ID. Encoded ARN for AWS, ID for Azure (examples: arn:aws:iam::accountId:role/roleName, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)",
"required": true,
"schema": {
"type": "string",
Expand Down Expand Up @@ -1639,7 +1639,7 @@
{
"name": "resourceId",
"in": "path",
"description": "The resource ID",
"description": "The resource ID. Encoded ARN for AWS, ID for Azure (examples: arn:aws:iam::accountId:role/roleName, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)",
"required": true,
"schema": {
"type": "string"
Expand Down
Loading

0 comments on commit f7a8379

Please sign in to comment.