PaloAltoNetworks / PaloAltoNetworks/pan.dev

Improvement in "Get Vulnerability (CVEs) Stats"

Open
#619 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

Prisma Cloud Runtime Security:

https://pan.dev/prisma-cloud/api/cwpp/get-stats-vulnerabilities/

Describe the problem

In this tech doc, we have the following point:

Consider the following observations:

The impacted resources and distribution counts are not retrieved when you apply filters or you are assigned with specific collections or accounts. For example, when you apply these filters, the counts in the API /stats/vulnerabilities are returned as zero and empty in the API /stats/vulnerabilites/download.

Suggested fix

This is correct, however I would suggest to make it more accurate by matching our docs here:
https://docs.prismacloud.io/en/enterprise-edition/content-collections/runtime-security/vulnerability-management/vulnerability-explorer

If you scroll all the way down, you'll see the following:
_The vulnerability (CVE) results hide the impacted resources if you use a filter or have an assigned collection or account as the percentage refers to the entire environment. This is supported for the System Admin role only.

Can we match the API docs with the vuln explorer docs by mentioning also that "This is supported for the System Admin role only"

Something like this:
The impacted resources and distribution counts are not retrieved when you apply filters or you are assigned with specific collections or accounts (This is supported for the System Admin role only) . For example, when you apply these filters, the counts in the API /stats/vulnerabilities are returned as zero and empty in the API /stats/vulnerabilites/download.

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 Get Vulnerability (CVEs) Stats API documentation linked in the issue and compare its filter and collection wording with the Vulnerability Explorer documentation. Update the relevant paragraph to state that the impacted-resource and distribution counts are supported for the System Admin role only, then verify the API documentation matches the referenced product documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.