diff --git a/doc/index.html b/doc/index.html index 56bf2538..423ce078 100644 --- a/doc/index.html +++ b/doc/index.html @@ -3445,7 +3445,7 @@

Visibility

VISIBILITY_SELF 2 -

VISIBILITY_SELF enable call this endpoint from the authenticated user only

+

VISIBILITY_SELF restricts calls to the authenticated user only

@@ -3473,7 +3473,7 @@

File-level Extensions

AdminRole .google.protobuf.MethodOptions 51002 -

AdminRoles are used to define which admin role a logged in user must provide to call this method

+

AdminRoles are used to define the admin role a logged in user must provide to call this method

@@ -3489,7 +3489,7 @@

File-level Extensions

InfraRole .google.protobuf.MethodOptions 51005 -

InfraRoles are used to define which infra role a microservice must provide to call this method

+

InfraRoles are used to define the infra role a microservice must provide to call this method

@@ -3505,7 +3505,7 @@

File-level Extensions

ProjectRole .google.protobuf.MethodOptions 51001 -

ProjectRoles are used to define which project role a logged in user must provide to call this method

+

ProjectRoles are used to define the project role a logged in user must provide to call this method

@@ -3513,7 +3513,7 @@

File-level Extensions

TenantRole .google.protobuf.MethodOptions 51000 -

TenantRoles are used to define which tenant role a logged in user must provide to call this method

+

TenantRoles are used to define the tenant role a logged in user must provide to call this method

@@ -3694,7 +3694,7 @@

AuditServiceGetResponse

AuditServiceListRequest

-

AuditServiceListRequest is the request payload for a audit list request

+

AuditServiceListRequest is the request payload for an audit list request

@@ -4387,7 +4387,7 @@

TokenServiceCreateRequesttenant_roles

- + @@ -4539,7 +4539,7 @@

TokenServiceCreateResponse

- + @@ -4673,7 +4673,7 @@

TokenServiceRefreshRespon

- + @@ -5555,14 +5555,14 @@

DiskPartition

- + - + @@ -5628,7 +5628,7 @@

Filesystem

- + @@ -6767,7 +6767,7 @@

ImageQuery

ImageServiceGetRequest

-

ImageServiceGetRequest is the request payload for a image get request

+

ImageServiceGetRequest is the request payload for an image get request

TokenServiceCreateRequest.TenantRolesEntry repeated

TenantRoles_associates a tenant id with the corresponding role of the token owner

TenantRoles associates a tenant id with the corresponding role of the token owner

secret string

Secret is the body if the jwt token, should be used in api requests as bearer token

Secret is the body of the JWT token, should be used in API requests as bearer token

secret string

Secret is the body if the jwt token, should be used in api requests as bearer token

Secret is the body of the JWT token, should be used in API requests as bearer token

label string optional

optional label for this this partition

Label an optional label for this partition

size uint64

Size size in mebibytes (MiB) of this partition"

Size in mebibytes (MiB) of this partition

label string optional

Label optional label for this this filesystem

Label an optional label for this filesystem

@@ -6791,7 +6791,7 @@

ImageServiceGetRequest

ImageServiceGetResponse

-

ImageServiceGetResponse is the response payload for a image get request

+

ImageServiceGetResponse is the response payload for an image get request

@@ -6815,7 +6815,7 @@

ImageServiceGetResponse

ImageServiceLatestRequest

-

ImageServiceLatestRequest is the request payload for a image latest request

+

ImageServiceLatestRequest is the request payload for an image latest request

@@ -6847,7 +6847,7 @@

ImageServiceLatestRequestImageServiceLatestResponse

-

ImageServiceLatestResponse is the response payload for a image latest request

+

ImageServiceLatestResponse is the response payload for an image latest request

@@ -6871,7 +6871,7 @@

ImageServiceLatestResponse

ImageServiceListRequest

-

ImageServiceListRequest is the request payload for a image list request

+

ImageServiceListRequest is the request payload for an image list request

@@ -6895,7 +6895,7 @@

ImageServiceListRequest

ImageServiceListResponse

-

ImageServiceListResponse is the response payload for a image list request

+

ImageServiceListResponse is the response payload for an image list request

@@ -7219,7 +7219,7 @@

ImageServiceUpdateRequest

- + @@ -7356,7 +7356,7 @@

metalstack/api/v2/ip.proto

IP -

IP is a ip address which can be used as loadbalancer addresses

+

IP is an IP address which can be used as loadbalancer addresses

expires_at google.protobuf.Timestamp

ExpiresAt usage is not possible after this date

ExpiresAt indicates that usage is not possible after this date

@@ -7457,7 +7457,7 @@

IPQuery

- + @@ -7478,14 +7478,14 @@

IPQuery

- + - + @@ -7499,7 +7499,7 @@

IPQuery

- + @@ -7513,7 +7513,7 @@

IPQuery

- + @@ -7531,7 +7531,7 @@

IPQuery

IPServiceCreateRequest

-

IPServiceCreateRequest is the request payload for a ip create request

+

IPServiceCreateRequest is the request payload for an IP create request

network string optional

Network from where the ips to list

Network from which the IPs are to list

uuid string optional

Uuid for which this ips should get filtered

UUID for which these IPs should be filtered

machine string optional

Machine for which this ips should get filtered

Machine for which these IPs should be filtered

labels Labels optional

Labels for which this ips should get filtered

Labels for which these IPs should be filtered

address_family IPAddressFamily optional

Addressfamily of the IPs to list, defaults to all addressfamilies

Address family of the IPs to list, defaults to all address families

@@ -7611,7 +7611,7 @@

IPServiceCreateRequest

IPServiceCreateResponse

-

IPServiceCreateResponse is the response payload for a ip create request

+

IPServiceCreateResponse is the response payload for an IP create request

@@ -7666,7 +7666,7 @@

IPServiceDeleteRequest

IPServiceDeleteResponse

-

IPServiceDeleteResponse is the response payload for a ip delete request

+

IPServiceDeleteResponse is the response payload for an IP delete request

@@ -7690,7 +7690,7 @@

IPServiceDeleteResponse

IPServiceGetRequest

-

IPServiceGetRequest is the request payload for a ip get request

+

IPServiceGetRequest is the request payload for an IP get request

@@ -7728,7 +7728,7 @@

IPServiceGetRequest

IPServiceGetResponse

-

IPServiceGetResponse is the response payload for a ip get request

+

IPServiceGetResponse is the response payload for an IP get request

@@ -7752,7 +7752,7 @@

IPServiceGetResponse

IPServiceListRequest

-

IPServiceListRequest is the request payload for a ip list request

+

IPServiceListRequest is the request payload for an IP list request

@@ -7772,7 +7772,7 @@

IPServiceListRequest

- + @@ -7783,7 +7783,7 @@

IPServiceListRequest

IPServiceListResponse

-

IPServiceListResponse is the response payload for a ip list request

+

IPServiceListResponse is the response payload for an IP list request

query IPQuery

Query to list one ore more ips

Query to list one or more IPs

@@ -7807,7 +7807,7 @@

IPServiceListResponse

IPServiceUpdateRequest

-

IPServiceUpdateRequest is the request payload for a ip update request

+

IPServiceUpdateRequest is the request payload for an IP update request

@@ -7928,7 +7928,7 @@

IPAddressFamily

IPType

-

IPType specifies different ip address types

+

IPType specifies different IP address types

@@ -7944,7 +7944,7 @@

IPType

- + @@ -8205,7 +8205,7 @@

Network

- + @@ -8254,7 +8254,7 @@

Network

- + @@ -8838,7 +8838,7 @@

NetworkUsage

- + @@ -9206,7 +9206,7 @@

PartitionBootConfiguration

- + @@ -10324,7 +10324,7 @@

MachineBMCReport

- + @@ -10390,7 +10390,7 @@

MachineBios

- + @@ -10864,14 +10864,14 @@

MachineIssuesQuery

- + - + @@ -11238,7 +11238,7 @@

MachinePowerSupply

MachineProvisioningEvent

-

MachineProvisioningEvent is a event which has occurred during provisioning

+

MachineProvisioningEvent is an event that has occurred during provisioning

NameNumberDescription
IP_TYPE_EPHEMERAL 1

IP_TYPE_EPHEMERAL defines a ephemeral ip address which is freed/deleted after usage

IP_TYPE_EPHEMERAL defines an ephemeral IP address which is freed/deleted after usage

default_child_prefix_length ChildPrefixLength

Default Child Prefix length defines the bitlength of a child network created per addressfamily, of not specified during the allocate request

Default Child Prefix length defines the bit length of a child network created per address family, if not specified during the allocate request

consumption NetworkConsumption

Consumption of ips and prefixes in this networks

Consumption of IPs and prefixes in this network

available_prefixes uint64

the total available 2 bit Prefixes

the total available 2-bit prefixes

commandline string

Commandline the cmdline to the kernel for the boot image

Commandline the kernel command line for the boot image

fru MachineFRU

Fru containers field replaceable unit details

Fru contains field replaceable unit details

date string

Date the bios date as string because every vendor has different ideas howto describe the date

Date the bios date as string because every vendor has different ideas how to describe the date

only MachineIssueType repeated

Only a list of machine issue types to include

Only includes the specified machine issue types

omit MachineIssueType repeated

Omit a list of machine issues to omit

Omits the specified machine issues

@@ -13001,7 +13001,7 @@

MachineServiceListBMCR

- + @@ -13080,7 +13080,7 @@

MachineServiceListRequest

- + @@ -14044,7 +14044,7 @@

PartitionServiceDelet

- + @@ -14338,14 +14338,14 @@

ProjectInvite

- + - + @@ -14370,7 +14370,7 @@

ProjectInvite

ProjectMember

-

ProjectMember defines a user that participates at a project

+

ProjectMember defines a user that participates in a project

query metalstack.api.v2.MachineBMCQuery

Query to list one ore more bmcs of many machines

Query to list one or more BMCs of many machines

query metalstack.api.v2.MachineQuery

Query to list one ore more machines

Query to list one or more machines

id string

ID of the partition to get

ID of the partition to delete

tenant string

Tenant is the login of tenant who invites to join this project

Tenant is the login of the tenant inviting another user to join this project

tenant_name string

TenantName is the name of tenant who invites to join this project

TenantName is the name of the tenant inviting another user to join this project

@@ -14693,7 +14693,7 @@

ProjectServiceInvi

- + @@ -15216,14 +15216,14 @@

ProjectService

- + - + @@ -15237,7 +15237,7 @@

ProjectService

- + @@ -15581,7 +15581,7 @@

metalstack/api/v2/size_ima

ImageConstraint

-

ImageConstraint defines a constraint for a image

examples:

images:

ubuntu: ">= 20.04.20211011"

debian: ">= 10.0.20210101"

+

ImageConstraint defines a constraint for an image

examples:

images:

ubuntu: ">= 20.04.20211011"

debian: ">= 10.0.20210101"

project_name string

ProjectName if the project joined

ProjectName of the project joined

RemoveMember ProjectServiceRemoveMemberRequest ProjectServiceRemoveMemberResponse

RemoveMember remove a user from a project

RemoveMember removes a user from a project

UpdateMember ProjectServiceUpdateMemberRequest ProjectServiceUpdateMemberResponse

UpdateMember update a user for a project

UpdateMember updates a user for a project

InviteAccept ProjectServiceInviteAcceptRequest ProjectServiceInviteAcceptResponse

InviteAccept is called from a user to accept a invitation

InviteAccept is called by a user to accept an invitation

@@ -17699,7 +17699,7 @@

SwitchServiceMigrateRe

- + @@ -18523,14 +18523,14 @@

TenantInvite

- + - + @@ -18555,7 +18555,7 @@

TenantInvite

TenantMember

-

TenantMember defines a user that participates at a tenant

+

TenantMember defines a user that participates in a tenant

switch metalstack.api.v2.Switch

Switch contains the switch was migrated to

Switch contains the switch that was migrated to

tenant string

Tenant is the login of tenant who invites to join this tenant

Tenant is the login of the tenant inviting another user to join this tenant

tenant_name string

TenantName is the name of tenant who invites to join this tenant

TenantName is the name of the tenant inviting another user to join this tenant

@@ -18582,7 +18582,7 @@

TenantMember

- + @@ -19066,7 +19066,7 @@

TenantServiceInvites

- + @@ -19398,14 +19398,14 @@

TenantService

- + - + @@ -19715,7 +19715,7 @@

TenantService

- + @@ -20767,7 +20767,7 @@

User

- + @@ -20901,7 +20901,7 @@

UpdateBMCInfoRequest

- + @@ -21291,7 +21291,7 @@

BootServiceRegisterReque

- + diff --git a/go/metalstack/admin/v2/adminv2connect/tenant.connect.go b/go/metalstack/admin/v2/adminv2connect/tenant.connect.go index 3f48b270..fc984eaa 100644 --- a/go/metalstack/admin/v2/adminv2connect/tenant.connect.go +++ b/go/metalstack/admin/v2/adminv2connect/tenant.connect.go @@ -52,7 +52,7 @@ type TenantServiceClient interface { List(context.Context, *v2.TenantServiceListRequest) (*v2.TenantServiceListResponse, error) // Add a member to a tenant AddMember(context.Context, *v2.TenantServiceAddMemberRequest) (*v2.TenantServiceAddMemberResponse, error) - // RemoveMember remove a member of a tenant + // RemoveMember removes a member from a tenant RemoveMember(context.Context, *v2.TenantServiceRemoveMemberRequest) (*v2.TenantServiceRemoveMemberResponse, error) } @@ -146,7 +146,7 @@ type TenantServiceHandler interface { List(context.Context, *v2.TenantServiceListRequest) (*v2.TenantServiceListResponse, error) // Add a member to a tenant AddMember(context.Context, *v2.TenantServiceAddMemberRequest) (*v2.TenantServiceAddMemberResponse, error) - // RemoveMember remove a member of a tenant + // RemoveMember removes a member from a tenant RemoveMember(context.Context, *v2.TenantServiceRemoveMemberRequest) (*v2.TenantServiceRemoveMemberResponse, error) } diff --git a/go/metalstack/admin/v2/filesystem.pb.go b/go/metalstack/admin/v2/filesystem.pb.go index 76384149..d64aab44 100644 --- a/go/metalstack/admin/v2/filesystem.pb.go +++ b/go/metalstack/admin/v2/filesystem.pb.go @@ -383,8 +383,8 @@ func (x *FilesystemServiceDeleteResponse) GetFilesystemLayout() *v2.FilesystemLa // FilesystemServiceMatchRequest type FilesystemServiceMatchRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Match either size and image to a filesystemlayout - // or if a machine matches to a filesystemlayout + // Match size and image to a filesystem layout + // or match a machine to a filesystem layout // // Types that are valid to be assigned to Match: // diff --git a/go/metalstack/admin/v2/image.pb.go b/go/metalstack/admin/v2/image.pb.go index 09c685b3..c0ca608c 100644 --- a/go/metalstack/admin/v2/image.pb.go +++ b/go/metalstack/admin/v2/image.pb.go @@ -133,7 +133,7 @@ type ImageServiceUpdateRequest struct { Features []v2.ImageFeature `protobuf:"varint,6,rep,packed,name=features,proto3,enum=metalstack.api.v2.ImageFeature" json:"features,omitempty"` // Classification of this image Classification v2.ImageClassification `protobuf:"varint,7,opt,name=classification,proto3,enum=metalstack.api.v2.ImageClassification" json:"classification,omitempty"` - // ExpiresAt usage is not possible after this date + // ExpiresAt indicates that usage is not possible after this date ExpiresAt *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/admin/v2/machine.pb.go b/go/metalstack/admin/v2/machine.pb.go index 9e42afd3..440f7c31 100644 --- a/go/metalstack/admin/v2/machine.pb.go +++ b/go/metalstack/admin/v2/machine.pb.go @@ -118,7 +118,7 @@ func (x *MachineServiceGetResponse) GetMachine() *v2.Machine { // MachineServiceListRequest is the request payload for a machine list request type MachineServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Query to list one ore more machines + // Query to list one or more machines Query *v2.MachineQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"` // Partition for which machines should be listed, could be left empty if only one partition is present // otherwise an error is thrown that the partition must be specified @@ -505,7 +505,7 @@ func (x *MachineServiceGetBMCResponse) GetBmc() *v2.MachineBMCReport { // MachineServiceListBMCRequest is the request payload for a machine listbmc request type MachineServiceListBMCRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Query to list one ore more bmcs of many machines + // Query to list one or more BMCs of many machines Query *v2.MachineBMCQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/admin/v2/partition.pb.go b/go/metalstack/admin/v2/partition.pb.go index 0fdb1b37..eec90fd4 100644 --- a/go/metalstack/admin/v2/partition.pb.go +++ b/go/metalstack/admin/v2/partition.pb.go @@ -182,7 +182,7 @@ func (x *PartitionServiceUpdateRequest) GetLabels() *v2.UpdateLabels { // PartitionServiceDeleteRequest is the request payload for a partition delete request type PartitionServiceDeleteRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // ID of the partition to get + // ID of the partition to delete Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/admin/v2/switch.pb.go b/go/metalstack/admin/v2/switch.pb.go index 6b58abcc..b1f7576d 100644 --- a/go/metalstack/admin/v2/switch.pb.go +++ b/go/metalstack/admin/v2/switch.pb.go @@ -541,7 +541,7 @@ func (x *SwitchServiceMigrateRequest) GetNewSwitch() string { // SwitchServiceMigrateResponse is the response payload for migrating a switch. type SwitchServiceMigrateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Switch contains the switch was migrated to + // Switch contains the switch that was migrated to Switch *v2.Switch `protobuf:"bytes,1,opt,name=switch,proto3" json:"switch,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/api/v2/apiv2connect/project.connect.go b/go/metalstack/api/v2/apiv2connect/project.connect.go index 5ef541aa..2f18f2f2 100644 --- a/go/metalstack/api/v2/apiv2connect/project.connect.go +++ b/go/metalstack/api/v2/apiv2connect/project.connect.go @@ -81,13 +81,13 @@ type ProjectServiceClient interface { Update(context.Context, *v2.ProjectServiceUpdateRequest) (*v2.ProjectServiceUpdateResponse, error) // Leave project Leave(context.Context, *v2.ProjectServiceLeaveRequest) (*v2.ProjectServiceLeaveResponse, error) - // RemoveMember remove a user from a project + // RemoveMember removes a user from a project RemoveMember(context.Context, *v2.ProjectServiceRemoveMemberRequest) (*v2.ProjectServiceRemoveMemberResponse, error) - // UpdateMember update a user for a project + // UpdateMember updates a user for a project UpdateMember(context.Context, *v2.ProjectServiceUpdateMemberRequest) (*v2.ProjectServiceUpdateMemberResponse, error) // Invite a user to a project Invite(context.Context, *v2.ProjectServiceInviteRequest) (*v2.ProjectServiceInviteResponse, error) - // InviteAccept is called from a user to accept a invitation + // InviteAccept is called by a user to accept an invitation InviteAccept(context.Context, *v2.ProjectServiceInviteAcceptRequest) (*v2.ProjectServiceInviteAcceptResponse, error) // InviteDelete deletes a pending invitation InviteDelete(context.Context, *v2.ProjectServiceInviteDeleteRequest) (*v2.ProjectServiceInviteDeleteResponse, error) @@ -337,13 +337,13 @@ type ProjectServiceHandler interface { Update(context.Context, *v2.ProjectServiceUpdateRequest) (*v2.ProjectServiceUpdateResponse, error) // Leave project Leave(context.Context, *v2.ProjectServiceLeaveRequest) (*v2.ProjectServiceLeaveResponse, error) - // RemoveMember remove a user from a project + // RemoveMember removes a user from a project RemoveMember(context.Context, *v2.ProjectServiceRemoveMemberRequest) (*v2.ProjectServiceRemoveMemberResponse, error) - // UpdateMember update a user for a project + // UpdateMember updates a user for a project UpdateMember(context.Context, *v2.ProjectServiceUpdateMemberRequest) (*v2.ProjectServiceUpdateMemberResponse, error) // Invite a user to a project Invite(context.Context, *v2.ProjectServiceInviteRequest) (*v2.ProjectServiceInviteResponse, error) - // InviteAccept is called from a user to accept a invitation + // InviteAccept is called by a user to accept an invitation InviteAccept(context.Context, *v2.ProjectServiceInviteAcceptRequest) (*v2.ProjectServiceInviteAcceptResponse, error) // InviteDelete deletes a pending invitation InviteDelete(context.Context, *v2.ProjectServiceInviteDeleteRequest) (*v2.ProjectServiceInviteDeleteResponse, error) diff --git a/go/metalstack/api/v2/apiv2connect/tenant.connect.go b/go/metalstack/api/v2/apiv2connect/tenant.connect.go index 6721559b..4291fc44 100644 --- a/go/metalstack/api/v2/apiv2connect/tenant.connect.go +++ b/go/metalstack/api/v2/apiv2connect/tenant.connect.go @@ -78,9 +78,9 @@ type TenantServiceClient interface { Update(context.Context, *v2.TenantServiceUpdateRequest) (*v2.TenantServiceUpdateResponse, error) // Delete a tenant Delete(context.Context, *v2.TenantServiceDeleteRequest) (*v2.TenantServiceDeleteResponse, error) - // Leave remove a member of a tenant + // Leave removes a member from a tenant Leave(context.Context, *v2.TenantServiceLeaveRequest) (*v2.TenantServiceLeaveResponse, error) - // RemoveMember remove a member of a tenant + // RemoveMember removes a member from a tenant RemoveMember(context.Context, *v2.TenantServiceRemoveMemberRequest) (*v2.TenantServiceRemoveMemberResponse, error) // UpdateMember update a member of a tenant UpdateMember(context.Context, *v2.TenantServiceUpdateMemberRequest) (*v2.TenantServiceUpdateMemberResponse, error) @@ -334,9 +334,9 @@ type TenantServiceHandler interface { Update(context.Context, *v2.TenantServiceUpdateRequest) (*v2.TenantServiceUpdateResponse, error) // Delete a tenant Delete(context.Context, *v2.TenantServiceDeleteRequest) (*v2.TenantServiceDeleteResponse, error) - // Leave remove a member of a tenant + // Leave removes a member from a tenant Leave(context.Context, *v2.TenantServiceLeaveRequest) (*v2.TenantServiceLeaveResponse, error) - // RemoveMember remove a member of a tenant + // RemoveMember removes a member from a tenant RemoveMember(context.Context, *v2.TenantServiceRemoveMemberRequest) (*v2.TenantServiceRemoveMemberResponse, error) // UpdateMember update a member of a tenant UpdateMember(context.Context, *v2.TenantServiceUpdateMemberRequest) (*v2.TenantServiceUpdateMemberResponse, error) diff --git a/go/metalstack/api/v2/audit.pb.go b/go/metalstack/api/v2/audit.pb.go index 367b22e0..25c5a1b5 100644 --- a/go/metalstack/api/v2/audit.pb.go +++ b/go/metalstack/api/v2/audit.pb.go @@ -348,7 +348,7 @@ func (x *AuditQuery) GetPhase() AuditPhase { return AuditPhase_AUDIT_PHASE_UNSPECIFIED } -// AuditServiceListRequest is the request payload for a audit list request +// AuditServiceListRequest is the request payload for an audit list request type AuditServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Login for this tenant diff --git a/go/metalstack/api/v2/common.pb.go b/go/metalstack/api/v2/common.pb.go index 9d6c4f9f..86a07ff6 100644 --- a/go/metalstack/api/v2/common.pb.go +++ b/go/metalstack/api/v2/common.pb.go @@ -311,7 +311,7 @@ const ( Visibility_VISIBILITY_UNSPECIFIED Visibility = 0 // VISIBILITY_PUBLIC specifies that this service is accessible without authentication Visibility_VISIBILITY_PUBLIC Visibility = 1 - // VISIBILITY_SELF enable call this endpoint from the authenticated user only + // VISIBILITY_SELF restricts calls to the authenticated user only Visibility_VISIBILITY_SELF Visibility = 2 ) @@ -919,15 +919,15 @@ var file_metalstack_api_v2_common_proto_extTypes = []protoimpl.ExtensionInfo{ // Extension fields to descriptorpb.MethodOptions. var ( - // TenantRoles are used to define which tenant role a logged in user must provide to call this method + // TenantRoles are used to define the tenant role a logged in user must provide to call this method // // repeated metalstack.api.v2.TenantRole tenant_roles = 51000; E_TenantRoles = &file_metalstack_api_v2_common_proto_extTypes[0] - // ProjectRoles are used to define which project role a logged in user must provide to call this method + // ProjectRoles are used to define the project role a logged in user must provide to call this method // // repeated metalstack.api.v2.ProjectRole project_roles = 51001; E_ProjectRoles = &file_metalstack_api_v2_common_proto_extTypes[1] - // AdminRoles are used to define which admin role a logged in user must provide to call this method + // AdminRoles are used to define the admin role a logged in user must provide to call this method // // repeated metalstack.api.v2.AdminRole admin_roles = 51002; E_AdminRoles = &file_metalstack_api_v2_common_proto_extTypes[2] @@ -939,7 +939,7 @@ var ( // // optional metalstack.api.v2.Auditing auditing = 51004; E_Auditing = &file_metalstack_api_v2_common_proto_extTypes[4] - // InfraRoles are used to define which infra role a microservice must provide to call this method + // InfraRoles are used to define the infra role a microservice must provide to call this method // // repeated metalstack.api.v2.InfraRole infra_roles = 51005; E_InfraRoles = &file_metalstack_api_v2_common_proto_extTypes[5] diff --git a/go/metalstack/api/v2/filesystem.pb.go b/go/metalstack/api/v2/filesystem.pb.go index 1ab5e186..296c13de 100644 --- a/go/metalstack/api/v2/filesystem.pb.go +++ b/go/metalstack/api/v2/filesystem.pb.go @@ -646,7 +646,7 @@ type Filesystem struct { Description *string `protobuf:"bytes,4,opt,name=description,proto3,oneof" json:"description,omitempty"` // Path the mountpoint where this filesystem should be mounted on Path *string `protobuf:"bytes,5,opt,name=path,proto3,oneof" json:"path,omitempty"` - // Label optional label for this this filesystem + // Label an optional label for this filesystem Label *string `protobuf:"bytes,6,opt,name=label,proto3,oneof" json:"label,omitempty"` // MountOptions the options to use to mount this filesystem MountOptions []string `protobuf:"bytes,7,rep,name=mount_options,json=mountOptions,proto3" json:"mount_options,omitempty"` @@ -884,9 +884,9 @@ type DiskPartition struct { state protoimpl.MessageState `protogen:"open.v1"` // Number partition number, will be appended to partitionprefix to create the final devicename Number uint32 `protobuf:"varint,1,opt,name=number,proto3" json:"number,omitempty"` - // optional label for this this partition + // Label an optional label for this partition Label *string `protobuf:"bytes,2,opt,name=label,proto3,oneof" json:"label,omitempty"` - // Size size in mebibytes (MiB) of this partition" + // Size in mebibytes (MiB) of this partition Size uint64 `protobuf:"varint,3,opt,name=size,proto3" json:"size,omitempty"` // GPTType the gpt partition table type of this partition GptType *GPTType `protobuf:"varint,4,opt,name=gpt_type,json=gptType,proto3,enum=metalstack.api.v2.GPTType,oneof" json:"gpt_type,omitempty"` diff --git a/go/metalstack/api/v2/image.pb.go b/go/metalstack/api/v2/image.pb.go index 878b13e4..e939d0b8 100644 --- a/go/metalstack/api/v2/image.pb.go +++ b/go/metalstack/api/v2/image.pb.go @@ -133,7 +133,7 @@ func (ImageClassification) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_image_proto_rawDescGZIP(), []int{1} } -// ImageServiceGetRequest is the request payload for a image get request +// ImageServiceGetRequest is the request payload for an image get request type ImageServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // ID of the image to get @@ -179,7 +179,7 @@ func (x *ImageServiceGetRequest) GetId() string { return "" } -// ImageServiceListRequest is the request payload for a image list request +// ImageServiceListRequest is the request payload for an image list request type ImageServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Query for images @@ -225,7 +225,7 @@ func (x *ImageServiceListRequest) GetQuery() *ImageQuery { return nil } -// ImageServiceLatestRequest is the request payload for a image latest request +// ImageServiceLatestRequest is the request payload for an image latest request type ImageServiceLatestRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // OS for which the latest image should be fetched @@ -281,7 +281,7 @@ func (x *ImageServiceLatestRequest) GetClassification() ImageClassification { return ImageClassification_IMAGE_CLASSIFICATION_UNSPECIFIED } -// ImageServiceGetResponse is the response payload for a image get request +// ImageServiceGetResponse is the response payload for an image get request type ImageServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Image the image @@ -327,7 +327,7 @@ func (x *ImageServiceGetResponse) GetImage() *Image { return nil } -// ImageServiceListResponse is the response payload for a image list request +// ImageServiceListResponse is the response payload for an image list request type ImageServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Images the images @@ -373,7 +373,7 @@ func (x *ImageServiceListResponse) GetImages() []*Image { return nil } -// ImageServiceLatestResponse is the response payload for a image latest request +// ImageServiceLatestResponse is the response payload for an image latest request type ImageServiceLatestResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Image which is the latest for one os diff --git a/go/metalstack/api/v2/ip.pb.go b/go/metalstack/api/v2/ip.pb.go index fbbb6eb4..aea26d36 100644 --- a/go/metalstack/api/v2/ip.pb.go +++ b/go/metalstack/api/v2/ip.pb.go @@ -22,13 +22,13 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) -// IPType specifies different ip address types +// IPType specifies different IP address types type IPType int32 const ( // IP_TYPE_UNSPECIFIED is not specified IPType_IP_TYPE_UNSPECIFIED IPType = 0 - // IP_TYPE_EPHEMERAL defines a ephemeral ip address which is freed/deleted after usage + // IP_TYPE_EPHEMERAL defines an ephemeral IP address which is freed/deleted after usage IPType_IP_TYPE_EPHEMERAL IPType = 1 // IP_TYPE_STATIC defines a static ip address which must be freed/deleted explicitly IPType_IP_TYPE_STATIC IPType = 2 @@ -128,7 +128,7 @@ func (IPAddressFamily) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_ip_proto_rawDescGZIP(), []int{1} } -// IP is a ip address which can be used as loadbalancer addresses +// IP is an IP address which can be used as loadbalancer addresses type IP struct { state protoimpl.MessageState `protogen:"open.v1"` // Uuid of this ip @@ -247,7 +247,7 @@ func (x *IP) GetNamespace() string { return "" } -// IPServiceGetRequest is the request payload for a ip get request +// IPServiceGetRequest is the request payload for an IP get request type IPServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // IP of the ip to get @@ -311,7 +311,7 @@ func (x *IPServiceGetRequest) GetNamespace() string { return "" } -// IPServiceCreateRequest is the request payload for a ip create request +// IPServiceCreateRequest is the request payload for an IP create request type IPServiceCreateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Network from which the IP should be created @@ -429,7 +429,7 @@ func (x *IPServiceCreateRequest) GetAddressFamily() IPAddressFamily { return IPAddressFamily_IP_ADDRESS_FAMILY_UNSPECIFIED } -// IPServiceUpdateRequest is the request payload for a ip update request +// IPServiceUpdateRequest is the request payload for an IP update request type IPServiceUpdateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Ip the ip address to update @@ -529,12 +529,12 @@ func (x *IPServiceUpdateRequest) GetLabels() *UpdateLabels { return nil } -// IPServiceListRequest is the request payload for a ip list request +// IPServiceListRequest is the request payload for an IP list request type IPServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Project of the ips to list Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` - // Query to list one ore more ips + // Query to list one or more IPs Query *IPQuery `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -589,23 +589,23 @@ type IPQuery struct { state protoimpl.MessageState `protogen:"open.v1"` // Ip the ip to list Ip *string `protobuf:"bytes,1,opt,name=ip,proto3,oneof" json:"ip,omitempty"` - // Network from where the ips to list + // Network from which the IPs are to list Network *string `protobuf:"bytes,2,opt,name=network,proto3,oneof" json:"network,omitempty"` // Project of the ips to list Project *string `protobuf:"bytes,3,opt,name=project,proto3,oneof" json:"project,omitempty"` // Name of this ip Name *string `protobuf:"bytes,4,opt,name=name,proto3,oneof" json:"name,omitempty"` - // Uuid for which this ips should get filtered + // UUID for which these IPs should be filtered Uuid *string `protobuf:"bytes,5,opt,name=uuid,proto3,oneof" json:"uuid,omitempty"` - // Machine for which this ips should get filtered + // Machine for which these IPs should be filtered Machine *string `protobuf:"bytes,6,opt,name=machine,proto3,oneof" json:"machine,omitempty"` // ParentPrefixCidr for which this ips should get filtered ParentPrefixCidr *string `protobuf:"bytes,7,opt,name=parent_prefix_cidr,json=parentPrefixCidr,proto3,oneof" json:"parent_prefix_cidr,omitempty"` - // Labels for which this ips should get filtered + // Labels for which these IPs should be filtered Labels *Labels `protobuf:"bytes,8,opt,name=labels,proto3,oneof" json:"labels,omitempty"` // Static if set to true, this will be a Static ip Type *IPType `protobuf:"varint,9,opt,name=type,proto3,enum=metalstack.api.v2.IPType,oneof" json:"type,omitempty"` - // Addressfamily of the IPs to list, defaults to all addressfamilies + // Address family of the IPs to list, defaults to all address families AddressFamily *IPAddressFamily `protobuf:"varint,10,opt,name=address_family,json=addressFamily,proto3,enum=metalstack.api.v2.IPAddressFamily,oneof" json:"address_family,omitempty"` // Namespace can be specified to get the ip of a namespace. Namespace *string `protobuf:"bytes,11,opt,name=namespace,proto3,oneof" json:"namespace,omitempty"` @@ -775,7 +775,7 @@ func (x *IPServiceDeleteRequest) GetProject() string { return "" } -// IPServiceGetResponse is the response payload for a ip get request +// IPServiceGetResponse is the response payload for an IP get request type IPServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Ip the ip @@ -867,7 +867,7 @@ func (x *IPServiceUpdateResponse) GetIp() *IP { return nil } -// IPServiceCreateResponse is the response payload for a ip create request +// IPServiceCreateResponse is the response payload for an IP create request type IPServiceCreateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Ip the ip @@ -913,7 +913,7 @@ func (x *IPServiceCreateResponse) GetIp() *IP { return nil } -// IPServiceListResponse is the response payload for a ip list request +// IPServiceListResponse is the response payload for an IP list request type IPServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Ips the ips @@ -959,7 +959,7 @@ func (x *IPServiceListResponse) GetIps() []*IP { return nil } -// IPServiceDeleteResponse is the response payload for a ip delete request +// IPServiceDeleteResponse is the response payload for an IP delete request type IPServiceDeleteResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Ip the ip diff --git a/go/metalstack/api/v2/machine.pb.go b/go/metalstack/api/v2/machine.pb.go index 47596d4c..7ef921c3 100644 --- a/go/metalstack/api/v2/machine.pb.go +++ b/go/metalstack/api/v2/machine.pb.go @@ -2851,7 +2851,7 @@ type MachineBMCReport struct { Bmc *MachineBMC `protobuf:"bytes,1,opt,name=bmc,proto3" json:"bmc,omitempty"` // Bios contains bios details Bios *MachineBios `protobuf:"bytes,2,opt,name=bios,proto3" json:"bios,omitempty"` - // Fru containers field replaceable unit details + // Fru contains field replaceable unit details Fru *MachineFRU `protobuf:"bytes,3,opt,name=fru,proto3" json:"fru,omitempty"` // PowerMetric contains the power statistics of the machine PowerMetric *MachinePowerMetric `protobuf:"bytes,4,opt,name=power_metric,json=powerMetric,proto3" json:"power_metric,omitempty"` @@ -2951,7 +2951,7 @@ type MachineBios struct { Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"` // Vendor the bios vendor Vendor string `protobuf:"bytes,2,opt,name=vendor,proto3" json:"vendor,omitempty"` - // Date the bios date as string because every vendor has different ideas howto describe the date + // Date the bios date as string because every vendor has different ideas how to describe the date Date string `protobuf:"bytes,3,opt,name=date,proto3" json:"date,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -3427,7 +3427,7 @@ func (x *MachineRecentProvisioningEvents) GetState() MachineProvisioningEventSta return MachineProvisioningEventState_MACHINE_PROVISIONING_EVENT_STATE_UNSPECIFIED } -// MachineProvisioningEvent is a event which has occurred during provisioning +// MachineProvisioningEvent is an event that has occurred during provisioning type MachineProvisioningEvent struct { state protoimpl.MessageState `protogen:"open.v1"` // Time the time that this event was received @@ -4336,9 +4336,9 @@ type MachineIssuesQuery struct { state protoimpl.MessageState `protogen:"open.v1"` // MachineQuery to select specific machines MachineQuery *MachineQuery `protobuf:"bytes,1,opt,name=machine_query,json=machineQuery,proto3" json:"machine_query,omitempty"` - // Only a list of machine issue types to include + // Only includes the specified machine issue types Only []MachineIssueType `protobuf:"varint,2,rep,packed,name=only,proto3,enum=metalstack.api.v2.MachineIssueType" json:"only,omitempty"` - // Omit a list of machine issues to omit + // Omits the specified machine issues Omit []MachineIssueType `protobuf:"varint,3,rep,packed,name=omit,proto3,enum=metalstack.api.v2.MachineIssueType" json:"omit,omitempty"` // Severity filters issue for given severity Severity *MachineIssueSeverity `protobuf:"varint,4,opt,name=severity,proto3,enum=metalstack.api.v2.MachineIssueSeverity,oneof" json:"severity,omitempty"` diff --git a/go/metalstack/api/v2/network.pb.go b/go/metalstack/api/v2/network.pb.go index b948b602..e17143c3 100644 --- a/go/metalstack/api/v2/network.pb.go +++ b/go/metalstack/api/v2/network.pb.go @@ -942,7 +942,7 @@ type Network struct { Prefixes []string `protobuf:"bytes,8,rep,name=prefixes,proto3" json:"prefixes,omitempty"` // Destination Prefixes in this network DestinationPrefixes []string `protobuf:"bytes,9,rep,name=destination_prefixes,json=destinationPrefixes,proto3" json:"destination_prefixes,omitempty"` - // Default Child Prefix length defines the bitlength of a child network created per addressfamily, of not specified during the allocate request + // Default Child Prefix length defines the bit length of a child network created per address family, if not specified during the allocate request DefaultChildPrefixLength *ChildPrefixLength `protobuf:"bytes,10,opt,name=default_child_prefix_length,json=defaultChildPrefixLength,proto3" json:"default_child_prefix_length,omitempty"` // Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length MinChildPrefixLength *ChildPrefixLength `protobuf:"bytes,11,opt,name=min_child_prefix_length,json=minChildPrefixLength,proto3" json:"min_child_prefix_length,omitempty"` @@ -956,7 +956,7 @@ type Network struct { ParentNetwork *string `protobuf:"bytes,15,opt,name=parent_network,json=parentNetwork,proto3,oneof" json:"parent_network,omitempty"` // AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced AdditionalAnnouncableCidrs []string `protobuf:"bytes,16,rep,name=additional_announcable_cidrs,json=additionalAnnouncableCidrs,proto3" json:"additional_announcable_cidrs,omitempty"` - // Consumption of ips and prefixes in this networks + // Consumption of IPs and prefixes in this network Consumption *NetworkConsumption `protobuf:"bytes,17,opt,name=consumption,proto3" json:"consumption,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1391,7 +1391,7 @@ type NetworkUsage struct { AvailableIps uint64 `protobuf:"varint,1,opt,name=available_ips,json=availableIps,proto3" json:"available_ips,omitempty"` // the total used IPs UsedIps uint64 `protobuf:"varint,2,opt,name=used_ips,json=usedIps,proto3" json:"used_ips,omitempty"` - // the total available 2 bit Prefixes + // the total available 2-bit prefixes AvailablePrefixes uint64 `protobuf:"varint,3,opt,name=available_prefixes,json=availablePrefixes,proto3" json:"available_prefixes,omitempty"` // the total used Prefixes UsedPrefixes uint64 `protobuf:"varint,4,opt,name=used_prefixes,json=usedPrefixes,proto3" json:"used_prefixes,omitempty"` diff --git a/go/metalstack/api/v2/partition.pb.go b/go/metalstack/api/v2/partition.pb.go index 17402040..cf4415ed 100644 --- a/go/metalstack/api/v2/partition.pb.go +++ b/go/metalstack/api/v2/partition.pb.go @@ -185,7 +185,7 @@ type PartitionBootConfiguration struct { ImageUrl string `protobuf:"bytes,1,opt,name=image_url,json=imageUrl,proto3" json:"image_url,omitempty"` // KernelURL the url to download the kernel for the boot image KernelUrl string `protobuf:"bytes,2,opt,name=kernel_url,json=kernelUrl,proto3" json:"kernel_url,omitempty"` - // Commandline the cmdline to the kernel for the boot image + // Commandline the kernel command line for the boot image Commandline string `protobuf:"bytes,3,opt,name=commandline,proto3" json:"commandline,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/api/v2/project.pb.go b/go/metalstack/api/v2/project.pb.go index 0090c61c..2b359b0d 100644 --- a/go/metalstack/api/v2/project.pb.go +++ b/go/metalstack/api/v2/project.pb.go @@ -115,7 +115,7 @@ func (x *Project) GetAvatarUrl() string { return "" } -// ProjectMember defines a user that participates at a project +// ProjectMember defines a user that participates in a project type ProjectMember struct { state protoimpl.MessageState `protogen:"open.v1"` // Id is the user id of the member @@ -212,9 +212,9 @@ type ProjectInvite struct { Joined bool `protobuf:"varint,4,opt,name=joined,proto3" json:"joined,omitempty"` // ProjectName is the project name for which this invite was created ProjectName string `protobuf:"bytes,5,opt,name=project_name,json=projectName,proto3" json:"project_name,omitempty"` - // Tenant is the login of tenant who invites to join this project + // Tenant is the login of the tenant inviting another user to join this project Tenant string `protobuf:"bytes,6,opt,name=tenant,proto3" json:"tenant,omitempty"` - // TenantName is the name of tenant who invites to join this project + // TenantName is the name of the tenant inviting another user to join this project TenantName string `protobuf:"bytes,7,opt,name=tenant_name,json=tenantName,proto3" json:"tenant_name,omitempty"` // ExpiresAt the date when this invite expires ExpiresAt *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"` @@ -1564,7 +1564,7 @@ type ProjectServiceInviteAcceptResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Project ID of the project joined Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` - // ProjectName if the project joined + // ProjectName of the project joined ProjectName string `protobuf:"bytes,2,opt,name=project_name,json=projectName,proto3" json:"project_name,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/api/v2/size_imageconstraint.pb.go b/go/metalstack/api/v2/size_imageconstraint.pb.go index d6a7143b..f164a0fc 100644 --- a/go/metalstack/api/v2/size_imageconstraint.pb.go +++ b/go/metalstack/api/v2/size_imageconstraint.pb.go @@ -202,7 +202,7 @@ func (x *SizeImageConstraint) GetDescription() string { return "" } -// ImageConstraint defines a constraint for a image +// ImageConstraint defines a constraint for an image // examples: // images: // diff --git a/go/metalstack/api/v2/tenant.pb.go b/go/metalstack/api/v2/tenant.pb.go index 2501bbac..de703081 100644 --- a/go/metalstack/api/v2/tenant.pb.go +++ b/go/metalstack/api/v2/tenant.pb.go @@ -123,14 +123,14 @@ func (x *Tenant) GetCreatedBy() string { return "" } -// TenantMember defines a user that participates at a tenant +// TenantMember defines a user that participates in a tenant type TenantMember struct { state protoimpl.MessageState `protogen:"open.v1"` // Id is the user id of the member Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // Role is the role of the member Role TenantRole `protobuf:"varint,2,opt,name=role,proto3,enum=metalstack.api.v2.TenantRole" json:"role,omitempty"` - // Projects for the projects in which a user is a direct member + // Projects in which a user is a direct member Projects []string `protobuf:"bytes,3,rep,name=projects,proto3" json:"projects,omitempty"` // CreatedAt the date when the member was added to the tenant CreatedAt *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"` @@ -218,9 +218,9 @@ type TenantInvite struct { Joined bool `protobuf:"varint,4,opt,name=joined,proto3" json:"joined,omitempty"` // TargetTenantName is the tenant name for which this invite was created TargetTenantName string `protobuf:"bytes,5,opt,name=target_tenant_name,json=targetTenantName,proto3" json:"target_tenant_name,omitempty"` - // Tenant is the login of tenant who invites to join this tenant + // Tenant is the login of the tenant inviting another user to join this tenant Tenant string `protobuf:"bytes,6,opt,name=tenant,proto3" json:"tenant,omitempty"` - // TenantName is the name of tenant who invites to join this tenant + // TenantName is the name of the tenant inviting another user to join this tenant TenantName string `protobuf:"bytes,7,opt,name=tenant_name,json=tenantName,proto3" json:"tenant_name,omitempty"` // ExpiresAt the date when this invite expires ExpiresAt *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"` @@ -1107,7 +1107,7 @@ func (x *TenantServiceInvitesListRequest) GetLogin() string { // TenantServiceInvitesListResponse is the response payload to a list invites request type TenantServiceInvitesListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Invites not already accepted the invitation to this tenant + // Invites that have not yet accepted the invitation to this tenant Invites []*TenantInvite `protobuf:"bytes,1,rep,name=invites,proto3" json:"invites,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/api/v2/token.pb.go b/go/metalstack/api/v2/token.pb.go index 726b2b22..87c6c785 100644 --- a/go/metalstack/api/v2/token.pb.go +++ b/go/metalstack/api/v2/token.pb.go @@ -254,7 +254,7 @@ type TokenServiceCreateRequest struct { Expires *durationpb.Duration `protobuf:"bytes,3,opt,name=expires,proto3" json:"expires,omitempty"` // ProjectRoles associates a project id with the corresponding role of the token owner ProjectRoles map[string]ProjectRole `protobuf:"bytes,4,rep,name=project_roles,json=projectRoles,proto3" json:"project_roles,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"varint,2,opt,name=value,enum=metalstack.api.v2.ProjectRole"` - // TenantRoles_associates a tenant id with the corresponding role of the token owner + // TenantRoles associates a tenant id with the corresponding role of the token owner TenantRoles map[string]TenantRole `protobuf:"bytes,5,rep,name=tenant_roles,json=tenantRoles,proto3" json:"tenant_roles,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"varint,2,opt,name=value,enum=metalstack.api.v2.TenantRole"` // AdminRole defines the admin role of the token owner AdminRole *AdminRole `protobuf:"varint,6,opt,name=admin_role,json=adminRole,proto3,enum=metalstack.api.v2.AdminRole,oneof" json:"admin_role,omitempty"` @@ -426,7 +426,7 @@ type TokenServiceCreateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Token which was created Token *Token `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"` - // Secret is the body if the jwt token, should be used in api requests as bearer token + // Secret is the body of the JWT token, should be used in API requests as bearer token Secret string `protobuf:"bytes,2,opt,name=secret,proto3" json:"secret,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -961,7 +961,7 @@ type TokenServiceRefreshResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Token which was refreshed Token *Token `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"` - // Secret is the body if the jwt token, should be used in api requests as bearer token + // Secret is the body of the JWT token, should be used in API requests as bearer token Secret string `protobuf:"bytes,2,opt,name=secret,proto3" json:"secret,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/api/v2/user.pb.go b/go/metalstack/api/v2/user.pb.go index d4e3cf3f..3ae540c5 100644 --- a/go/metalstack/api/v2/user.pb.go +++ b/go/metalstack/api/v2/user.pb.go @@ -37,7 +37,7 @@ type User struct { Tenants []*Tenant `protobuf:"bytes,5,rep,name=tenants,proto3" json:"tenants,omitempty"` // Projects the user belongs to Projects []*Project `protobuf:"bytes,6,rep,name=projects,proto3" json:"projects,omitempty"` - // DefaultTenant this user belongs to + // DefaultTenant the default tenant that this user belongs to DefaultTenant *Tenant `protobuf:"bytes,7,opt,name=default_tenant,json=defaultTenant,proto3" json:"default_tenant,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/infra/v2/bmc.pb.go b/go/metalstack/infra/v2/bmc.pb.go index 1eb40d8c..ca32240a 100644 --- a/go/metalstack/infra/v2/bmc.pb.go +++ b/go/metalstack/infra/v2/bmc.pb.go @@ -28,7 +28,7 @@ type UpdateBMCInfoRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Partition is the partition ID where metal-bmc wants to receive events Partition string `protobuf:"bytes,1,opt,name=partition,proto3" json:"partition,omitempty"` - // BmcReports contains maps the BMC report per machine UUID + // BmcReports maps the BMC report per machine UUID BmcReports map[string]*v2.MachineBMCReport `protobuf:"bytes,2,rep,name=bmc_reports,json=bmcReports,proto3" json:"bmc_reports,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/infra/v2/boot.pb.go b/go/metalstack/infra/v2/boot.pb.go index 7a1c60e6..32efb3a0 100644 --- a/go/metalstack/infra/v2/boot.pb.go +++ b/go/metalstack/infra/v2/boot.pb.go @@ -249,7 +249,7 @@ type BootServiceRegisterRequest struct { Fru *v2.MachineFRU `protobuf:"bytes,5,opt,name=fru,proto3" json:"fru,omitempty"` // Tags of this machine Tags []string `protobuf:"bytes,6,rep,name=tags,proto3" json:"tags,omitempty"` - // MetalHammer version this machine was bootet into + // MetalHammer version this machine was booted into MetalHammerVersion string `protobuf:"bytes,7,opt,name=metal_hammer_version,json=metalHammerVersion,proto3" json:"metal_hammer_version,omitempty"` // Partition where this machine is located Partition string `protobuf:"bytes,8,opt,name=partition,proto3" json:"partition,omitempty"` diff --git a/js/metalstack/admin/v2/filesystem_pb.d.ts b/js/metalstack/admin/v2/filesystem_pb.d.ts index 0f76e8da..103ec78b 100644 --- a/js/metalstack/admin/v2/filesystem_pb.d.ts +++ b/js/metalstack/admin/v2/filesystem_pb.d.ts @@ -175,8 +175,8 @@ export declare const FilesystemServiceDeleteResponseSchema: GenMessage & { /** - * Match either size and image to a filesystemlayout - * or if a machine matches to a filesystemlayout + * Match size and image to a filesystem layout + * or match a machine to a filesystem layout * * @generated from oneof metalstack.admin.v2.FilesystemServiceMatchRequest.match */ diff --git a/js/metalstack/admin/v2/filesystem_pb.ts b/js/metalstack/admin/v2/filesystem_pb.ts index 8b9eacad..a1fa86d8 100644 --- a/js/metalstack/admin/v2/filesystem_pb.ts +++ b/js/metalstack/admin/v2/filesystem_pb.ts @@ -214,8 +214,8 @@ export const FilesystemServiceDeleteResponseSchema: GenMessage & { /** - * Match either size and image to a filesystemlayout - * or if a machine matches to a filesystemlayout + * Match size and image to a filesystem layout + * or match a machine to a filesystem layout * * @generated from oneof metalstack.admin.v2.FilesystemServiceMatchRequest.match */ diff --git a/js/metalstack/admin/v2/image_pb.d.ts b/js/metalstack/admin/v2/image_pb.d.ts index 3bf5d143..a7795641 100644 --- a/js/metalstack/admin/v2/image_pb.d.ts +++ b/js/metalstack/admin/v2/image_pb.d.ts @@ -92,7 +92,7 @@ export type ImageServiceUpdateRequest = Message<"metalstack.admin.v2.ImageServic */ classification: ImageClassification; /** - * ExpiresAt usage is not possible after this date + * ExpiresAt indicates that usage is not possible after this date * * @generated from field: google.protobuf.Timestamp expires_at = 8; */ diff --git a/js/metalstack/admin/v2/image_pb.ts b/js/metalstack/admin/v2/image_pb.ts index b7c4c339..80a9fa69 100644 --- a/js/metalstack/admin/v2/image_pb.ts +++ b/js/metalstack/admin/v2/image_pb.ts @@ -118,7 +118,7 @@ export type ImageServiceUpdateRequest = Message<"metalstack.admin.v2.ImageServic classification: ImageClassification; /** - * ExpiresAt usage is not possible after this date + * ExpiresAt indicates that usage is not possible after this date * * @generated from field: google.protobuf.Timestamp expires_at = 8; */ diff --git a/js/metalstack/admin/v2/machine_pb.d.ts b/js/metalstack/admin/v2/machine_pb.d.ts index a56a9a65..678ac1be 100644 --- a/js/metalstack/admin/v2/machine_pb.d.ts +++ b/js/metalstack/admin/v2/machine_pb.d.ts @@ -48,7 +48,7 @@ export declare const MachineServiceGetResponseSchema: GenMessage & { /** - * Query to list one ore more machines + * Query to list one or more machines * * @generated from field: metalstack.api.v2.MachineQuery query = 1; */ @@ -204,7 +204,7 @@ export declare const MachineServiceGetBMCResponseSchema: GenMessage & { /** - * Query to list one ore more bmcs of many machines + * Query to list one or more BMCs of many machines * * @generated from field: metalstack.api.v2.MachineBMCQuery query = 1; */ diff --git a/js/metalstack/admin/v2/machine_pb.ts b/js/metalstack/admin/v2/machine_pb.ts index f7594bdb..c411d755 100644 --- a/js/metalstack/admin/v2/machine_pb.ts +++ b/js/metalstack/admin/v2/machine_pb.ts @@ -66,7 +66,7 @@ export const MachineServiceGetResponseSchema: GenMessage & { /** - * Query to list one ore more machines + * Query to list one or more machines * * @generated from field: metalstack.api.v2.MachineQuery query = 1; */ @@ -250,7 +250,7 @@ export const MachineServiceGetBMCResponseSchema: GenMessage & { /** - * Query to list one ore more bmcs of many machines + * Query to list one or more BMCs of many machines * * @generated from field: metalstack.api.v2.MachineBMCQuery query = 1; */ diff --git a/js/metalstack/admin/v2/partition_pb.d.ts b/js/metalstack/admin/v2/partition_pb.d.ts index bb05380d..0836921a 100644 --- a/js/metalstack/admin/v2/partition_pb.d.ts +++ b/js/metalstack/admin/v2/partition_pb.d.ts @@ -92,7 +92,7 @@ export declare const PartitionServiceUpdateRequestSchema: GenMessage & { /** - * ID of the partition to get + * ID of the partition to delete * * @generated from field: string id = 1; */ diff --git a/js/metalstack/admin/v2/partition_pb.ts b/js/metalstack/admin/v2/partition_pb.ts index fcee9c0b..1d16814e 100644 --- a/js/metalstack/admin/v2/partition_pb.ts +++ b/js/metalstack/admin/v2/partition_pb.ts @@ -117,7 +117,7 @@ export const PartitionServiceUpdateRequestSchema: GenMessage & { /** - * ID of the partition to get + * ID of the partition to delete * * @generated from field: string id = 1; */ diff --git a/js/metalstack/admin/v2/switch_pb.d.ts b/js/metalstack/admin/v2/switch_pb.d.ts index c53a0874..6920526e 100644 --- a/js/metalstack/admin/v2/switch_pb.d.ts +++ b/js/metalstack/admin/v2/switch_pb.d.ts @@ -244,7 +244,7 @@ export declare const SwitchServiceMigrateRequestSchema: GenMessage & { /** - * Switch contains the switch was migrated to + * Switch contains the switch that was migrated to * * @generated from field: metalstack.api.v2.Switch switch = 1; */ diff --git a/js/metalstack/admin/v2/switch_pb.ts b/js/metalstack/admin/v2/switch_pb.ts index e8b97b16..acd46d8c 100644 --- a/js/metalstack/admin/v2/switch_pb.ts +++ b/js/metalstack/admin/v2/switch_pb.ts @@ -296,7 +296,7 @@ export const SwitchServiceMigrateRequestSchema: GenMessage & { /** - * Switch contains the switch was migrated to + * Switch contains the switch that was migrated to * * @generated from field: metalstack.api.v2.Switch switch = 1; */ diff --git a/js/metalstack/admin/v2/tenant_pb.d.ts b/js/metalstack/admin/v2/tenant_pb.d.ts index 2fc66760..717356fb 100644 --- a/js/metalstack/admin/v2/tenant_pb.d.ts +++ b/js/metalstack/admin/v2/tenant_pb.d.ts @@ -221,7 +221,7 @@ export declare const TenantService: GenService<{ output: typeof TenantServiceAddMemberResponseSchema; }; /** - * RemoveMember remove a member of a tenant + * RemoveMember removes a member from a tenant * * @generated from rpc metalstack.admin.v2.TenantService.RemoveMember */ diff --git a/js/metalstack/admin/v2/tenant_pb.ts b/js/metalstack/admin/v2/tenant_pb.ts index f4e22a1c..365f1381 100644 --- a/js/metalstack/admin/v2/tenant_pb.ts +++ b/js/metalstack/admin/v2/tenant_pb.ts @@ -267,7 +267,7 @@ export const TenantService: GenService<{ output: typeof TenantServiceAddMemberResponseSchema; }, /** - * RemoveMember remove a member of a tenant + * RemoveMember removes a member from a tenant * * @generated from rpc metalstack.admin.v2.TenantService.RemoveMember */ diff --git a/js/metalstack/api/v2/audit_pb.d.ts b/js/metalstack/api/v2/audit_pb.d.ts index b4d971a3..4651f5cd 100644 --- a/js/metalstack/api/v2/audit_pb.d.ts +++ b/js/metalstack/api/v2/audit_pb.d.ts @@ -163,7 +163,7 @@ export type AuditQuery = Message<"metalstack.api.v2.AuditQuery"> & { */ export declare const AuditQuerySchema: GenMessage; /** - * AuditServiceListRequest is the request payload for a audit list request + * AuditServiceListRequest is the request payload for an audit list request * * @generated from message metalstack.api.v2.AuditServiceListRequest */ diff --git a/js/metalstack/api/v2/audit_pb.ts b/js/metalstack/api/v2/audit_pb.ts index f667d305..45a1f1d4 100644 --- a/js/metalstack/api/v2/audit_pb.ts +++ b/js/metalstack/api/v2/audit_pb.ts @@ -201,7 +201,7 @@ export const AuditQuerySchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_audit, 1); /** - * AuditServiceListRequest is the request payload for a audit list request + * AuditServiceListRequest is the request payload for an audit list request * * @generated from message metalstack.api.v2.AuditServiceListRequest */ diff --git a/js/metalstack/api/v2/common_pb.d.ts b/js/metalstack/api/v2/common_pb.d.ts index 17a8afb6..6ad353fa 100644 --- a/js/metalstack/api/v2/common_pb.d.ts +++ b/js/metalstack/api/v2/common_pb.d.ts @@ -364,7 +364,7 @@ export declare enum Visibility { */ PUBLIC = 1, /** - * VISIBILITY_SELF enable call this endpoint from the authenticated user only + * VISIBILITY_SELF restricts calls to the authenticated user only * * @generated from enum value: VISIBILITY_SELF = 2; */ @@ -437,19 +437,19 @@ export declare enum OptimisticLockingStrategy { */ export declare const OptimisticLockingStrategySchema: GenEnum; /** - * TenantRoles are used to define which tenant role a logged in user must provide to call this method + * TenantRoles are used to define the tenant role a logged in user must provide to call this method * * @generated from extension: repeated metalstack.api.v2.TenantRole tenant_roles = 51000; */ export declare const tenant_roles: GenExtension; /** - * ProjectRoles are used to define which project role a logged in user must provide to call this method + * ProjectRoles are used to define the project role a logged in user must provide to call this method * * @generated from extension: repeated metalstack.api.v2.ProjectRole project_roles = 51001; */ export declare const project_roles: GenExtension; /** - * AdminRoles are used to define which admin role a logged in user must provide to call this method + * AdminRoles are used to define the admin role a logged in user must provide to call this method * * @generated from extension: repeated metalstack.api.v2.AdminRole admin_roles = 51002; */ @@ -467,7 +467,7 @@ export declare const visibility: GenExtension; */ export declare const auditing: GenExtension; /** - * InfraRoles are used to define which infra role a microservice must provide to call this method + * InfraRoles are used to define the infra role a microservice must provide to call this method * * @generated from extension: repeated metalstack.api.v2.InfraRole infra_roles = 51005; */ diff --git a/js/metalstack/api/v2/common_pb.js b/js/metalstack/api/v2/common_pb.js index 36ea0247..518993eb 100644 --- a/js/metalstack/api/v2/common_pb.js +++ b/js/metalstack/api/v2/common_pb.js @@ -229,7 +229,7 @@ export var Visibility; */ Visibility[Visibility["PUBLIC"] = 1] = "PUBLIC"; /** - * VISIBILITY_SELF enable call this endpoint from the authenticated user only + * VISIBILITY_SELF restricts calls to the authenticated user only * * @generated from enum value: VISIBILITY_SELF = 2; */ @@ -304,19 +304,19 @@ export var OptimisticLockingStrategy; */ export const OptimisticLockingStrategySchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_common, 7); /** - * TenantRoles are used to define which tenant role a logged in user must provide to call this method + * TenantRoles are used to define the tenant role a logged in user must provide to call this method * * @generated from extension: repeated metalstack.api.v2.TenantRole tenant_roles = 51000; */ export const tenant_roles = /*@__PURE__*/ extDesc(file_metalstack_api_v2_common, 0); /** - * ProjectRoles are used to define which project role a logged in user must provide to call this method + * ProjectRoles are used to define the project role a logged in user must provide to call this method * * @generated from extension: repeated metalstack.api.v2.ProjectRole project_roles = 51001; */ export const project_roles = /*@__PURE__*/ extDesc(file_metalstack_api_v2_common, 1); /** - * AdminRoles are used to define which admin role a logged in user must provide to call this method + * AdminRoles are used to define the admin role a logged in user must provide to call this method * * @generated from extension: repeated metalstack.api.v2.AdminRole admin_roles = 51002; */ @@ -334,7 +334,7 @@ export const visibility = /*@__PURE__*/ extDesc(file_metalstack_api_v2_common, 3 */ export const auditing = /*@__PURE__*/ extDesc(file_metalstack_api_v2_common, 4); /** - * InfraRoles are used to define which infra role a microservice must provide to call this method + * InfraRoles are used to define the infra role a microservice must provide to call this method * * @generated from extension: repeated metalstack.api.v2.InfraRole infra_roles = 51005; */ diff --git a/js/metalstack/api/v2/common_pb.ts b/js/metalstack/api/v2/common_pb.ts index 60972378..9adeb7b5 100644 --- a/js/metalstack/api/v2/common_pb.ts +++ b/js/metalstack/api/v2/common_pb.ts @@ -425,7 +425,7 @@ export enum Visibility { PUBLIC = 1, /** - * VISIBILITY_SELF enable call this endpoint from the authenticated user only + * VISIBILITY_SELF restricts calls to the authenticated user only * * @generated from enum value: VISIBILITY_SELF = 2; */ @@ -511,7 +511,7 @@ export const OptimisticLockingStrategySchema: GenEnum enumDesc(file_metalstack_api_v2_common, 7); /** - * TenantRoles are used to define which tenant role a logged in user must provide to call this method + * TenantRoles are used to define the tenant role a logged in user must provide to call this method * * @generated from extension: repeated metalstack.api.v2.TenantRole tenant_roles = 51000; */ @@ -519,7 +519,7 @@ export const tenant_roles: GenExtension = /*@__PURE extDesc(file_metalstack_api_v2_common, 0); /** - * ProjectRoles are used to define which project role a logged in user must provide to call this method + * ProjectRoles are used to define the project role a logged in user must provide to call this method * * @generated from extension: repeated metalstack.api.v2.ProjectRole project_roles = 51001; */ @@ -527,7 +527,7 @@ export const project_roles: GenExtension = /*@__PU extDesc(file_metalstack_api_v2_common, 1); /** - * AdminRoles are used to define which admin role a logged in user must provide to call this method + * AdminRoles are used to define the admin role a logged in user must provide to call this method * * @generated from extension: repeated metalstack.api.v2.AdminRole admin_roles = 51002; */ @@ -551,7 +551,7 @@ export const auditing: GenExtension = /*@__PURE__*/ extDesc(file_metalstack_api_v2_common, 4); /** - * InfraRoles are used to define which infra role a microservice must provide to call this method + * InfraRoles are used to define the infra role a microservice must provide to call this method * * @generated from extension: repeated metalstack.api.v2.InfraRole infra_roles = 51005; */ diff --git a/js/metalstack/api/v2/filesystem_pb.d.ts b/js/metalstack/api/v2/filesystem_pb.d.ts index c877b7d9..825dc9f6 100644 --- a/js/metalstack/api/v2/filesystem_pb.d.ts +++ b/js/metalstack/api/v2/filesystem_pb.d.ts @@ -217,7 +217,7 @@ export type Filesystem = Message<"metalstack.api.v2.Filesystem"> & { */ path?: string | undefined; /** - * Label optional label for this this filesystem + * Label an optional label for this filesystem * * @generated from field: optional string label = 6; */ @@ -319,13 +319,13 @@ export type DiskPartition = Message<"metalstack.api.v2.DiskPartition"> & { */ number: number; /** - * optional label for this this partition + * Label an optional label for this partition * * @generated from field: optional string label = 2; */ label?: string | undefined; /** - * Size size in mebibytes (MiB) of this partition" + * Size in mebibytes (MiB) of this partition * * @generated from field: uint64 size = 3; */ diff --git a/js/metalstack/api/v2/filesystem_pb.ts b/js/metalstack/api/v2/filesystem_pb.ts index 50b987e6..c76704a8 100644 --- a/js/metalstack/api/v2/filesystem_pb.ts +++ b/js/metalstack/api/v2/filesystem_pb.ts @@ -259,7 +259,7 @@ export type Filesystem = Message<"metalstack.api.v2.Filesystem"> & { path?: string | undefined; /** - * Label optional label for this this filesystem + * Label an optional label for this filesystem * * @generated from field: optional string label = 6; */ @@ -378,14 +378,14 @@ export type DiskPartition = Message<"metalstack.api.v2.DiskPartition"> & { number: number; /** - * optional label for this this partition + * Label an optional label for this partition * * @generated from field: optional string label = 2; */ label?: string | undefined; /** - * Size size in mebibytes (MiB) of this partition" + * Size in mebibytes (MiB) of this partition * * @generated from field: uint64 size = 3; */ diff --git a/js/metalstack/api/v2/image_pb.d.ts b/js/metalstack/api/v2/image_pb.d.ts index 2c2b2ca8..8b66849e 100644 --- a/js/metalstack/api/v2/image_pb.d.ts +++ b/js/metalstack/api/v2/image_pb.d.ts @@ -7,7 +7,7 @@ import type { Message } from "@bufbuild/protobuf"; */ export declare const file_metalstack_api_v2_image: GenFile; /** - * ImageServiceGetRequest is the request payload for a image get request + * ImageServiceGetRequest is the request payload for an image get request * * @generated from message metalstack.api.v2.ImageServiceGetRequest */ @@ -25,7 +25,7 @@ export type ImageServiceGetRequest = Message<"metalstack.api.v2.ImageServiceGetR */ export declare const ImageServiceGetRequestSchema: GenMessage; /** - * ImageServiceListRequest is the request payload for a image list request + * ImageServiceListRequest is the request payload for an image list request * * @generated from message metalstack.api.v2.ImageServiceListRequest */ @@ -43,7 +43,7 @@ export type ImageServiceListRequest = Message<"metalstack.api.v2.ImageServiceLis */ export declare const ImageServiceListRequestSchema: GenMessage; /** - * ImageServiceLatestRequest is the request payload for a image latest request + * ImageServiceLatestRequest is the request payload for an image latest request * * @generated from message metalstack.api.v2.ImageServiceLatestRequest */ @@ -68,7 +68,7 @@ export type ImageServiceLatestRequest = Message<"metalstack.api.v2.ImageServiceL */ export declare const ImageServiceLatestRequestSchema: GenMessage; /** - * ImageServiceGetResponse is the response payload for a image get request + * ImageServiceGetResponse is the response payload for an image get request * * @generated from message metalstack.api.v2.ImageServiceGetResponse */ @@ -86,7 +86,7 @@ export type ImageServiceGetResponse = Message<"metalstack.api.v2.ImageServiceGet */ export declare const ImageServiceGetResponseSchema: GenMessage; /** - * ImageServiceListResponse is the response payload for a image list request + * ImageServiceListResponse is the response payload for an image list request * * @generated from message metalstack.api.v2.ImageServiceListResponse */ @@ -104,7 +104,7 @@ export type ImageServiceListResponse = Message<"metalstack.api.v2.ImageServiceLi */ export declare const ImageServiceListResponseSchema: GenMessage; /** - * ImageServiceLatestResponse is the response payload for a image latest request + * ImageServiceLatestResponse is the response payload for an image latest request * * @generated from message metalstack.api.v2.ImageServiceLatestResponse */ diff --git a/js/metalstack/api/v2/image_pb.ts b/js/metalstack/api/v2/image_pb.ts index fc64a908..e29a7965 100644 --- a/js/metalstack/api/v2/image_pb.ts +++ b/js/metalstack/api/v2/image_pb.ts @@ -19,7 +19,7 @@ export const file_metalstack_api_v2_image: GenFile = /*@__PURE__*/ fileDesc("Ch1tZXRhbHN0YWNrL2FwaS92Mi9pbWFnZS5wcm90bxIRbWV0YWxzdGFjay5hcGkudjIiMQoWSW1hZ2VTZXJ2aWNlR2V0UmVxdWVzdBIXCgJpZBgBIAEoCUILukgIcgbAs66xAgEiRwoXSW1hZ2VTZXJ2aWNlTGlzdFJlcXVlc3QSLAoFcXVlcnkYASABKAsyHS5tZXRhbHN0YWNrLmFwaS52Mi5JbWFnZVF1ZXJ5IokBChlJbWFnZVNlcnZpY2VMYXRlc3RSZXF1ZXN0EgoKAm9zGAEgASgJEk0KDmNsYXNzaWZpY2F0aW9uGAIgASgOMiYubWV0YWxzdGFjay5hcGkudjIuSW1hZ2VDbGFzc2lmaWNhdGlvbkIIukgFggECEAFIAIgBAUIRCg9fY2xhc3NpZmljYXRpb24iQgoXSW1hZ2VTZXJ2aWNlR2V0UmVzcG9uc2USJwoFaW1hZ2UYASABKAsyGC5tZXRhbHN0YWNrLmFwaS52Mi5JbWFnZSJEChhJbWFnZVNlcnZpY2VMaXN0UmVzcG9uc2USKAoGaW1hZ2VzGAEgAygLMhgubWV0YWxzdGFjay5hcGkudjIuSW1hZ2UiRQoaSW1hZ2VTZXJ2aWNlTGF0ZXN0UmVzcG9uc2USJwoFaW1hZ2UYASABKAsyGC5tZXRhbHN0YWNrLmFwaS52Mi5JbWFnZSL/AgoFSW1hZ2USFwoCaWQYASABKAlCC7pICHIGwLOusQIBEiUKBG1ldGEYAiABKAsyFy5tZXRhbHN0YWNrLmFwaS52Mi5NZXRhEhgKA3VybBgDIAEoCUILukgIcgbgs66xAgESHgoEbmFtZRgEIAEoCUILukgIcgbAs66xAgFIAIgBARIlCgtkZXNjcmlwdGlvbhgFIAEoCUILukgIcgbIs66xAgFIAYgBARJCCghmZWF0dXJlcxgGIAMoDjIfLm1ldGFsc3RhY2suYXBpLnYyLkltYWdlRmVhdHVyZUIPukgMkgEJGAEiBYIBAhABEkgKDmNsYXNzaWZpY2F0aW9uGAcgASgOMiYubWV0YWxzdGFjay5hcGkudjIuSW1hZ2VDbGFzc2lmaWNhdGlvbkIIukgFggECEAESLgoKZXhwaXJlc19hdBgIIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5UaW1lc3RhbXBCBwoFX25hbWVCDgoMX2Rlc2NyaXB0aW9uIkYKCkltYWdlVXNhZ2USJwoFaW1hZ2UYASABKAsyGC5tZXRhbHN0YWNrLmFwaS52Mi5JbWFnZRIPCgd1c2VkX2J5GAIgAygJIvQDCgpJbWFnZVF1ZXJ5EhwKAmlkGAEgASgJQgu6SAhyBsCzrrECAUgAiAEBEhsKAm9zGAIgASgJQgq6SAdyBRACGIABSAGIAQESIAoHdmVyc2lvbhgDIAEoCUIKukgHcgUQARiAAUgCiAEBEh4KBG5hbWUYBCABKAlCC7pICHIGwLOusQIBSAOIAQESJQoLZGVzY3JpcHRpb24YBSABKAlCC7pICHIGyLOusQIBSASIAQESHQoDdXJsGAYgASgJQgu6SAhyBuCzrrECAUgFiAEBEj8KB2ZlYXR1cmUYByABKA4yHy5tZXRhbHN0YWNrLmFwaS52Mi5JbWFnZUZlYXR1cmVCCLpIBYIBAhABSAaIAQESTQoOY2xhc3NpZmljYXRpb24YCCABKA4yJi5tZXRhbHN0YWNrLmFwaS52Mi5JbWFnZUNsYXNzaWZpY2F0aW9uQgi6SAWCAQIQAUgHiAEBEi4KBmxhYmVscxgJIAEoCzIZLm1ldGFsc3RhY2suYXBpLnYyLkxhYmVsc0gIiAEBQgUKA19pZEIFCgNfb3NCCgoIX3ZlcnNpb25CBwoFX25hbWVCDgoMX2Rlc2NyaXB0aW9uQgYKBF91cmxCCgoIX2ZlYXR1cmVCEQoPX2NsYXNzaWZpY2F0aW9uQgkKB19sYWJlbHMqfwoMSW1hZ2VGZWF0dXJlEh0KGUlNQUdFX0ZFQVRVUkVfVU5TUEVDSUZJRUQQABImChVJTUFHRV9GRUFUVVJFX01BQ0hJTkUQARoLgrIZB21hY2hpbmUSKAoWSU1BR0VfRkVBVFVSRV9GSVJFV0FMTBACGgyCshkIZmlyZXdhbGwq0gEKE0ltYWdlQ2xhc3NpZmljYXRpb24SJAogSU1BR0VfQ0xBU1NJRklDQVRJT05fVU5TUEVDSUZJRUQQABItChxJTUFHRV9DTEFTU0lGSUNBVElPTl9QUkVWSUVXEAEaC4KyGQdwcmV2aWV3EjEKHklNQUdFX0NMQVNTSUZJQ0FUSU9OX1NVUFBPUlRFRBACGg2CshkJc3VwcG9ydGVkEjMKH0lNQUdFX0NMQVNTSUZJQ0FUSU9OX0RFUFJFQ0FURUQQAxoOgrIZCmRlcHJlY2F0ZWQy0gIKDEltYWdlU2VydmljZRJmCgNHZXQSKS5tZXRhbHN0YWNrLmFwaS52Mi5JbWFnZVNlcnZpY2VHZXRSZXF1ZXN0GioubWV0YWxzdGFjay5hcGkudjIuSW1hZ2VTZXJ2aWNlR2V0UmVzcG9uc2UiCNjzGALg8xgCEmkKBExpc3QSKi5tZXRhbHN0YWNrLmFwaS52Mi5JbWFnZVNlcnZpY2VMaXN0UmVxdWVzdBorLm1ldGFsc3RhY2suYXBpLnYyLkltYWdlU2VydmljZUxpc3RSZXNwb25zZSII2PMYAuDzGAISbwoGTGF0ZXN0EiwubWV0YWxzdGFjay5hcGkudjIuSW1hZ2VTZXJ2aWNlTGF0ZXN0UmVxdWVzdBotLm1ldGFsc3RhY2suYXBpLnYyLkltYWdlU2VydmljZUxhdGVzdFJlc3BvbnNlIgjY8xgC4PMYAkLAAQoVY29tLm1ldGFsc3RhY2suYXBpLnYyQgpJbWFnZVByb3RvUAFaNWdpdGh1Yi5jb20vbWV0YWwtc3RhY2svYXBpL2dvL21ldGFsc3RhY2svYXBpL3YyO2FwaXYyogIDTUFYqgIRTWV0YWxzdGFjay5BcGkuVjLKAhFNZXRhbHN0YWNrXEFwaVxWMuICHU1ldGFsc3RhY2tcQXBpXFYyXEdQQk1ldGFkYXRh6gITTWV0YWxzdGFjazo6QXBpOjpWMmIGcHJvdG8z", [file_buf_validate_validate, file_google_protobuf_timestamp, file_metalstack_api_v2_common, file_metalstack_api_v2_predefined_rules]); /** - * ImageServiceGetRequest is the request payload for a image get request + * ImageServiceGetRequest is the request payload for an image get request * * @generated from message metalstack.api.v2.ImageServiceGetRequest */ @@ -40,7 +40,7 @@ export const ImageServiceGetRequestSchema: GenMessage = messageDesc(file_metalstack_api_v2_image, 0); /** - * ImageServiceListRequest is the request payload for a image list request + * ImageServiceListRequest is the request payload for an image list request * * @generated from message metalstack.api.v2.ImageServiceListRequest */ @@ -61,7 +61,7 @@ export const ImageServiceListRequestSchema: GenMessage messageDesc(file_metalstack_api_v2_image, 1); /** - * ImageServiceLatestRequest is the request payload for a image latest request + * ImageServiceLatestRequest is the request payload for an image latest request * * @generated from message metalstack.api.v2.ImageServiceLatestRequest */ @@ -90,7 +90,7 @@ export const ImageServiceLatestRequestSchema: GenMessage messageDesc(file_metalstack_api_v2_image, 3); /** - * ImageServiceListResponse is the response payload for a image list request + * ImageServiceListResponse is the response payload for an image list request * * @generated from message metalstack.api.v2.ImageServiceListResponse */ @@ -132,7 +132,7 @@ export const ImageServiceListResponseSchema: GenMessage & { */ export declare const IPSchema: GenMessage; /** - * IPServiceGetRequest is the request payload for a ip get request + * IPServiceGetRequest is the request payload for an IP get request * * @generated from message metalstack.api.v2.IPServiceGetRequest */ @@ -103,7 +103,7 @@ export type IPServiceGetRequest = Message<"metalstack.api.v2.IPServiceGetRequest */ export declare const IPServiceGetRequestSchema: GenMessage; /** - * IPServiceCreateRequest is the request payload for a ip create request + * IPServiceCreateRequest is the request payload for an IP create request * * @generated from message metalstack.api.v2.IPServiceCreateRequest */ @@ -169,7 +169,7 @@ export type IPServiceCreateRequest = Message<"metalstack.api.v2.IPServiceCreateR */ export declare const IPServiceCreateRequestSchema: GenMessage; /** - * IPServiceUpdateRequest is the request payload for a ip update request + * IPServiceUpdateRequest is the request payload for an IP update request * * @generated from message metalstack.api.v2.IPServiceUpdateRequest */ @@ -223,7 +223,7 @@ export type IPServiceUpdateRequest = Message<"metalstack.api.v2.IPServiceUpdateR */ export declare const IPServiceUpdateRequestSchema: GenMessage; /** - * IPServiceListRequest is the request payload for a ip list request + * IPServiceListRequest is the request payload for an IP list request * * @generated from message metalstack.api.v2.IPServiceListRequest */ @@ -235,7 +235,7 @@ export type IPServiceListRequest = Message<"metalstack.api.v2.IPServiceListReque */ project: string; /** - * Query to list one ore more ips + * Query to list one or more IPs * * @generated from field: metalstack.api.v2.IPQuery query = 2; */ @@ -259,7 +259,7 @@ export type IPQuery = Message<"metalstack.api.v2.IPQuery"> & { */ ip?: string | undefined; /** - * Network from where the ips to list + * Network from which the IPs are to list * * @generated from field: optional string network = 2; */ @@ -277,13 +277,13 @@ export type IPQuery = Message<"metalstack.api.v2.IPQuery"> & { */ name?: string | undefined; /** - * Uuid for which this ips should get filtered + * UUID for which these IPs should be filtered * * @generated from field: optional string uuid = 5; */ uuid?: string | undefined; /** - * Machine for which this ips should get filtered + * Machine for which these IPs should be filtered * * @generated from field: optional string machine = 6; */ @@ -295,7 +295,7 @@ export type IPQuery = Message<"metalstack.api.v2.IPQuery"> & { */ parentPrefixCidr?: string | undefined; /** - * Labels for which this ips should get filtered + * Labels for which these IPs should be filtered * * @generated from field: optional metalstack.api.v2.Labels labels = 8; */ @@ -307,7 +307,7 @@ export type IPQuery = Message<"metalstack.api.v2.IPQuery"> & { */ type?: IPType | undefined; /** - * Addressfamily of the IPs to list, defaults to all addressfamilies + * Address family of the IPs to list, defaults to all address families * * @generated from field: optional metalstack.api.v2.IPAddressFamily address_family = 10; */ @@ -349,7 +349,7 @@ export type IPServiceDeleteRequest = Message<"metalstack.api.v2.IPServiceDeleteR */ export declare const IPServiceDeleteRequestSchema: GenMessage; /** - * IPServiceGetResponse is the response payload for a ip get request + * IPServiceGetResponse is the response payload for an IP get request * * @generated from message metalstack.api.v2.IPServiceGetResponse */ @@ -385,7 +385,7 @@ export type IPServiceUpdateResponse = Message<"metalstack.api.v2.IPServiceUpdate */ export declare const IPServiceUpdateResponseSchema: GenMessage; /** - * IPServiceCreateResponse is the response payload for a ip create request + * IPServiceCreateResponse is the response payload for an IP create request * * @generated from message metalstack.api.v2.IPServiceCreateResponse */ @@ -403,7 +403,7 @@ export type IPServiceCreateResponse = Message<"metalstack.api.v2.IPServiceCreate */ export declare const IPServiceCreateResponseSchema: GenMessage; /** - * IPServiceListResponse is the response payload for a ip list request + * IPServiceListResponse is the response payload for an IP list request * * @generated from message metalstack.api.v2.IPServiceListResponse */ @@ -421,7 +421,7 @@ export type IPServiceListResponse = Message<"metalstack.api.v2.IPServiceListResp */ export declare const IPServiceListResponseSchema: GenMessage; /** - * IPServiceDeleteResponse is the response payload for a ip delete request + * IPServiceDeleteResponse is the response payload for an IP delete request * * @generated from message metalstack.api.v2.IPServiceDeleteResponse */ @@ -439,7 +439,7 @@ export type IPServiceDeleteResponse = Message<"metalstack.api.v2.IPServiceDelete */ export declare const IPServiceDeleteResponseSchema: GenMessage; /** - * IPType specifies different ip address types + * IPType specifies different IP address types * * @generated from enum metalstack.api.v2.IPType */ @@ -451,7 +451,7 @@ export declare enum IPType { */ IP_TYPE_UNSPECIFIED = 0, /** - * IP_TYPE_EPHEMERAL defines a ephemeral ip address which is freed/deleted after usage + * IP_TYPE_EPHEMERAL defines an ephemeral IP address which is freed/deleted after usage * * @generated from enum value: IP_TYPE_EPHEMERAL = 1; */ diff --git a/js/metalstack/api/v2/ip_pb.js b/js/metalstack/api/v2/ip_pb.js index e8e43991..ccd663f7 100644 --- a/js/metalstack/api/v2/ip_pb.js +++ b/js/metalstack/api/v2/ip_pb.js @@ -70,7 +70,7 @@ export const IPServiceListResponseSchema = /*@__PURE__*/ messageDesc(file_metals */ export const IPServiceDeleteResponseSchema = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_ip, 11); /** - * IPType specifies different ip address types + * IPType specifies different IP address types * * @generated from enum metalstack.api.v2.IPType */ @@ -83,7 +83,7 @@ export var IPType; */ IPType[IPType["IP_TYPE_UNSPECIFIED"] = 0] = "IP_TYPE_UNSPECIFIED"; /** - * IP_TYPE_EPHEMERAL defines a ephemeral ip address which is freed/deleted after usage + * IP_TYPE_EPHEMERAL defines an ephemeral IP address which is freed/deleted after usage * * @generated from enum value: IP_TYPE_EPHEMERAL = 1; */ diff --git a/js/metalstack/api/v2/ip_pb.ts b/js/metalstack/api/v2/ip_pb.ts index 4d9a4591..6c6099e6 100644 --- a/js/metalstack/api/v2/ip_pb.ts +++ b/js/metalstack/api/v2/ip_pb.ts @@ -17,7 +17,7 @@ export const file_metalstack_api_v2_ip: GenFile = /*@__PURE__*/ fileDesc("ChptZXRhbHN0YWNrL2FwaS92Mi9pcC5wcm90bxIRbWV0YWxzdGFjay5hcGkudjIisQIKAklQEhYKBHV1aWQYASABKAlCCLpIBXIDsAEBEiUKBG1ldGEYAiABKAsyFy5tZXRhbHN0YWNrLmFwaS52Mi5NZXRhEhMKAmlwGAMgASgJQge6SARyAnABEhkKBG5hbWUYBCABKAlCC7pICHIGwLOusQIBEiAKC2Rlc2NyaXB0aW9uGAUgASgJQgu6SAhyBsizrrECARIcCgduZXR3b3JrGAYgASgJQgu6SAhyBsCzrrECARIZCgdwcm9qZWN0GAcgASgJQgi6SAVyA7ABARIxCgR0eXBlGAggASgOMhkubWV0YWxzdGFjay5hcGkudjIuSVBUeXBlQgi6SAWCAQIQARIgCgluYW1lc3BhY2UYCSABKAlCCLpIBXIDsAEBSACIAQFCDAoKX25hbWVzcGFjZSJ1ChNJUFNlcnZpY2VHZXRSZXF1ZXN0EhMKAmlwGAEgASgJQge6SARyAnABEhkKB3Byb2plY3QYAiABKAlCCLpIBXIDsAEBEiAKCW5hbWVzcGFjZRgDIAEoCUIIukgFcgOwAQFIAIgBAUIMCgpfbmFtZXNwYWNlItgDChZJUFNlcnZpY2VDcmVhdGVSZXF1ZXN0EhwKB25ldHdvcmsYASABKAlCC7pICHIGwLOusQIBEhkKB3Byb2plY3QYAiABKAlCCLpIBXIDsAEBEh4KBG5hbWUYAyABKAlCC7pICHIGwLOusQIBSACIAQESJQoLZGVzY3JpcHRpb24YBCABKAlCC7pICHIGyLOusQIBSAGIAQESGAoCaXAYBSABKAlCB7pIBHICcAFIAogBARIeCgdtYWNoaW5lGAYgASgJQgi6SAVyA7ABAUgDiAEBEi4KBmxhYmVscxgHIAEoCzIZLm1ldGFsc3RhY2suYXBpLnYyLkxhYmVsc0gEiAEBEjYKBHR5cGUYCCABKA4yGS5tZXRhbHN0YWNrLmFwaS52Mi5JUFR5cGVCCLpIBYIBAhABSAWIAQESSQoOYWRkcmVzc19mYW1pbHkYCSABKA4yIi5tZXRhbHN0YWNrLmFwaS52Mi5JUEFkZHJlc3NGYW1pbHlCCLpIBYIBAhABSAaIAQFCBwoFX25hbWVCDgoMX2Rlc2NyaXB0aW9uQgUKA19pcEIKCghfbWFjaGluZUIJCgdfbGFiZWxzQgcKBV90eXBlQhEKD19hZGRyZXNzX2ZhbWlseSLmAgoWSVBTZXJ2aWNlVXBkYXRlUmVxdWVzdBITCgJpcBgBIAEoCUIHukgEcgJwARI6Cgt1cGRhdGVfbWV0YRgCIAEoCzIdLm1ldGFsc3RhY2suYXBpLnYyLlVwZGF0ZU1ldGFCBrpIA8gBARIZCgdwcm9qZWN0GAMgASgJQgi6SAVyA7ABARIeCgRuYW1lGAQgASgJQgu6SAhyBsCzrrECAUgAiAEBEiUKC2Rlc2NyaXB0aW9uGAUgASgJQgu6SAhyBsizrrECAUgBiAEBEjYKBHR5cGUYBiABKA4yGS5tZXRhbHN0YWNrLmFwaS52Mi5JUFR5cGVCCLpIBYIBAhABSAKIAQESNAoGbGFiZWxzGAcgASgLMh8ubWV0YWxzdGFjay5hcGkudjIuVXBkYXRlTGFiZWxzSAOIAQFCBwoFX25hbWVCDgoMX2Rlc2NyaXB0aW9uQgcKBV90eXBlQgkKB19sYWJlbHMiXAoUSVBTZXJ2aWNlTGlzdFJlcXVlc3QSGQoHcHJvamVjdBgBIAEoCUIIukgFcgOwAQESKQoFcXVlcnkYAiABKAsyGi5tZXRhbHN0YWNrLmFwaS52Mi5JUFF1ZXJ5IswECgdJUFF1ZXJ5EhgKAmlwGAEgASgJQge6SARyAnABSACIAQESIQoHbmV0d29yaxgCIAEoCUILukgIcgbAs66xAgFIAYgBARIeCgdwcm9qZWN0GAMgASgJQgi6SAVyA7ABAUgCiAEBEh4KBG5hbWUYBCABKAlCC7pICHIGwLOusQIBSAOIAQESGwoEdXVpZBgFIAEoCUIIukgFcgOwAQFIBIgBARIeCgdtYWNoaW5lGAYgASgJQgi6SAVyA7ABAUgFiAEBEikKEnBhcmVudF9wcmVmaXhfY2lkchgHIAEoCUIIukgFcgPoAQFIBogBARIuCgZsYWJlbHMYCCABKAsyGS5tZXRhbHN0YWNrLmFwaS52Mi5MYWJlbHNIB4gBARI2CgR0eXBlGAkgASgOMhkubWV0YWxzdGFjay5hcGkudjIuSVBUeXBlQgi6SAWCAQIQAUgIiAEBEkkKDmFkZHJlc3NfZmFtaWx5GAogASgOMiIubWV0YWxzdGFjay5hcGkudjIuSVBBZGRyZXNzRmFtaWx5Qgi6SAWCAQIQAUgJiAEBEiAKCW5hbWVzcGFjZRgLIAEoCUIIukgFcgOwAQFICogBAUIFCgNfaXBCCgoIX25ldHdvcmtCCgoIX3Byb2plY3RCBwoFX25hbWVCBwoFX3V1aWRCCgoIX21hY2hpbmVCFQoTX3BhcmVudF9wcmVmaXhfY2lkckIJCgdfbGFiZWxzQgcKBV90eXBlQhEKD19hZGRyZXNzX2ZhbWlseUIMCgpfbmFtZXNwYWNlIkgKFklQU2VydmljZURlbGV0ZVJlcXVlc3QSEwoCaXAYASABKAlCB7pIBHICcAESGQoHcHJvamVjdBgCIAEoCUIIukgFcgOwAQEiOQoUSVBTZXJ2aWNlR2V0UmVzcG9uc2USIQoCaXAYASABKAsyFS5tZXRhbHN0YWNrLmFwaS52Mi5JUCI8ChdJUFNlcnZpY2VVcGRhdGVSZXNwb25zZRIhCgJpcBgBIAEoCzIVLm1ldGFsc3RhY2suYXBpLnYyLklQIjwKF0lQU2VydmljZUNyZWF0ZVJlc3BvbnNlEiEKAmlwGAEgASgLMhUubWV0YWxzdGFjay5hcGkudjIuSVAiOwoVSVBTZXJ2aWNlTGlzdFJlc3BvbnNlEiIKA2lwcxgBIAMoCzIVLm1ldGFsc3RhY2suYXBpLnYyLklQIjwKF0lQU2VydmljZURlbGV0ZVJlc3BvbnNlEiEKAmlwGAEgASgLMhUubWV0YWxzdGFjay5hcGkudjIuSVAqZwoGSVBUeXBlEhcKE0lQX1RZUEVfVU5TUEVDSUZJRUQQABIkChFJUF9UWVBFX0VQSEVNRVJBTBABGg2CshkJZXBoZW1lcmFsEh4KDklQX1RZUEVfU1RBVElDEAIaCoKyGQZzdGF0aWMqfAoPSVBBZGRyZXNzRmFtaWx5EiEKHUlQX0FERFJFU1NfRkFNSUxZX1VOU1BFQ0lGSUVEEAASIgoUSVBfQUREUkVTU19GQU1JTFlfVjQQARoIgrIZBGlwdjQSIgoUSVBfQUREUkVTU19GQU1JTFlfVjYQAhoIgrIZBGlwdjYynwQKCUlQU2VydmljZRJjCgNHZXQSJi5tZXRhbHN0YWNrLmFwaS52Mi5JUFNlcnZpY2VHZXRSZXF1ZXN0GicubWV0YWxzdGFjay5hcGkudjIuSVBTZXJ2aWNlR2V0UmVzcG9uc2UiC8rzGAMBAgPg8xgCEmsKBkNyZWF0ZRIpLm1ldGFsc3RhY2suYXBpLnYyLklQU2VydmljZUNyZWF0ZVJlcXVlc3QaKi5tZXRhbHN0YWNrLmFwaS52Mi5JUFNlcnZpY2VDcmVhdGVSZXNwb25zZSIKyvMYAgEC4PMYARJrCgZVcGRhdGUSKS5tZXRhbHN0YWNrLmFwaS52Mi5JUFNlcnZpY2VVcGRhdGVSZXF1ZXN0GioubWV0YWxzdGFjay5hcGkudjIuSVBTZXJ2aWNlVXBkYXRlUmVzcG9uc2UiCsrzGAIBAuDzGAESZgoETGlzdBInLm1ldGFsc3RhY2suYXBpLnYyLklQU2VydmljZUxpc3RSZXF1ZXN0GigubWV0YWxzdGFjay5hcGkudjIuSVBTZXJ2aWNlTGlzdFJlc3BvbnNlIgvK8xgDAQID4PMYAhJrCgZEZWxldGUSKS5tZXRhbHN0YWNrLmFwaS52Mi5JUFNlcnZpY2VEZWxldGVSZXF1ZXN0GioubWV0YWxzdGFjay5hcGkudjIuSVBTZXJ2aWNlRGVsZXRlUmVzcG9uc2UiCsrzGAIBAuDzGAFCvQEKFWNvbS5tZXRhbHN0YWNrLmFwaS52MkIHSXBQcm90b1ABWjVnaXRodWIuY29tL21ldGFsLXN0YWNrL2FwaS9nby9tZXRhbHN0YWNrL2FwaS92MjthcGl2MqICA01BWKoCEU1ldGFsc3RhY2suQXBpLlYyygIRTWV0YWxzdGFja1xBcGlcVjLiAh1NZXRhbHN0YWNrXEFwaVxWMlxHUEJNZXRhZGF0YeoCE01ldGFsc3RhY2s6OkFwaTo6VjJiBnByb3RvMw", [file_buf_validate_validate, file_metalstack_api_v2_common, file_metalstack_api_v2_predefined_rules]); /** - * IP is a ip address which can be used as loadbalancer addresses + * IP is an IP address which can be used as loadbalancer addresses * * @generated from message metalstack.api.v2.IP */ @@ -95,7 +95,7 @@ export const IPSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_ip, 0); /** - * IPServiceGetRequest is the request payload for a ip get request + * IPServiceGetRequest is the request payload for an IP get request * * @generated from message metalstack.api.v2.IPServiceGetRequest */ @@ -130,7 +130,7 @@ export const IPServiceGetRequestSchema: GenMessage = /*@__P messageDesc(file_metalstack_api_v2_ip, 1); /** - * IPServiceCreateRequest is the request payload for a ip create request + * IPServiceCreateRequest is the request payload for an IP create request * * @generated from message metalstack.api.v2.IPServiceCreateRequest */ @@ -207,7 +207,7 @@ export const IPServiceCreateRequestSchema: GenMessage = messageDesc(file_metalstack_api_v2_ip, 2); /** - * IPServiceUpdateRequest is the request payload for a ip update request + * IPServiceUpdateRequest is the request payload for an IP update request * * @generated from message metalstack.api.v2.IPServiceUpdateRequest */ @@ -270,7 +270,7 @@ export const IPServiceUpdateRequestSchema: GenMessage = messageDesc(file_metalstack_api_v2_ip, 3); /** - * IPServiceListRequest is the request payload for a ip list request + * IPServiceListRequest is the request payload for an IP list request * * @generated from message metalstack.api.v2.IPServiceListRequest */ @@ -283,7 +283,7 @@ export type IPServiceListRequest = Message<"metalstack.api.v2.IPServiceListReque project: string; /** - * Query to list one ore more ips + * Query to list one or more IPs * * @generated from field: metalstack.api.v2.IPQuery query = 2; */ @@ -311,7 +311,7 @@ export type IPQuery = Message<"metalstack.api.v2.IPQuery"> & { ip?: string | undefined; /** - * Network from where the ips to list + * Network from which the IPs are to list * * @generated from field: optional string network = 2; */ @@ -332,14 +332,14 @@ export type IPQuery = Message<"metalstack.api.v2.IPQuery"> & { name?: string | undefined; /** - * Uuid for which this ips should get filtered + * UUID for which these IPs should be filtered * * @generated from field: optional string uuid = 5; */ uuid?: string | undefined; /** - * Machine for which this ips should get filtered + * Machine for which these IPs should be filtered * * @generated from field: optional string machine = 6; */ @@ -353,7 +353,7 @@ export type IPQuery = Message<"metalstack.api.v2.IPQuery"> & { parentPrefixCidr?: string | undefined; /** - * Labels for which this ips should get filtered + * Labels for which these IPs should be filtered * * @generated from field: optional metalstack.api.v2.Labels labels = 8; */ @@ -367,7 +367,7 @@ export type IPQuery = Message<"metalstack.api.v2.IPQuery"> & { type?: IPType | undefined; /** - * Addressfamily of the IPs to list, defaults to all addressfamilies + * Address family of the IPs to list, defaults to all address families * * @generated from field: optional metalstack.api.v2.IPAddressFamily address_family = 10; */ @@ -417,7 +417,7 @@ export const IPServiceDeleteRequestSchema: GenMessage = messageDesc(file_metalstack_api_v2_ip, 6); /** - * IPServiceGetResponse is the response payload for a ip get request + * IPServiceGetResponse is the response payload for an IP get request * * @generated from message metalstack.api.v2.IPServiceGetResponse */ @@ -459,7 +459,7 @@ export const IPServiceUpdateResponseSchema: GenMessage messageDesc(file_metalstack_api_v2_ip, 8); /** - * IPServiceCreateResponse is the response payload for a ip create request + * IPServiceCreateResponse is the response payload for an IP create request * * @generated from message metalstack.api.v2.IPServiceCreateResponse */ @@ -480,7 +480,7 @@ export const IPServiceCreateResponseSchema: GenMessage messageDesc(file_metalstack_api_v2_ip, 9); /** - * IPServiceListResponse is the response payload for a ip list request + * IPServiceListResponse is the response payload for an IP list request * * @generated from message metalstack.api.v2.IPServiceListResponse */ @@ -501,7 +501,7 @@ export const IPServiceListResponseSchema: GenMessage = /* messageDesc(file_metalstack_api_v2_ip, 10); /** - * IPServiceDeleteResponse is the response payload for a ip delete request + * IPServiceDeleteResponse is the response payload for an IP delete request * * @generated from message metalstack.api.v2.IPServiceDeleteResponse */ @@ -522,7 +522,7 @@ export const IPServiceDeleteResponseSchema: GenMessage messageDesc(file_metalstack_api_v2_ip, 11); /** - * IPType specifies different ip address types + * IPType specifies different IP address types * * @generated from enum metalstack.api.v2.IPType */ @@ -535,7 +535,7 @@ export enum IPType { IP_TYPE_UNSPECIFIED = 0, /** - * IP_TYPE_EPHEMERAL defines a ephemeral ip address which is freed/deleted after usage + * IP_TYPE_EPHEMERAL defines an ephemeral IP address which is freed/deleted after usage * * @generated from enum value: IP_TYPE_EPHEMERAL = 1; */ diff --git a/js/metalstack/api/v2/machine_pb.d.ts b/js/metalstack/api/v2/machine_pb.d.ts index 16d9a6f7..1ca05c22 100644 --- a/js/metalstack/api/v2/machine_pb.d.ts +++ b/js/metalstack/api/v2/machine_pb.d.ts @@ -1131,7 +1131,7 @@ export type MachineBMCReport = Message<"metalstack.api.v2.MachineBMCReport"> & { */ bios?: MachineBios | undefined; /** - * Fru containers field replaceable unit details + * Fru contains field replaceable unit details * * @generated from field: metalstack.api.v2.MachineFRU fru = 3; */ @@ -1185,7 +1185,7 @@ export type MachineBios = Message<"metalstack.api.v2.MachineBios"> & { */ vendor: string; /** - * Date the bios date as string because every vendor has different ideas howto describe the date + * Date the bios date as string because every vendor has different ideas how to describe the date * * @generated from field: string date = 3; */ @@ -1416,7 +1416,7 @@ export type MachineRecentProvisioningEvents = Message<"metalstack.api.v2.Machine */ export declare const MachineRecentProvisioningEventsSchema: GenMessage; /** - * MachineProvisioningEvent is a event which has occurred during provisioning + * MachineProvisioningEvent is an event that has occurred during provisioning * * @generated from message metalstack.api.v2.MachineProvisioningEvent */ @@ -1905,13 +1905,13 @@ export type MachineIssuesQuery = Message<"metalstack.api.v2.MachineIssuesQuery"> */ machineQuery?: MachineQuery | undefined; /** - * Only a list of machine issue types to include + * Only includes the specified machine issue types * * @generated from field: repeated metalstack.api.v2.MachineIssueType only = 2; */ only: MachineIssueType[]; /** - * Omit a list of machine issues to omit + * Omits the specified machine issues * * @generated from field: repeated metalstack.api.v2.MachineIssueType omit = 3; */ diff --git a/js/metalstack/api/v2/machine_pb.ts b/js/metalstack/api/v2/machine_pb.ts index 9d50498c..fd33e1b0 100644 --- a/js/metalstack/api/v2/machine_pb.ts +++ b/js/metalstack/api/v2/machine_pb.ts @@ -1333,7 +1333,7 @@ export type MachineBMCReport = Message<"metalstack.api.v2.MachineBMCReport"> & { bios?: MachineBios | undefined; /** - * Fru containers field replaceable unit details + * Fru contains field replaceable unit details * * @generated from field: metalstack.api.v2.MachineFRU fru = 3; */ @@ -1396,7 +1396,7 @@ export type MachineBios = Message<"metalstack.api.v2.MachineBios"> & { vendor: string; /** - * Date the bios date as string because every vendor has different ideas howto describe the date + * Date the bios date as string because every vendor has different ideas how to describe the date * * @generated from field: string date = 3; */ @@ -1665,7 +1665,7 @@ export const MachineRecentProvisioningEventsSchema: GenMessage machineQuery?: MachineQuery | undefined; /** - * Only a list of machine issue types to include + * Only includes the specified machine issue types * * @generated from field: repeated metalstack.api.v2.MachineIssueType only = 2; */ only: MachineIssueType[]; /** - * Omit a list of machine issues to omit + * Omits the specified machine issues * * @generated from field: repeated metalstack.api.v2.MachineIssueType omit = 3; */ diff --git a/js/metalstack/api/v2/network_pb.d.ts b/js/metalstack/api/v2/network_pb.d.ts index e48c5f68..5141c440 100644 --- a/js/metalstack/api/v2/network_pb.d.ts +++ b/js/metalstack/api/v2/network_pb.d.ts @@ -379,7 +379,7 @@ export type Network = Message<"metalstack.api.v2.Network"> & { */ destinationPrefixes: string[]; /** - * Default Child Prefix length defines the bitlength of a child network created per addressfamily, of not specified during the allocate request + * Default Child Prefix length defines the bit length of a child network created per address family, if not specified during the allocate request * * @generated from field: metalstack.api.v2.ChildPrefixLength default_child_prefix_length = 10; */ @@ -421,7 +421,7 @@ export type Network = Message<"metalstack.api.v2.Network"> & { */ additionalAnnouncableCidrs: string[]; /** - * Consumption of ips and prefixes in this networks + * Consumption of IPs and prefixes in this network * * @generated from field: metalstack.api.v2.NetworkConsumption consumption = 17; */ @@ -595,7 +595,7 @@ export type NetworkUsage = Message<"metalstack.api.v2.NetworkUsage"> & { */ usedIps: bigint; /** - * the total available 2 bit Prefixes + * the total available 2-bit prefixes * * @generated from field: uint64 available_prefixes = 3; */ diff --git a/js/metalstack/api/v2/network_pb.ts b/js/metalstack/api/v2/network_pb.ts index d2f9aae7..17674898 100644 --- a/js/metalstack/api/v2/network_pb.ts +++ b/js/metalstack/api/v2/network_pb.ts @@ -451,7 +451,7 @@ export type Network = Message<"metalstack.api.v2.Network"> & { destinationPrefixes: string[]; /** - * Default Child Prefix length defines the bitlength of a child network created per addressfamily, of not specified during the allocate request + * Default Child Prefix length defines the bit length of a child network created per address family, if not specified during the allocate request * * @generated from field: metalstack.api.v2.ChildPrefixLength default_child_prefix_length = 10; */ @@ -500,7 +500,7 @@ export type Network = Message<"metalstack.api.v2.Network"> & { additionalAnnouncableCidrs: string[]; /** - * Consumption of ips and prefixes in this networks + * Consumption of IPs and prefixes in this network * * @generated from field: metalstack.api.v2.NetworkConsumption consumption = 17; */ @@ -703,7 +703,7 @@ export type NetworkUsage = Message<"metalstack.api.v2.NetworkUsage"> & { usedIps: bigint; /** - * the total available 2 bit Prefixes + * the total available 2-bit prefixes * * @generated from field: uint64 available_prefixes = 3; */ diff --git a/js/metalstack/api/v2/partition_pb.d.ts b/js/metalstack/api/v2/partition_pb.d.ts index 6dadcf89..0ffba5ae 100644 --- a/js/metalstack/api/v2/partition_pb.d.ts +++ b/js/metalstack/api/v2/partition_pb.d.ts @@ -103,7 +103,7 @@ export type PartitionBootConfiguration = Message<"metalstack.api.v2.PartitionBoo */ kernelUrl: string; /** - * Commandline the cmdline to the kernel for the boot image + * Commandline the kernel command line for the boot image * * @generated from field: string commandline = 3; */ diff --git a/js/metalstack/api/v2/partition_pb.ts b/js/metalstack/api/v2/partition_pb.ts index 7c0fcf2e..ba629aac 100644 --- a/js/metalstack/api/v2/partition_pb.ts +++ b/js/metalstack/api/v2/partition_pb.ts @@ -129,7 +129,7 @@ export type PartitionBootConfiguration = Message<"metalstack.api.v2.PartitionBoo kernelUrl: string; /** - * Commandline the cmdline to the kernel for the boot image + * Commandline the kernel command line for the boot image * * @generated from field: string commandline = 3; */ diff --git a/js/metalstack/api/v2/project_pb.d.ts b/js/metalstack/api/v2/project_pb.d.ts index 1568161e..13aa78cd 100644 --- a/js/metalstack/api/v2/project_pb.d.ts +++ b/js/metalstack/api/v2/project_pb.d.ts @@ -56,7 +56,7 @@ export type Project = Message<"metalstack.api.v2.Project"> & { */ export declare const ProjectSchema: GenMessage; /** - * ProjectMember defines a user that participates at a project + * ProjectMember defines a user that participates in a project * * @generated from message metalstack.api.v2.ProjectMember */ @@ -136,13 +136,13 @@ export type ProjectInvite = Message<"metalstack.api.v2.ProjectInvite"> & { */ projectName: string; /** - * Tenant is the login of tenant who invites to join this project + * Tenant is the login of the tenant inviting another user to join this project * * @generated from field: string tenant = 6; */ tenant: string; /** - * TenantName is the name of tenant who invites to join this project + * TenantName is the name of the tenant inviting another user to join this project * * @generated from field: string tenant_name = 7; */ @@ -701,7 +701,7 @@ export type ProjectServiceInviteAcceptResponse = Message<"metalstack.api.v2.Proj */ project: string; /** - * ProjectName if the project joined + * ProjectName of the project joined * * @generated from field: string project_name = 2; */ @@ -814,7 +814,7 @@ export declare const ProjectService: GenService<{ output: typeof ProjectServiceLeaveResponseSchema; }; /** - * RemoveMember remove a user from a project + * RemoveMember removes a user from a project * * @generated from rpc metalstack.api.v2.ProjectService.RemoveMember */ @@ -824,7 +824,7 @@ export declare const ProjectService: GenService<{ output: typeof ProjectServiceRemoveMemberResponseSchema; }; /** - * UpdateMember update a user for a project + * UpdateMember updates a user for a project * * @generated from rpc metalstack.api.v2.ProjectService.UpdateMember */ @@ -844,7 +844,7 @@ export declare const ProjectService: GenService<{ output: typeof ProjectServiceInviteResponseSchema; }; /** - * InviteAccept is called from a user to accept a invitation + * InviteAccept is called by a user to accept an invitation * * @generated from rpc metalstack.api.v2.ProjectService.InviteAccept */ diff --git a/js/metalstack/api/v2/project_pb.ts b/js/metalstack/api/v2/project_pb.ts index 43c23e99..d6aa4b24 100644 --- a/js/metalstack/api/v2/project_pb.ts +++ b/js/metalstack/api/v2/project_pb.ts @@ -76,7 +76,7 @@ export const ProjectSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_project, 0); /** - * ProjectMember defines a user that participates at a project + * ProjectMember defines a user that participates in a project * * @generated from message metalstack.api.v2.ProjectMember */ @@ -168,14 +168,14 @@ export type ProjectInvite = Message<"metalstack.api.v2.ProjectInvite"> & { projectName: string; /** - * Tenant is the login of tenant who invites to join this project + * Tenant is the login of the tenant inviting another user to join this project * * @generated from field: string tenant = 6; */ tenant: string; /** - * TenantName is the name of tenant who invites to join this project + * TenantName is the name of the tenant inviting another user to join this project * * @generated from field: string tenant_name = 7; */ @@ -831,7 +831,7 @@ export type ProjectServiceInviteAcceptResponse = Message<"metalstack.api.v2.Proj project: string; /** - * ProjectName if the project joined + * ProjectName of the project joined * * @generated from field: string project_name = 2; */ @@ -955,7 +955,7 @@ export const ProjectService: GenService<{ output: typeof ProjectServiceLeaveResponseSchema; }, /** - * RemoveMember remove a user from a project + * RemoveMember removes a user from a project * * @generated from rpc metalstack.api.v2.ProjectService.RemoveMember */ @@ -965,7 +965,7 @@ export const ProjectService: GenService<{ output: typeof ProjectServiceRemoveMemberResponseSchema; }, /** - * UpdateMember update a user for a project + * UpdateMember updates a user for a project * * @generated from rpc metalstack.api.v2.ProjectService.UpdateMember */ @@ -985,7 +985,7 @@ export const ProjectService: GenService<{ output: typeof ProjectServiceInviteResponseSchema; }, /** - * InviteAccept is called from a user to accept a invitation + * InviteAccept is called by a user to accept an invitation * * @generated from rpc metalstack.api.v2.ProjectService.InviteAccept */ diff --git a/js/metalstack/api/v2/size_imageconstraint_pb.d.ts b/js/metalstack/api/v2/size_imageconstraint_pb.d.ts index cf850d83..40ef51e1 100644 --- a/js/metalstack/api/v2/size_imageconstraint_pb.d.ts +++ b/js/metalstack/api/v2/size_imageconstraint_pb.d.ts @@ -89,7 +89,7 @@ export type SizeImageConstraint = Message<"metalstack.api.v2.SizeImageConstraint */ export declare const SizeImageConstraintSchema: GenMessage; /** - * ImageConstraint defines a constraint for a image + * ImageConstraint defines a constraint for an image * examples: * images: * ubuntu: ">= 20.04.20211011" diff --git a/js/metalstack/api/v2/size_imageconstraint_pb.ts b/js/metalstack/api/v2/size_imageconstraint_pb.ts index ab0e630e..784062e5 100644 --- a/js/metalstack/api/v2/size_imageconstraint_pb.ts +++ b/js/metalstack/api/v2/size_imageconstraint_pb.ts @@ -115,7 +115,7 @@ export const SizeImageConstraintSchema: GenMessage = /*@__P messageDesc(file_metalstack_api_v2_size_imageconstraint, 2); /** - * ImageConstraint defines a constraint for a image + * ImageConstraint defines a constraint for an image * examples: * images: * ubuntu: ">= 20.04.20211011" diff --git a/js/metalstack/api/v2/size_reservation_pb.d.ts b/js/metalstack/api/v2/size_reservation_pb.d.ts index 42ad6a89..5a42328d 100644 --- a/js/metalstack/api/v2/size_reservation_pb.d.ts +++ b/js/metalstack/api/v2/size_reservation_pb.d.ts @@ -60,7 +60,7 @@ export declare const SizeReservationServiceListRequestSchema: GenMessage & { /** - * Size reservation + * Size reservation * * @generated from field: metalstack.api.v2.SizeReservation size_reservation = 1; */ diff --git a/js/metalstack/api/v2/size_reservation_pb.ts b/js/metalstack/api/v2/size_reservation_pb.ts index 01c4c878..03a6b91d 100644 --- a/js/metalstack/api/v2/size_reservation_pb.ts +++ b/js/metalstack/api/v2/size_reservation_pb.ts @@ -79,7 +79,7 @@ export const SizeReservationServiceListRequestSchema: GenMessage & { /** - * Size reservation + * Size reservation * * @generated from field: metalstack.api.v2.SizeReservation size_reservation = 1; */ diff --git a/js/metalstack/api/v2/tenant_pb.d.ts b/js/metalstack/api/v2/tenant_pb.d.ts index cd1ad887..0cacfd9f 100644 --- a/js/metalstack/api/v2/tenant_pb.d.ts +++ b/js/metalstack/api/v2/tenant_pb.d.ts @@ -61,7 +61,7 @@ export type Tenant = Message<"metalstack.api.v2.Tenant"> & { */ export declare const TenantSchema: GenMessage; /** - * TenantMember defines a user that participates at a tenant + * TenantMember defines a user that participates in a tenant * * @generated from message metalstack.api.v2.TenantMember */ @@ -79,7 +79,7 @@ export type TenantMember = Message<"metalstack.api.v2.TenantMember"> & { */ role: TenantRole; /** - * Projects for the projects in which a user is a direct member + * Projects in which a user is a direct member * * @generated from field: repeated string projects = 3; */ @@ -139,13 +139,13 @@ export type TenantInvite = Message<"metalstack.api.v2.TenantInvite"> & { */ targetTenantName: string; /** - * Tenant is the login of tenant who invites to join this tenant + * Tenant is the login of the tenant inviting another user to join this tenant * * @generated from field: string tenant = 6; */ tenant: string; /** - * TenantName is the name of tenant who invites to join this tenant + * TenantName is the name of the tenant inviting another user to join this tenant * * @generated from field: string tenant_name = 7; */ @@ -519,7 +519,7 @@ export declare const TenantServiceInvitesListRequestSchema: GenMessage & { /** - * Invites not already accepted the invitation to this tenant + * Invites that have not yet accepted the invitation to this tenant * * @generated from field: repeated metalstack.api.v2.TenantInvite invites = 1; */ @@ -812,7 +812,7 @@ export declare const TenantService: GenService<{ output: typeof TenantServiceDeleteResponseSchema; }; /** - * Leave remove a member of a tenant + * Leave removes a member from a tenant * * @generated from rpc metalstack.api.v2.TenantService.Leave */ @@ -822,7 +822,7 @@ export declare const TenantService: GenService<{ output: typeof TenantServiceLeaveResponseSchema; }; /** - * RemoveMember remove a member of a tenant + * RemoveMember removes a member from a tenant * * @generated from rpc metalstack.api.v2.TenantService.RemoveMember */ diff --git a/js/metalstack/api/v2/tenant_pb.ts b/js/metalstack/api/v2/tenant_pb.ts index d24dc54c..80bf79e9 100644 --- a/js/metalstack/api/v2/tenant_pb.ts +++ b/js/metalstack/api/v2/tenant_pb.ts @@ -82,7 +82,7 @@ export const TenantSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_tenant, 0); /** - * TenantMember defines a user that participates at a tenant + * TenantMember defines a user that participates in a tenant * * @generated from message metalstack.api.v2.TenantMember */ @@ -102,7 +102,7 @@ export type TenantMember = Message<"metalstack.api.v2.TenantMember"> & { role: TenantRole; /** - * Projects for the projects in which a user is a direct member + * Projects in which a user is a direct member * * @generated from field: repeated string projects = 3; */ @@ -172,14 +172,14 @@ export type TenantInvite = Message<"metalstack.api.v2.TenantInvite"> & { targetTenantName: string; /** - * Tenant is the login of tenant who invites to join this tenant + * Tenant is the login of the tenant inviting another user to join this tenant * * @generated from field: string tenant = 6; */ tenant: string; /** - * TenantName is the name of tenant who invites to join this tenant + * TenantName is the name of the tenant inviting another user to join this tenant * * @generated from field: string tenant_name = 7; */ @@ -615,7 +615,7 @@ export const TenantServiceInvitesListRequestSchema: GenMessage & { /** - * Invites not already accepted the invitation to this tenant + * Invites that have not yet accepted the invitation to this tenant * * @generated from field: repeated metalstack.api.v2.TenantInvite invites = 1; */ @@ -955,7 +955,7 @@ export const TenantService: GenService<{ output: typeof TenantServiceDeleteResponseSchema; }, /** - * Leave remove a member of a tenant + * Leave removes a member from a tenant * * @generated from rpc metalstack.api.v2.TenantService.Leave */ @@ -965,7 +965,7 @@ export const TenantService: GenService<{ output: typeof TenantServiceLeaveResponseSchema; }, /** - * RemoveMember remove a member of a tenant + * RemoveMember removes a member from a tenant * * @generated from rpc metalstack.api.v2.TenantService.RemoveMember */ diff --git a/js/metalstack/api/v2/token_pb.d.ts b/js/metalstack/api/v2/token_pb.d.ts index 3a461424..829a5552 100644 --- a/js/metalstack/api/v2/token_pb.d.ts +++ b/js/metalstack/api/v2/token_pb.d.ts @@ -147,7 +147,7 @@ export type TokenServiceCreateRequest = Message<"metalstack.api.v2.TokenServiceC [key: string]: ProjectRole; }; /** - * TenantRoles_associates a tenant id with the corresponding role of the token owner + * TenantRoles associates a tenant id with the corresponding role of the token owner * * @generated from field: map tenant_roles = 5; */ @@ -228,7 +228,7 @@ export type TokenServiceCreateResponse = Message<"metalstack.api.v2.TokenService */ token?: Token | undefined; /** - * Secret is the body if the jwt token, should be used in api requests as bearer token + * Secret is the body of the JWT token, should be used in API requests as bearer token * * @generated from field: string secret = 2; */ @@ -463,7 +463,7 @@ export type TokenServiceRefreshResponse = Message<"metalstack.api.v2.TokenServic */ token?: Token | undefined; /** - * Secret is the body if the jwt token, should be used in api requests as bearer token + * Secret is the body of the JWT token, should be used in API requests as bearer token * * @generated from field: string secret = 2; */ diff --git a/js/metalstack/api/v2/token_pb.ts b/js/metalstack/api/v2/token_pb.ts index 8fc729f8..51f0a9b2 100644 --- a/js/metalstack/api/v2/token_pb.ts +++ b/js/metalstack/api/v2/token_pb.ts @@ -170,7 +170,7 @@ export type TokenServiceCreateRequest = Message<"metalstack.api.v2.TokenServiceC projectRoles: { [key: string]: ProjectRole }; /** - * TenantRoles_associates a tenant id with the corresponding role of the token owner + * TenantRoles associates a tenant id with the corresponding role of the token owner * * @generated from field: map tenant_roles = 5; */ @@ -259,7 +259,7 @@ export type TokenServiceCreateResponse = Message<"metalstack.api.v2.TokenService token?: Token | undefined; /** - * Secret is the body if the jwt token, should be used in api requests as bearer token + * Secret is the body of the JWT token, should be used in API requests as bearer token * * @generated from field: string secret = 2; */ @@ -530,7 +530,7 @@ export type TokenServiceRefreshResponse = Message<"metalstack.api.v2.TokenServic token?: Token | undefined; /** - * Secret is the body if the jwt token, should be used in api requests as bearer token + * Secret is the body of the JWT token, should be used in API requests as bearer token * * @generated from field: string secret = 2; */ diff --git a/js/metalstack/api/v2/user_pb.d.ts b/js/metalstack/api/v2/user_pb.d.ts index 970edf12..ac82bc3e 100644 --- a/js/metalstack/api/v2/user_pb.d.ts +++ b/js/metalstack/api/v2/user_pb.d.ts @@ -49,7 +49,7 @@ export type User = Message<"metalstack.api.v2.User"> & { */ projects: Project[]; /** - * DefaultTenant this user belongs to + * DefaultTenant the default tenant that this user belongs to * * @generated from field: metalstack.api.v2.Tenant default_tenant = 7; */ diff --git a/js/metalstack/api/v2/user_pb.ts b/js/metalstack/api/v2/user_pb.ts index 3301536a..305818f5 100644 --- a/js/metalstack/api/v2/user_pb.ts +++ b/js/metalstack/api/v2/user_pb.ts @@ -68,7 +68,7 @@ export type User = Message<"metalstack.api.v2.User"> & { projects: Project[]; /** - * DefaultTenant this user belongs to + * DefaultTenant the default tenant that this user belongs to * * @generated from field: metalstack.api.v2.Tenant default_tenant = 7; */ diff --git a/js/metalstack/infra/v2/bmc_pb.d.ts b/js/metalstack/infra/v2/bmc_pb.d.ts index 48db9091..12e8ca3d 100644 --- a/js/metalstack/infra/v2/bmc_pb.d.ts +++ b/js/metalstack/infra/v2/bmc_pb.d.ts @@ -18,7 +18,7 @@ export type UpdateBMCInfoRequest = Message<"metalstack.infra.v2.UpdateBMCInfoReq */ partition: string; /** - * BmcReports contains maps the BMC report per machine UUID + * BmcReports maps the BMC report per machine UUID * * @generated from field: map bmc_reports = 2; */ diff --git a/js/metalstack/infra/v2/bmc_pb.ts b/js/metalstack/infra/v2/bmc_pb.ts index b98f6498..8eb8fd81 100644 --- a/js/metalstack/infra/v2/bmc_pb.ts +++ b/js/metalstack/infra/v2/bmc_pb.ts @@ -31,7 +31,7 @@ export type UpdateBMCInfoRequest = Message<"metalstack.infra.v2.UpdateBMCInfoReq partition: string; /** - * BmcReports contains maps the BMC report per machine UUID + * BmcReports maps the BMC report per machine UUID * * @generated from field: map bmc_reports = 2; */ diff --git a/js/metalstack/infra/v2/boot_pb.d.ts b/js/metalstack/infra/v2/boot_pb.d.ts index 2f22b563..0355e944 100644 --- a/js/metalstack/infra/v2/boot_pb.d.ts +++ b/js/metalstack/infra/v2/boot_pb.d.ts @@ -137,7 +137,7 @@ export type BootServiceRegisterRequest = Message<"metalstack.infra.v2.BootServic */ tags: string[]; /** - * MetalHammer version this machine was bootet into + * MetalHammer version this machine was booted into * * @generated from field: string metal_hammer_version = 7; */ diff --git a/js/metalstack/infra/v2/boot_pb.ts b/js/metalstack/infra/v2/boot_pb.ts index 3f19449b..b632006b 100644 --- a/js/metalstack/infra/v2/boot_pb.ts +++ b/js/metalstack/infra/v2/boot_pb.ts @@ -172,7 +172,7 @@ export type BootServiceRegisterRequest = Message<"metalstack.infra.v2.BootServic tags: string[]; /** - * MetalHammer version this machine was bootet into + * MetalHammer version this machine was booted into * * @generated from field: string metal_hammer_version = 7; */ diff --git a/proto/metalstack/admin/v2/filesystem.proto b/proto/metalstack/admin/v2/filesystem.proto index 3de4f36d..6353bd5a 100644 --- a/proto/metalstack/admin/v2/filesystem.proto +++ b/proto/metalstack/admin/v2/filesystem.proto @@ -88,8 +88,8 @@ message FilesystemServiceDeleteResponse { // FilesystemServiceMatchRequest message FilesystemServiceMatchRequest { - // Match either size and image to a filesystemlayout - // or if a machine matches to a filesystemlayout + // Match size and image to a filesystem layout + // or match a machine to a filesystem layout oneof match { // ensure at least one match is specified option (buf.validate.oneof).required = true; diff --git a/proto/metalstack/admin/v2/image.proto b/proto/metalstack/admin/v2/image.proto index 735659e5..b2f2652e 100644 --- a/proto/metalstack/admin/v2/image.proto +++ b/proto/metalstack/admin/v2/image.proto @@ -65,7 +65,7 @@ message ImageServiceUpdateRequest { // Classification of this image metalstack.api.v2.ImageClassification classification = 7 [(buf.validate.field).enum.defined_only = true]; - // ExpiresAt usage is not possible after this date + // ExpiresAt indicates that usage is not possible after this date google.protobuf.Timestamp expires_at = 8; } diff --git a/proto/metalstack/admin/v2/machine.proto b/proto/metalstack/admin/v2/machine.proto index b095af37..dc1e5e83 100644 --- a/proto/metalstack/admin/v2/machine.proto +++ b/proto/metalstack/admin/v2/machine.proto @@ -78,7 +78,7 @@ message MachineServiceGetResponse { // MachineServiceListRequest is the request payload for a machine list request message MachineServiceListRequest { - // Query to list one ore more machines + // Query to list one or more machines metalstack.api.v2.MachineQuery query = 1; // Partition for which machines should be listed, could be left empty if only one partition is present // otherwise an error is thrown that the partition must be specified @@ -130,7 +130,7 @@ message MachineServiceGetBMCResponse { // MachineServiceListBMCRequest is the request payload for a machine listbmc request message MachineServiceListBMCRequest { - // Query to list one ore more bmcs of many machines + // Query to list one or more BMCs of many machines metalstack.api.v2.MachineBMCQuery query = 1; } diff --git a/proto/metalstack/admin/v2/partition.proto b/proto/metalstack/admin/v2/partition.proto index ba54a5f7..21025a34 100644 --- a/proto/metalstack/admin/v2/partition.proto +++ b/proto/metalstack/admin/v2/partition.proto @@ -61,7 +61,7 @@ message PartitionServiceUpdateRequest { // PartitionServiceDeleteRequest is the request payload for a partition delete request message PartitionServiceDeleteRequest { - // ID of the partition to get + // ID of the partition to delete string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; } diff --git a/proto/metalstack/admin/v2/switch.proto b/proto/metalstack/admin/v2/switch.proto index ebd1cc95..4812cf80 100644 --- a/proto/metalstack/admin/v2/switch.proto +++ b/proto/metalstack/admin/v2/switch.proto @@ -145,7 +145,7 @@ message SwitchServiceMigrateRequest { // SwitchServiceMigrateResponse is the response payload for migrating a switch. message SwitchServiceMigrateResponse { - // Switch contains the switch was migrated to + // Switch contains the switch that was migrated to metalstack.api.v2.Switch switch = 1; } diff --git a/proto/metalstack/admin/v2/tenant.proto b/proto/metalstack/admin/v2/tenant.proto index 4a2e3ffd..ccb65a61 100644 --- a/proto/metalstack/admin/v2/tenant.proto +++ b/proto/metalstack/admin/v2/tenant.proto @@ -25,7 +25,7 @@ service TenantService { option (metalstack.api.v2.admin_roles) = ADMIN_ROLE_EDITOR; option (metalstack.api.v2.auditing) = AUDITING_INCLUDED; } - // RemoveMember remove a member of a tenant + // RemoveMember removes a member from a tenant rpc RemoveMember(TenantServiceRemoveMemberRequest) returns (TenantServiceRemoveMemberResponse) { option (metalstack.api.v2.admin_roles) = ADMIN_ROLE_EDITOR; option (metalstack.api.v2.auditing) = AUDITING_INCLUDED; diff --git a/proto/metalstack/api/v2/audit.proto b/proto/metalstack/api/v2/audit.proto index 549d3010..d5062a90 100644 --- a/proto/metalstack/api/v2/audit.proto +++ b/proto/metalstack/api/v2/audit.proto @@ -92,7 +92,7 @@ message AuditQuery { optional AuditPhase phase = 12 [(buf.validate.field).enum.defined_only = true]; } -// AuditServiceListRequest is the request payload for a audit list request +// AuditServiceListRequest is the request payload for an audit list request message AuditServiceListRequest { // Login for this tenant string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; diff --git a/proto/metalstack/api/v2/common.proto b/proto/metalstack/api/v2/common.proto index 3a8ebc0f..254ecb14 100644 --- a/proto/metalstack/api/v2/common.proto +++ b/proto/metalstack/api/v2/common.proto @@ -71,7 +71,7 @@ enum Visibility { VISIBILITY_UNSPECIFIED = 0; // VISIBILITY_PUBLIC specifies that this service is accessible without authentication VISIBILITY_PUBLIC = 1; - // VISIBILITY_SELF enable call this endpoint from the authenticated user only + // VISIBILITY_SELF restricts calls to the authenticated user only VISIBILITY_SELF = 2; } @@ -89,17 +89,17 @@ enum Auditing { // MethodOptions to specify specific annotations to methods extend google.protobuf.MethodOptions { - // TenantRoles are used to define which tenant role a logged in user must provide to call this method + // TenantRoles are used to define the tenant role a logged in user must provide to call this method repeated TenantRole tenant_roles = 51000; - // ProjectRoles are used to define which project role a logged in user must provide to call this method + // ProjectRoles are used to define the project role a logged in user must provide to call this method repeated ProjectRole project_roles = 51001; - // AdminRoles are used to define which admin role a logged in user must provide to call this method + // AdminRoles are used to define the admin role a logged in user must provide to call this method repeated AdminRole admin_roles = 51002; // Visibility defines the visibility of this method, this is used to have public or self visible methods Visibility visibility = 51003; // Auditing defines if calls to this method should be audited or not Auditing auditing = 51004; - // InfraRoles are used to define which infra role a microservice must provide to call this method + // InfraRoles are used to define the infra role a microservice must provide to call this method repeated InfraRole infra_roles = 51005; // MachineRole are used to define which machine role a microservice must provide to call this method repeated MachineRole machine_roles = 51006; diff --git a/proto/metalstack/api/v2/filesystem.proto b/proto/metalstack/api/v2/filesystem.proto index 15de03cf..f10b7f10 100644 --- a/proto/metalstack/api/v2/filesystem.proto +++ b/proto/metalstack/api/v2/filesystem.proto @@ -99,7 +99,7 @@ message Filesystem { min_len: 1 max_len: 4096 }]; - // Label optional label for this this filesystem + // Label an optional label for this filesystem optional string label = 6 [ (buf.validate.field).string.(metalstack.api.v2.is_name) = true, (buf.validate.field).string.(metalstack.api.v2.trimmed) = true @@ -163,12 +163,12 @@ message Raid { message DiskPartition { // Number partition number, will be appended to partitionprefix to create the final devicename uint32 number = 1; - // optional label for this this partition + // Label an optional label for this partition optional string label = 2 [ (buf.validate.field).string.(metalstack.api.v2.is_name) = true, (buf.validate.field).string.(metalstack.api.v2.trimmed) = true ]; - // Size size in mebibytes (MiB) of this partition" + // Size in mebibytes (MiB) of this partition uint64 size = 3; // GPTType the gpt partition table type of this partition optional GPTType gpt_type = 4 [ diff --git a/proto/metalstack/api/v2/image.proto b/proto/metalstack/api/v2/image.proto index 459b6c36..e92ecf37 100644 --- a/proto/metalstack/api/v2/image.proto +++ b/proto/metalstack/api/v2/image.proto @@ -26,19 +26,19 @@ service ImageService { } } -// ImageServiceGetRequest is the request payload for a image get request +// ImageServiceGetRequest is the request payload for an image get request message ImageServiceGetRequest { // ID of the image to get string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; } -// ImageServiceListRequest is the request payload for a image list request +// ImageServiceListRequest is the request payload for an image list request message ImageServiceListRequest { // Query for images ImageQuery query = 1; } -// ImageServiceLatestRequest is the request payload for a image latest request +// ImageServiceLatestRequest is the request payload for an image latest request message ImageServiceLatestRequest { // OS for which the latest image should be fetched // should contain os and major.minor then latest patch version of this os is returned @@ -47,19 +47,19 @@ message ImageServiceLatestRequest { optional ImageClassification classification = 2 [(buf.validate.field).enum.defined_only = true]; } -// ImageServiceGetResponse is the response payload for a image get request +// ImageServiceGetResponse is the response payload for an image get request message ImageServiceGetResponse { // Image the image Image image = 1; } -// ImageServiceListResponse is the response payload for a image list request +// ImageServiceListResponse is the response payload for an image list request message ImageServiceListResponse { // Images the images repeated Image images = 1; } -// ImageServiceLatestResponse is the response payload for a image latest request +// ImageServiceLatestResponse is the response payload for an image latest request message ImageServiceLatestResponse { // Image which is the latest for one os Image image = 1; diff --git a/proto/metalstack/api/v2/ip.proto b/proto/metalstack/api/v2/ip.proto index 676c4a53..a72b8068 100644 --- a/proto/metalstack/api/v2/ip.proto +++ b/proto/metalstack/api/v2/ip.proto @@ -42,11 +42,11 @@ service IPService { } } -// IPType specifies different ip address types +// IPType specifies different IP address types enum IPType { // IP_TYPE_UNSPECIFIED is not specified IP_TYPE_UNSPECIFIED = 0; - // IP_TYPE_EPHEMERAL defines a ephemeral ip address which is freed/deleted after usage + // IP_TYPE_EPHEMERAL defines an ephemeral IP address which is freed/deleted after usage IP_TYPE_EPHEMERAL = 1 [(enum_string_value) = "ephemeral"]; // IP_TYPE_STATIC defines a static ip address which must be freed/deleted explicitly IP_TYPE_STATIC = 2 [(enum_string_value) = "static"]; @@ -62,7 +62,7 @@ enum IPAddressFamily { IP_ADDRESS_FAMILY_V6 = 2 [(enum_string_value) = "ipv6"]; } -// IP is a ip address which can be used as loadbalancer addresses +// IP is an IP address which can be used as loadbalancer addresses message IP { // Uuid of this ip string uuid = 1 [(buf.validate.field).string.uuid = true]; @@ -85,7 +85,7 @@ message IP { optional string namespace = 9 [(buf.validate.field).string.uuid = true]; } -// IPServiceGetRequest is the request payload for a ip get request +// IPServiceGetRequest is the request payload for an IP get request message IPServiceGetRequest { // IP of the ip to get string ip = 1 [(buf.validate.field).string.ip = true]; @@ -95,7 +95,7 @@ message IPServiceGetRequest { optional string namespace = 3 [(buf.validate.field).string.uuid = true]; } -// IPServiceCreateRequest is the request payload for a ip create request +// IPServiceCreateRequest is the request payload for an IP create request message IPServiceCreateRequest { // Network from which the IP should be created string network = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; @@ -117,7 +117,7 @@ message IPServiceCreateRequest { optional IPAddressFamily address_family = 9 [(buf.validate.field).enum.defined_only = true]; } -// IPServiceUpdateRequest is the request payload for a ip update request +// IPServiceUpdateRequest is the request payload for an IP update request message IPServiceUpdateRequest { // Ip the ip address to update string ip = 1 [(buf.validate.field).string.ip = true]; @@ -135,11 +135,11 @@ message IPServiceUpdateRequest { optional UpdateLabels labels = 7; } -// IPServiceListRequest is the request payload for a ip list request +// IPServiceListRequest is the request payload for an IP list request message IPServiceListRequest { // Project of the ips to list string project = 1 [(buf.validate.field).string.uuid = true]; - // Query to list one ore more ips + // Query to list one or more IPs IPQuery query = 2; } @@ -147,23 +147,23 @@ message IPServiceListRequest { message IPQuery { // Ip the ip to list optional string ip = 1 [(buf.validate.field).string.ip = true]; - // Network from where the ips to list + // Network from which the IPs are to list optional string network = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // Project of the ips to list optional string project = 3 [(buf.validate.field).string.uuid = true]; // Name of this ip optional string name = 4 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Uuid for which this ips should get filtered + // UUID for which these IPs should be filtered optional string uuid = 5 [(buf.validate.field).string.uuid = true]; - // Machine for which this ips should get filtered + // Machine for which these IPs should be filtered optional string machine = 6 [(buf.validate.field).string.uuid = true]; // ParentPrefixCidr for which this ips should get filtered optional string parent_prefix_cidr = 7 [(buf.validate.field).string.ip_prefix = true]; - // Labels for which this ips should get filtered + // Labels for which these IPs should be filtered optional Labels labels = 8; // Static if set to true, this will be a Static ip optional IPType type = 9 [(buf.validate.field).enum.defined_only = true]; - // Addressfamily of the IPs to list, defaults to all addressfamilies + // Address family of the IPs to list, defaults to all address families optional IPAddressFamily address_family = 10 [(buf.validate.field).enum.defined_only = true]; // Namespace can be specified to get the ip of a namespace. optional string namespace = 11 [(buf.validate.field).string.uuid = true]; @@ -177,7 +177,7 @@ message IPServiceDeleteRequest { string project = 2 [(buf.validate.field).string.uuid = true]; } -// IPServiceGetResponse is the response payload for a ip get request +// IPServiceGetResponse is the response payload for an IP get request message IPServiceGetResponse { // Ip the ip IP ip = 1; @@ -189,19 +189,19 @@ message IPServiceUpdateResponse { IP ip = 1; } -// IPServiceCreateResponse is the response payload for a ip create request +// IPServiceCreateResponse is the response payload for an IP create request message IPServiceCreateResponse { // Ip the ip IP ip = 1; } -// IPServiceListResponse is the response payload for a ip list request +// IPServiceListResponse is the response payload for an IP list request message IPServiceListResponse { // Ips the ips repeated IP ips = 1; } -// IPServiceDeleteResponse is the response payload for a ip delete request +// IPServiceDeleteResponse is the response payload for an IP delete request message IPServiceDeleteResponse { // Ip the ip IP ip = 1; diff --git a/proto/metalstack/api/v2/machine.proto b/proto/metalstack/api/v2/machine.proto index 2efe17e9..ea63c09e 100644 --- a/proto/metalstack/api/v2/machine.proto +++ b/proto/metalstack/api/v2/machine.proto @@ -515,7 +515,7 @@ message MachineBMCReport { MachineBMC bmc = 1; // Bios contains bios details MachineBios bios = 2; - // Fru containers field replaceable unit details + // Fru contains field replaceable unit details MachineFRU fru = 3; // PowerMetric contains the power statistics of the machine MachinePowerMetric power_metric = 4; @@ -533,7 +533,7 @@ message MachineBios { string version = 1 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; // Vendor the bios vendor string vendor = 2 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Date the bios date as string because every vendor has different ideas howto describe the date + // Date the bios date as string because every vendor has different ideas how to describe the date string date = 3 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; } @@ -654,7 +654,7 @@ enum MachineProvisioningEventType { MACHINE_PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM = 11 [(enum_string_value) = "Machine Reclaim"]; } -// MachineProvisioningEvent is a event which has occurred during provisioning +// MachineProvisioningEvent is an event that has occurred during provisioning message MachineProvisioningEvent { // Time the time that this event was received google.protobuf.Timestamp time = 1; @@ -893,9 +893,9 @@ message MachineHardwareQuery { message MachineIssuesQuery { // MachineQuery to select specific machines metalstack.api.v2.MachineQuery machine_query = 1; - // Only a list of machine issue types to include + // Only includes the specified machine issue types repeated MachineIssueType only = 2 [(buf.validate.field).repeated = {items: {enum: {defined_only: true}}}]; - // Omit a list of machine issues to omit + // Omits the specified machine issues repeated MachineIssueType omit = 3 [(buf.validate.field).repeated = {items: {enum: {defined_only: true}}}]; // Severity filters issue for given severity optional MachineIssueSeverity severity = 4 [(buf.validate.field).enum.defined_only = true]; diff --git a/proto/metalstack/api/v2/network.proto b/proto/metalstack/api/v2/network.proto index fc1ea2cd..519a00af 100644 --- a/proto/metalstack/api/v2/network.proto +++ b/proto/metalstack/api/v2/network.proto @@ -183,7 +183,7 @@ message Network { repeated string prefixes = 8 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; // Destination Prefixes in this network repeated string destination_prefixes = 9 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; - // Default Child Prefix length defines the bitlength of a child network created per addressfamily, of not specified during the allocate request + // Default Child Prefix length defines the bit length of a child network created per address family, if not specified during the allocate request ChildPrefixLength default_child_prefix_length = 10; // Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length ChildPrefixLength min_child_prefix_length = 11; @@ -197,7 +197,7 @@ message Network { optional string parent_network = 15 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced repeated string additional_announcable_cidrs = 16 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; - // Consumption of ips and prefixes in this networks + // Consumption of IPs and prefixes in this network NetworkConsumption consumption = 17; } @@ -261,7 +261,7 @@ message NetworkUsage { uint64 available_ips = 1; // the total used IPs uint64 used_ips = 2; - // the total available 2 bit Prefixes + // the total available 2-bit prefixes uint64 available_prefixes = 3; // the total used Prefixes uint64 used_prefixes = 4; diff --git a/proto/metalstack/api/v2/partition.proto b/proto/metalstack/api/v2/partition.proto index da1a16fe..8b9eab57 100644 --- a/proto/metalstack/api/v2/partition.proto +++ b/proto/metalstack/api/v2/partition.proto @@ -53,7 +53,7 @@ message PartitionBootConfiguration { string image_url = 1 [(buf.validate.field).string.(metalstack.api.v2.is_uri) = true]; // KernelURL the url to download the kernel for the boot image string kernel_url = 2 [(buf.validate.field).string.(metalstack.api.v2.is_uri) = true]; - // Commandline the cmdline to the kernel for the boot image + // Commandline the kernel command line for the boot image string commandline = 3 [(buf.validate.field).string.max_len = 4096]; } diff --git a/proto/metalstack/api/v2/project.proto b/proto/metalstack/api/v2/project.proto index 24aa49be..cfb49f0b 100644 --- a/proto/metalstack/api/v2/project.proto +++ b/proto/metalstack/api/v2/project.proto @@ -43,12 +43,12 @@ service ProjectService { option (project_roles) = PROJECT_ROLE_VIEWER; option (auditing) = AUDITING_INCLUDED; } - // RemoveMember remove a user from a project + // RemoveMember removes a user from a project rpc RemoveMember(ProjectServiceRemoveMemberRequest) returns (ProjectServiceRemoveMemberResponse) { option (project_roles) = PROJECT_ROLE_OWNER; option (auditing) = AUDITING_INCLUDED; } - // UpdateMember update a user for a project + // UpdateMember updates a user for a project rpc UpdateMember(ProjectServiceUpdateMemberRequest) returns (ProjectServiceUpdateMemberResponse) { option (project_roles) = PROJECT_ROLE_OWNER; option (auditing) = AUDITING_INCLUDED; @@ -58,7 +58,7 @@ service ProjectService { option (project_roles) = PROJECT_ROLE_OWNER; option (auditing) = AUDITING_INCLUDED; } - // InviteAccept is called from a user to accept a invitation + // InviteAccept is called by a user to accept an invitation rpc InviteAccept(ProjectServiceInviteAcceptRequest) returns (ProjectServiceInviteAcceptResponse) { option (visibility) = VISIBILITY_SELF; option (auditing) = AUDITING_INCLUDED; @@ -97,7 +97,7 @@ message Project { optional string avatar_url = 6 [(buf.validate.field).string.(metalstack.api.v2.is_uri) = true]; } -// ProjectMember defines a user that participates at a project +// ProjectMember defines a user that participates in a project message ProjectMember { // Id is the user id of the member string id = 1; @@ -125,9 +125,9 @@ message ProjectInvite { bool joined = 4; // ProjectName is the project name for which this invite was created string project_name = 5; - // Tenant is the login of tenant who invites to join this project + // Tenant is the login of the tenant inviting another user to join this project string tenant = 6; - // TenantName is the name of tenant who invites to join this project + // TenantName is the name of the tenant inviting another user to join this project string tenant_name = 7; // ExpiresAt the date when this invite expires google.protobuf.Timestamp expires_at = 8; @@ -315,7 +315,7 @@ message ProjectServiceInviteAcceptRequest { message ProjectServiceInviteAcceptResponse { // Project ID of the project joined string project = 1; - // ProjectName if the project joined + // ProjectName of the project joined string project_name = 2; } diff --git a/proto/metalstack/api/v2/size_imageconstraint.proto b/proto/metalstack/api/v2/size_imageconstraint.proto index cffaf972..ebc7ee43 100644 --- a/proto/metalstack/api/v2/size_imageconstraint.proto +++ b/proto/metalstack/api/v2/size_imageconstraint.proto @@ -46,7 +46,7 @@ message SizeImageConstraint { optional string description = 5 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; } -// ImageConstraint defines a constraint for a image +// ImageConstraint defines a constraint for an image // examples: // images: // ubuntu: ">= 20.04.20211011" diff --git a/proto/metalstack/api/v2/size_reservation.proto b/proto/metalstack/api/v2/size_reservation.proto index 8667fa67..c2d9064a 100644 --- a/proto/metalstack/api/v2/size_reservation.proto +++ b/proto/metalstack/api/v2/size_reservation.proto @@ -42,7 +42,7 @@ message SizeReservationServiceListRequest { // SizeReservationServiceGetResponse is the response payload for a size reservation get request message SizeReservationServiceGetResponse { - // Size reservation + // Size reservation SizeReservation size_reservation = 1; } diff --git a/proto/metalstack/api/v2/tenant.proto b/proto/metalstack/api/v2/tenant.proto index e0106e15..4a318de0 100644 --- a/proto/metalstack/api/v2/tenant.proto +++ b/proto/metalstack/api/v2/tenant.proto @@ -40,13 +40,13 @@ service TenantService { option (auditing) = AUDITING_INCLUDED; } - // Leave remove a member of a tenant + // Leave removes a member from a tenant rpc Leave(TenantServiceLeaveRequest) returns (TenantServiceLeaveResponse) { option (tenant_roles) = TENANT_ROLE_VIEWER; option (auditing) = AUDITING_INCLUDED; } - // RemoveMember remove a member of a tenant + // RemoveMember removes a member from a tenant rpc RemoveMember(TenantServiceRemoveMemberRequest) returns (TenantServiceRemoveMemberResponse) { option (tenant_roles) = TENANT_ROLE_OWNER; option (auditing) = AUDITING_INCLUDED; @@ -103,13 +103,13 @@ message Tenant { string created_by = 7; } -// TenantMember defines a user that participates at a tenant +// TenantMember defines a user that participates in a tenant message TenantMember { // Id is the user id of the member string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; // Role is the role of the member TenantRole role = 2 [(buf.validate.field).enum.defined_only = true]; - // Projects for the projects in which a user is a direct member + // Projects in which a user is a direct member repeated string projects = 3; // CreatedAt the date when the member was added to the tenant google.protobuf.Timestamp created_at = 4; @@ -129,9 +129,9 @@ message TenantInvite { bool joined = 4; // TargetTenantName is the tenant name for which this invite was created string target_tenant_name = 5; - // Tenant is the login of tenant who invites to join this tenant + // Tenant is the login of the tenant inviting another user to join this tenant string tenant = 6; - // TenantName is the name of tenant who invites to join this tenant + // TenantName is the name of the tenant inviting another user to join this tenant string tenant_name = 7; // ExpiresAt the date when this invite expires google.protobuf.Timestamp expires_at = 8; @@ -257,7 +257,7 @@ message TenantServiceInvitesListRequest { // TenantServiceInvitesListResponse is the response payload to a list invites request message TenantServiceInvitesListResponse { - // Invites not already accepted the invitation to this tenant + // Invites that have not yet accepted the invitation to this tenant repeated TenantInvite invites = 1; } diff --git a/proto/metalstack/api/v2/token.proto b/proto/metalstack/api/v2/token.proto index 4dcdadf8..2a516584 100644 --- a/proto/metalstack/api/v2/token.proto +++ b/proto/metalstack/api/v2/token.proto @@ -119,7 +119,7 @@ message TokenServiceCreateRequest { }, (buf.validate.field).map.(metalstack.api.v2.keys_trimmed) = true ]; - // TenantRoles_associates a tenant id with the corresponding role of the token owner + // TenantRoles associates a tenant id with the corresponding role of the token owner map tenant_roles = 5 [ (buf.validate.field).map = { keys: { @@ -167,7 +167,7 @@ message MethodPermission { message TokenServiceCreateResponse { // Token which was created Token token = 1; - // Secret is the body if the jwt token, should be used in api requests as bearer token + // Secret is the body of the JWT token, should be used in API requests as bearer token string secret = 2; } @@ -269,7 +269,7 @@ message TokenServiceRefreshRequest {} message TokenServiceRefreshResponse { // Token which was refreshed Token token = 1; - // Secret is the body if the jwt token, should be used in api requests as bearer token + // Secret is the body of the JWT token, should be used in API requests as bearer token string secret = 2; } diff --git a/proto/metalstack/api/v2/user.proto b/proto/metalstack/api/v2/user.proto index feab2159..5be7159b 100644 --- a/proto/metalstack/api/v2/user.proto +++ b/proto/metalstack/api/v2/user.proto @@ -31,7 +31,7 @@ message User { repeated Tenant tenants = 5; // Projects the user belongs to repeated Project projects = 6; - // DefaultTenant this user belongs to + // DefaultTenant the default tenant that this user belongs to Tenant default_tenant = 7; } diff --git a/proto/metalstack/infra/v2/bmc.proto b/proto/metalstack/infra/v2/bmc.proto index 851b3337..23061e19 100644 --- a/proto/metalstack/infra/v2/bmc.proto +++ b/proto/metalstack/infra/v2/bmc.proto @@ -30,7 +30,7 @@ service BMCService { message UpdateBMCInfoRequest { // Partition is the partition ID where metal-bmc wants to receive events string partition = 1 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; - // BmcReports contains maps the BMC report per machine UUID + // BmcReports maps the BMC report per machine UUID map bmc_reports = 2 [(buf.validate.field).map = {keys: {string: {uuid: true}}}]; } diff --git a/proto/metalstack/infra/v2/boot.proto b/proto/metalstack/infra/v2/boot.proto index 84bf13f9..53973784 100644 --- a/proto/metalstack/infra/v2/boot.proto +++ b/proto/metalstack/infra/v2/boot.proto @@ -89,7 +89,7 @@ message BootServiceRegisterRequest { metalstack.api.v2.MachineFRU fru = 5; // Tags of this machine repeated string tags = 6; - // MetalHammer version this machine was bootet into + // MetalHammer version this machine was booted into string metal_hammer_version = 7 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; // Partition where this machine is located string partition = 8 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true];
projects string repeated

Projects for the projects in which a user is a direct member

Projects in which a user is a direct member

invites TenantInvite repeated

Invites not already accepted the invitation to this tenant

Invites that have not yet accepted the invitation to this tenant

Leave TenantServiceLeaveRequest TenantServiceLeaveResponse

Leave remove a member of a tenant

Leave removes a member from a tenant

RemoveMember TenantServiceRemoveMemberRequest TenantServiceRemoveMemberResponse

RemoveMember remove a member of a tenant

RemoveMember removes a member from a tenant

RemoveMember TenantServiceRemoveMemberRequest TenantServiceRemoveMemberResponse

RemoveMember remove a member of a tenant

RemoveMember removes a member from a tenant

default_tenant Tenant

DefaultTenant this user belongs to

DefaultTenant the default tenant that this user belongs to

bmc_reports UpdateBMCInfoRequest.BmcReportsEntry repeated

BmcReports contains maps the BMC report per machine UUID

BmcReports maps the BMC report per machine UUID

metal_hammer_version string

MetalHammer version this machine was bootet into

MetalHammer version this machine was booted into