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

[NetAppFiles] Anf 8208 update swagger rest api to 2020 09 01 #11832

Merged

Conversation

audunn
Copy link
Member

@audunn audunn commented Nov 26, 2020

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

Adds new properties

  • securityOperators to active directory.
  • smbEncryption and smbContinuouslyAvailable to volume properties
  • Fix error in description of Resync volume replication operation that would confuse users. Non functional change for documentation.
  • Fix error in example for throughputMibps value in VolumeProperties
  • Added missing nextlink value to volumes

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-pipeline-app
Copy link

openapi-pipeline-app bot commented Nov 26, 2020

Swagger Validation Report

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

️⚠️LintDiff: 2 Warnings warning [Detail]

Rule Message
⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: smbEncryption
New: Microsoft.NetApp/stable/2020-09-01/netapp.json#L3489
⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: smbContinuouslyAvailable
New: Microsoft.NetApp/stable/2020-09-01/netapp.json#L3495
️️✔️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): 111 Warnings warning [Detail] Only 10 items are listed, please refer to log for more details.

Rule Message
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/mountTargets' removed or restructured?
New: azure-rest-api-specs/blob/3a1ed3e7b32f3d480cce60e2d85597f55441c8a8/
Old: Microsoft.NetApp/preview/2017-08-15/netapp.json#L674:5
⚠️ 1010 - AddingRequiredParameter The required parameter 'poolName' was added in the new version.
New: Microsoft.NetApp/stable/2020-09-01/netapp.json#L739:9
⚠️ 1010 - AddingRequiredParameter The required parameter 'resourceGroupName' was added in the new version.
New: Microsoft.NetApp/stable/2020-09-01/netapp.json#L1577:9
⚠️ 1010 - AddingRequiredParameter The required parameter 'subscriptionId' was added in the new version.
New: Microsoft.NetApp/stable/2020-09-01/netapp.json#L1577:9
⚠️ 1010 - AddingRequiredParameter The required parameter 'subscriptionId' was added in the new version.
New: Microsoft.NetApp/stable/2020-09-01/netapp.json#L739:9
⚠️ 1010 - AddingRequiredParameter The required parameter 'api-version' was added in the new version.
New: Microsoft.NetApp/stable/2020-09-01/netapp.json#L1410:9
⚠️ 1010 - AddingRequiredParameter The required parameter 'snapshotName' was added in the new version.
New: Microsoft.NetApp/stable/2020-09-01/netapp.json#L1410:9
⚠️ 1010 - AddingRequiredParameter The required parameter 'volumeName' was added in the new version.
New: Microsoft.NetApp/stable/2020-09-01/netapp.json#L1410:9
⚠️ 1010 - AddingRequiredParameter The required parameter 'poolName' was added in the new version.
New: Microsoft.NetApp/stable/2020-09-01/netapp.json#L1410:9
⚠️ 1010 - AddingRequiredParameter The required parameter 'accountName' was added in the new version.
New: Microsoft.NetApp/stable/2020-09-01/netapp.json#L1410:9
️⚠️[Staging] Cross Version BreakingChange (Base on stable version): 50 Warnings warning [Detail] Only 10 items are listed, please refer to log for more details.

