OAI / OAI/OpenAPI-Specification

More example `same hierarchy` in path templating

Đang mở
#2,015 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

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

clarification examples request matching
Ngôn ngữ chính
Markdown
Star
31.2k
Fork
9.2k
Merge trung bình
6 giờ 37 phút
Pull request đã merge (30 ngày)
27

Mô tả

We can't describe different templated name with same hierarchy.

Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical.

But I can't understand what the same hierarchy means.

We can't describe these path templates

  /pets/{petId}
  /pets/{name}

But we can describe these?

  /pets/{petId}
  /pets/{name}/hello

These depth of the hierarchy is different but these is different templated name in same depth of hierarchy.
When we get /pets/1/hello we can match bottom paths and name=1.
These is partially the same, but the whole is different.

So I want to add more example to this section.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

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.

Hướng nghiên cứu

Tìm phần trong đặc tả có chứa quy tắc được trích dẫn “same hierarchy” và đọc hướng dẫn xung quanh về việc tạo template cho đường dẫn. Thêm một ví dụ làm rõ tại sao /pets/{petId} và /pets/{name} xung đột với nhau, trong khi đường dẫn sâu hơn /pets/{name}/hello lại khác, sau đó kiểm tra rằng cách diễn đạt khớp với quy tắc.

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

Đánh giá

Công nghệ
openapi
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
55/100

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.