[Hub Generated] Review request for Microsoft.CostManagement to add version stable/2023-03-01 #23892
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…022-10-01 to version 2023-03-01
* Adds base for updating Microsoft.CostManagement from version stable/2022-10-01 to version 2023-03-01 * Updates readme * Updates API version in new specs and examples * Benefit Summaries Async (#22497) * Added benefit utilizaiton summaries APIs to costmanagement.benefits.json and appropriate examples. * Added report schema and secondary url * Prettier check and spelling error fix * Addressed BenefitKind / Kind in the csv schema and changed parameter name to benefitAsyncOperationIdParameter * Replacing included quantity * Alphabetized the parameters * Changing request body BenefitKind property to Kind * Adding 200 repsonse to generate api and fixing linter warnings * Adding examples to generate api * Making status optional for running scenario * Changing to completed to have all properties in generate examples and adding long running operation tag to error response * LRO Error response * LRO lint diff error still present. * Found all diffs in 2022-10-01 version added since branching (#23590) * Found all diffs in 2022-10-01 version added since branching * Fixing examples ruined by updating. Pulled straight from 2022-10-01 * Changed enum name (#23605) * Changing code of ErrorDetails object back to a string (#23734) * cost details report operation results example needs string error code (#23742) * Cherry picked commit causing conflict in readme (#23817) Co-authored-by: alprosms <[email protected]> --------- Co-authored-by: alprosms <[email protected]>
|
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 |
|---|---|---|
| common-types.json | 2023-03-01(93eab54) | 2022-10-01(main) |
| common-types.json | 2023-03-01(93eab54) | 2022-10-05-preview(main) |
| costmanagement.benefits.json | 2023-03-01(93eab54) | 2022-10-01(main) |
| costmanagement.exports.json | 2023-03-01(93eab54) | 2022-10-01(main) |
| costmanagement.exports.json | 2023-03-01(93eab54) | 2020-12-01-preview(main) |
| costmanagement.generatecostdetailsreport.json | 2023-03-01(93eab54) | 2022-10-01(main) |
| costmanagement.generatedetailedcostreport.json | 2023-03-01(93eab54) | 2022-10-01(main) |
| costmanagement.generatedetailedcostreport.json | 2023-03-01(93eab54) | 2020-12-01-preview(main) |
| costmanagement.json | 2023-03-01(93eab54) | 2022-10-01(main) |
| costmanagement.json | 2023-03-01(93eab54) | 2022-10-05-preview(main) |
| costmanagement.pricesheets.json | 2023-03-01(93eab54) | 2022-10-01(main) |
| costmanagement.pricesheets.json | 2023-03-01(93eab54) | 2022-02-01-preview(main) |
| scheduledActions.json | 2023-03-01(93eab54) | 2022-10-01(main) |
| scheduledActions.json | 2023-03-01(93eab54) | 2022-06-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
| Rule | Message |
|---|---|
| The '$ref' property points to different models in the old and new versions. New: common-types/resource-management/v5/types.json#L307:9 Old: Microsoft.CostManagement/stable/2022-10-01/common-types.json#L78:9 |
The following breaking changes are detected by comparison with the latest preview version:
Only 27 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 11 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.1) | new version | base version |
|---|---|---|
| package-2023-03 | package-2023-03(93eab54) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
The following errors/warnings exist before current PR submission:
Only 27 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Operations API path must follow the schema provided in the common types. Location: Microsoft.CostManagement/stable/2023-03-01/common-types.json#L57 |
|
'decimal' is not a known format. Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L812 |
|
'decimal' is not a known format. Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L882 |
|
'decimal' is not a known format. Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L914 |
|
'decimal' is not a known format. Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L920 |
|
'decimal' is not a known format. Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L926 |
|
'decimal' is not a known format. Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L932 |
|
'decimal' is not a known format. Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L938 |
|
'decimal' is not a known format. Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L945 |
|
'decimal' is not a known format. Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L951 |
|
'decimal' is not a known format. Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L957 |
|
'decimal' is not a known format. Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L963 |
|
'decimal' is not a known format. Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L1221 |
|
'decimal' is not a known format. Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L1255 |
|
'decimal' is not a known format. Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L1261 |
|
'decimal' is not a known format. Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L1267 |
|
Path '/{scope}/providers/Microsoft.CostManagement/exports/{exportName}' with explicitly defined scope is a duplicate of path '/{scope}/providers/Microsoft.CostManagement/exports' that has the scope parameter.'. Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.exports.json#L36 |
|
Path '/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/run' with explicitly defined scope is a duplicate of path '/{scope}/providers/Microsoft.CostManagement/exports' that has the scope parameter.'. Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.exports.json#L36 |
|
Path '/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/runHistory' with explicitly defined scope is a duplicate of path '/{scope}/providers/Microsoft.CostManagement/exports' that has the scope parameter.'. Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.exports.json#L36 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.exports.json#L84 |
|
Path '/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/run' with explicitly defined scope is a duplicate of path '/{scope}/providers/Microsoft.CostManagement/exports/{exportName}' that has the scope parameter.'. Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.exports.json#L97 |
|
Path '/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/runHistory' with explicitly defined scope is a duplicate of path '/{scope}/providers/Microsoft.CostManagement/exports/{exportName}' that has the scope parameter.'. Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.exports.json#L97 |
|
The resource name parameter 'exportName' should be defined with a 'pattern' restriction. Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.exports.json#L97 |
|
Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.exports.json#L127 |
|
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.exports.json#L209 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.exports.json#L270 |
|
Path '/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/runHistory' with explicitly defined scope is a duplicate of path '/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/run' that has the scope parameter.'. Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.exports.json#L283 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 56 Errors, 0 Warnings failed [Detail]
Tag package-2023-03; Prod region: Deployed
Test run on region: westcentralus; Operation coverage: total: 57, untested: 0, failed: 52, passed: 5
Service API Readiness Test failed. Check pipeline artifact for detail report.
Only 27 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider. Source: runtime OperationId: ScheduledActions_CheckNameAvailabilityByScope |
|
statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider. Source: runtime OperationId: Exports_CreateOrUpdate |
|
statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider. Source: runtime OperationId: Exports_List |
|
statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider. Source: runtime OperationId: Exports_Get |
|
statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider. Source: runtime OperationId: Exports_GetExecutionHistory |
|
statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider. Source: runtime OperationId: Exports_Execute |
|
statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider. Source: runtime OperationId: ScheduledActions_CreateOrUpdateByScope |
|
statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider. Source: runtime OperationId: ScheduledActions_GetByScope |
|
statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider. Source: runtime OperationId: ScheduledActions_ListByScope |
|
statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider. Source: runtime OperationId: ScheduledActions_RunByScope |
|
statusCode: 400, errorCode: MultipleErrors, errorMessage: Multiple errors have occurred. Please see inner errors for details. Source: runtime OperationId: ScheduledActions_CreateOrUpdate |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The private scheduled action 'name082lss' was not found. Source: runtime OperationId: ScheduledActions_Get |
|
statusCode: 404, errorCode: ResourceNotFound, errorMessage: The private scheduled action 'name082lss' was not found. Source: runtime OperationId: ScheduledActions_Run |
|
statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider. Source: runtime OperationId: Views_CreateOrUpdateByScope |
|
statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider. Source: runtime OperationId: Views_ListByScope |
|
statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider. Source: runtime OperationId: Views_GetByScope |
|
Enum does not match case for: True Source: response OperationId: Views_CreateOrUpdate |
|
Enum does not match case for: True Source: response OperationId: Views_Get |
|
statusCode: 401, errorCode: 401, errorMessage: Caller is not authorized Source: runtime OperationId: BenefitUtilizationSummaries_ListByBillingProfileId |
|
statusCode: 401, errorCode: 401, errorMessage: Caller is not authorized Source: runtime OperationId: BillingProfileScope_GenerateBenefitUtilizationSummariesReport |
|
statusCode: 401, errorCode: 401, errorMessage: Caller is not authorized Source: runtime OperationId: GenerateReservationDetailsReport_ByBillingProfileId |
|
statusCode: 401, errorCode: 401, errorMessage: Caller is not authorized Source: runtime OperationId: BenefitUtilizationSummaries_ListByBillingAccountId |
|
statusCode: 401, errorCode: 401, errorMessage: Caller is not authorized Source: runtime OperationId: BillingAccountScope_GenerateBenefitUtilizationSummariesReport |
|
statusCode: 401, errorCode: 401, errorMessage: Caller is not authorized Source: runtime OperationId: GenerateReservationDetailsReport_ByBillingAccountId |
|
statusCode: 500, errorCode: 500, errorMessage: An exception occurred during processing the request. Use this request id 'cdf930c7-754c-43ed-8056-eeac730a53b2' for follow-up. Source: runtime OperationId: PriceSheet_Download |
|
String does not match pattern ([A-Za-z0-9]+(-[A-Za-z0-9]+)+):([A-Za-z0-9]+(-[A-Za-z0-9]+)+)_[0-9]{4}-[0-9]{2}-[0-9]{2}: billingajs8mp9 Source: request OperationId: PriceSheet_Download |
|
String does not match pattern ([A-Za-z0-9]+(-[A-Za-z0-9]+)+): billingp6m5jbe Source: request OperationId: PriceSheet_Download |
️️✔️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
|
AzureRestAPISpecReview
added
ARMReview
new-api-version
ReadyForApiTest
|
Hi, @MattEberhart-MSFTE your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
|
Previously I had this PR which had all breaking changes approvals and ARM approvals. #23514 I ran into a merge conflict and had to create a new dev branch. I branched from the linked PR branch, merged main, resolved conflicts, and checked that branch into this dev branch. |
tadelesh
added
the
Approved-SdkBreakingChange-Go
|
@pilor FYI, this is another API that proposes to have a response schema for 200 OK, after POST -> 202 Accepted. |
...ent/resource-manager/Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json
Show resolved
Hide resolved
...ent/resource-manager/Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json
Show resolved
Hide resolved
TimLovellSmith
added
the
ARMChangesRequested
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
MattEberhart-MSFTE
added
the
WaitForARMFeedback
openapi-workflow-bot
bot
removed
the
ARMChangesRequested
|
Hi @MattEberhart-MSFTE, Your PR has some issues. Please fix the CI sequentially by following the order of
|
TimLovellSmith
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
* Remove operation results * Removing examples
|
@MattEberhart-MSFTE can you fix the LintDiff error listed on above bot comment? |
ankhyk
added
the
Approved-OkToMerge
haolingdong-msft
approved these changes
May 16, 2023
ArcturusZhang
deleted the
dev-cost-management-Microsoft.CostManagement-2023-03-01-stable-3
branch
This was referenced May 16, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.