Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Action Plan API Public Preview #770

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open

Action Plan API Public Preview #770

wants to merge 11 commits into from

Conversation

jrdevore
Copy link
Contributor

@jrdevore jrdevore commented Nov 8, 2024

Action Plan API Public Documentation

PCAI-6962

First version of Public Action PLan API docs on target for 24.12.1


Setting up PANDEV for Arya Action plan

  • ID: action-plan

docusaurus.config.js entry for action plan

          "action-plan": {
            specPath: "openapi-specs/action-plan",
            outputDir: "products/prisma-cloud/api/action-plan",
            showExtensions: true,
            sidebarOptions: { groupPathsBy: "tag", categoryLinkSource: "tag" },
            baseUrl: "/prisma-cloud/api/",
            hideSendButton: true,
          },

Sidebar addition

Add action plan to sidebar array for prisma cloud

  • Path: pan.dev/products/prisma-cloud/sidebars.js
    {
      type: "category",
      label: "Arya Action Plan API",
      collapsed: true,
      items: [require("./api/action-plan/sidebar")],
    },
  ],

API Spec Location

  • Path: pan.dev/openapi-specs/action-plan/

Additional Documentation if any will go within products/prisma-cloud/api/action-plan

  • Path:pan.dev/products/prisma-cloud/api/action-plan

image

@jrdevore jrdevore added documentation Improvements or additions to documentation DO NOT MERGE prismacloud-api-documentation Prisma Cloud Public API Documentation labels Nov 8, 2024
Copy link

github-actions bot commented Nov 9, 2024

Visit the preview URL for this PR (updated for commit 346c75a):

https://pan-dev-f1b58--pr770-vyw89zq7.web.app

(expires Sun, 22 Dec 2024 19:33:37 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 9359a9fa100d5fdb082f75280473a90b1f96eb51

@jrdevore jrdevore marked this pull request as ready for review November 16, 2024 00:47
@jrdevore jrdevore requested review from a team as code owners November 16, 2024 00:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation prismacloud-api-documentation Prisma Cloud Public API Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants