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

[Microsoft.StorageSync] Update 2020-03-01 and 2020-09-01 specifications to address swagger correctness and completeness items. #16041

Merged
merged 5 commits into from
Oct 8, 2021

Conversation

anpint
Copy link
Member

@anpint anpint commented Sep 14, 2021

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

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.
    No service changes are needed for these specification changes.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
    Swagger will be publish once the fixes are signed off and the PR is completed.
  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
      -[x] 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-workflow-bot
Copy link

Hi, @anpint 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. vsswagger@microsoft.com

    @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 Sep 14, 2021

    Swagger Validation Report

    ️❌BreakingChange: 13 Errors, 0 Warnings failed [Detail]
    Rule Message
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L3075:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L3075:5
    1040 - AddedReadOnlyPropertyInResponse The new version has a new read-only property 'lastSyncMode' in response that was not found in the old version.
    New: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L4532:7
    Old: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L4331:7
    1040 - AddedReadOnlyPropertyInResponse The new version has a new read-only property 'syncMode' in response that was not found in the old version.
    New: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L4590:7
    Old: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L4384:7
    1040 - AddedReadOnlyPropertyInResponse The new version has a new read-only property 'agentVersionStatus' in response that was not found in the old version.
    New: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L4201:7
    Old: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L4011:7
    1040 - AddedReadOnlyPropertyInResponse The new version has a new read-only property 'agentVersionExpirationDate' in response that was not found in the old version.
    New: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L4201:7
    Old: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L4011:7
    1041 - AddedPropertyInResponse The new version has a new property 'properties' in response that was not found in the old version.
    New: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L3677:7
    Old: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L3569:7
    1041 - AddedPropertyInResponse The new version has a new property 'requestUri' in response that was not found in the old version.
    New: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L3180:7
    Old: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L3116:7
    1041 - AddedPropertyInResponse The new version has a new property 'exceptionType' in response that was not found in the old version.
    New: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L3180:7
    Old: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L3116:7
    1041 - AddedPropertyInResponse The new version has a new property 'httpMethod' in response that was not found in the old version.
    New: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L3180:7
    Old: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L3116:7
    1041 - AddedPropertyInResponse The new version has a new property 'hashedMessage' in response that was not found in the old version.
    New: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L3180:7
    Old: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L3116:7
    1041 - AddedPropertyInResponse The new version has a new property 'httpErrorCode' in response that was not found in the old version.
    New: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L3180:7
    Old: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L3116:7
    1041 - AddedPropertyInResponse The new version has a new property 'innerError' in response that was not found in the old version.
    New: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L3154:7
    Old: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L3094:7
    ️⚠️LintDiff: 4 Warnings warning [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ R1005 - GetInOperationName 'GET' operation 'LocationOperationStatus' 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.StorageSync/stable/2020-03-01/storagesync.json#L3102
    ⚠️ R1005 - GetInOperationName 'GET' operation 'LocationOperationStatus' 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.StorageSync/stable/2020-09-01/storagesync.json#L3102
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Workflows_Get
    Location: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L3104
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Workflows_Get
    Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L3104


    The following errors/warnings exist before current PR submission:

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

    Rule Message
    R4009 - RequiredReadOnlySystemData The response of operation:'StorageSyncServices_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L199
    R4009 - RequiredReadOnlySystemData The response of operation:'PrivateEndpointConnections_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L560
    R4009 - RequiredReadOnlySystemData The response of operation:'SyncGroups_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L940
    R4009 - RequiredReadOnlySystemData The response of operation:'CloudEndpoints_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L1167
    R4009 - RequiredReadOnlySystemData The response of operation:'ServerEndpoints_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L2124
    R4009 - RequiredReadOnlySystemData The response of operation:'RegisteredServers_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L2501
    R4009 - RequiredReadOnlySystemData The response of operation:'Workflows_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L2882
    R4009 - RequiredReadOnlySystemData The response of operation:'StorageSyncServices_Create' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L120
    R4009 - RequiredReadOnlySystemData The response of operation:'PrivateEndpointConnections_Create' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L603
    R4009 - RequiredReadOnlySystemData The response of operation:'SyncGroups_Create' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L870
    R4009 - RequiredReadOnlySystemData The response of operation:'CloudEndpoints_Create' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L1064
    R4009 - RequiredReadOnlySystemData The response of operation:'ServerEndpoints_Create' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L1927
    R4009 - RequiredReadOnlySystemData The response of operation:'RegisteredServers_Create' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L2562
    R4009 - RequiredReadOnlySystemData The response of operation:'StorageSyncServices_Update' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L253
    R4009 - RequiredReadOnlySystemData The response of operation:'ServerEndpoints_Update' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L2026
    R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L109
    R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L549
    R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L109
    R4010 - RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L549
    R4011 - DeleteOperationResponses The delete operation is defined without a 200 or 204 error response implementation,please add it.'
    Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L2235
    R4011 - DeleteOperationResponses The delete operation is defined without a 200 or 204 error response implementation,please add it.'
    Location: Microsoft.StorageSync/stable/2020-03-01/storagesync.json#L2235
    R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L3475
    R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L3482
    R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L3958
    R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L4127
    R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L4248
    R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L4380
    R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L4386
    R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L4418
    R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.StorageSync/stable/2020-09-01/storagesync.json#L4424
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️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.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot openapi-workflow-bot bot added FixS360 WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Sep 14, 2021
    @openapi-workflow-bot
    Copy link

    Hi, @anpint your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Sep 14, 2021

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-storagesync - 1.0.0
    ️✔️azure-sdk-for-go - storagesync/mgmt/2020-09-01/storagesync - v58.0.0
    ️✔️azure-sdk-for-go - storagesync/mgmt/2020-03-01/storagesync - v58.0.0
    ️✔️azure-sdk-for-go - storagesync/mgmt/2019-10-01/storagesync - v58.0.0
    ️✔️azure-sdk-for-go - storagesync/mgmt/2019-06-01/storagesync - v58.0.0
    ️✔️azure-sdk-for-go - storagesync/mgmt/2019-02-01/storagesync - v58.0.0
    ️✔️azure-sdk-for-go - storagesync/mgmt/2018-10-01/storagesync - v58.0.0
    ️✔️azure-sdk-for-go - storagesync/mgmt/2018-07-01/storagesync - v58.0.0
    ️✔️azure-sdk-for-go - storagesync/mgmt/2018-04-02/storagesync - v58.0.0
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from a90c57a. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-5.0
      command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/storagesync/resource-manager/readme.md
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
    • ️✔️Microsoft.Azure.Management.StorageSync [View full logs]  [Release SDK Changes]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from a90c57a. 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-storagesync [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model ServerEndpointCreateParameters has a new parameter initial_upload_policy
      info	[Changelog]   - Model CloudEndpoint has a new parameter change_enumeration_status
      info	[Changelog]   - Model ServerEndpoint has a new parameter initial_upload_policy
      info	[Changelog]   - Model ServerEndpointBackgroundDataDownloadActivity has a new parameter started_timestamp
      info	[Changelog]   - Model ServerEndpointSyncActivityStatus has a new parameter session_minutes_remaining
      info	[Changelog]   - Added operation group MicrosoftStorageSyncOperationsMixin
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from a90c57a. 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] 2021-10-08 05:53:47 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-storagesync"
      cmderr	[generate.py] 2021-10-08 05:53:47 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-10-08 05:53:47 INFO autorest --version=3.6.0 --use=@autorest/java@4.0.38 --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/storagesync/azure-resourcemanager-storagesync --java.namespace=com.azure.resourcemanager.storagesync   --java --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/storagesync/resource-manager/readme.md
      cmderr	[generate.py] 2021-10-08 05:54:20 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-10-08 05:54:20 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-10-08 05:54:20 INFO [POM][Skip] pom already has module azure-resourcemanager-storagesync
      cmderr	[generate.py] 2021-10-08 05:54:20 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-10-08 05:54:20 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-10-08 05:54:20 INFO [POM][Success] Write to root pom
      cmderr	[generate.py] 2021-10-08 05:55:37 ERROR [COMPILE] Maven build fail
    • ️✔️azure-resourcemanager-storagesync [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-10-08 05:55:39 DEBUG Got artifact_id: azure-resourcemanager-storagesync
      cmderr	[Inst] 2021-10-08 05:55:39 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-10-08 05:55:39 DEBUG Got artifact: azure-resourcemanager-storagesync-1.0.0-beta.1-sources.jar
      cmderr	[Inst] 2021-10-08 05:55:39 DEBUG Got artifact: azure-resourcemanager-storagesync-1.0.0-beta.1-javadoc.jar
      cmderr	[Inst] 2021-10-08 05:55:39 DEBUG Got artifact: azure-resourcemanager-storagesync-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-10-08 05:55:39 DEBUG Match jar package: azure-resourcemanager-storagesync-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-10-08 05:55:39 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/16041/azure-sdk-for-java/azure-resourcemanager-storagesync/azure-resourcemanager-storagesync-1.0.0-beta.1.jar\" -o azure-resourcemanager-storagesync-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-storagesync -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-storagesync-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from a90c57a. SDK Automation 14.0.0
      command	sh ./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
    • ️✔️storagesync/mgmt/2020-09-01/storagesync [View full logs]  [Release SDK Changes]
      info	[Changelog] This is a new package
    • ️✔️storagesync/mgmt/2020-03-01/storagesync [View full logs
      Only show 15 items here, please refer to log for details.
      info	[Changelog] - New struct `OperationResourceServiceSpecification`
      info	[Changelog] - New field `InnerError` in struct `APIError`
      info	[Changelog] - New field `SyncMode` in struct `ServerEndpointSyncActivityStatus`
      info	[Changelog] - New field `Properties` in struct `OperationEntity`
      info	[Changelog] - New field `LastSyncMode` in struct `ServerEndpointSyncSessionStatus`
      info	[Changelog] - New field `AgentVersionExpirationDate` in struct `RegisteredServerProperties`
      info	[Changelog] - New field `AgentVersionStatus` in struct `RegisteredServerProperties`
      info	[Changelog] - New field `ExceptionType` in struct `ErrorDetails`
      info	[Changelog] - New field `HTTPMethod` in struct `ErrorDetails`
      info	[Changelog] - New field `HashedMessage` in struct `ErrorDetails`
      info	[Changelog] - New field `HTTPErrorCode` in struct `ErrorDetails`
      info	[Changelog] - New field `RequestURI` in struct `ErrorDetails`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 35 additive change(s).
      info	[Changelog]
    • ️✔️storagesync/mgmt/2019-10-01/storagesync [View full logs
      info	[Changelog] No exported changes
    • ️✔️storagesync/mgmt/2019-06-01/storagesync [View full logs
      info	[Changelog] No exported changes
    • ️✔️storagesync/mgmt/2019-02-01/storagesync [View full logs
      info	[Changelog] No exported changes
    • ️✔️storagesync/mgmt/2018-10-01/storagesync [View full logs
      info	[Changelog] No exported changes
    • ️✔️storagesync/mgmt/2018-07-01/storagesync [View full logs
      info	[Changelog] No exported changes
    • ️✔️storagesync/mgmt/2018-04-02/storagesync [View full logs
      info	[Changelog] No exported changes
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from a90c57a. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.7.0 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/storagesync/resource-manager/readme.md
    • ️✔️@azure/arm-storagesync [View full logs]  [Release SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/storageSyncManagementClient.js → ./dist/arm-storagesync.js...
      cmderr	[npmPack] created ./dist/arm-storagesync.js in 496ms
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from a90c57a. 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
    • ️✔️storagesync [View full logs
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @anpint, 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

    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.

    @anpint
    Copy link
    Member Author

    anpint commented Sep 14, 2021

    Filed work item for breaking change review: Scenario 10931913: Breaking change review for Microsoft.StorageSync, API Versions 2020-03-01 and 2020-09-01

    @lirenhe
    Copy link
    Member

    lirenhe commented Sep 15, 2021

    @anpint, as your PR contains breaking changes, could you follow http://aka.ms/bcforapi to get it reviewed?

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Sep 20, 2021
    @anpint
    Copy link
    Member Author

    anpint commented Sep 20, 2021

    @anpint, as your PR contains breaking changes, could you follow http://aka.ms/bcforapi to get it reviewed?

    Thanks @lirenhe we just went through a review of the breaking changes and it was approved. Please let me know if anything else is needed to merge the PR

    @lirenhe
    Copy link
    Member

    lirenhe commented Sep 27, 2021

    @anpint, as your PR contains breaking changes, could you follow http://aka.ms/bcforapi to get it reviewed?

    Thanks @lirenhe we just went through a review of the breaking changes and it was approved. Please let me know if anything else is needed to merge the PR

    As the PR add some new APIs, could you also work with ARM team to get their approval? I added the label of 'WaitForArmFeedback' but you could reach them directly for the review.

    @@ -3071,6 +3071,66 @@
    }
    }
    }
    },
    "/subscriptions/{subscriptionId}/providers/Microsoft.StorageSync/locations/{locationName}/operations/{operationId}": {
    Copy link
    Member

    Choose a reason for hiding this comment

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

    @anpint
    Your spec defines operations API as /subscriptions/{subscriptionId}/providers/Microsoft.StorageSync/locations/{locationName}/operations/{operationId}
    But the examples use operationResults in the ID. Which one is correct?

    Can you point me to your S360 error?

    Copy link
    Member

    Choose a reason for hiding this comment

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

    As per our offline discussion I understand the resource name 'operations' is correct and is what your shipped API is using for Azure-AsyncOperation format. The resourceName should be 'operationStatuses'. Refer https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/async-api-reference.md#azure-asyncoperation-resource-format

    The resource name 'operations' confuses with RP general operations API. Please add a work item to fix the resource name in future API versions.

    I am signing off now as this is an existing API and you are trying to fix S360 error.

    @RamyasreeChakka RamyasreeChakka added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Oct 4, 2021
    @RamyasreeChakka RamyasreeChakka added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review labels Oct 4, 2021
    @anpint
    Copy link
    Member Author

    anpint commented Oct 4, 2021

    @anpint, as your PR contains breaking changes, could you follow http://aka.ms/bcforapi to get it reviewed?

    Thanks @lirenhe we just went through a review of the breaking changes and it was approved. Please let me know if anything else is needed to merge the PR

    As the PR add some new APIs, could you also work with ARM team to get their approval? I added the label of 'WaitForArmFeedback' but you could reach them directly for the review.

    @lirenhe We've completed the ARM review as well. Please go ahead and merge this PR for us unless there's anything else we need to do. Thanks.

    @lirenhe lirenhe merged commit a90c57a into Azure:main Oct 8, 2021
    jovannikolov-msft pushed a commit to jovannikolov-msft/azure-rest-api-specs that referenced this pull request Dec 1, 2021
    …ns to address swagger correctness and completeness items. (Azure#16041)
    
    * Address swagger correctness items in 2020-03-01 API version. Added various properties that are returned by RP but not defined in swagger.
    
    * Swagger completeness: Add location based async operation polling
    
    * Fix reference to example file for 2020-09-01
    
    * Fix semantic validation error for 2020-09-01 and fix a typo in 2020-03-01
    
    * Fix typo in examples for location based operations API
    @anpint anpint deleted the anpint-storagesync-fixS360 branch December 20, 2021 22:40
    LeiWang3 pushed a commit to LeiWang3/azure-rest-api-specs that referenced this pull request Mar 31, 2022
    …ns to address swagger correctness and completeness items. (Azure#16041)
    
    * Address swagger correctness items in 2020-03-01 API version. Added various properties that are returned by RP but not defined in swagger.
    
    * Swagger completeness: Add location based async operation polling
    
    * Fix reference to example file for 2020-09-01
    
    * Fix semantic validation error for 2020-09-01 and fix a typo in 2020-03-01
    
    * Fix typo in examples for location based operations API
    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 ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review FixS360 Reviewed-FeedbackProvided
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants