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

@@ -42,17 +42,18 @@ type Account struct {
Scope *scopes.ScopeInfo `protobuf:"bytes,20,opt,name=scope,proto3" json:"scope,omitempty"`
// Optional name for identification purposes.
Name *wrappers.StringValue `protobuf:"bytes,30,opt,name=name,proto3" json:"name,omitempty"`
// Optional user-set descripton for identification purposes.
// Optional user-set description for identification purposes.
Description *wrappers.StringValue `protobuf:"bytes,40,opt,name=description,proto3" json:"description,omitempty"`
// Output only. The time this resource was created.
CreatedTime *timestamp.Timestamp `protobuf:"bytes,50,opt,name=created_time,proto3" json:"created_time,omitempty"`
// Output only. The time this resource was last updated.
UpdatedTime *timestamp.Timestamp `protobuf:"bytes,60,opt,name=updated_time,proto3" json:"updated_time,omitempty"`
// 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.
Version uint32 `protobuf:"varint,70,opt,name=version,proto3" json:"version,omitempty"`
// The type of this Account.
Type string `protobuf:"bytes,80,opt,name=type,proto3" json:"type,omitempty"`
// 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.
AuthMethodId string `protobuf:"bytes,90,opt,name=auth_method_id,proto3" json:"auth_method_id,omitempty"`
// The attributes that are applicable for the specific Account type.
Attributes *_struct.Struct `protobuf:"bytes,100,opt,name=attributes,proto3" json:"attributes,omitempty"`
@@ -50,7 +50,8 @@ type AuthMethod struct {
CreatedTime *timestamp.Timestamp `protobuf:"bytes,60,opt,name=created_time,proto3" json:"created_time,omitempty"`
// Output only. The time this resource was last updated.
UpdatedTime *timestamp.Timestamp `protobuf:"bytes,70,opt,name=updated_time,proto3" json:"updated_time,omitempty"`
// 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.
Version uint32 `protobuf:"varint,80,opt,name=version,proto3" json:"version,omitempty"`
// The Auth Method type.
Type string `protobuf:"bytes,90,opt,name=type,proto3" json:"type,omitempty"`
@@ -106,7 +106,8 @@ type Group struct {
CreatedTime *timestamp.Timestamp `protobuf:"bytes,60,opt,name=created_time,proto3" json:"created_time,omitempty"`
// Output only. The time this resource was last updated.
UpdatedTime *timestamp.Timestamp `protobuf:"bytes,70,opt,name=updated_time,proto3" json:"updated_time,omitempty"`
// 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.
Version uint32 `protobuf:"varint,80,opt,name=version,proto3" json:"version,omitempty"`
// Output only. Contains the list of member IDs in this Group.
MemberIds []string `protobuf:"bytes,90,rep,name=member_ids,proto3" json:"member_ids,omitempty"`
@@ -50,7 +50,8 @@ type HostCatalog struct {
CreatedTime *timestamp.Timestamp `protobuf:"bytes,60,opt,name=created_time,proto3" json:"created_time,omitempty"`
// Output only. The time this resource was last updated.
UpdatedTime *timestamp.Timestamp `protobuf:"bytes,70,opt,name=updated_time,proto3" json:"updated_time,omitempty"`
// 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.
Version uint32 `protobuf:"varint,80,opt,name=version,proto3" json:"version,omitempty"`
// The type of Host Catalog.
Type string `protobuf:"bytes,90,opt,name=type,proto3" json:"type,omitempty"`
@@ -38,7 +38,7 @@ type Host struct {
// Output only. The ID of the Host.
Id string `protobuf:"bytes,10,opt,name=id,proto3" json:"id,omitempty"`
// Output only. The Host Catalog of which this Host is a part.
// The Host Catalog of which this Host is a part.
HostCatalogId string `protobuf:"bytes,20,opt,name=host_catalog_id,proto3" json:"host_catalog_id,omitempty"`
// Output only. Scope information for this resource.
Scope *scopes.ScopeInfo `protobuf:"bytes,30,opt,name=scope,proto3" json:"scope,omitempty"`
@@ -50,7 +50,8 @@ type Host struct {
CreatedTime *timestamp.Timestamp `protobuf:"bytes,60,opt,name=created_time,proto3" json:"created_time,omitempty"`
// Output only. The time this resource was last updated.
UpdatedTime *timestamp.Timestamp `protobuf:"bytes,70,opt,name=updated_time,proto3" json:"updated_time,omitempty"`
// 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.
Version uint32 `protobuf:"varint,80,opt,name=version,proto3" json:"version,omitempty"`
// The type of the resource.
Type string `protobuf:"bytes,90,opt,name=type,proto3" json:"type,omitempty"`
@@ -37,9 +37,9 @@ type HostSet struct {
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// Output only. The ID of the host.
// Output only. The ID of the Host Set.
Id string `protobuf:"bytes,10,opt,name=id,proto3" json:"id,omitempty"`
// Output only. The Host Catalog of which this Host Set is a part.
// The Host Catalog of which this Host Set is a part.
HostCatalogId string `protobuf:"bytes,20,opt,name=host_catalog_id,proto3" json:"host_catalog_id,omitempty"`
// Output only. Scope information for this resource.
Scope *scopes.ScopeInfo `protobuf:"bytes,30,opt,name=scope,proto3" json:"scope,omitempty"`
@@ -51,7 +51,8 @@ type HostSet struct {
CreatedTime *timestamp.Timestamp `protobuf:"bytes,60,opt,name=created_time,proto3" json:"created_time,omitempty"`
// Output only. The time this resource was last updated.
UpdatedTime *timestamp.Timestamp `protobuf:"bytes,70,opt,name=updated_time,proto3" json:"updated_time,omitempty"`
// 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.
Version uint32 `protobuf:"varint,80,opt,name=version,proto3" json:"version,omitempty"`
// The type of the Host Set.
Type string `protobuf:"bytes,90,opt,name=type,proto3" json:"type,omitempty"`
@@ -233,7 +233,7 @@ type Role struct {
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// Output only. The ID of the Role
// Output only. The ID of the Role.
Id string `protobuf:"bytes,10,opt,name=id,proto3" json:"id,omitempty"`
// The ID of the Scope containing this Role.
ScopeId string `protobuf:"bytes,20,opt,name=scope_id,proto3" json:"scope_id,omitempty"`
@@ -247,7 +247,8 @@ type Role struct {
CreatedTime *timestamp.Timestamp `protobuf:"bytes,60,opt,name=created_time,proto3" json:"created_time,omitempty"`
// Output only. The time this resource was last updated.
UpdatedTime *timestamp.Timestamp `protobuf:"bytes,70,opt,name=updated_time,proto3" json:"updated_time,omitempty"`
// 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.
Version uint32 `protobuf:"varint,80,opt,name=version,proto3" json:"version,omitempty"`
// 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.
GrantScopeId *wrappers.StringValue `protobuf:"bytes,90,opt,name=grant_scope_id,proto3" json:"grant_scope_id,omitempty"`
@@ -132,7 +132,8 @@ type Scope struct {
CreatedTime *timestamp.Timestamp `protobuf:"bytes,60,opt,name=created_time,proto3" json:"created_time,omitempty"`
// Output only. The time this resource was last updated.
UpdatedTime *timestamp.Timestamp `protobuf:"bytes,70,opt,name=updated_time,proto3" json:"updated_time,omitempty"`
// 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.
Version uint32 `protobuf:"varint,80,opt,name=version,proto3" json:"version,omitempty"`
// The type of the resource.
Type string `protobuf:"bytes,90,opt,name=type,proto3" json:"type,omitempty"`
@@ -107,7 +107,8 @@ type Target struct {
CreatedTime *timestamp.Timestamp `protobuf:"bytes,60,opt,name=created_time,proto3" json:"created_time,omitempty"`
// Output only. The time this resource was last updated.
UpdatedTime *timestamp.Timestamp `protobuf:"bytes,70,opt,name=updated_time,proto3" json:"updated_time,omitempty"`
// 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.
Version uint32 `protobuf:"varint,80,opt,name=version,proto3" json:"version,omitempty"`
// The type of the Target.
Type string `protobuf:"bytes,90,opt,name=type,proto3" json:"type,omitempty"`
@@ -117,7 +118,7 @@ type Target struct {
HostSets []*HostSet `protobuf:"bytes,110,rep,name=host_sets,proto3" json:"host_sets,omitempty"`
// Maximum total lifetime of a created Session, in seconds.
SessionMaxSeconds *wrappers.UInt32Value `protobuf:"bytes,120,opt,name=session_max_seconds,proto3" json:"session_max_seconds,omitempty"`
// Maximum number of connections allowed in a Session.
// Maximum number of connections allowed in a Session. Unlimited is indicated by the value -1.
SessionConnectionLimit *wrappers.Int32Value `protobuf:"bytes,130,opt,name=session_connection_limit,proto3" json:"session_connection_limit,omitempty"`
// The attributes that are applicable for the specific Target.
Attributes *_struct.Struct `protobuf:"bytes,200,opt,name=attributes,proto3" json:"attributes,omitempty"`
@@ -106,7 +106,8 @@ type User struct {
CreatedTime *timestamp.Timestamp `protobuf:"bytes,60,opt,name=created_time,proto3" json:"created_time,omitempty"`
// Output only. The time this resource was last updated.
UpdatedTime *timestamp.Timestamp `protobuf:"bytes,70,opt,name=updated_time,proto3" json:"updated_time,omitempty"`
// 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.
Version uint32 `protobuf:"varint,80,opt,name=version,proto3" json:"version,omitempty"`
// Output only. Contains the list of Account IDs linked to this User.
AccountIds []string `protobuf:"bytes,90,rep,name=account_ids,proto3" json:"account_ids,omitempty"`