@@ -17243,133 +17254,133 @@
| id |
string |
|
- ID is the identifier of the task. |
+ ID is the identifier of the task |
| queue |
string |
|
- Queue is the name of the queue in which the task belongs. |
+ Queue is the name of the queue in which the task belongs |
| type |
string |
|
- Type is the type name of the task. |
+ Type is the type name of the task |
| payload |
bytes |
|
- Payload is the payload data of the task. |
+ Payload is the payload data of the task |
| state |
TaskState |
|
- State indicates the task state. |
+ State indicates the task state |
| max_retry |
int32 |
|
- MaxRetry is the maximum number of times the task can be retried. |
+ MaxRetry is the maximum number of times the task can be retried |
| retried |
int32 |
|
- Retried is the number of times the task has retried so far. |
+ Retried is the number of times the task has retried so far |
| last_error |
string |
|
- LastError is the error message from the last failure. |
+ LastError is the error message from the last failure |
| last_failed_at |
google.protobuf.Timestamp |
|
- LastFailedAt is the time time of the last failure if any.
-If the task has no failures, LastFailedAt is zero time (i.e. time.Time{}). |
+ LastFailedAt is the time of the last failure if any
+If the task has no failures, LastFailedAt is zero time (i.e. time.Time{}) |
| timeout |
google.protobuf.Duration |
|
- Timeout is the duration the task can be processed by Handler before being retried, |
+ Timeout is the duration the task can be processed by Handler before being retried |
| deadline |
google.protobuf.Timestamp |
|
- Deadline is the deadline for the task. |
+ Deadline is the deadline for the task |
| group |
string |
|
- Group is the name of the group in which the task belongs.
+ | Group is the name of the group in which the task belongs
Tasks in the same queue can be grouped together by Group name and will be aggregated into one task
-by a Server processing the queue.
+by a Server processing the queue
-Empty string (default) indicates task does not belong to any groups, and no aggregation will be applied to the task. |
+Empty string (default) indicates task does not belong to any groups, and no aggregation will be applied to the task
| next_process_at |
google.protobuf.Timestamp |
|
- NextProcessAt is the time the task is scheduled to be processed,
-zero if not applicable. |
+ NextProcessAt is the time the task is scheduled to be processed
+Zero if not applicable |
| is_orphaned |
bool |
|
- IsOrphaned describes whether the task is left in active state with no worker processing it.
+ | IsOrphaned describes whether the task is left in active state with no worker processing it
An orphaned task indicates that the worker has crashed or experienced network failures and was not able to
-extend its lease on the task.
+extend its lease on the task
-This task will be recovered by running a server against the queue the task is in.
-This field is only applicable to tasks with TaskStateActive. |
+This task will be recovered by running a server against the queue the task is in
+This field is only applicable to tasks with TaskStateActive
| retention |
google.protobuf.Duration |
|
- Retention is duration of the retention period after the task is successfully processed. |
+ Retention is duration of the retention period after the task is successfully processed |
| completed_at |
google.protobuf.Timestamp |
|
- CompletedAt is the time when the task is processed successfully.
-Zero value (i.e. time.Time{}) indicates no value. |
+ CompletedAt is the time when the task is processed successfully
+Zero value (i.e. time.Time{}) indicates no value |
| result |
bytes |
|
- Result holds the result data associated with the task.
-Use ResultWriter to write result data from the Handler. |
+ Result holds the result data associated with the task
+Use ResultWriter to write result data from the Handler |
@@ -17380,7 +17391,7 @@
- TaskServiceDeleteRequest is the message to a delete task request
+ TaskServiceDeleteRequest is the request payload for deleting a task.
@@ -17393,14 +17404,14 @@ TaskServiceDeleteResponse is the response to a task delete request
+ TaskServiceDeleteResponse is the response payload for deleting a task.
TaskServiceGetRequest
- TaskServiceGetRequest is the message to a get task request
+ TaskServiceGetRequest is the request payload for getting a task.
@@ -17431,14 +17442,14 @@ TaskServiceGetRequest
task_id |
string |
|
- TaskId to get |
+ TaskId is the identifier of the task to get |
| queue |
string |
|
- Queue where this task was scheduled to |
+ Queue is the queue where this task was scheduled to |
@@ -17449,7 +17460,7 @@ TaskServiceGetRequest
TaskServiceGetResponse
- TaskServiceGetResponse is the response to a task get request
+ TaskServiceGetResponse is the response payload for getting a task.
@@ -17473,7 +17484,7 @@ TaskServiceGetResponse
TaskServiceListRequest
- TaskServiceListRequest is the message to a task list request
+ TaskServiceListRequest is the request payload for listing tasks.
@@ -17486,22 +17497,22 @@ TaskServiceListRequest
queue |
string |
optional |
- Queue where this tasks should be listed
-will return tasks from all queues if not specified |
+ Queue filters tasks by this queue
+Will return tasks from all queues if not specified |
| count |
uint32 |
optional |
- Count of tasks to return |
+ Count is the number of tasks to return |
| page |
uint32 |
optional |
- Page of tasks to return |
+ Page is the page of tasks to return |
@@ -17512,7 +17523,7 @@ TaskServiceListRequest
TaskServiceListResponse
- TaskServiceListResponse is the response to a task list request
+ TaskServiceListResponse is the response payload for listing tasks.
@@ -17525,7 +17536,7 @@ TaskServiceListResponse
tasks
TaskInfo |
repeated |
- Tasks contains the requested list of tasks |
+ Tasks contains the list of requested tasks |
@@ -17536,14 +17547,14 @@ TaskServiceListResponse
TaskServiceQueuesRequest
- TaskServiceQueuesRequest is the message to get all queues
+ TaskServiceQueuesRequest is the request payload for getting all queues.
TaskServiceQueuesResponse
- TaskServiceQueuesResponse is the response to a queues request
+ TaskServiceQueuesResponse is the response payload for getting all queues.
@@ -17569,7 +17580,7 @@ TaskServiceQueuesResponse
TaskState
-
TaskState defines the state of the task
+ TaskState defines the state of the task.
| Name | Number | Description |
@@ -17579,49 +17590,49 @@ TaskState
| TASK_STATE_UNSPECIFIED |
0 |
- TASK_STATE_UNSPECIFIED indicates a undefined state |
+ TASK_STATE_UNSPECIFIED is not specified |
| TASK_STATE_ACTIVE |
1 |
- TASK_STATE_ACTIVE indicates that the task is currently being processed by Handler. |
+ TASK_STATE_ACTIVE indicates that the task is currently being processed by Handler |
| TASK_STATE_PENDING |
2 |
- TASK_STATE_PENDING indicates that the task is ready to be processed by Handler. |
+ TASK_STATE_PENDING indicates that the task is ready to be processed by Handler |
| TASK_STATE_SCHEDULED |
3 |
- TASK_STATE_SCHEDULED indicates that the task is scheduled to be processed some time in the future. |
+ TASK_STATE_SCHEDULED indicates that the task is scheduled to be processed some time in the future |
| TASK_STATE_RETRY |
4 |
- TASK_STATE_RETRY indicates that the task has previously failed and scheduled to be processed some time in the future. |
+ TASK_STATE_RETRY indicates that the task has previously failed and is scheduled to be processed some time in the future |
| TASK_STATE_ARCHIVED |
5 |
- TASK_STATE_ARCHIVED indicates that the task is archived and stored for inspection purposes. |
+ TASK_STATE_ARCHIVED indicates that the task is archived and stored for inspection purposes |
| TASK_STATE_COMPLETED |
6 |
- TASK_STATE_COMPLETED indicates that the task is processed successfully and retained until the retention TTL expires. |
+ TASK_STATE_COMPLETED indicates that the task is processed successfully and retained until the retention TTL expires |
| TASK_STATE_AGGREGATING |
7 |
- TASK_STATE_AGGREGATING indicates that the task is waiting in a group to be aggregated into one task. |
+ TASK_STATE_AGGREGATING indicates that the task is waiting in a group to be aggregated into one task |
@@ -17632,7 +17643,7 @@ TaskState
TaskService
- TaskService provides services to async tasks
+ TaskService provides asynchronous task management operations.
| Method Name | Request Type | Response Type | Description |
@@ -17643,28 +17654,28 @@ TaskService
Get |
TaskServiceGetRequest |
TaskServiceGetResponse |
- Get a specific task |
+ Returns the task with the specified identifier. |
| Delete |
TaskServiceDeleteRequest |
TaskServiceDeleteResponse |
- Delete a specific task |
+ Deletes the task with the specified identifier. |
| Queues |
TaskServiceQueuesRequest |
TaskServiceQueuesResponse |
- Queues returns all configures queues |
+ Returns the list of all configured queues. |
| List |
TaskServiceListRequest |
TaskServiceListResponse |
- List list all tasks |
+ Returns the list of all tasks. |
@@ -18585,7 +18596,7 @@ TenantServiceUpdateRespon
TenantService
-
TenantService serves tenant related functions
+ TenantService provides tenant management operations.
| Method Name | Request Type | Response Type | Description |
@@ -18596,14 +18607,14 @@ TenantService
Create |
TenantServiceCreateRequest |
TenantServiceCreateResponse |
- Create a tenant |
+ Creates a new tenant. |
| List |
TenantServiceListRequest |
TenantServiceListResponse |
- List tenants |
+ Returns the list of tenants. |
@@ -18696,7 +18707,7 @@ metalstack/admin/v2/tenant.proto
<
TenantServiceCreateRequest
- TenantServiceCreateRequest is the request payload of the tenant create request
+ TenantServiceCreateRequest is the request payload for creating a tenant.
@@ -18709,14 +18720,14 @@ TenantServiceCreateReque
| name |
string |
|
- Name of this tenant |
+ Name of the tenant |
| description |
string |
optional |
- Description of this tenant |
+ Description of the tenant |
@@ -18748,7 +18759,7 @@ TenantServiceCreateReque
TenantServiceCreateResponse
-
TenantServiceCreateResponse is the response payload of the tenant create request
+ TenantServiceCreateResponse is the response payload for creating a tenant.
@@ -18761,7 +18772,7 @@ TenantServiceCreateResp
| tenant |
metalstack.api.v2.Tenant |
|
- Tenant is the tenant |
+ Tenant contains the created tenant |
@@ -18772,7 +18783,7 @@ TenantServiceCreateResp
TenantServiceListRequest
-
TenantServiceListRequest is the request payload for a tenant list request
+ TenantServiceListRequest is the request payload for listing tenants.
@@ -18785,14 +18796,14 @@ TenantServiceListRequest
| login |
string |
optional |
- Login of the tenant to list |
+ Login filters tenants by this login |
| name |
string |
optional |
- Name of the tenant to list |
+ Name filters tenants by this name |
@@ -18810,7 +18821,7 @@ TenantServiceListRequest
TenantServiceListResponse
-
TenantServiceListResponse is the response payload for a tenant list request
+ TenantServiceListResponse is the response payload for listing tenants.
@@ -18823,14 +18834,14 @@ TenantServiceListResponse
| tenants |
metalstack.api.v2.Tenant |
repeated |
- Tenants are the list of tenants |
+ Tenants contains the list of tenants |
| next_page |
uint64 |
optional |
- NextPage is used for pagination, returns the next page to be fetched and must then be provided in the list request. |
+ NextPage is used for pagination, returns the next page to be fetched and must then be provided in the list request |
@@ -18847,7 +18858,7 @@ TenantServiceListResponse
TenantService
-
TenantService serves tenant related functions
+ TenantService provides tenant management operations.
| Method Name | Request Type | Response Type | Description |
@@ -18858,14 +18869,14 @@ TenantService
Create |
TenantServiceCreateRequest |
TenantServiceCreateResponse |
- Create a tenant |
+ Creates a new tenant. |
| List |
TenantServiceListRequest |
TenantServiceListResponse |
- List all tenants |
+ Returns the list of all tenants. |
@@ -18881,7 +18892,7 @@ metalstack/admin/v2/token.proto
TokenServiceCreateRequest
- TokenServiceCreateRequest is the request payload to create a token
+ TokenServiceCreateRequest is the request payload for creating a token.
@@ -18912,7 +18923,7 @@ TokenServiceCreateRequest
TokenServiceCreateResponse
-
TokenServiceCreateResponse is the response payload of a token create request
+ TokenServiceCreateResponse is the response payload for creating a token.
@@ -18925,14 +18936,14 @@ TokenServiceCreateRespon
| token |
metalstack.api.v2.Token |
|
- Token which was created |
+ Token contains the created token |
| secret |
string |
|
- Secret is the body if the jwt token, should be used in api requests as bearer token |
+ Secret is the body if the JWT token, should be used in API requests as bearer token |
@@ -18943,7 +18954,7 @@ TokenServiceCreateRespon
TokenServiceListRequest
-
TokenServiceListRequest is the request payload for the token list request
+ TokenServiceListRequest is the request payload for listing tokens.
@@ -18967,7 +18978,7 @@ TokenServiceListRequest
TokenServiceListResponse
- TokenServiceListResponse is the response payload for the token list request
+ TokenServiceListResponse is the response payload for listing tokens.
@@ -18980,7 +18991,7 @@ TokenServiceListResponse
| tokens |
metalstack.api.v2.Token |
repeated |
- Tokens is the list of tokens |
+ Tokens contains the list of tokens |
@@ -18991,7 +19002,7 @@ TokenServiceListResponse
TokenServiceRevokeRequest
-
TokenServiceRevokeRequest is the request payload for the token revoke request
+ TokenServiceRevokeRequest is the request payload for revoking a token.
@@ -19022,7 +19033,7 @@ TokenServiceRevokeRequest
TokenServiceRevokeResponse
-
TokenServiceRevokeResponse is the response payload for the token revoke request
+ TokenServiceRevokeResponse is the response payload for revoking a token.
@@ -19035,7 +19046,7 @@ TokenServiceRevokeRespon
TokenService
-
TokenService serves token related functions
+ TokenService provides token management operations.
| Method Name | Request Type | Response Type | Description |
@@ -19046,21 +19057,21 @@ TokenService
List |
TokenServiceListRequest |
TokenServiceListResponse |
- List tokens |
+ Returns the list of tokens for a user. |
| Revoke |
TokenServiceRevokeRequest |
TokenServiceRevokeResponse |
- Revoke a token |
+ Revokes a token. |
| Create |
TokenServiceCreateRequest |
TokenServiceCreateResponse |
- Create a token to authenticate against the platform, the secret will be only visible in the response.
+ | Creates a token to authenticate against the platform, the secret will be only visible in the response.
This service is suitable to create tokens for other users instead of deriving users from tokens directly. |
@@ -19077,7 +19088,7 @@ metalstack/api/v2/vpn.proto
VPNNode
- VPNNode is a machine connected to the vpn
+ VPNNode represents a machine connected to the VPN.
@@ -19090,7 +19101,7 @@ VPNNode
id |
uint64 |
|
- Id of this node |
+ ID of this node |
@@ -19111,14 +19122,14 @@ VPNNode
ip_addresses |
string |
repeated |
- IPAddresses of this node in the vpn |
+ IPAddresses of this node in the VPN |
| last_seen |
google.protobuf.Timestamp |
|
- LastSeen timestamp when this node reached out the the control plane |
+ LastSeen timestamp when this node reached out to the control plane |
@@ -19150,7 +19161,7 @@ metalstack/admin/v2/vpn.proto
VPNServiceAuthKeyRequest
- VPNServiceAuthKeyRequest is the request payload for a vpn authkey request.
+ VPNServiceAuthKeyRequest is the request payload for generating a VPN authentication key.
@@ -19163,29 +19174,29 @@ VPNServiceAuthKeyRequest
| project |
string |
|
- Project for which a vpn authkey should be generated. |
+ Project for which a VPN authentication key should be generated |
| ephemeral |
bool |
|
- Ephemeral defines if the authkey should be ephemeral. |
+ Ephemeral defines if the authentication key should be ephemeral |
| expires |
google.protobuf.Duration |
|
- Expires defines the duration after which the authkey expires. |
+ Expires defines the duration after which the authentication key expires |
| reason |
string |
|
- Reason must be provided why access to the vpn is requested
-reason is only forwarded to a audit sink |
+ Reason must be provided why access to the VPN is requested
+Reason is only forwarded to an audit sink |
@@ -19196,7 +19207,7 @@ VPNServiceAuthKeyRequest
VPNServiceAuthKeyResponse
-
VPNServiceAuthKeyResponse is the request payload for a authkey response
+ VPNServiceAuthKeyResponse is the response payload for generating a VPN authentication key.
@@ -19209,36 +19220,36 @@ VPNServiceAuthKeyResponse
| address |
string |
|
- Address is the address of the vpn control plane. |
+ Address is the address of the VPN control plane |
| auth_key |
string |
|
- AuthKey is the key to connect to the vpn at the given address.
-This key can only be seen once. |
+ AuthKey is the key to connect to the VPN at the given address
+This key can only be seen once |
| ephemeral |
bool |
|
- Ephemeral defines if the authkey should be ephemeral. |
+ Ephemeral defines if the authentication key should be ephemeral |
| expires_at |
google.protobuf.Timestamp |
|
- ExpiresAt this key cannot be used after this timestamp. |
+ ExpiresAt this key cannot be used after this timestamp |
| created_at |
google.protobuf.Timestamp |
|
- CreatedAt this key was created at this timestamp. |
+ CreatedAt this key was created at this timestamp |
@@ -19249,7 +19260,7 @@ VPNServiceAuthKeyResponse
VPNServiceListNodesRequest
-
VPNServiceListNodesRequest is the request payload for a vpn list nodes request
+ VPNServiceListNodesRequest is the request payload for listing VPN nodes.
@@ -19262,7 +19273,7 @@ VPNServiceListNodesReque
| project |
string |
optional |
- Project if given only nodes of this user are returned |
+ Project filters nodes by this project |
@@ -19273,7 +19284,7 @@ VPNServiceListNodesReque
VPNServiceListNodesResponse
-
VPNServiceListNodesResponse is the response payload for a vpn list nodes request
+ VPNServiceListNodesResponse is the response payload for listing VPN nodes.
@@ -19286,7 +19297,7 @@ VPNServiceListNodesResp
| nodes |
metalstack.api.v2.VPNNode |
repeated |
- Nodes connected to the vpn |
+ Nodes connected to the VPN |
@@ -19303,7 +19314,7 @@ VPNServiceListNodesResp
VPNService
-
VPNService serves vpn related functions
+ VPNService provides VPN management operations.
| Method Name | Request Type | Response Type | Description |
@@ -19314,14 +19325,14 @@ VPNService
AuthKey |
VPNServiceAuthKeyRequest |
VPNServiceAuthKeyResponse |
- AuthKey generates a authkey for a project to join a machine to the project vpn |
+ GenerateAuthKey generates an authentication key for a project to join a machine to the project VPN. |
| ListNodes |
VPNServiceListNodesRequest |
VPNServiceListNodesResponse |
- ListNodes returns a list of machines actually connected to the vpn |
+ Returns the list of machines connected to the VPN. |
@@ -19337,7 +19348,7 @@ metalstack/api/v2/health.proto
Health
- Health reports the health status of all services
+ Health reports the health status of all services.
@@ -19350,7 +19361,7 @@ Health
services |
HealthStatus |
repeated |
- Services the health of all individual services |
+ Services contains the health of all individual services |
@@ -19361,14 +19372,14 @@ Health
HealthServiceGetRequest
- HealthServiceGetRequest is request payload to get the health of the system
+ HealthServiceGetRequest is the request payload for getting the health of the system.
HealthServiceGetResponse
- HealthServiceGetRequest is the response payload with the health of the system
+ HealthServiceGetResponse is the response payload for getting the health of the system.
@@ -19381,7 +19392,7 @@ HealthServiceGetResponse
health
Health |
|
- Health is the overall health of the system |
+ Health contains the overall health of the system |
@@ -19392,7 +19403,7 @@ HealthServiceGetResponse
HealthStatus
- HealthStatus the health of one service
+ HealthStatus represents the health status of one service.
@@ -19405,14 +19416,14 @@ HealthStatus
name |
Service |
|
- Name the name of the service |
+ Name is the name of the service |
| status |
ServiceStatus |
|
- Status the status of this service |
+ Status is the status of this service |
@@ -19468,7 +19479,7 @@ HealthStatus.PartitionsE
PartitionHealth
-
PartitionHealth the status of a specific service in this partition
+ PartitionHealth represents the status of a specific service in this partition.
@@ -19481,7 +19492,7 @@ PartitionHealth
status |
ServiceStatus |
|
- Status the health status of the service in this partition |
+ Status is the health status of the service in this partition |
@@ -19501,7 +19512,7 @@ PartitionHealth
Service
- Service defines the service for which the healtyness is reported
+ Service defines the service for which the healthiness is reported.
| Name | Number | Description |
@@ -19517,19 +19528,19 @@ Service
| SERVICE_IPAM |
1 |
- SERVICE_IPAM the ipam service |
+ SERVICE_IPAM the IPAM service |
| SERVICE_RETHINK |
2 |
- SERVICE_RETHINK the rethinkdb |
+ SERVICE_RETHINK the RethinkDB |
| SERVICE_MASTERDATA |
3 |
- SERVICE_MASTERDATA the masterdata-api |
+ SERVICE_MASTERDATA the masterdata API |
@@ -19547,13 +19558,13 @@ Service
| SERVICE_VPN |
6 |
- SERVICE_VPN the vpn service |
+ SERVICE_VPN the VPN service |
| SERVICE_REDIS |
7 |
- SERVICE_REDIS the redis service |
+ SERVICE_REDIS the Redis service |
@@ -19566,7 +19577,7 @@ Service
ServiceStatus
- ServiceStatus defines the status of a service
+ ServiceStatus defines the status of a service.
| Name | Number | Description |
@@ -19594,7 +19605,7 @@ ServiceStatus
| SERVICE_STATUS_HEALTHY |
3 |
- SERVICE_STATUS_HEALTHY the service is in healthy status e.g. fully functional |
+ SERVICE_STATUS_HEALTHY the service is in healthy status, for example fully functional |
@@ -19605,7 +19616,7 @@ ServiceStatus
HealthService
- HealthService serves health related functions
+ HealthService provides health status monitoring operations.
| Method Name | Request Type | Response Type | Description |
@@ -19616,7 +19627,7 @@ HealthService
Get |
HealthServiceGetRequest |
HealthServiceGetResponse |
- Get the health of the platform |
+ Returns the health status of the platform. |
@@ -19632,14 +19643,14 @@ metalstack/api/v2/method.proto
MethodServiceListRequest
- MethodServiceListRequest is the request payload to list all public methods
+ MethodServiceListRequest is the request payload for listing all public methods.
MethodServiceListResponse
- MethodServiceListResponse is the response payload with all public visible methods
+ MethodServiceListResponse is the response payload for listing all public methods.
@@ -19663,14 +19674,14 @@ MethodServiceListResponse
MethodServiceTokenScopedListRequest
-
MethodServiceTokenScopedListRequest is the request payload to list all methods callable with the token present in the request
+ MethodServiceTokenScopedListRequest is the request payload for listing all methods callable with the token present in the request.
MethodServiceTokenScopedListResponse
- MethodServiceTokenScopedListResponse is the response payload which contains all methods which are callable with the given token
+ MethodServiceTokenScopedListResponse is the response payload which contains all methods which are callable with the given token.
@@ -19683,21 +19694,21 @@ MethodServiceTok
| permissions |
MethodPermission |
repeated |
- Permissions a list of methods which can be called |
+ Permissions contains a list of methods which can be called |
| project_roles |
MethodServiceTokenScopedListResponse.ProjectRolesEntry |
repeated |
- ProjectRoles associates a project id with the corresponding role of the token owner |
+ ProjectRoles associates a project ID with the corresponding role of the token owner |
| tenant_roles |
MethodServiceTokenScopedListResponse.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 |
@@ -19828,7 +19839,7 @@ MethodService
- MethodService serves method related functions
methods are functions in services
+ MethodService provides method discovery operations.
Methods are functions in services.
| Method Name | Request Type | Response Type | Description |
@@ -19839,14 +19850,14 @@ MethodService
List |
MethodServiceListRequest |
MethodServiceListResponse |
- List all public visible methods |
+ Returns the list of all public visible methods. |
| TokenScopedList |
MethodServiceTokenScopedListRequest |
MethodServiceTokenScopedListResponse |
- TokenScopedList all methods callable with the token present in the request |
+ TokenScopedList returns all methods callable with the token present in the request. |
@@ -19862,7 +19873,7 @@ metalstack/api/v2/user.proto
User
- User is a end user of the platform
+ User represents an end user of the platform.
@@ -19875,7 +19886,7 @@ User
login |
string |
|
- Login the login at the provider |
+ Login is the login at the provider |
@@ -19928,14 +19939,14 @@ User
UserServiceGetRequest
- UserServiceGetRequest is the request to get the user
+ UserServiceGetRequest is the request payload for getting the user.
UserServiceGetResponse
- UserServiceGetResponse the response when userservice get request was called
+ UserServiceGetResponse is the response payload for getting the user.
@@ -19948,7 +19959,7 @@ UserServiceGetResponse
user |
User |
|
- User is the user |
+ User contains the authenticated user |
@@ -19965,7 +19976,7 @@ UserServiceGetResponse
UserService
- UserService exposes rpc calls for users
+ UserService provides user information operations.
| Method Name | Request Type | Response Type | Description |
@@ -19976,7 +19987,7 @@ UserService
Get |
UserServiceGetRequest |
UserServiceGetResponse |
- Get a User |
+ Returns the authenticated user. |
@@ -19992,7 +20003,7 @@ metalstack/infra/v2/bmc.proto
BMCCommandDoneRequest
- BMCCommandDoneRequest must be returned after command execution
+ BMCCommandDoneRequest must be returned after command execution.
@@ -20006,7 +20017,7 @@ BMCCommandDoneRequest
string |
|
CommandId is a unique ID which must be sent back after execution
-it is usually in the form: <machine-uuid>:machine-bmc-command |
+It is usually in the form: <machine-uuid>:machine-bmc-command
@@ -20024,14 +20035,14 @@ BMCCommandDoneRequest
BMCCommandDoneResponse
- BMCCommandDoneResponse
+ BMCCommandDoneResponse is the response payload for BMC command completion.
UpdateBMCInfoRequest
- UpdateBMCInfoRequest
+ UpdateBMCInfoRequest is the request payload for updating BMC information.
@@ -20044,14 +20055,14 @@ UpdateBMCInfoRequest
partition |
string |
|
- Partition the partition id where metal-bmc wants to receive events |
+ Partition is the partition ID where metal-bmc wants to receive events |
| bmc_reports |
UpdateBMCInfoRequest.BmcReportsEntry |
repeated |
- BmcReports contains maps the bmc report per machine uuid |
+ BmcReports contains maps the BMC report per machine UUID |
@@ -20093,7 +20104,7 @@ UpdateBMCInfoR
UpdateBMCInfoResponse
-
UpdateBMCInfoResponse
+ UpdateBMCInfoResponse is the response payload for updating BMC information.
@@ -20106,14 +20117,14 @@ UpdateBMCInfoResponse
updated_machines |
string |
repeated |
- UpdatedMachines is a slice of machine uuids which were updated |
+ UpdatedMachines is a slice of machine UUIDs which were updated |
| created_machines |
string |
repeated |
- CreatedMachines is a slice of machine uuids which were created |
+ CreatedMachines is a slice of machine UUIDs which were created |
@@ -20124,7 +20135,7 @@ UpdateBMCInfoResponse
WaitForBMCCommandRequest
- WaitForBMCCommandRequest
+ WaitForBMCCommandRequest is the request payload for waiting for a BMC command.
@@ -20137,7 +20148,7 @@ WaitForBMCCommandRequest
| partition |
string |
|
- Partition the partition id where metal-bmc wants to receive bmc commands |
+ Partition is the partition ID where metal-bmc wants to receive BMC commands |
@@ -20148,7 +20159,7 @@ WaitForBMCCommandRequest
WaitForBMCCommandResponse
-
WaitForBMCCommandResponse
+ WaitForBMCCommandResponse is the response payload for waiting for a BMC command.
@@ -20168,14 +20179,14 @@ WaitForBMCCommandResponse
| bmc_command |
metalstack.api.v2.MachineBMCCommand |
|
- BmcCommand to execute against the bmc of the machine |
+ BmcCommand to execute against the BMC of the machine |
| machine_bmc |
metalstack.api.v2.MachineBMC |
|
- MachineBmc contains connection details of the machine to issue the bmcCommand to |
+ MachineBmc contains connection details of the machine to issue the BMC command to |
@@ -20183,7 +20194,7 @@ WaitForBMCCommandResponse
| string |
|
CommandId is a unique ID which must be sent back after execution
-it is usually in the form: <machine-uuid>:machine-bmc-command:<command> |
+It is usually in the form: <machine-uuid>:machine-bmc-command:<command>
@@ -20200,7 +20211,7 @@ WaitForBMCCommandResponse
BMCService
-
BMCService serves bmc related functions
+ BMCService provides BMC management operations.
| Method Name | Request Type | Response Type | Description |
@@ -20211,21 +20222,21 @@ BMCService
UpdateBMCInfo |
UpdateBMCInfoRequest |
UpdateBMCInfoResponse |
- UpdateBMCInfo |
+ Updates BMC information. |
| WaitForBMCCommand |
WaitForBMCCommandRequest |
WaitForBMCCommandResponse stream |
- WaitForBMCCommand is called by the metal-bmc and is returned with a bmc command to execute. |
+ WaitForBMCCommand is called by the metal-bmc and returns a BMC command to execute. |
| BMCCommandDone |
BMCCommandDoneRequest |
BMCCommandDoneResponse |
- BMCCommandDone must be called from metal-bmc after the command execution |
+ BMCCommandDone must be called from metal-bmc after the command execution. |
@@ -20606,7 +20617,7 @@ BootServiceWaitResponse
BootService
- BootService is used for all boot related requests, either pixiecore or metal-hammer
Pixiecore
+ BootService provides boot-related operations for pixiecore and metal-hammer.
Pixiecore
| Method Name | Request Type | Response Type | Description |
@@ -20617,42 +20628,42 @@ BootService
Dhcp |
BootServiceDhcpRequest |
BootServiceDhcpResponse |
- Dhcp is the first dhcp request (option 97). A ProvisioningEventPXEBooting is fired |
+ Dhcp handles the first DHCP request (option 97). A ProvisioningEventPXEBooting is fired. |
| Boot |
BootServiceBootRequest |
BootServiceBootResponse |
- Boot is called from pixie once the machine got the first dhcp response and ipxie asks for subsequent kernel and initrd |
+ Boot is called from pixie once the machine got the first DHCP response and ipxe asks for subsequent kernel and initrd. |
| SuperUserPassword |
BootServiceSuperUserPasswordRequest |
BootServiceSuperUserPasswordResponse |
- SuperUserPassword metal-hammer takes the configured root password for the bmc from metal-apiserver and configure the bmc accordingly |
+ SuperUserPassword returns the configured root password for the BMC. |
| Register |
BootServiceRegisterRequest |
BootServiceRegisterResponse |
- Register is called from metal-hammer after hardware inventory is finished, tells metal-apiserver all gory details about that machine |
+ Register is called from metal-hammer after hardware inventory is finished, tells metal-apiserver all details about that machine. |
| Wait |
BootServiceWaitRequest |
BootServiceWaitResponse stream |
- Wait is a hanging call that waits until the machine gets allocated by a user |
+ Wait is a hanging call that waits until the machine gets allocated by a user. |
| InstallationSucceeded |
BootServiceInstallationSucceededRequest |
BootServiceInstallationSucceededResponse |
- InstallationSucceeded tells metal-apiserver installation was either successful |
+ InstallationSucceeded tells metal-apiserver that installation was successful. |
@@ -20668,7 +20679,7 @@ metalstack/infra/v2/component.proto
ComponentServicePingRequest
-
ComponentServicePingRequest is sent from a microservice to report its state regularly
+ ComponentServicePingRequest is the request payload for pinging a microservice.
@@ -20688,23 +20699,21 @@ ComponentServicePingReq
| identifier |
string |
|
- Identifier is a unique identifier of this service, e.g. if two instance are running, this might be the pod id.
-micro_service and identifier guarantee uniqueness. |
+ Identifier is a unique identifier of this service, for example if two instances are running, this might be the pod ID |
| started_at |
google.protobuf.Timestamp |
|
- StartedAt is the timestamp this service was started. |
+ StartedAt is the timestamp this service was started |
| interval |
google.protobuf.Duration |
|
- Interval at which the ping is scheduled, must be between 5 seconds and 1 hour.
-Also gets validated in the same way in go/client/ping.go. |
+ Interval at which the ping is scheduled, must be between 5 seconds and 1 hour |
@@ -20722,7 +20731,7 @@ ComponentServicePingReq
ComponentServicePingResponse
-
ComponentServicePingResponse is the response to a ping request
+ ComponentServicePingResponse is the response payload for pinging a microservice.
@@ -20735,7 +20744,7 @@ ComponentServicePingRe
ComponentService
-
ComponentService serves component, e.g. microservices related functions.
+ ComponentService provides microservice component management operations.
| Method Name | Request Type | Response Type | Description |
@@ -20746,8 +20755,7 @@ ComponentService
Ping |
ComponentServicePingRequest |
ComponentServicePingResponse |
- Ping must be called from every connected microservice in a recurring manner
-to get visibility of all registered microservices. |
+ Returns the ping response to register or report the microservice state. |
@@ -20763,7 +20771,7 @@ metalstack/infra/v2/event.proto
EventServiceSendRequest
- EventServiceSendRequest.
+ EventServiceSendRequest is the request payload for sending provisioning events.
@@ -20776,7 +20784,7 @@ EventServiceSendRequest
events
EventServiceSendRequest.EventsEntry |
repeated |
- Events grouped by machine IDs. |
+ Events grouped by machine IDs |
@@ -20818,7 +20826,7 @@ EventServiceSen
EventServiceSendResponse
-
EventServiceSendResponse.
+ EventServiceSendResponse is the response payload for sending provisioning events.
@@ -20831,14 +20839,14 @@ EventServiceSendResponse
| events |
uint64 |
|
- Events counts the number of events successfully stored in the database. |
+ Events counts the number of events successfully stored in the database |
| failed |
string |
repeated |
- Failed contains IDs of all machines whose events could not be stored in the database. |
+ Failed contains IDs of all machines whose events could not be stored in the database |
@@ -20862,21 +20870,21 @@ MachineProvisioningEvent
| time |
google.protobuf.Timestamp |
|
- Time the event occurred at. |
+ Time the event occurred at |
| event |
ProvisioningEventType |
|
- Event that occurred. |
+ Event that occurred |
| message |
string |
|
- Message describing the event in more detail. |
+ Message describes the event in more detail |
@@ -20899,73 +20907,73 @@ ProvisioningEventType
| PROVISIONING_EVENT_TYPE_UNSPECIFIED |
0 |
- PROVISIONING_EVENT_TYPE_UNSPECIFIED is unspecified. |
+ PROVISIONING_EVENT_TYPE_UNSPECIFIED is unspecified |
| PROVISIONING_EVENT_TYPE_ALIVE |
1 |
- PROVISIONING_EVENT_TYPE_ALIVE means the machine has reported itself to the API not long ago. |
+ PROVISIONING_EVENT_TYPE_ALIVE means the machine has reported itself to the API not long ago |
| PROVISIONING_EVENT_TYPE_CRASHED |
2 |
- PROVISIONING_EVENT_TYPE_CRASHED means an irregularity in the machine's lifecycle. |
+ PROVISIONING_EVENT_TYPE_CRASHED means an irregularity in the machine's lifecycle |
| PROVISIONING_EVENT_TYPE_PXE_BOOTING |
3 |
- PROVISIONING_EVENT_TYPE_PXE_BOOTING is sent when an unprovisioned machine requests a boot image via PXE. |
+ PROVISIONING_EVENT_TYPE_PXE_BOOTING is sent when an unprovisioned machine requests a boot image via PXE |
| PROVISIONING_EVENT_TYPE_PLANNED_REBOOT |
4 |
- PROVISIONING_EVENT_TYPE_PLANNED_REBOOT means the machine was scheduled for reboot. |
+ PROVISIONING_EVENT_TYPE_PLANNED_REBOOT means the machine was scheduled for reboot |
| PROVISIONING_EVENT_TYPE_PREPARING |
5 |
- PROVISIONING_EVENT_TYPE_PREPARING means the metal-hammer has started. |
+ PROVISIONING_EVENT_TYPE_PREPARING means the metal-hammer has started |
| PROVISIONING_EVENT_TYPE_REGISTERING |
6 |
- PROVISIONING_EVENT_TYPE_REGISTERING means the metal-hammer is attempting to register the machine at the API. |
+ PROVISIONING_EVENT_TYPE_REGISTERING means the metal-hammer is attempting to register the machine at the API |
| PROVISIONING_EVENT_TYPE_WAITING |
7 |
- PROVISIONING_EVENT_TYPE_WAITING means the machine has successfully reached the state where it is waiting for allocation. |
+ PROVISIONING_EVENT_TYPE_WAITING means the machine has successfully reached the state where it is waiting for allocation |
| PROVISIONING_EVENT_TYPE_INSTALLING |
8 |
- PROVISIONING_EVENT_TYPE_INSTALLING means the machine was allocated and the requested OS is being installed. |
+ PROVISIONING_EVENT_TYPE_INSTALLING means the machine was allocated and the requested OS is being installed |
| PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL |
9 |
- PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL means the machine has successfully been installed and is now booting into the new OS. |
+ PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL means the machine has successfully been installed and is now booting into the new OS |
| PROVISIONING_EVENT_TYPE_PHONED_HOME |
10 |
- PROVISIONING_EVENT_TYPE_PHONED_HOME is sent periodically by an allocated machine to indicate its liveliness. |
+ PROVISIONING_EVENT_TYPE_PHONED_HOME is sent periodically by an allocated machine to indicate its liveliness |
| PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM |
11 |
- PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM means the machine was freed and is about to return into the pool of waiting machines. |
+ PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM means the machine was freed and is about to return into the pool of waiting machines |
@@ -20976,7 +20984,7 @@ ProvisioningEventType
EventService
-
EventService serves event related functions.
+ EventService provides machine provisioning event logging operations.
| Method Name | Request Type | Response Type | Description |
@@ -20987,7 +20995,7 @@ EventService
Send |
EventServiceSendRequest |
EventServiceSendResponse |
- Send a series of machine provisioning events. |
+ Sends a series of machine provisioning events. |
@@ -21003,7 +21011,7 @@ metalstack/infra/v2/switch.proto
<
SwitchServiceGetRequest
- SwitchServiceGetRequest.
+ SwitchServiceGetRequest is the request payload for getting a switch.
@@ -21016,7 +21024,7 @@ SwitchServiceGetRequest
id
string |
|
- Id of the switch. |
+ Id of the switch |
@@ -21027,7 +21035,7 @@ SwitchServiceGetRequest
SwitchServiceGetResponse
- SwitchServiceGetResponse.
+ SwitchServiceGetResponse is the response payload for getting a switch.
@@ -21040,7 +21048,7 @@ SwitchServiceGetResponse
| switch |
metalstack.api.v2.Switch |
|
- Switch that was requested. |
+ Switch contains the requested switch |
@@ -21051,7 +21059,7 @@ SwitchServiceGetResponse
SwitchServiceHeartbeatRequest
-
SwitchServiceHeartbeatRequest.
+ SwitchServiceHeartbeatRequest is the request payload for sending a switch heartbeat.
@@ -21064,35 +21072,35 @@ SwitchServiceHeartbea
| id |
string |
|
- Id of the switch. |
+ Id of the switch |
| duration |
google.protobuf.Duration |
|
- Duration of the sync. |
+ Duration of the sync |
| error |
string |
optional |
- Error if any occurred during the sync. |
+ Error if any occurred during the sync |
| port_states |
SwitchServiceHeartbeatRequest.PortStatesEntry |
repeated |
- PortStates maps port identifiers to the respective port's operational state. |
+ PortStates maps port identifiers to the respective port's operational state |
| bgp_port_states |
SwitchServiceHeartbeatRequest.BgpPortStatesEntry |
repeated |
- BgpPortStates maps port identifiers to the respective port's BGP state. |
+ BgpPortStates maps port identifiers to the respective port's BGP state |
@@ -21165,7 +21173,7 @@ Switc
SwitchServiceHeartbeatResponse
-
SwitchServiceHeartbeatResponse.
+ SwitchServiceHeartbeatResponse is the response payload for sending a switch heartbeat.
@@ -21178,21 +21186,21 @@ SwitchServiceHeartbe
| id |
string |
|
- Id of the switch. |
+ Id of the switch |
| last_sync |
metalstack.api.v2.SwitchSync |
|
- LastSync holds information about the last sync. |
+ LastSync holds information about the last sync |
| last_sync_error |
metalstack.api.v2.SwitchSync |
|
- LastSyncError holds information about the last erroneous sync. |
+ LastSyncError holds information about the last erroneous sync |
@@ -21203,7 +21211,7 @@ SwitchServiceHeartbe
SwitchServiceRegisterRequest
-
SwitchServiceRegisterRequest.
+ SwitchServiceRegisterRequest is the request payload for registering a switch.
@@ -21216,7 +21224,7 @@ SwitchServiceRegisterR
| switch |
metalstack.api.v2.Switch |
|
- Switch to register. |
+ Switch to register |
@@ -21227,7 +21235,7 @@ SwitchServiceRegisterR
SwitchServiceRegisterResponse
-
SwitchServiceRegisterResponse.
+ SwitchServiceRegisterResponse is the response payload for registering a switch.
@@ -21240,7 +21248,7 @@ SwitchServiceRegister
| switch |
metalstack.api.v2.Switch |
|
- Switch that was registered. |
+ Switch contains the registered switch |
@@ -21257,7 +21265,7 @@ SwitchServiceRegister
SwitchService
-
SwitchService serves switch related functions.
+ SwitchService provides infrastructure switch management operations.
| Method Name | Request Type | Response Type | Description |
@@ -21268,21 +21276,21 @@ SwitchService
Get |
SwitchServiceGetRequest |
SwitchServiceGetResponse |
- Get a switch by ID. |
+ Returns the switch with the specified ID. |
| Register |
SwitchServiceRegisterRequest |
SwitchServiceRegisterResponse |
- Register a switch. |
+ Registers a switch. |
| Heartbeat |
SwitchServiceHeartbeatRequest |
SwitchServiceHeartbeatResponse |
- Heartbeat a switch. |
+ Heartbeat sends a heartbeat from a switch. |
diff --git a/go/metalstack/admin/v2/adminv2connect/audit.connect.go b/go/metalstack/admin/v2/adminv2connect/audit.connect.go
index e844179d..2241e2d5 100644
--- a/go/metalstack/admin/v2/adminv2connect/audit.connect.go
+++ b/go/metalstack/admin/v2/adminv2connect/audit.connect.go
@@ -41,9 +41,9 @@ const (
// AuditServiceClient is a client for the metalstack.admin.v2.AuditService service.
type AuditServiceClient interface {
- // Get an audit trace
+ // Returns the audit trace with the specified UUID.
Get(context.Context, *v2.AuditServiceGetRequest) (*v2.AuditServiceGetResponse, error)
- // List all audit traces
+ // Returns the list of all audit traces.
List(context.Context, *v2.AuditServiceListRequest) (*v2.AuditServiceListResponse, error)
}
@@ -99,9 +99,9 @@ func (c *auditServiceClient) List(ctx context.Context, req *v2.AuditServiceListR
// AuditServiceHandler is an implementation of the metalstack.admin.v2.AuditService service.
type AuditServiceHandler interface {
- // Get an audit trace
+ // Returns the audit trace with the specified UUID.
Get(context.Context, *v2.AuditServiceGetRequest) (*v2.AuditServiceGetResponse, error)
- // List all audit traces
+ // Returns the list of all audit traces.
List(context.Context, *v2.AuditServiceListRequest) (*v2.AuditServiceListResponse, error)
}
diff --git a/go/metalstack/admin/v2/adminv2connect/component.connect.go b/go/metalstack/admin/v2/adminv2connect/component.connect.go
index f9e0c662..da843f1a 100644
--- a/go/metalstack/admin/v2/adminv2connect/component.connect.go
+++ b/go/metalstack/admin/v2/adminv2connect/component.connect.go
@@ -43,11 +43,11 @@ const (
// ComponentServiceClient is a client for the metalstack.admin.v2.ComponentService service.
type ComponentServiceClient interface {
- // Get a single component
+ // Returns the component with the specified UUID.
Get(context.Context, *v2.ComponentServiceGetRequest) (*v2.ComponentServiceGetResponse, error)
- // Delete a component
+ // Deletes the component with the specified UUID.
Delete(context.Context, *v2.ComponentServiceDeleteRequest) (*v2.ComponentServiceDeleteResponse, error)
- // List all components with their status
+ // Returns the list of all components with their status.
List(context.Context, *v2.ComponentServiceListRequest) (*v2.ComponentServiceListResponse, error)
}
@@ -119,11 +119,11 @@ func (c *componentServiceClient) List(ctx context.Context, req *v2.ComponentServ
// ComponentServiceHandler is an implementation of the metalstack.admin.v2.ComponentService service.
type ComponentServiceHandler interface {
- // Get a single component
+ // Returns the component with the specified UUID.
Get(context.Context, *v2.ComponentServiceGetRequest) (*v2.ComponentServiceGetResponse, error)
- // Delete a component
+ // Deletes the component with the specified UUID.
Delete(context.Context, *v2.ComponentServiceDeleteRequest) (*v2.ComponentServiceDeleteResponse, error)
- // List all components with their status
+ // Returns the list of all components with their status.
List(context.Context, *v2.ComponentServiceListRequest) (*v2.ComponentServiceListResponse, error)
}
diff --git a/go/metalstack/admin/v2/adminv2connect/filesystem.connect.go b/go/metalstack/admin/v2/adminv2connect/filesystem.connect.go
index 2dc6583f..da067030 100644
--- a/go/metalstack/admin/v2/adminv2connect/filesystem.connect.go
+++ b/go/metalstack/admin/v2/adminv2connect/filesystem.connect.go
@@ -46,11 +46,11 @@ const (
// FilesystemServiceClient is a client for the metalstack.admin.v2.FilesystemService service.
type FilesystemServiceClient interface {
- // Create a filesystem
+ // Creates a new filesystem.
Create(context.Context, *v2.FilesystemServiceCreateRequest) (*v2.FilesystemServiceCreateResponse, error)
- // Update a filesystem
+ // Updates a filesystem.
Update(context.Context, *v2.FilesystemServiceUpdateRequest) (*v2.FilesystemServiceUpdateResponse, error)
- // Delete a filesystem
+ // Deletes a filesystem.
Delete(context.Context, *v2.FilesystemServiceDeleteRequest) (*v2.FilesystemServiceDeleteResponse, error)
}
@@ -123,11 +123,11 @@ func (c *filesystemServiceClient) Delete(ctx context.Context, req *v2.Filesystem
// FilesystemServiceHandler is an implementation of the metalstack.admin.v2.FilesystemService
// service.
type FilesystemServiceHandler interface {
- // Create a filesystem
+ // Creates a new filesystem.
Create(context.Context, *v2.FilesystemServiceCreateRequest) (*v2.FilesystemServiceCreateResponse, error)
- // Update a filesystem
+ // Updates a filesystem.
Update(context.Context, *v2.FilesystemServiceUpdateRequest) (*v2.FilesystemServiceUpdateResponse, error)
- // Delete a filesystem
+ // Deletes a filesystem.
Delete(context.Context, *v2.FilesystemServiceDeleteRequest) (*v2.FilesystemServiceDeleteResponse, error)
}
diff --git a/go/metalstack/admin/v2/adminv2connect/image.connect.go b/go/metalstack/admin/v2/adminv2connect/image.connect.go
index 5c9c1e40..321e7267 100644
--- a/go/metalstack/admin/v2/adminv2connect/image.connect.go
+++ b/go/metalstack/admin/v2/adminv2connect/image.connect.go
@@ -45,13 +45,13 @@ const (
// ImageServiceClient is a client for the metalstack.admin.v2.ImageService service.
type ImageServiceClient interface {
- // Create a image
+ // Creates a new image.
Create(context.Context, *v2.ImageServiceCreateRequest) (*v2.ImageServiceCreateResponse, error)
- // Update a image
+ // Updates an image.
Update(context.Context, *v2.ImageServiceUpdateRequest) (*v2.ImageServiceUpdateResponse, error)
- // Delete a image
+ // Deletes an image.
Delete(context.Context, *v2.ImageServiceDeleteRequest) (*v2.ImageServiceDeleteResponse, error)
- // Usage of images
+ // Returns the usage of images.
Usage(context.Context, *v2.ImageServiceUsageRequest) (*v2.ImageServiceUsageResponse, error)
}
@@ -139,13 +139,13 @@ func (c *imageServiceClient) Usage(ctx context.Context, req *v2.ImageServiceUsag
// ImageServiceHandler is an implementation of the metalstack.admin.v2.ImageService service.
type ImageServiceHandler interface {
- // Create a image
+ // Creates a new image.
Create(context.Context, *v2.ImageServiceCreateRequest) (*v2.ImageServiceCreateResponse, error)
- // Update a image
+ // Updates an image.
Update(context.Context, *v2.ImageServiceUpdateRequest) (*v2.ImageServiceUpdateResponse, error)
- // Delete a image
+ // Deletes an image.
Delete(context.Context, *v2.ImageServiceDeleteRequest) (*v2.ImageServiceDeleteResponse, error)
- // Usage of images
+ // Returns the usage of images.
Usage(context.Context, *v2.ImageServiceUsageRequest) (*v2.ImageServiceUsageResponse, error)
}
diff --git a/go/metalstack/admin/v2/adminv2connect/ip.connect.go b/go/metalstack/admin/v2/adminv2connect/ip.connect.go
index 02e51cb5..ce2541e1 100644
--- a/go/metalstack/admin/v2/adminv2connect/ip.connect.go
+++ b/go/metalstack/admin/v2/adminv2connect/ip.connect.go
@@ -39,7 +39,7 @@ const (
// IPServiceClient is a client for the metalstack.admin.v2.IPService service.
type IPServiceClient interface {
- // List all ips
+ // Returns the list of all IP addresses.
List(context.Context, *v2.IPServiceListRequest) (*v2.IPServiceListResponse, error)
}
@@ -79,7 +79,7 @@ func (c *iPServiceClient) List(ctx context.Context, req *v2.IPServiceListRequest
// IPServiceHandler is an implementation of the metalstack.admin.v2.IPService service.
type IPServiceHandler interface {
- // List all ips
+ // Returns the list of all IP addresses.
List(context.Context, *v2.IPServiceListRequest) (*v2.IPServiceListResponse, error)
}
diff --git a/go/metalstack/admin/v2/adminv2connect/machine.connect.go b/go/metalstack/admin/v2/adminv2connect/machine.connect.go
index 121b2a3a..371b2430 100644
--- a/go/metalstack/admin/v2/adminv2connect/machine.connect.go
+++ b/go/metalstack/admin/v2/adminv2connect/machine.connect.go
@@ -51,17 +51,17 @@ const (
// MachineServiceClient is a client for the metalstack.admin.v2.MachineService service.
type MachineServiceClient interface {
- // Get a machine
+ // Returns the machine with the specified UUID.
Get(context.Context, *v2.MachineServiceGetRequest) (*v2.MachineServiceGetResponse, error)
- // List all machines
+ // Returns the list of all machines.
List(context.Context, *v2.MachineServiceListRequest) (*v2.MachineServiceListResponse, error)
- // BMCCommand send a command to the bmc of a machine
+ // BMCCommand sends a command to the BMC of a machine.
BMCCommand(context.Context, *v2.MachineServiceBMCCommandRequest) (*v2.MachineServiceBMCCommandResponse, error)
- // GetBMC returns the BMC details of a machine
+ // Returns the BMC details of a machine.
GetBMC(context.Context, *v2.MachineServiceGetBMCRequest) (*v2.MachineServiceGetBMCResponse, error)
- // ListBMC returns the BMC details of many machines
+ // ListBMC returns the BMC details of many machines.
ListBMC(context.Context, *v2.MachineServiceListBMCRequest) (*v2.MachineServiceListBMCResponse, error)
- // ConsolePassword returns the password to access the serial console of the machine
+ // GetConsolePassword returns the password to access the serial console of the machine.
ConsolePassword(context.Context, *v2.MachineServiceConsolePasswordRequest) (*v2.MachineServiceConsolePasswordResponse, error)
}
@@ -181,17 +181,17 @@ func (c *machineServiceClient) ConsolePassword(ctx context.Context, req *v2.Mach
// MachineServiceHandler is an implementation of the metalstack.admin.v2.MachineService service.
type MachineServiceHandler interface {
- // Get a machine
+ // Returns the machine with the specified UUID.
Get(context.Context, *v2.MachineServiceGetRequest) (*v2.MachineServiceGetResponse, error)
- // List all machines
+ // Returns the list of all machines.
List(context.Context, *v2.MachineServiceListRequest) (*v2.MachineServiceListResponse, error)
- // BMCCommand send a command to the bmc of a machine
+ // BMCCommand sends a command to the BMC of a machine.
BMCCommand(context.Context, *v2.MachineServiceBMCCommandRequest) (*v2.MachineServiceBMCCommandResponse, error)
- // GetBMC returns the BMC details of a machine
+ // Returns the BMC details of a machine.
GetBMC(context.Context, *v2.MachineServiceGetBMCRequest) (*v2.MachineServiceGetBMCResponse, error)
- // ListBMC returns the BMC details of many machines
+ // ListBMC returns the BMC details of many machines.
ListBMC(context.Context, *v2.MachineServiceListBMCRequest) (*v2.MachineServiceListBMCResponse, error)
- // ConsolePassword returns the password to access the serial console of the machine
+ // GetConsolePassword returns the password to access the serial console of the machine.
ConsolePassword(context.Context, *v2.MachineServiceConsolePasswordRequest) (*v2.MachineServiceConsolePasswordResponse, error)
}
diff --git a/go/metalstack/admin/v2/adminv2connect/network.connect.go b/go/metalstack/admin/v2/adminv2connect/network.connect.go
index 1e33c994..039d93d0 100644
--- a/go/metalstack/admin/v2/adminv2connect/network.connect.go
+++ b/go/metalstack/admin/v2/adminv2connect/network.connect.go
@@ -47,15 +47,15 @@ const (
// NetworkServiceClient is a client for the metalstack.admin.v2.NetworkService service.
type NetworkServiceClient interface {
- // Get a network
+ // Returns the network with the specified ID.
Get(context.Context, *v2.NetworkServiceGetRequest) (*v2.NetworkServiceGetResponse, error)
- // Create a network
+ // Creates a new network.
Create(context.Context, *v2.NetworkServiceCreateRequest) (*v2.NetworkServiceCreateResponse, error)
- // Update a network
+ // Updates a network.
Update(context.Context, *v2.NetworkServiceUpdateRequest) (*v2.NetworkServiceUpdateResponse, error)
- // Delete a network
+ // Deletes a network.
Delete(context.Context, *v2.NetworkServiceDeleteRequest) (*v2.NetworkServiceDeleteResponse, error)
- // List all networks
+ // Returns the list of all networks.
List(context.Context, *v2.NetworkServiceListRequest) (*v2.NetworkServiceListResponse, error)
}
@@ -159,15 +159,15 @@ func (c *networkServiceClient) List(ctx context.Context, req *v2.NetworkServiceL
// NetworkServiceHandler is an implementation of the metalstack.admin.v2.NetworkService service.
type NetworkServiceHandler interface {
- // Get a network
+ // Returns the network with the specified ID.
Get(context.Context, *v2.NetworkServiceGetRequest) (*v2.NetworkServiceGetResponse, error)
- // Create a network
+ // Creates a new network.
Create(context.Context, *v2.NetworkServiceCreateRequest) (*v2.NetworkServiceCreateResponse, error)
- // Update a network
+ // Updates a network.
Update(context.Context, *v2.NetworkServiceUpdateRequest) (*v2.NetworkServiceUpdateResponse, error)
- // Delete a network
+ // Deletes a network.
Delete(context.Context, *v2.NetworkServiceDeleteRequest) (*v2.NetworkServiceDeleteResponse, error)
- // List all networks
+ // Returns the list of all networks.
List(context.Context, *v2.NetworkServiceListRequest) (*v2.NetworkServiceListResponse, error)
}
diff --git a/go/metalstack/admin/v2/adminv2connect/partition.connect.go b/go/metalstack/admin/v2/adminv2connect/partition.connect.go
index 28a4e8f7..1f6dcdf9 100644
--- a/go/metalstack/admin/v2/adminv2connect/partition.connect.go
+++ b/go/metalstack/admin/v2/adminv2connect/partition.connect.go
@@ -46,13 +46,13 @@ const (
// PartitionServiceClient is a client for the metalstack.admin.v2.PartitionService service.
type PartitionServiceClient interface {
- // Create a partition
+ // Creates a new partition.
Create(context.Context, *v2.PartitionServiceCreateRequest) (*v2.PartitionServiceCreateResponse, error)
- // Update a partition
+ // Updates a partition.
Update(context.Context, *v2.PartitionServiceUpdateRequest) (*v2.PartitionServiceUpdateResponse, error)
- // Delete a partition
+ // Deletes a partition.
Delete(context.Context, *v2.PartitionServiceDeleteRequest) (*v2.PartitionServiceDeleteResponse, error)
- // Capacity of a partitions
+ // Returns the capacity of a partition.
Capacity(context.Context, *v2.PartitionServiceCapacityRequest) (*v2.PartitionServiceCapacityResponse, error)
}
@@ -140,13 +140,13 @@ func (c *partitionServiceClient) Capacity(ctx context.Context, req *v2.Partition
// PartitionServiceHandler is an implementation of the metalstack.admin.v2.PartitionService service.
type PartitionServiceHandler interface {
- // Create a partition
+ // Creates a new partition.
Create(context.Context, *v2.PartitionServiceCreateRequest) (*v2.PartitionServiceCreateResponse, error)
- // Update a partition
+ // Updates a partition.
Update(context.Context, *v2.PartitionServiceUpdateRequest) (*v2.PartitionServiceUpdateResponse, error)
- // Delete a partition
+ // Deletes a partition.
Delete(context.Context, *v2.PartitionServiceDeleteRequest) (*v2.PartitionServiceDeleteResponse, error)
- // Capacity of a partitions
+ // Returns the capacity of a partition.
Capacity(context.Context, *v2.PartitionServiceCapacityRequest) (*v2.PartitionServiceCapacityResponse, error)
}
diff --git a/go/metalstack/admin/v2/adminv2connect/project.connect.go b/go/metalstack/admin/v2/adminv2connect/project.connect.go
index 8dfddbc4..9d614b2f 100644
--- a/go/metalstack/admin/v2/adminv2connect/project.connect.go
+++ b/go/metalstack/admin/v2/adminv2connect/project.connect.go
@@ -39,7 +39,7 @@ const (
// ProjectServiceClient is a client for the metalstack.admin.v2.ProjectService service.
type ProjectServiceClient interface {
- // List projects based on various filter criteria
+ // Returns the list of projects matching the filter criteria.
List(context.Context, *v2.ProjectServiceListRequest) (*v2.ProjectServiceListResponse, error)
}
@@ -79,7 +79,7 @@ func (c *projectServiceClient) List(ctx context.Context, req *v2.ProjectServiceL
// ProjectServiceHandler is an implementation of the metalstack.admin.v2.ProjectService service.
type ProjectServiceHandler interface {
- // List projects based on various filter criteria
+ // Returns the list of projects matching the filter criteria.
List(context.Context, *v2.ProjectServiceListRequest) (*v2.ProjectServiceListResponse, error)
}
diff --git a/go/metalstack/admin/v2/adminv2connect/size.connect.go b/go/metalstack/admin/v2/adminv2connect/size.connect.go
index cef7b27e..4f94d4a9 100644
--- a/go/metalstack/admin/v2/adminv2connect/size.connect.go
+++ b/go/metalstack/admin/v2/adminv2connect/size.connect.go
@@ -43,11 +43,11 @@ const (
// SizeServiceClient is a client for the metalstack.admin.v2.SizeService service.
type SizeServiceClient interface {
- // Create a size
+ // Creates a new size.
Create(context.Context, *v2.SizeServiceCreateRequest) (*v2.SizeServiceCreateResponse, error)
- // Update a size
+ // Updates a size.
Update(context.Context, *v2.SizeServiceUpdateRequest) (*v2.SizeServiceUpdateResponse, error)
- // Delete a size
+ // Deletes a size.
Delete(context.Context, *v2.SizeServiceDeleteRequest) (*v2.SizeServiceDeleteResponse, error)
}
@@ -119,11 +119,11 @@ func (c *sizeServiceClient) Delete(ctx context.Context, req *v2.SizeServiceDelet
// SizeServiceHandler is an implementation of the metalstack.admin.v2.SizeService service.
type SizeServiceHandler interface {
- // Create a size
+ // Creates a new size.
Create(context.Context, *v2.SizeServiceCreateRequest) (*v2.SizeServiceCreateResponse, error)
- // Update a size
+ // Updates a size.
Update(context.Context, *v2.SizeServiceUpdateRequest) (*v2.SizeServiceUpdateResponse, error)
- // Delete a size
+ // Deletes a size.
Delete(context.Context, *v2.SizeServiceDeleteRequest) (*v2.SizeServiceDeleteResponse, error)
}
diff --git a/go/metalstack/admin/v2/adminv2connect/size_imageconstraint.connect.go b/go/metalstack/admin/v2/adminv2connect/size_imageconstraint.connect.go
index 2f93a493..29b12288 100644
--- a/go/metalstack/admin/v2/adminv2connect/size_imageconstraint.connect.go
+++ b/go/metalstack/admin/v2/adminv2connect/size_imageconstraint.connect.go
@@ -54,15 +54,15 @@ const (
// SizeImageConstraintServiceClient is a client for the
// metalstack.admin.v2.SizeImageConstraintService service.
type SizeImageConstraintServiceClient interface {
- // Create a size image constraint
+ // Creates a size image constraint.
Create(context.Context, *v2.SizeImageConstraintServiceCreateRequest) (*v2.SizeImageConstraintServiceCreateResponse, error)
- // Update a size image constraint
+ // Updates a size image constraint.
Update(context.Context, *v2.SizeImageConstraintServiceUpdateRequest) (*v2.SizeImageConstraintServiceUpdateResponse, error)
- // Delete a size image constraint
+ // Deletes a size image constraint.
Delete(context.Context, *v2.SizeImageConstraintServiceDeleteRequest) (*v2.SizeImageConstraintServiceDeleteResponse, error)
- // Get a size image constraint
+ // Returns the size image constraint with the specified size.
Get(context.Context, *v2.SizeImageConstraintServiceGetRequest) (*v2.SizeImageConstraintServiceGetResponse, error)
- // List a size image constraint
+ // Returns the list of size image constraints.
List(context.Context, *v2.SizeImageConstraintServiceListRequest) (*v2.SizeImageConstraintServiceListResponse, error)
}
@@ -168,15 +168,15 @@ func (c *sizeImageConstraintServiceClient) List(ctx context.Context, req *v2.Siz
// SizeImageConstraintServiceHandler is an implementation of the
// metalstack.admin.v2.SizeImageConstraintService service.
type SizeImageConstraintServiceHandler interface {
- // Create a size image constraint
+ // Creates a size image constraint.
Create(context.Context, *v2.SizeImageConstraintServiceCreateRequest) (*v2.SizeImageConstraintServiceCreateResponse, error)
- // Update a size image constraint
+ // Updates a size image constraint.
Update(context.Context, *v2.SizeImageConstraintServiceUpdateRequest) (*v2.SizeImageConstraintServiceUpdateResponse, error)
- // Delete a size image constraint
+ // Deletes a size image constraint.
Delete(context.Context, *v2.SizeImageConstraintServiceDeleteRequest) (*v2.SizeImageConstraintServiceDeleteResponse, error)
- // Get a size image constraint
+ // Returns the size image constraint with the specified size.
Get(context.Context, *v2.SizeImageConstraintServiceGetRequest) (*v2.SizeImageConstraintServiceGetResponse, error)
- // List a size image constraint
+ // Returns the list of size image constraints.
List(context.Context, *v2.SizeImageConstraintServiceListRequest) (*v2.SizeImageConstraintServiceListResponse, error)
}
diff --git a/go/metalstack/admin/v2/adminv2connect/size_reservation.connect.go b/go/metalstack/admin/v2/adminv2connect/size_reservation.connect.go
index b2c99985..823544c5 100644
--- a/go/metalstack/admin/v2/adminv2connect/size_reservation.connect.go
+++ b/go/metalstack/admin/v2/adminv2connect/size_reservation.connect.go
@@ -50,13 +50,13 @@ const (
// SizeReservationServiceClient is a client for the metalstack.admin.v2.SizeReservationService
// service.
type SizeReservationServiceClient interface {
- // Create a size reservation
+ // Creates a new size reservation.
Create(context.Context, *v2.SizeReservationServiceCreateRequest) (*v2.SizeReservationServiceCreateResponse, error)
- // Update a size reservation
+ // Updates a size reservation.
Update(context.Context, *v2.SizeReservationServiceUpdateRequest) (*v2.SizeReservationServiceUpdateResponse, error)
- // Delete a size reservation
+ // Deletes a size reservation.
Delete(context.Context, *v2.SizeReservationServiceDeleteRequest) (*v2.SizeReservationServiceDeleteResponse, error)
- // List size reservations
+ // Returns the list of size reservations.
List(context.Context, *v2.SizeReservationServiceListRequest) (*v2.SizeReservationServiceListResponse, error)
}
@@ -145,13 +145,13 @@ func (c *sizeReservationServiceClient) List(ctx context.Context, req *v2.SizeRes
// SizeReservationServiceHandler is an implementation of the
// metalstack.admin.v2.SizeReservationService service.
type SizeReservationServiceHandler interface {
- // Create a size reservation
+ // Creates a new size reservation.
Create(context.Context, *v2.SizeReservationServiceCreateRequest) (*v2.SizeReservationServiceCreateResponse, error)
- // Update a size reservation
+ // Updates a size reservation.
Update(context.Context, *v2.SizeReservationServiceUpdateRequest) (*v2.SizeReservationServiceUpdateResponse, error)
- // Delete a size reservation
+ // Deletes a size reservation.
Delete(context.Context, *v2.SizeReservationServiceDeleteRequest) (*v2.SizeReservationServiceDeleteResponse, error)
- // List size reservations
+ // Returns the list of size reservations.
List(context.Context, *v2.SizeReservationServiceListRequest) (*v2.SizeReservationServiceListResponse, error)
}
diff --git a/go/metalstack/admin/v2/adminv2connect/switch.connect.go b/go/metalstack/admin/v2/adminv2connect/switch.connect.go
index d83fc052..a44c2320 100644
--- a/go/metalstack/admin/v2/adminv2connect/switch.connect.go
+++ b/go/metalstack/admin/v2/adminv2connect/switch.connect.go
@@ -52,19 +52,19 @@ const (
// SwitchServiceClient is a client for the metalstack.admin.v2.SwitchService service.
type SwitchServiceClient interface {
- // Get a switch by ID.
+ // Returns the switch with the specified ID.
Get(context.Context, *v2.SwitchServiceGetRequest) (*v2.SwitchServiceGetResponse, error)
- // List switches.
+ // Returns the list of switches.
List(context.Context, *v2.SwitchServiceListRequest) (*v2.SwitchServiceListResponse, error)
- // Update a switch.
+ // Updates a switch.
Update(context.Context, *v2.SwitchServiceUpdateRequest) (*v2.SwitchServiceUpdateResponse, error)
- // Delete a switch.
+ // Deletes a switch.
Delete(context.Context, *v2.SwitchServiceDeleteRequest) (*v2.SwitchServiceDeleteResponse, error)
- // Migrate a switch.
+ // Migrates a switch.
Migrate(context.Context, *v2.SwitchServiceMigrateRequest) (*v2.SwitchServiceMigrateResponse, error)
- // Port set the port status of a switch port.
+ // Sets the port status of a switch port.
Port(context.Context, *v2.SwitchServicePortRequest) (*v2.SwitchServicePortResponse, error)
- // ConnectedMachines lists all switches with their machine connections.
+ // Returns all switches with their machine connections.
ConnectedMachines(context.Context, *v2.SwitchServiceConnectedMachinesRequest) (*v2.SwitchServiceConnectedMachinesResponse, error)
}
@@ -200,19 +200,19 @@ func (c *switchServiceClient) ConnectedMachines(ctx context.Context, req *v2.Swi
// SwitchServiceHandler is an implementation of the metalstack.admin.v2.SwitchService service.
type SwitchServiceHandler interface {
- // Get a switch by ID.
+ // Returns the switch with the specified ID.
Get(context.Context, *v2.SwitchServiceGetRequest) (*v2.SwitchServiceGetResponse, error)
- // List switches.
+ // Returns the list of switches.
List(context.Context, *v2.SwitchServiceListRequest) (*v2.SwitchServiceListResponse, error)
- // Update a switch.
+ // Updates a switch.
Update(context.Context, *v2.SwitchServiceUpdateRequest) (*v2.SwitchServiceUpdateResponse, error)
- // Delete a switch.
+ // Deletes a switch.
Delete(context.Context, *v2.SwitchServiceDeleteRequest) (*v2.SwitchServiceDeleteResponse, error)
- // Migrate a switch.
+ // Migrates a switch.
Migrate(context.Context, *v2.SwitchServiceMigrateRequest) (*v2.SwitchServiceMigrateResponse, error)
- // Port set the port status of a switch port.
+ // Sets the port status of a switch port.
Port(context.Context, *v2.SwitchServicePortRequest) (*v2.SwitchServicePortResponse, error)
- // ConnectedMachines lists all switches with their machine connections.
+ // Returns all switches with their machine connections.
ConnectedMachines(context.Context, *v2.SwitchServiceConnectedMachinesRequest) (*v2.SwitchServiceConnectedMachinesResponse, error)
}
diff --git a/go/metalstack/admin/v2/adminv2connect/task.connect.go b/go/metalstack/admin/v2/adminv2connect/task.connect.go
index a39406bc..70279fca 100644
--- a/go/metalstack/admin/v2/adminv2connect/task.connect.go
+++ b/go/metalstack/admin/v2/adminv2connect/task.connect.go
@@ -45,13 +45,13 @@ const (
// TaskServiceClient is a client for the metalstack.admin.v2.TaskService service.
type TaskServiceClient interface {
- // Get a specific task
+ // Returns the task with the specified identifier.
Get(context.Context, *v2.TaskServiceGetRequest) (*v2.TaskServiceGetResponse, error)
- // Delete a specific task
+ // Deletes the task with the specified identifier.
Delete(context.Context, *v2.TaskServiceDeleteRequest) (*v2.TaskServiceDeleteResponse, error)
- // Queues returns all configures queues
+ // Returns the list of all configured queues.
Queues(context.Context, *v2.TaskServiceQueuesRequest) (*v2.TaskServiceQueuesResponse, error)
- // List list all tasks
+ // Returns the list of all tasks.
List(context.Context, *v2.TaskServiceListRequest) (*v2.TaskServiceListResponse, error)
}
@@ -139,13 +139,13 @@ func (c *taskServiceClient) List(ctx context.Context, req *v2.TaskServiceListReq
// TaskServiceHandler is an implementation of the metalstack.admin.v2.TaskService service.
type TaskServiceHandler interface {
- // Get a specific task
+ // Returns the task with the specified identifier.
Get(context.Context, *v2.TaskServiceGetRequest) (*v2.TaskServiceGetResponse, error)
- // Delete a specific task
+ // Deletes the task with the specified identifier.
Delete(context.Context, *v2.TaskServiceDeleteRequest) (*v2.TaskServiceDeleteResponse, error)
- // Queues returns all configures queues
+ // Returns the list of all configured queues.
Queues(context.Context, *v2.TaskServiceQueuesRequest) (*v2.TaskServiceQueuesResponse, error)
- // List list all tasks
+ // Returns the list of all tasks.
List(context.Context, *v2.TaskServiceListRequest) (*v2.TaskServiceListResponse, error)
}
diff --git a/go/metalstack/admin/v2/adminv2connect/tenant.connect.go b/go/metalstack/admin/v2/adminv2connect/tenant.connect.go
index 200c4e61..cfdbeb06 100644
--- a/go/metalstack/admin/v2/adminv2connect/tenant.connect.go
+++ b/go/metalstack/admin/v2/adminv2connect/tenant.connect.go
@@ -41,9 +41,9 @@ const (
// TenantServiceClient is a client for the metalstack.admin.v2.TenantService service.
type TenantServiceClient interface {
- // Create a tenant
+ // Creates a new tenant.
Create(context.Context, *v2.TenantServiceCreateRequest) (*v2.TenantServiceCreateResponse, error)
- // List all tenants
+ // Returns the list of all tenants.
List(context.Context, *v2.TenantServiceListRequest) (*v2.TenantServiceListResponse, error)
}
@@ -99,9 +99,9 @@ func (c *tenantServiceClient) List(ctx context.Context, req *v2.TenantServiceLis
// TenantServiceHandler is an implementation of the metalstack.admin.v2.TenantService service.
type TenantServiceHandler interface {
- // Create a tenant
+ // Creates a new tenant.
Create(context.Context, *v2.TenantServiceCreateRequest) (*v2.TenantServiceCreateResponse, error)
- // List all tenants
+ // Returns the list of all tenants.
List(context.Context, *v2.TenantServiceListRequest) (*v2.TenantServiceListResponse, error)
}
diff --git a/go/metalstack/admin/v2/adminv2connect/token.connect.go b/go/metalstack/admin/v2/adminv2connect/token.connect.go
index 1b5a7753..98cf0434 100644
--- a/go/metalstack/admin/v2/adminv2connect/token.connect.go
+++ b/go/metalstack/admin/v2/adminv2connect/token.connect.go
@@ -43,11 +43,11 @@ const (
// TokenServiceClient is a client for the metalstack.admin.v2.TokenService service.
type TokenServiceClient interface {
- // List tokens
+ // Returns the list of tokens for a user.
List(context.Context, *v2.TokenServiceListRequest) (*v2.TokenServiceListResponse, error)
- // Revoke a token
+ // Revokes a token.
Revoke(context.Context, *v2.TokenServiceRevokeRequest) (*v2.TokenServiceRevokeResponse, error)
- // Create a token to authenticate against the platform, the secret will be only visible in the response.
+ // Creates a token to authenticate against the platform, the secret will be only visible in the response.
// This service is suitable to create tokens for other users instead of deriving users from tokens directly.
Create(context.Context, *v2.TokenServiceCreateRequest) (*v2.TokenServiceCreateResponse, error)
}
@@ -120,11 +120,11 @@ func (c *tokenServiceClient) Create(ctx context.Context, req *v2.TokenServiceCre
// TokenServiceHandler is an implementation of the metalstack.admin.v2.TokenService service.
type TokenServiceHandler interface {
- // List tokens
+ // Returns the list of tokens for a user.
List(context.Context, *v2.TokenServiceListRequest) (*v2.TokenServiceListResponse, error)
- // Revoke a token
+ // Revokes a token.
Revoke(context.Context, *v2.TokenServiceRevokeRequest) (*v2.TokenServiceRevokeResponse, error)
- // Create a token to authenticate against the platform, the secret will be only visible in the response.
+ // Creates a token to authenticate against the platform, the secret will be only visible in the response.
// This service is suitable to create tokens for other users instead of deriving users from tokens directly.
Create(context.Context, *v2.TokenServiceCreateRequest) (*v2.TokenServiceCreateResponse, error)
}
diff --git a/go/metalstack/admin/v2/adminv2connect/vpn.connect.go b/go/metalstack/admin/v2/adminv2connect/vpn.connect.go
index cab3f682..eec85d0b 100644
--- a/go/metalstack/admin/v2/adminv2connect/vpn.connect.go
+++ b/go/metalstack/admin/v2/adminv2connect/vpn.connect.go
@@ -41,9 +41,9 @@ const (
// VPNServiceClient is a client for the metalstack.admin.v2.VPNService service.
type VPNServiceClient interface {
- // AuthKey generates a authkey for a project to join a machine to the project vpn
+ // GenerateAuthKey generates an authentication key for a project to join a machine to the project VPN.
AuthKey(context.Context, *v2.VPNServiceAuthKeyRequest) (*v2.VPNServiceAuthKeyResponse, error)
- // ListNodes returns a list of machines actually connected to the vpn
+ // Returns the list of machines connected to the VPN.
ListNodes(context.Context, *v2.VPNServiceListNodesRequest) (*v2.VPNServiceListNodesResponse, error)
}
@@ -99,9 +99,9 @@ func (c *vPNServiceClient) ListNodes(ctx context.Context, req *v2.VPNServiceList
// VPNServiceHandler is an implementation of the metalstack.admin.v2.VPNService service.
type VPNServiceHandler interface {
- // AuthKey generates a authkey for a project to join a machine to the project vpn
+ // GenerateAuthKey generates an authentication key for a project to join a machine to the project VPN.
AuthKey(context.Context, *v2.VPNServiceAuthKeyRequest) (*v2.VPNServiceAuthKeyResponse, error)
- // ListNodes returns a list of machines actually connected to the vpn
+ // Returns the list of machines connected to the VPN.
ListNodes(context.Context, *v2.VPNServiceListNodesRequest) (*v2.VPNServiceListNodesResponse, error)
}
diff --git a/go/metalstack/admin/v2/audit.pb.go b/go/metalstack/admin/v2/audit.pb.go
index 0d77fa62..063c82f7 100644
--- a/go/metalstack/admin/v2/audit.pb.go
+++ b/go/metalstack/admin/v2/audit.pb.go
@@ -23,7 +23,7 @@ const (
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
-// AuditServiceListRequest is the request payload to list audits
+// AuditServiceListRequest is the request payload for listing audit traces.
type AuditServiceListRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// Query for audit traces
@@ -69,10 +69,10 @@ func (x *AuditServiceListRequest) GetQuery() *v2.AuditQuery {
return nil
}
-// AuditServiceListResponse is the response payload of a audit list request
+// AuditServiceListResponse is the response payload for listing audit traces.
type AuditServiceListResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Traces is a list of audit traces
+ // Traces contains the list of audit traces
Traces []*v2.AuditTrace `protobuf:"bytes,1,rep,name=traces,proto3" json:"traces,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -115,7 +115,7 @@ func (x *AuditServiceListResponse) GetTraces() []*v2.AuditTrace {
return nil
}
-// AuditServiceGetRequest is the request payload of a audit get request
+// AuditServiceGetRequest is the request payload for getting an audit trace.
type AuditServiceGetRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// Uuid of the audit trace
@@ -170,7 +170,7 @@ func (x *AuditServiceGetRequest) GetPhase() v2.AuditPhase {
return v2.AuditPhase(0)
}
-// AuditServiceGetResponse is the response payload of a audit get request
+// AuditServiceGetResponse is the response payload for getting an audit trace.
type AuditServiceGetResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
// Trace is the audit trace
diff --git a/go/metalstack/admin/v2/component.pb.go b/go/metalstack/admin/v2/component.pb.go
index 313bfe1a..106339dd 100644
--- a/go/metalstack/admin/v2/component.pb.go
+++ b/go/metalstack/admin/v2/component.pb.go
@@ -23,10 +23,10 @@ const (
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
-// ComponentServiceListRequest
+// ComponentServiceListRequest is the request payload for listing components.
type ComponentServiceListRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Query components.
+ // Query filters components
Query *v2.ComponentQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -69,10 +69,10 @@ func (x *ComponentServiceListRequest) GetQuery() *v2.ComponentQuery {
return nil
}
-// ComponentServiceListResponse
+// ComponentServiceListResponse is the response payload for listing components.
type ComponentServiceListResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Components
+ // Components contains the list of components
Components []*v2.Component `protobuf:"bytes,1,rep,name=components,proto3" json:"components,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -115,7 +115,7 @@ func (x *ComponentServiceListResponse) GetComponents() []*v2.Component {
return nil
}
-// ComponentServiceGetRequest
+// ComponentServiceGetRequest is the request payload for getting a component.
type ComponentServiceGetRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// UUID identifies the component to get
@@ -161,10 +161,10 @@ func (x *ComponentServiceGetRequest) GetUuid() string {
return ""
}
-// ComponentServiceGetResponse
+// ComponentServiceGetResponse is the response payload for getting a component.
type ComponentServiceGetResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Component
+ // Component contains the retrieved component
Component *v2.Component `protobuf:"bytes,1,opt,name=component,proto3" json:"component,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -207,7 +207,7 @@ func (x *ComponentServiceGetResponse) GetComponent() *v2.Component {
return nil
}
-// ComponentServiceGetRequest
+// ComponentServiceDeleteRequest is the request payload for deleting a component.
type ComponentServiceDeleteRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// UUID identifies the component to delete
@@ -253,10 +253,10 @@ func (x *ComponentServiceDeleteRequest) GetUuid() string {
return ""
}
-// ComponentServiceGetResponse
+// ComponentServiceDeleteResponse is the response payload for deleting a component.
type ComponentServiceDeleteResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Component
+ // Component contains the deleted component
Component *v2.Component `protobuf:"bytes,1,opt,name=component,proto3" json:"component,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
diff --git a/go/metalstack/admin/v2/filesystem.pb.go b/go/metalstack/admin/v2/filesystem.pb.go
index 3b85539a..85eada55 100644
--- a/go/metalstack/admin/v2/filesystem.pb.go
+++ b/go/metalstack/admin/v2/filesystem.pb.go
@@ -23,10 +23,10 @@ const (
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
-// FilesystemServiceCreateRequest
+// FilesystemServiceCreateRequest is the request payload for creating a filesystem.
type FilesystemServiceCreateRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // FilesystemLayout the filesystemlayout
+ // FilesystemLayout is the filesystem layout to create
FilesystemLayout *v2.FilesystemLayout `protobuf:"bytes,1,opt,name=filesystem_layout,json=filesystemLayout,proto3" json:"filesystem_layout,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -69,10 +69,10 @@ func (x *FilesystemServiceCreateRequest) GetFilesystemLayout() *v2.FilesystemLay
return nil
}
-// FilesystemServiceCreateResponse
+// FilesystemServiceCreateResponse is the response payload for creating a filesystem.
type FilesystemServiceCreateResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // FilesystemLayout the filesystemlayout
+ // FilesystemLayout contains the created filesystem layout
FilesystemLayout *v2.FilesystemLayout `protobuf:"bytes,1,opt,name=filesystem_layout,json=filesystemLayout,proto3" json:"filesystem_layout,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -115,7 +115,7 @@ func (x *FilesystemServiceCreateResponse) GetFilesystemLayout() *v2.FilesystemLa
return nil
}
-// FilesystemServiceUpdateRequest
+// FilesystemServiceUpdateRequest is the request payload for updating a filesystem.
type FilesystemServiceUpdateRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// Id of this filesystemLayout
@@ -130,7 +130,7 @@ type FilesystemServiceUpdateRequest struct {
Filesystems []*v2.Filesystem `protobuf:"bytes,5,rep,name=filesystems,proto3" json:"filesystems,omitempty"`
// Disks list of disks that belong to this layout
Disks []*v2.Disk `protobuf:"bytes,6,rep,name=disks,proto3" json:"disks,omitempty"`
- // raid arrays to create
+ // Raid arrays to create
Raid []*v2.Raid `protobuf:"bytes,7,rep,name=raid,proto3" json:"raid,omitempty"`
// VolumeGroups list of volumegroups to create
VolumeGroups []*v2.VolumeGroup `protobuf:"bytes,8,rep,name=volume_groups,json=volumeGroups,proto3" json:"volume_groups,omitempty"`
@@ -242,10 +242,10 @@ func (x *FilesystemServiceUpdateRequest) GetConstraints() *v2.FilesystemLayoutCo
return nil
}
-// FilesystemServiceUpdateResponse
+// FilesystemServiceUpdateResponse is the response payload for updating a filesystem.
type FilesystemServiceUpdateResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // FilesystemLayout the filesystemlayout
+ // FilesystemLayout contains the updated filesystem layout
FilesystemLayout *v2.FilesystemLayout `protobuf:"bytes,1,opt,name=filesystem_layout,json=filesystemLayout,proto3" json:"filesystem_layout,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -288,7 +288,7 @@ func (x *FilesystemServiceUpdateResponse) GetFilesystemLayout() *v2.FilesystemLa
return nil
}
-// FilesystemServiceDeleteRequest
+// FilesystemServiceDeleteRequest is the request payload for deleting a filesystem.
type FilesystemServiceDeleteRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// ID of the filesystem to delete
@@ -334,10 +334,10 @@ func (x *FilesystemServiceDeleteRequest) GetId() string {
return ""
}
-// message FilesystemServiceDeleteResponse {
+// FilesystemServiceDeleteResponse is the response payload for deleting a filesystem.
type FilesystemServiceDeleteResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // FilesystemLayout the filesystemlayout
+ // FilesystemLayout contains the deleted filesystem layout
FilesystemLayout *v2.FilesystemLayout `protobuf:"bytes,1,opt,name=filesystem_layout,json=filesystemLayout,proto3" json:"filesystem_layout,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
diff --git a/go/metalstack/admin/v2/image.pb.go b/go/metalstack/admin/v2/image.pb.go
index 2e2c8a4f..e1c987d5 100644
--- a/go/metalstack/admin/v2/image.pb.go
+++ b/go/metalstack/admin/v2/image.pb.go
@@ -24,10 +24,10 @@ const (
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
-// ImageServiceCreateRequest
+// ImageServiceCreateRequest is the request payload for creating an image.
type ImageServiceCreateRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Image is the image
+ // Image is the image to create
Image *v2.Image `protobuf:"bytes,1,opt,name=image,proto3" json:"image,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -70,10 +70,10 @@ func (x *ImageServiceCreateRequest) GetImage() *v2.Image {
return nil
}
-// ImageServiceCreateResponse
+// ImageServiceCreateResponse is the response payload for creating an image.
type ImageServiceCreateResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Image is the image
+ // Image contains the created image
Image *v2.Image `protobuf:"bytes,1,opt,name=image,proto3" json:"image,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -116,7 +116,7 @@ func (x *ImageServiceCreateResponse) GetImage() *v2.Image {
return nil
}
-// ImageServiceUpdateRequest
+// ImageServiceUpdateRequest is the request payload for updating an image.
type ImageServiceUpdateRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// Id of this image
@@ -125,9 +125,9 @@ type ImageServiceUpdateRequest struct {
UpdateMeta *v2.UpdateMeta `protobuf:"bytes,2,opt,name=update_meta,json=updateMeta,proto3" json:"update_meta,omitempty"`
// URL where this image is located
Url *string `protobuf:"bytes,3,opt,name=url,proto3,oneof" json:"url,omitempty"`
- // Name of this imageLayout
+ // Name of this image
Name *string `protobuf:"bytes,4,opt,name=name,proto3,oneof" json:"name,omitempty"`
- // Description of this imageLayout
+ // Description of this image
Description *string `protobuf:"bytes,5,opt,name=description,proto3,oneof" json:"description,omitempty"`
// Features of this image
Features []v2.ImageFeature `protobuf:"varint,6,rep,packed,name=features,proto3,enum=metalstack.api.v2.ImageFeature" json:"features,omitempty"`
@@ -225,10 +225,10 @@ func (x *ImageServiceUpdateRequest) GetExpiresAt() *timestamppb.Timestamp {
return nil
}
-// ImageServiceUpdateResponse
+// ImageServiceUpdateResponse is the response payload for updating an image.
type ImageServiceUpdateResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Image is the image
+ // Image contains the updated image
Image *v2.Image `protobuf:"bytes,1,opt,name=image,proto3" json:"image,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -271,7 +271,7 @@ func (x *ImageServiceUpdateResponse) GetImage() *v2.Image {
return nil
}
-// ImageServiceDeleteRequest
+// ImageServiceDeleteRequest is the request payload for deleting an image.
type ImageServiceDeleteRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// ID of the image to delete
@@ -317,10 +317,10 @@ func (x *ImageServiceDeleteRequest) GetId() string {
return ""
}
-// message ImageServiceDeleteResponse {
+// ImageServiceDeleteResponse is the response payload for deleting an image.
type ImageServiceDeleteResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // ImageLayout the imagelayout
+ // Image contains the deleted image
Image *v2.Image `protobuf:"bytes,1,opt,name=image,proto3" json:"image,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -363,7 +363,7 @@ func (x *ImageServiceDeleteResponse) GetImage() *v2.Image {
return nil
}
-// ImageServiceUsageRequest
+// ImageServiceUsageRequest is the request payload for getting image usage.
type ImageServiceUsageRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// Query for which images the usage should be reported
@@ -409,10 +409,10 @@ func (x *ImageServiceUsageRequest) GetQuery() *v2.ImageQuery {
return nil
}
-// ImageServiceUsageResponse
+// ImageServiceUsageResponse is the response payload for getting image usage.
type ImageServiceUsageResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Images with usage
+ // Images contains usage information
ImageUsage []*v2.ImageUsage `protobuf:"bytes,1,rep,name=image_usage,json=imageUsage,proto3" json:"image_usage,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
diff --git a/go/metalstack/admin/v2/ip.pb.go b/go/metalstack/admin/v2/ip.pb.go
index ab24e077..9deda2f5 100644
--- a/go/metalstack/admin/v2/ip.pb.go
+++ b/go/metalstack/admin/v2/ip.pb.go
@@ -22,10 +22,10 @@ const (
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
-// IPServiceListRequest
+// IPServiceListRequest is the request payload for listing IP addresses.
type IPServiceListRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Query to search for one or more ips
+ // Query to search for IP addresses
Query *v2.IPQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -68,10 +68,10 @@ func (x *IPServiceListRequest) GetQuery() *v2.IPQuery {
return nil
}
-// IPServiceListResponse
+// IPServiceListResponse is the response payload for listing IP addresses.
type IPServiceListResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // IPs are the list of ips
+ // IPs contains the list of IP addresses
Ips []*v2.IP `protobuf:"bytes,1,rep,name=ips,proto3" json:"ips,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 5c009995..2dc25e97 100644
--- a/go/metalstack/admin/v2/machine.pb.go
+++ b/go/metalstack/admin/v2/machine.pb.go
@@ -502,12 +502,12 @@ func (x *MachineServiceListBMCResponse) GetBmcReports() map[string]*v2.MachineBM
return nil
}
-// MachineServiceConsolePasswordRequest is the request to get the console password
+// MachineServiceConsolePasswordRequest is the request payload for getting the console password.
type MachineServiceConsolePasswordRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// UUID of the machine to get
Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
- // Reason must be provided why access to the console is requested.
+ // Reason must be provided why access to the console is requested
// Reason is only forwarded to an audit sink
Reason string `protobuf:"bytes,2,opt,name=reason,proto3" json:"reason,omitempty"`
unknownFields protoimpl.UnknownFields
@@ -558,7 +558,7 @@ func (x *MachineServiceConsolePasswordRequest) GetReason() string {
return ""
}
-// MachineServiceConsolePasswordResponse is the response to the console password request
+// MachineServiceConsolePasswordResponse is the response payload for getting the console password.
type MachineServiceConsolePasswordResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
// UUID of the machine to get
diff --git a/go/metalstack/admin/v2/network.pb.go b/go/metalstack/admin/v2/network.pb.go
index f0143a98..45ca1cfa 100644
--- a/go/metalstack/admin/v2/network.pb.go
+++ b/go/metalstack/admin/v2/network.pb.go
@@ -23,7 +23,7 @@ const (
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
-// NetworkServiceGetRequest
+// NetworkServiceGetRequest is the request payload for getting a network.
type NetworkServiceGetRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// ID of the network to get
@@ -69,10 +69,10 @@ func (x *NetworkServiceGetRequest) GetId() string {
return ""
}
-// NetworkServiceGetResponse
+// NetworkServiceGetResponse is the response payload for getting a network.
type NetworkServiceGetResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Network which was requested to get
+ // Network contains the requested network
Network *v2.Network `protobuf:"bytes,1,opt,name=network,proto3" json:"network,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -115,7 +115,7 @@ func (x *NetworkServiceGetResponse) GetNetwork() *v2.Network {
return nil
}
-// NetworkServiceCreateRequest
+// NetworkServiceCreateRequest is the request payload for creating a network.
type NetworkServiceCreateRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// Id of this network
@@ -142,7 +142,7 @@ type NetworkServiceCreateRequest struct {
MinChildPrefixLength *v2.ChildPrefixLength `protobuf:"bytes,11,opt,name=min_child_prefix_length,json=minChildPrefixLength,proto3" json:"min_child_prefix_length,omitempty"`
// NATType of this network
NatType *v2.NATType `protobuf:"varint,12,opt,name=nat_type,json=natType,proto3,enum=metalstack.api.v2.NATType,oneof" json:"nat_type,omitempty"`
- // VRF of this network has this VNI.
+ // VRF of this network has this VNI
Vrf *uint32 `protobuf:"varint,13,opt,name=vrf,proto3,oneof" json:"vrf,omitempty"`
// Parent Network points to the id of the parent network if any
ParentNetwork *string `protobuf:"bytes,14,opt,name=parent_network,json=parentNetwork,proto3,oneof" json:"parent_network,omitempty"`
@@ -305,7 +305,7 @@ func (x *NetworkServiceCreateRequest) GetAddressFamily() v2.NetworkAddressFamily
return v2.NetworkAddressFamily(0)
}
-// NetworkServiceUpdateRequest is the request payload for a network update request
+// NetworkServiceUpdateRequest is the request payload for updating a network.
type NetworkServiceUpdateRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// Id of this network
@@ -322,7 +322,7 @@ type NetworkServiceUpdateRequest struct {
Prefixes []string `protobuf:"bytes,6,rep,name=prefixes,proto3" json:"prefixes,omitempty"`
// Destination Prefixes in this network
DestinationPrefixes []string `protobuf:"bytes,7,rep,name=destination_prefixes,json=destinationPrefixes,proto3" json:"destination_prefixes,omitempty"`
- // Default Child Prefix length defines the bit length 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 addressfamily, if not specified during the allocate request
DefaultChildPrefixLength *v2.ChildPrefixLength `protobuf:"bytes,8,opt,name=default_child_prefix_length,json=defaultChildPrefixLength,proto3,oneof" 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 *v2.ChildPrefixLength `protobuf:"bytes,9,opt,name=min_child_prefix_length,json=minChildPrefixLength,proto3,oneof" json:"min_child_prefix_length,omitempty"`
@@ -330,7 +330,7 @@ type NetworkServiceUpdateRequest struct {
NatType *v2.NATType `protobuf:"varint,10,opt,name=nat_type,json=natType,proto3,enum=metalstack.api.v2.NATType,oneof" json:"nat_type,omitempty"`
// AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced
AdditionalAnnouncableCidrs []string `protobuf:"bytes,11,rep,name=additional_announcable_cidrs,json=additionalAnnouncableCidrs,proto3" json:"additional_announcable_cidrs,omitempty"`
- // Force update, actually only prevents accidental removal of additional_announcable_cidrs which will destroy your dataplane in fact.
+ // Force update, prevents accidental removal of additional_announcable_cidrs which will destroy your dataplane.
Force bool `protobuf:"varint,12,opt,name=force,proto3" json:"force,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -450,7 +450,7 @@ func (x *NetworkServiceUpdateRequest) GetForce() bool {
return false
}
-// NetworkServiceDeleteRequest is the request payload for a network delete request
+// NetworkServiceDeleteRequest is the request payload for deleting a network.
type NetworkServiceDeleteRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// ID of the network to get
@@ -496,10 +496,10 @@ func (x *NetworkServiceDeleteRequest) GetId() string {
return ""
}
-// NetworkServiceListRequest
+// NetworkServiceListRequest is the request payload for listing networks.
type NetworkServiceListRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Query which specifies which networks to return
+ // Query specifies which networks to return
Query *v2.NetworkQuery `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -542,10 +542,10 @@ func (x *NetworkServiceListRequest) GetQuery() *v2.NetworkQuery {
return nil
}
-// NetworkServiceCreateResponse is the response payload for a network create request
+// NetworkServiceCreateResponse is the response payload for creating a network.
type NetworkServiceCreateResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Network the network
+ // Network contains the created network
Network *v2.Network `protobuf:"bytes,1,opt,name=network,proto3" json:"network,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -588,10 +588,10 @@ func (x *NetworkServiceCreateResponse) GetNetwork() *v2.Network {
return nil
}
-// NetworkServiceUpdateResponse is the response payload for a network update request
+// NetworkServiceUpdateResponse is the response payload for updating a network.
type NetworkServiceUpdateResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Network the network
+ // Network contains the updated network
Network *v2.Network `protobuf:"bytes,1,opt,name=network,proto3" json:"network,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -634,10 +634,10 @@ func (x *NetworkServiceUpdateResponse) GetNetwork() *v2.Network {
return nil
}
-// NetworkServiceCapacityResponse is the response payload for a network delete request
+// NetworkServiceDeleteResponse is the response payload for deleting a network.
type NetworkServiceDeleteResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Network the network
+ // Network contains the deleted network
Network *v2.Network `protobuf:"bytes,1,opt,name=network,proto3" json:"network,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -680,10 +680,10 @@ func (x *NetworkServiceDeleteResponse) GetNetwork() *v2.Network {
return nil
}
-// NetworkServiceListResponse
+// NetworkServiceListResponse is the response payload for listing networks.
type NetworkServiceListResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Networks are the requested networks
+ // Networks contains the list of networks
Networks []*v2.Network `protobuf:"bytes,1,rep,name=networks,proto3" json:"networks,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 8e93e45e..0fdb1b37 100644
--- a/go/metalstack/admin/v2/partition.pb.go
+++ b/go/metalstack/admin/v2/partition.pb.go
@@ -69,7 +69,7 @@ func (x *PartitionServiceCreateRequest) GetPartition() *v2.Partition {
return nil
}
-// PartitionServiceUpdateRequest is the request payload for a partition update request
+// PartitionServiceUpdateRequest is the request payload for updating a partition.
type PartitionServiceUpdateRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// ID of this partition
@@ -85,8 +85,7 @@ type PartitionServiceUpdateRequest struct {
// NTPServers for this partition
NtpServers []*v2.NTPServer `protobuf:"bytes,6,rep,name=ntp_servers,json=ntpServers,proto3" json:"ntp_servers,omitempty"`
// ManagementServiceAddresses defines where the management is reachable
- // should be in the form :
- // FIXME validation
+ // must be in the form :
MgmtServiceAddresses []string `protobuf:"bytes,7,rep,name=mgmt_service_addresses,json=mgmtServiceAddresses,proto3" json:"mgmt_service_addresses,omitempty"`
// Labels to update on this network
Labels *v2.UpdateLabels `protobuf:"bytes,8,opt,name=labels,proto3,oneof" json:"labels,omitempty"`
@@ -318,10 +317,10 @@ func (x *PartitionServiceUpdateResponse) GetPartition() *v2.Partition {
return nil
}
-// PartitionServiceCapacityResponse is the response payload for a partition delete request
+// PartitionServiceDeleteResponse is the response payload for deleting a partition.
type PartitionServiceDeleteResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Partition the partition
+ // Partition contains the deleted partition
Partition *v2.Partition `protobuf:"bytes,1,opt,name=partition,proto3" json:"partition,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -364,7 +363,7 @@ func (x *PartitionServiceDeleteResponse) GetPartition() *v2.Partition {
return nil
}
-// PartitionServiceListRequest is the request payload for a partition capacity request
+// PartitionServiceCapacityRequest is the request payload for getting partition capacity.
type PartitionServiceCapacityRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// ID of the partition to get
@@ -710,7 +709,7 @@ const file_metalstack_admin_v2_partition_proto_rawDesc = "" +
"\n" +
"#metalstack/admin/v2/partition.proto\x12\x13metalstack.admin.v2\x1a\x1bbuf/validate/validate.proto\x1a\x1emetalstack/api/v2/common.proto\x1a!metalstack/api/v2/partition.proto\x1a(metalstack/api/v2/predefined_rules.proto\"[\n" +
"\x1dPartitionServiceCreateRequest\x12:\n" +
- "\tpartition\x18\x01 \x01(\v2\x1c.metalstack.api.v2.PartitionR\tpartition\"\xb7\x04\n" +
+ "\tpartition\x18\x01 \x01(\v2\x1c.metalstack.api.v2.PartitionR\tpartition\"\xc5\x04\n" +
"\x1dPartitionServiceUpdateRequest\x12\x1b\n" +
"\x02id\x18\x01 \x01(\tB\v\xbaH\br\x06г\xae\xb1\x02\x01R\x02id\x12F\n" +
"\vupdate_meta\x18\x02 \x01(\v2\x1d.metalstack.api.v2.UpdateMetaB\x06\xbaH\x03\xc8\x01\x01R\n" +
@@ -721,8 +720,8 @@ const file_metalstack_admin_v2_partition_proto_rawDesc = "" +
"dnsServers\x12G\n" +
"\vntp_servers\x18\x06 \x03(\v2\x1c.metalstack.api.v2.NTPServerB\b\xbaH\x05\x92\x01\x02\x10\n" +
"R\n" +
- "ntpServers\x124\n" +
- "\x16mgmt_service_addresses\x18\a \x03(\tR\x14mgmtServiceAddresses\x12<\n" +
+ "ntpServers\x12B\n" +
+ "\x16mgmt_service_addresses\x18\a \x03(\tB\f\xbaH\t\x92\x01\x06Ȥ\xb3\xb1\x02\x01R\x14mgmtServiceAddresses\x12<\n" +
"\x06labels\x18\b \x01(\v2\x1f.metalstack.api.v2.UpdateLabelsH\x01R\x06labels\x88\x01\x01B\x0e\n" +
"\f_descriptionB\t\n" +
"\a_labels\"<\n" +
diff --git a/go/metalstack/admin/v2/project.pb.go b/go/metalstack/admin/v2/project.pb.go
index 27f410cc..930379ff 100644
--- a/go/metalstack/admin/v2/project.pb.go
+++ b/go/metalstack/admin/v2/project.pb.go
@@ -23,12 +23,12 @@ const (
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
-// ProjectServiceListRequest is the request payload for the project list request
+// ProjectServiceListRequest is the request payload for listing projects.
type ProjectServiceListRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Tenant lists only projects of this tenant
+ // Tenant filters projects by this tenant
Tenant *string `protobuf:"bytes,1,opt,name=tenant,proto3,oneof" json:"tenant,omitempty"`
- // Labels lists only projects containing the given labels
+ // Labels filters projects containing the given labels
Labels *v2.Labels `protobuf:"bytes,2,opt,name=labels,proto3,oneof" json:"labels,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -78,10 +78,10 @@ func (x *ProjectServiceListRequest) GetLabels() *v2.Labels {
return nil
}
-// ProjectServiceListResponse is the response payload for the project list request
+// ProjectServiceListResponse is the response payload for listing projects.
type ProjectServiceListResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Projects is a list of all projects
+ // Projects contains the list of projects
Projects []*v2.Project `protobuf:"bytes,1,rep,name=projects,proto3" json:"projects,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
diff --git a/go/metalstack/admin/v2/size.pb.go b/go/metalstack/admin/v2/size.pb.go
index 28b4f208..b0e85a18 100644
--- a/go/metalstack/admin/v2/size.pb.go
+++ b/go/metalstack/admin/v2/size.pb.go
@@ -23,7 +23,7 @@ const (
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
-// SizeServiceCreateRequest is the request payload for a size create request
+// SizeServiceCreateRequest is the request payload for creating a size.
type SizeServiceCreateRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// Size is the size to create
@@ -69,10 +69,10 @@ func (x *SizeServiceCreateRequest) GetSize() *v2.Size {
return nil
}
-// SizeServiceGetResponse is the response payload for a size create request
+// SizeServiceCreateResponse is the response payload for creating a size.
type SizeServiceCreateResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Size the size
+ // Size contains the created size
Size *v2.Size `protobuf:"bytes,1,opt,name=size,proto3" json:"size,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -115,7 +115,7 @@ func (x *SizeServiceCreateResponse) GetSize() *v2.Size {
return nil
}
-// SizeServiceUpdateRequest is the request payload for a size update request
+// SizeServiceUpdateRequest is the request payload for updating a size.
type SizeServiceUpdateRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// Id of this size
@@ -206,10 +206,10 @@ func (x *SizeServiceUpdateRequest) GetLabels() *v2.UpdateLabels {
return nil
}
-// SizeServiceUpdateResponse is the response payload for a size update request
+// SizeServiceUpdateResponse is the response payload for updating a size.
type SizeServiceUpdateResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Size the size
+ // Size contains the updated size
Size *v2.Size `protobuf:"bytes,1,opt,name=size,proto3" json:"size,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -252,7 +252,7 @@ func (x *SizeServiceUpdateResponse) GetSize() *v2.Size {
return nil
}
-// SizeServiceDeleteRequest is the request payload for a size delete request
+// SizeServiceDeleteRequest is the request payload for deleting a size.
type SizeServiceDeleteRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// ID of the size to delete
@@ -298,10 +298,10 @@ func (x *SizeServiceDeleteRequest) GetId() string {
return ""
}
-// SizeServiceDeleteResponse is the response payload for a size delete request
+// SizeServiceDeleteResponse is the response payload for deleting a size.
type SizeServiceDeleteResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Size the size
+ // Size contains the deleted size
Size *v2.Size `protobuf:"bytes,1,opt,name=size,proto3" json:"size,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
diff --git a/go/metalstack/admin/v2/size_imageconstraint.pb.go b/go/metalstack/admin/v2/size_imageconstraint.pb.go
index f1cc8be8..b6bf1359 100644
--- a/go/metalstack/admin/v2/size_imageconstraint.pb.go
+++ b/go/metalstack/admin/v2/size_imageconstraint.pb.go
@@ -23,7 +23,7 @@ const (
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
-// SizeImageConstraintServiceCreateRequest is the request payload for a size image constraint create request
+// SizeImageConstraintServiceCreateRequest is the request payload for creating a size image constraint.
type SizeImageConstraintServiceCreateRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// Size of the constraint
@@ -105,10 +105,10 @@ func (x *SizeImageConstraintServiceCreateRequest) GetDescription() string {
return ""
}
-// SizeImageConstraintServiceCreateResponse is the response payload for a size image constraint create request
+// SizeImageConstraintServiceCreateResponse is the response payload for creating a size image constraint.
type SizeImageConstraintServiceCreateResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // SizeImageConstraint created
+ // SizeImageConstraint contains the created constraint
SizeImageConstraint *v2.SizeImageConstraint `protobuf:"bytes,1,opt,name=size_image_constraint,json=sizeImageConstraint,proto3" json:"size_image_constraint,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -151,7 +151,7 @@ func (x *SizeImageConstraintServiceCreateResponse) GetSizeImageConstraint() *v2.
return nil
}
-// SizeImageConstraintServiceUpdateRequest is the request payload for a size image constraint update request
+// SizeImageConstraintServiceUpdateRequest is the request payload for updating a size image constraint.
type SizeImageConstraintServiceUpdateRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// Size of the image constraint to update
@@ -233,10 +233,10 @@ func (x *SizeImageConstraintServiceUpdateRequest) GetDescription() string {
return ""
}
-// SizeImageConstraintServiceUpdateResponse is the response payload for a size image constraint update request
+// SizeImageConstraintServiceUpdateResponse is the response payload for updating a size image constraint.
type SizeImageConstraintServiceUpdateResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // SizeImageConstraint updated
+ // SizeImageConstraint contains the updated constraint
SizeImageConstraint *v2.SizeImageConstraint `protobuf:"bytes,1,opt,name=size_image_constraint,json=sizeImageConstraint,proto3" json:"size_image_constraint,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -279,7 +279,7 @@ func (x *SizeImageConstraintServiceUpdateResponse) GetSizeImageConstraint() *v2.
return nil
}
-// SizeImageConstraintServiceDeleteRequest is the request payload for a size image constraint delete request
+// SizeImageConstraintServiceDeleteRequest is the request payload for deleting a size image constraint.
type SizeImageConstraintServiceDeleteRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// Size of the constraint
@@ -325,10 +325,10 @@ func (x *SizeImageConstraintServiceDeleteRequest) GetSize() string {
return ""
}
-// SizeImageConstraintServiceDeleteResponse is the response payload for a size image constraint delete request
+// SizeImageConstraintServiceDeleteResponse is the response payload for deleting a size image constraint.
type SizeImageConstraintServiceDeleteResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // SizeImageConstraint deleted
+ // SizeImageConstraint contains the deleted constraint
SizeImageConstraint *v2.SizeImageConstraint `protobuf:"bytes,1,opt,name=size_image_constraint,json=sizeImageConstraint,proto3" json:"size_image_constraint,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -371,7 +371,7 @@ func (x *SizeImageConstraintServiceDeleteResponse) GetSizeImageConstraint() *v2.
return nil
}
-// SizeImageConstraintServiceGetRequest is the request payload for a size image constraint get request
+// SizeImageConstraintServiceGetRequest is the request payload for getting a size image constraint.
type SizeImageConstraintServiceGetRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// Size of the constraint
@@ -417,10 +417,10 @@ func (x *SizeImageConstraintServiceGetRequest) GetSize() string {
return ""
}
-// SizeImageConstraintServiceGetResponse is the response payload for a size image constraint get request
+// SizeImageConstraintServiceGetResponse is the response payload for getting a size image constraint.
type SizeImageConstraintServiceGetResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // SizeImageConstraint get
+ // SizeImageConstraint contains the retrieved constraint
SizeImageConstraint *v2.SizeImageConstraint `protobuf:"bytes,1,opt,name=size_image_constraint,json=sizeImageConstraint,proto3" json:"size_image_constraint,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -463,7 +463,7 @@ func (x *SizeImageConstraintServiceGetResponse) GetSizeImageConstraint() *v2.Siz
return nil
}
-// SizeImageConstraintServiceListRequest is the request payload for a size image constraint list request
+// SizeImageConstraintServiceListRequest is the request payload for listing size image constraints.
type SizeImageConstraintServiceListRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// Query for size image constraints
@@ -509,10 +509,10 @@ func (x *SizeImageConstraintServiceListRequest) GetQuery() *v2.SizeImageConstrai
return nil
}
-// SizeImageConstraintServiceListResponse is the response payload for a size image constraint list request
+// SizeImageConstraintServiceListResponse is the response payload for listing size image constraints.
type SizeImageConstraintServiceListResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // SizeImageConstraints listed
+ // SizeImageConstraints contains the list of constraints
SizeImageConstraints []*v2.SizeImageConstraint `protobuf:"bytes,1,rep,name=size_image_constraints,json=sizeImageConstraints,proto3" json:"size_image_constraints,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
diff --git a/go/metalstack/admin/v2/size_reservation.pb.go b/go/metalstack/admin/v2/size_reservation.pb.go
index d7444eca..55fbefaf 100644
--- a/go/metalstack/admin/v2/size_reservation.pb.go
+++ b/go/metalstack/admin/v2/size_reservation.pb.go
@@ -23,7 +23,7 @@ const (
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
-// SizeReservationServiceCreateRequest is the request payload for a size reservation create request
+// SizeReservationServiceCreateRequest is the request payload for creating a size reservation.
type SizeReservationServiceCreateRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// SizeReservation is the size reservation to create
@@ -69,10 +69,10 @@ func (x *SizeReservationServiceCreateRequest) GetSizeReservation() *v2.SizeReser
return nil
}
-// SizeReservationServiceCreateResponse is the response payload for a size reservation create request
+// SizeReservationServiceCreateResponse is the response payload for creating a size reservation.
type SizeReservationServiceCreateResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // SizeReservation the size reservation
+ // SizeReservation contains the created reservation
SizeReservation *v2.SizeReservation `protobuf:"bytes,1,opt,name=size_reservation,json=sizeReservation,proto3" json:"size_reservation,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -115,7 +115,7 @@ func (x *SizeReservationServiceCreateResponse) GetSizeReservation() *v2.SizeRese
return nil
}
-// SizeReservationServiceUpdateRequest is the request payload for a size reservation update request
+// SizeReservationServiceUpdateRequest is the request payload for updating a size reservation.
type SizeReservationServiceUpdateRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// Id of this size reservation
@@ -215,10 +215,10 @@ func (x *SizeReservationServiceUpdateRequest) GetLabels() *v2.UpdateLabels {
return nil
}
-// SizeReservationServiceUpdateResponse is the response payload for a size reservation update request
+// SizeReservationServiceUpdateResponse is the response payload for updating a size reservation.
type SizeReservationServiceUpdateResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // SizeReservation the size reservation
+ // SizeReservation contains the updated reservation
SizeReservation *v2.SizeReservation `protobuf:"bytes,1,opt,name=size_reservation,json=sizeReservation,proto3" json:"size_reservation,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -261,7 +261,7 @@ func (x *SizeReservationServiceUpdateResponse) GetSizeReservation() *v2.SizeRese
return nil
}
-// SizeReservationServiceDeleteRequest is the request payload for a size reservation delete request
+// SizeReservationServiceDeleteRequest is the request payload for deleting a size reservation.
type SizeReservationServiceDeleteRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// ID of the size reservation to delete
@@ -307,10 +307,10 @@ func (x *SizeReservationServiceDeleteRequest) GetId() string {
return ""
}
-// SizeReservationServiceDeleteResponse is the response payload for a size reservation delete request
+// SizeReservationServiceDeleteResponse is the response payload for deleting a size reservation.
type SizeReservationServiceDeleteResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // SizeReservation the size reservation
+ // SizeReservation contains the deleted reservation
SizeReservation *v2.SizeReservation `protobuf:"bytes,1,opt,name=size_reservation,json=sizeReservation,proto3" json:"size_reservation,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -353,7 +353,7 @@ func (x *SizeReservationServiceDeleteResponse) GetSizeReservation() *v2.SizeRese
return nil
}
-// SizeReservationServiceListRequest is the request payload for a size list request
+// SizeReservationServiceListRequest is the request payload for listing size reservations.
type SizeReservationServiceListRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// Query for size reservations
@@ -399,10 +399,10 @@ func (x *SizeReservationServiceListRequest) GetQuery() *v2.SizeReservationQuery
return nil
}
-// SizeReservationServiceListResponse is the response payload for a size reservation list request
+// SizeReservationServiceListResponse is the response payload for listing size reservations.
type SizeReservationServiceListResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Size reservations
+ // SizeReservations contains the list of reservations
SizeReservations []*v2.SizeReservation `protobuf:"bytes,1,rep,name=size_reservations,json=sizeReservations,proto3" json:"size_reservations,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 c5445478..73791ca4 100644
--- a/go/metalstack/admin/v2/switch.pb.go
+++ b/go/metalstack/admin/v2/switch.pb.go
@@ -24,10 +24,10 @@ const (
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
-// SwitchServiceGetRequest.
+// SwitchServiceGetRequest is the request payload for getting a switch.
type SwitchServiceGetRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Id of the switch to get.
+ // Id of the switch to get
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -70,10 +70,10 @@ func (x *SwitchServiceGetRequest) GetId() string {
return ""
}
-// SwitchServiceGetResponse.
+// SwitchServiceGetResponse is the response payload for getting a switch.
type SwitchServiceGetResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Switch that was requested.
+ // Switch contains the requested switch
Switch *v2.Switch `protobuf:"bytes,1,opt,name=switch,proto3" json:"switch,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -116,10 +116,10 @@ func (x *SwitchServiceGetResponse) GetSwitch() *v2.Switch {
return nil
}
-// SwitchServiceListRequest.
+// SwitchServiceListRequest is the request payload for listing switches.
type SwitchServiceListRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Query to filter the results.
+ // Query to filter the results
Query *v2.SwitchQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -162,10 +162,10 @@ func (x *SwitchServiceListRequest) GetQuery() *v2.SwitchQuery {
return nil
}
-// SwitchServiceListResponse.
+// SwitchServiceListResponse is the response payload for listing switches.
type SwitchServiceListResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Switches that match the request query.
+ // Switches that match the request query
Switches []*v2.Switch `protobuf:"bytes,1,rep,name=switches,proto3" json:"switches,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -208,29 +208,29 @@ func (x *SwitchServiceListResponse) GetSwitches() []*v2.Switch {
return nil
}
-// SwitchServiceUpdateRequest.
+// SwitchServiceUpdateRequest is the request payload for updating a switch.
type SwitchServiceUpdateRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // ID of the switch.
+ // ID of the switch
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
- // UpdateMeta contains the timestamp and strategy to be used in this update request.
+ // UpdateMeta contains the timestamp and strategy to be used in this update request
UpdateMeta *v2.UpdateMeta `protobuf:"bytes,2,opt,name=update_meta,json=updateMeta,proto3" json:"update_meta,omitempty"`
- // UpdatedAt is the date when this entity was updated.
- // must be part of the update request to ensure optimistic locking.
+ // UpdatedAt is the date when this entity was updated
+ // Must be part of the update request to ensure optimistic locking
UpdatedAt *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
- // Description of the switch.
+ // Description of the switch
Description *string `protobuf:"bytes,4,opt,name=description,proto3,oneof" json:"description,omitempty"`
- // Replace mode is used to mark a switch ready for replacement.
+ // ReplaceMode is used to mark a switch ready for replacement
ReplaceMode *v2.SwitchReplaceMode `protobuf:"varint,5,opt,name=replace_mode,json=replaceMode,proto3,enum=metalstack.api.v2.SwitchReplaceMode,oneof" json:"replace_mode,omitempty"`
- // Management IP is the switch's IP for management access.
+ // ManagementIp is the switch's IP for management access
ManagementIp *string `protobuf:"bytes,6,opt,name=management_ip,json=managementIp,proto3,oneof" json:"management_ip,omitempty"`
- // Management user is the user name to use for management access.
+ // ManagementUser is the user name to use for management access
ManagementUser *string `protobuf:"bytes,7,opt,name=management_user,json=managementUser,proto3,oneof" json:"management_user,omitempty"`
- // Console command is the command for accessing the switch's console.
+ // ConsoleCommand is the command for accessing the switch's console
ConsoleCommand *string `protobuf:"bytes,8,opt,name=console_command,json=consoleCommand,proto3,oneof" json:"console_command,omitempty"`
- // Nics are the front panel ports of the switch.
+ // Nics are the front panel ports of the switch
Nics []*v2.SwitchNic `protobuf:"bytes,9,rep,name=nics,proto3" json:"nics,omitempty"`
- // SwitchOs is the OS running on the switch.
+ // SwitchOs is the OS running on the switch
Os *v2.SwitchOS `protobuf:"bytes,10,opt,name=os,proto3,oneof" json:"os,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -336,10 +336,10 @@ func (x *SwitchServiceUpdateRequest) GetOs() *v2.SwitchOS {
return nil
}
-// SwitchServiceUpdateResponse.
+// SwitchServiceUpdateResponse is the response payload for updating a switch.
type SwitchServiceUpdateResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Switch that was updated.
+ // Switch contains the updated switch
Switch *v2.Switch `protobuf:"bytes,1,opt,name=switch,proto3" json:"switch,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -382,12 +382,12 @@ func (x *SwitchServiceUpdateResponse) GetSwitch() *v2.Switch {
return nil
}
-// SwitchServiceDeleteRequest.
+// SwitchServiceDeleteRequest is the request payload for deleting a switch.
type SwitchServiceDeleteRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Id of the switch.
+ // Id of the switch
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
- // Force will allow switch deletion despite existing machine connections.
+ // Force will allow switch deletion despite existing machine connections
Force bool `protobuf:"varint,2,opt,name=force,proto3" json:"force,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -437,10 +437,10 @@ func (x *SwitchServiceDeleteRequest) GetForce() bool {
return false
}
-// SwitchServiceDeleteResponse.
+// SwitchServiceDeleteResponse is the response payload for deleting a switch.
type SwitchServiceDeleteResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Switch that has been deleted.
+ // Switch contains the deleted switch
Switch *v2.Switch `protobuf:"bytes,1,opt,name=switch,proto3" json:"switch,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -483,12 +483,12 @@ func (x *SwitchServiceDeleteResponse) GetSwitch() *v2.Switch {
return nil
}
-// SwitchServiceMigrateRequest.
+// SwitchServiceMigrateRequest is the request payload for migrating a switch.
type SwitchServiceMigrateRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // OldSwitch which to migrate away from.
+ // OldSwitch is the switch to migrate away from
OldSwitch string `protobuf:"bytes,1,opt,name=old_switch,json=oldSwitch,proto3" json:"old_switch,omitempty"`
- // NewSwitch which to migrate to.
+ // NewSwitch is the switch to migrate to
NewSwitch string `protobuf:"bytes,2,opt,name=new_switch,json=newSwitch,proto3" json:"new_switch,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -538,10 +538,10 @@ func (x *SwitchServiceMigrateRequest) GetNewSwitch() string {
return ""
}
-// SwitchServiceMigrateResponse.
+// SwitchServiceMigrateResponse is the response payload for migrating a switch.
type SwitchServiceMigrateResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Switch that was migrated to.
+ // Switch contains the switch was migrated to
Switch *v2.Switch `protobuf:"bytes,1,opt,name=switch,proto3" json:"switch,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -584,14 +584,14 @@ func (x *SwitchServiceMigrateResponse) GetSwitch() *v2.Switch {
return nil
}
-// SwitchServicePortRequest.
+// SwitchServicePortRequest is the request payload for setting the port status of a switch port.
type SwitchServicePortRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Id of the switch.
+ // Id of the switch
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
- // NicName of the port whose status should be changed.
+ // NicName of the port whose status should be changed
NicName string `protobuf:"bytes,2,opt,name=nic_name,json=nicName,proto3" json:"nic_name,omitempty"`
- // Status that the port should have.
+ // Status that the port should have
Status v2.SwitchPortStatus `protobuf:"varint,3,opt,name=status,proto3,enum=metalstack.api.v2.SwitchPortStatus" json:"status,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -648,10 +648,10 @@ func (x *SwitchServicePortRequest) GetStatus() v2.SwitchPortStatus {
return v2.SwitchPortStatus(0)
}
-// SwitchServicePortResponse.
+// SwitchServicePortResponse is the response payload for setting the port status of a switch port.
type SwitchServicePortResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Switch after the port status toggle..
+ // Switch after the port status toggle
Switch *v2.Switch `protobuf:"bytes,1,opt,name=switch,proto3" json:"switch,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -694,12 +694,12 @@ func (x *SwitchServicePortResponse) GetSwitch() *v2.Switch {
return nil
}
-// SwitchServiceConnectedMachinesRequest.
+// SwitchServiceConnectedMachinesRequest is the request payload for listing switches with machine connections.
type SwitchServiceConnectedMachinesRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Query to filter the switch results.
+ // Query to filter the switch results
Query *v2.SwitchQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
- // MachineQuery to filter the machine results.
+ // MachineQuery to filter the machine results
MachineQuery *v2.MachineQuery `protobuf:"bytes,2,opt,name=machine_query,json=machineQuery,proto3" json:"machine_query,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -749,10 +749,10 @@ func (x *SwitchServiceConnectedMachinesRequest) GetMachineQuery() *v2.MachineQue
return nil
}
-// SwitchServiceConnectedMachinesResponse.
+// SwitchServiceConnectedMachinesResponse is the response payload for listing switches with machine connections.
type SwitchServiceConnectedMachinesResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // SwitchesWithMachines contains all switches with their machine connections.
+ // SwitchesWithMachines contains all switches with their machine connections
SwitchesWithMachines []*v2.SwitchWithMachines `protobuf:"bytes,1,rep,name=switches_with_machines,json=switchesWithMachines,proto3" json:"switches_with_machines,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
diff --git a/go/metalstack/admin/v2/task.pb.go b/go/metalstack/admin/v2/task.pb.go
index 7c89594d..f18c48a8 100644
--- a/go/metalstack/admin/v2/task.pb.go
+++ b/go/metalstack/admin/v2/task.pb.go
@@ -24,25 +24,25 @@ const (
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
-// TaskState defines the state of the task
+// TaskState defines the state of the task.
type TaskState int32
const (
- // TASK_STATE_UNSPECIFIED indicates a undefined state
+ // TASK_STATE_UNSPECIFIED is not specified
TaskState_TASK_STATE_UNSPECIFIED TaskState = 0
- // TASK_STATE_ACTIVE indicates that the task is currently being processed by Handler.
+ // TASK_STATE_ACTIVE indicates that the task is currently being processed by Handler
TaskState_TASK_STATE_ACTIVE TaskState = 1
- // TASK_STATE_PENDING indicates that the task is ready to be processed by Handler.
+ // TASK_STATE_PENDING indicates that the task is ready to be processed by Handler
TaskState_TASK_STATE_PENDING TaskState = 2
- // TASK_STATE_SCHEDULED indicates that the task is scheduled to be processed some time in the future.
+ // TASK_STATE_SCHEDULED indicates that the task is scheduled to be processed some time in the future
TaskState_TASK_STATE_SCHEDULED TaskState = 3
- // TASK_STATE_RETRY indicates that the task has previously failed and scheduled to be processed some time in the future.
+ // TASK_STATE_RETRY indicates that the task has previously failed and is scheduled to be processed some time in the future
TaskState_TASK_STATE_RETRY TaskState = 4
- // TASK_STATE_ARCHIVED indicates that the task is archived and stored for inspection purposes.
+ // TASK_STATE_ARCHIVED indicates that the task is archived and stored for inspection purposes
TaskState_TASK_STATE_ARCHIVED TaskState = 5
- // TASK_STATE_COMPLETED indicates that the task is processed successfully and retained until the retention TTL expires.
+ // TASK_STATE_COMPLETED indicates that the task is processed successfully and retained until the retention TTL expires
TaskState_TASK_STATE_COMPLETED TaskState = 6
- // TASK_STATE_AGGREGATING indicates that the task is waiting in a group to be aggregated into one task.
+ // TASK_STATE_AGGREGATING indicates that the task is waiting in a group to be aggregated into one task
TaskState_TASK_STATE_AGGREGATING TaskState = 7
)
@@ -97,12 +97,12 @@ func (TaskState) EnumDescriptor() ([]byte, []int) {
return file_metalstack_admin_v2_task_proto_rawDescGZIP(), []int{0}
}
-// TaskServiceGetRequest is the message to a get task request
+// TaskServiceGetRequest is the request payload for getting a task.
type TaskServiceGetRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // TaskId to get
+ // TaskId is the identifier of the task to get
TaskId string `protobuf:"bytes,1,opt,name=task_id,json=taskId,proto3" json:"task_id,omitempty"`
- // Queue where this task was scheduled to
+ // Queue is the queue where this task was scheduled to
Queue string `protobuf:"bytes,2,opt,name=queue,proto3" json:"queue,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -152,7 +152,7 @@ func (x *TaskServiceGetRequest) GetQueue() string {
return ""
}
-// TaskServiceGetResponse is the response to a task get request
+// TaskServiceGetResponse is the response payload for getting a task.
type TaskServiceGetResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
// Task contains the task details
@@ -198,12 +198,12 @@ func (x *TaskServiceGetResponse) GetTask() *TaskInfo {
return nil
}
-// TaskServiceDeleteRequest is the message to a delete task request
+// TaskServiceDeleteRequest is the request payload for deleting a task.
type TaskServiceDeleteRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // TaskId to cancel
+ // TaskId is the identifier of the task to cancel
TaskId string `protobuf:"bytes,1,opt,name=task_id,json=taskId,proto3" json:"task_id,omitempty"`
- // Queue where this task was scheduled to
+ // Queue is the queue where this task was scheduled to
Queue string `protobuf:"bytes,2,opt,name=queue,proto3" json:"queue,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -253,7 +253,7 @@ func (x *TaskServiceDeleteRequest) GetQueue() string {
return ""
}
-// TaskServiceDeleteResponse is the response to a task delete request
+// TaskServiceDeleteResponse is the response payload for deleting a task.
type TaskServiceDeleteResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
unknownFields protoimpl.UnknownFields
@@ -290,7 +290,7 @@ func (*TaskServiceDeleteResponse) Descriptor() ([]byte, []int) {
return file_metalstack_admin_v2_task_proto_rawDescGZIP(), []int{3}
}
-// TaskServiceQueuesRequest is the message to get all queues
+// TaskServiceQueuesRequest is the request payload for getting all queues.
type TaskServiceQueuesRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
unknownFields protoimpl.UnknownFields
@@ -327,7 +327,7 @@ func (*TaskServiceQueuesRequest) Descriptor() ([]byte, []int) {
return file_metalstack_admin_v2_task_proto_rawDescGZIP(), []int{4}
}
-// TaskServiceQueuesResponse is the response to a queues request
+// TaskServiceQueuesResponse is the response payload for getting all queues.
type TaskServiceQueuesResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
// Queues configured for the async system
@@ -373,15 +373,15 @@ func (x *TaskServiceQueuesResponse) GetQueues() []string {
return nil
}
-// TaskServiceListRequest is the message to a task list request
+// TaskServiceListRequest is the request payload for listing tasks.
type TaskServiceListRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Queue where this tasks should be listed
- // will return tasks from all queues if not specified
+ // Queue filters tasks by this queue
+ // Will return tasks from all queues if not specified
Queue *string `protobuf:"bytes,1,opt,name=queue,proto3,oneof" json:"queue,omitempty"`
- // Count of tasks to return
+ // Count is the number of tasks to return
Count *uint32 `protobuf:"varint,2,opt,name=count,proto3,oneof" json:"count,omitempty"`
- // Page of tasks to return
+ // Page is the page of tasks to return
Page *uint32 `protobuf:"varint,3,opt,name=page,proto3,oneof" json:"page,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -438,10 +438,10 @@ func (x *TaskServiceListRequest) GetPage() uint32 {
return 0
}
-// TaskServiceListResponse is the response to a task list request
+// TaskServiceListResponse is the response payload for listing tasks.
type TaskServiceListResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Tasks contains the requested list of tasks
+ // Tasks contains the list of requested tasks
Tasks []*TaskInfo `protobuf:"bytes,1,rep,name=tasks,proto3" json:"tasks,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -484,56 +484,56 @@ func (x *TaskServiceListResponse) GetTasks() []*TaskInfo {
return nil
}
-// TaskInfo contains details of an async task
+// TaskInfo contains details of an asynchronous task.
type TaskInfo struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // ID is the identifier of the task.
+ // ID is the identifier of the task
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
- // Queue is the name of the queue in which the task belongs.
+ // Queue is the name of the queue in which the task belongs
Queue string `protobuf:"bytes,2,opt,name=queue,proto3" json:"queue,omitempty"`
- // Type is the type name of the task.
+ // Type is the type name of the task
Type string `protobuf:"bytes,3,opt,name=type,proto3" json:"type,omitempty"`
- // Payload is the payload data of the task.
+ // Payload is the payload data of the task
Payload []byte `protobuf:"bytes,4,opt,name=payload,proto3" json:"payload,omitempty"`
- // State indicates the task state.
+ // State indicates the task state
State TaskState `protobuf:"varint,5,opt,name=state,proto3,enum=metalstack.admin.v2.TaskState" json:"state,omitempty"`
- // MaxRetry is the maximum number of times the task can be retried.
+ // MaxRetry is the maximum number of times the task can be retried
MaxRetry int32 `protobuf:"varint,6,opt,name=max_retry,json=maxRetry,proto3" json:"max_retry,omitempty"`
- // Retried is the number of times the task has retried so far.
+ // Retried is the number of times the task has retried so far
Retried int32 `protobuf:"varint,7,opt,name=retried,proto3" json:"retried,omitempty"`
- // LastError is the error message from the last failure.
+ // LastError is the error message from the last failure
LastError string `protobuf:"bytes,8,opt,name=last_error,json=lastError,proto3" json:"last_error,omitempty"`
- // LastFailedAt is the time time of the last failure if any.
- // If the task has no failures, LastFailedAt is zero time (i.e. time.Time{}).
+ // LastFailedAt is the time of the last failure if any
+ // If the task has no failures, LastFailedAt is zero time (i.e. time.Time{})
LastFailedAt *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=last_failed_at,json=lastFailedAt,proto3" json:"last_failed_at,omitempty"`
- // Timeout is the duration the task can be processed by Handler before being retried,
+ // Timeout is the duration the task can be processed by Handler before being retried
Timeout *durationpb.Duration `protobuf:"bytes,10,opt,name=timeout,proto3" json:"timeout,omitempty"`
- // Deadline is the deadline for the task.
+ // Deadline is the deadline for the task
Deadline *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=deadline,proto3" json:"deadline,omitempty"`
- // Group is the name of the group in which the task belongs.
+ // Group is the name of the group in which the task belongs
//
// Tasks in the same queue can be grouped together by Group name and will be aggregated into one task
- // by a Server processing the queue.
+ // by a Server processing the queue
//
- // Empty string (default) indicates task does not belong to any groups, and no aggregation will be applied to the task.
+ // Empty string (default) indicates task does not belong to any groups, and no aggregation will be applied to the task
Group string `protobuf:"bytes,12,opt,name=group,proto3" json:"group,omitempty"`
- // NextProcessAt is the time the task is scheduled to be processed,
- // zero if not applicable.
+ // NextProcessAt is the time the task is scheduled to be processed
+ // Zero if not applicable
NextProcessAt *timestamppb.Timestamp `protobuf:"bytes,13,opt,name=next_process_at,json=nextProcessAt,proto3" json:"next_process_at,omitempty"`
- // IsOrphaned describes whether the task is left in active state with no worker processing it.
+ // IsOrphaned describes whether the task is left in active state with no worker processing it
// An orphaned task indicates that the worker has crashed or experienced network failures and was not able to
- // extend its lease on the task.
+ // extend its lease on the task
//
- // This task will be recovered by running a server against the queue the task is in.
- // This field is only applicable to tasks with TaskStateActive.
+ // This task will be recovered by running a server against the queue the task is in
+ // This field is only applicable to tasks with TaskStateActive
IsOrphaned bool `protobuf:"varint,14,opt,name=is_orphaned,json=isOrphaned,proto3" json:"is_orphaned,omitempty"`
- // Retention is duration of the retention period after the task is successfully processed.
+ // Retention is duration of the retention period after the task is successfully processed
Retention *durationpb.Duration `protobuf:"bytes,15,opt,name=retention,proto3" json:"retention,omitempty"`
- // CompletedAt is the time when the task is processed successfully.
- // Zero value (i.e. time.Time{}) indicates no value.
+ // CompletedAt is the time when the task is processed successfully
+ // Zero value (i.e. time.Time{}) indicates no value
CompletedAt *timestamppb.Timestamp `protobuf:"bytes,16,opt,name=completed_at,json=completedAt,proto3" json:"completed_at,omitempty"`
- // Result holds the result data associated with the task.
- // Use ResultWriter to write result data from the Handler.
+ // Result holds the result data associated with the task
+ // Use ResultWriter to write result data from the Handler
Result []byte `protobuf:"bytes,17,opt,name=result,proto3" json:"result,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
diff --git a/go/metalstack/admin/v2/tenant.pb.go b/go/metalstack/admin/v2/tenant.pb.go
index 03aebe2e..e7a89f13 100644
--- a/go/metalstack/admin/v2/tenant.pb.go
+++ b/go/metalstack/admin/v2/tenant.pb.go
@@ -23,12 +23,12 @@ const (
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
-// TenantServiceCreateRequest is the request payload of the tenant create request
+// TenantServiceCreateRequest is the request payload for creating a tenant.
type TenantServiceCreateRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Name of this tenant
+ // Name of the tenant
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
- // Description of this tenant
+ // Description of the tenant
Description *string `protobuf:"bytes,2,opt,name=description,proto3,oneof" json:"description,omitempty"`
// Email of the tenant, if not set will be inherited from the creator
Email *string `protobuf:"bytes,3,opt,name=email,proto3,oneof" json:"email,omitempty"`
@@ -105,10 +105,10 @@ func (x *TenantServiceCreateRequest) GetLabels() *v2.Labels {
return nil
}
-// TenantServiceCreateResponse is the response payload of the tenant create request
+// TenantServiceCreateResponse is the response payload for creating a tenant.
type TenantServiceCreateResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Tenant is the tenant
+ // Tenant contains the created tenant
Tenant *v2.Tenant `protobuf:"bytes,1,opt,name=tenant,proto3" json:"tenant,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -151,12 +151,12 @@ func (x *TenantServiceCreateResponse) GetTenant() *v2.Tenant {
return nil
}
-// TenantServiceListRequest is the request payload for a tenant list request
+// TenantServiceListRequest is the request payload for listing tenants.
type TenantServiceListRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Login of the tenant to list
+ // Login filters tenants by this login
Login *string `protobuf:"bytes,1,opt,name=login,proto3,oneof" json:"login,omitempty"`
- // Name of the tenant to list
+ // Name filters tenants by this name
Name *string `protobuf:"bytes,2,opt,name=name,proto3,oneof" json:"name,omitempty"`
// Paging details for the list request
Paging *v2.Paging `protobuf:"bytes,3,opt,name=paging,proto3" json:"paging,omitempty"`
@@ -215,12 +215,12 @@ func (x *TenantServiceListRequest) GetPaging() *v2.Paging {
return nil
}
-// TenantServiceListResponse is the response payload for a tenant list request
+// TenantServiceListResponse is the response payload for listing tenants.
type TenantServiceListResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Tenants are the list of tenants
+ // Tenants contains the list of tenants
Tenants []*v2.Tenant `protobuf:"bytes,1,rep,name=tenants,proto3" json:"tenants,omitempty"`
- // NextPage is used for pagination, returns the next page to be fetched and must then be provided in the list request.
+ // NextPage is used for pagination, returns the next page to be fetched and must then be provided in the list request
NextPage *uint64 `protobuf:"varint,2,opt,name=next_page,json=nextPage,proto3,oneof" json:"next_page,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
diff --git a/go/metalstack/admin/v2/token.pb.go b/go/metalstack/admin/v2/token.pb.go
index feb7991b..53fdfc05 100644
--- a/go/metalstack/admin/v2/token.pb.go
+++ b/go/metalstack/admin/v2/token.pb.go
@@ -23,7 +23,7 @@ const (
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
-// TokenServiceListRequest is the request payload for the token list request
+// TokenServiceListRequest is the request payload for listing tokens.
type TokenServiceListRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// User is the id of the user for which the tokens should be listed
@@ -69,10 +69,10 @@ func (x *TokenServiceListRequest) GetUser() string {
return ""
}
-// TokenServiceListResponse is the response payload for the token list request
+// TokenServiceListResponse is the response payload for listing tokens.
type TokenServiceListResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Tokens is the list of tokens
+ // Tokens contains the list of tokens
Tokens []*v2.Token `protobuf:"bytes,1,rep,name=tokens,proto3" json:"tokens,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -115,7 +115,7 @@ func (x *TokenServiceListResponse) GetTokens() []*v2.Token {
return nil
}
-// TokenServiceRevokeRequest is the request payload for the token revoke request
+// TokenServiceRevokeRequest is the request payload for revoking a token.
type TokenServiceRevokeRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// Uuid is the uuid of the token which should be revoked
@@ -170,7 +170,7 @@ func (x *TokenServiceRevokeRequest) GetUser() string {
return ""
}
-// TokenServiceRevokeResponse is the response payload for the token revoke request
+// TokenServiceRevokeResponse is the response payload for revoking a token.
type TokenServiceRevokeResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
unknownFields protoimpl.UnknownFields
@@ -207,7 +207,7 @@ func (*TokenServiceRevokeResponse) Descriptor() ([]byte, []int) {
return file_metalstack_admin_v2_token_proto_rawDescGZIP(), []int{3}
}
-// TokenServiceCreateRequest is the request payload to create a token
+// TokenServiceCreateRequest is the request payload for creating a token.
type TokenServiceCreateRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// User this token should be created for, if omitted, user is derived from caller
@@ -262,12 +262,12 @@ func (x *TokenServiceCreateRequest) GetTokenCreateRequest() *v2.TokenServiceCrea
return nil
}
-// TokenServiceCreateResponse is the response payload of a token create request
+// TokenServiceCreateResponse is the response payload for creating a token.
type TokenServiceCreateResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Token which was created
+ // Token contains the created token
Token *v2.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 if 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/admin/v2/vpn.pb.go b/go/metalstack/admin/v2/vpn.pb.go
index 84f271fd..16836a4b 100644
--- a/go/metalstack/admin/v2/vpn.pb.go
+++ b/go/metalstack/admin/v2/vpn.pb.go
@@ -25,17 +25,17 @@ const (
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
-// VPNServiceAuthKeyRequest is the request payload for a vpn authkey request.
+// VPNServiceAuthKeyRequest is the request payload for generating a VPN authentication key.
type VPNServiceAuthKeyRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Project for which a vpn authkey should be generated.
+ // Project for which a VPN authentication key should be generated
Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"`
- // Ephemeral defines if the authkey should be ephemeral.
+ // Ephemeral defines if the authentication key should be ephemeral
Ephemeral bool `protobuf:"varint,2,opt,name=ephemeral,proto3" json:"ephemeral,omitempty"`
- // Expires defines the duration after which the authkey expires.
+ // Expires defines the duration after which the authentication key expires
Expires *durationpb.Duration `protobuf:"bytes,3,opt,name=expires,proto3" json:"expires,omitempty"`
- // Reason must be provided why access to the vpn is requested
- // reason is only forwarded to a audit sink
+ // Reason must be provided why access to the VPN is requested
+ // Reason is only forwarded to an audit sink
Reason string `protobuf:"bytes,4,opt,name=reason,proto3" json:"reason,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -99,19 +99,19 @@ func (x *VPNServiceAuthKeyRequest) GetReason() string {
return ""
}
-// VPNServiceAuthKeyResponse is the request payload for a authkey response
+// VPNServiceAuthKeyResponse is the response payload for generating a VPN authentication key.
type VPNServiceAuthKeyResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Address is the address of the vpn control plane.
+ // Address is the address of the VPN control plane
Address string `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"`
- // AuthKey is the key to connect to the vpn at the given address.
- // This key can only be seen once.
+ // AuthKey is the key to connect to the VPN at the given address
+ // This key can only be seen once
AuthKey string `protobuf:"bytes,2,opt,name=auth_key,json=authKey,proto3" json:"auth_key,omitempty"`
- // Ephemeral defines if the authkey should be ephemeral.
+ // Ephemeral defines if the authentication key should be ephemeral
Ephemeral bool `protobuf:"varint,3,opt,name=ephemeral,proto3" json:"ephemeral,omitempty"`
- // ExpiresAt this key cannot be used after this timestamp.
+ // ExpiresAt this key cannot be used after this timestamp
ExpiresAt *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"`
- // CreatedAt this key was created at this timestamp.
+ // CreatedAt this key was created at this timestamp
CreatedAt *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -182,10 +182,10 @@ func (x *VPNServiceAuthKeyResponse) GetCreatedAt() *timestamppb.Timestamp {
return nil
}
-// VPNServiceListNodesRequest is the request payload for a vpn list nodes request
+// VPNServiceListNodesRequest is the request payload for listing VPN nodes.
type VPNServiceListNodesRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Project if given only nodes of this user are returned
+ // Project filters nodes by this project
Project *string `protobuf:"bytes,1,opt,name=project,proto3,oneof" json:"project,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -228,10 +228,10 @@ func (x *VPNServiceListNodesRequest) GetProject() string {
return ""
}
-// VPNServiceListNodesResponse is the response payload for a vpn list nodes request
+// VPNServiceListNodesResponse is the response payload for listing VPN nodes.
type VPNServiceListNodesResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Nodes connected to the vpn
+ // Nodes connected to the VPN
Nodes []*v2.VPNNode `protobuf:"bytes,1,rep,name=nodes,proto3" json:"nodes,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
diff --git a/go/metalstack/api/v2/apiv2connect/audit.connect.go b/go/metalstack/api/v2/apiv2connect/audit.connect.go
index ec0a7592..df8ceb7d 100644
--- a/go/metalstack/api/v2/apiv2connect/audit.connect.go
+++ b/go/metalstack/api/v2/apiv2connect/audit.connect.go
@@ -41,9 +41,9 @@ const (
// AuditServiceClient is a client for the metalstack.api.v2.AuditService service.
type AuditServiceClient interface {
- // Get an audit trace
+ // Returns the audit trace with the specified UUID.
Get(context.Context, *v2.AuditServiceGetRequest) (*v2.AuditServiceGetResponse, error)
- // List audit traces
+ // Returns the list of audit traces.
List(context.Context, *v2.AuditServiceListRequest) (*v2.AuditServiceListResponse, error)
}
@@ -99,9 +99,9 @@ func (c *auditServiceClient) List(ctx context.Context, req *v2.AuditServiceListR
// AuditServiceHandler is an implementation of the metalstack.api.v2.AuditService service.
type AuditServiceHandler interface {
- // Get an audit trace
+ // Returns the audit trace with the specified UUID.
Get(context.Context, *v2.AuditServiceGetRequest) (*v2.AuditServiceGetResponse, error)
- // List audit traces
+ // Returns the list of audit traces.
List(context.Context, *v2.AuditServiceListRequest) (*v2.AuditServiceListResponse, error)
}
diff --git a/go/metalstack/api/v2/apiv2connect/filesystem.connect.go b/go/metalstack/api/v2/apiv2connect/filesystem.connect.go
index 59167218..9f0439fc 100644
--- a/go/metalstack/api/v2/apiv2connect/filesystem.connect.go
+++ b/go/metalstack/api/v2/apiv2connect/filesystem.connect.go
@@ -43,11 +43,11 @@ const (
// FilesystemServiceClient is a client for the metalstack.api.v2.FilesystemService service.
type FilesystemServiceClient interface {
- // Get a filesystem
+ // Returns the filesystem with the specified ID.
Get(context.Context, *v2.FilesystemServiceGetRequest) (*v2.FilesystemServiceGetResponse, error)
- // List all filesystems
+ // Returns the list of all filesystems.
List(context.Context, *v2.FilesystemServiceListRequest) (*v2.FilesystemServiceListResponse, error)
- // Match a filesystems
+ // Matches a filesystem to a size and image or machine.
Match(context.Context, *v2.FilesystemServiceMatchRequest) (*v2.FilesystemServiceMatchResponse, error)
}
@@ -119,11 +119,11 @@ func (c *filesystemServiceClient) Match(ctx context.Context, req *v2.FilesystemS
// FilesystemServiceHandler is an implementation of the metalstack.api.v2.FilesystemService service.
type FilesystemServiceHandler interface {
- // Get a filesystem
+ // Returns the filesystem with the specified ID.
Get(context.Context, *v2.FilesystemServiceGetRequest) (*v2.FilesystemServiceGetResponse, error)
- // List all filesystems
+ // Returns the list of all filesystems.
List(context.Context, *v2.FilesystemServiceListRequest) (*v2.FilesystemServiceListResponse, error)
- // Match a filesystems
+ // Matches a filesystem to a size and image or machine.
Match(context.Context, *v2.FilesystemServiceMatchRequest) (*v2.FilesystemServiceMatchResponse, error)
}
diff --git a/go/metalstack/api/v2/apiv2connect/health.connect.go b/go/metalstack/api/v2/apiv2connect/health.connect.go
index c35167f2..b0703610 100644
--- a/go/metalstack/api/v2/apiv2connect/health.connect.go
+++ b/go/metalstack/api/v2/apiv2connect/health.connect.go
@@ -39,7 +39,7 @@ const (
// HealthServiceClient is a client for the metalstack.api.v2.HealthService service.
type HealthServiceClient interface {
- // Get the health of the platform
+ // Returns the health status of the platform.
Get(context.Context, *v2.HealthServiceGetRequest) (*v2.HealthServiceGetResponse, error)
}
@@ -79,7 +79,7 @@ func (c *healthServiceClient) Get(ctx context.Context, req *v2.HealthServiceGetR
// HealthServiceHandler is an implementation of the metalstack.api.v2.HealthService service.
type HealthServiceHandler interface {
- // Get the health of the platform
+ // Returns the health status of the platform.
Get(context.Context, *v2.HealthServiceGetRequest) (*v2.HealthServiceGetResponse, error)
}
diff --git a/go/metalstack/api/v2/apiv2connect/image.connect.go b/go/metalstack/api/v2/apiv2connect/image.connect.go
index a8886fef..5a44e8a7 100644
--- a/go/metalstack/api/v2/apiv2connect/image.connect.go
+++ b/go/metalstack/api/v2/apiv2connect/image.connect.go
@@ -43,11 +43,11 @@ const (
// ImageServiceClient is a client for the metalstack.api.v2.ImageService service.
type ImageServiceClient interface {
- // Get a image
+ // Returns the image with the specified ID.
Get(context.Context, *v2.ImageServiceGetRequest) (*v2.ImageServiceGetResponse, error)
- // List all images
+ // Returns the list of all images.
List(context.Context, *v2.ImageServiceListRequest) (*v2.ImageServiceListResponse, error)
- // Latest image for a specific os
+ // Returns the latest image for a specific operating system.
Latest(context.Context, *v2.ImageServiceLatestRequest) (*v2.ImageServiceLatestResponse, error)
}
@@ -119,11 +119,11 @@ func (c *imageServiceClient) Latest(ctx context.Context, req *v2.ImageServiceLat
// ImageServiceHandler is an implementation of the metalstack.api.v2.ImageService service.
type ImageServiceHandler interface {
- // Get a image
+ // Returns the image with the specified ID.
Get(context.Context, *v2.ImageServiceGetRequest) (*v2.ImageServiceGetResponse, error)
- // List all images
+ // Returns the list of all images.
List(context.Context, *v2.ImageServiceListRequest) (*v2.ImageServiceListResponse, error)
- // Latest image for a specific os
+ // Returns the latest image for a specific operating system.
Latest(context.Context, *v2.ImageServiceLatestRequest) (*v2.ImageServiceLatestResponse, error)
}
diff --git a/go/metalstack/api/v2/apiv2connect/ip.connect.go b/go/metalstack/api/v2/apiv2connect/ip.connect.go
index a9b68e95..00bb2709 100644
--- a/go/metalstack/api/v2/apiv2connect/ip.connect.go
+++ b/go/metalstack/api/v2/apiv2connect/ip.connect.go
@@ -47,15 +47,15 @@ const (
// IPServiceClient is a client for the metalstack.api.v2.IPService service.
type IPServiceClient interface {
- // Get a ip
+ // Returns the IP address with the specified IP.
Get(context.Context, *v2.IPServiceGetRequest) (*v2.IPServiceGetResponse, error)
- // Create a ip
+ // Creates a new IP address.
Create(context.Context, *v2.IPServiceCreateRequest) (*v2.IPServiceCreateResponse, error)
- // Update a ip
+ // Updates an IP address.
Update(context.Context, *v2.IPServiceUpdateRequest) (*v2.IPServiceUpdateResponse, error)
- // List all ips
+ // Returns the list of all IP addresses.
List(context.Context, *v2.IPServiceListRequest) (*v2.IPServiceListResponse, error)
- // Delete a ip
+ // Deletes an IP address.
Delete(context.Context, *v2.IPServiceDeleteRequest) (*v2.IPServiceDeleteResponse, error)
}
@@ -159,15 +159,15 @@ func (c *iPServiceClient) Delete(ctx context.Context, req *v2.IPServiceDeleteReq
// IPServiceHandler is an implementation of the metalstack.api.v2.IPService service.
type IPServiceHandler interface {
- // Get a ip
+ // Returns the IP address with the specified IP.
Get(context.Context, *v2.IPServiceGetRequest) (*v2.IPServiceGetResponse, error)
- // Create a ip
+ // Creates a new IP address.
Create(context.Context, *v2.IPServiceCreateRequest) (*v2.IPServiceCreateResponse, error)
- // Update a ip
+ // Updates an IP address.
Update(context.Context, *v2.IPServiceUpdateRequest) (*v2.IPServiceUpdateResponse, error)
- // List all ips
+ // Returns the list of all IP addresses.
List(context.Context, *v2.IPServiceListRequest) (*v2.IPServiceListResponse, error)
- // Delete a ip
+ // Deletes an IP address.
Delete(context.Context, *v2.IPServiceDeleteRequest) (*v2.IPServiceDeleteResponse, error)
}
diff --git a/go/metalstack/api/v2/apiv2connect/machine.connect.go b/go/metalstack/api/v2/apiv2connect/machine.connect.go
index fa33f5f1..9674fc72 100644
--- a/go/metalstack/api/v2/apiv2connect/machine.connect.go
+++ b/go/metalstack/api/v2/apiv2connect/machine.connect.go
@@ -52,19 +52,19 @@ const (
// MachineServiceClient is a client for the metalstack.api.v2.MachineService service.
type MachineServiceClient interface {
- // Get a machine
+ // Returns the machine with the specified UUID.
Get(context.Context, *v2.MachineServiceGetRequest) (*v2.MachineServiceGetResponse, error)
- // Create a machine
+ // Creates a new machine.
Create(context.Context, *v2.MachineServiceCreateRequest) (*v2.MachineServiceCreateResponse, error)
- // Update a machine
+ // Updates a machine.
Update(context.Context, *v2.MachineServiceUpdateRequest) (*v2.MachineServiceUpdateResponse, error)
- // List all machines
+ // Returns the list of all machines.
List(context.Context, *v2.MachineServiceListRequest) (*v2.MachineServiceListResponse, error)
- // Delete a machine
+ // Deletes a machine.
Delete(context.Context, *v2.MachineServiceDeleteRequest) (*v2.MachineServiceDeleteResponse, error)
- // BMCCommand send a command to the bmc of a machine
+ // BMCCommand sends a command to the BMC of a machine.
BMCCommand(context.Context, *v2.MachineServiceBMCCommandRequest) (*v2.MachineServiceBMCCommandResponse, error)
- // GetBMC returns the BMC details of a machine
+ // Returns the BMC details of a machine.
GetBMC(context.Context, *v2.MachineServiceGetBMCRequest) (*v2.MachineServiceGetBMCResponse, error)
}
@@ -200,19 +200,19 @@ func (c *machineServiceClient) GetBMC(ctx context.Context, req *v2.MachineServic
// MachineServiceHandler is an implementation of the metalstack.api.v2.MachineService service.
type MachineServiceHandler interface {
- // Get a machine
+ // Returns the machine with the specified UUID.
Get(context.Context, *v2.MachineServiceGetRequest) (*v2.MachineServiceGetResponse, error)
- // Create a machine
+ // Creates a new machine.
Create(context.Context, *v2.MachineServiceCreateRequest) (*v2.MachineServiceCreateResponse, error)
- // Update a machine
+ // Updates a machine.
Update(context.Context, *v2.MachineServiceUpdateRequest) (*v2.MachineServiceUpdateResponse, error)
- // List all machines
+ // Returns the list of all machines.
List(context.Context, *v2.MachineServiceListRequest) (*v2.MachineServiceListResponse, error)
- // Delete a machine
+ // Deletes a machine.
Delete(context.Context, *v2.MachineServiceDeleteRequest) (*v2.MachineServiceDeleteResponse, error)
- // BMCCommand send a command to the bmc of a machine
+ // BMCCommand sends a command to the BMC of a machine.
BMCCommand(context.Context, *v2.MachineServiceBMCCommandRequest) (*v2.MachineServiceBMCCommandResponse, error)
- // GetBMC returns the BMC details of a machine
+ // Returns the BMC details of a machine.
GetBMC(context.Context, *v2.MachineServiceGetBMCRequest) (*v2.MachineServiceGetBMCResponse, error)
}
diff --git a/go/metalstack/api/v2/apiv2connect/method.connect.go b/go/metalstack/api/v2/apiv2connect/method.connect.go
index 3c414892..e49be3cb 100644
--- a/go/metalstack/api/v2/apiv2connect/method.connect.go
+++ b/go/metalstack/api/v2/apiv2connect/method.connect.go
@@ -42,9 +42,9 @@ const (
// MethodServiceClient is a client for the metalstack.api.v2.MethodService service.
type MethodServiceClient interface {
- // List all public visible methods
+ // Returns the list of all public visible methods.
List(context.Context, *v2.MethodServiceListRequest) (*v2.MethodServiceListResponse, error)
- // TokenScopedList all methods callable with the token present in the request
+ // TokenScopedList returns all methods callable with the token present in the request.
TokenScopedList(context.Context, *v2.MethodServiceTokenScopedListRequest) (*v2.MethodServiceTokenScopedListResponse, error)
}
@@ -100,9 +100,9 @@ func (c *methodServiceClient) TokenScopedList(ctx context.Context, req *v2.Metho
// MethodServiceHandler is an implementation of the metalstack.api.v2.MethodService service.
type MethodServiceHandler interface {
- // List all public visible methods
+ // Returns the list of all public visible methods.
List(context.Context, *v2.MethodServiceListRequest) (*v2.MethodServiceListResponse, error)
- // TokenScopedList all methods callable with the token present in the request
+ // TokenScopedList returns all methods callable with the token present in the request.
TokenScopedList(context.Context, *v2.MethodServiceTokenScopedListRequest) (*v2.MethodServiceTokenScopedListResponse, error)
}
diff --git a/go/metalstack/api/v2/apiv2connect/network.connect.go b/go/metalstack/api/v2/apiv2connect/network.connect.go
index 889d3615..ed05b0ea 100644
--- a/go/metalstack/api/v2/apiv2connect/network.connect.go
+++ b/go/metalstack/api/v2/apiv2connect/network.connect.go
@@ -50,17 +50,17 @@ const (
// NetworkServiceClient is a client for the metalstack.api.v2.NetworkService service.
type NetworkServiceClient interface {
- // Get a network
+ // Returns the network with the specified ID.
Get(context.Context, *v2.NetworkServiceGetRequest) (*v2.NetworkServiceGetResponse, error)
- // Create a child network from a super network.
+ // Creates a child network from a super network.
Create(context.Context, *v2.NetworkServiceCreateRequest) (*v2.NetworkServiceCreateResponse, error)
- // Update a network
+ // Updates a network.
Update(context.Context, *v2.NetworkServiceUpdateRequest) (*v2.NetworkServiceUpdateResponse, error)
- // List all project networks
+ // Returns the list of all project networks.
List(context.Context, *v2.NetworkServiceListRequest) (*v2.NetworkServiceListResponse, error)
- // ListBaseNetworks all base networks that can be used for either child network or ip allocation
+ // ListBaseNetworks returns all base networks that can be used for either child network or IP allocation.
ListBaseNetworks(context.Context, *v2.NetworkServiceListBaseNetworksRequest) (*v2.NetworkServiceListBaseNetworksResponse, error)
- // Delete a network
+ // Deletes a network.
Delete(context.Context, *v2.NetworkServiceDeleteRequest) (*v2.NetworkServiceDeleteResponse, error)
}
@@ -180,17 +180,17 @@ func (c *networkServiceClient) Delete(ctx context.Context, req *v2.NetworkServic
// NetworkServiceHandler is an implementation of the metalstack.api.v2.NetworkService service.
type NetworkServiceHandler interface {
- // Get a network
+ // Returns the network with the specified ID.
Get(context.Context, *v2.NetworkServiceGetRequest) (*v2.NetworkServiceGetResponse, error)
- // Create a child network from a super network.
+ // Creates a child network from a super network.
Create(context.Context, *v2.NetworkServiceCreateRequest) (*v2.NetworkServiceCreateResponse, error)
- // Update a network
+ // Updates a network.
Update(context.Context, *v2.NetworkServiceUpdateRequest) (*v2.NetworkServiceUpdateResponse, error)
- // List all project networks
+ // Returns the list of all project networks.
List(context.Context, *v2.NetworkServiceListRequest) (*v2.NetworkServiceListResponse, error)
- // ListBaseNetworks all base networks that can be used for either child network or ip allocation
+ // ListBaseNetworks returns all base networks that can be used for either child network or IP allocation.
ListBaseNetworks(context.Context, *v2.NetworkServiceListBaseNetworksRequest) (*v2.NetworkServiceListBaseNetworksResponse, error)
- // Delete a network
+ // Deletes a network.
Delete(context.Context, *v2.NetworkServiceDeleteRequest) (*v2.NetworkServiceDeleteResponse, error)
}
diff --git a/go/metalstack/api/v2/apiv2connect/partition.connect.go b/go/metalstack/api/v2/apiv2connect/partition.connect.go
index 37d648d3..0899b4c8 100644
--- a/go/metalstack/api/v2/apiv2connect/partition.connect.go
+++ b/go/metalstack/api/v2/apiv2connect/partition.connect.go
@@ -41,9 +41,9 @@ const (
// PartitionServiceClient is a client for the metalstack.api.v2.PartitionService service.
type PartitionServiceClient interface {
- // Get a partition
+ // Returns the partition with the specified ID.
Get(context.Context, *v2.PartitionServiceGetRequest) (*v2.PartitionServiceGetResponse, error)
- // List all partitions
+ // Returns the list of all partitions.
List(context.Context, *v2.PartitionServiceListRequest) (*v2.PartitionServiceListResponse, error)
}
@@ -99,9 +99,9 @@ func (c *partitionServiceClient) List(ctx context.Context, req *v2.PartitionServ
// PartitionServiceHandler is an implementation of the metalstack.api.v2.PartitionService service.
type PartitionServiceHandler interface {
- // Get a partition
+ // Returns the partition with the specified ID.
Get(context.Context, *v2.PartitionServiceGetRequest) (*v2.PartitionServiceGetResponse, error)
- // List all partitions
+ // Returns the list of all partitions.
List(context.Context, *v2.PartitionServiceListRequest) (*v2.PartitionServiceListResponse, error)
}
diff --git a/go/metalstack/api/v2/apiv2connect/project.connect.go b/go/metalstack/api/v2/apiv2connect/project.connect.go
index b76c92c6..5ef541aa 100644
--- a/go/metalstack/api/v2/apiv2connect/project.connect.go
+++ b/go/metalstack/api/v2/apiv2connect/project.connect.go
@@ -69,9 +69,9 @@ const (
// ProjectServiceClient is a client for the metalstack.api.v2.ProjectService service.
type ProjectServiceClient interface {
- // List all accessible projects
+ // Returns the list of all accessible projects.
List(context.Context, *v2.ProjectServiceListRequest) (*v2.ProjectServiceListResponse, error)
- // Get a project
+ // Returns the project with the specified UUID.
Get(context.Context, *v2.ProjectServiceGetRequest) (*v2.ProjectServiceGetResponse, error)
// Create a project
Create(context.Context, *v2.ProjectServiceCreateRequest) (*v2.ProjectServiceCreateResponse, error)
@@ -325,9 +325,9 @@ func (c *projectServiceClient) InviteGet(ctx context.Context, req *v2.ProjectSer
// ProjectServiceHandler is an implementation of the metalstack.api.v2.ProjectService service.
type ProjectServiceHandler interface {
- // List all accessible projects
+ // Returns the list of all accessible projects.
List(context.Context, *v2.ProjectServiceListRequest) (*v2.ProjectServiceListResponse, error)
- // Get a project
+ // Returns the project with the specified UUID.
Get(context.Context, *v2.ProjectServiceGetRequest) (*v2.ProjectServiceGetResponse, error)
// Create a project
Create(context.Context, *v2.ProjectServiceCreateRequest) (*v2.ProjectServiceCreateResponse, error)
diff --git a/go/metalstack/api/v2/apiv2connect/size.connect.go b/go/metalstack/api/v2/apiv2connect/size.connect.go
index 5c95f0ec..3c77a5df 100644
--- a/go/metalstack/api/v2/apiv2connect/size.connect.go
+++ b/go/metalstack/api/v2/apiv2connect/size.connect.go
@@ -41,9 +41,9 @@ const (
// SizeServiceClient is a client for the metalstack.api.v2.SizeService service.
type SizeServiceClient interface {
- // Get a size
+ // Returns the size with the specified ID.
Get(context.Context, *v2.SizeServiceGetRequest) (*v2.SizeServiceGetResponse, error)
- // List all sizes
+ // Returns the list of all sizes.
List(context.Context, *v2.SizeServiceListRequest) (*v2.SizeServiceListResponse, error)
}
@@ -99,9 +99,9 @@ func (c *sizeServiceClient) List(ctx context.Context, req *v2.SizeServiceListReq
// SizeServiceHandler is an implementation of the metalstack.api.v2.SizeService service.
type SizeServiceHandler interface {
- // Get a size
+ // Returns the size with the specified ID.
Get(context.Context, *v2.SizeServiceGetRequest) (*v2.SizeServiceGetResponse, error)
- // List all sizes
+ // Returns the list of all sizes.
List(context.Context, *v2.SizeServiceListRequest) (*v2.SizeServiceListResponse, error)
}
diff --git a/go/metalstack/api/v2/apiv2connect/size_imageconstraint.connect.go b/go/metalstack/api/v2/apiv2connect/size_imageconstraint.connect.go
index 5db04365..c67d7f09 100644
--- a/go/metalstack/api/v2/apiv2connect/size_imageconstraint.connect.go
+++ b/go/metalstack/api/v2/apiv2connect/size_imageconstraint.connect.go
@@ -42,7 +42,7 @@ const (
// SizeImageConstraintServiceClient is a client for the metalstack.api.v2.SizeImageConstraintService
// service.
type SizeImageConstraintServiceClient interface {
- // Try if a given combination of size and image is possible
+ // Try validates if a given combination of size and image is possible.
Try(context.Context, *v2.SizeImageConstraintServiceTryRequest) (*v2.SizeImageConstraintServiceTryResponse, error)
}
@@ -84,7 +84,7 @@ func (c *sizeImageConstraintServiceClient) Try(ctx context.Context, req *v2.Size
// SizeImageConstraintServiceHandler is an implementation of the
// metalstack.api.v2.SizeImageConstraintService service.
type SizeImageConstraintServiceHandler interface {
- // Try if a given combination of size and image is possible
+ // Try validates if a given combination of size and image is possible.
Try(context.Context, *v2.SizeImageConstraintServiceTryRequest) (*v2.SizeImageConstraintServiceTryResponse, error)
}
diff --git a/go/metalstack/api/v2/apiv2connect/size_reservation.connect.go b/go/metalstack/api/v2/apiv2connect/size_reservation.connect.go
index 0f6ea868..39240adf 100644
--- a/go/metalstack/api/v2/apiv2connect/size_reservation.connect.go
+++ b/go/metalstack/api/v2/apiv2connect/size_reservation.connect.go
@@ -44,9 +44,9 @@ const (
// SizeReservationServiceClient is a client for the metalstack.api.v2.SizeReservationService
// service.
type SizeReservationServiceClient interface {
- // Get a size reservation
+ // Returns the size reservation with the specified ID.
Get(context.Context, *v2.SizeReservationServiceGetRequest) (*v2.SizeReservationServiceGetResponse, error)
- // List size reservations
+ // Returns the list of size reservations.
List(context.Context, *v2.SizeReservationServiceListRequest) (*v2.SizeReservationServiceListResponse, error)
}
@@ -103,9 +103,9 @@ func (c *sizeReservationServiceClient) List(ctx context.Context, req *v2.SizeRes
// SizeReservationServiceHandler is an implementation of the
// metalstack.api.v2.SizeReservationService service.
type SizeReservationServiceHandler interface {
- // Get a size reservation
+ // Returns the size reservation with the specified ID.
Get(context.Context, *v2.SizeReservationServiceGetRequest) (*v2.SizeReservationServiceGetResponse, error)
- // List size reservations
+ // Returns the list of size reservations.
List(context.Context, *v2.SizeReservationServiceListRequest) (*v2.SizeReservationServiceListResponse, error)
}
diff --git a/go/metalstack/api/v2/apiv2connect/tenant.connect.go b/go/metalstack/api/v2/apiv2connect/tenant.connect.go
index ba11f8a9..6721559b 100644
--- a/go/metalstack/api/v2/apiv2connect/tenant.connect.go
+++ b/go/metalstack/api/v2/apiv2connect/tenant.connect.go
@@ -68,9 +68,9 @@ const (
// TenantServiceClient is a client for the metalstack.api.v2.TenantService service.
type TenantServiceClient interface {
- // Create a tenant
+ // Creates a new tenant.
Create(context.Context, *v2.TenantServiceCreateRequest) (*v2.TenantServiceCreateResponse, error)
- // List tenants
+ // Returns the list of tenants.
List(context.Context, *v2.TenantServiceListRequest) (*v2.TenantServiceListResponse, error)
// Get a tenant
Get(context.Context, *v2.TenantServiceGetRequest) (*v2.TenantServiceGetResponse, error)
@@ -324,9 +324,9 @@ func (c *tenantServiceClient) InviteGet(ctx context.Context, req *v2.TenantServi
// TenantServiceHandler is an implementation of the metalstack.api.v2.TenantService service.
type TenantServiceHandler interface {
- // Create a tenant
+ // Creates a new tenant.
Create(context.Context, *v2.TenantServiceCreateRequest) (*v2.TenantServiceCreateResponse, error)
- // List tenants
+ // Returns the list of tenants.
List(context.Context, *v2.TenantServiceListRequest) (*v2.TenantServiceListResponse, error)
// Get a tenant
Get(context.Context, *v2.TenantServiceGetRequest) (*v2.TenantServiceGetResponse, error)
diff --git a/go/metalstack/api/v2/apiv2connect/token.connect.go b/go/metalstack/api/v2/apiv2connect/token.connect.go
index 1488f2e1..b5eb7d0b 100644
--- a/go/metalstack/api/v2/apiv2connect/token.connect.go
+++ b/go/metalstack/api/v2/apiv2connect/token.connect.go
@@ -49,17 +49,17 @@ const (
// TokenServiceClient is a client for the metalstack.api.v2.TokenService service.
type TokenServiceClient interface {
- // Get a token
+ // Returns the token with the specified UUID.
Get(context.Context, *v2.TokenServiceGetRequest) (*v2.TokenServiceGetResponse, error)
- // Create a token to authenticate against the platform, the secret will be only visible in the response.
+ // Creates a token to authenticate against the platform, the secret will be only visible in the response.
Create(context.Context, *v2.TokenServiceCreateRequest) (*v2.TokenServiceCreateResponse, error)
- // Update a token
+ // Updates a token.
Update(context.Context, *v2.TokenServiceUpdateRequest) (*v2.TokenServiceUpdateResponse, error)
- // List all your tokens
+ // Returns the list of all user tokens.
List(context.Context, *v2.TokenServiceListRequest) (*v2.TokenServiceListResponse, error)
- // Revoke a token, no further usage is possible afterwards
+ // Revokes a token, no further usage is possible afterwards.
Revoke(context.Context, *v2.TokenServiceRevokeRequest) (*v2.TokenServiceRevokeResponse, error)
- // Refresh a token, this will create a new token with the exact same permissions as the calling token contains
+ // Refreshes a token, this will create a new token with the exact same permissions as the calling token contains.
Refresh(context.Context, *v2.TokenServiceRefreshRequest) (*v2.TokenServiceRefreshResponse, error)
}
@@ -179,17 +179,17 @@ func (c *tokenServiceClient) Refresh(ctx context.Context, req *v2.TokenServiceRe
// TokenServiceHandler is an implementation of the metalstack.api.v2.TokenService service.
type TokenServiceHandler interface {
- // Get a token
+ // Returns the token with the specified UUID.
Get(context.Context, *v2.TokenServiceGetRequest) (*v2.TokenServiceGetResponse, error)
- // Create a token to authenticate against the platform, the secret will be only visible in the response.
+ // Creates a token to authenticate against the platform, the secret will be only visible in the response.
Create(context.Context, *v2.TokenServiceCreateRequest) (*v2.TokenServiceCreateResponse, error)
- // Update a token
+ // Updates a token.
Update(context.Context, *v2.TokenServiceUpdateRequest) (*v2.TokenServiceUpdateResponse, error)
- // List all your tokens
+ // Returns the list of all user tokens.
List(context.Context, *v2.TokenServiceListRequest) (*v2.TokenServiceListResponse, error)
- // Revoke a token, no further usage is possible afterwards
+ // Revokes a token, no further usage is possible afterwards.
Revoke(context.Context, *v2.TokenServiceRevokeRequest) (*v2.TokenServiceRevokeResponse, error)
- // Refresh a token, this will create a new token with the exact same permissions as the calling token contains
+ // Refreshes a token, this will create a new token with the exact same permissions as the calling token contains.
Refresh(context.Context, *v2.TokenServiceRefreshRequest) (*v2.TokenServiceRefreshResponse, error)
}
diff --git a/go/metalstack/api/v2/apiv2connect/user.connect.go b/go/metalstack/api/v2/apiv2connect/user.connect.go
index 6399c994..4e862fd0 100644
--- a/go/metalstack/api/v2/apiv2connect/user.connect.go
+++ b/go/metalstack/api/v2/apiv2connect/user.connect.go
@@ -39,7 +39,7 @@ const (
// UserServiceClient is a client for the metalstack.api.v2.UserService service.
type UserServiceClient interface {
- // Get a User
+ // Returns the authenticated user.
Get(context.Context, *v2.UserServiceGetRequest) (*v2.UserServiceGetResponse, error)
}
@@ -79,7 +79,7 @@ func (c *userServiceClient) Get(ctx context.Context, req *v2.UserServiceGetReque
// UserServiceHandler is an implementation of the metalstack.api.v2.UserService service.
type UserServiceHandler interface {
- // Get a User
+ // Returns the authenticated user.
Get(context.Context, *v2.UserServiceGetRequest) (*v2.UserServiceGetResponse, error)
}
diff --git a/go/metalstack/api/v2/apiv2connect/version.connect.go b/go/metalstack/api/v2/apiv2connect/version.connect.go
index 3ab5ca15..cf1a81bf 100644
--- a/go/metalstack/api/v2/apiv2connect/version.connect.go
+++ b/go/metalstack/api/v2/apiv2connect/version.connect.go
@@ -39,7 +39,7 @@ const (
// VersionServiceClient is a client for the metalstack.api.v2.VersionService service.
type VersionServiceClient interface {
- // Get the version
+ // Returns the version of the application.
Get(context.Context, *v2.VersionServiceGetRequest) (*v2.VersionServiceGetResponse, error)
}
@@ -79,7 +79,7 @@ func (c *versionServiceClient) Get(ctx context.Context, req *v2.VersionServiceGe
// VersionServiceHandler is an implementation of the metalstack.api.v2.VersionService service.
type VersionServiceHandler interface {
- // Get the version
+ // Returns the version of the application.
Get(context.Context, *v2.VersionServiceGetRequest) (*v2.VersionServiceGetResponse, error)
}
diff --git a/go/metalstack/api/v2/audit.pb.go b/go/metalstack/api/v2/audit.pb.go
index 376cf788..8eed2080 100644
--- a/go/metalstack/api/v2/audit.pb.go
+++ b/go/metalstack/api/v2/audit.pb.go
@@ -23,7 +23,7 @@ const (
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
-// AuditPhase specifies phase of an audit trace
+// AuditPhase specifies the phase of an audit trace.
type AuditPhase int32
const (
@@ -31,7 +31,7 @@ const (
AuditPhase_AUDIT_PHASE_UNSPECIFIED AuditPhase = 0
// AUDIT_PHASE_REQUEST defines an audit trace in the request phase
AuditPhase_AUDIT_PHASE_REQUEST AuditPhase = 1
- // AUDIT_PHASE_REQUEST defines an audit trace in the response phase
+ // AUDIT_PHASE_RESPONSE defines an audit trace in the response phase
AuditPhase_AUDIT_PHASE_RESPONSE AuditPhase = 2
)
@@ -76,26 +76,26 @@ func (AuditPhase) EnumDescriptor() ([]byte, []int) {
return file_metalstack_api_v2_audit_proto_rawDescGZIP(), []int{0}
}
-// AuditTrace is an audit trace
+// AuditTrace is an audit trace.
type AuditTrace struct {
state protoimpl.MessageState `protogen:"open.v1"`
// Uuid of the audit trace
Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
- // Timestamp is the timestamp when the request arrived at the api
+ // Timestamp is the timestamp when the request arrived at the API
Timestamp *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
- // User is the login user who called the api method
+ // User is the login user who called the API method
User string `protobuf:"bytes,3,opt,name=user,proto3" json:"user,omitempty"`
- // Tenant is the tenant targeted by the api call
+ // Tenant is the tenant targeted by the API call
Tenant string `protobuf:"bytes,4,opt,name=tenant,proto3" json:"tenant,omitempty"`
- // Project is the project targeted by the api call
+ // Project is the project targeted by the API call
Project *string `protobuf:"bytes,5,opt,name=project,proto3,oneof" json:"project,omitempty"`
- // Method is the api method that was called
+ // Method is the API method that was called
Method string `protobuf:"bytes,6,opt,name=method,proto3" json:"method,omitempty"`
- // Body is the payload of the api call. In the request phase this contains the payload sent by the client, in the request phase it contains the payload returned by the api server
+ // Body is the payload of the API call. In the request phase this contains the payload sent by the client, in the response phase it contains the payload returned by the API server
Body *string `protobuf:"bytes,7,opt,name=body,proto3,oneof" json:"body,omitempty"`
- // Source IP contains the source ip address of the api call
+ // SourceIP contains the source IP address of the API call
SourceIp string `protobuf:"bytes,8,opt,name=source_ip,json=sourceIp,proto3" json:"source_ip,omitempty"`
- // Result Code is a status code describing the result of the api call. It is set for traces in the response phase and contains official gRPC status codes
+ // ResultCode is a status code describing the result of the API call. It is set for traces in the response phase and contains official gRPC status codes
ResultCode *int32 `protobuf:"varint,9,opt,name=result_code,json=resultCode,proto3,oneof" json:"result_code,omitempty"`
// Phase represents the phase of the audit trace
Phase AuditPhase `protobuf:"varint,10,opt,name=phase,proto3,enum=metalstack.api.v2.AuditPhase" json:"phase,omitempty"`
diff --git a/go/metalstack/api/v2/health.pb.go b/go/metalstack/api/v2/health.pb.go
index a85d3b88..7b9d97ed 100644
--- a/go/metalstack/api/v2/health.pb.go
+++ b/go/metalstack/api/v2/health.pb.go
@@ -21,7 +21,7 @@ const (
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
-// ServiceStatus defines the status of a service
+// ServiceStatus defines the status of a service.
type ServiceStatus int32
const (
@@ -31,7 +31,7 @@ const (
ServiceStatus_SERVICE_STATUS_DEGRADED ServiceStatus = 1
// SERVICE_STATUS_UNHEALTHY the service is in unhealthy status, serious impact is expected
ServiceStatus_SERVICE_STATUS_UNHEALTHY ServiceStatus = 2
- // SERVICE_STATUS_HEALTHY the service is in healthy status e.g. fully functional
+ // SERVICE_STATUS_HEALTHY the service is in healthy status, for example fully functional
ServiceStatus_SERVICE_STATUS_HEALTHY ServiceStatus = 3
)
@@ -78,25 +78,25 @@ func (ServiceStatus) EnumDescriptor() ([]byte, []int) {
return file_metalstack_api_v2_health_proto_rawDescGZIP(), []int{0}
}
-// Service defines the service for which the healtyness is reported
+// Service defines the service for which the healthiness is reported.
type Service int32
const (
// SERVICE_UNSPECIFIED is a unknown service
Service_SERVICE_UNSPECIFIED Service = 0
- // SERVICE_IPAM the ipam service
+ // SERVICE_IPAM the IPAM service
Service_SERVICE_IPAM Service = 1
- // SERVICE_RETHINK the rethinkdb
+ // SERVICE_RETHINK the RethinkDB
Service_SERVICE_RETHINK Service = 2
- // SERVICE_MASTERDATA the masterdata-api
+ // SERVICE_MASTERDATA the masterdata API
Service_SERVICE_MASTERDATA Service = 3
// SERVICE_MACHINES the machine service
Service_SERVICE_MACHINES Service = 4
// SERVICE_AUDIT the auditing
Service_SERVICE_AUDIT Service = 5
- // SERVICE_VPN the vpn service
+ // SERVICE_VPN the VPN service
Service_SERVICE_VPN Service = 6
- // SERVICE_REDIS the redis service
+ // SERVICE_REDIS the Redis service
Service_SERVICE_REDIS Service = 7
// SERVICE_TASKS the tasks service
Service_SERVICE_TASKS Service = 8
@@ -155,10 +155,10 @@ func (Service) EnumDescriptor() ([]byte, []int) {
return file_metalstack_api_v2_health_proto_rawDescGZIP(), []int{1}
}
-// Health reports the health status of all services
+// Health reports the health status of all services.
type Health struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Services the health of all individual services
+ // Services contains the health of all individual services
Services []*HealthStatus `protobuf:"bytes,1,rep,name=services,proto3" json:"services,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -201,12 +201,12 @@ func (x *Health) GetServices() []*HealthStatus {
return nil
}
-// HealthStatus the health of one service
+// HealthStatus represents the health status of one service.
type HealthStatus struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Name the name of the service
+ // Name is the name of the service
Name Service `protobuf:"varint,1,opt,name=name,proto3,enum=metalstack.api.v2.Service" json:"name,omitempty"`
- // Status the status of this service
+ // Status is the status of this service
Status ServiceStatus `protobuf:"varint,2,opt,name=status,proto3,enum=metalstack.api.v2.ServiceStatus" json:"status,omitempty"`
// Message describes the reason for the unhealthy status if possible
Message string `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
@@ -274,10 +274,10 @@ func (x *HealthStatus) GetPartitions() map[string]*PartitionHealth {
return nil
}
-// PartitionHealth the status of a specific service in this partition
+// PartitionHealth represents the status of a specific service in this partition.
type PartitionHealth struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Status the health status of the service in this partition
+ // Status is the health status of the service in this partition
Status ServiceStatus `protobuf:"varint,1,opt,name=status,proto3,enum=metalstack.api.v2.ServiceStatus" json:"status,omitempty"`
// Message describes the reason for the unhealthy status if possible
Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
@@ -329,7 +329,7 @@ func (x *PartitionHealth) GetMessage() string {
return ""
}
-// HealthServiceGetRequest is request payload to get the health of the system
+// HealthServiceGetRequest is the request payload for getting the health of the system.
type HealthServiceGetRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
unknownFields protoimpl.UnknownFields
@@ -366,10 +366,10 @@ func (*HealthServiceGetRequest) Descriptor() ([]byte, []int) {
return file_metalstack_api_v2_health_proto_rawDescGZIP(), []int{3}
}
-// HealthServiceGetRequest is the response payload with the health of the system
+// HealthServiceGetResponse is the response payload for getting the health of the system.
type HealthServiceGetResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Health is the overall health of the system
+ // Health contains the overall health of the system
Health *Health `protobuf:"bytes,1,opt,name=health,proto3" json:"health,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
diff --git a/go/metalstack/api/v2/machine.pb.go b/go/metalstack/api/v2/machine.pb.go
index d6024ba2..2399f65c 100644
--- a/go/metalstack/api/v2/machine.pb.go
+++ b/go/metalstack/api/v2/machine.pb.go
@@ -4252,7 +4252,7 @@ const file_metalstack_api_v2_machine_proto_rawDesc = "" +
"\x05image\x18\b \x01(\tB\b\xbaH\x05r\x03\x18\x80\x01R\x05image\x120\n" +
"\x11filesystem_layout\x18\t \x01(\tH\x03R\x10filesystemLayout\x88\x01\x01\x12?\n" +
"\x0fssh_public_keys\x18\n" +
- " \x03(\tB\x17\xbaH\x14\x92\x01\x11Ȥ\xb3\xb1\x02\x01\x102\"\ar\x05\x10\x01\x18\x80@R\rsshPublicKeys\x120\n" +
+ " \x03(\tB\x17\xbaH\x14\x92\x01\x11Ф\xb3\xb1\x02\x01\x102\"\ar\x05\x10\x01\x18\x80@R\rsshPublicKeys\x120\n" +
"\buserdata\x18\v \x01(\tB\x0f\xbaH\fr\n" +
"\U00033bb1\x02\x01\x18\x80\x80\x02H\x04R\buserdata\x88\x01\x01\x121\n" +
"\x06labels\x18\f \x01(\v2\x19.metalstack.api.v2.LabelsR\x06labels\x12G\n" +
@@ -4282,7 +4282,7 @@ const file_metalstack_api_v2_machine_proto_rawDesc = "" +
"\aproject\x18\x03 \x01(\tB\b\xbaH\x05r\x03\xb0\x01\x01R\aproject\x122\n" +
"\vdescription\x18\x04 \x01(\tB\v\xbaH\br\x06ȳ\xae\xb1\x02\x01H\x00R\vdescription\x88\x01\x01\x12<\n" +
"\x06labels\x18\x05 \x01(\v2\x1f.metalstack.api.v2.UpdateLabelsH\x01R\x06labels\x88\x01\x01\x12?\n" +
- "\x0fssh_public_keys\x18\x06 \x03(\tB\x17\xbaH\x14\x92\x01\x11Ȥ\xb3\xb1\x02\x01\x102\"\ar\x05\x10\x01\x18\x80@R\rsshPublicKeysB\x0e\n" +
+ "\x0fssh_public_keys\x18\x06 \x03(\tB\x17\xbaH\x14\x92\x01\x11Ф\xb3\xb1\x02\x01\x102\"\ar\x05\x10\x01\x18\x80@R\rsshPublicKeysB\x0e\n" +
"\f_descriptionB\t\n" +
"\a_labels\"T\n" +
"\x1cMachineServiceUpdateResponse\x124\n" +
@@ -4344,7 +4344,7 @@ const file_metalstack_api_v2_machine_proto_rawDesc = "" +
"\bnetworks\x18\t \x03(\v2!.metalstack.api.v2.MachineNetworkR\bnetworks\x12#\n" +
"\bhostname\x18\n" +
" \x01(\tB\a\xbaH\x04r\x02h\x01R\bhostname\x12?\n" +
- "\x0fssh_public_keys\x18\v \x03(\tB\x17\xbaH\x14\x92\x01\x11Ȥ\xb3\xb1\x02\x01\x102\"\ar\x05\x10\x01\x18\x80@R\rsshPublicKeys\x12+\n" +
+ "\x0fssh_public_keys\x18\v \x03(\tB\x17\xbaH\x14\x92\x01\x11Ф\xb3\xb1\x02\x01\x102\"\ar\x05\x10\x01\x18\x80@R\rsshPublicKeys\x12+\n" +
"\buserdata\x18\f \x01(\tB\x0f\xbaH\fr\n" +
"\U00033bb1\x02\x01\x18\x80\x80\x02R\buserdata\x12[\n" +
"\x0fallocation_type\x18\r \x01(\x0e2(.metalstack.api.v2.MachineAllocationTypeB\b\xbaH\x05\x82\x01\x02\x10\x01R\x0eallocationType\x12G\n" +
diff --git a/go/metalstack/api/v2/method.pb.go b/go/metalstack/api/v2/method.pb.go
index f24268a7..15303aa8 100644
--- a/go/metalstack/api/v2/method.pb.go
+++ b/go/metalstack/api/v2/method.pb.go
@@ -22,7 +22,7 @@ const (
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
-// MethodServiceListRequest is the request payload to list all public methods
+// MethodServiceListRequest is the request payload for listing all public methods.
type MethodServiceListRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
unknownFields protoimpl.UnknownFields
@@ -59,7 +59,7 @@ func (*MethodServiceListRequest) Descriptor() ([]byte, []int) {
return file_metalstack_api_v2_method_proto_rawDescGZIP(), []int{0}
}
-// MethodServiceListResponse is the response payload with all public visible methods
+// MethodServiceListResponse is the response payload for listing all public methods.
type MethodServiceListResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
// Methods is a list of methods public callable
@@ -105,7 +105,7 @@ func (x *MethodServiceListResponse) GetMethods() []string {
return nil
}
-// MethodServiceTokenScopedListRequest is the request payload to list all methods callable with the token present in the request
+// MethodServiceTokenScopedListRequest is the request payload for listing all methods callable with the token present in the request.
type MethodServiceTokenScopedListRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
unknownFields protoimpl.UnknownFields
@@ -142,14 +142,14 @@ func (*MethodServiceTokenScopedListRequest) Descriptor() ([]byte, []int) {
return file_metalstack_api_v2_method_proto_rawDescGZIP(), []int{2}
}
-// MethodServiceTokenScopedListResponse is the response payload which contains all methods which are callable with the given token
+// MethodServiceTokenScopedListResponse is the response payload which contains all methods which are callable with the given token.
type MethodServiceTokenScopedListResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Permissions a list of methods which can be called
+ // Permissions contains a list of methods which can be called
Permissions []*MethodPermission `protobuf:"bytes,1,rep,name=permissions,proto3" json:"permissions,omitempty"`
- // ProjectRoles associates a project id with the corresponding role of the token owner
+ // ProjectRoles associates a project ID with the corresponding role of the token owner
ProjectRoles map[string]ProjectRole `protobuf:"bytes,2,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,3,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,4,opt,name=admin_role,json=adminRole,proto3,enum=metalstack.api.v2.AdminRole,oneof" json:"admin_role,omitempty"`
diff --git a/go/metalstack/api/v2/partition.pb.go b/go/metalstack/api/v2/partition.pb.go
index 00856893..67d223f8 100644
--- a/go/metalstack/api/v2/partition.pb.go
+++ b/go/metalstack/api/v2/partition.pb.go
@@ -522,7 +522,7 @@ var File_metalstack_api_v2_partition_proto protoreflect.FileDescriptor
const file_metalstack_api_v2_partition_proto_rawDesc = "" +
"\n" +
- "!metalstack/api/v2/partition.proto\x12\x11metalstack.api.v2\x1a\x1bbuf/validate/validate.proto\x1a\x1emetalstack/api/v2/common.proto\x1a(metalstack/api/v2/predefined_rules.proto\"\xaa\x03\n" +
+ "!metalstack/api/v2/partition.proto\x12\x11metalstack.api.v2\x1a\x1bbuf/validate/validate.proto\x1a\x1emetalstack/api/v2/common.proto\x1a(metalstack/api/v2/predefined_rules.proto\"\xb8\x03\n" +
"\tPartition\x12\x1b\n" +
"\x02id\x18\x01 \x01(\tB\v\xbaH\br\x06г\xae\xb1\x02\x01R\x02id\x12+\n" +
"\x04meta\x18\x02 \x01(\v2\x17.metalstack.api.v2.MetaR\x04meta\x12-\n" +
@@ -532,8 +532,8 @@ const file_metalstack_api_v2_partition_proto_rawDesc = "" +
"dnsServers\x12G\n" +
"\vntp_servers\x18\x06 \x03(\v2\x1c.metalstack.api.v2.NTPServerB\b\xbaH\x05\x92\x01\x02\x10\n" +
"R\n" +
- "ntpServers\x124\n" +
- "\x16mgmt_service_addresses\x18\a \x03(\tR\x14mgmtServiceAddresses\"|\n" +
+ "ntpServers\x12B\n" +
+ "\x16mgmt_service_addresses\x18\a \x03(\tB\f\xbaH\t\x92\x01\x06Ȥ\xb3\xb1\x02\x01R\x14mgmtServiceAddresses\"|\n" +
"\x0ePartitionQuery\x12 \n" +
"\x02id\x18\x01 \x01(\tB\v\xbaH\br\x06г\xae\xb1\x02\x01H\x00R\x02id\x88\x01\x01\x126\n" +
"\x06labels\x18\x02 \x01(\v2\x19.metalstack.api.v2.LabelsH\x01R\x06labels\x88\x01\x01B\x05\n" +
diff --git a/go/metalstack/api/v2/predefined_rules.pb.go b/go/metalstack/api/v2/predefined_rules.pb.go
index fabce2f8..46770b2e 100644
--- a/go/metalstack/api/v2/predefined_rules.pb.go
+++ b/go/metalstack/api/v2/predefined_rules.pb.go
@@ -106,8 +106,16 @@ var file_metalstack_api_v2_predefined_rules_proto_extTypes = []protoimpl.Extensi
ExtendedType: (*validate.RepeatedRules)(nil),
ExtensionType: (*bool)(nil),
Field: 80058953,
+ Name: "metalstack.api.v2.are_host_and_port",
+ Tag: "varint,80058953,opt,name=are_host_and_port",
+ Filename: "metalstack/api/v2/predefined_rules.proto",
+ },
+ {
+ ExtendedType: (*validate.RepeatedRules)(nil),
+ ExtensionType: (*bool)(nil),
+ Field: 80058954,
Name: "metalstack.api.v2.all_trimmed",
- Tag: "varint,80058953,opt,name=all_trimmed",
+ Tag: "varint,80058954,opt,name=all_trimmed",
Filename: "metalstack/api/v2/predefined_rules.proto",
},
}
@@ -142,7 +150,7 @@ var (
//
// optional bool is_ip_or_hostname = 80048957;
E_IsIpOrHostname = &file_metalstack_api_v2_predefined_rules_proto_extTypes[6]
- // Trimmed enforces the string to be trimmed, e.g. no whitespaces at the begin and end.
+ // Trimmed enforces the string to be trimmed, e.g. no whitespaces at the begin and end
//
// optional bool trimmed = 80048958;
E_Trimmed = &file_metalstack_api_v2_predefined_rules_proto_extTypes[7]
@@ -158,10 +166,14 @@ var (
//
// optional bool ips = 80058952;
E_Ips = &file_metalstack_api_v2_predefined_rules_proto_extTypes[9]
- // All Trimmed enforces all strings to be trimmed, e.g. no whitespaces at the begin and end.
+ // AreHostAndPort validates if a slice of strings are all in the form of :
+ //
+ // optional bool are_host_and_port = 80058953;
+ E_AreHostAndPort = &file_metalstack_api_v2_predefined_rules_proto_extTypes[10]
+ // All Trimmed enforces all strings to be trimmed, e.g. no whitespaces at the begin and end
//
- // optional bool all_trimmed = 80058953;
- E_AllTrimmed = &file_metalstack_api_v2_predefined_rules_proto_extTypes[10]
+ // optional bool all_trimmed = 80058954;
+ E_AllTrimmed = &file_metalstack_api_v2_predefined_rules_proto_extTypes[11]
)
var File_metalstack_api_v2_predefined_rules_proto protoreflect.FileDescriptor
@@ -201,8 +213,11 @@ const file_metalstack_api_v2_predefined_rules_proto_rawDesc = "" +
"\x11repeated.prefixes\x12\x1cgiven prefixes must be valid\x1a\x1bthis.all(m, m.isIpPrefix())R\bprefixes:u\n" +
"\x03ips\x12\x1b.buf.validate.RepeatedRules\x18È´\x96& \x01(\bBC\xc2H@\n" +
">\n" +
- "\frepeated.ips\x12\x17given ips must be valid\x1a\x15this.all(m, m.isIp())R\x03ips:\xba\x01\n" +
- "\vall_trimmed\x12\x1b.buf.validate.RepeatedRules\x18É´\x96& \x01(\bBy\xc2Hv\n" +
+ "\frepeated.ips\x12\x17given ips must be valid\x1a\x15this.all(m, m.isIp())R\x03ips:\xe6\x01\n" +
+ "\x11are_host_and_port\x12\x1b.buf.validate.RepeatedRules\x18É´\x96& \x01(\bB\x9a\x01\xc2H\x96\x01\n" +
+ "\x93\x01\n" +
+ "\x1arepeated.are_host_and_port\x12Pgiven entries must all be in the form of : but port is optional\x1a#this.all(m, m.isHostAndPort(false))R\x0eareHostAndPort:\xba\x01\n" +
+ "\vall_trimmed\x12\x1b.buf.validate.RepeatedRules\x18Ê´\x96& \x01(\bBy\xc2Hv\n" +
"t\n" +
"\x14repeated.all_trimmed\x122given values must not start or end with whitespace\x1a(this.all(m, m.trim().size() == m.size())R\n" +
"allTrimmedB\xca\x01\n" +
@@ -223,11 +238,12 @@ var file_metalstack_api_v2_predefined_rules_proto_depIdxs = []int32{
0, // 7: metalstack.api.v2.trimmed:extendee -> buf.validate.StringRules
1, // 8: metalstack.api.v2.prefixes:extendee -> buf.validate.RepeatedRules
1, // 9: metalstack.api.v2.ips:extendee -> buf.validate.RepeatedRules
- 1, // 10: metalstack.api.v2.all_trimmed:extendee -> buf.validate.RepeatedRules
- 11, // [11:11] is the sub-list for method output_type
- 11, // [11:11] is the sub-list for method input_type
- 11, // [11:11] is the sub-list for extension type_name
- 0, // [0:11] is the sub-list for extension extendee
+ 1, // 10: metalstack.api.v2.are_host_and_port:extendee -> buf.validate.RepeatedRules
+ 1, // 11: metalstack.api.v2.all_trimmed:extendee -> buf.validate.RepeatedRules
+ 12, // [12:12] is the sub-list for method output_type
+ 12, // [12:12] is the sub-list for method input_type
+ 12, // [12:12] is the sub-list for extension type_name
+ 0, // [0:12] is the sub-list for extension extendee
0, // [0:0] is the sub-list for field type_name
}
@@ -243,7 +259,7 @@ func file_metalstack_api_v2_predefined_rules_proto_init() {
RawDescriptor: unsafe.Slice(unsafe.StringData(file_metalstack_api_v2_predefined_rules_proto_rawDesc), len(file_metalstack_api_v2_predefined_rules_proto_rawDesc)),
NumEnums: 0,
NumMessages: 0,
- NumExtensions: 11,
+ NumExtensions: 12,
NumServices: 0,
},
GoTypes: file_metalstack_api_v2_predefined_rules_proto_goTypes,
diff --git a/go/metalstack/api/v2/user.pb.go b/go/metalstack/api/v2/user.pb.go
index 5bec46d7..ec8847fa 100644
--- a/go/metalstack/api/v2/user.pb.go
+++ b/go/metalstack/api/v2/user.pb.go
@@ -22,10 +22,10 @@ const (
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
-// User is a end user of the platform
+// User represents an end user of the platform.
type User struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Login the login at the provider
+ // Login is the login at the provider
Login string `protobuf:"bytes,1,opt,name=login,proto3" json:"login,omitempty"`
// Name of the user
Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
@@ -122,7 +122,7 @@ func (x *User) GetDefaultTenant() *Tenant {
return nil
}
-// UserServiceGetRequest is the request to get the user
+// UserServiceGetRequest is the request payload for getting the user.
type UserServiceGetRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
unknownFields protoimpl.UnknownFields
@@ -159,10 +159,10 @@ func (*UserServiceGetRequest) Descriptor() ([]byte, []int) {
return file_metalstack_api_v2_user_proto_rawDescGZIP(), []int{1}
}
-// UserServiceGetResponse the response when userservice get request was called
+// UserServiceGetResponse is the response payload for getting the user.
type UserServiceGetResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // User is the user
+ // User contains the authenticated user
User *User `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
diff --git a/go/metalstack/api/v2/version.pb.go b/go/metalstack/api/v2/version.pb.go
index 9c7c8713..c994a555 100644
--- a/go/metalstack/api/v2/version.pb.go
+++ b/go/metalstack/api/v2/version.pb.go
@@ -22,7 +22,7 @@ const (
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
-// Version of the application
+// Version represents the version of the application.
type Version struct {
state protoimpl.MessageState `protogen:"open.v1"`
// Version of the application
@@ -95,7 +95,7 @@ func (x *Version) GetBuildDate() string {
return ""
}
-// VersionServiceGetRequest is the request payload to get the version
+// VersionServiceGetRequest is the request payload for getting the version.
type VersionServiceGetRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
unknownFields protoimpl.UnknownFields
@@ -132,10 +132,10 @@ func (*VersionServiceGetRequest) Descriptor() ([]byte, []int) {
return file_metalstack_api_v2_version_proto_rawDescGZIP(), []int{1}
}
-// VersionServiceGetResponse is the response payload with the version
+// VersionServiceGetResponse is the response payload for getting the version.
type VersionServiceGetResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Version of the application
+ // Version contains the version of the application
Version *Version `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
diff --git a/go/metalstack/api/v2/vpn.pb.go b/go/metalstack/api/v2/vpn.pb.go
index bcd2e772..65e7f674 100644
--- a/go/metalstack/api/v2/vpn.pb.go
+++ b/go/metalstack/api/v2/vpn.pb.go
@@ -22,18 +22,18 @@ const (
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
-// VPNNode is a machine connected to the vpn
+// VPNNode represents a machine connected to the VPN.
type VPNNode struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Id of this node
+ // ID of this node
Id uint64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
// Name of this node
Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
// Project of this node, maps to a project
Project string `protobuf:"bytes,3,opt,name=project,proto3" json:"project,omitempty"`
- // IPAddresses of this node in the vpn
+ // IPAddresses of this node in the VPN
IpAddresses []string `protobuf:"bytes,4,rep,name=ip_addresses,json=ipAddresses,proto3" json:"ip_addresses,omitempty"`
- // LastSeen timestamp when this node reached out the the control plane
+ // LastSeen timestamp when this node reached out to the control plane
LastSeen *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=last_seen,json=lastSeen,proto3" json:"last_seen,omitempty"`
// Online indicates if this node is online
Online bool `protobuf:"varint,6,opt,name=online,proto3" json:"online,omitempty"`
diff --git a/go/metalstack/infra/v2/bmc.pb.go b/go/metalstack/infra/v2/bmc.pb.go
index 26e7bf82..1eb40d8c 100644
--- a/go/metalstack/infra/v2/bmc.pb.go
+++ b/go/metalstack/infra/v2/bmc.pb.go
@@ -23,12 +23,12 @@ const (
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
-// UpdateBMCInfoRequest
+// UpdateBMCInfoRequest is the request payload for updating BMC information.
type UpdateBMCInfoRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Partition the partition id where metal-bmc wants to receive events
+ // 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 contains 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
@@ -78,12 +78,12 @@ func (x *UpdateBMCInfoRequest) GetBmcReports() map[string]*v2.MachineBMCReport {
return nil
}
-// UpdateBMCInfoResponse
+// UpdateBMCInfoResponse is the response payload for updating BMC information.
type UpdateBMCInfoResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // UpdatedMachines is a slice of machine uuids which were updated
+ // UpdatedMachines is a slice of machine UUIDs which were updated
UpdatedMachines []string `protobuf:"bytes,1,rep,name=updated_machines,json=updatedMachines,proto3" json:"updated_machines,omitempty"`
- // CreatedMachines is a slice of machine uuids which were created
+ // CreatedMachines is a slice of machine UUIDs which were created
CreatedMachines []string `protobuf:"bytes,2,rep,name=created_machines,json=createdMachines,proto3" json:"created_machines,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -133,10 +133,10 @@ func (x *UpdateBMCInfoResponse) GetCreatedMachines() []string {
return nil
}
-// WaitForBMCCommandRequest
+// WaitForBMCCommandRequest is the request payload for waiting for a BMC command.
type WaitForBMCCommandRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Partition the partition id where metal-bmc wants to receive bmc commands
+ // Partition is the partition ID where metal-bmc wants to receive BMC commands
Partition string `protobuf:"bytes,1,opt,name=partition,proto3" json:"partition,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -179,17 +179,17 @@ func (x *WaitForBMCCommandRequest) GetPartition() string {
return ""
}
-// WaitForBMCCommandResponse
+// WaitForBMCCommandResponse is the response payload for waiting for a BMC command.
type WaitForBMCCommandResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
// UUID of the machine to send the command to
Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
- // BmcCommand to execute against the bmc of the machine
+ // BmcCommand to execute against the BMC of the machine
BmcCommand v2.MachineBMCCommand `protobuf:"varint,2,opt,name=bmc_command,json=bmcCommand,proto3,enum=metalstack.api.v2.MachineBMCCommand" json:"bmc_command,omitempty"`
- // MachineBmc contains connection details of the machine to issue the bmcCommand to
+ // MachineBmc contains connection details of the machine to issue the BMC command to
MachineBmc *v2.MachineBMC `protobuf:"bytes,3,opt,name=machine_bmc,json=machineBmc,proto3" json:"machine_bmc,omitempty"`
// CommandId is a unique ID which must be sent back after execution
- // it is usually in the form: :machine-bmc-command:
+ // It is usually in the form: :machine-bmc-command:
CommandId string `protobuf:"bytes,4,opt,name=command_id,json=commandId,proto3" json:"command_id,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -253,11 +253,11 @@ func (x *WaitForBMCCommandResponse) GetCommandId() string {
return ""
}
-// BMCCommandDoneRequest must be returned after command execution
+// BMCCommandDoneRequest must be returned after command execution.
type BMCCommandDoneRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// CommandId is a unique ID which must be sent back after execution
- // it is usually in the form: :machine-bmc-command
+ // It is usually in the form: :machine-bmc-command
CommandId string `protobuf:"bytes,1,opt,name=command_id,json=commandId,proto3" json:"command_id,omitempty"`
// Error of the command execution, nil if it was successful
Error *string `protobuf:"bytes,2,opt,name=error,proto3,oneof" json:"error,omitempty"`
@@ -309,7 +309,7 @@ func (x *BMCCommandDoneRequest) GetError() string {
return ""
}
-// BMCCommandDoneResponse
+// BMCCommandDoneResponse is the response payload for BMC command completion.
type BMCCommandDoneResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
unknownFields protoimpl.UnknownFields
diff --git a/go/metalstack/infra/v2/component.pb.go b/go/metalstack/infra/v2/component.pb.go
index 8214cb0b..7dffdf51 100644
--- a/go/metalstack/infra/v2/component.pb.go
+++ b/go/metalstack/infra/v2/component.pb.go
@@ -25,18 +25,16 @@ const (
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
-// ComponentServicePingRequest is sent from a microservice to report its state regularly
+// ComponentServicePingRequest is the request payload for pinging a microservice.
type ComponentServicePingRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
// Type defines which service is actually pinging
Type v2.ComponentType `protobuf:"varint,1,opt,name=type,proto3,enum=metalstack.api.v2.ComponentType" json:"type,omitempty"`
- // Identifier is a unique identifier of this service, e.g. if two instance are running, this might be the pod id.
- // micro_service and identifier guarantee uniqueness.
+ // Identifier is a unique identifier of this service, for example if two instances are running, this might be the pod ID
Identifier string `protobuf:"bytes,2,opt,name=identifier,proto3" json:"identifier,omitempty"`
- // StartedAt is the timestamp this service was started.
+ // StartedAt is the timestamp this service was started
StartedAt *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=started_at,json=startedAt,proto3" json:"started_at,omitempty"`
- // Interval at which the ping is scheduled, must be between 5 seconds and 1 hour.
- // Also gets validated in the same way in go/client/ping.go.
+ // Interval at which the ping is scheduled, must be between 5 seconds and 1 hour
Interval *durationpb.Duration `protobuf:"bytes,4,opt,name=interval,proto3" json:"interval,omitempty"`
// Version of this service
Version *v2.Version `protobuf:"bytes,5,opt,name=version,proto3" json:"version,omitempty"`
@@ -109,7 +107,7 @@ func (x *ComponentServicePingRequest) GetVersion() *v2.Version {
return nil
}
-// ComponentServicePingResponse is the response to a ping request
+// ComponentServicePingResponse is the response payload for pinging a microservice.
type ComponentServicePingResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
unknownFields protoimpl.UnknownFields
diff --git a/go/metalstack/infra/v2/event.pb.go b/go/metalstack/infra/v2/event.pb.go
index 353e7029..d83e200f 100644
--- a/go/metalstack/infra/v2/event.pb.go
+++ b/go/metalstack/infra/v2/event.pb.go
@@ -28,29 +28,29 @@ const (
type ProvisioningEventType int32
const (
- // PROVISIONING_EVENT_TYPE_UNSPECIFIED is unspecified.
+ // PROVISIONING_EVENT_TYPE_UNSPECIFIED is unspecified
ProvisioningEventType_PROVISIONING_EVENT_TYPE_UNSPECIFIED ProvisioningEventType = 0
- // PROVISIONING_EVENT_TYPE_ALIVE means the machine has reported itself to the API not long ago.
+ // PROVISIONING_EVENT_TYPE_ALIVE means the machine has reported itself to the API not long ago
ProvisioningEventType_PROVISIONING_EVENT_TYPE_ALIVE ProvisioningEventType = 1
- // PROVISIONING_EVENT_TYPE_CRASHED means an irregularity in the machine's lifecycle.
+ // PROVISIONING_EVENT_TYPE_CRASHED means an irregularity in the machine's lifecycle
ProvisioningEventType_PROVISIONING_EVENT_TYPE_CRASHED ProvisioningEventType = 2
- // PROVISIONING_EVENT_TYPE_PXE_BOOTING is sent when an unprovisioned machine requests a boot image via PXE.
+ // PROVISIONING_EVENT_TYPE_PXE_BOOTING is sent when an unprovisioned machine requests a boot image via PXE
ProvisioningEventType_PROVISIONING_EVENT_TYPE_PXE_BOOTING ProvisioningEventType = 3
- // PROVISIONING_EVENT_TYPE_PLANNED_REBOOT means the machine was scheduled for reboot.
+ // PROVISIONING_EVENT_TYPE_PLANNED_REBOOT means the machine was scheduled for reboot
ProvisioningEventType_PROVISIONING_EVENT_TYPE_PLANNED_REBOOT ProvisioningEventType = 4
- // PROVISIONING_EVENT_TYPE_PREPARING means the metal-hammer has started.
+ // PROVISIONING_EVENT_TYPE_PREPARING means the metal-hammer has started
ProvisioningEventType_PROVISIONING_EVENT_TYPE_PREPARING ProvisioningEventType = 5
- // PROVISIONING_EVENT_TYPE_REGISTERING means the metal-hammer is attempting to register the machine at the API.
+ // PROVISIONING_EVENT_TYPE_REGISTERING means the metal-hammer is attempting to register the machine at the API
ProvisioningEventType_PROVISIONING_EVENT_TYPE_REGISTERING ProvisioningEventType = 6
- // PROVISIONING_EVENT_TYPE_WAITING means the machine has successfully reached the state where it is waiting for allocation.
+ // PROVISIONING_EVENT_TYPE_WAITING means the machine has successfully reached the state where it is waiting for allocation
ProvisioningEventType_PROVISIONING_EVENT_TYPE_WAITING ProvisioningEventType = 7
- // PROVISIONING_EVENT_TYPE_INSTALLING means the machine was allocated and the requested OS is being installed.
+ // PROVISIONING_EVENT_TYPE_INSTALLING means the machine was allocated and the requested OS is being installed
ProvisioningEventType_PROVISIONING_EVENT_TYPE_INSTALLING ProvisioningEventType = 8
- // PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL means the machine has successfully been installed and is now booting into the new OS.
+ // PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL means the machine has successfully been installed and is now booting into the new OS
ProvisioningEventType_PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL ProvisioningEventType = 9
- // PROVISIONING_EVENT_TYPE_PHONED_HOME is sent periodically by an allocated machine to indicate its liveliness.
+ // PROVISIONING_EVENT_TYPE_PHONED_HOME is sent periodically by an allocated machine to indicate its liveliness
ProvisioningEventType_PROVISIONING_EVENT_TYPE_PHONED_HOME ProvisioningEventType = 10
- // PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM means the machine was freed and is about to return into the pool of waiting machines.
+ // PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM means the machine was freed and is about to return into the pool of waiting machines
ProvisioningEventType_PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM ProvisioningEventType = 11
)
@@ -113,10 +113,10 @@ func (ProvisioningEventType) EnumDescriptor() ([]byte, []int) {
return file_metalstack_infra_v2_event_proto_rawDescGZIP(), []int{0}
}
-// EventServiceSendRequest.
+// EventServiceSendRequest is the request payload for sending provisioning events.
type EventServiceSendRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Events grouped by machine IDs.
+ // Events grouped by machine IDs
Events map[string]*MachineProvisioningEvent `protobuf:"bytes,1,rep,name=events,proto3" json:"events,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -159,12 +159,12 @@ func (x *EventServiceSendRequest) GetEvents() map[string]*MachineProvisioningEve
return nil
}
-// EventServiceSendResponse.
+// EventServiceSendResponse is the response payload for sending provisioning events.
type EventServiceSendResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Events counts the number of events successfully stored in the database.
+ // Events counts the number of events successfully stored in the database
Events uint64 `protobuf:"varint,1,opt,name=events,proto3" json:"events,omitempty"`
- // Failed contains IDs of all machines whose events could not be stored in the database.
+ // Failed contains IDs of all machines whose events could not be stored in the database
Failed []string `protobuf:"bytes,2,rep,name=failed,proto3" json:"failed,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -217,11 +217,11 @@ func (x *EventServiceSendResponse) GetFailed() []string {
// MachineProvisioningEvent contains details about an event.
type MachineProvisioningEvent struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Time the event occurred at.
+ // Time the event occurred at
Time *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=time,proto3" json:"time,omitempty"`
- // Event that occurred.
+ // Event that occurred
Event ProvisioningEventType `protobuf:"varint,2,opt,name=event,proto3,enum=metalstack.infra.v2.ProvisioningEventType" json:"event,omitempty"`
- // Message describing the event in more detail.
+ // Message describes the event in more detail
Message string `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
diff --git a/go/metalstack/infra/v2/infrav2connect/bmc.connect.go b/go/metalstack/infra/v2/infrav2connect/bmc.connect.go
index 0a2c93c0..9200e995 100644
--- a/go/metalstack/infra/v2/infrav2connect/bmc.connect.go
+++ b/go/metalstack/infra/v2/infrav2connect/bmc.connect.go
@@ -46,11 +46,11 @@ const (
// BMCServiceClient is a client for the metalstack.infra.v2.BMCService service.
type BMCServiceClient interface {
- // UpdateBMCInfo
+ // Updates BMC information.
UpdateBMCInfo(context.Context, *v2.UpdateBMCInfoRequest) (*v2.UpdateBMCInfoResponse, error)
- // WaitForBMCCommand is called by the metal-bmc and is returned with a bmc command to execute.
+ // WaitForBMCCommand is called by the metal-bmc and returns a BMC command to execute.
WaitForBMCCommand(context.Context, *v2.WaitForBMCCommandRequest) (*connect.ServerStreamForClient[v2.WaitForBMCCommandResponse], error)
- // BMCCommandDone must be called from metal-bmc after the command execution
+ // BMCCommandDone must be called from metal-bmc after the command execution.
BMCCommandDone(context.Context, *v2.BMCCommandDoneRequest) (*v2.BMCCommandDoneResponse, error)
}
@@ -118,11 +118,11 @@ func (c *bMCServiceClient) BMCCommandDone(ctx context.Context, req *v2.BMCComman
// BMCServiceHandler is an implementation of the metalstack.infra.v2.BMCService service.
type BMCServiceHandler interface {
- // UpdateBMCInfo
+ // Updates BMC information.
UpdateBMCInfo(context.Context, *v2.UpdateBMCInfoRequest) (*v2.UpdateBMCInfoResponse, error)
- // WaitForBMCCommand is called by the metal-bmc and is returned with a bmc command to execute.
+ // WaitForBMCCommand is called by the metal-bmc and returns a BMC command to execute.
WaitForBMCCommand(context.Context, *v2.WaitForBMCCommandRequest, *connect.ServerStream[v2.WaitForBMCCommandResponse]) error
- // BMCCommandDone must be called from metal-bmc after the command execution
+ // BMCCommandDone must be called from metal-bmc after the command execution.
BMCCommandDone(context.Context, *v2.BMCCommandDoneRequest) (*v2.BMCCommandDoneResponse, error)
}
diff --git a/go/metalstack/infra/v2/infrav2connect/boot.connect.go b/go/metalstack/infra/v2/infrav2connect/boot.connect.go
index 440c5234..497b49ae 100644
--- a/go/metalstack/infra/v2/infrav2connect/boot.connect.go
+++ b/go/metalstack/infra/v2/infrav2connect/boot.connect.go
@@ -51,17 +51,17 @@ const (
// BootServiceClient is a client for the metalstack.infra.v2.BootService service.
type BootServiceClient interface {
- // Dhcp is the first dhcp request (option 97). A ProvisioningEventPXEBooting is fired
+ // Dhcp handles the first DHCP request (option 97). A ProvisioningEventPXEBooting is fired.
Dhcp(context.Context, *v2.BootServiceDhcpRequest) (*v2.BootServiceDhcpResponse, error)
- // Boot is called from pixie once the machine got the first dhcp response and ipxie asks for subsequent kernel and initrd
+ // Boot is called from pixie once the machine got the first DHCP response and ipxe asks for subsequent kernel and initrd.
Boot(context.Context, *v2.BootServiceBootRequest) (*v2.BootServiceBootResponse, error)
- // SuperUserPassword metal-hammer takes the configured root password for the bmc from metal-apiserver and configure the bmc accordingly
+ // SuperUserPassword returns the configured root password for the BMC.
SuperUserPassword(context.Context, *v2.BootServiceSuperUserPasswordRequest) (*v2.BootServiceSuperUserPasswordResponse, error)
- // Register is called from metal-hammer after hardware inventory is finished, tells metal-apiserver all gory details about that machine
+ // Register is called from metal-hammer after hardware inventory is finished, tells metal-apiserver all details about that machine.
Register(context.Context, *v2.BootServiceRegisterRequest) (*v2.BootServiceRegisterResponse, error)
- // Wait is a hanging call that waits until the machine gets allocated by a user
+ // Wait is a hanging call that waits until the machine gets allocated by a user.
Wait(context.Context, *v2.BootServiceWaitRequest) (*connect.ServerStreamForClient[v2.BootServiceWaitResponse], error)
- // InstallationSucceeded tells metal-apiserver installation was either successful
+ // InstallationSucceeded tells metal-apiserver that installation was successful.
InstallationSucceeded(context.Context, *v2.BootServiceInstallationSucceededRequest) (*v2.BootServiceInstallationSucceededResponse, error)
}
@@ -177,17 +177,17 @@ func (c *bootServiceClient) InstallationSucceeded(ctx context.Context, req *v2.B
// BootServiceHandler is an implementation of the metalstack.infra.v2.BootService service.
type BootServiceHandler interface {
- // Dhcp is the first dhcp request (option 97). A ProvisioningEventPXEBooting is fired
+ // Dhcp handles the first DHCP request (option 97). A ProvisioningEventPXEBooting is fired.
Dhcp(context.Context, *v2.BootServiceDhcpRequest) (*v2.BootServiceDhcpResponse, error)
- // Boot is called from pixie once the machine got the first dhcp response and ipxie asks for subsequent kernel and initrd
+ // Boot is called from pixie once the machine got the first DHCP response and ipxe asks for subsequent kernel and initrd.
Boot(context.Context, *v2.BootServiceBootRequest) (*v2.BootServiceBootResponse, error)
- // SuperUserPassword metal-hammer takes the configured root password for the bmc from metal-apiserver and configure the bmc accordingly
+ // SuperUserPassword returns the configured root password for the BMC.
SuperUserPassword(context.Context, *v2.BootServiceSuperUserPasswordRequest) (*v2.BootServiceSuperUserPasswordResponse, error)
- // Register is called from metal-hammer after hardware inventory is finished, tells metal-apiserver all gory details about that machine
+ // Register is called from metal-hammer after hardware inventory is finished, tells metal-apiserver all details about that machine.
Register(context.Context, *v2.BootServiceRegisterRequest) (*v2.BootServiceRegisterResponse, error)
- // Wait is a hanging call that waits until the machine gets allocated by a user
+ // Wait is a hanging call that waits until the machine gets allocated by a user.
Wait(context.Context, *v2.BootServiceWaitRequest, *connect.ServerStream[v2.BootServiceWaitResponse]) error
- // InstallationSucceeded tells metal-apiserver installation was either successful
+ // InstallationSucceeded tells metal-apiserver that installation was successful.
InstallationSucceeded(context.Context, *v2.BootServiceInstallationSucceededRequest) (*v2.BootServiceInstallationSucceededResponse, error)
}
diff --git a/go/metalstack/infra/v2/infrav2connect/component.connect.go b/go/metalstack/infra/v2/infrav2connect/component.connect.go
index ea0dee3d..ecd34208 100644
--- a/go/metalstack/infra/v2/infrav2connect/component.connect.go
+++ b/go/metalstack/infra/v2/infrav2connect/component.connect.go
@@ -39,8 +39,7 @@ const (
// ComponentServiceClient is a client for the metalstack.infra.v2.ComponentService service.
type ComponentServiceClient interface {
- // Ping must be called from every connected microservice in a recurring manner
- // to get visibility of all registered microservices.
+ // Returns the ping response to register or report the microservice state.
Ping(context.Context, *v2.ComponentServicePingRequest) (*v2.ComponentServicePingResponse, error)
}
@@ -80,8 +79,7 @@ func (c *componentServiceClient) Ping(ctx context.Context, req *v2.ComponentServ
// ComponentServiceHandler is an implementation of the metalstack.infra.v2.ComponentService service.
type ComponentServiceHandler interface {
- // Ping must be called from every connected microservice in a recurring manner
- // to get visibility of all registered microservices.
+ // Returns the ping response to register or report the microservice state.
Ping(context.Context, *v2.ComponentServicePingRequest) (*v2.ComponentServicePingResponse, error)
}
diff --git a/go/metalstack/infra/v2/infrav2connect/event.connect.go b/go/metalstack/infra/v2/infrav2connect/event.connect.go
index 2deb182e..24284b51 100644
--- a/go/metalstack/infra/v2/infrav2connect/event.connect.go
+++ b/go/metalstack/infra/v2/infrav2connect/event.connect.go
@@ -39,7 +39,7 @@ const (
// EventServiceClient is a client for the metalstack.infra.v2.EventService service.
type EventServiceClient interface {
- // Send a series of machine provisioning events.
+ // Sends a series of machine provisioning events.
Send(context.Context, *v2.EventServiceSendRequest) (*v2.EventServiceSendResponse, error)
}
@@ -79,7 +79,7 @@ func (c *eventServiceClient) Send(ctx context.Context, req *v2.EventServiceSendR
// EventServiceHandler is an implementation of the metalstack.infra.v2.EventService service.
type EventServiceHandler interface {
- // Send a series of machine provisioning events.
+ // Sends a series of machine provisioning events.
Send(context.Context, *v2.EventServiceSendRequest) (*v2.EventServiceSendResponse, error)
}
diff --git a/go/metalstack/infra/v2/infrav2connect/switch.connect.go b/go/metalstack/infra/v2/infrav2connect/switch.connect.go
index ae248c4b..89020b05 100644
--- a/go/metalstack/infra/v2/infrav2connect/switch.connect.go
+++ b/go/metalstack/infra/v2/infrav2connect/switch.connect.go
@@ -43,11 +43,11 @@ const (
// SwitchServiceClient is a client for the metalstack.infra.v2.SwitchService service.
type SwitchServiceClient interface {
- // Get a switch by ID.
+ // Returns the switch with the specified ID.
Get(context.Context, *v2.SwitchServiceGetRequest) (*v2.SwitchServiceGetResponse, error)
- // Register a switch.
+ // Registers a switch.
Register(context.Context, *v2.SwitchServiceRegisterRequest) (*v2.SwitchServiceRegisterResponse, error)
- // Heartbeat a switch.
+ // Heartbeat sends a heartbeat from a switch.
Heartbeat(context.Context, *v2.SwitchServiceHeartbeatRequest) (*v2.SwitchServiceHeartbeatResponse, error)
}
@@ -119,11 +119,11 @@ func (c *switchServiceClient) Heartbeat(ctx context.Context, req *v2.SwitchServi
// SwitchServiceHandler is an implementation of the metalstack.infra.v2.SwitchService service.
type SwitchServiceHandler interface {
- // Get a switch by ID.
+ // Returns the switch with the specified ID.
Get(context.Context, *v2.SwitchServiceGetRequest) (*v2.SwitchServiceGetResponse, error)
- // Register a switch.
+ // Registers a switch.
Register(context.Context, *v2.SwitchServiceRegisterRequest) (*v2.SwitchServiceRegisterResponse, error)
- // Heartbeat a switch.
+ // Heartbeat sends a heartbeat from a switch.
Heartbeat(context.Context, *v2.SwitchServiceHeartbeatRequest) (*v2.SwitchServiceHeartbeatResponse, error)
}
diff --git a/go/metalstack/infra/v2/switch.pb.go b/go/metalstack/infra/v2/switch.pb.go
index 3d3f2057..aadc02d5 100644
--- a/go/metalstack/infra/v2/switch.pb.go
+++ b/go/metalstack/infra/v2/switch.pb.go
@@ -24,10 +24,10 @@ const (
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
-// SwitchServiceGetRequest.
+// SwitchServiceGetRequest is the request payload for getting a switch.
type SwitchServiceGetRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Id of the switch.
+ // Id of the switch
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -70,10 +70,10 @@ func (x *SwitchServiceGetRequest) GetId() string {
return ""
}
-// SwitchServiceGetResponse.
+// SwitchServiceGetResponse is the response payload for getting a switch.
type SwitchServiceGetResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Switch that was requested.
+ // Switch contains the requested switch
Switch *v2.Switch `protobuf:"bytes,1,opt,name=switch,proto3" json:"switch,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -116,10 +116,10 @@ func (x *SwitchServiceGetResponse) GetSwitch() *v2.Switch {
return nil
}
-// SwitchServiceRegisterRequest.
+// SwitchServiceRegisterRequest is the request payload for registering a switch.
type SwitchServiceRegisterRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Switch to register.
+ // Switch to register
Switch *v2.Switch `protobuf:"bytes,1,opt,name=switch,proto3" json:"switch,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -162,10 +162,10 @@ func (x *SwitchServiceRegisterRequest) GetSwitch() *v2.Switch {
return nil
}
-// SwitchServiceRegisterResponse.
+// SwitchServiceRegisterResponse is the response payload for registering a switch.
type SwitchServiceRegisterResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Switch that was registered.
+ // Switch contains the registered switch
Switch *v2.Switch `protobuf:"bytes,1,opt,name=switch,proto3" json:"switch,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -208,18 +208,18 @@ func (x *SwitchServiceRegisterResponse) GetSwitch() *v2.Switch {
return nil
}
-// SwitchServiceHeartbeatRequest.
+// SwitchServiceHeartbeatRequest is the request payload for sending a switch heartbeat.
type SwitchServiceHeartbeatRequest struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Id of the switch.
+ // Id of the switch
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
- // Duration of the sync.
+ // Duration of the sync
Duration *durationpb.Duration `protobuf:"bytes,2,opt,name=duration,proto3" json:"duration,omitempty"`
- // Error if any occurred during the sync.
+ // Error if any occurred during the sync
Error *string `protobuf:"bytes,3,opt,name=error,proto3,oneof" json:"error,omitempty"`
- // PortStates maps port identifiers to the respective port's operational state.
+ // PortStates maps port identifiers to the respective port's operational state
PortStates map[string]v2.SwitchPortStatus `protobuf:"bytes,4,rep,name=port_states,json=portStates,proto3" json:"port_states,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"varint,2,opt,name=value,enum=metalstack.api.v2.SwitchPortStatus"`
- // BgpPortStates maps port identifiers to the respective port's BGP state.
+ // BgpPortStates maps port identifiers to the respective port's BGP state
BgpPortStates map[string]*v2.SwitchBGPPortState `protobuf:"bytes,5,rep,name=bgp_port_states,json=bgpPortStates,proto3" json:"bgp_port_states,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
@@ -290,14 +290,14 @@ func (x *SwitchServiceHeartbeatRequest) GetBgpPortStates() map[string]*v2.Switch
return nil
}
-// SwitchServiceHeartbeatResponse.
+// SwitchServiceHeartbeatResponse is the response payload for sending a switch heartbeat.
type SwitchServiceHeartbeatResponse struct {
state protoimpl.MessageState `protogen:"open.v1"`
- // Id of the switch.
+ // Id of the switch
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
- // LastSync holds information about the last sync.
+ // LastSync holds information about the last sync
LastSync *v2.SwitchSync `protobuf:"bytes,2,opt,name=last_sync,json=lastSync,proto3" json:"last_sync,omitempty"`
- // LastSyncError holds information about the last erroneous sync.
+ // LastSyncError holds information about the last erroneous sync
LastSyncError *v2.SwitchSync `protobuf:"bytes,3,opt,name=last_sync_error,json=lastSyncError,proto3" json:"last_sync_error,omitempty"`
unknownFields protoimpl.UnknownFields
sizeCache protoimpl.SizeCache
diff --git a/js/metalstack/admin/v2/audit_pb.d.ts b/js/metalstack/admin/v2/audit_pb.d.ts
index dc15a5f3..7e0a57f5 100644
--- a/js/metalstack/admin/v2/audit_pb.d.ts
+++ b/js/metalstack/admin/v2/audit_pb.d.ts
@@ -6,7 +6,7 @@ import type { Message } from "@bufbuild/protobuf";
*/
export declare const file_metalstack_admin_v2_audit: GenFile;
/**
- * AuditServiceListRequest is the request payload to list audits
+ * AuditServiceListRequest is the request payload for listing audit traces.
*
* @generated from message metalstack.admin.v2.AuditServiceListRequest
*/
@@ -24,13 +24,13 @@ export type AuditServiceListRequest = Message<"metalstack.admin.v2.AuditServiceL
*/
export declare const AuditServiceListRequestSchema: GenMessage;
/**
- * AuditServiceListResponse is the response payload of a audit list request
+ * AuditServiceListResponse is the response payload for listing audit traces.
*
* @generated from message metalstack.admin.v2.AuditServiceListResponse
*/
export type AuditServiceListResponse = Message<"metalstack.admin.v2.AuditServiceListResponse"> & {
/**
- * Traces is a list of audit traces
+ * Traces contains the list of audit traces
*
* @generated from field: repeated metalstack.api.v2.AuditTrace traces = 1;
*/
@@ -42,7 +42,7 @@ export type AuditServiceListResponse = Message<"metalstack.admin.v2.AuditService
*/
export declare const AuditServiceListResponseSchema: GenMessage;
/**
- * AuditServiceGetRequest is the request payload of a audit get request
+ * AuditServiceGetRequest is the request payload for getting an audit trace.
*
* @generated from message metalstack.admin.v2.AuditServiceGetRequest
*/
@@ -66,7 +66,7 @@ export type AuditServiceGetRequest = Message<"metalstack.admin.v2.AuditServiceGe
*/
export declare const AuditServiceGetRequestSchema: GenMessage;
/**
- * AuditServiceGetResponse is the response payload of a audit get request
+ * AuditServiceGetResponse is the response payload for getting an audit trace.
*
* @generated from message metalstack.admin.v2.AuditServiceGetResponse
*/
@@ -84,13 +84,13 @@ export type AuditServiceGetResponse = Message<"metalstack.admin.v2.AuditServiceG
*/
export declare const AuditServiceGetResponseSchema: GenMessage;
/**
- * AuditService serves audit related functions
+ * AuditService provides audit logging operations.
*
* @generated from service metalstack.admin.v2.AuditService
*/
export declare const AuditService: GenService<{
/**
- * Get an audit trace
+ * Returns the audit trace with the specified UUID.
*
* @generated from rpc metalstack.admin.v2.AuditService.Get
*/
@@ -100,7 +100,7 @@ export declare const AuditService: GenService<{
output: typeof AuditServiceGetResponseSchema;
};
/**
- * List all audit traces
+ * Returns the list of all audit traces.
*
* @generated from rpc metalstack.admin.v2.AuditService.List
*/
diff --git a/js/metalstack/admin/v2/audit_pb.js b/js/metalstack/admin/v2/audit_pb.js
index 6a84f276..97e10962 100644
--- a/js/metalstack/admin/v2/audit_pb.js
+++ b/js/metalstack/admin/v2/audit_pb.js
@@ -30,7 +30,7 @@ export const AuditServiceGetRequestSchema = /*@__PURE__*/ messageDesc(file_metal
*/
export const AuditServiceGetResponseSchema = /*@__PURE__*/ messageDesc(file_metalstack_admin_v2_audit, 3);
/**
- * AuditService serves audit related functions
+ * AuditService provides audit logging operations.
*
* @generated from service metalstack.admin.v2.AuditService
*/
diff --git a/js/metalstack/admin/v2/audit_pb.ts b/js/metalstack/admin/v2/audit_pb.ts
index d2392aaf..b999e1cf 100644
--- a/js/metalstack/admin/v2/audit_pb.ts
+++ b/js/metalstack/admin/v2/audit_pb.ts
@@ -17,7 +17,7 @@ export const file_metalstack_admin_v2_audit: GenFile = /*@__PURE__*/
fileDesc("Ch9tZXRhbHN0YWNrL2FkbWluL3YyL2F1ZGl0LnByb3RvEhNtZXRhbHN0YWNrLmFkbWluLnYyIkcKF0F1ZGl0U2VydmljZUxpc3RSZXF1ZXN0EiwKBXF1ZXJ5GAEgASgLMh0ubWV0YWxzdGFjay5hcGkudjIuQXVkaXRRdWVyeSJJChhBdWRpdFNlcnZpY2VMaXN0UmVzcG9uc2USLQoGdHJhY2VzGAEgAygLMh0ubWV0YWxzdGFjay5hcGkudjIuQXVkaXRUcmFjZSJ3ChZBdWRpdFNlcnZpY2VHZXRSZXF1ZXN0EhYKBHV1aWQYASABKAlCCLpIBXIDsAEBEjsKBXBoYXNlGAIgASgOMh0ubWV0YWxzdGFjay5hcGkudjIuQXVkaXRQaGFzZUIIukgFggECEAFIAIgBAUIICgZfcGhhc2UiRwoXQXVkaXRTZXJ2aWNlR2V0UmVzcG9uc2USLAoFdHJhY2UYASABKAsyHS5tZXRhbHN0YWNrLmFwaS52Mi5BdWRpdFRyYWNlMuUBCgxBdWRpdFNlcnZpY2USaAoDR2V0EisubWV0YWxzdGFjay5hZG1pbi52Mi5BdWRpdFNlcnZpY2VHZXRSZXF1ZXN0GiwubWV0YWxzdGFjay5hZG1pbi52Mi5BdWRpdFNlcnZpY2VHZXRSZXNwb25zZSIG0vMYAgECEmsKBExpc3QSLC5tZXRhbHN0YWNrLmFkbWluLnYyLkF1ZGl0U2VydmljZUxpc3RSZXF1ZXN0Gi0ubWV0YWxzdGFjay5hZG1pbi52Mi5BdWRpdFNlcnZpY2VMaXN0UmVzcG9uc2UiBtLzGAIBAkLOAQoXY29tLm1ldGFsc3RhY2suYWRtaW4udjJCCkF1ZGl0UHJvdG9QAVo5Z2l0aHViLmNvbS9tZXRhbC1zdGFjay9hcGkvZ28vbWV0YWxzdGFjay9hZG1pbi92MjthZG1pbnYyogIDTUFYqgITTWV0YWxzdGFjay5BZG1pbi5WMsoCE01ldGFsc3RhY2tcQWRtaW5cVjLiAh9NZXRhbHN0YWNrXEFkbWluXFYyXEdQQk1ldGFkYXRh6gIVTWV0YWxzdGFjazo6QWRtaW46OlYyYgZwcm90bzM", [file_buf_validate_validate, file_metalstack_api_v2_audit, file_metalstack_api_v2_common]);
/**
- * AuditServiceListRequest is the request payload to list audits
+ * AuditServiceListRequest is the request payload for listing audit traces.
*
* @generated from message metalstack.admin.v2.AuditServiceListRequest
*/
@@ -38,13 +38,13 @@ export const AuditServiceListRequestSchema: GenMessage
messageDesc(file_metalstack_admin_v2_audit, 0);
/**
- * AuditServiceListResponse is the response payload of a audit list request
+ * AuditServiceListResponse is the response payload for listing audit traces.
*
* @generated from message metalstack.admin.v2.AuditServiceListResponse
*/
export type AuditServiceListResponse = Message<"metalstack.admin.v2.AuditServiceListResponse"> & {
/**
- * Traces is a list of audit traces
+ * Traces contains the list of audit traces
*
* @generated from field: repeated metalstack.api.v2.AuditTrace traces = 1;
*/
@@ -59,7 +59,7 @@ export const AuditServiceListResponseSchema: GenMessage =
messageDesc(file_metalstack_admin_v2_audit, 2);
/**
- * AuditServiceGetResponse is the response payload of a audit get request
+ * AuditServiceGetResponse is the response payload for getting an audit trace.
*
* @generated from message metalstack.admin.v2.AuditServiceGetResponse
*/
@@ -108,13 +108,13 @@ export const AuditServiceGetResponseSchema: GenMessage