spec-first/connexion

Missing API documentation

Open

#1,885 opened on 2024年2月16日

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

説明

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

コントリビューターガイド

技術スタック
pythonrest api
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
fresh
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
basic Pythonfamiliarity with Connexion framework
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70
調査方針
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.
Missing API documentation · spec-first/connexion#1885 | Good First Issue