Skip to content

docs(reports): describe the grouped report block field pickers - #16567

Open
blakeaowens wants to merge 1 commit into
devfrom
docs/report-field-groups
Open

blakeaowens wants to merge 1 commit into
devfrom
docs/report-field-groups

Conversation

@blakeaowens

Copy link
Copy Markdown
Contributor

Description

Documents the grouped field lists in the report builder. A Tabular or Detail block on the Organization, Asset, Engagement, Test or Finding entity now lists its Fields and Order By choices under the same headings as that entity's list page uses for Add Filter (on Finding: Finding, Threat Intel, Asset, Engagement and Test, Dates and People), in the same order. Other entities keep a flat list.

PRO__report_builder.md:

  • The entity section gains a paragraph on the headings, how a search in Fields narrows them, and that they do not change the column order set in the numbered list or the generated report.

PRO__report_builder_api.md:

  • The field_options example shows the group and block_types keys each entry carries, and a paragraph lists the group keys, which models carry them, and that a script can ignore them.

Test results

Documentation only. No code change.

Documentation

This PR is the documentation.

Checklist

This checklist is for your information.

  • 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.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@blakeaowens
blakeaowens requested a review from Maffooch as a code owner October 27, 2026 10:23
@blakeaowens blakeaowens added this to the 3.5.0 milestone Oct 27, 2026
@github-actions github-actions Bot added the docs label Oct 27, 2026

This branch has not been deployed

No deployments
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.

1 participant