Use standard Openapi service slugs for subcommands
還沒有人認領這個 Issue。
評估
研究方向
Start by reading the CLI command definitions and how they map subcommands to OpenAPI services; the issue names no files or tests. Compare the existing subcommand names with the service slugs used in console URLs, then check the CLI help output and tests for the resulting command names. Done means each service uses its console slug as its subcommand, with aliases avoided unless needed.
由索引模型根據 Issue 內容生成。
描述
Description
Currently, subcommands within the CLI do not consistently follow a standardized naming convention. This can lead to confusion and friction when mapping CLI usage to official OpenAPI services.
We propose adopting slug-based subcommands aligned with the official OpenAPI service identifiers. These slugs are already used across OpenAPI platforms, particularly within the console portal URLs, and represent a well-established convention.
Proposal
Subcommands should use the same service slugs that are used in the OpenAPI console URLs.
For example:
- If a service is accessible via:
https://console.openapi.com/apis/<slug>/...
- Then the CLI subcommand should be:
$ openapi <slug> ...
This ensures a 1:1 mapping between CLI usage and official service naming, reducing cognitive overhead for developers.
Benefits
- ✅ Consistency with official OpenAPI ecosystem
- ✅ Easier discoverability and memorability
- ✅ Reduced need for documentation lookup
- ✅ Alignment between web console and CLI workflows
Additional Notes
- Slugs should be treated as stable identifiers.
- Avoid introducing aliases unless strictly necessary.
- Future services can be integrated seamlessly by reusing their existing slugs.
Example
If the console URL is:
https://console.openapi.com/apis/company/documentation
Then the corresponding CLI usage should be:
openapi company ...
- 主要語言
- Rust
- 星號
- 19
- 分支
- 0
- PR 合併指標
- 30 天內沒有已合併 PR
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 沒有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
openapi/openapi-cli 的其他 Issue
-
Support content negotiation via `Accept` header可能重新可做 @francescobianco 於 133 天前認領，目前沒有進行中的 PR。 未關閉enhancement
openapi/openapi-cli#3 · 已指派 1 人 ·
查看 openapi/openapi-cli 的全部 Issue
相似的 Issue
-
難度 2/5 1-3 小時 新手友好度 68/100
bytecodealliance/rustix#1703 ·
維護者通常 3 天內回覆
-
難度 2/5 1-3 小時 新手友好度 74/100
維護者通常 1 天內回覆
-
難度 1/5 1 小時以內 新手友好度 88/100
Pomax/vst-plugins#24 ·
維護者通常 1 天內回覆
-
V1 manifest lists written by Java lose added/existing/deleted file counts可能已有人在做 @kacper-li-airspace-intelligence 今天認領。 未關閉
難度 2/5 1-3 小時 新手友好度 72/100
apache/iceberg-rust#3445 ·
維護者通常 4 天內回覆
-
Slack integration: links on self-hosted domains never unfurl (parseCapShareUrl only accepts cap.so / cap.link)可能已有人在做 @mangeshraut712 今天認領。 未關閉bug
難度 2/5 1-3 小時 新手友好度 72/100
CapSoftware/Cap#2546 · 1 則留言 ·
維護者通常 1 天內回覆