docs(iot): IPR-1814 Device Security API usability improvements + vuln severity filter - #1419
Open
despera3821 wants to merge 8 commits into
Open
docs(iot): IPR-1814 Device Security API usability improvements + vuln severity filter#1419despera3821 wants to merge 8 commits into
despera3821 wants to merge 8 commits into
Conversation
Public API OpenAPI spec updates (match zingcloud MR !7421): - getSubnet: add name/siteid/description (exact-match), prefix, flat params; note all fields always present + 200+empty on no match (Req 1,3,4,5,7) - getSite: add name/description (exact-match) params; 200+empty on no match (Req 2,4) - schemas GetSiteResponse/UpdateSitePayloadSchema: add `group` field (the group the site belongs to; null when none); clarify external_id = GUI Name, siteid internal (Req 9, 12) - schemas DeviceDetailsV2: add site_name; document attr excluded under projection unless listed + panwIoTFname_* mapping pointer (Req 13, 10, 11) - schemas CreateNetworkSegmentPayloadSchema: add friendly `site` param (Req 14) - deviceListV2: expand projection description (attr exclusion, Req 10/11) - examples: +group (site), +site (create-segment) Note: Req 6 parent-range dropped (not documented). Req 10 attr is BREAKING - publish release note before deploy.
Adds the 'severity' query parameter (Critical/High/Medium/Low, case-sensitive) to the vulnerability list reference. The parameter is already supported by the API (publicapi/v03/vulnerability.js schema) but was undocumented.
Documents the existing includeDeviceIdList (yes|no) parameter: default includes the impacted device-ID arrays; includeDeviceIdList=no returns counts only for a smaller/faster response. Notes the size-limit guidance for large tenants (paginate or use =no) — relates to BAN-31435.
…payload guidance - Correct pagelength/offset: they now apply to groupby=vulnerability too (was documented as device-only); recommend small pagelength + offset for large tenants. - includeDeviceIdList: note that if a request fails with HTTP 400 due to an oversized response, use includeDeviceIdList=no and/or a smaller pagelength.
flat=true (and large pagelength) returns at most 10,000 subnets per request; larger pagelength is capped at 10,000 — use offset to page beyond. Matches the server-side cap in zingcloud BAN-31721.
|
Visit the preview URL for this PR (updated for commit 105018d): https://pan-dev-f1b58--pr1419-vbgod0g6.web.app (expires Fri, 14 Aug 2026 18:21:04 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: 9359a9fa100d5fdb082f75280473a90b1f96eb51 |
Trim the projection param to the essentials (comma-separated fields, max 50, from device/attributes, omitted -> full object). Drop the attr-exclusion detail.
…ed SUBNET_MAX_PAGE_LENGTH) The public subnet API rejects pagelength>1000 with HTTP 400 (pre-existing BAN-22855 cap). Prior wording said 10,000; corrected to 1,000 and added maximum:1000 to the schema. Use offset to page (incl. flat=true).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents the IPR-1814 Device Security public API usability changes (subnet
name/siteid/description/prefix/flat, sitename/description/group, devicesite_name/attrprojection, networkSegment friendlysite) and adds the previously-undocumentedseverityfilter (Critical/High/Medium/Low) onGET /vulnerability/list.Branched directly off
mainper code-owner guidance. Supersedes #1400.