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

Missing API documentation #1885

Open
mivade opened this issue Feb 16, 2024 · 2 comments
Open

Missing API documentation #1885

mivade opened this issue Feb 16, 2024 · 2 comments
Labels
documentation good first issue PR welcome We would welcome and review a PR addressing this issue

Comments

@mivade
Copy link

mivade commented Feb 16, 2024

Description

I was trying to understand how I can customize request body validation but as far as I can tell the docs, while generally very good about describing how to use Connexion, do not appear to contain actual API documentation. In particular the section on custom validators shows how to configure what validator to use but not how to create a custom validator.

Expected behavior

Classes and methods should have browsable API documentation without the need to navigate through Connexion's code itself.

Actual behavior

No API documentation appears to exist.

Steps to reproduce

  1. Visit the documentation on readthedocs
  2. Look for API documentation
  3. Fail to find it

Additional info:

N/A

@RobbeSneyders
Copy link
Member

Hi @mivade,

We do have some API documentation embedded throughout the docs. Eg. within the spoilers on this page.

For the abstract validators they're indeed missing though, while I agree they would be useful.

@RobbeSneyders RobbeSneyders added documentation good first issue PR welcome We would welcome and review a PR addressing this issue labels Feb 17, 2024
@mivade
Copy link
Author

mivade commented Feb 19, 2024

We do have some API documentation embedded throughout the docs. Eg. within the spoilers on this page.

Honestly I hadn't even noticed that. It may be a personal preference but I think having API documentation in a separate part of the documentation makes it a bit more discoverable.

@mivade mivade changed the title No API documentation Missing API documentation Feb 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation good first issue PR welcome We would welcome and review a PR addressing this issue
Projects
None yet
Development

No branches or pull requests

2 participants