Skip to content

docs(iot): BAN-31435 vulnerability/list groupby=vulnerability pagination + includeDeviceIdList - #1401

Open
despera3821 wants to merge 4 commits into
PaloAltoNetworks:masterfrom
despera3821:docs/BAN-31435-vuln-pagination
Open

docs(iot): BAN-31435 vulnerability/list groupby=vulnerability pagination + includeDeviceIdList#1401
despera3821 wants to merge 4 commits into
PaloAltoNetworks:masterfrom
despera3821:docs/BAN-31435-vuln-pagination

Conversation

@despera3821

Copy link
Copy Markdown
Contributor

What

BAN-31435 follow-up docs: the public GET /vulnerability/list?groupby=vulnerability endpoint now supports pagination and a counts-only option (backend MRs !7415 + !7423).

Changes (openapi-specs/iot/api/public/vulnerabilityList.yaml)

  • pagelength / offset: corrected — they now apply to groupby=vulnerability too (the docs previously said device-only). Note to use a smaller page length for large tenants.
  • includeDeviceIdList (new, yes/no): when no, each vulnerability returns the device count instead of the full device-ID list, producing a much smaller response — use it (or a smaller pagelength) to keep large-tenant responses under the size limit.

Publish once the backend fix is deployed. Ticket: BAN-31435.

despera3821 and others added 3 commits May 17, 2023 12:35
…ports pagination + includeDeviceIdList

- pagelength/offset now apply to groupby=vulnerability (was device-only)
- add includeDeviceIdList=no (device counts instead of full id lists) to bound large responses
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant