[Feature Request] Standardize operationIds to ensure uniqueness
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
- 35/100
Hướng nghiên cứu
Bắt đầu với tệp được tham chiếu OpenAPIService/PowershellFormatter.cs và phần thảo luận được liên kết từ pull request 338 để hiểu các quy ước operationId hiện có. Theo dõi nơi các operationIds được tạo cho các đường dẫn OData, sau đó xác định điểm vào của quá trình xác thực tài liệu; hoàn tất nghĩa là các quy tắc đặt tên được yêu cầu đã được áp dụng và các operationIds trùng lặp bị từ chối.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
We should consider standardizing the naming convention of operationIds to what we currently have in DevX API (PowerShell style) - https://github.com/microsoftgraph/microsoft-graph-devx-api/blob/dev/OpenAPIService/PowershellFormatter.cs? For example:
- Remove hash suffix values from operationIds for
functionall paths. - Add '_' to separate verb (action) in an operationId. This typically the last
.or second from last.for OData cast paths. - PUT operations should have Set as the verb in an operationId
{xxx}_Set{yyy}.
In PowerShell, we use operationIds to form command names.
As part of this exercise, we should add validation to ensure operationIds are unique for a given document.
Edit: This is a continuation of https://github.com/microsoft/OpenAPI.NET.OData/pull/338#discussion_r1097802458.
- Ngôn ngữ chính
- C#
- Star
- 240
- Fork
- 70
- Merge trung bình
- 7 giờ 59 phút
- Pull request đã merge (30 ngày)
- 13
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của microsoft/OpenAPI.NET.OData
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
microsoft/OpenAPI.NET.OData#661 ·
-
Microsoft.OpenApi.OData.Reader.dll ships unversioned (0.0.0.0) since the 2026-01-16 releases Đang mở
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 58/100
microsoft/OpenAPI.NET.OData#852 ·
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 45/100
microsoft/OpenAPI.NET.OData#833 ·
-
status:needs-more-information
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 42/100
microsoft/OpenAPI.NET.OData#723 · 1 bình luận · 1 reaction ·
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 45/100
microsoft/OpenAPI.NET.OData#720 ·
Tất cả issue của microsoft/OpenAPI.NET.OData
Issue tương tự
-
CS0162 "Unreachable code detected" warning from a MSBuildTemp .tmp file in every game project Đang mởbug
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 90/100
-
Type: enhancement
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
apache/arrow-adbc#4809 ·
-
type/automation type/tech-debt
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
microsoft/vscode-azurefunctions#5197 · 1 bình luận ·
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 85/100
microsoft/microsoft-ui-reactor#1274 ·