Skip to content

Conversation

handeeeadiguzel
Copy link
Contributor

@handeeeadiguzel handeeeadiguzel commented Nov 1, 2021

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

Changelog

Add a changelog entry for this PR by answering the following questions:

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. 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.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No refresh required for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

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 label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.

    • 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.
  • 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Nov 1, 2021

Swagger Validation Report

️❌BreakingChange: 18 Errors, 0 Warnings failed [Detail]
Rule Message
1011 - AddingResponseCode The new version adds a response code '204'.
New: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L645:11
1011 - AddingResponseCode The new version adds a response code '204'.
New: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L855:11
1011 - AddingResponseCode The new version adds a response code '204'.
New: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L1046:11
1033 - RemovedProperty The new version is missing a property found in the old version. Was 'dataset' renamed or removed?
New: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L1148:7
Old: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L1139:7
1040 - AddedReadOnlyPropertyInResponse The new version has a new read-only property 'dateRange' in response that was not found in the old version.
New: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L1459:7
Old: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L1446:7
1040 - AddedReadOnlyPropertyInResponse The new version has a new read-only property 'currency' in response that was not found in the old version.
New: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L1459:7
Old: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L1446:7
1040 - AddedReadOnlyPropertyInResponse The new version has a new read-only property 'location' in response that was not found in the old version.
New: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L2072:7
Old: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L2034:7
1040 - AddedReadOnlyPropertyInResponse The new version has a new read-only property 'sku' in response that was not found in the old version.
New: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L2072:7
Old: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L2034:7
1040 - AddedReadOnlyPropertyInResponse The new version has a new read-only property 'eTag' in response that was not found in the old version.
New: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L2072:7
Old: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L2034:7
1040 - AddedReadOnlyPropertyInResponse The new version has a new read-only property 'location' in response that was not found in the old version.
New: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L1719:7
Old: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L1681:7
1040 - AddedReadOnlyPropertyInResponse The new version has a new read-only property 'sku' in response that was not found in the old version.
New: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L1719:7
Old: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L1681:7
1040 - AddedReadOnlyPropertyInResponse The new version has a new read-only property 'eTag' in response that was not found in the old version.
New: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L1719:7
Old: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L1681:7
1041 - AddedPropertyInResponse The new version has a new property 'dataSet' in response that was not found in the old version.
New: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L1148:7
Old: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L1139:7
1041 - AddedPropertyInResponse The new version has a new property 'includeMonetaryCommitment' in response that was not found in the old version.
New: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L1148:7
Old: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L1139:7
1045 - AddedOptionalProperty The new version has a new optional property 'dataSet' that was not found in the old version.
New: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L1148:7
Old: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L1139:7
1045 - AddedOptionalProperty The new version has a new optional property 'includeMonetaryCommitment' that was not found in the old version.
New: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L1148:7
Old: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L1139:7
1045 - AddedOptionalProperty The new version has a new optional property 'dateRange' that was not found in the old version.
New: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L1459:7
Old: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L1446:7
1045 - AddedOptionalProperty The new version has a new optional property 'currency' that was not found in the old version.
New: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L1459:7
Old: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L1446:7
️⚠️LintDiff: 1 Warnings warning [Detail]
The following errors/warnings are introduced by current PR:
Rule Message
⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: includeMonetaryCommitment
Location: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L1182


The following errors/warnings exist before current PR submission:

