Project

General

Profile

Actions

Documentation #6071

open

eve/schema: add descriptions to the schema

Added by Victor Julien about 1 year ago. Updated 5 months ago.

Status:
Assigned
Priority:
Normal
Assignee:
Target version:
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)


Subtasks 8 (7 open1 closed)

Documentation #6072: eve/schema: document smbNewVictor JulienActions
Documentation #6073: eve/schema: document dnsNewJason IshActions
Documentation #6074: eve/schema: document nfsNewVictor JulienActions
Documentation #6075: eve/schema: document httpNewPhilippe AntoineActions
Documentation #6076: eve/schema: document quicClosedPhilippe AntoineActions
Documentation #6077: eve/schema: document sipNewJason IshActions
Documentation #6078: eve/schema: document pgsqlNewJuliana Fajardini ReichowActions
Documentation #6434: eve/schema: document statsIn ProgressShivani BhardwajActions

Related issues 3 (3 open0 closed)

Related to Suricata - Documentation #6288: eve/schema: generate tables of data for app-layer protocolsIn ProgressJason IshActions
Related to Suricata - Task #6443: Suricon 2023 brainstormAssignedVictor JulienActions
Related to Suricata - Documentation #2699: document all eve record types and fieldsAssignedSascha SteinbissActions
Actions

Also available in: Atom PDF