Rule Message
⚠️ 1027 - DefaultValueChanged The new version has a different default value than the previous one.
New: Microsoft.NetApp/stable/2020-09-01/netapp.json#L1202:9
Old: Microsoft.NetApp/stable/2020-08-01/netapp.json#L1202:9
⚠️ 1027 - DefaultValueChanged The new version has a different default value than the previous one.
New: Microsoft.NetApp/stable/2020-09-01/netapp.json#L48:9
Old: Microsoft.NetApp/stable/2020-08-01/netapp.json#L48:9
⚠️ 1027 - DefaultValueChanged The new version has a different default value than the previous one.
New: Microsoft.NetApp/stable/2020-09-01/netapp.json#L171:9
Old: Microsoft.NetApp/stable/2020-08-01/netapp.json#L171:9
⚠️ 1027 - DefaultValueChanged The new version has a different default value than the previous one.
New: Microsoft.NetApp/stable/2020-09-01/netapp.json#L218:9
Old: Microsoft.NetApp/stable/2020-08-01/netapp.json#L218:9
⚠️ 1027 - DefaultValueChanged The new version has a different default value than the previous one.
New: Microsoft.NetApp/stable/2020-09-01/netapp.json#L4816:5
Old: Microsoft.NetApp/stable/2020-08-01/netapp.json#L4787:5
⚠️ 1027 - DefaultValueChanged The new version has a different default value than the previous one.
New: Microsoft.NetApp/stable/2020-09-01/netapp.json#L258:9
Old: Microsoft.NetApp/stable/2020-08-01/netapp.json#L258:9
⚠️ 1027 - DefaultValueChanged The new version has a different default value than the previous one.
New: Microsoft.NetApp/stable/2020-09-01/netapp.json#L296:9
Old: Microsoft.NetApp/stable/2020-08-01/netapp.json#L296:9
⚠️ 1027 - DefaultValueChanged The new version has a different default value than the previous one.
New: Microsoft.NetApp/stable/2020-09-01/netapp.json#L352:9
Old: Microsoft.NetApp/stable/2020-08-01/netapp.json#L352:9
⚠️ 1027 - DefaultValueChanged The new version has a different default value than the previous one.
New: Microsoft.NetApp/stable/2020-09-01/netapp.json#L392:9
Old: Microsoft.NetApp/stable/2020-08-01/netapp.json#L392:9
⚠️ 1027 - DefaultValueChanged The new version has a different default value than the previous one.
New: Microsoft.NetApp/stable/2020-09-01/netapp.json#L451:9
Old: Microsoft.NetApp/stable/2020-08-01/netapp.json#L451:9
️️✔️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 Nov 26, 2020

Swagger Generation Artifacts

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️️✔️ azure-sdk-for-python succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from 9ac6ebf. 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/netapp/resource-manager/readme.md
  • ️✔️azure-mgmt-netapp [View full logs]  [Release SDK Changes]
    cmderr	[buildConf] INFO:packaging_tools:Building template azure-mgmt-netapp
    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-netapp
    cmderr	[changelogSetup] WARNING: Skipping azure-nspkg as it is not installed.
    cmderr	[changelogReport] INFO:__main__:Looking for Autorest generated package in azure.mgmt.netapp
    cmderr	[changelogReport] INFO:__main__:Found azure.mgmt.netapp
    cmderr	[changelogReport] INFO:__main__:Working on azure.mgmt.netapp
    cmderr	[changelogReport] INFO:__main__:Report written to sdk/netapp/azure-mgmt-netapp/code_reports/latest/report.json
    cmderr	[changelogReportLatest] INFO:__main__:Download versions of azure-mgmt-netapp on PyPI
    cmderr	[changelogReportLatest] INFO:__main__:Got ['0.1.0', '0.2.0', '0.3.0', '0.4.0', '0.5.0', '0.6.0', '0.7.0', '0.8.0', '0.9.0', '0.10.0', '0.11.0', '0.12.0', '0.13.0', '0.14.0', '1.0.0b1']
    cmderr	[changelogReportLatest] INFO:__main__:Only keep last PyPI version
    cmderr	[changelogReportLatest] INFO:__main__:Installing version 0.14.0 of azure-mgmt-netapp in a venv
    cmderr	[changelogReportLatest] Cache entry deserialization failed, entry ignored
    cmderr	[changelogReportLatest] INFO:__main__:Looking for Autorest generated package in azure.mgmt.netapp
    cmderr	[changelogReportLatest] INFO:__main__:Found azure.mgmt.netapp
    cmderr	[changelogReportLatest] INFO:__main__:Working on azure.mgmt.netapp
    cmderr	[changelogReportLatest] INFO:__main__:Report written to sdk/netapp/azure-mgmt-netapp/code_reports/0.14.0/report.json
    cmdout	[Changelog] Size of delta 0.902% size of original (original: 54679 chars, delta: 493 chars)
    cmdout	[Changelog] **Features**
    cmdout	[Changelog]   - Model ActiveDirectory has a new parameter security_operators
    cmdout	[Changelog]   - Model Volume has a new parameter smb_encryption
    cmdout	[Changelog]   - Model Volume has a new parameter smb_continuously_available
