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

Improve OpenAPI documentation #2609

Open
holgerhagen opened this issue Jul 18, 2024 · 0 comments
Open

Improve OpenAPI documentation #2609

holgerhagen opened this issue Jul 18, 2024 · 0 comments

Comments

@holgerhagen
Copy link
Contributor

holgerhagen commented Jul 18, 2024

Areas for improvement

  • not all return codes are documented (actually just a few)
  • Are the listed return coded upfront still helpful (in combination with the bullet point above)
  • Sometimes the HATEOAS links look weird in the docs and blow the examples up.
  • make required values more visible
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

1 participant