Project

General

Profile

Documentation #6071

Updated by Jason Ish over 1 year ago

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) 

Back