Actions
Documentation #6071
openeve/schema: add descriptions to the schema
Affected Versions:
Effort:
Difficulty:
Label:
Description
Goal is to use this to add to the auto generated documentation.
We'd need tooling to extract from schema, generate something we can include/reference from rtd.
More information on adding documentation can be found here: https://json-schema.org/understanding-json-schema/reference/generic.html
In most cases for us, this just means adding a "description" field. This is often best done by the person who knows an app-layer the best.
Example in our code: https://github.com/OISF/suricata/blob/master/etc/schema.json#L1135 (dns.opcode)
Updated by Jason Ish about 1 year ago
- Related to Documentation #6288: eve/schema: generate tables of data for app-layer protocols added
Updated by Victor Julien 12 months ago
- Related to Task #6443: Suricon 2023 brainstorm added
Updated by Victor Julien 12 months ago
To find missing fields we can look at code coverage of the log producing sites.
Updated by Philippe Antoine 12 months ago
- Related to Documentation #2699: document all eve record types and fields added
Actions