Skip to content

Commit 0cbcc59

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
docs: Small change for documentation
PiperOrigin-RevId: 490109215
1 parent 95cc6e0 commit 0cbcc59

9 files changed

Lines changed: 663 additions & 540 deletions

File tree

‎google/cloud/asset/v1/asset_service.proto‎

Lines changed: 464 additions & 369 deletions
Large diffs are not rendered by default.

‎google/cloud/asset/v1/assets.proto‎

Lines changed: 116 additions & 94 deletions
Large diffs are not rendered by default.

‎google/cloud/asset/v1/cloudasset_v1.yaml‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,9 @@ documentation:
1616
overview: |-
1717
# Cloud Asset API
1818
19-
The Cloud Asset API keeps a history of Google Cloud Platform (GCP) asset
20-
metadata, and allows GCP users to download a dump of all asset metadata
21-
for the resource types listed below within an organization or a project at
22-
a given timestamp.
19+
The Cloud Asset API keeps a history of Google Cloud asset metadata, and lets Google Cloud users
20+
download a dump of all asset metadata for the resource types listed below within an organization
21+
or a project at a given timestamp.
2322
2423
Read more documents here:
2524
https://cloud.google.com/asset-inventory/docs

‎google/cloud/asset/v1p1beta1/asset_service.proto‎

