[NetAppFiles] Release netapp microsoft.net app 2023 11 01 preview #29206
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec.
Updated the API version from stable/2023-11-01 to preview/2023-11-01-preview.
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
| Compared specs (v0.10.9) | new version | base version |
|---|---|---|
| netapp.json | 2023-11-01(c57f53a) | 2023-11-01(main) |
| Rule | Message |
|---|---|
|
The new version has a different 'minimum' value than the previous one. New: Microsoft.NetApp/stable/2023-11-01/netapp.json#L6605:9 Old: Microsoft.NetApp/stable/2023-11-01/netapp.json#L6605:9 |
|
The new version has a less constraining 'minimum' value than the previous one. New: Microsoft.NetApp/stable/2023-11-01/netapp.json#L6605:9 Old: Microsoft.NetApp/stable/2023-11-01/netapp.json#L6605:9 |
|
The new version has a new optional property 'protocolTypes' that was not found in the old version. New: Microsoft.NetApp/stable/2023-11-01/netapp.json#L7107:7 Old: Microsoft.NetApp/stable/2023-11-01/netapp.json#L7107:7 |
️❌Breaking Change(Cross-Version): 2 Errors, 8 Warnings failed [Detail]
| Compared specs (v0.10.9) | new version | base version |
|---|---|---|
| netapp.json | 2023-11-01-preview(c57f53a) | 2023-11-01(main) |
| netapp.json | 2023-11-01-preview(c57f53a) | 2023-07-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
| Rule | Message |
|---|---|
|
The new version has a different 'minimum' value than the previous one. New: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L7117:9 Old: Microsoft.NetApp/stable/2023-11-01/netapp.json#L6605:9 |
|
The new version has a less constraining 'minimum' value than the previous one. New: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L7117:9 Old: Microsoft.NetApp/stable/2023-11-01/netapp.json#L6605:9 |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 2 Warnings warning [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| package-netapp-2023-11-01 | package-netapp-2023-11-01(c57f53a) | package-netapp-2023-11-01(main) |
| package-preview-2023-11 | package-preview-2023-11(c57f53a) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| OperationId should contain the verb: 'getkeyvaultstatus' in:'Accounts_GetChangeKeyVaultInformation'. Consider updating the operationId Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L952 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L6138 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The response schema of operations API '/providers/Microsoft.NetApp/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L59 |
|
Operations API path must follow the schema provided in the common types. Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L60 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L252 |
|
The resource name parameter 'quotaLimitName' should be defined with a 'pattern' restriction. Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L270 |
|
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L314 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L335 |
|
A 202 response should include an Location response header. Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L758 |
|
Mark the top-level property 'location', specified in the patch operation body, as readOnly or immutable. You could also choose to remove it from the request payload of the Patch operation. This property is not patchable. Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L789 |
|
Properties of a PATCH request body must not be required, property:type. Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L794 |
|
Properties of a PATCH request body must not have default value, property:keySource. Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L794 |
|
Properties of a PATCH request body must not be required, property:keyVaultUri. Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L794 |
|
Properties of a PATCH request body must not be required, property:keyName. Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L794 |
|
Properties of a PATCH request body must not be required, property:keyVaultResourceId. Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L794 |
|
A 202 response should include an Location response header. Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L818 |
|
200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L843 |
|
A 202 response should include an Location response header. Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L868 |
|
Mark the top-level property 'location', specified in the patch operation body, as readOnly or immutable. You could also choose to remove it from the request payload of the Patch operation. This property is not patchable. Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L1216 |
|
Properties of a PATCH request body must not have default value, property:size. Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L1221 |
|
Properties of a PATCH request body must not have default value, property:qosType. Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L1221 |
|
A 202 response should include an Location response header. Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L1248 |
|
A 202 response should include an Location response header. Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L1293 |
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L1414 |
|
A 202 response should include an Location response header. Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L1463 |
|
Mark the top-level property 'location', specified in the patch operation body, as readOnly or immutable. You could also choose to remove it from the request payload of the Patch operation. This property is not patchable. Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L1491 |
|
Properties of a PATCH request body must not have default value, property:serviceLevel. Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L1496 |
|
Properties of a PATCH request body must not have default value, property:usageThreshold. Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L1496 |
|
A 202 response should include an Location response header. Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L1526 |
|
A 202 response should include an Location response header. Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L1581 |
|
200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L1667 |
|
A 202 response should include an Location response header. Location: Microsoft.NetApp/preview/2023-11-01-preview/netapp.json#L1707 |
️❌Avocado: 8 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.NetApp/netAppAccounts/{}/capacityPools/{}/volumes/{}/mountTargets is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/netapp/resource-manager/readme.md json: Microsoft.NetApp/preview/2017-08-15/netapp.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.NetApp/netAppAccounts/{}/capacityPools/{}/volumes/{}/backupStatus is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/netapp/resource-manager/readme.md json: Microsoft.NetApp/preview/2021-04-01-preview/netapp.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.NetApp/netAppAccounts/{}/accountBackups is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/netapp/resource-manager/readme.md json: Microsoft.NetApp/preview/2023-05-01-preview/netapp.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.NetApp/netAppAccounts/{}/accountBackups/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/netapp/resource-manager/readme.md json: Microsoft.NetApp/preview/2023-05-01-preview/netapp.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.NetApp/netAppAccounts/{}/capacityPools/{}/volumes/{}/backups is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/netapp/resource-manager/readme.md json: Microsoft.NetApp/preview/2021-04-01-preview/netapp.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.NetApp/netAppAccounts/{}/capacityPools/{}/volumes/{}/backups/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/netapp/resource-manager/readme.md json: Microsoft.NetApp/preview/2021-04-01-preview/netapp.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.NetApp/netAppAccounts/{}/vaults is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/netapp/resource-manager/readme.md json: Microsoft.NetApp/preview/2021-04-01-preview/netapp.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.NetApp/netAppAccounts/{}/capacityPools/{}/volumes/{}/restoreStatus is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/netapp/resource-manager/readme.md json: Microsoft.NetApp/preview/2023-05-01-preview/netapp.json |
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView 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.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
ARMReview
BreakingChangeReviewRequired
This was referenced May 22, 2024
…into release-netapp-Microsoft.NetApp-2023-11-01-preview
|
|
audunn
added
BreakingChange-Approved-BugFix
…into release-netapp-Microsoft.NetApp-2023-11-01-preview
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
audunn
removed
the
BreakingChangeReviewRequired
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
audunn
removed
the
BreakingChangeReviewRequired
|
Regarding the braking change flag and Similar with |
…into release-netapp-Microsoft.NetApp-2023-11-01-preview
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
audunn
removed
the
BreakingChangeReviewRequired
rkmanda
added
the
ARMSignedOff
openapi-pipeline-app
bot
removed
the
WaitForARMFeedback
…into release-netapp-Microsoft.NetApp-2023-11-01-preview
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
markcowl
pushed a commit
to markcowl/azure-rest-api-specs
that referenced
this pull request
Jun 11, 2024
…ure#29206) * Copy files from stable/2023-11-01 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to preview/2023-11-01-preview Updated the API version from stable/2023-11-01 to preview/2023-11-01-preview. * Added tag for 2023-11-01-preview in readme file * apply 2023-11-01 * pretty * remove extra example * spelling * Accounts_GetChangeKeyVaultInformation * Arm-id * coolnessperiod minimum fix * Add protocolTypes to volumePatchProperties
MaryGao
reviewed
Jul 26, 2024
specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-11-01/netapp.json
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.
Additional information
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.
Getting help
Purpose of this PRandDue diligence checklist.Next Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.