-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Benefit Summaries Async #22497
Benefit Summaries Async #22497
Conversation
…son and appropriate examples.
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. vscswagger@microsoft.com |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
costmanagement.benefits.json | 2023-03-01(0165ec9) | 2022-10-01(main) |
️⚠️
LintDiff: 1 Warnings warning [Detail]
compared tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-2023-03 | package-2023-03(0165ec9) | package-2023-03(dev-cost-management-Microsoft.CostManagement-2023-03-01-stable) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json#L1545 |
The following errors/warnings exist before current PR submission:
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
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.
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
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 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
...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
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
...ent/resource-manager/Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json
Outdated
Show resolved
Hide resolved
...ent/resource-manager/Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json
Outdated
Show resolved
Hide resolved
...ent/resource-manager/Microsoft.CostManagement/stable/2023-03-01/costmanagement.benefits.json
Outdated
Show resolved
Hide resolved
…name to benefitAsyncOperationIdParameter
Hi, @MattEberhart-MSFTE. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
...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
Outdated
Show resolved
Hide resolved
… adding long running operation tag to error response
3aaa9f8
into
dev-cost-management-Microsoft.CostManagement-2023-03-01-stable
* 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 <92699124+alprosms@users.noreply.github.com> --------- Co-authored-by: alprosms <92699124+alprosms@users.noreply.github.com>
* 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 <92699124+alprosms@users.noreply.github.com> --------- Co-authored-by: alprosms <92699124+alprosms@users.noreply.github.com>
…rsion stable/2023-03-01 (#23892) * 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 * Matteberhart/merging main for readme (#23886) * 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 <92699124+alprosms@users.noreply.github.com> --------- Co-authored-by: alprosms <92699124+alprosms@users.noreply.github.com> * Adding x-ms-secret to the report urls (#23934) * Remove operation results (#23938) * Remove operation results * Removing examples * Using commony type error response (#23955) --------- Co-authored-by: alprosms <92699124+alprosms@users.noreply.github.com>
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
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.