Lines changed: 47 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -31,28 +31,32 @@ option php_namespace = "Google\\Cloud\\Asset\\V1p1beta1";
3131
// Asset service definition.
3232
service AssetService {
3333
option (google.api.default_host) = "cloudasset.googleapis.com";
34-
option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
34+
option (google.api.oauth_scopes) =
35+
"https://www.googleapis.com/auth/cloud-platform";
3536

36-
// Searches all the resources under a given accessible CRM scope
37+
// Searches all the resources under a given accessible {{crm_name}} scope
3738
// (project/folder/organization). This RPC gives callers
3839
// especially admins the ability to search all the resources under a scope,
3940
// even if they don't have .get permission of all the resources. Callers
4041
// should have cloud.assets.SearchAllResources permission on the requested
4142
// scope, otherwise it will be rejected.
42-
rpc SearchAllResources(SearchAllResourcesRequest) returns (SearchAllResourcesResponse) {
43+
rpc SearchAllResources(SearchAllResourcesRequest)
44+
returns (SearchAllResourcesResponse) {
4345
option (google.api.http) = {
4446
get: "/v1p1beta1/{scope=*/*}/resources:searchAll"
4547
};
4648
option (google.api.method_signature) = "scope,query,asset_types";
4749
}
4850

49-
// Searches all the IAM policies under a given accessible CRM scope
50-
// (project/folder/organization). This RPC gives callers
51-
// especially admins the ability to search all the IAM policies under a scope,
52-
// even if they don't have .getIamPolicy permission of all the IAM policies.
53-
// Callers should have cloud.assets.SearchAllIamPolicies permission on the
54-
// requested scope, otherwise it will be rejected.
55-
rpc SearchAllIamPolicies(SearchAllIamPoliciesRequest) returns (SearchAllIamPoliciesResponse) {
51+
// Searches all the {{iam_name_short}} policies under a given accessible
52+
// {{crm_name}} scope (project/folder/organization). This RPC gives callers
53+
// especially admins the ability to search all the {{iam_name_short}} policies
54+
// under a scope, even if they don't have .getIamPolicy permission of all the
55+
// {{iam_name_short}} policies. Callers should have
56+
// cloud.assets.SearchAllIamPolicies permission on the requested scope,
57+
// otherwise it will be rejected.
58+
rpc SearchAllIamPolicies(SearchAllIamPoliciesRequest)
59+
returns (SearchAllIamPoliciesResponse) {
5660
option (google.api.http) = {
5761
get: "/v1p1beta1/{scope=*/*}/iamPolicies:searchAll"
5862
};
@@ -62,8 +66,8 @@ service AssetService {
6266

6367
// Search all resources request.
6468
message SearchAllResourcesRequest {
65-
// Required. The relative name of an asset. The search is limited to the resources
66-
// within the `scope`. The allowed value must be:
69+
// Required. The relative name of an asset. The search is limited to the
70+
// resources within the `scope`. The allowed value must be:
6771
// * Organization number (such as "organizations/123")
6872
// * Folder number(such as "folders/1234")
6973
// * Project number (such as "projects/12345")
@@ -73,26 +77,27 @@ message SearchAllResourcesRequest {
7377
// Optional. The query statement.
7478
string query = 2 [(google.api.field_behavior) = OPTIONAL];
7579

76-
// Optional. A list of asset types that this request searches for. If empty, it will
77-
// search all the supported asset types.
80+
// Optional. A list of asset types that this request searches for. If empty,
81+
// it will search all the supported asset types.
7882
repeated string asset_types = 3 [(google.api.field_behavior) = OPTIONAL];
7983

80-
// Optional. The page size for search result pagination. Page size is capped at 500 even
81-
// if a larger value is given. If set to zero, server will pick an appropriate
82-
// default. Returned results may be fewer than requested. When this happens,
83-
// there could be more results as long as `next_page_token` is returned.
84+
// Optional. The page size for search result pagination. Page size is capped
85+
// at 500 even if a larger value is given. If set to zero, server will pick an
86+
// appropriate default. Returned results may be fewer than requested. When
87+
// this happens, there could be more results as long as `next_page_token` is
88+
// returned.
8489
int32 page_size = 4 [(google.api.field_behavior) = OPTIONAL];
8590

86-
// Optional. If present, then retrieve the next batch of results from the preceding call
87-
// to this method. `page_token` must be the value of `next_page_token` from
88-
// the previous response. The values of all other method parameters, must be
89-
// identical to those in the previous call.
91+
// Optional. If present, then retrieve the next batch of results from the
92+
// preceding call to this method. `page_token` must be the value of
93+
// `next_page_token` from the previous response. The values of all other
94+
// method parameters, must be identical to those in the previous call.
9095
string page_token = 5 [(google.api.field_behavior) = OPTIONAL];
9196

92-
// Optional. A comma separated list of fields specifying the sorting order of the
93-
// results. The default order is ascending. Add " desc" after the field name
94-
// to indicate descending order. Redundant space characters are ignored. For
95-
// example, " foo , bar desc ".
97+
// Optional. A comma separated list of fields specifying the sorting order of
98+
// the results. The default order is ascending. Add " desc" after the field
99+
// name to indicate descending order. Redundant space characters are ignored.
100+
// For example, " foo , bar desc ".
96101
string order_by = 10 [(google.api.field_behavior) = OPTIONAL];
97102
}
98103

@@ -107,10 +112,10 @@ message SearchAllResourcesResponse {
107112
string next_page_token = 2;
108113
}
109114

110-
// Search all IAM policies request.
115+
// Search all {{iam_name_short}} policies request.
111116
message SearchAllIamPoliciesRequest {
112-
// Required. The relative name of an asset. The search is limited to the resources
113-
// within the `scope`. The allowed value must be:
117+
// Required. The relative name of an asset. The search is limited to the
118+
// resources within the `scope`. The allowed value must be:
114119
// * Organization number (such as "organizations/123")
115120
// * Folder number(such as "folders/1234")
116121
// * Project number (such as "projects/12345")
@@ -123,23 +128,25 @@ message SearchAllIamPoliciesRequest {
123128
// * "policy:([email protected] viewer)"
124129
string query = 2 [(google.api.field_behavior) = OPTIONAL];
125130

126-
// Optional. The page size for search result pagination. Page size is capped at 500 even
127-
// if a larger value is given. If set to zero, server will pick an appropriate
128-
// default. Returned results may be fewer than requested. When this happens,
129-
// there could be more results as long as `next_page_token` is returned.
131+
// Optional. The page size for search result pagination. Page size is capped
132+
// at 500 even if a larger value is given. If set to zero, server will pick an
133+
// appropriate default. Returned results may be fewer than requested. When
134+
// this happens, there could be more results as long as `next_page_token` is
135+
// returned.
130136
int32 page_size = 3 [(google.api.field_behavior) = OPTIONAL];
131137

132-
// Optional. If present, retrieve the next batch of results from the preceding call to
133-
// this method. `page_token` must be the value of `next_page_token` from the
134-
// previous response. The values of all other method parameters must be
135-
// identical to those in the previous call.
138+
// Optional. If present, retrieve the next batch of results from the preceding
139+
// call to this method. `page_token` must be the value of `next_page_token`
140+
// from the previous response. The values of all other method parameters must
141+
// be identical to those in the previous call.
136142
string page_token = 4 [(google.api.field_behavior) = OPTIONAL];
137143
}
138144

139-
// Search all IAM policies response.
145+
// Search all {{iam_name_short}} policies response.
140146
message SearchAllIamPoliciesResponse {
141-
// A list of IamPolicy that match the search query. Related information such
142-
// as the associated resource is returned along with the policy.
147+
// A list of {{iam_name_short}} policies that match the search query. Related
148+
// information such as the associated resource is returned along with the
149+
// policy.
143150
repeated IamPolicySearchResult results = 1;
144151

145152
// Set if there are more results than those appearing in this response; to get

‎google/cloud/asset/v1p1beta1/assets.proto‎

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -59,21 +59,23 @@ message StandardResourceMetadata {
5959
// "us-west1-b".
6060
string location = 11;
6161

62-
// Labels associated with this resource. See [Labelling and grouping GCP
62+
// Labels associated with this resource. See [Labelling and grouping
63+
// {{gcp_name}}
6364
// resources](https://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources)
6465
// for more information.
6566
map<string, string> labels = 12;
6667

6768
// Network tags associated with this resource. Like labels, network tags are a
68-
// type of annotations used to group GCP resources. See [Labelling GCP
69+
// type of annotations used to group {{gcp_name}} resources. See
70+
// [Labelling {{gcp_name}}
6971
// resources](lhttps://cloud.google.com/blog/products/gcp/labelling-and-grouping-your-google-cloud-platform-resources)
7072
// for more information.
7173
repeated string network_tags = 13;
7274
}
7375

74-
// The result for a IAM Policy search.
76+
// The result for a {{iam_name_short}} Policy search.
7577
message IamPolicySearchResult {
76-
// Explanation about the IAM policy search result.
78+
// Explanation about the {{iam_name_short}} policy search result.
7779
message Explanation {
7880
// The map from roles to their included permission matching the permission
7981
// query (e.g. containing `policy.role.permissions:`). A sample role string:
@@ -85,28 +87,30 @@ message IamPolicySearchResult {
8587

8688
// The [full resource
8789
// name](https://cloud.google.com/apis/design/resource_names#full_resource_name)
88-
// of the resource associated with this IAM policy.
90+
// of the resource associated with this {{iam_name_short}} policy.
8991
string resource = 1;
9092

91-
// The project that the associated GCP resource belongs to, in the form of
92-
// `projects/{project_number}`. If an IAM policy is set on a resource (like VM
93-
// instance, Cloud Storage bucket), the project field will indicate the
94-
// project that contains the resource. If an IAM policy is set on a folder or
95-
// orgnization, the project field will be empty.
93+
// The project that the associated {{gcp_name}} resource belongs to, in the
94+
// form of `projects/{project_number}`. If an {{iam_name_short}} policy is set
95+
// on a resource (like VM instance, {{storage_name}} bucket), the project
96+
// field will indicate the project that contains the resource. If an
97+
// {{iam_name_short}} policy is set on a folder or orgnization, the project
98+
// field will be empty.
9699
string project = 3;
97100

98-
// The IAM policy directly set on the given resource. Note that the original
99-
// IAM policy can contain multiple bindings. This only contains the bindings
100-
// that match the given query. For queries that don't contain a constrain on
101-
// policies (e.g. an empty query), this contains all the bindings.
101+
// The {{iam_name_short}} policy directly set on the given resource. Note that
102+
// the original {{iam_name_short}} policy can contain multiple bindings. This
103+
// only contains the bindings that match the given query. For queries that
104+
// don't contain a constrain on policies (e.g. an empty query), this contains
105+
// all the bindings.
102106
google.iam.v1.Policy policy = 4;
103107

104-
// Explanation about the IAM policy search result. It contains additional
105-
// information to explain why the search result matches the query.
108+
// Explanation about the {{iam_name_short}} policy search result. It contains
109+
// additional information to explain why the search result matches the query.
106110
Explanation explanation = 5;
107111
}
108112

109-
// IAM permissions
113+
// {{iam_name_short}} permissions
110114
message Permissions {
111115
// A list of permissions. A sample permission string: "compute.disk.get".
112116
repeated string permissions = 1;

‎google/cloud/asset/v1p1beta1/cloudasset_v1p1beta1.yaml‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,9 @@ documentation:
1111
overview: |-
1212
# Cloud Asset API
1313
14-
The Cloud Asset API keeps a history of Google Cloud Platform (GCP) asset
15-
metadata, and allows GCP users to download a dump of all asset metadata
16-
for the resource types listed below within an organization or a project at
17-
a given timestamp.
14+
The Cloud Asset API keeps a history of Google Cloud asset metadata, and lets Google Cloud users
15+
download a dump of all asset metadata for the resource types listed below within an organization
16+
or a project at a given timestamp.
1817
1918
Read more documents here:
2019
https://cloud.google.com/asset-inventory/docs

‎google/cloud/asset/v1p2beta1/cloudasset_v1p2beta1.yaml‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,9 @@ documentation:
1111
overview: |-
1212
# Cloud Asset API
1313
14-
The Cloud Asset API keeps a history of Google Cloud Platform (GCP) asset
15-
metadata, and allows GCP users to download a dump of all asset metadata
16-
for the resource types listed below within an organization or a project at
17-
a given timestamp.
14+
The Cloud Asset API keeps a history of Google Cloud asset metadata, and lets Google Cloud users
15+
download a dump of all asset metadata for the resource types listed below within an organization
16+
or a project at a given timestamp.
1817
1918
Read more documents here:
2019
https://cloud.google.com/asset-inventory/docs

‎google/cloud/asset/v1p5beta1/cloudasset_v1p5beta1.yaml‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,9 @@ documentation:
1111
overview: |-
1212
# Cloud Asset API
1313
14-
The Cloud Asset API keeps a history of Google Cloud Platform (GCP) asset
15-
metadata, and allows GCP users to download a dump of all asset metadata
16-
for the resource types listed below within an organization or a project at
17-
a given timestamp.
14+
The Cloud Asset API keeps a history of Google Cloud asset metadata, and lets Google Cloud users
15+
download a dump of all asset metadata for the resource types listed below within an organization
16+
or a project at a given timestamp.
1817
1918
Read more documents here:
2019
https://cloud.google.com/asset-inventory/docs

‎google/cloud/asset/v1p7beta1/cloudasset_v1p7beta1.yaml‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,9 @@ documentation:
1414
overview: |-
1515
# Cloud Asset API
1616
17-
The Cloud Asset API keeps a history of Google Cloud Platform (GCP) asset
18-
metadata, and allows GCP users to download a dump of all asset metadata
19-
for the resource types listed below within an organization or a project at
20-
a given timestamp.
17+
The Cloud Asset API keeps a history of Google Cloud asset metadata, and lets Google Cloud users
18+
download a dump of all asset metadata for the resource types listed below within an organization
19+
or a project at a given timestamp.
2120
2221
Read more documents here:
2322
https://cloud.google.com/asset-inventory/docs

0 commit comments

Comments
 (0)