diff --git a/doc/index.html b/doc/index.html index 56bf2538..423ce078 100644 --- a/doc/index.html +++ b/doc/index.html @@ -3445,7 +3445,7 @@
VISIBILITY_SELF enable call this endpoint from the authenticated user only
VISIBILITY_SELF restricts calls to the authenticated user only
AdminRoles are used to define which admin role a logged in user must provide to call this method
AdminRoles are used to define the admin role a logged in user must provide to call this method
InfraRoles are used to define which infra role a microservice must provide to call this method
InfraRoles are used to define the infra role a microservice must provide to call this method
ProjectRoles are used to define which project role a logged in user must provide to call this method
ProjectRoles are used to define the project role a logged in user must provide to call this method
TenantRoles are used to define which tenant role a logged in user must provide to call this method
TenantRoles are used to define the tenant role a logged in user must provide to call this method
AuditServiceListRequest is the request payload for a audit list request
+AuditServiceListRequest is the request payload for an audit list request
| tenant_roles | TokenServiceCreateRequest.TenantRolesEntry | repeated | -TenantRoles_associates a tenant id with the corresponding role of the token owner |
+ TenantRoles associates a tenant id with the corresponding role of the token owner |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| secret | string | - | Secret is the body if the jwt token, should be used in api requests as bearer token |
+ Secret is the body of the JWT token, should be used in API requests as bearer token |
secret | string | - | Secret is the body if the jwt token, should be used in api requests as bearer token |
+ Secret is the body of the JWT token, should be used in API requests as bearer token |
@@ -5555,14 +5555,14 @@ label | string | optional | -optional label for this this partition |
+ Label an optional label for this partition |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| size | uint64 | - | Size size in mebibytes (MiB) of this partition" |
+ Size in mebibytes (MiB) of this partition |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| label | string | optional | -Label optional label for this this filesystem |
+ Label an optional label for this filesystem |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| expires_at | google.protobuf.Timestamp | - | ExpiresAt usage is not possible after this date |
+ ExpiresAt indicates that usage is not possible after this date |
@@ -7356,7 +7356,7 @@
| network | string | optional | -Network from where the ips to list |
+ Network from which the IPs are to list |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| uuid | string | optional | -Uuid for which this ips should get filtered |
+ UUID for which these IPs should be filtered |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| machine | string | optional | -Machine for which this ips should get filtered |
+ Machine for which these IPs should be filtered |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| labels | Labels | optional | -Labels for which this ips should get filtered |
+ Labels for which these IPs should be filtered |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| address_family | IPAddressFamily | optional | -Addressfamily of the IPs to list, defaults to all addressfamilies |
+ Address family of the IPs to list, defaults to all address families |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| query | IPQuery | - | Query to list one ore more ips |
+ Query to list one or more IPs |
@@ -7783,7 +7783,7 @@
IPType specifies different ip address types
+IPType specifies different IP address types
| Name | Number | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| IP_TYPE_EPHEMERAL | 1 | -IP_TYPE_EPHEMERAL defines a ephemeral ip address which is freed/deleted after usage |
+ IP_TYPE_EPHEMERAL defines an ephemeral IP address which is freed/deleted after usage |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| default_child_prefix_length | ChildPrefixLength | - | Default Child Prefix length defines the bitlength of a child network created per addressfamily, of not specified during the allocate request |
+ Default Child Prefix length defines the bit length of a child network created per address family, if not specified during the allocate request |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| consumption | NetworkConsumption | - | Consumption of ips and prefixes in this networks |
+ Consumption of IPs and prefixes in this network |
available_prefixes | uint64 | - | the total available 2 bit Prefixes |
+ the total available 2-bit prefixes |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| commandline | string | - | Commandline the cmdline to the kernel for the boot image |
+ Commandline the kernel command line for the boot image |
fru | MachineFRU | - | Fru containers field replaceable unit details |
+ Fru contains field replaceable unit details |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| date | string | - | Date the bios date as string because every vendor has different ideas howto describe the date |
+ Date the bios date as string because every vendor has different ideas how to describe the date |
only | MachineIssueType | repeated | -Only a list of machine issue types to include |
+ Only includes the specified machine issue types |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| omit | MachineIssueType | repeated | -Omit a list of machine issues to omit |
+ Omits the specified machine issues |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| query | metalstack.api.v2.MachineBMCQuery | - | Query to list one ore more bmcs of many machines |
+ Query to list one or more BMCs of many machines |
@@ -13080,7 +13080,7 @@ query | metalstack.api.v2.MachineQuery | - | Query to list one ore more machines |
+ Query to list one or more machines |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| id | string | - | ID of the partition to get |
+ ID of the partition to delete |
tenant | string | - | Tenant is the login of tenant who invites to join this project |
+ Tenant is the login of the tenant inviting another user to join this project |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| tenant_name | string | - | TenantName is the name of tenant who invites to join this project |
+ TenantName is the name of the tenant inviting another user to join this project |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| project_name | string | - | ProjectName if the project joined |
+ ProjectName of the project joined |
@@ -15216,14 +15216,14 @@ RemoveMember | ProjectServiceRemoveMemberRequest | ProjectServiceRemoveMemberResponse | -RemoveMember remove a user from a project |
+ RemoveMember removes a user from a project |
|||||||||||||||||||||||||||||||||||||||||||||
| UpdateMember | ProjectServiceUpdateMemberRequest | ProjectServiceUpdateMemberResponse | -UpdateMember update a user for a project |
+ UpdateMember updates a user for a project |
||||||||||||||||||||||||||||||||||||||||||||||||||
| InviteAccept | ProjectServiceInviteAcceptRequest | ProjectServiceInviteAcceptResponse | -InviteAccept is called from a user to accept a invitation |
+ InviteAccept is called by a user to accept an invitation |
||||||||||||||||||||||||||||||||||||||||||||||||||
| switch | metalstack.api.v2.Switch | - | Switch contains the switch was migrated to |
+ Switch contains the switch that was migrated to |
@@ -18523,14 +18523,14 @@ tenant | string | - | Tenant is the login of tenant who invites to join this tenant |
+ Tenant is the login of the tenant inviting another user to join this tenant |
||||||||||||||||||||||||||||||
| tenant_name | string | - | TenantName is the name of tenant who invites to join this tenant |
+ TenantName is the name of the tenant inviting another user to join this tenant |
|||||||||||||||||||||||||||||||||||
| projects | string | repeated | -Projects for the projects in which a user is a direct member |
+ Projects in which a user is a direct member |
| invites | TenantInvite | repeated | -Invites not already accepted the invitation to this tenant |
+ Invites that have not yet accepted the invitation to this tenant |
Leave | TenantServiceLeaveRequest | TenantServiceLeaveResponse | -Leave remove a member of a tenant |
+ Leave removes a member from a tenant |
| RemoveMember | TenantServiceRemoveMemberRequest | TenantServiceRemoveMemberResponse | -RemoveMember remove a member of a tenant |
+ RemoveMember removes a member from a tenant |
| RemoveMember | TenantServiceRemoveMemberRequest | TenantServiceRemoveMemberResponse | -RemoveMember remove a member of a tenant |
+ RemoveMember removes a member from a tenant |
default_tenant | Tenant | - | DefaultTenant this user belongs to |
+ DefaultTenant the default tenant that this user belongs to |
@@ -20901,7 +20901,7 @@ bmc_reports | UpdateBMCInfoRequest.BmcReportsEntry | repeated | -BmcReports contains maps the BMC report per machine UUID |
+ BmcReports maps the BMC report per machine UUID |
@@ -21291,7 +21291,7 @@ metal_hammer_version | string | - | MetalHammer version this machine was bootet into |
+ MetalHammer version this machine was booted into |