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.

Sign up for GitHub

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

Jump to bottom

Adding default values to fix correctness issue #12286

Merged
merged 2 commits into from
Jan 12, 2021
Merged

Adding default values to fix correctness issue #12286

merged 2 commits into from
Jan 12, 2021

Conversation

juniwang
Copy link
Contributor

@juniwang juniwang commented Jan 5, 2021 •
edited
Loading

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

Adding default values for some properties

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
    • 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 API 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 version with Breaking Change Validation errors
  • Updating API(s) in preview over 1 year

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

    openapi-pipeline-app bot commented Jan 5, 2021 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.

    ️️✔️LintDiff succeeded [Detail] [Expand] 
    Validation passes for LintDiff.

    ️️✔️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) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand] 
    There is no credential detected.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 5, 2021 •
    edited
    Loading

    Swagger Generation Artifacts

    ️️✔️ azure-sdk-for-python succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 0467bd6. SDK Automation 14.0.0 
      warn	Skip initScript due to not configured
command	npx n 12
command	python3 -m venv venv
command	pip install --upgrade setuptools wheel pip
command	pip install pathlib jinja2 msrestazure
command	autorest --version=V2 --use=@microsoft.azure/autorest.python@~4.0.71 --python --python-mode=update --multiapi --keep-version-file --no-async --python-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-python/sdk ../azure-rest-api-specs/specification/signalr/resource-manager/readme.md
    • ️✔️azure-mgmt-signalr [View full logs]  [Release SDK Changes] Breaking Change Detected
      cmderr	[buildConf] INFO:packaging_tools:Building template azure-mgmt-signalr
cmderr	[buildConf] INFO:packaging_tools.conf:Skipping default conf since the file exists
cmderr	[buildConf] INFO:packaging_tools:Skipping CHANGELOG.md template, since a previous one was found
cmderr	[buildConf] INFO:packaging_tools:Template done azure-mgmt-signalr
cmderr	[changelogSetup] WARNING: Skipping azure-nspkg as it is not installed.
cmderr	[changelogReport] INFO:__main__:Looking for Autorest generated package in azure.mgmt.signalr
cmderr	[changelogReport] INFO:__main__:Found azure.mgmt.signalr
cmderr	[changelogReport] INFO:__main__:Working on azure.mgmt.signalr
cmderr	[changelogReport] INFO:__main__:Report written to sdk/signalr/azure-mgmt-signalr/code_reports/latest/report.json
cmderr	[changelogReportLatest] INFO:__main__:Download versions of azure-mgmt-signalr on PyPI
cmderr	[changelogReportLatest] INFO:__main__:Got ['0.1.0', '0.1.1', '0.2.0', '0.3.0', '0.4.0', '1.0.0b1']
cmderr	[changelogReportLatest] INFO:__main__:Only keep last PyPI version
cmderr	[changelogReportLatest] INFO:__main__:Installing version 0.4.0 of azure-mgmt-signalr in a venv
cmderr	[changelogReportLatest] Cache entry deserialization failed, entry ignored
cmderr	[changelogReportLatest] INFO:__main__:Looking for Autorest generated package in azure.mgmt.signalr
cmderr	[changelogReportLatest] INFO:__main__:Found azure.mgmt.signalr
cmderr	[changelogReportLatest] INFO:__main__:Working on azure.mgmt.signalr
cmderr	[changelogReportLatest] INFO:__main__:Report written to sdk/signalr/azure-mgmt-signalr/code_reports/0.4.0/report.json
cmdout	[Changelog] Size of delta 11.507% size of original (original: 23012 chars, delta: 2648 chars)
cmdout	[Changelog] **Features**
cmdout	[Changelog]   - Model SignalRResource has a new parameter identity
cmdout	[Changelog]   - Model SignalRResource has a new parameter tls
cmdout	[Changelog]   - Model UpstreamTemplate has a new parameter auth
cmdout	[Changelog] **Breaking changes**
cmdout	[Changelog]   - Model SignalRResource no longer has parameter host_name_prefix
cmdout	[Changelog]   - Model SignalRCreateOrUpdateProperties no longer has parameter host_name_prefix
warn	Breaking change found in changelog
    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 0467bd6. Schema Automation 14.0.0 
      warn	Skip initScript due to not configured
