Investigate automatic singularization of function cmdlet nouns in the v3 generator

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

Maintainer thường phản hồi trong vòng 7 ngày

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
18/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
csharp
Lĩnh vực
cli, tooling

Hướng nghiên cứu

Start with the function-segment branch in tools/WrapperGenerator/CmdletNaming.cs, which adds the operation noun without the singularization applied to resource segments, and compare it with the Reports overrides in src/Reports/wrapper/Reports_cmdletConfigurations.cs. Survey how the v1.0 and beta naming data (parity-renames.v1.0.json and its beta counterpart) treat function nouns across the corpus. Done means a written rule or a list of deliberate exceptions, plus naming regression tests, and no change to the wire API, HTTP routes or builders.

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

Mô tả

Status: Needs Investigation type:investigation
Is your feature request related to a problem? Please describe the problem.

The v3 WrapperGenerator automatically singularizes resource path segments, but its action/function-segment branch adds the parsed operation noun directly, bypassing resource singularization. As a result, function-derived PowerShell nouns can retain plural endings unless an oracle-derived rename or curated module configuration corrects them.

Example from the Reports directive migration (#3870):

GET /reports/managedDeviceEnrollmentTopFailures()
Structural command: Get-MgReportManagedDeviceEnrollmentTopFailures
Intended command:   Get-MgReportManagedDeviceEnrollmentTopFailure

The existing shared Reports.md directive specifies the singular ReportManagedDeviceEnrollmentTopFailure noun. Before this migration, v1.0 already received that name from an explicit entry in parity-renames.v1.0.json, while beta retained the structural plural because the committed derived naming data is v1.0-only. The shared Reports configuration now preserves the intended singular name in both profiles.

Describe the solution you'd like.

Investigate whether function-derived cmdlet nouns should be singularized automatically, consistently with resource-derived nouns, rather than requiring individual overrides for cases such as TopFailures → TopFailure.

Determine the correct rule before implementing it:

  • Evaluate singularizing the appropriate noun portion of a function name, without rewriting the actual API function, HTTP route, Kiota builder, or wire parameters.
  • Review corpus-wide effects in both v1.0 and beta, including meaningful plural names, irregular nouns, acronyms, parameterized overload suffixes, and possible command-name collisions.
  • Check compatibility with published command names, shared AutoRest directive intent, and existing curated/oracle-derived overrides. Do not remove needed overrides merely because one example is addressed.
  • Add naming regression coverage and document any deliberate exceptions if a general rule is adopted.

This issue is investigation only, not approval for a naming sweep. Whether action names need a similar rule should be assessed separately rather than assumed.

Additional context?

Raised during review of #3870. The user noted that function nouns should probably be singularized automatically and requested an issue marked as needing investigation.

Relevant source at the reviewed Reports PR head:

No generator behavior or Reports configuration is changed as part of filing this issue.

Ngôn ngữ chính
C#
Star
911
Fork
236
Merge trung bình
9 ngày 18 giờ
Pull request đã merge (30 ngày)
33

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 microsoftgraph/msgraph-sdk-powershell

Tất cả issue của microsoftgraph/msgraph-sdk-powershell

Issue tương tự

Thêm issue về C#

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.