Alprosms cost management microsoft.cost management 2023 04 01 preview#23795
Merged
alprosms merged 2 commits intodev-cost-management-Microsoft.CostManagement-2023-04-01-previewfrom May 3, 2023
Conversation
|
Hi, @alprosms 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.generatedetailedcostreport.json | 2023-04-01-preview(f6da4d1) | 2022-10-01(main) |
| costmanagement.generatedetailedcostreport.json | 2023-04-01-preview(f6da4d1) | 2020-12-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-preview-2023-04 | package-preview-2023-04(f6da4d1) | package-preview-2023-04(dev-cost-management-Microsoft.CostManagement-2023-04-01-preview) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
The parameters:operationId,scope should be kept in the same order as they present in the path. Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.generatedetailedcostreport.json#L123 |
|
The get operation should only return 200. Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.generatedetailedcostreport.json#L157 |
|
A 202 response should include an Location response header. Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.generatedetailedcostreport.json#L157 |
|
The parameters:operationId,scope should be kept in the same order as they present in the path. Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.generatedetailedcostreport.json#L170 |
|
The schema 'GenerateDetailedCostReportDefinition' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.generatedetailedcostreport.json#L224 |
|
The schema 'GenerateDetailedCostReportTimePeriod' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.generatedetailedcostreport.json#L257 |
|
The schema 'GenerateDetailedCostReportOperationStatuses' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.generatedetailedcostreport.json#L274 |
|
The schema 'GenerateDetailedCostReportOperationResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.generatedetailedcostreport.json#L312 |
|
The schema 'Status' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.generatedetailedcostreport.json#L334 |
| OperationId should contain the verb: 'generatedetailedcostreport' in:'GenerateDetailedCostReport_CreateOperation'. Consider updating the operationId Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.generatedetailedcostreport.json#L41 |
|
| The x-ms-long-running-operation-options should be specified explicitly to indicate the type of response header to track the async operation. Location: Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.generatedetailedcostreport.json#L123 |
️️✔️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
|
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @alprosms your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
|
Hi @alprosms, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the Swagger-Suppression-Process to get approval. |
This was referenced May 2, 2023
modikumar
approved these changes
May 2, 2023
sjanamma
reviewed
May 2, 2023
...oft.CostManagement/preview/2023-04-01-preview/costmanagement.generatedetailedcostreport.json
Show resolved
Hide resolved
sjanamma
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
nichaump
approved these changes
May 3, 2023
alprosms
merged commit fb6e27e
into
dev-cost-management-Microsoft.CostManagement-2023-04-01-preview
alprosms
deleted the
alprosms-cost-management-Microsoft.CostManagement-2023-04-01-preview
branch
ArcturusZhang
pushed a commit
that referenced
this pull request
May 4, 2023
) * Adds base for updating Microsoft.CostManagement from version stable/2022-10-01 to version 2023-04-01-preview * Updates readme * Updates API version in new specs and examples * Adding Budgets API translated from 2022-10-01 stable version of Micro… (#22866) * Adding Budgets API translated from 2022-10-01 stable version of Microsoft.Consumption/budgets * Updating api-version in examples to 2023-04-01-preview * Adding costmanagement.budgets.json to readme * Addressing Swagger LintDiff errors * Updating budget name pattern * Adding suppression for R4011 * Adding budget name pattern regex for only alphanumeric, underscore, or hyphen characters * fixing readme.go.md for budgets * removing "object" type from notifications dictionary keys * removing tags * removing mismatching enum values * updating notifications key type * Revert "updating notifications key type" This reverts commit eeb504b. * Revert "removing mismatching enum values" This reverts commit cba0132. * updates to enum name * Removing incorrect/outdated description info * fixing BudgetsList example * Updating example Ids to use Microsoft.CostManagement RP * updating min & max length of budget name per conversations with PMs * Adding suppressions for DeleteOperationResponses, TopLevelResourcesListBySubscription, and NoDuplicatePathsForScopeParameter * fixing indentation in readme * fixing formatting of suppressions in readme * Adding paging back in, specifying as null for future use * Adding support for RU Alerts in new Budgets API version (#23140) * Updating budgets swagger definition to include modifications from RU Alert category * Adding new examples for all scenarios of RU Alerts, added new examples for all scopes for Cost Budgets * Spelling & lintdiff fixes * prettier-fix * Added more descriptions, and some light markdown to larger descripitons * Addressing comments * prettier-fix * Updating description for amount property * addressing Shravan's offline comments * spell check * removing aws scopes from scope description * Addressing comments from internal review, removed legacy tags for EA * Alexprosak microsoft.cost management 2023 04 01 preview (#23362) * Updating readme default tag * specifiying the word "update" in 200 response for budget createorupdate * updating tags to package-preview-2023-04-01 * readme test * Revert "readme test" This reverts commit 566e2e6. * Revert "updating tags to package-preview-2023-04-01" This reverts commit f9cf3fe. * Updating readme with previous apis not included and updated to current version * Revert "Updating readme with previous apis not included and updated to current version" This reverts commit bb87946. * Alexprosak cost management microsoft.cost management 2023 04 01 preview (#23770) * changing azure-sdk-for-net to azure-sdk-for-net-track2 per ask from comment on main branch PR * Adding in descriptions + examples for RU Alerts support at the customer scope * fixing json formatting * fixing example references * Updating costmanagementproxyresource to reference ARM common proxy resource. Minor formatting change on scope parameter * Updating common-types with updates to common-types from 2022-10-01 version * prettier-fix * Alprosms cost management microsoft.cost management 2023 04 01 preview (#23795) * updating costdetailreport swaggers from recent changes to 2022-10-01 version * suppressing invalid LintDiff errors
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
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.