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

[dataprotection] Set final-state-via to "location" for some APIs due to updated AAZ behaviour. #24715

Merged
merged 2 commits into from
Aug 4, 2023

Merge pull request #1 from vishesh155/dpp-add-lro-options

ae39505
Select commit
Loading
Failed to load commit list.
Merged

[dataprotection] Set final-state-via to "location" for some APIs due to updated AAZ behaviour. #24715

Merge pull request #1 from vishesh155/dpp-add-lro-options
ae39505
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff succeeded Aug 4, 2023 in 3m 7s

Swagger LintDiff succeeded

LintDiff
View more details.

Details

compared tags (via openapi-validator v2.1.3) new version base version
package-2023-05 package-2023-05(ae39505) package-2023-05(main)
package-2023-01 package-2023-01(ae39505) package-2023-01(main)

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/stable/2023-01-01/dataprotection.json#L42
❌ LroExtension Operations with a 202 response must specify x-ms-long-running-operation: true.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L64
❌ ParametersOrder The parameters:operationId,location should be kept in the same order as they present in the path.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L64
❌ GetOperation200 The get operation should only return 200.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L94
❌ ResourceNameRestriction The resource name parameter 'vaultName' should be defined with a 'pattern' restriction.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L184
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L307
❌ ResourceNameRestriction The resource name parameter 'vaultName' should be defined with a 'pattern' restriction.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L328
❌ PutResponseSchemaDescription Description of 200 response code of a PUT operation MUST include term 'update'.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L410
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L426
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L467
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L476
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L526
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L532
❌ ResourceNameRestriction The resource name parameter 'vaultName' should be defined with a 'pattern' restriction.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L544
❌ LroExtension Operations with a 202 response must specify x-ms-long-running-operation: true.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L545
❌ GetOperation200 The get operation should only return 200.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L580
❌ OperationsApiSchemaUsesCommonTypes Operations API path must follow the schema provided in the common types.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L740
❌ ResourceNameRestriction The resource name parameter 'vaultName' should be defined with a 'pattern' restriction.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L761
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L788
❌ ResourceNameRestriction The resource name parameter 'vaultName' should be defined with a 'pattern' restriction.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L809
❌ ResourceNameRestriction The resource name parameter 'backupPolicyName' should be defined with a 'pattern' restriction.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L809
❌ PutResponseSchemaDescription Any Put MUST contain 200 and 201 return codes.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L899
❌ ResourceNameRestriction The resource name parameter 'vaultName' should be defined with a 'pattern' restriction.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L969
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L996
❌ ResourceNameRestriction The resource name parameter 'vaultName' should be defined with a 'pattern' restriction.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1017
❌ ResourceNameRestriction The resource name parameter 'backupInstanceName' should be defined with a 'pattern' restriction.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1017
❌ PutResponseSchemaDescription Description of 200 response code of a PUT operation MUST include term 'update'.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1099
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1128
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1193
❌ ResourceNameRestriction The resource name parameter 'vaultName' should be defined with a 'pattern' restriction.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1205
❌ ResourceNameRestriction The resource name parameter 'backupInstanceName' should be defined with a 'pattern' restriction.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1205
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1269
❌ ResourceNameRestriction The resource name parameter 'vaultName' should be defined with a 'pattern' restriction.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1284
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1345
❌ ResourceNameRestriction The resource name parameter 'vaultName' should be defined with a 'pattern' restriction.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1360
❌ ResourceNameRestriction The resource name parameter 'backupInstanceName' should be defined with a 'pattern' restriction.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1360
❌ LroExtension Operations with a 202 response must specify x-ms-long-running-operation: true.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1361
❌ 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/stable/2023-01-01/dataprotection.json#L1366
❌ GetOperation200 The get operation should only return 200.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1400
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1400
❌ ResourceNameRestriction The resource name parameter 'vaultName' should be defined with a 'pattern' restriction.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1417
❌ ResourceNameRestriction The resource name parameter 'backupInstanceName' should be defined with a 'pattern' restriction.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1417
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1461
❌ ResourceNameRestriction The resource name parameter 'vaultName' should be defined with a 'pattern' restriction.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1483
❌ ResourceNameRestriction The resource name parameter 'backupInstanceName' should be defined with a 'pattern' restriction.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1483
❌ ResourceNameRestriction The resource name parameter 'vaultName' should be defined with a 'pattern' restriction.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1537
❌ ResourceNameRestriction The resource name parameter 'backupInstanceName' should be defined with a 'pattern' restriction.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1537
❌ LroPostReturn A LRO POST operation must have both 200 & 202 return codes.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1538
❌ PostOperationAsyncResponseValidation An async POST operation must set long running operation options 'x-ms-long-running-operation-options'
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1538
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.DataProtection/stable/2023-01-01/dataprotection.json#L1595
View more details on openapi-pipeline-app