command	npx n 12
command	autorest --use=@autorest/azureresourceschema@3.0.92 --version=3.0.6320 --azureresourceschema --multiapi --title=none --pass-thru:subset-reducer --azureresourceschema-folder=/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas ../../azure-rest-api-specs/specification/signalr/resource-manager/readme.md
    • ️✔️signalr [View full logs]  [Release Schema Changes] 
      cmderr	[resource-manager] node-pre-gyp
cmderr	[resource-manager] WARN Using request for node-pre-gyp https download
cmderr	[resource-manager] WARN template-schema-validation-tools@1.0.0 No repository field.
cmderr	[resource-manager]  optional SKIPPING OPTIONAL DEPENDENCY: fsevents@2.1.3 (node_modules/fsevents):
cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.1.3: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
    ️❌ azure-sdk-for-net failed [Detail]
    • ❌Failed [Logs]Release - Generate from 0467bd6. 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/signalr/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.SignalR [View full logs]  [Release SDK Changes] 
      cmdout	[msbuild]      3>/home/vsts/work/1/s/azure-sdk-for-net/sdk/signalr/Microsoft.Azure.Management.SignalR/tests/Tests/SignalRTests.cs(187,21): error CS0200: Property or indexer 'ResourceSku.Size' cannot be assigned to -- it is read only [/home/vsts/work/1/s/azure-sdk-for-net/sdk/signalr/Microsoft.Azure.Management.SignalR/tests/Microsoft.Azure.Management.SignalR.Tests.csproj]
cmdout	[msbuild]      3>/home/vsts/work/1/s/azure-sdk-for-net/sdk/signalr/Microsoft.Azure.Management.SignalR/tests/Tests/SignalRTests.cs(190,17): error CS0117: 'SignalRResource' does not contain a definition for 'HostNamePrefix' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/signalr/Microsoft.Azure.Management.SignalR/tests/Microsoft.Azure.Management.SignalR.Tests.csproj]
cmdout	[msbuild]      3>/home/vsts/work/1/s/azure-sdk-for-net/sdk/signalr/Microsoft.Azure.Management.SignalR/tests/Helpers/SignalRTestUtilities.cs(75,21): error CS0200: Property or indexer 'ResourceSku.Size' cannot be assigned to -- it is read only [/home/vsts/work/1/s/azure-sdk-for-net/sdk/signalr/Microsoft.Azure.Management.SignalR/tests/Microsoft.Azure.Management.SignalR.Tests.csproj]
cmdout	[msbuild]      3>/home/vsts/work/1/s/azure-sdk-for-net/sdk/signalr/Microsoft.Azure.Management.SignalR/tests/Helpers/SignalRTestUtilities.cs(85,21): error CS0200: Property or indexer 'ResourceSku.Size' cannot be assigned to -- it is read only [/home/vsts/work/1/s/azure-sdk-for-net/sdk/signalr/Microsoft.Azure.Management.SignalR/tests/Microsoft.Azure.Management.SignalR.Tests.csproj]
cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/signalr/Microsoft.Azure.Management.SignalR/tests/Tests/SignalRTests.cs(187,21): error CS0200: Property or indexer 'ResourceSku.Size' cannot be assigned to -- it is read only [/home/vsts/work/1/s/azure-sdk-for-net/sdk/signalr/Microsoft.Azure.Management.SignalR/tests/Microsoft.Azure.Management.SignalR.Tests.csproj]
cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/signalr/Microsoft.Azure.Management.SignalR/tests/Tests/SignalRTests.cs(190,17): error CS0117: 'SignalRResource' does not contain a definition for 'HostNamePrefix' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/signalr/Microsoft.Azure.Management.SignalR/tests/Microsoft.Azure.Management.SignalR.Tests.csproj]
cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/signalr/Microsoft.Azure.Management.SignalR/tests/Helpers/SignalRTestUtilities.cs(75,21): error CS0200: Property or indexer 'ResourceSku.Size' cannot be assigned to -- it is read only [/home/vsts/work/1/s/azure-sdk-for-net/sdk/signalr/Microsoft.Azure.Management.SignalR/tests/Microsoft.Azure.Management.SignalR.Tests.csproj]
cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/signalr/Microsoft.Azure.Management.SignalR/tests/Helpers/SignalRTestUtilities.cs(85,21): error CS0200: Property or indexer 'ResourceSku.Size' cannot be assigned to -- it is read only [/home/vsts/work/1/s/azure-sdk-for-net/sdk/signalr/Microsoft.Azure.Management.SignalR/tests/Microsoft.Azure.Management.SignalR.Tests.csproj]
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: dotnet
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 0467bd6. 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 317ms
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 0467bd6. 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-01-12 01:28:32 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-signalr"
cmderr	[generate.py] 2021-01-12 01:28:32 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
cmderr	[generate.py] 2021-01-12 01:28:32 INFO autorest --version=3.0.6350 --use=@autorest/java@4.0.8 --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  --package-version=1.0.0-beta.1 --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-01-12 01:29:12 INFO [CI][Success] Write to ci.yml
cmderr	[generate.py] 2021-01-12 01:29:12 INFO [POM][Process] dealing with pom.xml
cmderr	[generate.py] 2021-01-12 01:29:12 INFO [POM][Skip] pom already has module azure-resourcemanager-signalr
cmderr	[generate.py] 2021-01-12 01:29:12 INFO [POM][Success] Write to pom.xml
cmderr	[generate.py] 2021-01-12 01:29:12 INFO [POM][Process] dealing with root pom
cmderr	[generate.py] 2021-01-12 01:29:12 INFO [POM][Success] Write to root pom
cmderr	[generate.py] WARNING: An illegal reflective access operation has occurred
cmderr	[generate.py] WARNING: Illegal reflective access by org.codehaus.groovy.reflection.ReflectionUtils (file:/home/vsts/.m2/repository/org/codehaus/groovy/groovy/3.0.0-beta-2/groovy-3.0.0-beta-2-indy.jar) to method java.util.Collections$UnmodifiableCollection.toString()
cmderr	[generate.py] WARNING: Please consider reporting this to the maintainers of org.codehaus.groovy.reflection.ReflectionUtils
cmderr	[generate.py] WARNING: Use --illegal-access=warn to enable warnings of further illegal reflective access operations
cmderr	[generate.py] WARNING: All illegal access operations will be denied in a future release
    • ️✔️azure-resourcemanager-signalr [View full logs]  [Release SDK Changes] 
      cmderr	[Inst] 2021-01-12 01:31:30 DEBUG Got artifact_id: azure-resourcemanager-signalr
