Add an OpenAPI/AsyncAPI ecosystem profile
維護者通常 1 天內回覆
還沒有人認領這個 Issue。
評估
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 新手友好度
- 55/100
研究方向
Read the existing ecosystem profile and contract tests, especially project_validator/ecosystems/ modules, tests/test_go.py, and tests/test_ecosystem_contract.py; inspect fixture layouts in tests/support.py. Implement and register the profile in project_validator/ecosystems/openapi.py, then update fixtures, profile tests, snapshots, and the README “Applies to” column. Done when the well configured fixture passes applicable checks and the bare fixture passes none of this ecosystem’s practices.
由索引模型根據 Issue 內容生成。
描述
Profile
Recognised by intent (#63): a top-level openapi: or asyncapi: key in a YAML or JSON file. Supplies the schema practices from #85.
| Practice | Rule for this ecosystem |
|---|---|
schema-declared |
the openapi / asyncapi version is 3.0 or later (3.1 for full JSON Schema), and info.version is set |
schema-validation |
CI lints the description: spectral (.spectral.yaml), redocly lint, vacuum |
schema-examples |
operations have examples, and CI checks them (spectral's oas3-valid-*-example rules) or runs contract tests (schemathesis, dredd) |
schema-compatibility |
CI checks for breaking changes: oasdiff breaking, openapi-diff |
Definition of done
- One profile module,
project_validator/ecosystems/openapi.py, registered inBUILT_IN. Nothing inproject_validator/checks/changes: a row marked later belongs to a check that does not exist yet and is recorded on that check's issue. tests/fixtures/well_configured_openapipasses every check that applies to it, andtests/fixtures/bare_openapipasses none of the ecosystem's practices (tests/test_ecosystem_contract.py). Snapshots recorded withUPDATE_SNAPSHOTS=1.- A project layout in
tests/support.py, profile tests liketests/test_go.py, and the README "Applies to" column (tests/test_documentation.py). - A practice with no good evidence for this ecosystem is left out (the check reports
SKIP) rather than judged by weak evidence.
- 主要語言
- Python
- 星號
- 4
- 分支
- 1
- 平均合併
- 10 小時 41 分鐘
- 30 天內合併 PR
- 79
環境準備
這個專案沒有提供開發容器、Dockerfile 或貢獻指南，環境需要你自己搭建：先看它的 README，通用步驟見我們的新手貢獻指南。
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
cpp-best-practices/project_validator 的其他 Issue
-
難度 2/5 1-3 小時 新手友好度 62/100
cpp-best-practices/project_validator#267 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 68/100
cpp-best-practices/project_validator#263 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 62/100
cpp-best-practices/project_validator#260 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 74/100
cpp-best-practices/project_validator#259 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 65/100
cpp-best-practices/project_validator#255 ·
維護者通常 1 天內回覆
查看 cpp-best-practices/project_validator 的全部 Issue
相似的 Issue
-
documentation type/bug
難度 2/5 1-3 小時 新手友好度 78/100
維護者通常 1 天內回覆
-
難度 1/5 1 小時以內 新手友好度 65/100
StevenBlack/hosts#3299 ·
-
`garak --report` overwrites the input report when its name has no ".report"可能已有人在做 @0z5a 今天認領。 未關閉needs-triage
難度 2/5 半天 新手友好度 72/100
維護者通常 2 天內回覆
-
trace: Pi's 1-hour cache writes are priced at 1.25x, but billed at 2x可能已有人在做 @Shizoqua 今天認領。 未關閉
難度 2/5 1-3 小時 新手友好度 82/100
microsoft/TokenEconomizer#221 ·
維護者通常 1 天內回覆
-
plot_graph crashes when a mesh node has no m2m edge可能已有人在做 @tygvi 今天認領。 未關閉
難度 2/5 1-3 小時 新手友好度 78/100
mllam/neural-lam#883 · 1 則留言 ·
維護者通常 2 天內回覆