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

[Hub Generated] Review request for Microsoft.DataProtection to add version preview/2023-08-01-preview #25967

Merged
merged 17 commits into from
Nov 2, 2023

Removing Where Condition

8b813e9
Select commit
Loading
Failed to load commit list.
Merged

[Hub Generated] Review request for Microsoft.DataProtection to add version preview/2023-08-01-preview #25967

Removing Where Condition
8b813e9
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff succeeded Oct 12, 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-preview-2023-08 package-preview-2023-08(8b813e9) default(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule Message Related RPC [For API reviewers]
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1381
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1384
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1387
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2741
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2744
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2747
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2805
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2808
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2811
⚠️ 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.DataProtection/preview/2023-08-01-preview/dataprotection.json#L7350


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

Rule Message
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L42
❌ LroExtension Operations with a 202 response must specify x-ms-long-running-operation: true.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L64
❌ ParametersOrder The parameters:operationId,location should be kept in the same order as they present in the path.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L64
❌ GetOperation200 The get operation should only return 200.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L94
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L307
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L429
❌ 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.DataProtection/preview/2023-08-01-preview/dataprotection.json#L446
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L473
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L482
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L532
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L538
❌ LroExtension Operations with a 202 response must specify x-ms-long-running-operation: true.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L554
❌ GetOperation200 The get operation should only return 200.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L589
❌ OperationsApiSchemaUsesCommonTypes Operations API path must follow the schema provided in the common types.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L749
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L797
❌ 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.DataProtection/preview/2023-08-01-preview/dataprotection.json#L869
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1005
❌ 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.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1073
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1137
❌ 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.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1148
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1202
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1278
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1354
❌ LroExtension Operations with a 202 response must specify x-ms-long-running-operation: true.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1443
❌ OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'BackupInstances' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1448
❌ GetOperation200 The get operation should only return 200.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1482
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1482
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1543
❌ ParametersInPost $filter is a query parameter. Post operation must not contain any query parameter other than api-version.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1629
❌ ParametersInPost $skipToken is a query parameter. Post operation must not contain any query parameter other than api-version.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1629
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1757
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1835
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L1986
❌ PostResponseCodes Long-running POST operations must have responses with 202 and default return codes. They must also 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. They also must not have other response codes.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2008
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2065
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2144
❌ 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.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2166
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2217
❌ 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.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2230
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2281
❌ 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.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2294
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2345
❌ 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.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2358
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2409
❌ 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.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2422
❌ OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'BackupInstances' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2427
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2482
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2558
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2600
❌ PostResponseCodes Long-running POST operations must have responses with 202 and default return codes. They must also 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. They also must not have other response codes.
Location: Microsoft.DataProtection/preview/2023-08-01-preview/dataprotection.json#L2846
View more details on openapi-pipeline-app