Actions
Documentation #6071
open
VJ
OD
eve/schema: add descriptions to the schema
Documentation #6071:
eve/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)
JI Updated by Jason Ish almost 3 years ago
- Subtask #6072 added
JI Updated by Jason Ish almost 3 years ago
- Subtask #6073 added
JI Updated by Jason Ish almost 3 years ago
- Subtask #6074 added
JI Updated by Jason Ish almost 3 years ago
- Subtask #6075 added
JI Updated by Jason Ish almost 3 years ago
- Subtask #6076 added
JI Updated by Jason Ish almost 3 years ago
- Subtask #6077 added
JI Updated by Jason Ish almost 3 years ago
- Subtask #6078 added
JI Updated by Jason Ish almost 3 years ago
- Description updated (diff)
JI Updated by Jason Ish over 2 years ago
- Related to Documentation #6288: eve/schema: generate tables of data for app-layer protocols added
SB Updated by Shivani Bhardwaj over 2 years ago
- Subtask #6434 added
VJ Updated by Victor Julien over 2 years ago
- Related to Task #6443: Suricon 2023 brainstorm added
VJ Updated by Victor Julien over 2 years ago
To find missing fields we can look at code coverage of the log producing sites.
PA Updated by Philippe Antoine over 2 years ago
- Related to Documentation #2699: document all eve record types and fields added
VJ Updated by Victor Julien over 2 years ago
- Status changed from New to Assigned
JF Updated by Juliana Fajardini Reichow over 1 year ago
- Subtask #7299 added
Actions