S360 issue: Adding missing properties in Recommendations API
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:
- What's the purpose of the update?
- [ ] new service onboarding
- [ ] new API version
- [ ] update existing version for new feature
- [x] update existing version to fix swagger quality issue in s360
- [ ] Other, please clarify
- When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
- When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
- By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.
Contribution checklist (MS Employees Only):
- [x] I commit to follow the Breaking Change Policy of "no breaking changes"
- [x] I have reviewed the documentation for the workflow.
- [x] Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Applicability: :warning:
If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.
- Change to data plane APIs
- Adding new properties
- All removals
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.
- Adding a new service
- Adding new API(s)
- Adding a new API version -[ ] 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.
-
[x] 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.
Hi, @sri- Thanks for your PR. I am workflow bot for review process. Here are some small tips.
Swagger Validation Report
️❌BreakingChange: 16 Errors, 0 Warnings failed [Detail]
| compared swaggers (via Oad v0.10.1)] | new version | base version |
|---|---|---|
| consumption.json | 2019-10-01(3dd5663) | 2019-10-01(main) |
| consumption.json | 2019-11-01(3dd5663) | 2019-11-01(main) |
| consumption.json | 2021-05-01(3dd5663) | 2021-05-01(main) |
| consumption.json | 2021-10-01(3dd5663) | 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 v1.13.0) | new version | base version |
|---|---|---|
| package-2021-10 | package-2021-10(3dd5663) | package-2021-10(main) |
| package-2021-05 | package-2021-05(3dd5663) | package-2021-05(main) |
| package-2019-11 | package-2019-11(3dd5663) | package-2019-11(main) |
| package-2019-10 | package-2019-10(3dd5663) | package-2019-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 |
|---|---|
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/2019-10-01/consumption.json#L1562 |
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/2019-11-01/consumption.json#L1562 |
R3030 - PathResourceProviderMatchNamespace |
The last resource provider 'Microsoft.Management, Microsoft.Billing' doesn't match the namespace. Location: Microsoft.Consumption/stable/2019-10-01/consumption.json#L1562 |
R3030 - PathResourceProviderMatchNamespace |
The last resource provider 'Microsoft.Management, Microsoft.Billing' doesn't match the namespace. Location: Microsoft.Consumption/stable/2019-11-01/consumption.json#L1562 |
R4011 - DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Consumption/stable/2019-10-01/consumption.json#L424 |
R4011 - DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.Consumption/stable/2019-11-01/consumption.json#L424 |
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 |
R4011 - DeleteOperationResponses |
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 |
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/2019-10-01/consumption.json#L1477 |
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/2019-11-01/consumption.json#L1477 |
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 |
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-10-01/consumption.json#L1427 |
R4037 - MissingTypeObject |
The schema 'MeterDetails' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2019-10-01/consumption.json#L1747 |
R4037 - MissingTypeObject |
The schema 'UsageDetailsListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2019-10-01/consumption.json#L1826 |
R4037 - MissingTypeObject |
The schema 'LegacyUsageDetailProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2019-10-01/consumption.json#L1864 |
R4037 - MissingTypeObject |
The schema 'ModernUsageDetailProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2019-10-01/consumption.json#L2107 |
R4037 - MissingTypeObject |
The schema 'TagProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2019-10-01/consumption.json#L3861 |
R4037 - MissingTypeObject |
The schema 'Tag' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2019-10-01/consumption.json#L3883 |
R4037 - MissingTypeObject |
The schema 'BudgetsListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2019-10-01/consumption.json#L3899 |
R4037 - MissingTypeObject |
The schema 'BudgetProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2019-10-01/consumption.json#L3933 |
R4037 - MissingTypeObject |
The schema 'BudgetTimePeriod' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2019-10-01/consumption.json#L4004 |
R4037 - MissingTypeObject |
The schema 'BudgetFilter' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2019-10-01/consumption.json#L4022 |
R4037 - MissingTypeObject |
The schema 'BudgetFilterProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2019-10-01/consumption.json#L4047 |
R4037 - MissingTypeObject |
The schema 'BudgetComparisonExpression' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2019-10-01/consumption.json#L4060 |
R4037 - MissingTypeObject |
The schema 'CurrentSpend' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2019-10-01/consumption.json#L4093 |
R4037 - MissingTypeObject |
The schema 'ForecastSpend' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2019-10-01/consumption.json#L4109 |
R4037 - MissingTypeObject |
The schema 'Notification' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2019-10-01/consumption.json#L4125 |
R4037 - MissingTypeObject |
The schema 'PriceSheetModel' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2019-10-01/consumption.json#L4242 |
R4037 - MissingTypeObject |
The schema 'DownloadProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2019-10-01/consumption.json#L4265 |
R4037 - MissingTypeObject |
The schema 'PriceSheetProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Consumption/stable/2019-10-01/consumption.json#L4280 |
️️✔️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.
️️✔️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
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️❌SDK Breaking Change Tracking failed [Detail]
Breaking Changes Tracking
❌azure-sdk-for-go - sdk/resourcemanager/consumption/armconsumption - 2.0.0+ Field `ETag` of struct `ChargeSummary` has been removed + Field `ETag` of struct `LegacyChargeSummary` has been removed + Field `ETag` of struct `ModernChargeSummary` has been removed + Field `Etag` of struct `CreditSummary` has been removed + Field `MarketplaceCharges` of struct `LegacyChargeSummaryProperties` has been removed + Field `Tags` of struct `CreditSummary` has been removed
❌azure-sdk-for-python-track2 - track2_azure-mgmt-consumption - 10.0.0+ Model ChargeSummary no longer has parameter e_tag + Model CreditSummary no longer has parameter etag + Model CreditSummary no longer has parameter tags + Model LegacyChargeSummary no longer has parameter e_tag + Model LegacyChargeSummary no longer has parameter marketplace_charges + Model ModernChargeSummary no longer has parameter e_tag
❌azure-sdk-for-js - @azure/arm-consumption - 10.0.0+ Interface BudgetFilter no longer has parameter not + Interface LegacyChargeSummary no longer has parameter marketplaceCharges + Operation ReservationRecommendationDetails.get has a new signature
️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from b43b95c467ee8099cac52ed9f29a975a027f23ef. SDK Automation 14.0.0warn Skip initScript due to not configured command sudo apt-get install -y dotnet-sdk-6.0 command autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/consumption/resource-manager/readme.md cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied cmderr [Autorest] realpath(): Permission denied
️✔️Microsoft.Azure.Management.Consumption [View full logs] [Release SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from b43b95c467ee8099cac52ed9f29a975a027f23ef. SDK Automation 14.0.0command sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json command generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
️✔️sdk/resourcemanager/consumption/armconsumption [View full logs] [Release SDK Changes] Breaking Change Detectedinfo [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Field `MarketplaceCharges` of struct `LegacyChargeSummaryProperties` has been removed info [Changelog] - Field `ETag` of struct `ChargeSummary` has been removed info [Changelog] - Field `ETag` of struct `LegacyChargeSummary` has been removed info [Changelog] - Field `Tags` of struct `CreditSummary` has been removed info [Changelog] - Field `Etag` of struct `CreditSummary` has been removed info [Changelog] - Field `ETag` of struct `ModernChargeSummary` has been removed info [Changelog] info [Changelog] ### Features Added info [Changelog] info [Changelog] - New const `EventTypeCreditExpired` info [Changelog] - New field `Tags` in struct `LegacyChargeSummary` info [Changelog] - New field `Etag` in struct `LegacyChargeSummary` info [Changelog] - New field `ETag` in struct `CreditSummary` info [Changelog] - New field `AzureMarketplaceCharges` in struct `LegacyChargeSummaryProperties` info [Changelog] - New field `Tags` in struct `ModernChargeSummary` info [Changelog] - New field `Etag` in struct `ModernChargeSummary` info [Changelog] - New field `SubscriptionID` in struct `ModernReservationRecommendationProperties` info [Changelog] - New field `ResourceType` in struct `ModernReservationRecommendationProperties` info [Changelog] - New field `Tags` in struct `ChargeSummary` info [Changelog] - New field `Etag` in struct `ChargeSummary` info [Changelog] info [Changelog] Total 5 breaking change(s), 7 additive change(s).
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs]Release - Generate from b43b95c467ee8099cac52ed9f29a975a027f23ef. SDK Automation 14.0.0command sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json cmderr [automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed. command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
️✔️track2_azure-mgmt-consumption [View full logs] [Release SDK Changes] Breaking Change Detectedinfo [Changelog] ### Features Added info [Changelog] info [Changelog] - Model ChargeSummary has a new parameter etag info [Changelog] - Model ChargeSummary has a new parameter tags info [Changelog] - Model CreditSummary has a new parameter e_tag_properties_e_tag info [Changelog] - Model LegacyChargeSummary has a new parameter azure_marketplace_charges info [Changelog] - Model LegacyChargeSummary has a new parameter etag info [Changelog] - Model LegacyChargeSummary has a new parameter tags info [Changelog] - Model ModernChargeSummary has a new parameter etag info [Changelog] - Model ModernChargeSummary has a new parameter tags info [Changelog] - Model ModernReservationRecommendation has a new parameter resource_type info [Changelog] - Model ModernReservationRecommendation has a new parameter subscription_id info [Changelog] info [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Model ChargeSummary no longer has parameter e_tag info [Changelog] - Model CreditSummary no longer has parameter etag info [Changelog] - Model CreditSummary no longer has parameter tags info [Changelog] - Model LegacyChargeSummary no longer has parameter e_tag info [Changelog] - Model LegacyChargeSummary no longer has parameter marketplace_charges info [Changelog] - Model ModernChargeSummary no longer has parameter e_tag
️⚠️ azure-sdk-for-java warning [Detail]
⚠️Warning [Logs]Release - Generate from b43b95c467ee8099cac52ed9f29a975a027f23ef. SDK Automation 14.0.0command ./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json command ./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json cmderr [generate.py] [ForkJoinPool-1-worker-3] INFO com.azure.core.test.implementation.TestingHelpers - Environment variable 'AZURE_TEST_MODE' has not been set yet. Using 'Playback' mode.
️✔️azure-resourcemanager-consumption [View full logs] [Release SDK Changes]
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from b43b95c467ee8099cac52ed9f29a975a027f23ef. SDK Automation 14.0.0command sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json warn File azure-sdk-for-js_tmp/initOutput.json not found to read command sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
️✔️@azure/arm-consumption [View full logs] [Release SDK Changes] Breaking Change Detectedinfo [Changelog] **Features** info [Changelog] info [Changelog] - Added operation LotsOperations.listByCustomer info [Changelog] - Added Interface LotsListByCustomerNextOptionalParams info [Changelog] - Added Interface LotsListByCustomerOptionalParams info [Changelog] - Added Type Alias LotsListByCustomerNextResponse info [Changelog] - Added Type Alias LotsListByCustomerResponse info [Changelog] - Interface CreditSummary has a new optional parameter eTagPropertiesETag info [Changelog] - Interface LegacyChargeSummary has a new optional parameter azureMarketplaceCharges info [Changelog] - Interface LegacyUsageDetail has a new optional parameter benefitId info [Changelog] - Interface LegacyUsageDetail has a new optional parameter benefitName info [Changelog] - Interface ModernReservationRecommendation has a new optional parameter resourceType info [Changelog] - Interface ModernReservationRecommendation has a new optional parameter subscriptionId info [Changelog] - Enum KnownEventType has a new value CreditExpired info [Changelog] info [Changelog] **Breaking Changes** info [Changelog] info [Changelog] - Operation ReservationRecommendationDetails.get has a new signature info [Changelog] - Interface BudgetFilter no longer has parameter not info [Changelog] - Interface LegacyChargeSummary no longer has parameter marketplaceCharges
️⚠️ azure-resource-manager-schemas warning [Detail]
⚠️Warning [Logs]Release - Generate from b43b95c467ee8099cac52ed9f29a975a027f23ef. Schema Automation 14.0.0command .sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json cmderr [initScript.sh] WARN old lockfile cmderr [initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm, cmderr [initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry. cmderr [initScript.sh] npm WARN old lockfile cmderr [initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient... cmderr [initScript.sh] npm WARN old lockfile warn File azure-resource-manager-schemas_tmp/initOutput.json not found to read command .sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json warn No file changes detected after generation
️✔️consumption [View full logs]
️️✔️ azure-powershell succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from b43b95c467ee8099cac52ed9f29a975a027f23ef. SDK Automation 14.0.0command sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json command pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
️✔️Az.Consumption [View full logs] [Release SDK Changes]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/consumption/armconsumption | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
| Python | track2_azure-mgmt-consumption | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
| Java | azure-resourcemanager-consumption | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
| JavaScript | @azure/arm-consumption | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
Hi @sri-, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.
| Task | How to fix | Priority |
|---|---|---|
| Avocado | Fix-Avocado | High |
| Semantic validation | Fix-SemanticValidation-Error | High |
| Model validation | Fix-ModelValidation-Error | High |
| LintDiff | Fix-LintDiff | high |
NewApiVersionRequired reason: A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support. EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.
Hi @sri-, 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. 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. If you want to know the production traffic statistic, please see ARM Traffic statistic. If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback. Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.
/azp run
Azure Pipelines successfully started running 1 pipeline(s).