[Hub Generated] Review request for Microsoft.RecoveryServices to add version stable/2023-04-01#24111
Merged
weidongxu-microsoft merged 5 commits intomainfrom May 26, 2023
Conversation
…/2023-02-01 to version 2023-04-01
|
Hi, @ankur741999 Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| registeredidentities.json | 2023-04-01(0648a3f) | 2023-02-01(main) |
| registeredidentities.json | 2023-04-01(0648a3f) | 2022-09-30-preview(main) |
| replicationusages.json | 2023-04-01(0648a3f) | 2023-02-01(main) |
| replicationusages.json | 2023-04-01(0648a3f) | 2022-09-30-preview(main) |
| vaults.json | 2023-04-01(0648a3f) | 2023-02-01(main) |
| vaults.json | 2023-04-01(0648a3f) | 2022-09-30-preview(main) |
| vaultusages.json | 2023-04-01(0648a3f) | 2023-02-01(main) |
| vaultusages.json | 2023-04-01(0648a3f) | 2022-09-30-preview(main) |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.2) | new version | base version |
|---|---|---|
| package-2023-04 | package-2023-04(0648a3f) | default(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
ImplementPrivateEndpointAPIs |
The private endpoint API: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName} is missing. Location: Microsoft.RecoveryServices/stable/2023-04-01/registeredidentities.json#L20 |
ImplementPrivateEndpointAPIs |
The private endpoint API: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections is missing. Location: Microsoft.RecoveryServices/stable/2023-04-01/registeredidentities.json#L20 |
PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/certificates/{certificateName}' Location: Microsoft.RecoveryServices/stable/2023-04-01/registeredidentities.json#L21 |
ResourceNameRestriction |
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.RecoveryServices/stable/2023-04-01/registeredidentities.json#L21 |
ResourceNameRestriction |
The resource name parameter 'certificateName' should be defined with a 'pattern' restriction. Location: Microsoft.RecoveryServices/stable/2023-04-01/registeredidentities.json#L21 |
SubscriptionsAndResourceGroupCasing |
The path segment Subscriptions should be subscriptions. Location: Microsoft.RecoveryServices/stable/2023-04-01/registeredidentities.json#L21 |
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: 'VaultCertificates_Create' Request Model: 'parameters[5].schema' Response Model: 'responses[200].schema' Location: Microsoft.RecoveryServices/stable/2023-04-01/registeredidentities.json#L22 |
MissingDefaultResponse |
Operation is missing a default response. Location: Microsoft.RecoveryServices/stable/2023-04-01/registeredidentities.json#L64 |
PutResponseSchemaDescription |
Any Put MUST contain 200 and 201 return codes. Location: Microsoft.RecoveryServices/stable/2023-04-01/registeredidentities.json#L64 |
RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.RecoveryServices/stable/2023-04-01/registeredidentities.json#L64 |
PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/registeredIdentities/{identityName}' Location: Microsoft.RecoveryServices/stable/2023-04-01/registeredidentities.json#L80 |
ResourceNameRestriction |
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.RecoveryServices/stable/2023-04-01/registeredidentities.json#L80 |
ResourceNameRestriction |
The resource name parameter 'identityName' should be defined with a 'pattern' restriction. Location: Microsoft.RecoveryServices/stable/2023-04-01/registeredidentities.json#L80 |
SubscriptionsAndResourceGroupCasing |
The path segment Subscriptions should be subscriptions. Location: Microsoft.RecoveryServices/stable/2023-04-01/registeredidentities.json#L80 |
DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.RecoveryServices/stable/2023-04-01/registeredidentities.json#L108 |
MissingDefaultResponse |
Operation is missing a default response. Location: Microsoft.RecoveryServices/stable/2023-04-01/registeredidentities.json#L108 |
RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.RecoveryServices/stable/2023-04-01/registeredidentities.json#L108 |
NestedResourcesMustHaveListOperation |
The nested resource 'VaultCertificateResponse' does not have list operation, please add it. Location: Microsoft.RecoveryServices/stable/2023-04-01/registeredidentities.json#L300 |
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/2023-04-01/registeredidentities.json#L327 |
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/2023-04-01/registeredidentities.json#L350 |
PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/replicationUsages' Location: Microsoft.RecoveryServices/stable/2023-04-01/replicationusages.json#L21 |
ResourceNameRestriction |
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.RecoveryServices/stable/2023-04-01/replicationusages.json#L21 |
SubscriptionsAndResourceGroupCasing |
The path segment Subscriptions should be subscriptions. Location: Microsoft.RecoveryServices/stable/2023-04-01/replicationusages.json#L21 |
MissingDefaultResponse |
Operation is missing a default response. Location: Microsoft.RecoveryServices/stable/2023-04-01/replicationusages.json#L45 |
RequiredDefaultResponse |
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.RecoveryServices/stable/2023-04-01/replicationusages.json#L45 |
GetCollectionOnlyHasValueAndNextLink |
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.RecoveryServices/stable/2023-04-01/replicationusages.json#L48 |
IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/stable/2023-04-01/replicationusages.json#L70 |
IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/stable/2023-04-01/replicationusages.json#L74 |
IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/stable/2023-04-01/replicationusages.json#L78 |
IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.RecoveryServices/stable/2023-04-01/replicationusages.json#L88 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 29 Errors, 0 Warnings failed [Detail]
Tag package-2023-04; Prod region: Deployed
Test run on region: westcentralus; Operation coverage: total: 20, untested: 0, failed: 11, passed: 9
Service API Readiness Test failed. Check pipeline artifact for detail report.
| Rule | Message |
|---|---|
CLIENT_ERROR |
statusCode: 404, errorCode: InvalidResourceType, errorMessage: The resource type 'locations/checkNameAvailability' could not be found in the namespace 'Microsoft.RecoveryServices' for api version '2023-04-01'. The supported api-versions are '2018-01-10'. Source: runtime OperationId: RecoveryServices_CheckNameAvailability |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: location Source: response OperationId: VaultExtendedInfo_CreateOrUpdate |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: tags Source: response OperationId: VaultExtendedInfo_CreateOrUpdate |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: identity Source: response OperationId: VaultExtendedInfo_CreateOrUpdate |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: sku Source: response OperationId: VaultExtendedInfo_CreateOrUpdate |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: location Source: response OperationId: VaultExtendedInfo_Get |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: tags Source: response OperationId: VaultExtendedInfo_Get |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: identity Source: response OperationId: VaultExtendedInfo_Get |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: sku Source: response OperationId: VaultExtendedInfo_Get |
CLIENT_ERROR |
statusCode: 412, errorCode: undefined, errorMessage: undefined Source: runtime OperationId: VaultExtendedInfo_Update |
INVALID_RESPONSE_BODY |
Body is required in response but not provided Source: response OperationId: VaultExtendedInfo_Update |
CLIENT_ERROR |
statusCode: 400, errorCode: undefined, errorMessage: undefined Source: runtime OperationId: VaultCertificates_Create |
INVALID_RESPONSE_CODE |
The swagger file does not define '400' response code Source: response OperationId: VaultCertificates_Create |
CLIENT_ERROR |
statusCode: 404, errorCode: ResourceNotFound, errorMessage: Could not perform the operation as VM no longer exists. Stop protecting virtual machine without deleting backup data. More details at http://go.microsoft.com/fwlink/?LinkId=808124 Source: runtime OperationId: RegisteredIdentities_Delete |
INVALID_RESPONSE_CODE |
The swagger file does not define '404' response code Source: response OperationId: RegisteredIdentities_Delete |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: monitoringSummary Source: response OperationId: ReplicationUsages_List |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: jobsSummary Source: response OperationId: ReplicationUsages_List |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: protectedItemsSummary Source: response OperationId: ReplicationUsages_List |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: storageAccountsCountSummary Source: response OperationId: ReplicationUsages_List |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: protectedItemCount Source: response OperationId: ReplicationUsages_List |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: registeredServersCount Source: response OperationId: ReplicationUsages_List |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: recoveryPlanCount Source: response OperationId: ReplicationUsages_List |
CLIENT_ERROR |
statusCode: 403, errorCode: AuthorizationFailed, errorMessage: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' does not have authorization to perform action 'Microsoft.RecoveryServices/locations/capabilities/action' over scope '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5' or the scope is invalid. If access was recently granted, please refresh your credentials. Source: runtime OperationId: RecoveryServices_Capabilities |
CLIENT_ERROR |
statusCode: 400, errorCode: CloudInvalidInputError, errorMessage: The current operation failed due to an internal service error "Invalid input error". Please retry the operation after some time. If the issue persists, please contact Microsoft support. Source: runtime OperationId: GetOperationResult |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: innerError Source: response OperationId: GetOperationResult |
CLIENT_ERROR |
statusCode: 400, errorCode: CloudInvalidInputError, errorMessage: The current operation failed due to an internal service error "Invalid input error". Please retry the operation after some time. If the issue persists, please contact Microsoft support. Source: runtime OperationId: GetOperationStatus |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: innerError Source: response OperationId: GetOperationStatus |
CLIENT_ERROR |
statusCode: 404, errorCode: undefined, errorMessage: undefined Source: runtime OperationId: PrivateLinkResources_Get |
INVALID_RESPONSE_BODY |
Body is required in response but not provided Source: response OperationId: PrivateLinkResources_Get |
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced May 23, 2023
|
Hi, @ankur741999 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
This was referenced May 23, 2023
v-jiaodi
approved these changes
May 24, 2023
This was referenced May 26, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.