[Hub Generated] Review request for Microsoft.Consumption to add version stable/2019-10-01 #13402
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
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.Consumption/events' removed or restructured? Old: Microsoft.Consumption/stable/2019-10-01/consumption.json#L1599:5 |
|
The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.Consumption/lots' removed or restructured? Old: Microsoft.Consumption/stable/2019-10-01/consumption.json#L1650:5 |
|
The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.Consumption/credits/balanceSummary' removed or restructured? Old: Microsoft.Consumption/stable/2019-10-01/consumption.json#L1695:5 |
|
The new version is adding a path that was not found in the old version. New: Microsoft.Consumption/stable/2019-10-01/consumption.json#L1599:5 |
|
The new version is adding a path that was not found in the old version. New: Microsoft.Consumption/stable/2019-10-01/consumption.json#L1650:5 |
|
The new version is adding a path that was not found in the old version. New: Microsoft.Consumption/stable/2019-10-01/consumption.json#L1695:5 |
️⚠️LintDiff: 2 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.9.0 , classic-openapi-validator v1.1.6 )
- Linted configuring files (Based on target branch, openapi-validator v1.9.0 , classic-openapi-validator v1.1.6 )
| Rule | Message |
|---|---|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'EventsModel'. Consider using the plural form of 'Events' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Consumption/stable/2019-10-01/consumption.json#L1604 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'LotsModel'. Consider using the plural form of 'Lots' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Consumption/stable/2019-10-01/consumption.json#L1655 |
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Resource type naming must follow camel case. Path: '/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/Microsoft.Consumption/aggregatedCost' Location: azure-rest-api-specs/blob/d0a9a6e25985f06872332b81f6714975236cb409/undefined#Lundefined |
|
The last resource provider 'Microsoft.Consumption, Microsoft.Billing' doesn't match the namespace. Location: azure-rest-api-specs/blob/d0a9a6e25985f06872332b81f6714975236cb409/undefined#Lundefined |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: azure-rest-api-specs/blob/d0a9a6e25985f06872332b81f6714975236cb409/undefined#Lundefined |
|
The response schema of operations API '/providers/Microsoft.Consumption/operations' does not match the ARM specification. Please standardize the schema. Location: azure-rest-api-specs/blob/d0a9a6e25985f06872332b81f6714975236cb409/undefined#Lundefined |
| Based on the response model schema, operation 'Charges_List' might be pageable. Consider adding the x-ms-pageable extension. Location: azure-rest-api-specs/blob/d0a9a6e25985f06872332b81f6714975236cb409/undefined#Lundefined |
|
| Guid used in model definition 'LegacyUsageDetailProperties' for property 'meterId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: azure-rest-api-specs/blob/d0a9a6e25985f06872332b81f6714975236cb409/undefined#Lundefined |
|
| Guid used in model definition 'MarketplaceProperties' for property 'meterId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: azure-rest-api-specs/blob/d0a9a6e25985f06872332b81f6714975236cb409/undefined#Lundefined |
|
| Guid used in model definition 'LegacyReservationRecommendationProperties' for property 'meterId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: azure-rest-api-specs/blob/d0a9a6e25985f06872332b81f6714975236cb409/undefined#Lundefined |
|
| Guid used in model definition 'ModernReservationRecommendationProperties' for property 'meterId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: azure-rest-api-specs/blob/d0a9a6e25985f06872332b81f6714975236cb409/undefined#Lundefined |
|
| Guid used in model definition 'ModernReservationTransactionProperties' for property 'purchasingSubscriptionGuid'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: azure-rest-api-specs/blob/d0a9a6e25985f06872332b81f6714975236cb409/undefined#Lundefined |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️[Staging] SDK Track2 Validation: 0 Warnings warning [Detail]
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
| "readme":"consumption/resource-manager/readme.md", "tag":"package-2019-10", "details":"Schema 'ReservationRecommendationDetailsModel' has a property 'etag' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from ReservationRecommendationDetailsModel" |
|
| "readme":"consumption/resource-manager/readme.md", "tag":"package-2019-10", "details":"Schema 'LegacyReservationTransaction' has a property 'properties' that is already declared the parent schema 'ReservationTransaction' but isn't significantly different. The property has been removed from LegacyReservationTransaction" |
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
|
Hi, @karthikku-2020 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] |
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
BreakingChangeReviewRequired
and removed
CI-FixRequiredOnFailure
labels
|
NewApiVersionRequired reason: |
|
Hi @karthikku-2020, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Hi @karthikku-2020, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
This was referenced Mar 12, 2021
|
These were the Swagger "Completeness" issues that were reported for a specific version. And this PR is to address these issues. Can you I know why this is a breaking change? https://portal.azure-devex-tools.com/amekpis/completeness/detail?errorId=53EBA63F-287B-4F95-B1FF-5C845CBF4E66 |
|
Please fix the modelvalidation and prettier issue. For breaking change please submit for breaking change review. |
JeffreyRichter
added
the
Approved-BreakingChange
JeffreyRichter
approved these changes
Mar 18, 2021
@PhoenixHe-msft - The prettier check is fixed. However, the model validation appears to be a fix on the API side and not in the swagger spec. Please review and merge this PR asap. |
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
|
@karthikku-2020 Please suppress the model validation issue in readme.md or please fix the issue in example file. |
@PhoenixHe-msft Done! |
This was referenced Mar 25, 2021
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.
Changelog
Please ensure to add changelog with this PR by answering the following questions.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.