Skip to content

📚 Document the generic Findings.json format #128

@rfelber

Description

@rfelber

Where to find the issue

The secureCodeBox V2 generates a generic findings JSON format in addition to the rawResults by each security scanner. This format should be documented within the documentation contribution section https://docs.securecodebox.io/docs/contributing/conventions to help developers understanding the finding generation and post processing process.

Suggested change

Maybe the json-schema standard https://json-schema.org/ could help to document the findings format in a more general way. The json-schema can also be used for validation of given findings.json files.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions