Correcting a bunch of incorrect documentation for the different API services and resources. (#494)

This commit is contained in:
Todd Knight authored and GitHub committed 2020-09-29 13:17:59 -07:00
1 parent 1c2dd7d0fc
commit 0eb35f49d5
61 files changed
+2030 -2366

No files matched your search

@@ -21,7 +21,7 @@ message Account {
// Optional name for identification purposes.
google.protobuf.StringValue name = 30 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"name" that: "name"}];
// Optional user-set descripton for identification purposes.
// Optional user-set description for identification purposes.
google.protobuf.StringValue description = 40 [(custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"description" that: "description"}];
// Output only. The time this resource was created.
@@ -30,13 +30,14 @@ message Account {
// Output only. The time this resource was last updated.
google.protobuf.Timestamp updated_time = 60 [json_name="updated_time"];
// Version can be used in subsequent write requests to ensure this resource has not changed and to fail the write if it has.
// Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
// The mutation will fail if the version does not match the latest known good version.
uint32 version = 70;
// The type of this Account.
string type = 80;
// Output only. The ID of the Auth Method that is associated with this Account.
// The ID of the Auth Method that is associated with this Account.
string auth_method_id = 90 [json_name="auth_method_id"];
// The attributes that are applicable for the specific Account type.
@@ -33,7 +33,8 @@ message AuthMethod {
// Output only. The time this resource was last updated.
google.protobuf.Timestamp updated_time = 70 [json_name="updated_time"];
// Version can be used in subsequent write requests to ensure this resource has not changed and to fail the write if it has.
// Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
// The mutation will fail if the version does not match the latest known good version.
uint32 version = 80;
// The Auth Method type.
@@ -40,7 +40,8 @@ message Group {
// Output only. The time this resource was last updated.
google.protobuf.Timestamp updated_time = 70 [json_name="updated_time"];
// Version can be used in subsequent write requests to ensure this resource has not changed and to fail the write if it has.
// Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
// The mutation will fail if the version does not match the latest known good version.
uint32 version = 80;
// Output only. Contains the list of member IDs in this Group.
@@ -33,7 +33,8 @@ message HostCatalog {
// Output only. The time this resource was last updated.
google.protobuf.Timestamp updated_time = 70 [json_name="updated_time"];
// Version can be used in subsequent write requests to ensure this resource has not changed and to fail the write if it has.
// Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
// The mutation will fail if the version does not match the latest known good version.
uint32 version = 80;
// The type of Host Catalog.
@@ -15,7 +15,7 @@ message Host {
// Output only. The ID of the Host.
string id = 10;
// Output only. The Host Catalog of which this Host is a part.
// The Host Catalog of which this Host is a part.
string host_catalog_id = 20 [json_name="host_catalog_id"];
// Output only. Scope information for this resource.
@@ -33,7 +33,8 @@ message Host {
// Output only. The time this resource was last updated.
google.protobuf.Timestamp updated_time = 70 [json_name="updated_time"];
// Version can be used in subsequent write requests to ensure this resource has not changed and to fail the write if it has.
// Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
// The mutation will fail if the version does not match the latest known good version.
uint32 version = 80;
// The type of the resource.
@@ -13,10 +13,10 @@ import "controller/custom_options/v1/options.proto";
// HostSet is a collection of Hosts created and managed by a Host Catalog
message HostSet {
// Output only. The ID of the host.
// Output only. The ID of the Host Set.
string id = 10;
// Output only. The Host Catalog of which this Host Set is a part.
// The Host Catalog of which this Host Set is a part.
string host_catalog_id = 20 [json_name="host_catalog_id"];
// Output only. Scope information for this resource.
@@ -34,7 +34,8 @@ message HostSet {
// Output only. The time this resource was last updated.
google.protobuf.Timestamp updated_time = 70 [json_name="updated_time"];
// Version can be used in subsequent write requests to ensure this resource has not changed and to fail the write if it has.
// Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
// The mutation will fail if the version does not match the latest known good version.
uint32 version = 80;
// The type of the Host Set.
@@ -44,7 +44,7 @@ message Grant {
// Role contains all fields related to a Role resource
message Role {
// Output only. The ID of the Role
// Output only. The ID of the Role.
string id = 10;
// The ID of the Scope containing this Role.
@@ -65,7 +65,8 @@ message Role {
// Output only. The time this resource was last updated.
google.protobuf.Timestamp updated_time = 70 [json_name="updated_time"];
// Version can be used in subsequent write requests to ensure this resource has not changed and to fail the write if it has.
// Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
// The mutation will fail if the version does not match the latest known good version.
uint32 version = 80;
// The Scope the grants will apply to. If the Role is at the global scope, this can be an org or project. If the Role is at an org scope, this can be a project within the org. It is invalid for this to be anything other than the Role's scope when the Role's scope is a project.
@@ -48,7 +48,8 @@ message Scope {
// Output only. The time this resource was last updated.
google.protobuf.Timestamp updated_time = 70 [json_name="updated_time"];
// Version can be used in subsequent write requests to ensure this resource has not changed and to fail the write if it has.
// Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
// The mutation will fail if the version does not match the latest known good version.
uint32 version = 80;
// The type of the resource.
@@ -41,7 +41,8 @@ message Target {
// Output only. The time this resource was last updated.
google.protobuf.Timestamp updated_time = 70 [json_name="updated_time"];
// Version can be used in subsequent write requests to ensure this resource has not changed and to fail the write if it has.
// Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
// The mutation will fail if the version does not match the latest known good version.
uint32 version = 80;
// The type of the Target.
@@ -56,7 +57,7 @@ message Target {
// Maximum total lifetime of a created Session, in seconds.
google.protobuf.UInt32Value session_max_seconds = 120 [json_name="session_max_seconds", (custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"session_max_seconds" that: "SessionMaxSeconds"}];
// Maximum number of connections allowed in a Session.
// Maximum number of connections allowed in a Session. Unlimited is indicated by the value -1.
google.protobuf.Int32Value session_connection_limit = 130 [json_name="session_connection_limit", (custom_options.v1.generate_sdk_option) = true, (custom_options.v1.mask_mapping) = {this:"session_connection_limit" that: "SessionConnectionLimit"}];
// The attributes that are applicable for the specific Target.
@@ -40,7 +40,8 @@ message User {
// Output only. The time this resource was last updated.
google.protobuf.Timestamp updated_time = 70 [json_name="updated_time"];
// Version can be used in subsequent write requests to ensure this resource has not changed and to fail the write if it has.
// Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.
// The mutation will fail if the version does not match the latest known good version.
uint32 version = 80;
// Output only. Contains the list of Account IDs linked to this User.