[NetApp]Remove throughputMibps from create request examples #21907

audunn · 2022-12-15T11:23:36Z

ARM API Information (Control Plane)

Non functional QOS documentation update.
Some of our examples show setting value in a request for an optional property that is causing confusion for some clients causing them to have errors trying to create volumes.

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

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

Add a changelog entry for this PR by answering the following questions:

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
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.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

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 the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] 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. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

openapi-workflow-bot · 2022-12-15T11:23:39Z

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.

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. vscswagger@microsoft.com

openapi-pipeline-app · 2022-12-15T11:23:39Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

compared swaggers (via Oad v0.10.4)]	new version	base version
netapp.json	2020-06-01(544390b)	2020-06-01(main)
netapp.json	2020-07-01(544390b)	2020-07-01(main)
netapp.json	2020-08-01(544390b)	2020-08-01(main)
netapp.json	2020-09-01(544390b)	2020-09-01(main)
netapp.json	2020-11-01(544390b)	2020-11-01(main)
netapp.json	2020-12-01(544390b)	2020-12-01(main)
netapp.json	2021-02-01(544390b)	2021-02-01(main)
netapp.json	2021-04-01(544390b)	2021-04-01(main)
netapp.json	2021-06-01(544390b)	2021-06-01(main)
netapp.json	2021-08-01(544390b)	2021-08-01(main)
netapp.json	2021-10-01(544390b)	2021-10-01(main)
netapp.json	2022-01-01(544390b)	2022-01-01(main)
netapp.json	2022-03-01(544390b)	2022-03-01(main)
netapp.json	2022-05-01(544390b)	2022-05-01(main)

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️🔄LintDiff inProgress [Detail]

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ApiReadinessCheck succeeded [Detail] [Expand]

️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

API Test is not triggered due to precheck failure. Check pipeline log for details.

️❌~[Staging] SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]

️️✔️~[Staging] CadlAPIView succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2022-12-15T11:23:40Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️❌SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

❌azure-sdk-for-go - sdk/resourcemanager/netapp/armnetapp - Approved - 4.0.0

+	Function `*SnapshotsClient.BeginUpdate` parameter(s) have been changed from `(context.Context, string, string, string, string, string, interface{}, *SnapshotsClientBeginUpdateOptions)` to `(context.Context, string, string, string, string, string, any, *SnapshotsClientBeginUpdateOptions)`

❌azure-sdk-for-js - @azure/arm-netapp - Approved - 18.0.0

