spec-first
Missing API documentation
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
- Visit the documentation on readthedocs
- Look for API documentation
- Fail to find it
Additional info:
N/A
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.
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.