Ramldoc: opt out of inherited path parameters in resources
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 功能
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- kotlin
- 领域
- documentation, tooling
调研方向
从 rmf-codegen 中的 ramldoc 生成步骤开始，检查 Smoke test API 定义的根 RAML 参数如何被扁平化到端点文档中。比较针对继承路径参数的默认 opt-out 与可配置的 blacklist；完成后应确立一种有文档说明的行为，避免重复共享参数。
由索引模型根据 Issue 内容生成。
描述
We've arrived in the tuning phase of the documentation generator that is based on rmf-codegen. In our Smoke test API definitions we realized that we have three path parameters that are all identical in 100% of the API endpoints (region, cloud provider, project key).
Since rmf-codegen is so perfect in flattening the effective API definition of an endpoint, the API documentation lists these three parameters over and over and over again.
We'd like to avoid hacking it out again and think the "ramldoc" generation step is the right one to decide whether to fully flatten everything or whether to selectively define some things as documented centrally. A simple default could be to not flatten all base URI parameters that are defined in the root RAML api file. Simply passing a blacklist would do the job, too though.
Any ideas whether this is realistic and could be doable?
- 主要语言
- Kotlin
- 星标
- 16
- 派生
- 7
- 平均合并
- 1 天 3 小时
- 30 天内合并 PR
- 3
环境准备
我们还没有检查这个项目的环境配置文件。先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
commercetools/rmf-codegen 的其他 Issue
-
难度 4/5 3-5 天 新手友好度 35/100
commercetools/rmf-codegen#333 · 1 条评论 ·
-
难度 3/5 1-2 天 新手友好度 45/100
commercetools/rmf-codegen#323 ·
-
难度 3/5 1-2 天 新手友好度 48/100
commercetools/rmf-codegen#313 · 2 条评论 ·
-
难度 5/5 一周以上 新手友好度 25/100
commercetools/rmf-codegen#306 · 5 条评论 ·
-
难度 4/5 3-5 天 新手友好度 40/100
commercetools/rmf-codegen#295 ·
查看 commercetools/rmf-codegen 的全部 Issue
相似的 Issue
-
OAI-PMH
难度 2/5 1-3 小时 新手友好度 78/100
-
难度 2/5 1-3 小时 新手友好度 90/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 86/100
TeamAmaze/AmazeFileManager#4731 ·
-
Bug Needs review
难度 2/5 1-3 小时 新手友好度 70/100
breezy-weather/breezy-weather#2978 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 92/100
AAswordman/Operit#1292 ·
维护者通常 1 天内回复