Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Use standard Openapi service slugs for subcommands

Đang mở
  • Có gì không ổn?
#1 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
45/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
cli, openapi, rust
Lĩnh vực
cli

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

enhancement good first issue help wanted
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 ...
Ngôn ngữ chính
Rust
Star
19
Fork
0
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của openapi/openapi-cli

Tất cả issue của openapi/openapi-cli

Issue tương tự

Thêm issue về Rust

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.