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

Copy Change from azure-rest-api-specs-pr/RPSaaSMaster #17978

Merged
merged 1 commit into from
Feb 24, 2022

Conversation

ChenTanyi
Copy link
Contributor

@ChenTanyi ChenTanyi requested a review from najian February 24, 2022 02:00
@openapi-workflow-bot
Copy link

Hi, @ChenTanyi 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 Feb 24, 2022

    Swagger Validation Report

    ️❌BreakingChange: 4 Errors, 0 Warnings failed [Detail]
    Rule Message
    1041 - AddedPropertyInResponse The new version has a new property 'vNetSolution' in response that was not found in the old version.
    New: Microsoft.ServiceLinker/preview/2021-11-01-preview/servicelinker.json#L593:7
    Old: Microsoft.ServiceLinker/preview/2021-11-01-preview/servicelinker.json#L585:7
    1041 - AddedPropertyInResponse The new version has a new property 'secretStore' in response that was not found in the old version.
    New: Microsoft.ServiceLinker/preview/2021-11-01-preview/servicelinker.json#L593:7
    Old: Microsoft.ServiceLinker/preview/2021-11-01-preview/servicelinker.json#L585:7
    1045 - AddedOptionalProperty The new version has a new optional property 'vNetSolution' that was not found in the old version.
    New: Microsoft.ServiceLinker/preview/2021-11-01-preview/servicelinker.json#L593:7
    Old: Microsoft.ServiceLinker/preview/2021-11-01-preview/servicelinker.json#L585:7
    1045 - AddedOptionalProperty The new version has a new optional property 'secretStore' that was not found in the old version.
    New: Microsoft.ServiceLinker/preview/2021-11-01-preview/servicelinker.json#L593:7
    Old: Microsoft.ServiceLinker/preview/2021-11-01-preview/servicelinker.json#L585:7
    ️⚠️LintDiff: 1 Warnings warning [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: GetConfiguration
    Location: Microsoft.ServiceLinker/preview/2021-11-01-preview/servicelinker.json#L361


    The following errors/warnings exist before current PR submission:

    Rule Message
    ⚠️ R2066 - PostOperationIdContainsUrlVerb OperationId should contain the verb: 'validatelinker' in:'Linker_Validate'. Consider updating the operationId
    Location: Microsoft.ServiceLinker/preview/2021-11-01-preview/servicelinker.json#L271
    ️️✔️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-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-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 24, 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-track2 - armservicelinker - 0.3.0
    +	Function `ErrorDetail.MarshalJSON` has been removed
    +	Struct `ErrorAdditionalInfo` has been removed
    +	Struct `ErrorDetail` has been removed
    +	Struct `ErrorResponse` has been removed
    ️✔️azure-sdk-for-go - preview/servicelinker/mgmt/2021-11-01-preview/servicelinker - v61.6.0
    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-servicelinker - 1.0.0b1
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 9967109. 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! 8.3.1 -> 8.5.1
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.5.1>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-servicelinker [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model LinkerPatch has a new parameter secret_store
      info	[Changelog]   - Model LinkerPatch has a new parameter v_net_solution
      info	[Changelog]   - Model LinkerResource has a new parameter secret_store
      info	[Changelog]   - Model LinkerResource has a new parameter v_net_solution
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 9967109. SDK Automation 14.0.0
      command	./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] 2022-02-24 06:01:54 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-servicelinker"
      cmderr	[generate.py] 2022-02-24 06:01:54 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2022-02-24 06:01:54 INFO autorest --version=3.6.6 --use=@autorest/[email protected] --java --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/servicelinker/azure-resourcemanager-servicelinker --java.namespace=com.azure.resourcemanager.servicelinker   --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --generate-samples --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL  ../azure-rest-api-specs/specification/servicelinker/resource-manager/readme.md
      cmderr	[generate.py] 2022-02-24 06:02:24 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2022-02-24 06:02:24 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2022-02-24 06:02:24 INFO [POM][Skip] pom already has module azure-resourcemanager-servicelinker
      cmderr	[generate.py] 2022-02-24 06:02:24 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2022-02-24 06:02:24 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2022-02-24 06:02:24 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-servicelinker [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2022-02-24 06:03:53 DEBUG Got artifact_id: azure-resourcemanager-servicelinker
      cmderr	[Inst] 2022-02-24 06:03:53 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2022-02-24 06:03:53 DEBUG Got artifact: azure-resourcemanager-servicelinker-1.0.0-beta.1.jar
      cmderr	[Inst] 2022-02-24 06:03:53 DEBUG Match jar package: azure-resourcemanager-servicelinker-1.0.0-beta.1.jar
      cmderr	[Inst] 2022-02-24 06:03:53 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/17978/azure-sdk-for-java/azure-resourcemanager-servicelinker/azure-resourcemanager-servicelinker-1.0.0-beta.1.jar\" -o azure-resourcemanager-servicelinker-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-servicelinker -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-servicelinker-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 9967109. 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
    • ️✔️preview/servicelinker/mgmt/2021-11-01-preview/servicelinker [View full logs]  [Release SDK Changes]
      info	[Changelog] This is a new package
      info	[Changelog]
    ️️✔️ azure-sdk-for-go-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 9967109. 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
    • ️✔️armservicelinker [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Function `ErrorDetail.MarshalJSON` has been removed
      info	[Changelog] - Struct `ErrorAdditionalInfo` has been removed
      info	[Changelog] - Struct `ErrorDetail` has been removed
      info	[Changelog] - Struct `ErrorResponse` has been removed
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New const `VNetSolutionTypeServiceEndpoint`
      info	[Changelog] - New const `VNetSolutionTypePrivateLink`
      info	[Changelog] - New function `VNetSolutionType.ToPtr() *VNetSolutionType`
      info	[Changelog] - New function `PossibleVNetSolutionTypeValues() []VNetSolutionType`
      info	[Changelog] - New struct `SecretStore`
      info	[Changelog] - New struct `VNetSolution`
      info	[Changelog] - New field `SecretStore` in struct `LinkerProperties`
      info	[Changelog] - New field `VNetSolution` in struct `LinkerProperties`
      info	[Changelog]
      info	[Changelog] Total 7 breaking change(s), 9 additive change(s).
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 9967109. 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
      cmderr	[automation_init.sh]  deprecated [email protected]: The functionality that this package provided is now in @npmcli/arborist
      cmderr	[automation_init.sh] npm WARN deprecated @opentelemetry/[email protected]: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
      cmderr	[automation_init.sh]  deprecated [email protected]: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
      cmderr	[automation_init.sh] notice created a lockfile as package-lock.json. You should commit this file.
      cmderr	[automation_init.sh] npm WARN @octokit/[email protected] requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
      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
    • ️✔️track2_@azure/arm-servicelinker [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 9967109. 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
    • ️✔️servicelinker [View full logs]  [Release Schema Changes]
    Posted by Swagger Pipeline | How to fix these errors?

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

    @raych1 raych1 added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Feb 24, 2022
    @raych1
    Copy link
    Member

    raych1 commented Feb 24, 2022

    Breaking change policy is out of scope as service is not GAed.

    @raych1 raych1 merged commit 9967109 into main Feb 24, 2022
    @ChenTanyi ChenTanyi deleted the servicelinker-2021-11-01 branch February 24, 2022 05:56
    FredericHeem pushed a commit to grucloud/azure-rest-api-specs that referenced this pull request Mar 7, 2022
    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 CI-BreakingChange-Go-V2
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants