-
Notifications
You must be signed in to change notification settings - Fork 5.3k
[Hub Generated] Review request for Microsoft.Consumption to add version stable/2023-03-01 #23264
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
[Hub Generated] Review request for Microsoft.Consumption to add version stable/2023-03-01 #23264
Conversation
…-09-01 to version 2023-03-01
#22963) * Added RI Tranastions query parameters to billing account scope. Updated example. Added documentation around size response limit * Ran prettify and fixed typo * Adding suppression for valid formats
Hi, @thramu 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 |
---|---|---|
consumption.json | 2023-03-01(f6d05f8) | 2022-09-01(main) |
consumption.json | 2023-03-01(f6d05f8) | 2019-05-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 4 Warnings warning [Detail]
compared tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-2023-03 | package-2023-03(f6d05f8) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L5197 |
||
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L5335 |
||
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L5402 |
||
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L5973 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
GetOperation200 |
The get operation should only return 200. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L155 |
GetOperation200 |
The get operation should only return 200. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L252 |
ResourceNameRestriction |
The resource name parameter 'budgetName' should be defined with a 'pattern' restriction. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L309 |
DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L430 |
GetOperation200 |
The get operation should only return 200. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L473 |
ResourceNameRestriction |
The resource name parameter 'billingPeriodName' should be defined with a 'pattern' restriction. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L629 |
GetOperation200 |
The get operation should only return 200. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L1113 |
TrackedResourcePatchOperation |
Tracked resource 'ReservationRecommendationDetailsModel' must have patch operation that at least supports the update of tags. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L1128 |
TrackedResourcesMustHavePut |
The tracked resource ReservationRecommendationDetailsModel does not have a corresponding put operation. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L1128 |
GetOperation200 |
The get operation should only return 200. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L1182 |
ResourceNameRestriction |
The resource name parameter 'billingPeriodName' should be defined with a 'pattern' restriction. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L1364 |
OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.Consumption/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L1453 |
ResourceNameRestriction |
The resource name parameter 'billingPeriodName' should be defined with a 'pattern' restriction. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L1518 |
GetOperation200 |
The get operation should only return 200. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L1848 |
MissingTypeObject |
The schema 'MeterDetails' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L1862 |
MissingTypeObject |
The schema 'UsageDetailsListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L1941 |
MissingTypeObject |
The schema 'LegacyUsageDetailProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L1979 |
MissingTypeObject |
The schema 'ModernUsageDetailProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L2252 |
MissingTypeObject |
The schema 'ReservationSummariesListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L2998 |
MissingTypeObject |
The schema 'ReservationSummaryProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L3016 |
MissingTypeObject |
The schema 'ReservationDetailsListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L3123 |
MissingTypeObject |
The schema 'ReservationDetailProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L3141 |
MissingTypeObject |
The schema 'ReservationRecommendationDetailsProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L3229 |
MissingTypeObject |
The schema 'ReservationRecommendationDetailsCalculatedSavingsProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L3264 |
MissingTypeObject |
The schema 'ReservationRecommendationDetailsResourceProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L3303 |
MissingTypeObject |
The schema 'ReservationRecommendationDetailsSavingsProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L3341 |
MissingTypeObject |
The schema 'ReservationRecommendationDetailsUsageProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L3380 |
MissingTypeObject |
The schema 'ReservationRecommendationsListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L3413 |
MissingTypeObject |
The schema 'SkuProperty' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L3610 |
MissingTypeObject |
The schema 'ModernReservationTransactionProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2023-03-01/consumption.json#L3777 |
️️✔️
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.
Swagger Generation Artifacts
|
Generated ApiView
|
Hi @thramu, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the Swagger-Suppression-Process to get approval. |
Approved this PR as it's the replacement of previous PR to resolve conflicts. Review was done in previous PR and was ready to merge. |
…on stable/2023-03-01 (Azure#23264) * Adds base for updating Microsoft.Consumption from version stable/2022-09-01 to version 2023-03-01 * Updates readme * Updates API version in new specs and examples * Adding new API version contract changes to 2023-03-01 (Azure#22644) * Added RI Tranastions query parameters to billing account scope. Updat… (Azure#22963) * Added RI Tranastions query parameters to billing account scope. Updated example. Added documentation around size response limit * Ran prettify and fixed typo * Adding suppression for valid formats * Single directives (Azure#23014) --------- Co-authored-by: MattEberhart-MSFTE <[email protected]>
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.