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

[Hub Generated] Review request for Microsoft.StorageSync to add version stable/2022-09-01 #26082

Merged
merged 29 commits into from
Oct 11, 2023

Update storagesync.json

e935be8
Select commit
Loading
Failed to load commit list.
Merged

[Hub Generated] Review request for Microsoft.StorageSync to add version stable/2022-09-01 #26082

Update storagesync.json
e935be8
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff succeeded Oct 11, 2023 in 3m 14s

Swagger LintDiff succeeded

LintDiff
View more details.

Details

compared tags (via openapi-validator v2.1.6) new version base version
package-2022-09 package-2022-09(e935be8) default(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.StorageSync/stable/2022-09-01/storagesync.json#L3608
⚠️ 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.StorageSync/stable/2022-09-01/storagesync.json#L3796
⚠️ 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.StorageSync/stable/2022-09-01/storagesync.json#L3806
⚠️ 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.StorageSync/stable/2022-09-01/storagesync.json#L4396
⚠️ 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.StorageSync/stable/2022-09-01/storagesync.json#L4426
⚠️ 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.StorageSync/stable/2022-09-01/storagesync.json#L4618


The following errors/warnings exist before current PR submission:
Only 50 items are listed, please refer to log for more details.

Rule Message
❌ OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.StorageSync/operations' does not match the ARM specification. Please standardize the schema.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L43
❌ OperationsApiSchemaUsesCommonTypes Operations API path must follow the schema provided in the common types.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L44
❌ ResourceNameRestriction The resource name parameter 'locationName' should be defined with a 'pattern' restriction.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L70
❌ ResourceNameRestriction The resource name parameter 'storageSyncServiceName' should be defined with a 'pattern' restriction.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L125
❌ 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.StorageSync/stable/2022-09-01/storagesync.json#L126
❌ 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: 'StorageSyncServices_Create' Request Model: 'parameters[4].schema' Response Model: 'responses[200].schema'
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L126
❌ 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.StorageSync/stable/2022-09-01/storagesync.json#L126
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L199
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L341
❌ DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L347
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L421
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L454
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L503
❌ ResourceNameRestriction The resource name parameter 'storageSyncServiceName' should be defined with a 'pattern' restriction.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L529
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L558
❌ ResourceNameRestriction The resource name parameter 'storageSyncServiceName' should be defined with a 'pattern' restriction.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L571
❌ ResourceNameRestriction The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L571
❌ 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.StorageSync/stable/2022-09-01/storagesync.json#L615
❌ 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.StorageSync/stable/2022-09-01/storagesync.json#L615
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L687
❌ DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L693
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L756
❌ ResourceNameRestriction The resource name parameter 'storageSyncServiceName' should be defined with a 'pattern' restriction.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L763
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L796
❌ ResourceNameRestriction The resource name parameter 'storageSyncServiceName' should be defined with a 'pattern' restriction.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L822
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L855
❌ ResourceNameRestriction The resource name parameter 'storageSyncServiceName' should be defined with a 'pattern' restriction.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L881
❌ ResourceNameRestriction The resource name parameter 'syncGroupName' should be defined with a 'pattern' restriction.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L881
❌ 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: 'SyncGroups_Create' Request Model: 'parameters[5].schema' Response Model: 'responses[200].schema'
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L882
❌ 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.StorageSync/stable/2022-09-01/storagesync.json#L882
❌ ResourceNameRestriction The resource name parameter 'storageSyncServiceName' should be defined with a 'pattern' restriction.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L1075
❌ ResourceNameRestriction The resource name parameter 'syncGroupName' should be defined with a 'pattern' restriction.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L1075
❌ ResourceNameRestriction The resource name parameter 'cloudEndpointName' should be defined with a 'pattern' restriction.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L1075
❌ 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.StorageSync/stable/2022-09-01/storagesync.json#L1076
❌ 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: 'CloudEndpoints_Create' Request Model: 'parameters[6].schema' Response Model: 'responses[200].schema'
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L1076
❌ 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.StorageSync/stable/2022-09-01/storagesync.json#L1076
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L1173
❌ DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L1247
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L1335
❌ ResourceNameRestriction The resource name parameter 'storageSyncServiceName' should be defined with a 'pattern' restriction.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L1342
❌ ResourceNameRestriction The resource name parameter 'syncGroupName' should be defined with a 'pattern' restriction.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L1342
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L1382
❌ ResourceNameRestriction The resource name parameter 'storageSyncServiceName' should be defined with a 'pattern' restriction.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L1408
❌ ResourceNameRestriction The resource name parameter 'syncGroupName' should be defined with a 'pattern' restriction.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L1408
❌ ResourceNameRestriction The resource name parameter 'cloudEndpointName' should be defined with a 'pattern' restriction.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L1408
❌ PostResponseCodes 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.StorageSync/stable/2022-09-01/storagesync.json#L1409
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L1501
❌ ResourceNameRestriction The resource name parameter 'storageSyncServiceName' should be defined with a 'pattern' restriction.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L1508
❌ ResourceNameRestriction The resource name parameter 'syncGroupName' should be defined with a 'pattern' restriction.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L1508
❌ ResourceNameRestriction The resource name parameter 'cloudEndpointName' should be defined with a 'pattern' restriction.
Location: Microsoft.StorageSync/stable/2022-09-01/storagesync.json#L1508
View more details on openapi-pipeline-app