Boavizta / boaviztapi

🛠 Giving access to BOAVIZTA reference data and methodologies trough a RESTful API
GNU Affero General Public License v3.0
66 stars 23 forks source link

Specify the model of json output #230

Open demeringo opened 9 months ago

demeringo commented 9 months ago

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

da-ekchajzer commented 9 months ago

Where would you put the JSON Schema ?

demeringo commented 9 months ago

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.