Skip to content

Conversation

@juniwang
Copy link
Member

@juniwang juniwang commented Mar 26, 2021

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

Changelog

Please ensure to add changelog with 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 you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after 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, no need to refresh 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

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
    • Adding a new service
  • Please 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 there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in 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.

@juniwang juniwang requested a review from ArcturusZhang as a code owner March 26, 2021 05:17
@openapi-workflow-bot
Copy link

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

    Swagger pipeline can not start as the pull request has merge conflicts.

    @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

    Swagger pipeline can not start as the pull request has merge conflicts.

    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Mar 26, 2021
    @openapi-workflow-bot
    Copy link

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

    @juniwang juniwang force-pushed the juniwang/sr202010401preview branch from daad4c6 to 7dc1823 Compare March 26, 2021 05:25
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 26, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:
    Rule Message
    ⚠️ R4014 - AllResourcesMustHaveGetOperation The resource 'PrivateLinkResource' does not have get operation, please add it.
    Location: azure-rest-api-specs/blob/659190e892644e7f699ff66f3023b34bd8d9eb26/undefined#Lundefined
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️⚠️[Staging] Cross Version BreakingChange (Base on preview version): 25 Warnings warning [Detail]

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

    Rule Message
    ⚠️ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'SignalRServiceName' removed or renamed?
    New: Microsoft.SignalRService/preview/2021-04-01-preview/signalr.json#L2178:3
    Old: Microsoft.SignalRService/preview/2020-07-01-preview/signalr.json#L1804:3
    ⚠️ 1011 - AddingResponseCode The new version adds a response code '200'.
    New: Microsoft.SignalRService/preview/2021-04-01-preview/signalr.json#L355:11
    ⚠️ 1011 - AddingResponseCode The new version adds a response code '200'.
    New: Microsoft.SignalRService/preview/2021-04-01-preview/signalr.json#L651:11
    ⚠️ 1011 - AddingResponseCode The new version adds a response code '202'.
    New: Microsoft.SignalRService/preview/2021-04-01-preview/signalr.json#L751:11
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: Microsoft.SignalRService/preview/2021-04-01-preview/signalr.json#L40:13
    Old: Microsoft.SignalRService/preview/2020-07-01-preview/signalr.json#L40:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: common-types/resource-management/v2/types.json#L317:9
    Old: Microsoft.SignalRService/preview/2020-07-01-preview/signalr.json#L810:9
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: common-types/resource-management/v2/types.json#L298:11
    Old: Microsoft.SignalRService/preview/2020-07-01-preview/signalr.json#L839:11
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: Microsoft.SignalRService/preview/2021-04-01-preview/signalr.json#L95:13
    Old: Microsoft.SignalRService/preview/2020-07-01-preview/signalr.json#L95:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: Microsoft.SignalRService/preview/2021-04-01-preview/signalr.json#L138:13
    Old: Microsoft.SignalRService/preview/2020-07-01-preview/signalr.json#L138:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: Microsoft.SignalRService/preview/2021-04-01-preview/signalr.json#L177:13
    Old: Microsoft.SignalRService/preview/2020-07-01-preview/signalr.json#L177:13
    ️⚠️[Staging] Cross Version BreakingChange (Base on stable version): 26 Warnings warning [Detail]

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

    Rule Message
    ⚠️ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'SignalRServiceName' removed or renamed?
    New: Microsoft.SignalRService/preview/2021-04-01-preview/signalr.json#L2178:3
    Old: Microsoft.SignalRService/stable/2020-05-01/signalr.json#L1695:3
    ⚠️ 1011 - AddingResponseCode The new version adds a response code '200'.
    New: Microsoft.SignalRService/preview/2021-04-01-preview/signalr.json#L651:11
    ⚠️ 1011 - AddingResponseCode The new version adds a response code '202'.
    New: Microsoft.SignalRService/preview/2021-04-01-preview/signalr.json#L751:11
    ⚠️ 1011 - AddingResponseCode The new version adds a response code '200'.
    New: Microsoft.SignalRService/preview/2021-04-01-preview/signalr.json#L355:11
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: Microsoft.SignalRService/preview/2021-04-01-preview/signalr.json#L40:13
    Old: Microsoft.SignalRService/stable/2020-05-01/signalr.json#L40:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: common-types/resource-management/v2/types.json#L317:9
    Old: Microsoft.SignalRService/stable/2020-05-01/signalr.json#L949:9
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: common-types/resource-management/v2/types.json#L298:11
    Old: Microsoft.SignalRService/stable/2020-05-01/signalr.json#L978:11
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: Microsoft.SignalRService/preview/2021-04-01-preview/signalr.json#L95:13
    Old: Microsoft.SignalRService/stable/2020-05-01/signalr.json#L95:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: Microsoft.SignalRService/preview/2021-04-01-preview/signalr.json#L177:13
    Old: Microsoft.SignalRService/stable/2020-05-01/signalr.json#L131:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: Microsoft.SignalRService/preview/2021-04-01-preview/signalr.json#L219:13
    Old: Microsoft.SignalRService/stable/2020-05-01/signalr.json#L173:13
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️[Staging] SDK Track2 Validation: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:
    Rule Message
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"signalr/resource-manager/readme.md",
    "tag":"package-2018-10-01",
    "details":"Schema 'SignalRResource' has a property 'id' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from SignalRResource"
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"signalr/resource-manager/readme.md",
    "tag":"package-2018-10-01",
    "details":"Schema 'SignalRResource' has a property 'name' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from SignalRResource"
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"signalr/resource-manager/readme.md",
    "tag":"package-2018-10-01",
    "details":"Schema 'SignalRResource' has a property 'type' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from SignalRResource"
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"signalr/resource-manager/readme.md",
    "tag":"package-2018-03-01-preview",
    "details":"Schema 'SignalRResource' has a property 'id' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from SignalRResource"
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"signalr/resource-manager/readme.md",
    "tag":"package-2018-03-01-preview",
    "details":"Schema 'SignalRResource' has a property 'name' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from SignalRResource"
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"signalr/resource-manager/readme.md",
    "tag":"package-2018-03-01-preview",
    "details":"Schema 'SignalRResource' has a property 'type' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from SignalRResource"
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 26, 2021

    Swagger Generation Artifacts

    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from f5e595b. 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-04-12 08:13:36 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-signalr"
      cmderr	[generate.py] 2021-04-12 08:13:36 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-04-12 08:13:36 INFO autorest --version=3.1.3 --use=@autorest/java@4.0.23 --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/signalr/azure-resourcemanager-signalr --java.namespace=com.azure.resourcemanager.signalr   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/signalr/resource-manager/readme.md
      cmderr	[generate.py] 2021-04-12 08:14:04 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-04-12 08:14:04 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-04-12 08:14:04 INFO [POM][Skip] pom already has module azure-resourcemanager-signalr
      cmderr	[generate.py] 2021-04-12 08:14:04 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-04-12 08:14:04 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-04-12 08:14:04 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-signalr [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-04-12 08:16:28 DEBUG Got artifact_id: azure-resourcemanager-signalr
      cmderr	[Inst] 2021-04-12 08:16:28 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-04-12 08:16:28 DEBUG Got artifact: azure-resourcemanager-signalr-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-04-12 08:16:28 DEBUG Match jar package: azure-resourcemanager-signalr-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-04-12 08:16:28 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/13664/azure-sdk-for-java/azure-resourcemanager-signalr/azure-resourcemanager-signalr-1.0.0-beta.1.jar\" -o azure-resourcemanager-signalr-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-signalr -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-signalr-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from f5e595b. 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]  This version of npm is compatible with lockfileVersion@1, but package-lock.json was generated for lockfileVersion@2. I'll try to do my best with it!
      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
    • ️✔️signalr [View full logs]  [Release Schema Changes]
    ️🔄 azure-sdk-for-net inProgress [Detail]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from f5e595b. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️signalr/mgmt/2020-05-01/signalr [View full logs]  [Release SDK Changes]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New function `ResourceSku.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `CreateOrUpdateProperties.MarshalJSON() ([]byte, error)`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 2 additive change(s).
      info	[Changelog]
    • ️✔️signalr/mgmt/2018-10-01/signalr [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️preview/signalr/mgmt/2021-04-01-preview/signalr [View full logs]  [Release SDK Changes]
      info	[Changelog] This is a new package
    • ️✔️preview/signalr/mgmt/2020-07-01-preview/signalr [View full logs]  [Release SDK Changes]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New function `ResourceSku.MarshalJSON() ([]byte, error)`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 1 additive change(s).
      info	[Changelog]
    • ️✔️preview/signalr/mgmt/2018-03-01-preview/signalr [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from f5e595b. 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
    • ️✔️azure-mgmt-signalr [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model UpstreamTemplate has a new parameter auth
      info	[Changelog]   - Model SignalRResource has a new parameter tls
      info	[Changelog]   - Model SignalRResource has a new parameter shared_private_link_resources
      info	[Changelog]   - Model SignalRResource has a new parameter system_data
      info	[Changelog]   - Model SignalRResource has a new parameter identity
      info	[Changelog]   - Model PrivateEndpointConnection has a new parameter system_data
      info	[Changelog]   - Model PrivateLinkResource has a new parameter shareable_private_link_resource_types
      info	[Changelog]   - Added operation SignalRPrivateEndpointConnectionsOperations.list
      info	[Changelog]   - Added operation group SignalRSharedPrivateLinkResourcesOperations
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Model SignalRResource no longer has parameter host_name_prefix
      info	[Changelog]   - Operation SignalROperations.create_or_update has a new signature
      info	[Changelog]   - Operation SignalROperations.update has a new signature
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from f5e595b. 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.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/signalr/resource-manager/readme.md
    • ️✔️@azure/arm-signalr [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/signalRManagementClient.js → ./dist/arm-signalr.js...
      cmderr	[npmPack] created ./dist/arm-signalr.js in 329ms
    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

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

    @juniwang
    Copy link
    Member Author

    juniwang commented Apr 8, 2021

    can one of admins review it again please?

    @varunkumta varunkumta added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Apr 9, 2021
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Python

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    5 participants