Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Specify the model of json output #230

Open
demeringo opened this issue Oct 2, 2023 · 2 comments
Open

Specify the model of json output #230

demeringo opened this issue Oct 2, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@demeringo
Copy link
Collaborator

demeringo commented Oct 2, 2023

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

@demeringo demeringo added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 2, 2023
@da-ekchajzer
Copy link
Collaborator

Where would you put the JSON Schema ?

@demeringo
Copy link
Collaborator Author

demeringo commented Oct 8, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants