spec-first/connexion

Missing API documentation

Open

#1,885 建立於 2024年2月16日

在 GitHub 查看
 (2 留言) (0 反應) (0 負責人)Python (4,346 star) (738 fork)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
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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.