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

Ramldoc: opt out of inherited path parameters in resources

Đang mở
  • Có gì không ổn?
#159 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ó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
kotlin
Lĩnh vực
documentation, tooling

Hướng nghiên cứu

Bắt đầu từ bước tạo ramldoc trong rmf-codegen và kiểm tra cách các tham số RAML gốc của các định nghĩa API của Smoke test được làm phẳng thành tài liệu endpoint. So sánh một opt-out mặc định cho các tham số đường dẫn được kế thừa với một blacklist có thể cấu hình; kết quả cần thiết lập một hành vi được ghi lại, tránh lặp lại các tham số dùng chung.

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

Mô tả

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?

Ngôn ngữ chính
Kotlin
Star
16
Fork
7
Merge trung bình
1 ngày 3 giờ
Pull request đã merge (30 ngày)
3

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

Chúng tôi chưa kiểm tra các tệp thiết lập môi trường của dự án này. Hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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 commercetools/rmf-codegen

Tất cả issue của commercetools/rmf-codegen

Issue tương tự

Thêm issue về Kotlin

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.