Rule Message
⚠️ R1003 - ListInOperationName Since operation 'Exports_GetExecutionHistory' response has model definition 'array', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Microsoft.CostManagement/stable/2021-10-01/costmanagement.exports.json#L342
⚠️ R1003 - ListInOperationName Since operation 'Dimensions_ByExternalCloudProviderType' response has model definition 'x-ms-pageable', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L876
⚠️ R1005 - GetInOperationName 'GET' operation 'Dimensions_ByExternalCloudProviderType' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L876
⚠️ R1007 - PatchInOperationName 'PATCH' operation 'Alerts_Dismiss' should use method name 'Update'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L487
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'GenerateDetailedCostReportOperationResults_Get' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
Location: Microsoft.CostManagement/stable/2021-10-01/costmanagement.generatedetailedcostreport.json#L123
⚠️ R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options. Property name: direction
Location: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L1305
⚠️ R2029 - PageableOperation Based on the response model schema, operation 'Exports_List' might be pageable. Consider adding the x-ms-pageable extension.
Location: Microsoft.CostManagement/stable/2021-10-01/costmanagement.exports.json#L37
⚠️ R2029 - PageableOperation Based on the response model schema, operation 'Exports_GetExecutionHistory' might be pageable. Consider adding the x-ms-pageable extension.
Location: Microsoft.CostManagement/stable/2021-10-01/costmanagement.exports.json#L338
⚠️ R2029 - PageableOperation Based on the response model schema, operation 'Alerts_List' might be pageable. Consider adding the x-ms-pageable extension.
Location: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L383
⚠️ R2029 - PageableOperation Based on the response model schema, operation 'Alerts_ListExternal' might be pageable. Consider adding the x-ms-pageable extension.
Location: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L537
⚠️ R2066 - PostOperationIdContainsUrlVerb OperationId should contain the verb: 'run' in:'Exports_Execute'. Consider updating the operationId
Location: Microsoft.CostManagement/stable/2021-10-01/costmanagement.exports.json#L288
⚠️ R2066 - PostOperationIdContainsUrlVerb OperationId should contain the verb: 'generatedetailedcostreport' in:'GenerateDetailedCostReport_CreateOperation'. Consider updating the operationId
Location: Microsoft.CostManagement/stable/2021-10-01/costmanagement.generatedetailedcostreport.json#L41
⚠️ R2066 - PostOperationIdContainsUrlVerb OperationId should contain the verb: 'forecast' in:'Forecast_Usage'. Consider updating the operationId
Location: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L586
⚠️ R2066 - PostOperationIdContainsUrlVerb OperationId should contain the verb: 'forecast' in:'Forecast_ExternalCloudProviderUsage'. Consider updating the operationId
Location: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L662
⚠️ R2066 - PostOperationIdContainsUrlVerb OperationId should contain the verb: 'query' in:'Query_Usage'. Consider updating the operationId
Location: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L955
⚠️ R2066 - PostOperationIdContainsUrlVerb OperationId should contain the verb: 'query' in:'Query_UsageByExternalCloudProviderType'. Consider updating the operationId
Location: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L1063
⚠️ R4014 - AllResourcesMustHaveGetOperation The resource 'ExportExecution' does not have get operation, please add it.
Location: Microsoft.CostManagement/stable/2021-10-01/costmanagement.exports.json#L783
⚠️ R4014 - AllResourcesMustHaveGetOperation The resource 'Dimension' does not have get operation, please add it.
Location: Microsoft.CostManagement/stable/2021-10-01/costmanagement.json#L1711
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation

