-
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
[Hub Generated] Review request for Microsoft.Consumption to add version stable/2021-05-01 #13658
[Hub Generated] Review request for Microsoft.Consumption to add version stable/2021-05-01 #13658
Conversation
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. vsswagger@microsoft.com |
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Validation Report
|
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/2021-05-01/consumption.json#L1655 |
|
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/2021-05-01/consumption.json#L1752 |
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
Rule | Message |
---|---|
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/Microsoft.Consumption/aggregatedCost' Location: Microsoft.Consumption/stable/2021-05-01/consumption.json#L1557 |
R3030 - PathResourceProviderMatchNamespace |
The last resource provider 'Microsoft.Consumption, Microsoft.Billing' doesn't match the namespace. Location: Microsoft.Consumption/stable/2021-05-01/consumption.json#L36 |
R4011 - DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Consumption/stable/2021-05-01/consumption.json#L424 |
R4018 - 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/2021-05-01/consumption.json#L1477 |
Based on the response model schema, operation 'Charges_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Consumption/stable/2021-05-01/consumption.json#L480 |
|
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/2021-05-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/2021-05-01/consumption.json#L1707 |
|
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: Microsoft.Consumption/stable/2021-05-01/consumption.json#L2031 |
|
Guid used in model definition 'ModernUsageDetailProperties' 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: Microsoft.Consumption/stable/2021-05-01/consumption.json#L2259 |
|
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: Microsoft.Consumption/stable/2021-05-01/consumption.json#L2675 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌
Cross Version BreakingChange (Base on preview version): 40 Errors, 1 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.9)
- original: preview/2019-05-01-preview/consumption.json <---> new: stable/2021-05-01/consumption.json
Only 10 items are listed, please refer to log for more details.
️❌
Cross Version BreakingChange (Base on stable version): 5 Errors, 0 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.9)
- original: stable/2019-11-01/consumption.json <---> new: stable/2021-05-01/consumption.json
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
[Staging] SDK Track2 Validation: 2 Warnings warning [Detail]
- The following tags are being changed in this PR
- consumption/resource-manager/readme.md#package-2019-11
- consumption/resource-manager/readme.md#package-2019-10
- consumption/resource-manager/readme.md#package-2019-06
- consumption/resource-manager/readme.md#package-2019-05
- consumption/resource-manager/readme.md#package-preview-2019-05
- consumption/resource-manager/readme.md#package-preview-2019-04
- consumption/resource-manager/readme.md#package-preview-2018-11
- consumption/resource-manager/readme.md#package-2019-01
- consumption/resource-manager/readme.md#package-2017-11
- consumption/resource-manager/readme.md#package-2018-01
- consumption/resource-manager/readme.md#package-2018-03
- consumption/resource-manager/readme.md#package-2018-05
- consumption/resource-manager/readme.md#package-2018-06
- consumption/resource-manager/readme.md#package-2018-08
- consumption/resource-manager/readme.md#package-2018-10
- consumption/resource-manager/readme.md#package-2017-04-preview
- consumption/resource-manager/readme.md#package-2017-12-preview
- consumption/resource-manager/readme.md#package-2021-05
Rule | Message |
---|---|
"readme":"consumption/resource-manager/readme.md", "tag":"package-2021-05", "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-2021-05", "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" |
|
💬 AutorestCore/Exception | "readme":"consumption/resource-manager/readme.md", "tag":"package-2019-11", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)" |
💬 AutorestCore/Exception | "readme":"consumption/resource-manager/readme.md", "tag":"package-2019-11", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
💬 AutorestCore/Exception | "readme":"consumption/resource-manager/readme.md", "tag":"package-2021-05", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
💬 AutorestCore/Exception | "readme":"consumption/resource-manager/readme.md", "tag":"package-2021-05", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
"readme":"consumption/resource-manager/readme.md", "tag":"package-2019-11", "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-11", "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" |
|
"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" |
|
"readme":"consumption/resource-manager/readme.md", "tag":"package-preview-2018-11", "details":"Integer schema 'schemas:49' with unknown format: 'date-time' is not valid. Treating it as 'int32'." |
|
💬 AutorestCore/Exception | "readme":"consumption/resource-manager/readme.md", "tag":"package-2019-11", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
💬 AutorestCore/Exception | "readme":"consumption/resource-manager/readme.md", "tag":"package-2019-10", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
💬 AutorestCore/Exception | "readme":"consumption/resource-manager/readme.md", "tag":"package-2019-10", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
💬 AutorestCore/Exception | "readme":"consumption/resource-manager/readme.md", "tag":"package-2019-06", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
💬 AutorestCore/Exception | "readme":"consumption/resource-manager/readme.md", "tag":"package-2019-06", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
💬 AutorestCore/Exception | "readme":"consumption/resource-manager/readme.md", "tag":"package-2019-05", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
️️✔️
[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
Hi @karthikku-2020, Your PR has some issues. Please fix the CI sequentially by following the order of
|
The SystemData properties being metadata for a resource does not fit into the consumption RP APIs. The reason being the most of Consumption RP APIs dont really create any actual resources. The data that's being surfaced is only consumption data and the metadata we are talking about here will not be of any use for the customer. Also, the API aggregates the data from multiple sources and will be almost impossible to provide the SystemData properties for the operations in discussion here. |
@karthikku-2020 Please submit for lint suppression https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/85/Swagger-Suppression-Process |
@PhoenixHe-msft - Can please review suppression updates? |
…on stable/2021-05-01 (Azure#13658) * Adds base for updating Microsoft.Consumption from version stable/2019-11-01 to version 2021-05-01 * Updates readme * Updates API version in new specs and examples * Updates to Lots/Events * Lot source updated * Lot status updated * Lot source updated * prettier update * Events example file reference updated * Adding Lint Suppression * Update readme.md
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.