️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from 9ac6ebf. 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/netapp/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.NetApp [View full logs]  [Release SDK Changes]
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from 9ac6ebf. 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/netapp/resource-manager/readme.md
  • ️✔️@azure/arm-netapp [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/azureNetAppFilesManagementClient.js → ./dist/arm-netapp.js...
    cmderr	[npmPack] created ./dist/arm-netapp.js in 547ms
️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from 9ac6ebf. 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] 2020-12-17 10:40:12 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-netapp"
    cmderr	[generate.py] 2020-12-17 10:40:12 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
    cmderr	[generate.py] 2020-12-17 10:40:12 INFO autorest --version=3.0.6327 --use=@autorest/java@4.0.6 --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/netapp/azure-resourcemanager-netapp --java.namespace=com.azure.resourcemanager.netapp  --package-version=1.0.0-beta.1 --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --pipeline.modelerfour.flatten-payloads=false --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/netapp/resource-manager/readme.md
    cmderr	[generate.py] 2020-12-17 10:41:00 INFO [CI][Success] Write to ci.yml
    cmderr	[generate.py] 2020-12-17 10:41:00 INFO [POM][Process] dealing with pom.xml
    cmderr	[generate.py] 2020-12-17 10:41:00 INFO [POM][Success] Write to pom.xml
    cmderr	[generate.py] 2020-12-17 10:41:00 INFO [POM][Process] dealing with root pom
    cmderr	[generate.py] 2020-12-17 10:41:00 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-netapp [View full logs]  [Release SDK Changes]
    cmderr	[Inst] 2020-12-17 10:43:17 DEBUG Got artifact_id: azure-resourcemanager-netapp
    cmderr	[Inst] 2020-12-17 10:43:17 DEBUG Got artifact: pom.xml
    cmderr	[Inst] 2020-12-17 10:43:17 DEBUG Got artifact: azure-resourcemanager-netapp-1.0.0-beta.1-javadoc.jar
    cmderr	[Inst] 2020-12-17 10:43:17 DEBUG Got artifact: azure-resourcemanager-netapp-1.0.0-beta.1-sources.jar
    cmderr	[Inst] 2020-12-17 10:43:17 DEBUG Got artifact: azure-resourcemanager-netapp-1.0.0-beta.1.jar
    cmderr	[Inst] 2020-12-17 10:43:17 DEBUG Match jar package: azure-resourcemanager-netapp-1.0.0-beta.1.jar
    cmderr	[Inst] 2020-12-17 10:43:17 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/11832/azure-sdk-for-java/azure-resourcemanager-netapp/azure-resourcemanager-netapp-1.0.0-beta.1.jar\" -o azure-resourcemanager-netapp-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-netapp -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-netapp-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
    ```"}
️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from 9ac6ebf. 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/netapp/resource-manager/readme.md
  • ️✔️netapp [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"})
️️✔️[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, @audunn 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.
  • 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 openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Nov 26, 2020
    @openapi-workflow-bot
    Copy link

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

    This was referenced Nov 26, 2020
    @audunn
    Copy link
    Member Author

    audunn commented Nov 26, 2020

    /azp run

    @audunn audunn requested a review from lirenhe as a code owner December 16, 2020 09:52
    @zhenglaizhang
    Copy link
    Contributor

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 2 pipeline(s).

    @zhenglaizhang
    Copy link
    Contributor

    @audunn the default value changed is because of

    is changed, this is not consider a breaking change.
    So far, all looks good.

    @zhenglaizhang zhenglaizhang added the Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates label Dec 17, 2020
    @zhenglaizhang zhenglaizhang merged commit 9ac6ebf into Azure:master Dec 17, 2020
    This was referenced Dec 17, 2020
    giromm2ms pushed a commit to giromm2ms/azure-rest-api-specs that referenced this pull request Dec 20, 2020
    …1832)
    
    * add 2020-09-01 folder
    
    * update api version examples
    
    * Add 2020-09 update, update doc
    
    * Fix througputMips example
    
    * Add missing nextlink to volumes
    
    * Update snapshotvolumelist
    
    * Update prettier
    
    * fix:review comment
    
    Co-authored-by: Audunn Baldvinsson <audunn.baldvinsson@netapp.com>
    josuhazure pushed a commit to josuhazure/azure-rest-api-specs that referenced this pull request Jan 6, 2021
    …1832)
    
    * add 2020-09-01 folder
    
    * update api version examples
    
    * Add 2020-09 update, update doc
    
    * Fix througputMips example
    
    * Add missing nextlink to volumes
    
    * Update snapshotvolumelist
    
    * Update prettier
    
    * fix:review comment
    
    Co-authored-by: Audunn Baldvinsson <audunn.baldvinsson@netapp.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants