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

Format: Generate example/examples using Faker or AI LLM #131

Open
thim81 opened this issue Sep 6, 2024 · 0 comments
Open

Format: Generate example/examples using Faker or AI LLM #131

thim81 opened this issue Sep 6, 2024 · 0 comments

Comments

@thim81
Copy link
Owner

thim81 commented Sep 6, 2024

use-case for better documentation, it is always advised to have "example" values per property and if possible "examples"

These are usefull for the consumers/users for your API, since they provide inline context and can be useful to provide context.

The example data generation could use:

  • Faker to generate some random data

OR

  • we could plugin an LLM to generate the example/examples based on the OpenAPI context.

Ideas:

@thim81 thim81 changed the title Format: Generate example/examples Format: Generate example/examples using Faker or AI LLM Sep 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant