Change operationId to more human friendly names
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 45/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- docker, openapi
- 领域
- api, documentation
调研方向
首先在 API 参考文档中定位 Swagger operationId 定义,并列出使用 HTTP 动词作为前缀的条目。按照 VolumesList 和 ContainerExec 示例移除动词并重命名,然后验证所有受影响的 operation ID 是否遵循相同的命名模式。
由索引模型根据 Issue 内容生成。
描述
Currently the operationId is using the HTTP verb as a prefix. This makes many of the names very awkward. We should change them to be more human readable:
GetVolumesList -> VolumesList
PostContainerExec -> ContainerExec
- 主要语言
- HTML
- 星标
- 3
- 派生
- 1
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
bfirsh/docker-api-reference 的其他 Issue
-
难度 3/5 1-2 天 新手友好度 30/100
-
难度 2/5 1-3 小时 新手友好度 20/100
-
难度 2/5 1-3 小时 新手友好度 45/100
-
难度 2/5 1-3 小时 新手友好度 35/100
-
难度 3/5 1-2 天 新手友好度 35/100
查看 bfirsh/docker-api-reference 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 78/100
polarsource/polar#15580 ·
维护者通常 1 天内回复
-
accepted bug via-triage
难度 2/5 1-3 小时 新手友好度 69/100
pingdotgg/t3code#20931 · 1 条评论 ·
维护者通常 1 天内回复
-
bug/1-unconfirmed kind/bug
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 87/100
plone/plone.scale#167 ·
-
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复