boaviztapi
boaviztapi copied to clipboard
Specify the model of json output
Problem
Format of JSON output is described in documentation but not fully covered by an machine readable model (swagger or other).
Solution
JSON schema https://json-schema.org/
Alternatives
Additional context or elements
Where would you put the JSON Schema ?
Ideally, I would like it to be part of swagger api doc (and maybe link it to general documentation also). But I am not sure how to do this with the way we generate swagger.
An option could be to ask an LLM model to generate the schema from an example verbose ouptut, review it, and include it to our swagger.