+	Operation NetAppResource.checkNameAvailability has a new signature
+	Operation NetAppResource.checkQuotaAvailability has a new signature

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs]Release - Generate from 09f451a. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh]
cmderr	[automation_generate.sh] npm notice New major version of npm available! 8.19.3 -> 9.4.0
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.4.0>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.4.0` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-netapp [View full logs] [Release SDK Changes]
- azure-mgmt-netapp-5.1.0.zip
- azure_mgmt_netapp-5.1.0-py3-none-any.whl
```
info	[Changelog]
```

️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 09f451a. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json

️✔️Azure.ResourceManager.NetApp [View full logs] [Release SDK Changes]
- Azure.ResourceManager.NetApp.1.1.0-alpha.20230131.1.nupkg
```
info	[Changelog]
```

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 09f451a. SDK Automation 14.0.0

command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json

️✔️@azure/arm-netapp [View full logs] [Release SDK Changes] Breaking Change Detected

azure-arm-netapp-18.0.0.tgz

info	[Changelog] **Breaking Changes**
info	[Changelog]
info	[Changelog]   - Operation NetAppResource.checkNameAvailability has a new signature
info	[Changelog]   - Operation NetAppResource.checkQuotaAvailability has a new signature

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 09f451a. SDK Automation 14.0.0

command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️sdk/resourcemanager/netapp/armnetapp [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Function `*SnapshotsClient.BeginUpdate` parameter(s) have been changed from `(context.Context, string, string, string, string, string, interface{}, *SnapshotsClientBeginUpdateOptions)` to `(context.Context, string, string, string, string, string, any, *SnapshotsClientBeginUpdateOptions)`
info	[Changelog]
info	[Changelog] Total 1 breaking change(s), 0 additive change(s).

️⚠️ azure-sdk-for-java warning [Detail]

⚠️Warning [Logs]Release - Generate from 09f451a. 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
cmderr	[init.sh] [notice] A new release of pip available: 22.3.1 -> 23.0
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
cmderr	[init.sh] [notice] A new release of pip available: 22.3.1 -> 23.0
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json

️✔️azure-resourcemanager-netapp [View full logs] [Release SDK Changes]

️⚠️ azure-resource-manager-schemas warning [Detail]

⚠️Warning [Logs]Release - Generate from 09f451a. 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

️✔️netapp [View full logs] [Release Schema Changes]

️❌ azure-powershell failed [Detail]

❌Failed [Logs]Release - Generate from 09f451a. SDK Automation 14.0.0

command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json

❌Az.netapp [View full logs] [Release SDK Changes]

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2022-12-15T11:23:41Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/netapp/armnetapp	https://apiview.dev/Assemblies/Review/4ad7967adacb4dcbac87ae2faafdf692
.Net	Azure.ResourceManager.NetApp	There is no API change compared with the previous version
Java	azure-resourcemanager-netapp	https://apiview.dev/Assemblies/Review/add7cca9849247e7b56aeb33c9b21148
JavaScript	@azure/arm-netapp	https://apiview.dev/Assemblies/Review/c11a711ac4d14c92b71cd39f5129a5de

openapi-workflow-bot · 2022-12-15T11:30:40Z

Hi @audunn, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

honghr · 2022-12-27T05:52:33Z

/azp run

azure-pipelines · 2022-12-27T05:52:42Z

Azure Pipelines successfully started running 1 pipeline(s).

honghr · 2022-12-27T06:03:42Z

Hi @audunn Can you review the model validation error details. If you want to merge this pr, you need fix it first. And if you don't need this pr, you can close it. Thanks.

audunn · 2023-01-17T13:13:16Z

@honghr Hi, This is a non-functional update to specs just to improve api-reference validation can we move this long. The Model validation issues realy have nothing directly to do with this change. Those are are rules enforced after those file where updated.
Is it possible to go ahead with this as fixing the other isssues would mean a much bigger change to things we are not touching for this change?

audunn · 2023-01-17T15:06:38Z

@honghr Model validation has been fixed now

live1206 · 2023-01-27T01:52:39Z

/azp run

azure-pipelines · 2023-01-27T01:52:49Z

Azure Pipelines successfully started running 1 pipeline(s).

live1206 · 2023-01-27T02:20:40Z

@tadelesh Could you help review the breaking change for go? Thanks!

live1206 · 2023-01-27T02:22:10Z

@qiaozha Could you help review the breaking change for JS? Thanks

audunn · 2023-01-27T10:00:23Z

Not sure why this would show as breaking as this only changes examples and description of one field. SDK do not need to be regenerated based on this update.

tadelesh · 2023-01-28T02:56:28Z

@tadelesh Could you help review the breaking change for go? Thanks!

approved.

qiaozha · 2023-01-31T03:45:34Z

/azp run

azure-pipelines · 2023-01-31T03:45:45Z

Azure Pipelines successfully started running 1 pipeline(s).

… examples (#2765) Create to sync Azure/azure-rest-api-specs#21907 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...azure-sdk:sdkAuto/netapp?expand=1)

Remove throughputMibps from create request examples

4fa7421

openapi-assignment-bot bot assigned honghr Dec 15, 2022

AzureRestAPISpecReview added CI-FixRequiredOnFailure resource-manager labels Dec 15, 2022

azure-sdk mentioned this pull request Dec 15, 2022

[AutoPR sdk/resourcemanager/netapp/armnetapp] [NetApp]Remove throughputMibps from create request examples azure-sdk/azure-sdk-for-go#3798

Closed

openapi-pipeline-app bot added the CI-BreakingChange-JavaScript label Dec 15, 2022

Update description for username

da1b585

openapi-pipeline-app bot added the CI-BreakingChange-Go label Jan 17, 2023

azure-sdk mentioned this pull request Jan 17, 2023

[AutoPR netapp] [NetApp]Remove throughputMibps from create request examples azure-sdk/azure-resource-manager-schemas#1836

Closed

audunn added 4 commits January 17, 2023 13:50

Fix 2020-06-01

4522be7

Fix example files

aea5750

Update description for username

7913017

Pretty

568aee7

AzureRestAPISpecReview removed the CI-FixRequiredOnFailure label Jan 17, 2023

Remove doublicate

a5b212b

tadelesh added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Jan 28, 2023

audunn added 2 commits January 30, 2023 15:21

Update description

7348bd4

Add read to x-ms-mutability snapshotid and backupid

544390b

qiaozha added the Approved-SdkBreakingChange-JavaScript label Jan 31, 2023

honghr approved these changes Jan 31, 2023

View reviewed changes

honghr merged commit 09f451a into Azure:main Jan 31, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[NetApp]Remove throughputMibps from create request examples #21907

[NetApp]Remove throughputMibps from create request examples #21907

audunn commented Dec 15, 2022 •

edited

Loading

openapi-workflow-bot bot commented Dec 15, 2022

openapi-pipeline-app bot commented Dec 15, 2022 •

edited

Loading

openapi-pipeline-app bot commented Dec 15, 2022 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented Dec 15, 2022 •

edited

Loading

openapi-workflow-bot bot commented Dec 15, 2022

honghr commented Dec 27, 2022

azure-pipelines bot commented Dec 27, 2022

honghr commented Dec 27, 2022

audunn commented Jan 17, 2023

audunn commented Jan 17, 2023

live1206 commented Jan 27, 2023

azure-pipelines bot commented Jan 27, 2023

live1206 commented Jan 27, 2023

live1206 commented Jan 27, 2023

audunn commented Jan 27, 2023

tadelesh commented Jan 28, 2023

qiaozha commented Jan 31, 2023

azure-pipelines bot commented Jan 31, 2023

[NetApp]Remove throughputMibps from create request examples #21907

[NetApp]Remove throughputMibps from create request examples #21907

Conversation

audunn commented Dec 15, 2022 • edited Loading

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Dec 15, 2022

openapi-pipeline-app bot commented Dec 15, 2022 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Dec 15, 2022 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Dec 15, 2022 • edited Loading

Generated ApiView

openapi-workflow-bot bot commented Dec 15, 2022

honghr commented Dec 27, 2022

azure-pipelines bot commented Dec 27, 2022

honghr commented Dec 27, 2022

audunn commented Jan 17, 2023

audunn commented Jan 17, 2023

live1206 commented Jan 27, 2023

azure-pipelines bot commented Jan 27, 2023

live1206 commented Jan 27, 2023

live1206 commented Jan 27, 2023

audunn commented Jan 27, 2023

tadelesh commented Jan 28, 2023

qiaozha commented Jan 31, 2023

azure-pipelines bot commented Jan 31, 2023

audunn commented Dec 15, 2022 •

edited

Loading

openapi-pipeline-app bot commented Dec 15, 2022 •

edited

Loading

openapi-pipeline-app bot commented Dec 15, 2022 •

edited

Loading

openapi-pipeline-app bot commented Dec 15, 2022 •

edited

Loading