Repository navigation
docs: fix the API sample code, do_not_reactivate, Location findings and records screenshots - #16639
Merged
Merged
Conversation
…nd records screenshots - API v2 Sample Code: query /api/v2/findings/ (readable with any token) instead of /api/v2/users/, print the results instead of the Response internals, show the paginated response shape and a filtered query, with placeholder host and token. - do_not_reactivate: a reimport keeps a closed finding closed; new and open findings are processed as usual. - Location page: its table lists open findings only; say how to reach every finding on a Location through the Total Findings count. - Location Map: link it from the Locations overview, and state what a Reader can and cannot change. - Recapture the upstream records screenshots with the row menu. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Maffooch
approved these changes
Oct 30, 2026
devGregA
approved these changes
Oct 30, 2026
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
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.
Description
Fixes five out-of-date places in the docs:
automation/api/api-v2-docs.md): both Python samples now query/api/v2/findings/, which any token can read (the old/users/sample returned 403 for a Reader). They callraise_for_status(), print each finding'sidandtitleinstead of the Response object's internals, and use a placeholder host and<Your API Token>. The second sample filters onseverityandactive, notes that severity values are case-sensitive, and shows the paginated response shape (count,next,previous,prefetch,results) withlimitandoffset.do_not_reactivate(same page, Reimport): a reimport keeps a closed finding closed when it appears in the report again and adds a note to it; new findings are still created and open findings are processed as usual.PRO__location_map.md,PRO__locations_overview.md): linked from the Locations overview, with the relationship editing wording corrected (Clear is an option in the picker, then Save) and what a Reader cannot change stated.PRO__working_with_urls.md): its table is Affected Open Findings, filtered on Status Active. The page now says how to see every finding on a Location: the Total Findings count in a list of Locations opens the Findings list filtered to it.edit_ignore_delete_records.png,edit_ignore_delete_records_2.png): recaptured from demo data, so the first shows the row menu the text describes.English pages and images only; the language copies are generated.
Test results
Docs only. Both samples were run against a local instance with a Reader's token, and the Location statements were checked in the running app as an administrator and as a Reader. Every link and image path resolves.
Documentation
This PR is the documentation change.
Checklist
dev.devbranch.🤖 Generated with Claude Code