PaloAltoNetworks / PaloAltoNetworks/pan.dev

Issue/Help with "List Alerts V2 - GET"

Open
#497 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
MDX
Stars
78
Forks
88
Avg merge
5d 17h
Merged PRs (30d)
18

Description

Documentation link

https://pan.dev/prisma-cloud/api/cspm/get-alerts-v-2/

Describe the problem

The response schema documentation is not fully detailed and it is not fully aligned with the given example.

  1. Some object fields are not detailed, for example, the history object documentation just mentions it's an array of the history objects:
history object[]
Array []

However it does not mention the model structure of an history object. It is described only on the sample JSON as such:

      "history": [
        {
          "reason": "string",
          "status": "OPEN"
        }
      ],
  1. Some fields exist only on the sample JSON which is displayed under the Example from schema tab and are not mentioned at all on the field list which is displayed under the Schema tab. For example, when we compare the successful operation (200 Response code) documentation, the following two fields are not described in the field list in the schema documentation, yet they are still included in the sample JSON example:
    • policy.remediable (the remediable entry in the policy object).
    • reason (in the response JSON root level).

So which is correct, the "dry" schema field list or the sample JSON ?
If the sample is correct, why aren't the additional fields explicitly mentioned in the documentation with's their corresponding types & semantic descriptions ?

Suggested fix

Make sure the API response is properly documented and contains all relevant field both on the schema field list (along with the field names, description, type & structure) and on the sample JSON.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked List Alerts V2 - GET documentation and compare the 200 response's Schema and Example from schema sections. Confirm the history object structure, policy.remediable, and the root-level reason field against the API response, then ensure the field list and sample JSON consistently include their names, types, structures, and descriptions.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.