Skip to content

docs: fix the API sample code, do_not_reactivate, Location findings and records screenshots - #16639

Merged
blakeaowens merged 1 commit into
devfrom
docs/fix-api-sample-and-location-docs-gaps
Oct 30, 2026
Merged

blakeaowens merged 1 commit into
devfrom
docs/fix-api-sample-and-location-docs-gaps

Conversation

@blakeaowens

Copy link
Copy Markdown
Contributor

Description

Fixes five out-of-date places in the docs:

  • API v2 Sample Code (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 call raise_for_status(), print each finding's id and title instead of the Response object's internals, and use a placeholder host and <Your API Token>. The second sample filters on severity and active, notes that severity values are case-sensitive, and shows the paginated response shape (count, next, previous, prefetch, results) with limit and offset.
  • 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.
  • Location Map (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.
  • Location page (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.
  • Upstream records screenshots (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

  • Make sure to rebase your PR against the very latest dev.
  • Submit all PRs, features and bug fixes alike, against the dev branch.
  • Give a meaningful name to your PR, as it may end up being used in the release notes.
  • Your code is Ruff compliant (see ruff.toml).
  • Your code is python 3.13 compliant.
  • If this is a new feature and not a bug fix, you've included the proper documentation in the docs at https://github.com/DefectDojo/django-DefectDojo/tree/dev/docs as part of this PR.
  • Model changes must include the necessary migrations in the dojo/db_migrations folder.
  • Add applicable tests to the unit tests.
  • Add the proper label to categorize your PR.

🤖 Generated with Claude Code

…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>
@blakeaowens blakeaowens added this to the 3.5.0 milestone Oct 30, 2026
@blakeaowens
blakeaowens requested a review from Maffooch as a code owner October 30, 2026 09:19
@github-actions github-actions Bot added the docs label Oct 30, 2026
@blakeaowens
blakeaowens added this pull request to the merge queue Oct 30, 2026
Merged via the queue into dev with commit 2d4a0e9 Oct 30, 2026
31 checks passed
@blakeaowens
blakeaowens deleted the docs/fix-api-sample-and-location-docs-gaps branch October 30, 2026 09:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants