[Schema Inaccuracy] Wordy Plan availability prefix in branch protection endpoint descriptions
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 48/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 冷清
- 技术栈
- openapi
- 领域
- api, documentation
调研方向
在 OpenAPI 描述中搜索 /repos/{owner}/{repo}/branches/{branch}/protection 的操作以及重复出现的计划可用性句子。检查这 34 个描述的结构，然后确定这些信息约定的放置位置或复用方式。当每个 endpoint 的功能描述都很突出，并且可用性说明不再被不必要地重复时，即视为完成。
由索引模型根据 Issue 内容生成。
描述
Schema Inaccuracy
I’ve noticed that the documentation for the /repos/{owner}/{repo}/branches/{branch}/protection endpoints is a bit difficult to read. Currently, 34 different descriptions begin with a boilerplate sentence regarding plan availability:
"Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server."
The actual functional description of the endpoint is buried after this paragraph, which makes it hard to quickly understand what each specific operation does when browsing the spec.
Expected
The documentation could emhpasize the functional description of the endpoint. If the plan availability information is necessary, it would be much more readable if it were:
- Moved to the end of the description.
- Included as a "Note" or metadata field.
- Defined once at the top-level "Branch Protection" category rather than repeated for every sub-operation.
- 主要语言
- 没有语言数据
- 星标
- 1.6k
- 派生
- 342
- 平均合并
- 3 小时 33 分钟
- 30 天内合并 PR
- 51
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
github/rest-api-description 的其他 Issue
-
feature
难度 2/5 1-3 小时 新手友好度 82/100
github/rest-api-description#7201 ·
-
feature
难度 2/5 1-3 小时 新手友好度 72/100
github/rest-api-description#7163 ·
-
feature
难度 2/5 1-3 小时 新手友好度 68/100
github/rest-api-description#7162 ·
-
feature
难度 2/5 1-3 小时 新手友好度 68/100
github/rest-api-description#7135 ·
-
feature
难度 2/5 1-3 小时 新手友好度 74/100
github/rest-api-description#7111 · 1 条评论 ·
查看 github/rest-api-description 的全部 Issue
相似的 Issue
-
area/sessions comp/cron comp/gateway P2 sweeper:risk-message-delivery sweeper:risk-session-state type/bug
难度 2/5 1-3 小时 新手友好度 78/100
NousResearch/hermes-agent#118863 ·
-
难度 2/5 1-3 小时 新手友好度 76/100
-
难度 2/5 1-3 小时 新手友好度 78/100
use-agent-os/agent-os#3312 ·
-
难度 2/5 1-3 小时 新手友好度 85/100
-
needs-acceptance wg/data-plane-networking
难度 2/5 1-3 小时 新手友好度 78/100
vllm-project/semantic-router#4024 · 1 条评论 ·