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.

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

feat: [privilegedaccessmanager] republish docs #5810

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/google-cloud-privilegedaccessmanager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
1. [Select or create a Cloud Platform project][projects].
1. [Enable billing for your project][billing].
1. [Enable the Privileged Access Manager API API][enable_api].
1. [Set up authentication with a service account][auth] so you can access the
1. [Set up authentication][auth] so you can access the
API from your local workstation.

### Installing the client library
Expand Down Expand Up @@ -201,4 +201,4 @@ See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)
[projects]: https://console.cloud.google.com/project
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=privilegedaccessmanager.googleapis.com
[auth]: https://cloud.google.com/docs/authentication/getting-started
[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ service PrivilegedAccessManager {
option (google.api.oauth_scopes) =
"https://www.googleapis.com/auth/cloud-platform";

// CheckOnboardingStatus reports the onboarding status for a
// `CheckOnboardingStatus` reports the onboarding status for a
// project/folder/organization. Any findings reported by this API need to be
// fixed before PAM can be used on the resource.
rpc CheckOnboardingStatus(CheckOnboardingStatusRequest)
Expand Down Expand Up @@ -151,7 +151,7 @@ service PrivilegedAccessManager {
}

// Deletes a single entitlement. This method can only be called when there
// are no in-progress (ACTIVE/ACTIVATING/REVOKING) grants under the
// are no in-progress (`ACTIVE`/`ACTIVATING`/`REVOKING`) grants under the
// entitlement.
rpc DeleteEntitlement(DeleteEntitlementRequest)
returns (google.longrunning.Operation) {
Expand Down Expand Up @@ -254,7 +254,8 @@ service PrivilegedAccessManager {
option (google.api.method_signature) = "name";
}

// Creates a new grant in a given project and location.
// Creates a new grant in a given project/folder/organization and
// location.
rpc CreateGrant(CreateGrantRequest) returns (Grant) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/entitlements/*}/grants"
Expand Down Expand Up @@ -411,7 +412,7 @@ message Entitlement {
}
}

// AdditionalNotificationTargets includes email addresses to be notified.
// `AdditionalNotificationTargets` includes email addresses to be notified.
message AdditionalNotificationTargets {
// Optional. Additional email addresses to be notified when a principal
// (requester) is granted access.
Expand Down Expand Up @@ -500,7 +501,7 @@ message Entitlement {
string etag = 12;
}

// AccessControlEntry is used to control who can do some operation.
// `AccessControlEntry` is used to control who can do some operation.
message AccessControlEntry {
// Optional. Users who are allowed for the operation. Each entry should be a
// valid v1 IAM principal identifier. The format for these is documented at:
Expand Down Expand Up @@ -564,11 +565,11 @@ message ManualApprovals {

// Privileged access that this service can be used to gate.
message PrivilegedAccess {
// GcpIamAccess represents IAM based access control on a Google Cloud
// `GcpIamAccess` represents IAM based access control on a Google Cloud
// resource. Refer to https://cloud.google.com/iam/docs to understand more
// about IAM.
message GcpIamAccess {
// IAM Role bindings that are created after a successful grant.
// IAM role bindings that are created after a successful grant.
message RoleBinding {
// Required. IAM role to be granted.
// https://cloud.google.com/iam/docs/roles-overview.
Expand Down Expand Up @@ -736,7 +737,7 @@ message CreateEntitlementRequest {
// ID, the server can check if original operation with the same request ID
// was received, and if so, ignores the second request and returns the
// previous operation's response. This prevents clients from accidentally
// creating duplicate commitments.
// creating duplicate entitlements.
//
// The request ID must be a valid UUID with the exception that zero UUID is
// not supported (00000000-0000-0000-0000-000000000000).
Expand All @@ -761,8 +762,7 @@ message DeleteEntitlementRequest {
// For example, consider a situation where you make an initial request and the
// request times out. If you make the request again with the same request
// ID, the server can check if original operation with the same request ID
// was received, and if so, ignores the second request. This prevents
// clients from accidentally creating duplicate commitments.
// was received, and if so, ignores the second request.
//
// The request ID must be a valid UUID with the exception that zero UUID is
// not supported (00000000-0000-0000-0000-000000000000).
Expand Down Expand Up @@ -792,8 +792,6 @@ message UpdateEntitlementRequest {
[(google.api.field_behavior) = REQUIRED];
}

// This is to ensure that the `Grants` and `ProducerGrants` proto are byte
// compatible.
// A grant represents a request from a user for obtaining the access specified
// in an entitlement they are eligible for.
message Grant {
Expand Down Expand Up @@ -1210,7 +1208,7 @@ message CreateGrantRequest {
// request times out. If you make the request again with the same request
// ID, the server can check if original operation with the same request ID
// was received, and if so, ignores the second request. This prevents
// clients from accidentally creating duplicate commitments.
// clients from accidentally creating duplicate grants.
//
// The request ID must be a valid UUID with the exception that zero UUID is
// not supported (00000000-0000-0000-0000-000000000000).
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ function main(parent, entitlementId, entitlement) {
* ID, the server can check if original operation with the same request ID
* was received, and if so, ignores the second request and returns the
* previous operation's response. This prevents clients from accidentally
* creating duplicate commitments.
* creating duplicate entitlements.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ function main(parent, grant) {
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, ignores the second request. This prevents
* clients from accidentally creating duplicate commitments.
* clients from accidentally creating duplicate grants.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,7 @@ function main(name) {
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, ignores the second request. This prevents
* clients from accidentally creating duplicate commitments.
* was received, and if so, ignores the second request.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"regionTag": "privilegedaccessmanager_v1_generated_PrivilegedAccessManager_CheckOnboardingStatus_async",
"title": "PrivilegedAccessManager checkOnboardingStatus Sample",
"origin": "API_DEFINITION",
"description": " CheckOnboardingStatus reports the onboarding status for a project/folder/organization. Any findings reported by this API need to be fixed before PAM can be used on the resource.",
"description": " `CheckOnboardingStatus` reports the onboarding status for a project/folder/organization. Any findings reported by this API need to be fixed before PAM can be used on the resource.",
"canonical": true,
"file": "privileged_access_manager.check_onboarding_status.js",
"language": "JAVASCRIPT",
Expand Down Expand Up @@ -259,14 +259,14 @@
"regionTag": "privilegedaccessmanager_v1_generated_PrivilegedAccessManager_DeleteEntitlement_async",
"title": "PrivilegedAccessManager deleteEntitlement Sample",
"origin": "API_DEFINITION",
"description": " Deletes a single entitlement. This method can only be called when there are no in-progress (ACTIVE/ACTIVATING/REVOKING) grants under the entitlement.",
"description": " Deletes a single entitlement. This method can only be called when there are no in-progress (`ACTIVE`/`ACTIVATING`/`REVOKING`) grants under the entitlement.",
"canonical": true,
"file": "privileged_access_manager.delete_entitlement.js",
"language": "JAVASCRIPT",
"segments": [
{
"start": 25,
"end": 74,
"end": 73,
"type": "FULL"
}
],
Expand Down Expand Up @@ -503,7 +503,7 @@
"regionTag": "privilegedaccessmanager_v1_generated_PrivilegedAccessManager_CreateGrant_async",
"title": "PrivilegedAccessManager createGrant Sample",
"origin": "API_DEFINITION",
"description": " Creates a new grant in a given project and location.",
"description": " Creates a new grant in a given project/folder/organization and location.",
"canonical": true,
"file": "privileged_access_manager.create_grant.js",
"language": "JAVASCRIPT",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -572,7 +572,7 @@ export class PrivilegedAccessManagerClient {
// -- Service calls --
// -------------------
/**
* CheckOnboardingStatus reports the onboarding status for a
* `CheckOnboardingStatus` reports the onboarding status for a
* project/folder/organization. Any findings reported by this API need to be
* fixed before PAM can be used on the resource.
*
Expand Down Expand Up @@ -867,7 +867,8 @@ export class PrivilegedAccessManagerClient {
return this.innerApiCalls.getGrant(request, options, callback);
}
/**
* Creates a new grant in a given project and location.
* Creates a new grant in a given project/folder/organization and
* location.
*
* @param {Object} request
* The request object that will be sent.
Expand All @@ -886,7 +887,7 @@ export class PrivilegedAccessManagerClient {
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, ignores the second request. This prevents
* clients from accidentally creating duplicate commitments.
* clients from accidentally creating duplicate grants.
*
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
Expand Down Expand Up @@ -1219,7 +1220,7 @@ export class PrivilegedAccessManagerClient {
* ID, the server can check if original operation with the same request ID
* was received, and if so, ignores the second request and returns the
* previous operation's response. This prevents clients from accidentally
* creating duplicate commitments.
* creating duplicate entitlements.
*
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
Expand Down Expand Up @@ -1354,7 +1355,7 @@ export class PrivilegedAccessManagerClient {
}
/**
* Deletes a single entitlement. This method can only be called when there
* are no in-progress (ACTIVE/ACTIVATING/REVOKING) grants under the
* are no in-progress (`ACTIVE`/`ACTIVATING`/`REVOKING`) grants under the
* entitlement.
*
* @param {Object} request
Expand All @@ -1370,8 +1371,7 @@ export class PrivilegedAccessManagerClient {
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, ignores the second request. This prevents
* clients from accidentally creating duplicate commitments.
* was received, and if so, ignores the second request.
*
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
Expand Down
Loading