-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
Swagger Update for API version May23 #29142
Conversation
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.8) | new version | base version |
---|---|---|
storage.json | 2023-05-01(e38412a) | 2023-05-01(main) |
Rule | Message |
---|---|
1041 - AddedPropertyInResponse |
The new version has a new property 'enableExtendedGroups' in response that was not found in the old version. New: Microsoft.Storage/stable/2023-05-01/storage.json#L3753:7 Old: Microsoft.Storage/stable/2023-05-01/storage.json#L3748:7 |
1045 - AddedOptionalProperty |
The new version has a new optional property 'enableExtendedGroups' that was not found in the old version. New: Microsoft.Storage/stable/2023-05-01/storage.json#L3148:7 Old: Microsoft.Storage/stable/2023-05-01/storage.json#L3148:7 |
1045 - AddedOptionalProperty |
The new version has a new optional property 'enableExtendedGroups' that was not found in the old version. New: Microsoft.Storage/stable/2023-05-01/storage.json#L4186:7 Old: Microsoft.Storage/stable/2023-05-01/storage.json#L4176:7 |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 3 Warnings warning [Detail]
Compared specs (v2.2.2) | new version | base version |
---|---|---|
package-2023-05 | package-2023-05(e38412a) | package-2023-05(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
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.Storage/stable/2023-05-01/storage.json#L3218 |
||
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.Storage/stable/2023-05-01/storage.json#L3890 |
||
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.Storage/stable/2023-05-01/storage.json#L4235 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
GetCollectionResponseSchema |
The response in the GET collection operation 'Queue_List' does not match the response definition in the individual GET operation 'Queue_Get' . Location: Microsoft.Storage/stable/2023-05-01/storage.json#L18 |
GetCollectionResponseSchema |
The response in the GET collection operation 'BlobContainers_List' does not match the response definition in the individual GET operation 'BlobContainers_Get' . Location: Microsoft.Storage/stable/2023-05-01/storage.json#L18 |
GetCollectionResponseSchema |
The response in the GET collection operation 'FileShares_List' does not match the response definition in the individual GET operation 'FileShares_Get' . Location: Microsoft.Storage/stable/2023-05-01/storage.json#L18 |
RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2023-05-01/storage.json#L36 |
OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.Storage/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.Storage/stable/2023-05-01/storage.json#L39 |
OperationsApiSchemaUsesCommonTypes |
Operations API path must follow the schema provided in the common types. Location: Microsoft.Storage/stable/2023-05-01/storage.json#L40 |
RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2023-05-01/storage.json#L69 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.Storage/stable/2023-05-01/storage.json#L72 |
PostResponseCodes |
Synchronous POST operations must have one of the following combinations of responses - 200 and default ; 204 and default. They also must not have other response codes. Location: Microsoft.Storage/stable/2023-05-01/storage.json#L83 |
RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2023-05-01/storage.json#L111 |
ProvisioningStateSpecifiedForLROPut |
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: Microsoft.Storage/stable/2023-05-01/storage.json#L122 |
PutRequestResponseSchemeArm |
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'StorageAccounts_Create' Request Model: 'parameters[2].schema' Response Model: 'responses[200].schema' Location: Microsoft.Storage/stable/2023-05-01/storage.json#L122 |
PutResponseCodes |
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.Storage/stable/2023-05-01/storage.json#L122 |
RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2023-05-01/storage.json#L189 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Storage/stable/2023-05-01/storage.json#L196 |
DeleteResponseCodes |
Synchronous delete operations must have responses with 200, 204 and default return codes. They also must have no other response codes. Location: Microsoft.Storage/stable/2023-05-01/storage.json#L202 |
RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2023-05-01/storage.json#L227 |
ParametersInPointGet |
Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.Storage/stable/2023-05-01/storage.json#L262 |
RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.Storage/stable/2023-05-01/storage.json#L291 |
PatchResponseCodes |
Synchronous PATCH operations must have responses with 200 and default return codes. They also must not have other response codes. Location: Microsoft.Storage/stable/2023-05-01/storage.json#L300 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:type. Location: Microsoft.Storage/stable/2023-05-01/storage.json#L343 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:name. Location: Microsoft.Storage/stable/2023-05-01/storage.json#L343 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not have default value, property:keySource. Location: Microsoft.Storage/stable/2023-05-01/storage.json#L343 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:sasExpirationPeriod. Location: Microsoft.Storage/stable/2023-05-01/storage.json#L343 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not have default value, property:expirationAction. Location: Microsoft.Storage/stable/2023-05-01/storage.json#L343 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:expirationAction. Location: Microsoft.Storage/stable/2023-05-01/storage.json#L343 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:keyExpirationPeriodInDays. Location: Microsoft.Storage/stable/2023-05-01/storage.json#L343 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:directoryServiceOptions. Location: Microsoft.Storage/stable/2023-05-01/storage.json#L343 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:domainName. Location: Microsoft.Storage/stable/2023-05-01/storage.json#L343 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:domainGuid. Location: Microsoft.Storage/stable/2023-05-01/storage.json#L343 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
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
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
SDK still not released for SRP API version 2023-05-01.
/azp run |
Azure Pipelines successfully started running 4 pipeline(s). |
Please fill out the Purpose of this PR and Due diligence checklist. |
specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/storage.json
Show resolved
Hide resolved
Purpose of this PR: This PR adds support for new xlsAccountServiceMetadata 'EnableExtendedGroups' for Nfsv3AccountCreate and StorageAccountUpdate APIs version 01-05-2023. Major changes for this version have gone in with PR. Since doc/SDKs/PSH/CLI tools have not yet released, updating the same version. |
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting help
section 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 ApiView
comment 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 PR
andDue diligence checklist
.Next Steps to Merge
comment. 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.
queued
state, please add a comment with contents/azp run
.This should result in a new comment denoting a
PR validation pipeline
has started and the checks should be updated after few minutes.