Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Update parser documentation template to include additional detail. #11916

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Mar 5, 2025
Merged

Update parser documentation template to include additional detail. #11916

merged 2 commits into from
Mar 5, 2025

Conversation

skywalke34
Copy link
Contributor

Description

  • This pull request updates the parser-documentation-template.md file to improve structure and detail. The changes include:
  • Updated the format of the template to include more details.
  • Added placeholders and general instructions for each section to make it easier for contributors to create new parser documentation.
  • Added a numbered list to identify all fields parsed or not parsed for contributors to follow.
  • Included general guidance on how to map fields, handle deduplication, and manage occurrences in the parser.

This change is purely documentation-related and should not affect any functionality or code in DefectDojo.

@github-actions github-actions bot added the docs label Feb 28, 2025
@skywalke34 skywalke34 marked this pull request as ready for review February 28, 2025 06:18
@dryrunsecurity DryRunSecurity
Copy link

DryRun Security Summary

Documentation template for security tool parsers has been enhanced with more comprehensive guidance, structured templates, and expanded sections, while addressing path disclosure and information exposure considerations.

Expand for full summary

The PR updates the parser documentation template with more comprehensive guidance for documenting security tool parsers, expanding sections and adding structured templates. Security findings include:

  1. Path Disclosure: Updated file path reveals project documentation structure, potentially exposing repository organization details.
  2. Potential Information Exposure: Template encourages documenting all fields, which could help prevent unintended information leakage.

Code Analysis

We ran 7 analyzers against 1 file and 0 analyzers had findings. 7 analyzers had no findings.

View PR in the DryRun Dashboard.

mtesauro
mtesauro approved these changes Feb 28, 2025
View reviewed changes
Copy link
Contributor

@mtesauro mtesauro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved

@Maffooch Maffooch merged commit ee18462 into DefectDojo:dev Mar 5, 2025
77 checks passed
@skywalke34 skywalke34 deleted the parser-documentation-template-clean branch March 6, 2025 19:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@grendel513 grendel513 grendel513 approved these changes

@mtesauro mtesauro mtesauro approved these changes

@hblankenship hblankenship hblankenship approved these changes

@Maffooch Maffooch Maffooch approved these changes

Assignees
No one assigned
Labels
docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@skywalke34 @grendel513 @mtesauro @hblankenship @Maffooch