{AzureConsumption} fixes Azure/azure-rest-api-specs#22446 tiny typo in description #22507
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
In the Usage Details - List documentation for the Consumption Api the "scope" parameter contains the following (reformatted for ease of reading):
Also, Modern Commerce Account scopes are:
'/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for billingAccount scope,
'/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope,
'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and
'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.
The uri templates in the last two patterns *don't" start with a forward slash.
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| consumption.json | 2021-10-01(f02cfc8) | 2021-10-01(main) |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2021-10 | package-2021-10(f02cfc8) | package-2021-10(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The get operation should only return 200. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L155 |
|
The get operation should only return 200. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L252 |
|
The resource name parameter 'budgetName' should be defined with a 'pattern' restriction. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L309 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L430 |
|
The get operation should only return 200. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L473 |
|
The resource name parameter 'billingPeriodName' should be defined with a 'pattern' restriction. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L629 |
|
The get operation should only return 200. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1113 |
|
Tracked resource 'ReservationRecommendationDetailsModel' must have patch operation that at least supports the update of tags. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1128 |
|
The tracked resource ReservationRecommendationDetailsModel does not have a corresponding put operation. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1128 |
|
The get operation should only return 200. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1182 |
|
The resource name parameter 'billingPeriodName' should be defined with a 'pattern' restriction. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1358 |
|
The response schema of operations API '/providers/Microsoft.Consumption/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1447 |
|
The resource name parameter 'billingPeriodName' should be defined with a 'pattern' restriction. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1512 |
|
The get operation should only return 200. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1842 |
|
The schema 'MeterDetails' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1856 |
|
'decimal' is not a known format. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1887 |
|
'decimal' is not a known format. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1893 |
|
The schema 'UsageDetailsListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1935 |
|
The schema 'LegacyUsageDetailProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L1973 |
|
'decimal' is not a known format. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L2058 |
|
'decimal' is not a known format. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L2064 |
|
'decimal' is not a known format. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L2070 |
|
'decimal' is not a known format. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L2076 |
|
'decimal' is not a known format. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L2197 |
|
The schema 'ModernUsageDetailProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L2246 |
|
'decimal' is not a known format. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L2257 |
|
'decimal' is not a known format. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L2356 |
|
'decimal' is not a known format. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L2372 |
|
'decimal' is not a known format. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L2378 |
|
'decimal' is not a known format. Location: Microsoft.Consumption/stable/2021-10-01/consumption.json#L2484 |
️️✔️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]
️️✔️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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
|
Hi, @navba-MSFT 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 Generation Artifacts
|
Generated ApiView
|
This was referenced Feb 8, 2023
alprosms
approved these changes
Feb 14, 2023
JeffreyRichter
added
the
Approved-BreakingChange
dw511214992
approved these changes
Feb 20, 2023
This was referenced Feb 20, 2023
aviyerMSFT
pushed a commit
to aviyerMSFT/azure-rest-api-specs
that referenced
this pull request
Mar 22, 2023
…22507) In the Usage Details - List documentation for the Consumption Api the "scope" parameter contains the following (reformatted for ease of reading): Also, Modern Commerce Account scopes are: '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for billingAccount scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners. The uri templates in the last two patterns *don't" start with a forward slash.
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.
fixes #22446
In the Usage Details - List documentation for the Consumption Api the "scope" parameter contains the following (reformatted for ease of reading):
Also, Modern Commerce Account scopes are:
'/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for billingAccount scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.
The uri templates in the last two patterns *don't" start with a forward slash.
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.