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

Swagger Update for API version May23 #29142

Merged
merged 1 commit into from
May 29, 2024

Updating Swagger for new xlsAccountServiceMetada EnableExtendedGroups

e38412a
Select commit
Loading
Failed to load commit list.
Merged

Swagger Update for API version May23 #29142

Updating Swagger for new xlsAccountServiceMetada EnableExtendedGroups
e38412a
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff succeeded May 21, 2024 in 3m 48s

Swagger LintDiff succeeded

LintDiff
View Azure DevOps build log for more details.

Details

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]
⚠️ EnumInsteadOfBoolean 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
⚠️ EnumInsteadOfBoolean 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
⚠️ EnumInsteadOfBoolean 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 50 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
❌ PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:bypass.
Location: Microsoft.Storage/stable/2023-05-01/storage.json#L343
❌ PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:defaultAction.
Location: Microsoft.Storage/stable/2023-05-01/storage.json#L343
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:defaultAction.
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
❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
Location: Microsoft.Storage/stable/2023-05-01/storage.json#L355
❌ ResourceNameRestriction The resource name parameter 'deletedAccountName' should be defined with a 'pattern' restriction.
Location: Microsoft.Storage/stable/2023-05-01/storage.json#L404
❌ ParametersOrder The parameters:deletedAccountName,location should be kept in the same order as they present in the path.
Location: Microsoft.Storage/stable/2023-05-01/storage.json#L405
❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
Location: Microsoft.Storage/stable/2023-05-01/storage.json#L470
❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
Location: Microsoft.Storage/stable/2023-05-01/storage.json#L506
❌ 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#L520
❌ ParametersInPost $expand is a query parameter. Post operation must not contain any query parameter other than api-version.
Location: Microsoft.Storage/stable/2023-05-01/storage.json#L531
❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
Location: Microsoft.Storage/stable/2023-05-01/storage.json#L558
❌ 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#L569
❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
Location: Microsoft.Storage/stable/2023-05-01/storage.json#L606
❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
Location: Microsoft.Storage/stable/2023-05-01/storage.json#L643
❌ 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#L646
❌ PathResourceTypeNameCamelCase Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/ListAccountSas'
Location: Microsoft.Storage/stable/2023-05-01/storage.json#L656
❌ 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#L657
❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
Location: Microsoft.Storage/stable/2023-05-01/storage.json#L691
❌ PathResourceTypeNameCamelCase Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/ListServiceSas'
Location: Microsoft.Storage/stable/2023-05-01/storage.json#L701
View more details on openapi-pipeline-app