spec-first/connexion

Missing API documentation

Open

#1885 opened on Feb 16, 2024

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (4,346 stars) (738 forks)batch import
PR welcomedocumentationgood first issue

Description

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

Contributor guide

Tech stack
pythonrest api
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Pythonfamiliarity with Connexion framework
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
To address this issue, generate API documentation for the Connexion library, particularly for validation classes and methods. Start by examining the source code structure in the connexion/ directory to identify public classes and functions that require docstrings. Then, use Sphinx with autodoc to extract docstrings and produce browsable HTML documentation. Ensure that the custom validator section includes code examples showing how to create a validator class. Refer to the existing documentation on readthedocs for style consistency.