microsoft / microsoft/OpenAPI.NET.OData

Potential breaking changes in Graph PowerShell SDK due to change/rename of tags

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

Một pull request liên quan đã được merge.

  • #642 của @timayabi2020 — đã merge
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

Mô tả

The following tags are missing from the latest metadata for PowerShell.
users.Actions
users.Functions
deviceManagement.Functions
deviceManagement.Actions.

This means that if you try to slice the metadata using the above tags, the service will respond with a 404. e.g. https://devxapi-func-prod-eastus.azurewebsites.net/$openapi?tags=^users.Functions$&title=Users.Functions&openapiversion=3&style=Powershell&fileName=powershell_v2&graphVersion=v1.0&singularizeOperationIds=true.

Therefore, some paths that were assigned those tags, currently have new tags and this would potentially introduce breaking changes in the SDK.
Below is an example of before and after for one of the paths.
Before
Image

After
Image

The change will occur in terms of grouping of paths. e.g. Paths that used to appear under Users. Actions module are now appearing under Calendar module.

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

Bắt đầu bằng cách so sánh các tag users và deviceManagement trong metadata powershell_v2.yaml được liên kết với yêu cầu slicing $openapi được hiển thị trong issue, sau đó kiểm tra các nhóm path được tạo. Công việc được xem là hoàn tất khi các tag bị ảnh hưởng không còn trả về 404 và các path bị ảnh hưởng vẫn giữ cách nhóm tương thích với PowerShell SDK; hãy xem lại pull request #642 được liên kết để kiểm tra phần việc hiện 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ệ
csharp, openapi, powershell
Lĩnh vực
api, tooling
Loại issue
Lỗi
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
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
35/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.