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

RecoveryServices Swagger PR for api-Version: 2024-04-01 #28597

Merged
merged 12 commits into from
Apr 16, 2024

added example reference

35ebfaa
Select commit
Loading
Failed to load commit list.
Merged

RecoveryServices Swagger PR for api-Version: 2024-04-01 #28597

added example reference
35ebfaa
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / ~[NotRequired_Staging] Swagger LintDiff succeeded Apr 16, 2024 in 4m 6s

~[NotRequired_Staging] Swagger LintDiff succeeded

ppe/LintDiff
View Azure DevOps build log for more details.

Details

compared tags (via openapi-validator vbeta) new version base version
package-2024-04 package-2024-04(35ebfaa) default(main)

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

Rule Message Related RPC [For API reviewers]
⚠️ ParameterDescription Parameter should have a description.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L589
⚠️ ParameterDescription Parameter should have a description.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L456


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

Rule Message
❌ XmsParameterLocation The parameter 'ApiVersion' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaultusages.json#L163
❌ XmsParameterLocation The parameter 'SubscriptionId' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaultusages.json#L140
❌ GetCollectionOnlyHasValueAndNextLink Get endpoints for collections of resources must only have the value and nextLink properties in their model.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaultusages.json#L48
❌ RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaultusages.json#L45
❌ SubscriptionsAndResourceGroupCasing The path segment Subscriptions should be subscriptions.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaultusages.json#L21
❌ ResourceNameRestriction The resource name parameter 'vaultName' should be defined with a 'pattern' restriction.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaultusages.json#L21
❌ PathResourceTypeNameCamelCase Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/usages'
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaultusages.json#L21
❌ XmsParameterLocation The parameter 'ApiVersion' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L2290
❌ XmsParameterLocation The parameter 'SubscriptionId' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L2267
❌ PropertiesTypeObjectNoDefinition Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L2253
❌ MissingTypeObject The schema 'ErrorAdditionalInfo' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L2250
❌ PropertiesTypeObjectNoDefinition Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L2219
❌ MissingTypeObject The schema 'Error' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L2214
❌ PropertiesTypeObjectNoDefinition Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L2207
❌ MissingTypeObject The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L2204
❌ PropertiesTypeObjectNoDefinition Properties with type:object that don't reference a model definition are not allowed. ARM doesn't allow generic type definitions as this leads to bad customer experience.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L2181
❌ ProvisioningStateValidation ProvisioningState must have terminal states: Succeeded, Failed and Canceled.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L1992
❌ SystemDataDefinitionsCommonTypes System data references must utilize common types.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L1538
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L885
❌ ResourceNameRestriction The resource name parameter 'vaultName' should be defined with a 'pattern' restriction.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L848
❌ ResourceNameRestriction The resource name parameter 'vaultName' should be defined with a 'pattern' restriction.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.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.RecoveryServices/stable/2024-04-01/vaults.json#L684
❌ XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L640
❌ ResourceNameRestriction The resource name parameter 'vaultName' should be defined with a 'pattern' restriction.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L639
❌ PathForNestedResource The path for nested resource doest not meet the valid resource pattern. There is one exception for extension resources with fully qualified path and the author can go ahead and suppress the error(look at https://github.com/Azure/azure-openapi-validator/blob/main/docs/path-for-nested-resource.md#pathfornestedresource for more details)
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L639
❌ EvenSegmentedPathForPutOperation API path with PUT operation defined MUST have even number of segments (i.e. end in {resourceType}/{resourceName} segments).
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L639
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L608
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L602
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:name.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L585
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:type.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L585
❌ UnSupportedPatchProperties Mark the top-level property 'location', specified in the patch operation body, as readOnly or immutable. You could also choose to remove it from the request payload of the Patch operation. This property is not patchable.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L580
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L478
❌ ResourceNameRestriction The resource name parameter 'vaultName' should be defined with a 'pattern' restriction.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L377
❌ OperationsApiSchemaUsesCommonTypes Operations API path must follow the schema provided in the common types.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L308
❌ OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.RecoveryServices/operations' does not match the ARM specification. Please standardize the schema.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L307
❌ ResourceNameRestriction The resource name parameter 'privateLinkResourceName' should be defined with a 'pattern' restriction.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L71
❌ ResourceNameRestriction The resource name parameter 'vaultName' should be defined with a 'pattern' restriction.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L71
❌ ResourceNameRestriction The resource name parameter 'vaultName' should be defined with a 'pattern' restriction.
Location: Microsoft.RecoveryServices/stable/2024-04-01/vaults.json#L21
❌ XmsParameterLocation The parameter 'ApiVersion' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'.
Location: Microsoft.RecoveryServices/stable/2024-04-01/replicationusages.json#L182
❌ XmsParameterLocation The parameter 'SubscriptionId' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'.
Location: Microsoft.RecoveryServices/stable/2024-04-01/replicationusages.json#L159
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.RecoveryServices/stable/2024-04-01/replicationusages.json#L138
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.RecoveryServices/stable/2024-04-01/replicationusages.json#L134
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.RecoveryServices/stable/2024-04-01/replicationusages.json#L130
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.RecoveryServices/stable/2024-04-01/replicationusages.json#L126
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.RecoveryServices/stable/2024-04-01/replicationusages.json#L108
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.RecoveryServices/stable/2024-04-01/replicationusages.json#L104
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.RecoveryServices/stable/2024-04-01/replicationusages.json#L100
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.RecoveryServices/stable/2024-04-01/replicationusages.json#L96
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.RecoveryServices/stable/2024-04-01/replicationusages.json#L92
❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
Location: Microsoft.RecoveryServices/stable/2024-04-01/replicationusages.json#L88
View more details on openapi-pipeline-app