-
Notifications
You must be signed in to change notification settings - Fork 5.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Rename operation #24036
Rename operation #24036
Conversation
Hi, @MattEberhart-MSFTE Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
costmanagement.benefits.json | 2023-03-01(036701d) | 2023-03-01(main) |
Rule | Message |
---|---|
1008 - ModifiedOperationId |
The operation id has been changed from 'BillingAccountScope_GenerateBenefitUtilizationSummariesReport' to 'GenerateBenefitUtilizationSummariesReport_GenerateByBillingAccount'. This will impact generated code. New: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L319:7 Old: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L319:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'BillingProfileScope_GenerateBenefitUtilizationSummariesReport' to 'GenerateBenefitUtilizationSummariesReport_GenerateByBillingProfile'. This will impact generated code. New: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L385:7 Old: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L385:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'ReservationOrderScope_GenerateBenefitUtilizationSummariesReport' to 'GenerateBenefitUtilizationSummariesReport_GenerateByReservationOrderId'. This will impact generated code. New: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L454:7 Old: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L454:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'ReservationScope_GenerateBenefitUtilizationSummariesReport' to 'GenerateBenefitUtilizationSummariesReport_GenerateByReservationId'. This will impact generated code. New: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L520:7 Old: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L520:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'SavingsPlanOrderScope_GenerateBenefitUtilizationSummariesReport' to 'GenerateBenefitUtilizationSummariesReport_GenerateBySavingsPlanOrderId'. This will impact generated code. New: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L589:7 Old: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L589:7 |
1008 - ModifiedOperationId |
The operation id has been changed from 'SavingsPlanScope_GenerateBenefitUtilizationSummariesReportAsync' to 'GenerateBenefitUtilizationSummariesReportAsync_GenerateBySavingsPlanId'. This will impact generated code. New: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L655:7 Old: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L655:7 |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 6 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.2) | new version | base version |
---|---|---|
package-2023-03 | package-2023-03(036701d) | package-2023-03(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
OperationId should contain the verb: 'generatebenefitutilizationsummariesreport' in:'GenerateBenefitUtilizationSummariesReport_GenerateByBillingAccount'. Consider updating the operationId Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L323 |
||
OperationId should contain the verb: 'generatebenefitutilizationsummariesreport' in:'GenerateBenefitUtilizationSummariesReport_GenerateByBillingProfile'. Consider updating the operationId Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L389 |
||
OperationId should contain the verb: 'generatebenefitutilizationsummariesreport' in:'GenerateBenefitUtilizationSummariesReport_GenerateByReservationOrderId'. Consider updating the operationId Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L458 |
||
OperationId should contain the verb: 'generatebenefitutilizationsummariesreport' in:'GenerateBenefitUtilizationSummariesReport_GenerateByReservationId'. Consider updating the operationId Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L524 |
||
OperationId should contain the verb: 'generatebenefitutilizationsummariesreport' in:'GenerateBenefitUtilizationSummariesReport_GenerateBySavingsPlanOrderId'. Consider updating the operationId Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L593 |
||
OperationId should contain the verb: 'generatebenefitutilizationsummariesreport' in:'GenerateBenefitUtilizationSummariesReportAsync_GenerateBySavingsPlanId'. Consider updating the operationId Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L659 |
The following errors/warnings exist before current PR submission:
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️
~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
CadlAPIView succeeded [Detail] [Expand]
️️✔️
TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️
CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️
TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
Hi @MattEberhart-MSFTE, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
Choose a PR Template
Switch to "Preview" on this description then select one of the choices below.
Click here to open a PR for a Data Plane API.
Click here to open a PR for a Control Plane (ARM) API.
Selecting template is not working.
The issue is with operation ids as is, each scope appears in our documentation with the API as a drop down rather than a single API with multiple scopes in a drop down.
Screenshot below marks an existing API acting as expected in green and the new API to be changed in this PR in orange