️️✔️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).
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Nov 1, 2021

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-python-track2 - track2_azure-mgmt-costmanagement - Approved - 3.0.0
-	Model QueryResult no longer has parameter e_tag
-	Model QueryResult no longer has parameter location
-	Model QueryResult no longer has parameter sku
-	Model View no longer has parameter currency
-	Model View no longer has parameter data_set
-	Model View no longer has parameter date_range
-	Model View no longer has parameter include_monetary_commitment
️✔️azure-sdk-for-go - costmanagement/mgmt/2021-01-01/costmanagement - v59.1.0
️✔️azure-sdk-for-go - costmanagement/mgmt/2020-06-01/costmanagement - v59.1.0
️✔️azure-sdk-for-go - costmanagement/mgmt/2019-11-01/costmanagement - v59.1.0
️✔️azure-sdk-for-go - costmanagement/mgmt/2019-10-01/costmanagement - v59.1.0
️✔️azure-sdk-for-go - costmanagement/mgmt/2019-01-01/costmanagement - v59.1.0
️✔️azure-sdk-for-go - costmanagement/mgmt/2018-05-31/costmanagement - v59.1.0
️✔️azure-sdk-for-go - preview/costmanagement/mgmt/2019-03-01/costmanagement - v59.1.0
️✔️azure-sdk-for-go - preview/costmanagement/mgmt/2018-08-01-preview/costmanagement - v59.1.0
️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from cf6beaa. SDK Automation 14.0.0
    command	sh ./eng/initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
    command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
  • ️✔️costmanagement/mgmt/2021-01-01/costmanagement [View full logs]  [Release SDK Changes]
    info	[Changelog] This is a new package
  • ️✔️costmanagement/mgmt/2020-06-01/costmanagement [View full logs
    info	[Changelog] No exported changes
  • ️✔️costmanagement/mgmt/2019-11-01/costmanagement [View full logs
    info	[Changelog] No exported changes
  • ️✔️costmanagement/mgmt/2019-10-01/costmanagement [View full logs
    info	[Changelog] No exported changes
  • ️✔️costmanagement/mgmt/2019-01-01/costmanagement [View full logs
    info	[Changelog] No exported changes
  • ️✔️costmanagement/mgmt/2018-05-31/costmanagement [View full logs
    info	[Changelog] No exported changes
  • ️✔️preview/costmanagement/mgmt/2019-03-01/costmanagement [View full logs
    info	[Changelog] No exported changes
  • ️✔️preview/costmanagement/mgmt/2018-08-01-preview/costmanagement [View full logs
    info	[Changelog] No exported changes
️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from cf6beaa. SDK Automation 14.0.0
    command	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-costmanagement [View full logs]  [Release SDK Changes] Breaking Change Detected
    info	[Changelog] **Features**
    info	[Changelog]
    info	[Changelog]   - Model Dimension has a new parameter sku
    info	[Changelog]   - Model Dimension has a new parameter e_tag
    info	[Changelog]   - Model Dimension has a new parameter location
    info	[Changelog]   - Model Alert has a new parameter e_tag
    info	[Changelog]   - Model CommonExportProperties has a new parameter partition_data
    info	[Changelog]   - Model CommonExportProperties has a new parameter next_run_time_estimate
    info	[Changelog]   - Model CommonExportProperties has a new parameter run_history
    info	[Changelog]   - Model QueryFilter has a new parameter tag
    info	[Changelog]   - Model QueryFilter has a new parameter not_property
    info	[Changelog]   - Model QueryFilter has a new parameter dimension
    info	[Changelog]   - Model Resource has a new parameter sku
    info	[Changelog]   - Model Resource has a new parameter e_tag
    info	[Changelog]   - Model Resource has a new parameter location
    info	[Changelog]   - Model Export has a new parameter partition_data
    info	[Changelog]   - Model Export has a new parameter next_run_time_estimate
    info	[Changelog]   - Model Export has a new parameter run_history
    info	[Changelog]   - Model ReportConfigFilter has a new parameter tag
    info	[Changelog]   - Model ReportConfigFilter has a new parameter not_property
    info	[Changelog]   - Model ReportConfigFilter has a new parameter dimension
    info	[Changelog]   - Model ExportProperties has a new parameter partition_data
    info	[Changelog]   - Model ExportProperties has a new parameter next_run_time_estimate
    info	[Changelog]   - Model ExportProperties has a new parameter run_history
    info	[Changelog]   - Model ExportDeliveryDestination has a new parameter storage_account
    info	[Changelog]   - Model ExportDeliveryDestination has a new parameter sas_token
    info	[Changelog]   - Model ExportExecution has a new parameter e_tag
    info	[Changelog]   - Model ExportExecution has a new parameter error
    info	[Changelog]   - Added operation group GenerateDetailedCostReportOperations
    info	[Changelog]   - Added operation group GenerateDetailedCostReportOperationStatusOperations
    info	[Changelog]   - Added operation group GenerateDetailedCostReportOperationResultsOperations
    info	[Changelog]
    info	[Changelog] **Breaking changes**
    info	[Changelog]
    info	[Changelog]   - Operation ExportsOperations.get has a new signature
    info	[Changelog]   - Operation ExportsOperations.list has a new signature
    info	[Changelog]   - Model Alert no longer has parameter tags
    info	[Changelog]   - Model QueryFilter no longer has parameter dimensions
    info	[Changelog]   - Model QueryFilter no longer has parameter tags
    info	[Changelog]   - Model ReportConfigFilter no longer has parameter tag_value
    info	[Changelog]   - Model ReportConfigFilter no longer has parameter dimensions
    info	[Changelog]   - Model ReportConfigFilter no longer has parameter tag_key
    info	[Changelog]   - Model ReportConfigFilter no longer has parameter tags
    info	[Changelog]   - Model ExportExecution no longer has parameter tags
    info	[Changelog]   - Removed operation group SettingsOperations
    info	[Changelog]   - Removed operation group GenerateReservationDetailsReportOperations
️⚠️ azure-resource-manager-schemas warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from cf6beaa. Schema Automation 14.0.0
    command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
    cmderr	[initScript.sh] 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
    cmderr	[generateScript.sh] (node:2386) UnhandledPromiseRejectionWarning: Error: ENOENT: no such file or directory, unlink '/home/vsts/work/1/s/azure-resource-manager-schemas/schemas/2018-08-01-preview/Microsoft.CostManagement.json'
    cmderr	[generateScript.sh] (Use `node --trace-warnings ...` to show where the warning was created)
    cmderr	[generateScript.sh] (node:2386) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag `--unhandled-rejections=strict` (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 1)
    cmderr	[generateScript.sh] (node:2386) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.
    cmderr	[generateScript.sh] (node:2386) UnhandledPromiseRejectionWarning: Error: ENOENT: no such file or directory, unlink '/home/vsts/work/1/s/azure-resource-manager-schemas/schemas/2019-10-01/Microsoft.CostManagement.json'
    cmderr	[generateScript.sh] (node:2386) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag `--unhandled-rejections=strict` (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 2)
  • ️✔️cost-management [View full logs]  [Release Schema Changes]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-workflow-bot
Copy link

Hi, @handeeeadiguzel Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

    @openapi-workflow-bot
    Copy link

    [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.

    @openapi-workflow-bot
    Copy link

    Hi @handeeeadiguzel, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

    TaskHow to fixPrioritySupport (Microsoft alias)
    AvocadoFix-AvocadoHighruowan
    Semantic validationFix-SemanticValidation-ErrorHighraychen, jianyxi
    Model validationFix-ModelValidation-ErrorHighraychen,jianyxi
    LintDiffFix-LintDiffhighjianyxi, ruoxuan
    If you need further help, please feedback via swagger feedback."

    @openapi-workflow-bot
    Copy link

    Hi @handeeeadiguzel, 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.

    @openapi-workflow-bot
    Copy link

    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.

    …present in the swagger spec, however they were not present in x-ms-examples. Please provide them.
    @handeeeadiguzel handeeeadiguzel marked this pull request as ready for review November 1, 2021 22:33
    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Nov 1, 2021
    @ruowan
    Copy link
    Member

    ruowan commented Nov 2, 2021

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @msyyc
    Copy link
    Member

    msyyc commented Nov 5, 2021

    Hi @mitagarg, could you sign off the content as reviewers?

    @msyyc
    Copy link
    Member

    msyyc commented Nov 5, 2021

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @msyyc
    Copy link
    Member

    msyyc commented Nov 9, 2021

    Hi @handeeeadiguzel I need at least one approval from reviewers to merge the PR.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 Approved-SdkBreakingChange-Python FixS360
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    6 participants