cmderr	[Inst] 2021-01-12 01:31:30 DEBUG Got artifact: pom.xml
cmderr	[Inst] 2021-01-12 01:31:30 DEBUG Got artifact: azure-resourcemanager-signalr-1.0.0-beta.1-sources.jar
cmderr	[Inst] 2021-01-12 01:31:30 DEBUG Got artifact: azure-resourcemanager-signalr-1.0.0-beta.1.jar
cmderr	[Inst] 2021-01-12 01:31:30 DEBUG Match jar package: azure-resourcemanager-signalr-1.0.0-beta.1.jar
cmderr	[Inst] 2021-01-12 01:31:30 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/12286/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-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 0467bd6. 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
    • ️✔️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]
    • ️✔️signalr/mgmt/2020-05-01/signalr [View full logs]  [Release SDK Changes] 
      info	[Changelog] ## New Content
info	[Changelog]
info	[Changelog] - New function `CreateOrUpdateProperties.MarshalJSON() ([]byte, error)`
info	[Changelog] - New function `ResourceSku.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/2018-03-01-preview/signalr [View full logs]  [Release SDK Changes] 
      info	[Changelog] No exported changes
    ️️✔️[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."

    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Jan 5, 2021
    Closed
    This was referenced Jan 6, 2021
    Closed
    Closed
    Closed
    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Jan 6, 2021
    Closed
    @juniwang
    Copy link
    Contributor Author

    juniwang commented Jan 6, 2021

    Build failure for .net sdk is caused by the previous breaking change. Working on it to upgrade .net SDK and fix the UT.

    @leni-msft leni-msft merged commit 0467bd6 into Azure:master Jan 12, 2021
    This was referenced Jan 12, 2021
    Closed
    Closed
    Merged
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @leni-msft leni-msft leni-msft approved these changes

    Assignees

    @leni-msft leni-msft

    Labels
    CI-BreakingChange-Go CI-BreakingChange-Python
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    2 participants
    @juniwang @leni-msft