Skip to content
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

update innererror to fix s360 correctness #21863

Merged
merged 1 commit into from
Jan 26, 2023

Conversation

vutran01
Copy link
Contributor

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:

  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 date is not yet available, the month. - when pr is mered
  4. 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):

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

@openapi-workflow-bot
Copy link

Hi, @vutran01 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-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Dec 12, 2022

    Swagger Validation Report

    ️❌BreakingChange: 4 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.2)] new version base version
    workbooks_API.json 2021-08-01(7f263f3) 2021-08-01(main)
    workbooks_API.json 2022-04-01(7f263f3) 2022-04-01(main)
    Rule Message
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'innerError' renamed or removed?
    New: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L651:7
    Old: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L651:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'innerError' renamed or removed?
    New: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L646:7
    Old: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L646:7
    1040 - AddedReadOnlyPropertyInResponse The new version has a new read-only property 'innererror' in response that was not found in the old version.
    New: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L651:7
    Old: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L651:7
    1040 - AddedReadOnlyPropertyInResponse The new version has a new read-only property 'innererror' in response that was not found in the old version.
    New: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L646:7
    Old: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L646:7
    ️️✔️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 v2.0.0) new version base version
    package-2022-04-01 package-2022-04-01(7f263f3) package-2022-04-01(main)
    package-2022-01-11 package-2022-01-11(7f263f3) package-2022-01-11(main)
    package-2021-11-01 package-2021-11-01(7f263f3) package-2021-11-01(main)
    package-2022-12-09-only package-2022-12-09-only(7f263f3) default(main)

    The following errors/warnings exist before current PR submission:

    Only 30 items are listed, please refer to log for more details.

    Rule Message
    ResourceNameRestriction The resource name parameter 'resourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L139
    ResourceNameRestriction The resource name parameter 'resourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L139
    RepeatedPathInfo The 'sourceId' already appears in the path, please don't repeat it in the request body.
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L236
    RepeatedPathInfo The 'sourceId' already appears in the path, please don't repeat it in the request body.
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L236
    PatchIdentityProperty The patch operation body parameter schema should contains property 'identity'.
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L300
    PatchIdentityProperty The patch operation body parameter schema should contains property 'identity'.
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L300
    ResourceNameRestriction The resource name parameter 'resourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L340
    ResourceNameRestriction The resource name parameter 'resourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L340
    ResourceNameRestriction The resource name parameter 'resourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L382
    ResourceNameRestriction The resource name parameter 'resourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L382
    ArmResourcePropertiesBag Top level property names should not be repeated inside the properties bag for ARM resource 'Workbook'. Properties [properties.tags] conflict with ARM top level properties. Please rename these.
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L482
    ArmResourcePropertiesBag Top level property names should not be repeated inside the properties bag for ARM resource 'Workbook'. Properties [properties.tags] conflict with ARM top level properties. Please rename these.
    Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L482
    ResourceNameRestriction The resource name parameter 'resourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L139
    ResourceNameRestriction The resource name parameter 'resourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L139
    RepeatedPathInfo The 'sourceId' already appears in the path, please don't repeat it in the request body.
    Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L236
    RepeatedPathInfo The 'sourceId' already appears in the path, please don't repeat it in the request body.
    Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L236
    PatchIdentityProperty The patch operation body parameter schema should contains property 'identity'.
    Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L300
    PatchIdentityProperty The patch operation body parameter schema should contains property 'identity'.
    Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L300
    ResourceNameRestriction The resource name parameter 'resourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L340
    ResourceNameRestriction The resource name parameter 'resourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L340
    ResourceNameRestriction The resource name parameter 'resourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L382
    ResourceNameRestriction The resource name parameter 'resourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L382
    ArmResourcePropertiesBag Top level property names should not be repeated inside the properties bag for ARM resource 'Workbook'. Properties [properties.tags] conflict with ARM top level properties. Please rename these.
    Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L478
    ArmResourcePropertiesBag Top level property names should not be repeated inside the properties bag for ARM resource 'Workbook'. Properties [properties.tags] conflict with ARM top level properties. Please rename these.
    Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L478
    ⚠️ GetInOperationName 'GET' operation 'Workbooks_RevisionsList' 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.Insights/stable/2021-08-01/workbooks_API.json#L343
    ⚠️ GetInOperationName 'GET' operation 'Workbooks_RevisionsList' 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.Insights/stable/2021-08-01/workbooks_API.json#L343
    ⚠️ GetInOperationName 'GET' operation 'Workbooks_RevisionGet' 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.Insights/stable/2021-08-01/workbooks_API.json#L385
    ⚠️ GetInOperationName 'GET' operation 'Workbooks_RevisionGet' 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.Insights/stable/2021-08-01/workbooks_API.json#L385
    ⚠️ GetInOperationName 'GET' operation 'Workbooks_RevisionsList' 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.Insights/stable/2022-04-01/workbooks_API.json#L343
    ⚠️ GetInOperationName 'GET' operation 'Workbooks_RevisionsList' 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.Insights/stable/2022-04-01/workbooks_API.json#L343
    ️⚠️Avocado: 1 Warnings warning [Detail]
    Rule Message
    ⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
    readme: specification/applicationinsights/resource-manager/readme.md
    tag: specification/applicationinsights/resource-manager/readme.md#tag-package-2022-12-09-only
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

    API Test is not triggered due to precheck failure. Check pipeline log for details.

    ️️✔️~[Staging] SwaggerAPIView 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.
    Posted by Swagger Pipeline | How to fix these errors?

    @ghost ghost added the Insights label Dec 12, 2022
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Dec 12, 2022

    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/applicationinsights/armapplicationinsights - 2.0.0-beta.2
    +	Field `InnerError` of struct `WorkbookErrorDefinition` has been removed
    azure-sdk-for-python-track2 - track2_azure-mgmt-applicationinsights - 3.1.0
    +	Model WorkbookErrorDefinition no longer has parameter inner_error
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 6e290d0. 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
      cmderr	[automation_generate.sh]
      cmderr	[automation_generate.sh] npm notice New major version of npm available! 8.19.3 -> 9.4.0
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.4.0>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-applicationinsights [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Model WorkbookErrorDefinition has a new parameter innererror
      info	[Changelog]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog]   - Model WorkbookErrorDefinition no longer has parameter inner_error
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 6e290d0. SDK Automation 14.0.0
      command	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/applicationinsights/armapplicationinsights [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Type of `ComponentPurgeBodyFilters.Value` has been changed from `interface{}` to `any`
      info	[Changelog] - Type of `ErrorDefinition.Innererror` has been changed from `interface{}` to `any`
      info	[Changelog] - Type of `OperationLive.Properties` has been changed from `interface{}` to `any`
      info	[Changelog] - Type of `WorkbookTemplateLocalizedGallery.TemplateData` has been changed from `interface{}` to `any`
      info	[Changelog] - Type of `WorkbookTemplateProperties.TemplateData` has been changed from `interface{}` to `any`
      info	[Changelog] - Field `InnerError` of struct `WorkbookErrorDefinition` has been removed
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New value `WebTestKindStandard` added to type alias `WebTestKind`
      info	[Changelog] - New function `NewOperationsClient(azcore.TokenCredential, *arm.ClientOptions) (*OperationsClient, error)`
      info	[Changelog] - New function `*OperationsClient.NewListPager(*OperationsClientListOptions) *runtime.Pager[OperationsClientListResponse]`
      info	[Changelog] - New struct `ErrorFieldContract`
      info	[Changelog] - New struct `HeaderField`
      info	[Changelog] - New struct `OperationsClient`
      info	[Changelog] - New struct `OperationsClientListResponse`
      info	[Changelog] - New struct `WebTestPropertiesRequest`
      info	[Changelog] - New struct `WebTestPropertiesValidationRules`
      info	[Changelog] - New struct `WebTestPropertiesValidationRulesContentValidation`
      info	[Changelog] - New field `Details` in struct `ErrorResponse`
      info	[Changelog] - New field `Request` in struct `WebTestProperties`
      info	[Changelog] - New field `ValidationRules` in struct `WebTestProperties`
      info	[Changelog] - New field `Innererror` in struct `WorkbookErrorDefinition`
      info	[Changelog]
      info	[Changelog] Total 6 breaking change(s), 20 additive change(s).
    ️❌ azure-sdk-for-js failed [Detail]
    • Failed [Logs]Release - Generate from 6e290d0. SDK Automation 14.0.0
      command	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
      cmderr	[automation_generate.sh] [ERROR] Error:
      cmderr	[automation_generate.sh] [ERROR] An error occurred while run build for readme file: "specification/applicationinsights/resource-manager/readme.md":
      cmderr	[automation_generate.sh] [ERROR] Err: Error: Command failed: rush build -t @azure/arm-appinsights
      cmderr	[automation_generate.sh] [ERROR] Stderr: "null"
      cmderr	[automation_generate.sh] [ERROR] Stdout: "null"
      cmderr	[automation_generate.sh] [ERROR] ErrorStack: "Error: Command failed: rush build -t @azure/arm-appinsights
      cmderr	[automation_generate.sh] [ERROR]     at checkExecSyncError (node:child_process:861:11)
      cmderr	[automation_generate.sh] [ERROR]     at Object.execSync (node:child_process:932:15)
      cmderr	[automation_generate.sh] [ERROR]     at Object.<anonymous> (/opt/hostedtoolcache/node/16.19.0/x64/lib/node_modules/@azure-tools/js-sdk-release-tools/dist/hlc/generateMgmt.js:87:33)
      cmderr	[automation_generate.sh] [ERROR]     at Generator.next (<anonymous>)
      cmderr	[automation_generate.sh] [ERROR]     at fulfilled (/opt/hostedtoolcache/node/16.19.0/x64/lib/node_modules/@azure-tools/js-sdk-release-tools/node_modules/tslib/tslib.js:112:62)
      cmderr	[automation_generate.sh] [ERROR]     at processTicksAndRejections (node:internal/process/task_queues:96:5)"
    • @azure/arm-appinsights [View full logs]  [Release SDK Changes]
      info	[Changelog]
      error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 6e290d0. 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]  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
    • ️✔️applicationinsights [View full logs
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 6e290d0. SDK Automation 14.0.0
      command	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.ApplicationInsights [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Dec 12, 2022

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/applicationinsights/armapplicationinsights https://apiview.dev/Assemblies/Review/6c9ba5e2520348d98f08cfc233bf8b3c
    Java azure-resourcemanager-applicationinsights https://apiview.dev/Assemblies/Review/4c026e718f2446ff96956b45d4a2a906
    .Net Azure.ResourceManager.ApplicationInsights There is no API change compared with the previous version

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

    @openapi-workflow-bot
    Copy link

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

    @akning-ms
    Copy link
    Contributor

    It is possible to change it in service code to keep consistent, as it caused breaking change which need breaking change review board to approve

    @vutran01
    Copy link
    Contributor Author

    clients have been using this structure for a long time, changing the service would break all the clients. the swagger has been incorrect so this change is needed to match swagger to what the service has been doing. even creating a new api-version will not resolve swagger correctly for existing api-version

    @akning-ms
    Copy link
    Contributor

    clients have been using this structure for a long time, changing the service would break all the clients. the swagger has been incorrect so this change is needed to match swagger to what the service has been doing. even creating a new api-version will not resolve swagger correctly for existing api-version

    I am not sure what clients is using "innererror"? as they(SDK, PS...) are generated from Swagger. it should be using "innerError. the breaking change I said means this PR caused client breaking change. so suggest change service code if possible. otherwise. you should get breaking change review board approval first. refer to #21863 (comment)

    @ghost
    Copy link

    ghost commented Jan 22, 2023

    Hi, @vutran01. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    @ghost ghost added the no-recent-activity label Jan 22, 2023
    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jan 23, 2023
    @ghost ghost removed the no-recent-activity label Jan 23, 2023
    @vutran01
    Copy link
    Contributor Author

    @akning-ms can you take a look at this PR again as the breaking change has been approved?

    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 BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-BreakingChange-Go FixS360 Insights NewApiVersionRequired resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants