Skip to content

Commit 9247e23

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
docs: Small change for documentation
PiperOrigin-RevId: 490314741
1 parent 4713c10 commit 9247e23

9 files changed

Lines changed: 540 additions & 663 deletions

File tree

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

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

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

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

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,10 @@ documentation:
1616
overview: |-
1717
# Cloud Asset API
1818
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.
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.
2223
2324
Read more documents here:
2425
https://cloud.google.com/asset-inventory/docs

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

Lines changed: 40 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -31,32 +31,28 @@ 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) =
35-
"https://www.googleapis.com/auth/cloud-platform";
34+
option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
3635

37-
// Searches all the resources under a given accessible {{crm_name}} scope
36+
// Searches all the resources under a given accessible CRM scope
3837
// (project/folder/organization). This RPC gives callers
3938
// especially admins the ability to search all the resources under a scope,
4039
// even if they don't have .get permission of all the resources. Callers
4140
// should have cloud.assets.SearchAllResources permission on the requested
4241
// scope, otherwise it will be rejected.
43-
rpc SearchAllResources(SearchAllResourcesRequest)
44-
returns (SearchAllResourcesResponse) {
42+
rpc SearchAllResources(SearchAllResourcesRequest) returns (SearchAllResourcesResponse) {
4543
option (google.api.http) = {
4644
get: "/v1p1beta1/{scope=*/*}/resources:searchAll"
4745
};
4846
option (google.api.method_signature) = "scope,query,asset_types";
4947
}
5048

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) {
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) {
6056
option (google.api.http) = {
6157
get: "/v1p1beta1/{scope=*/*}/iamPolicies:searchAll"
6258
};
@@ -66,8 +62,8 @@ service AssetService {
6662

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

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

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.
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.
8984
int32 page_size = 4 [(google.api.field_behavior) = OPTIONAL];
9085

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.
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.
9590
string page_token = 5 [(google.api.field_behavior) = OPTIONAL];
9691

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 ".
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 ".
10196
string order_by = 10 [(google.api.field_behavior) = OPTIONAL];
10297
}
10398

@@ -112,10 +107,10 @@ message SearchAllResourcesResponse {
112107
string next_page_token = 2;
113108
}
114109

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

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.
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.
136130
int32 page_size = 3 [(google.api.field_behavior) = OPTIONAL];
137131

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.
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.
142136
string page_token = 4 [(google.api.field_behavior) = OPTIONAL];
143137
}
144138

145-
// Search all {{iam_name_short}} policies response.
139+
// Search all IAM policies response.
146140
message SearchAllIamPoliciesResponse {
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.
141+
// A list of IamPolicy that match the search query. Related information such
142+
// as the associated resource is returned along with the policy.
150143
repeated IamPolicySearchResult results = 1;
151144

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

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

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

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

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

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

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

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.
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.
9996
string project = 3;
10097

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.
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.
106102
google.iam.v1.Policy policy = 4;
107103

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

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

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,10 @@ documentation:
1111
overview: |-
1212
# Cloud Asset API
1313
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.
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.
1718
1819
Read more documents here:
1920
https://cloud.google.com/asset-inventory/docs

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,10 @@ documentation:
1111
overview: |-
1212
# Cloud Asset API
1313
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.
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.
1718
1819
Read more documents here:
1920
https://cloud.google.com/asset-inventory/docs

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,10 @@ documentation:
1111
overview: |-
1212
# Cloud Asset API
1313
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.
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.
1718
1819
Read more documents here:
1920
https://cloud.google.com/asset-inventory/docs

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,10 @@ documentation:
1414
overview: |-
1515
# Cloud Asset API
1616
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.
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.
2021
2122
Read more documents here:
2223
https://cloud.google.com/asset-inventory/docs

0 commit comments

Comments
 (0)