Updated summaries and descriptions for certificate, secret, keys operations. #2322
Conversation
|
Hello @tiffanyachen ! |
| "operationId": "GetDeletedKeys", | ||
| "description": "List deleted keys in the specified vault. Authorization: Requires the keys/list permission.", | ||
| "summary": "Lists the deleted keys in the specified vault.", | ||
| "description": "Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a deleted key. This operation icludes deletion-specific information. The Get Deleted Keys operation is applicable for vaults enabled for soft-delete. It requires the keys/list permission to be enabled on this vault. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault.", |
There was a problem hiding this comment.
It requires the keys/list permission to be enabled on this vault [](start = 279, length = 64)
The caller needs the permission, not the permission is enabled on the vault.
| "operationId": "GetDeletedKey", | ||
| "description": "Retrieves the deleted key information plus its attributes. Authorization: Requires the keys/get permission.", | ||
| "summary": "Gets the public part of a deleted key.", | ||
| "description": "The Get Deleted Key operation is applicable for soft-delete enabled vaults. It requires the keys/list permission to be enabled on this vault. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault.", |
There was a problem hiding this comment.
It requires the keys/list permission to be enabled on this vault [](start = 100, length = 64)
The caller needs the permission, not the permission is enabled on the vault.
| "operationId": "PurgeDeletedKey", | ||
| "description": "Permanently deletes the specified key. aka purges the key. Authorization: Requires the keys/purge permission.", | ||
| "summary": "Permanently deletes the specified key.", | ||
| "description": "The Purge Deleted Key operation is applicable for soft-delete enabled vaults. It requires the keys/purge permission to be enabled on this vault. While the operation can be invoked on any vault, it will return an error if invoked on a non soft-delete enabled vault.", |
There was a problem hiding this comment.
It requires the keys/purge permission to be enabled on this vault [](start = 102, length = 65)
The caller needs the permission, not the permission is enabled on the vault.
| "operationId": "RecoverDeletedKey", | ||
| "description": "Recovers the deleted key back to its current version under /keys. Authorization: Requires the keys/recover permission.", | ||
| "summary": "Recovers the deleted key to its latest version.", | ||
| "description": "The Recover Deleted Key operation is applicable for deleted keys in soft-delete enabled vaults. It recovers the deleted key back to its latest version under /keys. It requires the keys/recover permissions to be enabled on this vault. An attempt to recover an non-deleted key will return an error. Consider this the inverse of the delete operation on soft-delete enabled vaults.", |
There was a problem hiding this comment.
It requires the keys/recover permissions to be enabled on this vault [](start = 188, length = 68)
The caller needs the permission, not the permission is enabled on the vault.
| "summary": "List the versions of the specified secret.", | ||
| "description": "The LIST VERSIONS operation can be applied to all versions having the same secret name in the same key vault. The full secret identifier and attributes are provided in the response. No values are returned for the secrets and only current versions of a secret are listed.", | ||
| "summary": "List all versions of the specified secret.", | ||
| "description": "The full secret identifier and attributes are provided in the response. No values are returned for the secrets.", |
There was a problem hiding this comment.
. [](start = 134, length = 1)
Should this mention that the operation requires the secrets/list permission?
| "operationId": "PurgeDeletedSecret", | ||
| "description": "Permanently deletes the specified secret. aka purges the secret. Authorization: requires the secrets/purge permission.", | ||
| "summary": "Permanently deletes the specified secret.", | ||
| "description": "The purge deleted secret operation removes the secret permanently, without the possibility of recovery. It requires the secrets/purge permission, which must be assigned explicitly.", |
There was a problem hiding this comment.
The purge deleted secret operation removes the secret permanently, without the possibility of recovery. It requires the secrets/purge permission, which must be assigned explicitly. [](start = 24, length = 180)
should this mention that it can only be performed on a soft delete enabled vault?
| "operationId": "RecoverDeletedSecret", | ||
| "description": "Recovers the deleted secret back to its current version under /secrets. Authorization: requires the secrets/recover permission.", | ||
| "summary": "Recovers the deleted secret to the latest version.", | ||
| "description": "Recovers the deleted secret in the specified vault. It requires the secrets/recover permission.", |
There was a problem hiding this comment.
Recovers the deleted secret in the specified vault. It requires the secrets/recover permission. [](start = 24, length = 95)
should this mention that it can only be performed on a soft delete enabled vault?
| "operationId": "UpdateCertificate", | ||
| "summary": "Updates the specified attributes associated with the given certificate.", | ||
| "description": "The UpdateCertificate operation applies the specified update on the given certificate; note the only elements being updated are the certificate's attributes.", | ||
| "description": "The UpdateCertificate operation applies the specified update on the given certificate; the only elements updated are the certificate's attributes.", |
There was a problem hiding this comment.
The UpdateCertificate operation applies the specified update on the given certificate; the only elements updated are the certificate's attributes. [](start = 24, length = 146)
should this mention that it requires the certificates/update permission
| "operationId": "GetCertificate", | ||
| "description": "Gets information about a specified certificate. Authorization: requires the certificates/get permission.", | ||
| "summary": "Gets information about a certificate.", | ||
| "description": "Gets information about a specific certificate. It requires the certificates and get permissions.", |
There was a problem hiding this comment.
It requires the certificates and get permissions. [](start = 71, length = 49)
this worded differently from other descriptions referring to required permissions
| "summary": "Lists the deleted certificates in the specified vault, currently available for recovery.", | ||
| "description": "The GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging.", | ||
| "summary": "Lists the deleted certificates in the specified vault currently available for recovery.", | ||
| "description": "The GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This operation includes deletion-specific information. It requires the certificates/update permission.", |
There was a problem hiding this comment.
The GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This operation includes deletion-specific information. It requires the certificates/update permission. [](start = 24, length = 251)
should this mention that it only applies to vaults with soft delete enabled?
|
Hi There, I am the AutoRest Linter Azure bot. I am here to help. My task is to analyze the situation from the AutoRest linter perspective. Please review the below analysis result: File: AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback Thanks for your co-operation. |
|
@schaabs |
|
Still updating for review @mcardosos |
|
Hi There, I am the AutoRest Linter Azure bot. I am here to help. My task is to analyze the situation from the AutoRest linter perspective. Please review the below analysis result: File: AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback Thanks for your co-operation. |
|
This commit was treated and no generation was made for Python |
Swagger to SDK encountered an unknown error: (Azure/azure-sdk-for-go)
Traceback (most recent call last):
File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/github_tools.py", line 29, in exception_to_github
yield context
File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/restapi/github.py", line 180, in rest_handle_action
return rest_pull_close(body, github_con, restapi_repo, sdk_pr_target_repo, sdkbase)
File "/usr/local/lib/python3.6/dist-packages/swaggertosdk/restapi/github.py", line 306, in rest_pull_close
rest_pr.create_issue_comment("Was unable to create SDK %s PR for this closed PR.", sdkid)
TypeError: create_issue_comment() takes 2 positional arguments but 3 were given |
|
Did a commit to SDK for Python: |
|
No modification for AutorestCI/azure-sdk-for-ruby |
1 similar comment
|
No modification for AutorestCI/azure-sdk-for-ruby |
5 participants
This checklist is used to make sure that common issues in a pull request are addressed. This will expedite the process of getting your pull request merged and avoid extra work on your part to fix issues discovered during the review process.
PR information
api-versionin the path should match theapi-versionin the spec).Quality of Swagger