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

added properties property for operation object #22846

Conversation

fnuarnav
Copy link
Contributor

@fnuarnav fnuarnav commented Mar 1, 2023

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 the date is not yet available, the month.
  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, @fnuarnav 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. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 1, 2023

    Swagger Validation Report

    ️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    servicefabricmesh.json 2018-07-01-preview(a431955) 2018-07-01-preview(main)
    servicefabricmesh.json 2018-09-01-preview(a431955) 2018-09-01-preview(main)
    Rule Message
    1041 - AddedPropertyInResponse The new version has a new property 'properties' in response that was not found in the old version.
    New: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1621:7
    Old: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1621:7
    1041 - AddedPropertyInResponse The new version has a new property 'properties' in response that was not found in the old version.
    New: Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json#L1878:7
    Old: Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json#L1878:7
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 2 Warnings warning [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    package-2018-09-01-preview package-2018-09-01-preview(a431955) package-2018-09-01-preview(main)
    package-2018-07-01-preview package-2018-07-01-preview(a431955) package-2018-07-01-preview(main)

    [must fix]The following errors/warnings are introduced by current PR:

    Rule Message Related RPC [For API reviewers]
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1638
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json#L1895


    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 'applicationName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L37
    DeleteOperationAsyncResponseValidation An async DELETE operation must set ''x-ms-long-running-operation' : true''.
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L129
    DeleteOperationAsyncResponseValidation An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L129
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L159
    ResourceNameRestriction The resource name parameter 'applicationName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L174
    RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L201
    ResourceNameRestriction The resource name parameter 'applicationName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L214
    ResourceNameRestriction The resource name parameter 'serviceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L214
    RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L244
    ResourceNameRestriction The resource name parameter 'applicationName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L254
    ResourceNameRestriction The resource name parameter 'serviceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L254
    RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L284
    ResourceNameRestriction The resource name parameter 'applicationName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L297
    ResourceNameRestriction The resource name parameter 'serviceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L297
    ResourceNameRestriction The resource name parameter 'replicaName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L297
    RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L330
    ResourceNameRestriction The resource name parameter 'applicationName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L423
    ResourceNameRestriction The resource name parameter 'serviceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L423
    ResourceNameRestriction The resource name parameter 'replicaName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L423
    ResourceNameRestriction The resource name parameter 'codePackageName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L423
    OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.ServiceFabricMesh/operations' does not match the ARM specification. Please standardize the schema.
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L494
    ResourceNameRestriction The resource name parameter 'networkName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L510
    ResourceNameRestriction The resource name parameter 'volumeName' should be defined with a 'pattern' restriction.
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L727
    MissingTypeObject The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L946
    MissingTypeObject The schema 'ManagedProxyResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L992
    MissingTypeObject The schema 'TrackedResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1023
    MissingTypeObject The schema 'ProvisionedResourceProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1056
    MissingTypeObject The schema 'NetworkResourceDescription' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1083
    MissingTypeObject The schema 'VolumeResourceDescription' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1150
    MissingTypeObject The schema 'ApplicationResourceDescription' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1246
    ️️✔️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.

    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️❌ModelValidation: 5 Errors, 0 Warnings failed [Detail]
    Rule Message
    ENUM_CASE_MISMATCH Enum does not match case for: linux
    Url: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L2033:19
    ExampleUrl: preview/2018-07-01-preview/examples/ApplicationCreateOrUpdate.json#L9:39
    MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1357:35
    ExampleUrl: preview/2018-07-01-preview/examples/ServiceList.json#L14:11
    MISSING_RESOURCE_ID id is required to return in response of GET/PUT resource calls but not being provided
    Url: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L1357:35
    ExampleUrl: preview/2018-07-01-preview/examples/ServiceGet.json#L11:15
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Operations_List.
    Url: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L479:14
    INVALID_TYPE Expected type integer but found type string
    Url: Microsoft.ServiceFabricMesh/preview/2018-07-01-preview/servicefabricmesh.json#L2106:23
    ExampleUrl: preview/2018-07-01-preview/examples/NetworkCreateOrUpdate.json#L9:35
    ️️✔️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?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 1, 2023

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking


    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 9dbdcf0. SDK Automation 14.0.0
      command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
      command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.101 --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/servicefabricmesh/resource-manager/readme.md
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
    • ️✔️Microsoft.Azure.Management.ServiceFabricMesh [View full logs]  [Release SDK Changes]
    ️❌ azure-sdk-for-python failed [Detail]
    • Code Generator Failed [Logs]Release - Generate from 9dbdcf0. 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] npm notice
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.0 -> 9.6.2
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.2>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.6.2` to update!
      cmderr	[automation_generate.sh] npm notice
      cmdout	[automation_generate.sh] [Autorest]     validate_code_modeloptions(options)
      cmdout	[automation_generate.sh] [Autorest]   File "/home/cloudtest/.autorest/@autorestpython@6.4.6/node_modules/@autorest/python/autorest/codegen/__init__.py", line 41, in _validate_code_modeloptions
      cmdout	[automation_generate.sh] [Autorest]     raise ValueError("--basic-setup-py must be used with --package-version")
      cmdout	[automation_generate.sh] [Autorest] ValueError: --basic-setup-py must be used with --package-version
      cmdout	[automation_generate.sh] [Autorest] fatal   | Process() cancelled due to failure
      cmdout	[automation_generate.sh] [Autorest] error   |   Error: Plugin codegen reported failure.
      cmdout	[automation_generate.sh] [Autorest] error   | Autorest completed with an error. If you think the error message is unclear, or is a bug, please declare an issues at https://github.com/Azure/autorest/issues with the error message you are seeing.
      cmdout	[automation_generate.sh] [Autorest]     validate_code_modeloptions(options)
      cmdout	[automation_generate.sh] [Autorest]   File "/home/cloudtest/.autorest/@autorestpython@6.4.6/node_modules/@autorest/python/autorest/codegen/__init__.py", line 41, in _validate_code_modeloptions
      cmdout	[automation_generate.sh] [Autorest]     raise ValueError("--basic-setup-py must be used with --package-version")
      cmdout	[automation_generate.sh] [Autorest] ValueError: --basic-setup-py must be used with --package-version
      cmdout	[automation_generate.sh] [Autorest] fatal   | Process() cancelled due to failure
      cmdout	[automation_generate.sh] [Autorest] error   |   Error: Plugin codegen reported failure.
      cmdout	[automation_generate.sh] [Autorest] error   | Autorest completed with an error. If you think the error message is unclear, or is a bug, please declare an issues at https://github.com/Azure/autorest/issues with the error message you are seeing.
      cmdout	[automation_generate.sh] [Autorest]/mnt/vss/_work/1/s/azure-sdk-for-python_tmp/venv-sdk/auto_temp.json does not exist!!!Error happened during codegen
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-python]: sh scripts/automation_generate.sh
      warn	Skip package processing as generation is failed
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 9dbdcf0. 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/servicefabricmesh/armservicefabricmesh [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New function `NewClientFactory(string, azcore.TokenCredential, *arm.ClientOptions) (*ClientFactory, error)`
      info	[Changelog] - New function `*ClientFactory.NewApplicationClient() *ApplicationClient`
      info	[Changelog] - New function `*ClientFactory.NewCodePackageClient() *CodePackageClient`
      info	[Changelog] - New function `*ClientFactory.NewGatewayClient() *GatewayClient`
      info	[Changelog] - New function `*ClientFactory.NewNetworkClient() *NetworkClient`
      info	[Changelog] - New function `*ClientFactory.NewOperationsClient() *OperationsClient`
      info	[Changelog] - New function `*ClientFactory.NewSecretClient() *SecretClient`
      info	[Changelog] - New function `*ClientFactory.NewSecretValueClient() *SecretValueClient`
      info	[Changelog] - New function `*ClientFactory.NewServiceClient() *ServiceClient`
      info	[Changelog] - New function `*ClientFactory.NewServiceReplicaClient() *ServiceReplicaClient`
      info	[Changelog] - New function `*ClientFactory.NewVolumeClient() *VolumeClient`
      info	[Changelog] - New struct `AvailableOperationDescriptionProperties`
      info	[Changelog] - New struct `ClientFactory`
      info	[Changelog] - New struct `Dimension`
      info	[Changelog] - New struct `LogSpecification`
      info	[Changelog] - New struct `MetricAvailability`
      info	[Changelog] - New struct `MetricSpecification`
      info	[Changelog] - New struct `ServiceSpecification`
      info	[Changelog] - New field `Properties` in struct `OperationResult`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 26 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 9dbdcf0. 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
    • ️✔️@azure/arm-servicefabricmesh [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 9dbdcf0. 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
      warn	Skip detect changed packages
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 9dbdcf0. 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.servicefabricmesh.DefaultTag [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 Mar 1, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/servicefabricmesh/armservicefabricmesh https://apiview.dev/Assemblies/Review/08f77a19d7754e39bc294d8b6eb5ac07
    Java azure-resourcemanager-servicefabricmesh https://apiview.dev/Assemblies/Review/39e1b95fdc0949209b11978d47d248ee
    JavaScript @azure/arm-servicefabricmesh https://apiview.dev/Assemblies/Review/ad4d1c485e7241638b44cdbfce711776

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

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @ArcturusZhang ArcturusZhang added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Mar 3, 2023
    @openapi-workflow-bot
    Copy link

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

    @fnuarnav
    Copy link
    Contributor Author

    fnuarnav commented Mar 8, 2023

    Created a work item for breaking change review: https://msazure.visualstudio.com/One/_workitems/edit/17473935

    Copy link
    Member

    @ArcturusZhang ArcturusZhang left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Could we add some descriptions for those newly added properties?

    @mikekistler mikekistler added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Mar 27, 2023
    @ArcturusZhang
    Copy link
    Member

    ignoring the model validation failures because they existed before this PR

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants