PaloAltoNetworks / PaloAltoNetworks/pan.dev

Issue/Help with "Get Compliance Statistics Breakdown V2 - GET"

Open
#744 0 comments 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-compliance-posture-for-standard-v-2/

Describe the problem

Requests to this endpoint /v2/compliance/posture without "time" parameters, as described in the documentation will fail (400 bad request):

Postman-compliance-v2-not-working
If you add time parameters as in v1, you have an 200 ok request:
Postman-compliance-v2-time-parameters

Support team through Customer Case confirmed that time parameters are required for the GET method.

Suggested fix

Add the correct requirements of "time fields" in the documentation page of /v2/posture/

timeType string REQUIRED
Possible values: [relative]
Time type

timeAmount string REQUIRED
Number of time units

timeUnit string REQUIRED
Possible values: [minute, hour, day, week, month, year]
timeUnit

Check if these "time fields" are required in other GET /v2/posture/*

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 documentation page for GET /v2/compliance/posture and compare its parameters with the working v1 request. Update the v2 documentation to mark timeType, timeAmount, and timeUnit as required, then check the other GET /v2/posture/* endpoints for the same omission.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.