From d3c3d3adf8d675da0d41a8b3e742a3266d8e5672 Mon Sep 17 00:00:00 2001 From: Stefan Majer Date: Wed, 12 Aug 2026 08:06:33 +0200 Subject: [PATCH 1/3] Fix punctuation in docstrings --- bun.lock | 9 + doc/index.html | 1660 ++++++++--------- .../v2/adminv2connect/machine.connect.go | 4 +- .../admin/v2/adminv2connect/tenant.connect.go | 8 +- go/metalstack/admin/v2/audit.pb.go | 8 +- go/metalstack/admin/v2/component.pb.go | 12 +- go/metalstack/admin/v2/filesystem.pb.go | 20 +- go/metalstack/admin/v2/image.pb.go | 16 +- go/metalstack/admin/v2/ip.pb.go | 4 +- go/metalstack/admin/v2/machine.pb.go | 54 +- go/metalstack/admin/v2/network.pb.go | 32 +- go/metalstack/admin/v2/partition.pb.go | 24 +- go/metalstack/admin/v2/project.pb.go | 4 +- go/metalstack/admin/v2/size.pb.go | 10 +- .../admin/v2/size_imageconstraint.pb.go | 14 +- go/metalstack/admin/v2/size_reservation.pb.go | 14 +- go/metalstack/admin/v2/switch.pb.go | 38 +- go/metalstack/admin/v2/task.pb.go | 78 +- go/metalstack/admin/v2/tenant.pb.go | 20 +- go/metalstack/admin/v2/token.pb.go | 12 +- go/metalstack/admin/v2/vpn.pb.go | 18 +- .../api/v2/apiv2connect/project.connect.go | 44 +- .../api/v2/apiv2connect/tenant.connect.go | 40 +- go/metalstack/api/v2/audit.pb.go | 60 +- go/metalstack/api/v2/common.pb.go | 68 +- go/metalstack/api/v2/component.pb.go | 28 +- go/metalstack/api/v2/filesystem.pb.go | 58 +- go/metalstack/api/v2/health.pb.go | 18 +- go/metalstack/api/v2/image.pb.go | 36 +- go/metalstack/api/v2/ip.pb.go | 60 +- go/metalstack/api/v2/machine.pb.go | 216 +-- go/metalstack/api/v2/method.pb.go | 14 +- go/metalstack/api/v2/network.pb.go | 78 +- go/metalstack/api/v2/partition.pb.go | 26 +- go/metalstack/api/v2/predefined_rules.pb.go | 48 +- go/metalstack/api/v2/project.pb.go | 142 +- go/metalstack/api/v2/size.pb.go | 26 +- .../api/v2/size_imageconstraint.pb.go | 12 +- go/metalstack/api/v2/size_reservation.pb.go | 14 +- go/metalstack/api/v2/tenant.pb.go | 120 +- go/metalstack/api/v2/token.pb.go | 136 +- go/metalstack/api/v2/user.pb.go | 4 +- go/metalstack/api/v2/version.pb.go | 2 +- go/metalstack/api/v2/vpn.pb.go | 2 +- go/metalstack/infra/v2/bmc.pb.go | 20 +- go/metalstack/infra/v2/boot.pb.go | 36 +- go/metalstack/infra/v2/component.pb.go | 6 +- go/metalstack/infra/v2/event.pb.go | 2 +- go/metalstack/infra/v2/switch.pb.go | 12 +- js/client-test.d.ts | 1 + js/client-test.js | 45 + js/metalstack/admin/v2/audit_pb.d.ts | 8 +- js/metalstack/admin/v2/audit_pb.ts | 8 +- js/metalstack/admin/v2/component_pb.d.ts | 12 +- js/metalstack/admin/v2/component_pb.ts | 12 +- js/metalstack/admin/v2/filesystem_pb.d.ts | 20 +- js/metalstack/admin/v2/filesystem_pb.ts | 20 +- js/metalstack/admin/v2/image_pb.d.ts | 16 +- js/metalstack/admin/v2/image_pb.ts | 16 +- js/metalstack/admin/v2/ip_pb.d.ts | 4 +- js/metalstack/admin/v2/ip_pb.ts | 4 +- js/metalstack/admin/v2/machine_pb.d.ts | 56 +- js/metalstack/admin/v2/machine_pb.ts | 56 +- js/metalstack/admin/v2/network_pb.d.ts | 32 +- js/metalstack/admin/v2/network_pb.ts | 32 +- js/metalstack/admin/v2/partition_pb.d.ts | 24 +- js/metalstack/admin/v2/partition_pb.ts | 24 +- js/metalstack/admin/v2/project_pb.d.ts | 4 +- js/metalstack/admin/v2/project_pb.ts | 4 +- .../admin/v2/size_imageconstraint_pb.d.ts | 14 +- .../admin/v2/size_imageconstraint_pb.ts | 14 +- js/metalstack/admin/v2/size_pb.d.ts | 10 +- js/metalstack/admin/v2/size_pb.ts | 10 +- .../admin/v2/size_reservation_pb.d.ts | 14 +- js/metalstack/admin/v2/size_reservation_pb.ts | 14 +- js/metalstack/admin/v2/switch_pb.d.ts | 38 +- js/metalstack/admin/v2/switch_pb.ts | 38 +- js/metalstack/admin/v2/task_pb.d.ts | 78 +- js/metalstack/admin/v2/task_pb.js | 16 +- js/metalstack/admin/v2/task_pb.ts | 78 +- js/metalstack/admin/v2/tenant_pb.d.ts | 24 +- js/metalstack/admin/v2/tenant_pb.ts | 24 +- js/metalstack/admin/v2/token_pb.d.ts | 12 +- js/metalstack/admin/v2/token_pb.ts | 12 +- js/metalstack/admin/v2/vpn_pb.d.ts | 18 +- js/metalstack/admin/v2/vpn_pb.ts | 18 +- js/metalstack/api/v2/audit_pb.d.ts | 60 +- js/metalstack/api/v2/audit_pb.js | 6 +- js/metalstack/api/v2/audit_pb.ts | 60 +- js/metalstack/api/v2/common_pb.d.ts | 68 +- js/metalstack/api/v2/common_pb.js | 42 +- js/metalstack/api/v2/common_pb.ts | 68 +- js/metalstack/api/v2/component_pb.d.ts | 28 +- js/metalstack/api/v2/component_pb.js | 16 +- js/metalstack/api/v2/component_pb.ts | 28 +- js/metalstack/api/v2/filesystem_pb.d.ts | 58 +- js/metalstack/api/v2/filesystem_pb.js | 26 +- js/metalstack/api/v2/filesystem_pb.ts | 58 +- js/metalstack/api/v2/health_pb.d.ts | 18 +- js/metalstack/api/v2/health_pb.js | 2 +- js/metalstack/api/v2/health_pb.ts | 18 +- js/metalstack/api/v2/image_pb.d.ts | 36 +- js/metalstack/api/v2/image_pb.js | 14 +- js/metalstack/api/v2/image_pb.ts | 36 +- js/metalstack/api/v2/ip_pb.d.ts | 60 +- js/metalstack/api/v2/ip_pb.js | 16 +- js/metalstack/api/v2/ip_pb.ts | 60 +- js/metalstack/api/v2/machine_pb.d.ts | 216 +-- js/metalstack/api/v2/machine_pb.js | 46 +- js/metalstack/api/v2/machine_pb.ts | 216 +-- js/metalstack/api/v2/method_pb.d.ts | 14 +- js/metalstack/api/v2/method_pb.ts | 14 +- js/metalstack/api/v2/network_pb.d.ts | 78 +- js/metalstack/api/v2/network_pb.js | 28 +- js/metalstack/api/v2/network_pb.ts | 78 +- js/metalstack/api/v2/partition_pb.d.ts | 26 +- js/metalstack/api/v2/partition_pb.ts | 26 +- js/metalstack/api/v2/predefined_rules_pb.d.ts | 48 +- js/metalstack/api/v2/predefined_rules_pb.js | 48 +- js/metalstack/api/v2/predefined_rules_pb.ts | 48 +- js/metalstack/api/v2/project_pb.d.ts | 164 +- js/metalstack/api/v2/project_pb.ts | 164 +- .../api/v2/size_imageconstraint_pb.d.ts | 12 +- .../api/v2/size_imageconstraint_pb.ts | 12 +- js/metalstack/api/v2/size_pb.d.ts | 26 +- js/metalstack/api/v2/size_pb.js | 10 +- js/metalstack/api/v2/size_pb.ts | 26 +- js/metalstack/api/v2/size_reservation_pb.d.ts | 14 +- js/metalstack/api/v2/size_reservation_pb.ts | 14 +- js/metalstack/api/v2/tenant_pb.d.ts | 140 +- js/metalstack/api/v2/tenant_pb.ts | 140 +- js/metalstack/api/v2/token_pb.d.ts | 136 +- js/metalstack/api/v2/token_pb.js | 6 +- js/metalstack/api/v2/token_pb.ts | 136 +- js/metalstack/api/v2/user_pb.d.ts | 4 +- js/metalstack/api/v2/user_pb.ts | 4 +- js/metalstack/api/v2/version_pb.d.ts | 2 +- js/metalstack/api/v2/version_pb.ts | 2 +- js/metalstack/api/v2/vpn_pb.d.ts | 2 +- js/metalstack/api/v2/vpn_pb.ts | 2 +- js/metalstack/infra/v2/bmc_pb.d.ts | 20 +- js/metalstack/infra/v2/bmc_pb.ts | 20 +- js/metalstack/infra/v2/boot_pb.d.ts | 36 +- js/metalstack/infra/v2/boot_pb.ts | 36 +- js/metalstack/infra/v2/component_pb.d.ts | 6 +- js/metalstack/infra/v2/component_pb.ts | 6 +- js/metalstack/infra/v2/event_pb.d.ts | 2 +- js/metalstack/infra/v2/event_pb.ts | 2 +- js/metalstack/infra/v2/switch_pb.d.ts | 12 +- js/metalstack/infra/v2/switch_pb.ts | 12 +- js/test-interceptor.d.ts | 9 + js/test-interceptor.js | 33 + package.json | 1 + proto/metalstack/admin/v2/audit.proto | 8 +- proto/metalstack/admin/v2/component.proto | 12 +- proto/metalstack/admin/v2/filesystem.proto | 20 +- proto/metalstack/admin/v2/image.proto | 16 +- proto/metalstack/admin/v2/ip.proto | 4 +- proto/metalstack/admin/v2/machine.proto | 56 +- proto/metalstack/admin/v2/network.proto | 32 +- proto/metalstack/admin/v2/partition.proto | 24 +- proto/metalstack/admin/v2/project.proto | 4 +- proto/metalstack/admin/v2/size.proto | 10 +- .../admin/v2/size_imageconstraint.proto | 14 +- .../admin/v2/size_reservation.proto | 14 +- proto/metalstack/admin/v2/switch.proto | 38 +- proto/metalstack/admin/v2/task.proto | 78 +- proto/metalstack/admin/v2/tenant.proto | 24 +- proto/metalstack/admin/v2/token.proto | 12 +- proto/metalstack/admin/v2/vpn.proto | 18 +- proto/metalstack/api/v2/audit.proto | 60 +- proto/metalstack/api/v2/common.proto | 70 +- proto/metalstack/api/v2/component.proto | 28 +- proto/metalstack/api/v2/filesystem.proto | 58 +- proto/metalstack/api/v2/health.proto | 18 +- proto/metalstack/api/v2/image.proto | 36 +- proto/metalstack/api/v2/ip.proto | 60 +- proto/metalstack/api/v2/machine.proto | 216 +-- proto/metalstack/api/v2/method.proto | 14 +- proto/metalstack/api/v2/network.proto | 78 +- proto/metalstack/api/v2/partition.proto | 26 +- .../metalstack/api/v2/predefined_rules.proto | 48 +- proto/metalstack/api/v2/project.proto | 164 +- proto/metalstack/api/v2/size.proto | 26 +- .../api/v2/size_imageconstraint.proto | 12 +- .../metalstack/api/v2/size_reservation.proto | 14 +- proto/metalstack/api/v2/tenant.proto | 140 +- proto/metalstack/api/v2/token.proto | 138 +- proto/metalstack/api/v2/user.proto | 4 +- proto/metalstack/api/v2/version.proto | 2 +- proto/metalstack/api/v2/vpn.proto | 2 +- proto/metalstack/infra/v2/bmc.proto | 20 +- proto/metalstack/infra/v2/boot.proto | 36 +- proto/metalstack/infra/v2/component.proto | 6 +- proto/metalstack/infra/v2/event.proto | 2 +- proto/metalstack/infra/v2/switch.proto | 12 +- 196 files changed, 4432 insertions(+), 4334 deletions(-) create mode 100644 js/client-test.d.ts create mode 100644 js/client-test.js create mode 100644 js/test-interceptor.d.ts create mode 100644 js/test-interceptor.js diff --git a/bun.lock b/bun.lock index aac5b70d..15b35611 100644 --- a/bun.lock +++ b/bun.lock @@ -9,6 +9,7 @@ "@connectrpc/connect-web": "^2.1.2", }, "devDependencies": { + "@types/bun": "^1.3.14", "typescript": "^7.0.2", }, }, @@ -20,6 +21,10 @@ "@connectrpc/connect-web": ["@connectrpc/connect-web@2.1.2", "", { "peerDependencies": { "@bufbuild/protobuf": "^2.7.0", "@connectrpc/connect": "2.1.2" } }, "sha512-1tfaK85MU+gJjwwmL31d2rzdf0XCYX99chZf63uG89SGBUd4XuZ4ZzhGo2u79TPXOE6nLIZQ2okrpyey42PYdg=="], + "@types/bun": ["@types/bun@1.3.14", "", { "dependencies": { "bun-types": "1.3.14" } }, "sha512-h1hFqFVcvAvD9j9K7ZW7vd82aSA+rTdznZa+5bwvCwqSB1jmmfLcbIWhOLx1/+boy/xmjgCs/OMUL8hRJSmnPw=="], + + "@types/node": ["@types/node@26.2.0", "", { "dependencies": { "undici-types": "~8.3.0" } }, "sha512-5IviulTZeRNp2vAJ514cc/HUlY5nZ9fCbq9DMyC52BrhFZACo3nI0R7qBxhQmo/d27NFe96ur/b7Wwxklda+kg=="], + "@typescript/typescript-aix-ppc64": ["@typescript/typescript-aix-ppc64@7.0.2", "", { "os": "aix", "cpu": "ppc64" }, "sha512-MTKKkWB7p/0E9xi1d1tHtZ5PiLkGEMIq88pK2CubZjOsLtYTLqhgIgi6zepFa+9GHZ6h05NMCkQxGKiPXMxXtQ=="], "@typescript/typescript-darwin-arm64": ["@typescript/typescript-darwin-arm64@7.0.2", "", { "os": "darwin", "cpu": "arm64" }, "sha512-gowzar9MwS/aRWp6f3a4KUqzRjAZjOsmGNCM6LcTgXum+dBfgsBVMN+AgvOCCbguXyick6LJhpBszxMebJ8syA=="], @@ -60,6 +65,10 @@ "@typescript/typescript-win32-x64": ["@typescript/typescript-win32-x64@7.0.2", "", { "os": "win32", "cpu": "x64" }, "sha512-0BQ3HkAHHlKLSp1qRvf3SUhGpGsDuhB/jgFw75guyqbxJqEaS0Cw/VFO8i2nHglJUzQCRtMMR/IBAKE3ETMC4g=="], + "bun-types": ["bun-types@1.3.14", "", { "dependencies": { "@types/node": "*" } }, "sha512-4N0ig0fEomHt5R0KCFWjovxow98rIoRwKolrYdCcknNwMekCXRnWEUvgu5soYV8QXtVsrUD8B95MBOZGPvr6KQ=="], + "typescript": ["typescript@7.0.2", "", { "optionalDependencies": { "@typescript/typescript-aix-ppc64": "7.0.2", "@typescript/typescript-darwin-arm64": "7.0.2", "@typescript/typescript-darwin-x64": "7.0.2", "@typescript/typescript-freebsd-arm64": "7.0.2", "@typescript/typescript-freebsd-x64": "7.0.2", "@typescript/typescript-linux-arm": "7.0.2", "@typescript/typescript-linux-arm64": "7.0.2", "@typescript/typescript-linux-loong64": "7.0.2", "@typescript/typescript-linux-mips64el": "7.0.2", "@typescript/typescript-linux-ppc64": "7.0.2", "@typescript/typescript-linux-riscv64": "7.0.2", "@typescript/typescript-linux-s390x": "7.0.2", "@typescript/typescript-linux-x64": "7.0.2", "@typescript/typescript-netbsd-arm64": "7.0.2", "@typescript/typescript-netbsd-x64": "7.0.2", "@typescript/typescript-openbsd-arm64": "7.0.2", "@typescript/typescript-openbsd-x64": "7.0.2", "@typescript/typescript-sunos-x64": "7.0.2", "@typescript/typescript-win32-arm64": "7.0.2", "@typescript/typescript-win32-x64": "7.0.2" }, "bin": { "tsc": "bin/tsc" } }, "sha512-8FYau96o3NKOhbjKi/qNvG/W5jhzxkbdm5sj9AbZ/5T5sWqn3hJgLfGx27sRKZWTvyzCP8dLRBTf5tBTSRVUNA=="], + + "undici-types": ["undici-types@8.3.0", "", {}, "sha512-j375ScV60dom+YkPFIfTLcOiPxkN/buHz5GobjLhixFuANaNs3C9l4GmrWqejgXWJ7BbJcFYpTEUkS1Ge8bpZQ=="], } } diff --git a/doc/index.html b/doc/index.html index 13621e3d..260ff818 100644 --- a/doc/index.html +++ b/doc/index.html @@ -2881,7 +2881,7 @@

File-level Extensio bool .buf.validate.MapRules 80068951 -

Keys and Values trimmed enforces all map keys and values to be trimmed, e.g. no whitespaces at the begin and end

+

Keys and Values trimmed enforces all map keys and values to be trimmed, e.g. no whitespaces at the begin and end.

@@ -2889,7 +2889,7 @@

File-level Extensio bool .buf.validate.MapRules 80068952 -

Keys trimmed enforces all map keys and values to be trimmed, e.g. no whitespaces at the begin and end

+

Keys trimmed enforces all map keys and values to be trimmed, e.g. no whitespaces at the begin and end.

@@ -2897,7 +2897,7 @@

File-level Extensio bool .buf.validate.MapRules 80068955 -

MachineRolesKeysValid ensures that machine roles keys met our requirements

+

MachineRolesKeysValid ensures that machine roles keys met our requirements.

@@ -2905,7 +2905,7 @@

File-level Extensio bool .buf.validate.MapRules 80068953 -

ProjectRolesKeysValid ensures that project roles keys met our requirements

+

ProjectRolesKeysValid ensures that project roles keys met our requirements.

@@ -2913,7 +2913,7 @@

File-level Extensio bool .buf.validate.MapRules 80068954 -

TenantRolesKeysValid ensures that tenant roles keys met our requirements

+

TenantRolesKeysValid ensures that tenant roles keys met our requirements.

@@ -2921,7 +2921,7 @@

File-level Extensio bool .buf.validate.RepeatedRules 80058954 -

All Trimmed enforces all strings to be trimmed, e.g. no whitespaces at the begin and end

+

All Trimmed enforces all strings to be trimmed, e.g. no whitespaces at the begin and end.

@@ -2929,7 +2929,7 @@

File-level Extensio bool .buf.validate.RepeatedRules 80058953 -

AreHostAndPort validates if a slice of strings are all in the form of <ip | host>:<port>

+

AreHostAndPort validates if a slice of strings are all in the form of <ip | host>:<port>.

@@ -2937,7 +2937,7 @@

File-level Extensio bool .buf.validate.RepeatedRules 80058952 -

Ips validates if a slice of ips in string form are valid

+

Ips validates if a slice of ips in string form are valid.

@@ -2945,7 +2945,7 @@

File-level Extensio bool .buf.validate.RepeatedRules 80058951 -

Prefixes validates if a slice of prefixes in string form are valid

+

Prefixes validates if a slice of prefixes in string form are valid.

@@ -2953,7 +2953,7 @@

File-level Extensio bool .buf.validate.StringRules 80048953 -

IsDescription returns true if description field satisfies our requirements

+

IsDescription returns true if description field satisfies our requirements.

@@ -2961,7 +2961,7 @@

File-level Extensio bool .buf.validate.StringRules 80048957 -

IsIpOrHostname validates that the given string is either a ip or a hostname

+

IsIpOrHostname validates that the given string is either a ip or a hostname.

@@ -2969,7 +2969,7 @@

File-level Extensio bool .buf.validate.StringRules 80048961 -

IsKey returns true if name field satisfies our requirements

+

IsKey returns true if name field satisfies our requirements.

@@ -2977,7 +2977,7 @@

File-level Extensio bool .buf.validate.StringRules 80048965 -

IsMachineSubjectPermission returns true if name field satisfies our requirements

+

IsMachineSubjectPermission returns true if name field satisfies our requirements.

@@ -2985,7 +2985,7 @@

File-level Extensio bool .buf.validate.StringRules 80048952 -

IsName returns true if name field satisfies our requirements

+

IsName returns true if name field satisfies our requirements.

@@ -2993,7 +2993,7 @@

File-level Extensio bool .buf.validate.StringRules 80048960 -

IsOption returns true if name field satisfies our requirements

+

IsOption returns true if name field satisfies our requirements.

@@ -3001,7 +3001,7 @@

File-level Extensio bool .buf.validate.StringRules 80048954 -

IsPartition returns true if partition field satisfies our requirements

+

IsPartition returns true if partition field satisfies our requirements.

@@ -3009,7 +3009,7 @@

File-level Extensio bool .buf.validate.StringRules 80048955 -

IsPrefix validates if the given string is a valid prefix

+

IsPrefix validates if the given string is a valid prefix.

@@ -3017,7 +3017,7 @@

File-level Extensio bool .buf.validate.StringRules 80048964 -

IsProjectSubjectPermission returns true if name field satisfies our requirements

+

IsProjectSubjectPermission returns true if name field satisfies our requirements.

@@ -3025,7 +3025,7 @@

File-level Extensio bool .buf.validate.StringRules 80048962 -

IsTenantLogin returns true if name field satisfies our requirements

+

IsTenantLogin returns true if name field satisfies our requirements.

@@ -3033,7 +3033,7 @@

File-level Extensio bool .buf.validate.StringRules 80048963 -

IsTenantSubjectPermission returns true if name field satisfies our requirements

+

IsTenantSubjectPermission returns true if name field satisfies our requirements.

@@ -3041,7 +3041,7 @@

File-level Extensio bool .buf.validate.StringRules 80048956 -

IsUri validates if the given string is a valid URI

+

IsUri validates if the given string is a valid URI.

@@ -3049,7 +3049,7 @@

File-level Extensio bool .buf.validate.StringRules 80048959 -

IsUser returns true if name field satisfies our requirements

+

IsUser returns true if name field satisfies our requirements.

@@ -3057,7 +3057,7 @@

File-level Extensio bool .buf.validate.StringRules 80048951 -

Macaddress returns true if the given string is a valid macaddress

+

Macaddress returns true if the given string is a valid macaddress.

@@ -3065,7 +3065,7 @@

File-level Extensio bool .buf.validate.StringRules 80048958 -

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.

@@ -3082,7 +3082,7 @@

metalstack/api/v2/common.proto

Labels -

Labels define additional information to a entity

+

Labels define additional information to a entity.

@@ -3137,7 +3137,7 @@

Labels.LabelsEntry

LabelsPatch

-

LabelsPatch adds, updates or remove given labels without modifying others

+

LabelsPatch adds, updates or remove given labels without modifying others.

@@ -3150,14 +3150,14 @@

LabelsPatch

- + - + @@ -3188,14 +3188,14 @@

Meta

- + - @@ -3222,7 +3222,7 @@

Meta

Paging

-

Paging defines paging for methods with a lot of results

+

Paging defines paging for methods with a lot of results.

update Labels

Update labels. New ones will be added, existing ones overwritten

Update labels. New ones will be added, existing ones overwritten.

remove string repeated

Remove labels by key

Remove labels by key.

created_at google.protobuf.Timestamp

CreatedAt is the date when this entity was created

CreatedAt is the date when this entity was created.

updated_at google.protobuf.Timestamp

UpdatedAt is the date when this entity was updated +

UpdatedAt is the date when this entity was updated. must be part of the update request to ensure optimistic locking

@@ -3243,7 +3243,7 @@

Paging

- + @@ -3254,7 +3254,7 @@

Paging

UpdateLabels

-

UpdateLabels is a message to update labels

+

UpdateLabels is a message to update labels.

count uint64 optional

Count is the number of results returned per page, if not given server side defaults apply

Count is the number of results returned per page, if not given server side defaults apply.

@@ -3274,7 +3274,7 @@

UpdateLabels

- + @@ -3285,7 +3285,7 @@

UpdateLabels

UpdateMeta

-

UpdateMeta must be provided with every UpdateRequest to define how optimistic locking should be handled

+

UpdateMeta must be provided with every UpdateRequest to define how optimistic locking should be handled.

patch LabelsPatch

Patch adds, updates or remove given labels without modifying others

Patch adds, updates or remove given labels without modifying others.

@@ -3298,7 +3298,7 @@

UpdateMeta

- @@ -3319,7 +3319,7 @@

UpdateMeta

AdminRole

-

AdminRole specifies what role a logged in user needs to call this admin service

+

AdminRole specifies what role a logged in user needs to call this admin service.

updated_at google.protobuf.Timestamp

UpdatedAt is the date when this entity was updated +

UpdatedAt is the date when this entity was updated. must be part of the update request to ensure optimistic locking

@@ -3329,7 +3329,7 @@

AdminRole

- + @@ -3358,7 +3358,7 @@

Auditing

- + @@ -3377,7 +3377,7 @@

Auditing

NameNumberDescription
ADMIN_ROLE_UNSPECIFIED 0

ADMIN_ROLE_UNSPECIFIED is not specified

ADMIN_ROLE_UNSPECIFIED is not specified.
AUDITING_UNSPECIFIED 0

AUDITING_UNSPECIFIED is not specified

AUDITING_UNSPECIFIED is not specified.

InfraRole

-

InfraRole specifies what role a microservice needs to call this infra service

+

InfraRole specifies what role a microservice needs to call this infra service.

@@ -3387,7 +3387,7 @@

InfraRole

- + @@ -3406,7 +3406,7 @@

InfraRole

NameNumberDescription
INFRA_ROLE_UNSPECIFIED 0

INFRA_ROLE_UNSPECIFIED is not specified

INFRA_ROLE_UNSPECIFIED is not specified.

MachineRole

-

MachineRole specifies what role a microservice needs to call this machine service

+

MachineRole specifies what role a microservice needs to call this machine service.

@@ -3416,7 +3416,7 @@

MachineRole

- + @@ -3465,7 +3465,7 @@

OptimisticLockingStrategy

ProjectRole

-

ProjectRole specifies what role a logged in user needs to call this project scoped service

+

ProjectRole specifies what role a logged in user needs to call this project scoped service.

NameNumberDescription
MACHINE_ROLE_UNSPECIFIED 0

MACHINE_ROLE_UNSPECIFIED is not specified

MACHINE_ROLE_UNSPECIFIED is not specified.
@@ -3475,7 +3475,7 @@

ProjectRole

- + @@ -3500,7 +3500,7 @@

ProjectRole

NameNumberDescription
PROJECT_ROLE_UNSPECIFIED 0

PROJECT_ROLE_UNSPECIFIED is not specified

PROJECT_ROLE_UNSPECIFIED is not specified.

TenantRole

-

TenantRole specifies what role a logged in user needs to call this tenant scoped service

+

TenantRole specifies what role a logged in user needs to call this tenant scoped service.

@@ -3510,7 +3510,7 @@

TenantRole

- + @@ -3535,7 +3535,7 @@

TenantRole

@@ -3553,13 +3553,13 @@

Visibility

- + - + @@ -3593,7 +3593,7 @@

File-level Extensions

- + @@ -3601,7 +3601,7 @@

File-level Extensions

- + @@ -3609,7 +3609,7 @@

File-level Extensions

- + @@ -3617,7 +3617,7 @@

File-level Extensions

- + @@ -3625,7 +3625,7 @@

File-level Extensions

- + @@ -3633,7 +3633,7 @@

File-level Extensions

- + @@ -3641,7 +3641,7 @@

File-level Extensions

- + @@ -3658,7 +3658,7 @@

metalstack/api/v2/audit.proto

AuditQuery -

AuditQuery is the query for audit traces

+

AuditQuery is the query for audit traces.

NameNumberDescription
TENANT_ROLE_UNSPECIFIED 0

TENANT_ROLE_UNSPECIFIED is not specified

TENANT_ROLE_UNSPECIFIED is not specified.
TENANT_ROLE_GUEST 4

TENANT_ROLE_GUEST the logged in user needs at least guest role to call this method -The guest role is assumed by users who are invited to a tenant's project without them +The guest role is assumed by users who are invited to a tenant's project without them. having a direct membership within the tenant.
VISIBILITY_UNSPECIFIED 0

VISIBILITY_UNSPECIFIED is not defined

VISIBILITY_UNSPECIFIED is not defined.
VISIBILITY_PUBLIC 1

VISIBILITY_PUBLIC specifies that this service is accessible without authentication

VISIBILITY_PUBLIC specifies that this service is accessible without authentication.
AdminRole .google.protobuf.MethodOptions 51002

AdminRoles are used to define the 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.
Auditing .google.protobuf.MethodOptions 51004

Auditing defines if calls to this method should be audited or not

Auditing defines if calls to this method should be audited or not.
InfraRole .google.protobuf.MethodOptions 51005

InfraRoles are used to define the 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.
MachineRole .google.protobuf.MethodOptions 51006

MachineRole are used to define which machine role a microservice must provide to call this method

MachineRole are used to define which machine role a microservice must provide to call this method.
ProjectRole .google.protobuf.MethodOptions 51001

ProjectRoles are used to define the 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.
TenantRole .google.protobuf.MethodOptions 51000

TenantRoles are used to define the 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.
Visibility .google.protobuf.MethodOptions 51003

Visibility defines the visibility of this method, this is used to have public or self visible methods

Visibility defines the visibility of this method, this is used to have public or self visible methods.
@@ -3678,56 +3678,56 @@

AuditQuery

 - + - + - + - + - + - + - + - + @@ -3741,7 +3741,7 @@

AuditQuery

 - + @@ -3752,7 +3752,7 @@

AuditQuery

AuditServiceGetRequest

-

AuditServiceGetRequest is the request payload of a audit get request

+

AuditServiceGetRequest is the request payload of a audit get request.

from google.protobuf.Timestamp optional

From describes the start of the time window in which to list audit traces. Defaults to the last eight hours

From describes the start of the time window in which to list audit traces. Defaults to the last eight hours.

to google.protobuf.Timestamp optional

To describes the end of the time window in which to list audit traces. Defaults to the time the request was issued

To describes the end of the time window in which to list audit traces. Defaults to the time the request was issued.

user string optional

User is the user who called the api method

User is the user who called the api method.

project string optional

Project is the project targeted by the api call

Project is the project targeted by the api call.

method string optional

Method is the api method that was called

Method is the api method that was called.

source_ip string optional

Source IP contains the ip address of the caller

Source IP contains the ip address of the caller.

result_code int32 optional

Result Code is a string describing the result of the api call

Result Code is a string describing the result of the api call.

body string optional

Body is a string providing text-search of the body field

Body is a string providing text-search of the body field.

phase AuditPhase optional

Phase specifies the audit phase

Phase specifies the audit phase.

@@ -3779,7 +3779,7 @@

AuditServiceGetRequest

 - + @@ -3790,7 +3790,7 @@

AuditServiceGetRequest

AuditServiceGetResponse

-

AuditServiceGetResponse is the response payload of a audit get request

+

AuditServiceGetResponse is the response payload of a audit get request.

phase AuditPhase optional

Phase specifies the audit phase. Defaults to request

Phase specifies the audit phase. Defaults to request.

@@ -3803,7 +3803,7 @@

AuditServiceGetResponse

 - + @@ -3814,7 +3814,7 @@

AuditServiceGetResponse

AuditServiceListRequest

-

AuditServiceListRequest is the request payload for an audit list request

+

AuditServiceListRequest is the request payload for an audit list request.

trace AuditTrace

Trace is the audit trace

Trace is the audit trace.

@@ -3834,7 +3834,7 @@

AuditServiceListRequest

 - + @@ -3845,7 +3845,7 @@

AuditServiceListRequest

AuditServiceListResponse

-

AuditServiceListResponse is the response payload of a audit list request

+

AuditServiceListResponse is the response payload of a audit list request.

query AuditQuery

Query for audit traces

Query for audit traces.

@@ -3858,7 +3858,7 @@

AuditServiceListResponse

traces - + @@ -3889,63 +3889,63 @@

AuditTrace

 - + - + - + - + - + - + - + - + - + @@ -3975,19 +3975,19 @@

AuditPhase

 - + - + - + @@ -4052,7 +4052,7 @@

AuditServiceGetRequest

 - + @@ -4076,7 +4076,7 @@

AuditServiceGetResponse

trace - + @@ -4100,7 +4100,7 @@

AuditServiceListRequest

query - + @@ -4124,7 +4124,7 @@

AuditServiceListResponsetraces

- + @@ -4175,7 +4175,7 @@

metalstack/api/v2/token.proto

AdminPermissions -

AdminPermissions carries admin method permissions

+

AdminPermissions carries admin method permissions.

AuditTrace repeated

Traces is a list of audit traces

Traces is a list of audit traces.

timestamp google.protobuf.Timestamp

Timestamp is the timestamp when the request arrived at the API

Timestamp is the timestamp when the request arrived at the API.

user string

User is the login user who called the API method

User is the login user who called the API method.

tenant string

Tenant is the tenant targeted by the API call

Tenant is the tenant targeted by the API call.

project string optional

Project is the project targeted by the API call

Project is the project targeted by the API call.

method string

Method is the API method that was called

Method is the API method that was called.

body string optional

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 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.

source_ip string

SourceIP contains the source IP address of the API call

SourceIP contains the source IP address of the API call.

result_code int32 optional

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 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.

phase AuditPhase

Phase represents the phase of the audit trace

Phase represents the phase of the audit trace.

AUDIT_PHASE_UNSPECIFIED 0

AUDIT_PHASE_UNSPECIFIED is not specified

AUDIT_PHASE_UNSPECIFIED is not specified.
AUDIT_PHASE_REQUEST 1

AUDIT_PHASE_REQUEST defines an audit trace in the request phase

AUDIT_PHASE_REQUEST defines an audit trace in the request phase.
AUDIT_PHASE_RESPONSE 2

AUDIT_PHASE_RESPONSE defines an audit trace in the response phase

AUDIT_PHASE_RESPONSE defines an audit trace in the response phase.
phase metalstack.api.v2.AuditPhase optional

Phase specifies the audit phase. Defaults to request

Phase specifies the audit phase. Defaults to request.

metalstack.api.v2.AuditTrace

Trace is the audit trace

Trace is the audit trace.

metalstack.api.v2.AuditQuery

Query for audit traces

Query for audit traces.

metalstack.api.v2.AuditTrace repeated

Traces contains the list of audit traces

Traces contains the list of audit traces.

@@ -4199,7 +4199,7 @@

AdminPermissions

InfraPermissions

-

InfraPermissions carries infra method permissions

+

InfraPermissions carries infra method permissions.

@@ -4223,7 +4223,7 @@

InfraPermissions

MachinePermissions

-

MachinePermissions carries machine method permissions

+

MachinePermissions carries machine method permissions.

@@ -4255,7 +4255,7 @@

MachinePermissions

MethodPermission

-

MethodPermission is a mapping from a subject/project to a service method

+

MethodPermission is a mapping from a subject/project to a service method.

@@ -4291,7 +4291,7 @@

MethodPermission

PermissionsByVisibility

-

PermissionsByVisibility contains method permissions by visibility

+

PermissionsByVisibility contains method permissions by visibility.

@@ -4304,49 +4304,49 @@

PermissionsByVisibility

 - + - + - + - + - + - + - + @@ -4357,7 +4357,7 @@

PermissionsByVisibility

ProjectPermissions

-

ProjectPermissions carries project method permissions

+

ProjectPermissions carries project method permissions.

public PublicPermissions

PublicPermissions carries public method permissions

PublicPermissions carries public method permissions.

self SelfPermissions

SelfPermissions carries self method permissions

SelfPermissions carries self method permissions.

project ProjectPermissions

ProjectPermissions carries project method permissions

ProjectPermissions carries project method permissions.

tenant TenantPermissions

TenantPermissions carries tenant method permissions

TenantPermissions carries tenant method permissions.

admin AdminPermissions

AdminPermissions carries admin method permissions

AdminPermissions carries admin method permissions.

machine MachinePermissions

MachinePermissions carries machine method permissions

MachinePermissions carries machine method permissions.

infra InfraPermissions

InfraPermissions carries infra method permissions

InfraPermissions carries infra method permissions.

@@ -4388,7 +4388,7 @@

ProjectPermissions

PublicPermissions

-

PublicPermissions carries public method permissions

+

PublicPermissions carries public method permissions.

@@ -4412,7 +4412,7 @@

PublicPermissions

SelfPermissions

-

SelfPermissions carries self method permissions

+

SelfPermissions carries self method permissions.

@@ -4436,7 +4436,7 @@

SelfPermissions

TenantPermissions

-

TenantPermissions carries tenant method permissions

+

TenantPermissions carries tenant method permissions.

@@ -4468,7 +4468,7 @@

TenantPermissions

Token

-

Token generates a jwt authentication token to access the api

There are two different types of tokens, api- and user- tokens

A user token is used to authenticate end user requests for example from a cli.

The configured roles in a user token are expanded in the api server

based on the memberships in other projects and tenants based on the role granted there.

User tokens will never contain permissions.

Permissions are always derived from the tenant and project roles and memberships.

The api token should be used to authenticate services.

In contrast to a user token, the api token permissions and roles apply as configured during the token create process.

Message level validation, can be developed using https://protovalidate.com/playground

+

Token generates a jwt authentication token to access the api.

There are two different types of tokens, api- and user- tokens.

A user token is used to authenticate end user requests for example from a cli.

The configured roles in a user token are expanded in the api server.

based on the memberships in other projects and tenants based on the role granted there.

User tokens will never contain permissions.

Permissions are always derived from the tenant and project roles and memberships.

The api token should be used to authenticate services.

In contrast to a user token, the api token permissions and roles apply as configured during the token create process.

Message level validation, can be developed using https://protovalidate.com/playground

@@ -4509,64 +4509,64 @@

Token

 - + - + - + - + - + - + - + - + - + @@ -4670,7 +4670,7 @@

Token.TenantRolesEntry

TokenQuery

-

TokenQuery is used to search tokens

+

TokenQuery is used to search tokens.

permissions MethodPermission repeated

Permissions is a list of service methods this token can be used for

Permissions is a list of service methods this token can be used for.

expires google.protobuf.Timestamp

Expires gives the date in the future after which this token can not be used anymore

Expires gives the date in the future after which this token can not be used anymore.

issued_at google.protobuf.Timestamp

IssuedAt gives the date when this token was created

IssuedAt gives the date when this token was created.

token_type TokenType

TokenType describes the type of this token

TokenType describes the type of this token.

project_roles Token.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 Token.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.

admin_role AdminRole optional

AdminRole defines the admin role of the token owner

AdminRole defines the admin role of the token owner.

infra_role InfraRole optional

InfraRole defines the infrastructure role of the token owner

InfraRole defines the infrastructure role of the token owner.

machine_roles Token.MachineRolesEntry repeated

MachineRoles associates a machine uuid with the corresponding role of the token owner -TODO: decide if we need this map from machine.uuid->role, we could instead use the subject in the token instead

MachineRoles associates a machine uuid with the corresponding role of the token owner. +TODO: decide if we need this map from machine.uuid->role, we could instead use the subject in the token instead.

@@ -4705,7 +4705,7 @@

TokenQuery

 - + @@ -4723,7 +4723,7 @@

TokenQuery

TokenServiceCreateRequest

-

TokenServiceCreateRequest is the request payload to create a token

+

TokenServiceCreateRequest is the request payload to create a token.

labels Labels optional

Labels lists only tokens containing the given labels

Labels lists only tokens containing the given labels.

@@ -4743,49 +4743,49 @@

TokenServiceCreateRequestpermissions

- + - + - + - + - + - + - + @@ -4896,7 +4896,7 @@

TokenServi

TokenServiceCreateResponse

-

TokenServiceCreateResponse is the response payload of a token create request

+

TokenServiceCreateResponse is the response payload of a token create request.

PermissionsByVisibility repeated

Permissions is a list of service methods this token can be used for

Permissions is a list of service methods this token can be used for.

expires google.protobuf.Duration

Expires gives the duration since now, after which this token can not be used anymore

Expires gives the duration since now, after which this token can not be used anymore.

project_roles TokenServiceCreateRequest.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 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.

admin_role AdminRole optional

AdminRole defines the admin role of the token owner

AdminRole defines the admin role of the token owner.

infra_role InfraRole optional

InfraRole defines the infrastructure role of the token owner

InfraRole defines the infrastructure role of the token owner.

machine_roles TokenServiceCreateRequest.MachineRolesEntry repeated

MachineRoles associates a machine uuid with the corresponding role of the token owner

MachineRoles associates a machine uuid with the corresponding role of the token owner.

@@ -4916,7 +4916,7 @@

TokenServiceCreateResponse

- + @@ -4927,7 +4927,7 @@

TokenServiceCreateResponse

TokenServiceGetRequest

-

TokenServiceGetRequest is the request payload of a token get request

+

TokenServiceGetRequest is the request payload of a token get request.

secret string

Secret is the body of 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.

@@ -4951,7 +4951,7 @@

TokenServiceGetRequest

TokenServiceGetResponse

-

TokenServiceGetResponse is the response payload of a token get request

+

TokenServiceGetResponse is the response payload of a token get request.

@@ -4964,7 +4964,7 @@

TokenServiceGetResponse

 - + @@ -4975,7 +4975,7 @@

TokenServiceGetResponse

TokenServiceListRequest

-

TokenServiceListRequest is the request payload to list tokens

+

TokenServiceListRequest is the request payload to list tokens.

token Token

Token is the token

Token is the token.

@@ -4988,7 +4988,7 @@

TokenServiceListRequest

 - + @@ -4999,7 +4999,7 @@

TokenServiceListRequest

TokenServiceListResponse

-

TokenServiceListResponse is the response payload of a token list request

+

TokenServiceListResponse is the response payload of a token list request.

query TokenQuery

Query for tokens

Query for tokens.

@@ -5012,7 +5012,7 @@

TokenServiceListResponse

tokens - + @@ -5023,14 +5023,14 @@

TokenServiceListResponse

TokenServiceRefreshRequest -

TokenServiceRefreshRequest is the request payload of a token refresh request

Permissions, Roles and Expiration duration and all other properties are inherited from the calling token.

The expiration duration will be calculated from the existing token (exp - iat)

+

TokenServiceRefreshRequest is the request payload of a token refresh request.

Permissions, Roles and Expiration duration and all other properties are inherited from the calling token.

The expiration duration will be calculated from the existing token (exp - iat)

TokenServiceRefreshResponse

-

TokenServiceRefreshResponse is the response payload of a token refresh request

+

TokenServiceRefreshResponse is the response payload of a token refresh request.

Token repeated

Tokens is a list of tokens without the secrets

Tokens is a list of tokens without the secrets.

@@ -5050,7 +5050,7 @@

TokenServiceRefreshRespon

- + @@ -5061,7 +5061,7 @@

TokenServiceRefreshRespon

TokenServiceRevokeRequest

-

TokenServiceRevokeRequest is the request payload of a token revoke request

+

TokenServiceRevokeRequest is the request payload of a token revoke request.

secret string

Secret is the body of 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.

@@ -5085,14 +5085,14 @@

TokenServiceRevokeRequestTokenServiceRevokeResponse

-

TokenServiceRevokeResponse is the response payload of a token revoke request

+

TokenServiceRevokeResponse is the response payload of a token revoke request.

TokenServiceUpdateRequest

-

TokenServiceUpdateRequest is the request payload of a token update request

+

TokenServiceUpdateRequest is the request payload of a token update request.

@@ -5112,8 +5112,8 @@

TokenServiceUpdateRequestupdate_meta

- + @@ -5127,42 +5127,42 @@

TokenServiceUpdateRequestpermissions

- + - + - + - + - + - + @@ -5273,7 +5273,7 @@

TokenServi

TokenServiceUpdateResponse

-

TokenServiceUpdateResponse is the response payload of a token update request

+

TokenServiceUpdateResponse is the response payload of a token update request.

UpdateMeta

UpdateMeta contains the timestamp and strategy to be used in this update request -TokenUpdate is not guarded with optlock in the backend

UpdateMeta contains the timestamp and strategy to be used in this update request. +TokenUpdate is not guarded with optlock in the backend.

PermissionsByVisibility repeated

Permissions is a list of service methods this token can be used for

Permissions is a list of service methods this token can be used for.

project_roles TokenServiceUpdateRequest.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 TokenServiceUpdateRequest.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.

admin_role AdminRole optional

AdminRole defines the admin role of the token owner

AdminRole defines the admin role of the token owner.

infra_role InfraRole optional

InfraRole defines the infrastructure role of the token owner

InfraRole defines the infrastructure role of the token owner.

machine_roles TokenServiceUpdateRequest.MachineRolesEntry repeated

MachineRoles associates a machine uuid with the corresponding role of the token owner

MachineRoles associates a machine uuid with the corresponding role of the token owner.

@@ -5286,7 +5286,7 @@

TokenServiceUpdateResponse

- + @@ -5299,7 +5299,7 @@

TokenServiceUpdateResponse

TokenType

-

TokenType specifies different use cases of tokens

+

TokenType specifies different use cases of tokens.

token Token

Token is the updated token

Token is the updated token.

@@ -5309,13 +5309,13 @@

TokenType

 - + - + @@ -5459,7 +5459,7 @@

VersionServiceGetResponseversion

- + @@ -5503,7 +5503,7 @@

metalstack/api/v2/component.proto

Component -

Component represents a microservice connected to our apiserver

+

Component represents a microservice connected to our apiserver.

NameNumberDescription
TOKEN_TYPE_UNSPECIFIED 0

TOKEN_TYPE_UNSPECIFIED is not specified

TOKEN_TYPE_UNSPECIFIED is not specified.
TOKEN_TYPE_API 1

TOKEN_TYPE_API is a token for api usage

TOKEN_TYPE_API is a token for api usage.
Version

Version contains the version of the application

Version contains the version of the application.

@@ -5516,14 +5516,14 @@

Component

 - + - + @@ -5538,7 +5538,7 @@

Component

 - + @@ -5597,14 +5597,14 @@

ComponentQuery

 - + - + @@ -5625,7 +5625,7 @@

ComponentQuery

ComponentType

-

ComponentType defines which service is actually pinging

+

ComponentType defines which service is actually pinging.

uuid string

UUID identifies this component event

UUID identifies this component event.

type ComponentType

Type defines which service is actually pinging

Type defines which service is actually pinging.

started_at google.protobuf.Timestamp

StartedAt is the timestamp this service was started

StartedAt is the timestamp this service was started.

uuid string optional

UUID identifies this component

UUID identifies this component.

type ComponentType optional

Type defines which service is actually pinging

Type defines which service is actually pinging.

@@ -5635,43 +5635,43 @@

ComponentType

 - + - + - + - + - + - + - + @@ -5703,7 +5703,7 @@

ComponentServiceDelet

- + @@ -5727,7 +5727,7 @@

ComponentServiceDele

- + @@ -5751,7 +5751,7 @@

ComponentServiceGetReque

- + @@ -5775,7 +5775,7 @@

ComponentServiceGetResp

- + @@ -5799,7 +5799,7 @@

ComponentServiceListReq

- + @@ -5823,7 +5823,7 @@

ComponentServiceListRe

- + @@ -5901,7 +5901,7 @@

Disk

 - + @@ -5925,7 +5925,7 @@

DiskPartition

 - + @@ -6071,14 +6071,14 @@

FilesystemLayout

 - + - + @@ -6092,14 +6092,14 @@

FilesystemLayout

 - + - + @@ -6130,7 +6130,7 @@

FilesystemLayoutConstrain

- @@ -6138,7 +6138,7 @@

FilesystemLayoutConstrain

-
NameNumberDescription
COMPONENT_TYPE_UNSPECIFIED 0

COMPONENT_TYPE_UNSPECIFIED is unspecified

COMPONENT_TYPE_UNSPECIFIED is unspecified.
COMPONENT_TYPE_PIXIECORE 1

COMPONENT_TYPE_PIXIECORE is pixiecore

COMPONENT_TYPE_PIXIECORE is pixiecore.
COMPONENT_TYPE_METAL_CORE 2

COMPONENT_TYPE_METAL_CORE is metal-core

COMPONENT_TYPE_METAL_CORE is metal-core.
COMPONENT_TYPE_METAL_BMC 3

COMPONENT_TYPE_METAL_BMC is metal-bmc

COMPONENT_TYPE_METAL_BMC is metal-bmc.
COMPONENT_TYPE_METAL_IMAGE_CACHE_SYNC 4

COMPONENT_TYPE_METAL_IMAGE_CACHE_SYNC is metal-image-cache-sync

COMPONENT_TYPE_METAL_IMAGE_CACHE_SYNC is metal-image-cache-sync.
COMPONENT_TYPE_METAL_CONSOLE 5

COMPONENT_TYPE_METAL_CONSOLE is metal-console

COMPONENT_TYPE_METAL_CONSOLE is metal-console.
COMPONENT_TYPE_METAL_METRICS_EXPORTER 6

COMPONENT_TYPE_METAL_METRICS_EXPORTER is metal-metrics-exporter

COMPONENT_TYPE_METAL_METRICS_EXPORTER is metal-metrics-exporter.
uuid string

UUID identifies the component to delete

UUID identifies the component to delete.

component metalstack.api.v2.Component

Component contains the deleted component

Component contains the deleted component.

uuid string

UUID identifies the component to get

UUID identifies the component to get.

component metalstack.api.v2.Component

Component contains the retrieved component

Component contains the retrieved component.

query metalstack.api.v2.ComponentQuery

Query filters components

Query filters components.

components metalstack.api.v2.Component repeated

Components contains the list of components

Components contains the list of components.

partitions DiskPartition repeated

Partitions list of partitions to create on this disk

Partitions list of partitions to create on this disk.

number uint32

Number partition number, will be appended to partitionprefix to create the final devicename

Number partition number, will be appended to partitionprefix to create the final devicename.

filesystems Filesystem repeated

Filesystems is a list of filesystems to create on a machine

Filesystems is a list of filesystems to create on a machine.

disks Disk repeated

Disks list of disks that belong to this layout

Disks list of disks that belong to this layout.

volume_groups VolumeGroup repeated

VolumeGroups list of volumegroups to create

VolumeGroups list of volumegroups to create.

logical_volumes LogicalVolume repeated

LogicalVolumes list of logicalvolumes to create

LogicalVolumes list of logicalvolumes to create.

sizes string repeated

Sizes list of sizes this layout applies to +

Sizes list of sizes this layout applies to. this could either be a concrete size, or a asterisk to match all sizes

images FilesystemLayoutConstraints.ImagesEntry repeated

Images list of images this layout applies to in the following form +

Images list of images this layout applies to in the following form. key must be the first part of available images, e.g. the name of the image value must be a semver match expression with the constraint and the version separated by space this would match all debian images which are greater or equal 12.0 @@ -6184,7 +6184,7 @@

FilesystemLay

FilesystemServiceGetRequest

-

FilesystemServiceGetRequest is the request payload for a filesystem get request

+

FilesystemServiceGetRequest is the request payload for a filesystem get request.

@@ -6208,7 +6208,7 @@

FilesystemServiceGetReque

FilesystemServiceGetResponse

-

FilesystemServiceGetResponse is the response payload for a filesystem get request

+

FilesystemServiceGetResponse is the response payload for a filesystem get request.

@@ -6232,7 +6232,7 @@

FilesystemServiceGetResp

FilesystemServiceListRequest

-

FilesystemServiceListRequest is the request payload for a filesystem list request

+

FilesystemServiceListRequest is the request payload for a filesystem list request.

@@ -6256,7 +6256,7 @@

FilesystemServiceListReq

FilesystemServiceListResponse

-

FilesystemServiceListResponse is the response payload for a filesystem list request

+

FilesystemServiceListResponse is the response payload for a filesystem list request.

@@ -6345,14 +6345,14 @@

Raid

- + - + @@ -6397,14 +6397,14 @@

VolumeGroup

- + - + @@ -6417,7 +6417,7 @@

VolumeGroup

Format

-

Format specifies the filesystem to use on a volume

+

Format specifies the filesystem to use on a volume.

devices string repeated

Devices list of devices to form the raid array from

Devices list of devices to form the raid array from.

level RaidLevel

Level raid level to create, should be 0 or 1

Level raid level to create, should be 0 or 1.

devices string repeated

Devices list of devices to form the volume group from

Devices list of devices to form the volume group from.

tags string repeated

Tags list of tags to add to the volume group

Tags list of tags to add to the volume group.

@@ -6433,31 +6433,31 @@

Format

- + - + - + - + - + @@ -6470,7 +6470,7 @@

Format

NameNumberDescription
FORMAT_VFAT 1

FORMAT_VFAT is used for the UEFI boot partition

FORMAT_VFAT is used for the UEFI boot partition.
FORMAT_EXT3 2

FORMAT_EXT3 is usually only used for /boot

FORMAT_EXT3 is usually only used for /boot.
FORMAT_EXT4 3

FORMAT_EXT4 is the default fs

FORMAT_EXT4 is the default fs.
FORMAT_SWAP 4

FORMAT_SWAP is for the swap partition

FORMAT_SWAP is for the swap partition.
FORMAT_TMPFS 5

FORMAT_TMPFS is used for a memory filesystem typically /tmp

FORMAT_TMPFS is used for a memory filesystem typically /tmp.

GPTType

-

GPTType specifies the partition type in uefi systems

+

GPTType specifies the partition type in uefi systems.

@@ -6480,7 +6480,7 @@

GPTType

- + @@ -6521,7 +6521,7 @@

LVMType

- + @@ -6546,7 +6546,7 @@

LVMType

NameNumberDescription
GPT_TYPE_UNSPECIFIED 0

GPT_TYPE_UNSPECIFIED is no specified

GPT_TYPE_UNSPECIFIED is no specified.
LVM_TYPE_UNSPECIFIED 0

LVM_TYPE_UNSPECIFIED is not specified

LVM_TYPE_UNSPECIFIED is not specified.

RaidLevel

-

RaidLevel defines howto mirror two or more block devices

+

RaidLevel defines howto mirror two or more block devices.

@@ -6556,19 +6556,19 @@

RaidLevel

- + - + - + @@ -6626,7 +6626,7 @@

FilesystemServiceCre

- + @@ -6650,7 +6650,7 @@

FilesystemServiceCr

- + @@ -6698,7 +6698,7 @@

FilesystemServiceDe

- + @@ -6784,7 +6784,7 @@

FilesystemServiceUpd

- + @@ -6805,14 +6805,14 @@

FilesystemServiceUpd

- + - + @@ -6826,14 +6826,14 @@

FilesystemServiceUpd

- + - + @@ -6864,7 +6864,7 @@

FilesystemServiceUp

- + @@ -7053,7 +7053,7 @@

Image

- + @@ -7064,7 +7064,7 @@

Image

ImageQuery

-

ImageQuery is used to search images

+

ImageQuery is used to search images.

NameNumberDescription
RAID_LEVEL_UNSPECIFIED 0

RAID_LEVEL_UNSPECIFIED is not specified

RAID_LEVEL_UNSPECIFIED is not specified.
RAID_LEVEL_0 1

RAID_LEVEL_0 is a stripe of two or more disks

RAID_LEVEL_0 is a stripe of two or more disks.
RAID_LEVEL_1 2

RAID_LEVEL_1 is a mirror of two disks

RAID_LEVEL_1 is a mirror of two disks.
filesystem_layout metalstack.api.v2.FilesystemLayout

FilesystemLayout is the filesystem layout to create

FilesystemLayout is the filesystem layout to create.

filesystem_layout metalstack.api.v2.FilesystemLayout

FilesystemLayout contains the created filesystem layout

FilesystemLayout contains the created filesystem layout.

filesystem_layout metalstack.api.v2.FilesystemLayout

FilesystemLayout contains the deleted filesystem layout

FilesystemLayout contains the deleted filesystem layout.

update_meta metalstack.api.v2.UpdateMeta

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.

filesystems metalstack.api.v2.Filesystem repeated

Filesystems is a list of filesystems to create on a machine

Filesystems is a list of filesystems to create on a machine.

disks metalstack.api.v2.Disk repeated

Disks list of disks that belong to this layout

Disks list of disks that belong to this layout.

volume_groups metalstack.api.v2.VolumeGroup repeated

VolumeGroups list of volumegroups to create

VolumeGroups list of volumegroups to create.

logical_volumes metalstack.api.v2.LogicalVolume repeated

LogicalVolumes list of logicalvolumes to create

LogicalVolumes list of logicalvolumes to create.

filesystem_layout metalstack.api.v2.FilesystemLayout

FilesystemLayout contains the updated filesystem layout

FilesystemLayout contains the updated filesystem layout.

expires_at google.protobuf.Timestamp

ExpiresAt usage is not possible after this date

ExpiresAt usage is not possible after this date.

@@ -7133,7 +7133,7 @@

ImageQuery

- + @@ -7144,7 +7144,7 @@

ImageQuery

ImageServiceGetRequest

-

ImageServiceGetRequest is the request payload for an image get request

+

ImageServiceGetRequest is the request payload for an image get request.

labels Labels optional

Labels lists only images containing the given labels

Labels lists only images containing the given labels.

@@ -7168,7 +7168,7 @@

ImageServiceGetRequest

ImageServiceGetResponse

-

ImageServiceGetResponse is the response payload for an image get request

+

ImageServiceGetResponse is the response payload for an image get request.

@@ -7192,7 +7192,7 @@

ImageServiceGetResponse

ImageServiceLatestRequest

-

ImageServiceLatestRequest is the request payload for an image latest request

+

ImageServiceLatestRequest is the request payload for an image latest request.

@@ -7224,7 +7224,7 @@

ImageServiceLatestRequestImageServiceLatestResponse

-

ImageServiceLatestResponse is the response payload for an image latest request

+

ImageServiceLatestResponse is the response payload for an image latest request.

@@ -7248,7 +7248,7 @@

ImageServiceLatestResponse

ImageServiceListRequest

-

ImageServiceListRequest is the request payload for an image list request

+

ImageServiceListRequest is the request payload for an image list request.

@@ -7261,7 +7261,7 @@

ImageServiceListRequest

- + @@ -7272,7 +7272,7 @@

ImageServiceListRequest

ImageServiceListResponse

-

ImageServiceListResponse is the response payload for an image list request

+

ImageServiceListResponse is the response payload for an image list request.

query ImageQuery

Query for images

Query for images.

@@ -7296,7 +7296,7 @@

ImageServiceListResponse

ImageUsage -

ImageUsage reports which machines/firewalls actually use this image

+

ImageUsage reports which machines/firewalls actually use this image.

@@ -7339,25 +7339,25 @@

ImageClassification

- + - + - + - + @@ -7374,19 +7374,19 @@

ImageFeature

- + - + - + @@ -7451,7 +7451,7 @@

ImageServiceCreateRequest

- + @@ -7475,7 +7475,7 @@

ImageServiceCreateRespon

- + @@ -7523,7 +7523,7 @@

ImageServiceDeleteRespon

- + @@ -7554,7 +7554,7 @@

ImageServiceUpdateRequest

- + @@ -7596,7 +7596,7 @@

ImageServiceUpdateRequest

- + @@ -7627,7 +7627,7 @@

ImageServiceUpdateRespon

- + @@ -7651,7 +7651,7 @@

ImageServiceUsageRequestquery

- + @@ -7675,7 +7675,7 @@

ImageServiceUsageResponse

- + @@ -7740,7 +7740,7 @@

metalstack/api/v2/ip.proto

IP -

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

+

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

IMAGE_CLASSIFICATION_UNSPECIFIED 0

IMAGE_CLASSIFICATION_UNSPECIFIED is not specified

IMAGE_CLASSIFICATION_UNSPECIFIED is not specified.
IMAGE_CLASSIFICATION_PREVIEW 1

IMAGE_CLASSIFICATION_PREVIEW indicates that this image is in preview

IMAGE_CLASSIFICATION_PREVIEW indicates that this image is in preview.
IMAGE_CLASSIFICATION_SUPPORTED 2

IMAGE_CLASSIFICATION_SUPPORTED indicates that this image is supported

IMAGE_CLASSIFICATION_SUPPORTED indicates that this image is supported.
IMAGE_CLASSIFICATION_DEPRECATED 3

IMAGE_CLASSIFICATION_DEPRECATED indicates that this image is deprecated

IMAGE_CLASSIFICATION_DEPRECATED indicates that this image is deprecated.
IMAGE_FEATURE_UNSPECIFIED 0

IMAGE_FEATURE_UNSPECIFIED is not specified

IMAGE_FEATURE_UNSPECIFIED is not specified.
IMAGE_FEATURE_MACHINE 1

IMAGE_FEATURE_MACHINE indicates this image is usable for a machine

IMAGE_FEATURE_MACHINE indicates this image is usable for a machine.
IMAGE_FEATURE_FIREWALL 2

IMAGE_FEATURE_FIREWALL indicates this image is usable for a firewall

IMAGE_FEATURE_FIREWALL indicates this image is usable for a firewall.
image metalstack.api.v2.Image

Image is the image to create

Image is the image to create.

image metalstack.api.v2.Image

Image contains the created image

Image contains the created image.

image metalstack.api.v2.Image

Image contains the deleted image

Image contains the deleted image.

update_meta metalstack.api.v2.UpdateMeta

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.

expires_at google.protobuf.Timestamp

ExpiresAt indicates that usage is not possible after this date

ExpiresAt indicates that usage is not possible after this date.

image metalstack.api.v2.Image

Image contains the updated image

Image contains the updated image.

metalstack.api.v2.ImageQuery

Query for which images the usage should be reported

Query for which images the usage should be reported.

image_usage metalstack.api.v2.ImageUsage repeated

Images contains usage information

Images contains usage information.

@@ -7767,7 +7767,7 @@

IP

 - + @@ -7788,14 +7788,14 @@

IP

 - + - + @@ -7809,7 +7809,7 @@

IP

 - @@ -7821,7 +7821,7 @@

IP

IPQuery

-

IPQuery can be used to query a IP or a list of IP

+

IPQuery can be used to query a IP or a list of IP.

ip string

Ip is either ipv4 or ipv6 address

Ip is either ipv4 or ipv6 address.

network string

Network is the network this ip belongs to

Network is the network this ip belongs to.

project string

Project where this ip address belongs to

Project where this ip address belongs to.

namespace string optional

Namespace if specified this ip is from a namespaced network and can therefore overlap with others +

Namespace if specified this ip is from a namespaced network and can therefore overlap with others. Will be equal with project most of the time

@@ -7841,7 +7841,7 @@

IPQuery

 - + @@ -7890,14 +7890,14 @@

IPQuery

 - + - + @@ -7915,7 +7915,7 @@

IPQuery

IPServiceCreateRequest

-

IPServiceCreateRequest is the request payload for an IP create request

+

IPServiceCreateRequest is the request payload for an IP create request.

network string optional

Network from which the IPs are to list

Network from which the IPs are to list.

type IPType optional

Static if set to true, this will be a Static ip

Static if set to true, this will be a Static ip.

address_family IPAddressFamily optional

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

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

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

IPServiceCreateRequest

 - + @@ -7995,7 +7995,7 @@

IPServiceCreateRequest

IPServiceCreateResponse

-

IPServiceCreateResponse is the response payload for an IP create request

+

IPServiceCreateResponse is the response payload for an IP create request.

network string

Network from which the IP should be created

Network from which the IP should be created.

@@ -8019,7 +8019,7 @@

IPServiceCreateResponse

IPServiceDeleteRequest

-

IPServiceDeleteRequest is the request payload for a ip delete request

+

IPServiceDeleteRequest is the request payload for a ip delete request.

@@ -8050,7 +8050,7 @@

IPServiceDeleteRequest

IPServiceDeleteResponse

-

IPServiceDeleteResponse is the response payload for an IP delete request

+

IPServiceDeleteResponse is the response payload for an IP delete request.

@@ -8074,7 +8074,7 @@

IPServiceDeleteResponse

IPServiceGetRequest

-

IPServiceGetRequest is the request payload for an IP get request

+

IPServiceGetRequest is the request payload for an IP get request.

@@ -8112,7 +8112,7 @@

IPServiceGetRequest

IPServiceGetResponse

-

IPServiceGetResponse is the response payload for an IP get request

+

IPServiceGetResponse is the response payload for an IP get request.

@@ -8136,7 +8136,7 @@

IPServiceGetResponse

IPServiceListRequest

-

IPServiceListRequest is the request payload for an IP list request

+

IPServiceListRequest is the request payload for an IP list request.

@@ -8156,7 +8156,7 @@

IPServiceListRequest

 - + @@ -8167,7 +8167,7 @@

IPServiceListRequest

IPServiceListResponse

-

IPServiceListResponse is the response payload for an IP list request

+

IPServiceListResponse is the response payload for an IP list request.

query IPQuery

Query to list one or more IPs

Query to list one or more IPs.

@@ -8191,7 +8191,7 @@

IPServiceListResponse

IPServiceUpdateRequest

-

IPServiceUpdateRequest is the request payload for an IP update request

+

IPServiceUpdateRequest is the request payload for an IP update request.

@@ -8211,7 +8211,7 @@

IPServiceUpdateRequest

 - + @@ -8257,7 +8257,7 @@

IPServiceUpdateRequest

IPServiceUpdateResponse

-

IPServiceUpdateResponse is the response payload for a ip update request

+

IPServiceUpdateResponse is the response payload for a ip update request.

update_meta UpdateMeta

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.

@@ -8283,7 +8283,7 @@

IPServiceUpdateResponse

IPAddressFamily

-

IPAddressFamily defines either IPv4 or IPv6 Addressfamily

+

IPAddressFamily defines either IPv4 or IPv6 Addressfamily.

@@ -8293,26 +8293,26 @@

IPAddressFamily

 - + - + - +
NameNumberDescription
IP_ADDRESS_FAMILY_UNSPECIFIED 0

IP_ADDRESS_FAMILY_UNSPECIFIED is not specified

IP_ADDRESS_FAMILY_UNSPECIFIED is not specified.
IP_ADDRESS_FAMILY_V4 1

IP_ADDRESS_FAMILY_V4 defines a IPv4 address

IP_ADDRESS_FAMILY_V4 defines a IPv4 address.
IP_ADDRESS_FAMILY_V6 2

IP_ADDRESS_FAMILY_V6 defines a IPv6 address

IP_ADDRESS_FAMILY_V6 defines a IPv6 address.

IPType

-

IPType specifies different IP address types

+

IPType specifies different IP address types.

@@ -8322,19 +8322,19 @@

IPType

- + - + - + @@ -8413,7 +8413,7 @@

IPServiceListRequest

- + @@ -8437,7 +8437,7 @@

IPServiceListResponse

- + @@ -8553,21 +8553,21 @@

Network

- + - + - @@ -8589,14 +8589,14 @@

Network

- + - + @@ -8624,14 +8624,14 @@

Network

- + - + @@ -8649,7 +8649,7 @@

Network

NetworkConsumption

-

NetworkConsumption contains ip and prefix usage by addressfamily

+

NetworkConsumption contains ip and prefix usage by addressfamily.

NameNumberDescription
IP_TYPE_UNSPECIFIED 0

IP_TYPE_UNSPECIFIED is not specified

IP_TYPE_UNSPECIFIED is not specified.
IP_TYPE_EPHEMERAL 1

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

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

IP_TYPE_STATIC defines a static ip address which must be freed/deleted explicitly

IP_TYPE_STATIC defines a static ip address which must be freed/deleted explicitly.
query metalstack.api.v2.IPQuery

Query to search for IP addresses

Query to search for IP addresses.

ips metalstack.api.v2.IP repeated

IPs contains the list of IP addresses

IPs contains the list of IP addresses.

partition string optional

Partition where this network will be created

Partition where this network will be created.

project string optional

Project where this network belongs to

Project where this network belongs to.

namespace string optional

Namespace if specified, this network is namespaced and can therefore overlap with others +

Namespace if specified, this network is namespaced and can therefore overlap with others. Will be equal with project most of the time

default_child_prefix_length ChildPrefixLength

Default Child Prefix length defines the bit length of a child network created per address family, if 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.

min_child_prefix_length ChildPrefixLength

Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length

Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length.

parent_network string optional

Parent Network points to the id of the parent network if any

Parent Network points to the id of the parent network if any.

additional_announcable_cidrs string repeated

AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced

AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced.

@@ -8669,7 +8669,7 @@

NetworkConsumption

- + @@ -8680,7 +8680,7 @@

NetworkConsumption

NetworkQuery

-

NetworkQuery defines which networks to query

+

NetworkQuery defines which networks to query.

ipv6 NetworkUsage

IPv6 network usage, this can be approximated for high numbers

IPv6 network usage, this can be approximated for high numbers.

@@ -8714,21 +8714,21 @@

NetworkQuery

- + - + - + @@ -8756,7 +8756,7 @@

NetworkQuery

- + @@ -8808,7 +8808,7 @@

NetworkServiceCreateReque

- + @@ -8829,7 +8829,7 @@

NetworkServiceCreateReque

- + @@ -8843,7 +8843,7 @@

NetworkServiceCreateReque

- + @@ -8881,7 +8881,7 @@

NetworkServiceCreateResp

- + @@ -8936,7 +8936,7 @@

NetworkServiceDeleteResp

- + @@ -9022,7 +9022,7 @@

NetworkServiceL

- + @@ -9046,7 +9046,7 @@

NetworkService

- + @@ -9077,7 +9077,7 @@

NetworkServiceListRequestquery

- + @@ -9101,7 +9101,7 @@

NetworkServiceListResponse

- + @@ -9132,7 +9132,7 @@

NetworkServiceUpdateReque

- + @@ -9184,7 +9184,7 @@

NetworkServiceUpdateResp

- + @@ -9242,7 +9242,7 @@

NetworkUsage

NATType

-

NATType defines how and if outgoing traffic is translated

+

NATType defines how and if outgoing traffic is translated.

partition string optional

Partition where this network will be created

Partition where this network will be created.

project string optional

Project where this network belongs to

Project where this network belongs to.

namespace string optional

Namespace where this network belongs to

Namespace where this network belongs to.

parent_network string optional

Parent Network points to the id of the parent network if any

Parent Network points to the id of the parent network if any.

project string

Project where this network belongs to

Project where this network belongs to.

partition string optional

Partition where this network will be created

Partition where this network will be created.

parent_network string optional

Parent Network points to the id of the parent network if any

Parent Network points to the id of the parent network if any.

network Network

Network is the created network

Network is the created network.

network Network

Network is the deleted network

Network is the deleted network.

query NetworkQuery

Query which specifies which networks to return

Query which specifies which networks to return.

networks Network repeated

Networks are the requested networks

Networks are the requested networks.

NetworkQuery

Query which specifies which networks to return

Query which specifies which networks to return.

networks Network repeated

Networks are the requested networks

Networks are the requested networks.

update_meta UpdateMeta

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.

network Network

Network is the updated network

Network is the updated network.

@@ -9252,13 +9252,13 @@

NATType

- + - + @@ -9271,7 +9271,7 @@

NATType

NameNumberDescription
NAT_TYPE_UNSPECIFIED 0

NAT_TYPE_UNSPECIFIED indicates a unspecified nat type

NAT_TYPE_UNSPECIFIED indicates a unspecified nat type.
NAT_TYPE_NONE 1

NAT_TYPE_NONE indicates that no nat is configured

NAT_TYPE_NONE indicates that no nat is configured.

NetworkAddressFamily

-

NetworkAddressFamily defines the address family of a network

+

NetworkAddressFamily defines the address family of a network.

@@ -9281,32 +9281,32 @@

NetworkAddressFamily

- + - + - + - +
NameNumberDescription
NETWORK_ADDRESS_FAMILY_UNSPECIFIED 0

NETWORK_ADDRESS_FAMILY_UNSPECIFIED is not specified

NETWORK_ADDRESS_FAMILY_UNSPECIFIED is not specified.
NETWORK_ADDRESS_FAMILY_V4 1

NETWORK_ADDRESS_FAMILY_V4 defines a network with IPv4 address prefixes

NETWORK_ADDRESS_FAMILY_V4 defines a network with IPv4 address prefixes.
NETWORK_ADDRESS_FAMILY_V6 2

NETWORK_ADDRESS_FAMILY_V6 defines a network with IPv6 address prefixes

NETWORK_ADDRESS_FAMILY_V6 defines a network with IPv6 address prefixes.
NETWORK_ADDRESS_FAMILY_DUAL_STACK 3

NETWORK_ADDRESS_FAMILY_DUAL_STACK defines a network with both IPv4 and IPv6 address prefixes

NETWORK_ADDRESS_FAMILY_DUAL_STACK defines a network with both IPv4 and IPv6 address prefixes.

NetworkType

-

NetworkType indicates the purpose of the network, it cannot be changed after creation

+

NetworkType indicates the purpose of the network, it cannot be changed after creation.

@@ -9316,13 +9316,13 @@

NetworkType

- + - @@ -9330,7 +9330,7 @@

NetworkType

- @@ -9338,14 +9338,14 @@

NetworkType

- @@ -9496,7 +9496,7 @@

NTPServer

Partition

-

Partition is a failure domain with machines and switches

+

Partition is a failure domain with machines and switches.

NameNumberDescription
NETWORK_TYPE_UNSPECIFIED 0

NETWORK_TYPE_UNSPECIFIED indicates a unknown network type

NETWORK_TYPE_UNSPECIFIED indicates a unknown network type.
NETWORK_TYPE_EXTERNAL 1

NETWORK_TYPE_EXTERNAL indicates network where multiple projects can allocate ips, it offers connectivity to other external networks +

NETWORK_TYPE_EXTERNAL indicates network where multiple projects can allocate ips, it offers connectivity to other external networks. In most cases this is the internet network or a network which offers connectivity to legacy datacenter networks. If it is not project scoped everyone can allocate Ips in this network, otherwise only from the same project ip allocation is possible.
NETWORK_TYPE_UNDERLAY 2

NETWORK_TYPE_UNDERLAY indicates a underlay network +

NETWORK_TYPE_UNDERLAY indicates a underlay network. The underlay network connects all switches and the firewalls to build a EVPN dataplane It is not project scoped. Is part of the dataplane and reserved for administrative purposes.
NETWORK_TYPE_SUPER 3

NETWORK_TYPE_SUPER indicates a super network which is only used to create child networks +

NETWORK_TYPE_SUPER indicates a super network which is only used to create child networks. If the vrf id is given, child networks will inherit this vrf. If the vrf id is nil in this network, child vrf is taken from the pool. If the partition is given, child networks inherit the partition. If the partition is nil, child networks also do not have a partition (i.e. requires vrf is distributed across all partitions). If the partition is given, only one super network in that partition can be created. If the partition is nil, multiple super networks can exist. Then, for child network creation the network id must be specified (base networks can be queried by label selector). -For child creation destination prefixes will be inherited +For child creation destination prefixes will be inherited. If this is project scoped, the child project must match, otherwise can be freely specified.
@@ -9530,7 +9530,7 @@

Partition

- + @@ -9551,7 +9551,7 @@

Partition

- @@ -9563,7 +9563,7 @@

Partition

PartitionBootConfiguration

-

PartitionBootConfiguration defines how metal-hammer boots

+

PartitionBootConfiguration defines how metal-hammer boots.

boot_configuration PartitionBootConfiguration

PartitionBootConfiguration defines how metal-hammer boots

PartitionBootConfiguration defines how metal-hammer boots.

mgmt_service_addresses string repeated

ManagementServiceAddresses defines where the management is reachable +

ManagementServiceAddresses defines where the management is reachable. should be in the form <ip|host>:<port>

@@ -9601,7 +9601,7 @@

PartitionBootConfiguration

PartitionQuery

-

PartitionQuery is used to search partitions

+

PartitionQuery is used to search partitions.

@@ -9621,7 +9621,7 @@

PartitionQuery

- + @@ -9632,7 +9632,7 @@

PartitionQuery

PartitionServiceGetRequest

-

PartitionServiceGetRequest is the request payload for a partition get request

+

PartitionServiceGetRequest is the request payload for a partition get request.

labels Labels optional

Labels lists only partitions containing the given labels

Labels lists only partitions containing the given labels.

@@ -9656,7 +9656,7 @@

PartitionServiceGetRequest

PartitionServiceGetResponse

-

PartitionServiceGetResponse is the response payload for a partition get request

+

PartitionServiceGetResponse is the response payload for a partition get request.

@@ -9669,7 +9669,7 @@

PartitionServiceGetRespon

- + @@ -9680,7 +9680,7 @@

PartitionServiceGetRespon

PartitionServiceListRequest

-

PartitionServiceListRequest is the request payload for a partition list request

+

PartitionServiceListRequest is the request payload for a partition list request.

partition Partition

Partition is the partition

Partition is the partition.

@@ -9693,7 +9693,7 @@

PartitionServiceListReque

- + @@ -9704,7 +9704,7 @@

PartitionServiceListReque

PartitionServiceListResponse

-

PartitionServiceListResponse is the response payload for a partition list request

+

PartitionServiceListResponse is the response payload for a partition list request.

query PartitionQuery

Query for partitions

Query for partitions.

@@ -9717,7 +9717,7 @@

PartitionServiceListResp

- + @@ -9854,7 +9854,7 @@

SizeConstraint

- + @@ -9865,7 +9865,7 @@

SizeConstraint

SizeQuery

-

SizeQuery is used to search sizes

+

SizeQuery is used to search sizes.

partitions Partition repeated

Partitions are the partitions

Partitions are the partitions.

identifier string optional

Identifier glob pattern which matches to the given type, for example gpu pci id

Identifier glob pattern which matches to the given type, for example gpu pci id.

@@ -9899,7 +9899,7 @@

SizeQuery

- + @@ -9910,7 +9910,7 @@

SizeQuery

SizeServiceGetRequest

-

SizeServiceGetRequest is the request payload for a size get request

+

SizeServiceGetRequest is the request payload for a size get request.

labels Labels optional

Labels lists only sizes containing the given labels

Labels lists only sizes containing the given labels.

@@ -9934,7 +9934,7 @@

SizeServiceGetRequest

SizeServiceGetResponse

-

SizeServiceGetResponse is the response payload for a size get request

+

SizeServiceGetResponse is the response payload for a size get request.

@@ -9958,7 +9958,7 @@

SizeServiceGetResponse

SizeServiceListRequest

-

SizeServiceListRequest is the request payload for a size list request

+

SizeServiceListRequest is the request payload for a size list request.

@@ -9971,7 +9971,7 @@

SizeServiceListRequest

- + @@ -9982,7 +9982,7 @@

SizeServiceListRequest

SizeServiceListResponse

-

SizeServiceListResponse is the response payload for a size list request

+

SizeServiceListResponse is the response payload for a size list request.

query SizeQuery

Query for sizes

Query for sizes.

@@ -10008,7 +10008,7 @@

SizeServiceListResponse

SizeConstraintType

-

SizeConstraintType defines the property for which a constraint is defined

+

SizeConstraintType defines the property for which a constraint is defined.

@@ -10024,25 +10024,25 @@

SizeConstraintType

- + - + - + - + @@ -10087,7 +10087,7 @@

metalstack/api/v2/machine.proto

FirewallEgressRule -

FirewallEgressRule defines rules for outgoing traffic

+

FirewallEgressRule defines rules for outgoing traffic.

NameNumberDescription
SIZE_CONSTRAINT_TYPE_CORES 1

SIZE_CONSTRAINT_TYPE_CORES defines the number of cores as property

SIZE_CONSTRAINT_TYPE_CORES defines the number of cores as property.
SIZE_CONSTRAINT_TYPE_MEMORY 2

SIZE_CONSTRAINT_TYPE_MEMORY defines the amount of memory as property

SIZE_CONSTRAINT_TYPE_MEMORY defines the amount of memory as property.
SIZE_CONSTRAINT_TYPE_STORAGE 3

SIZE_CONSTRAINT_TYPE_STORAGE defines the amount of storage as property

SIZE_CONSTRAINT_TYPE_STORAGE defines the amount of storage as property.
SIZE_CONSTRAINT_TYPE_GPU 4

SIZE_CONSTRAINT_TYPE_GPU defines the number of gpus as property

SIZE_CONSTRAINT_TYPE_GPU defines the number of gpus as property.
@@ -10132,7 +10132,7 @@

FirewallEgressRule

FirewallIngressRule

-

FirewallIngressRule defines rules for incoming traffic

+

FirewallIngressRule defines rules for incoming traffic.

@@ -10184,7 +10184,7 @@

FirewallIngressRule

FirewallRules

-

FirewallRules can be defined during firewall allocation

+

FirewallRules can be defined during firewall allocation.

@@ -10197,14 +10197,14 @@

FirewallRules

 - + - + @@ -10215,7 +10215,7 @@

FirewallRules

FirewallSpec

-

FirewallSpec contains firewall specific firewall creation parameters

+

FirewallSpec contains firewall specific firewall creation parameters.

egress FirewallEgressRule repeated

Egress list of egress rules to be deployed during firewall allocation

Egress list of egress rules to be deployed during firewall allocation.

ingress FirewallIngressRule repeated

Ingress list of ingress rules to be deployed during firewall allocation

Ingress list of ingress rules to be deployed during firewall allocation.

@@ -10273,14 +10273,14 @@

Machine

 - + - + @@ -10308,14 +10308,14 @@

Machine

 - + - + @@ -10326,7 +10326,7 @@

Machine

MachineAllocation

-

MachineAllocation contains properties if this machine is allocated

+

MachineAllocation contains properties if this machine is allocated.

rack string

Rack where this machine is located

Rack where this machine is located.

room string

Room where this machine is located

Room where this machine is located.

status MachineStatus

Status contains several status details related to this machine

Status contains several status details related to this machine.

recent_provisioning_events MachineRecentProvisioningEvents

MachineRecentProvisioningEvents contains the recent provisioning events

MachineRecentProvisioningEvents contains the recent provisioning events.

@@ -10464,7 +10464,7 @@

MachineAllocation

MachineAllocationNetwork

-

MachineAllocationNetwork defines which network should be attached to a machine and if ips should be autoacquired

+

MachineAllocationNetwork defines which network should be attached to a machine and if ips should be autoacquired.

@@ -10485,7 +10485,7 @@

MachineAllocationNetwork

string @@ -10577,7 +10577,7 @@

MachineAllocationQuery

MachineBMC

-

MachineBMC describe details of the ipmi or out of band device

+

MachineBMC describe details of the ipmi or out of band device.

repeated

IPs to to attach to this machine additionally -If none given, one ip address is acquired per network for the machine +If none given, one ip address is acquired per network for the machine. Order of ips is preserved on the loopback interface.

@@ -10688,7 +10688,7 @@

MachineBMCQuery

MachineBMCReport

-

MachineBMCReport is sent from the metal-bmc to update bmc and power related details

+

MachineBMCReport is sent from the metal-bmc to update bmc and power related details.

@@ -10701,49 +10701,49 @@

MachineBMCReport

- + - + - + - + - + - + - + @@ -10754,7 +10754,7 @@

MachineBMCReport

MachineBios

-

MachineBios contains BIOS details of this machine

+

MachineBios contains BIOS details of this machine.

bmc MachineBMC

Bmc contains bmc details

Bmc contains bmc details.

bios MachineBios

Bios contains bios details

Bios contains bios details.

fru MachineFRU

Fru contains field replaceable unit details

Fru contains field replaceable unit details.

power_metric MachinePowerMetric

PowerMetric contains the power statistics of the machine

PowerMetric contains the power statistics of the machine.

power_supplies MachinePowerSupply repeated

PowerSupplies contains details about all power supplies and their state

PowerSupplies contains details about all power supplies and their state.

led_state MachineChassisIdentifyLEDState

LedState indicates the state of the indicator LED on this machine

LedState indicates the state of the indicator LED on this machine.

updated_at google.protobuf.Timestamp

UpdatedAt contains the date when this data was last updated

UpdatedAt contains the date when this data was last updated.

@@ -10792,7 +10792,7 @@

MachineBios

MachineBlockDevice

-

MachineBlockDevice contains details of a block device of this machine

+

MachineBlockDevice contains details of a block device of this machine.

@@ -10823,7 +10823,7 @@

MachineBlockDevice

MachineChassisIdentifyLEDState

-

MachineChassisIdentifyLEDState describes the identifier led state

+

MachineChassisIdentifyLEDState describes the identifier led state.

@@ -10854,7 +10854,7 @@

MachineChassisIdentify

MachineCondition

-

MachineCondition describes the availability of this machine

+

MachineCondition describes the availability of this machine.

@@ -10923,7 +10923,7 @@

MachineDiskQuery

MachineFRU

-

MachineFRU describes details to the machine which are required in case of a necessary replacement

+

MachineFRU describes details to the machine which are required in case of a necessary replacement.

@@ -10936,56 +10936,56 @@

MachineFRU

- + - + - + - + - + - + - + - + @@ -11069,7 +11069,7 @@

MachineFRUQuery

MachineHardware

-

MachineHardware contains hardware details

+

MachineHardware contains hardware details.

chassis_part_number string optional

ChassisPartNumber is the part number of the machine chassis

ChassisPartNumber is the part number of the machine chassis.

chassis_part_serial string optional

ChassisPartSerial is the serial number of the machine chassis

ChassisPartSerial is the serial number of the machine chassis.

board_mfg string optional

BoardMfg is the short description of the mainboard

BoardMfg is the short description of the mainboard.

board_mfg_serial string optional

BoardMfgSerial is the serial number of the mainboard

BoardMfgSerial is the serial number of the mainboard.

board_part_number string optional

BoardPartNumber is the part number of the mainboard

BoardPartNumber is the part number of the mainboard.

product_manufacturer string optional

ProductManufacturer is the manufacturer of the machine

ProductManufacturer is the manufacturer of the machine.

product_part_number string optional

ProductPartNumber is the part number of the machine

ProductPartNumber is the part number of the machine.

product_serial string optional

ProductSerial is the serial number of the machine

ProductSerial is the serial number of the machine.

@@ -11152,7 +11152,7 @@

MachineHardwareQuery

MachineIssue

-

MachineIssue contains details of one issue

+

MachineIssue contains details of one issue.

@@ -11172,28 +11172,28 @@

MachineIssue

- + - + - + - + @@ -11204,7 +11204,7 @@

MachineIssue

MachineIssues

-

MachineIssues is a list of issues for a machine

+

MachineIssues is a list of issues for a machine.

severity MachineIssueSeverity

Severity specifies the severity of an issue

Severity specifies the severity of an issue.

description string

Description provides an issue description

Description provides an issue description.

reference_url string

RefURL provides a link to a more detailed issue description in the metal-stack documentation

RefURL provides a link to a more detailed issue description in the metal-stack documentation.

details string

Details may contain additional details on an evaluated issue

Details may contain additional details on an evaluated issue.

@@ -11235,7 +11235,7 @@

MachineIssues

MachineIssuesQuery

-

MachineIssuesQuery defines which machine issues should be listed

+

MachineIssuesQuery defines which machine issues should be listed.

@@ -11255,7 +11255,7 @@

MachineIssuesQuery

- + @@ -11269,14 +11269,14 @@

MachineIssuesQuery

- + - + @@ -11287,7 +11287,7 @@

MachineIssuesQuery

MachineNetwork

-

MachineNetwork contains details which network should be created on a allocated machine

+

MachineNetwork contains details which network should be created on a allocated machine.

only MachineIssueType repeated

Only includes the specified machine issue types

Only includes the specified machine issue types.

severity MachineIssueSeverity optional

Severity filters issue for given severity

Severity filters issue for given severity.

last_error_threshold google.protobuf.Duration

LastErrorThreshold defines the last error threshold

LastErrorThreshold defines the last error threshold.

@@ -11314,7 +11314,7 @@

MachineNetwork

- + @@ -11335,7 +11335,7 @@

MachineNetwork

- + @@ -11356,7 +11356,7 @@

MachineNetwork

- + @@ -11426,7 +11426,7 @@

MachineNetworkQuery

MachineNic

-

MachineNic contains details of a network interface of this machine

+

MachineNic contains details of a network interface of this machine.

destination_prefixes string repeated

DestinationPrefixes prefixes that are reachable within this network

DestinationPrefixes prefixes that are reachable within this network.

nat_type NATType

NatType what type of nat if any should be used

NatType what type of nat if any should be used.

project string optional

Project is the project uuid associated with this network

Project is the project uuid associated with this network.

@@ -11544,7 +11544,7 @@

MachineNicQuery

MachinePowerMetric

-

MachinePowerMetric contains metrics of the power consumption of a machine

+

MachinePowerMetric contains metrics of the power consumption of a machine.

@@ -11598,7 +11598,7 @@

MachinePowerMetric

MachinePowerSupply

-

MachinePowerSupply contains details of the power supply of a machine

+

MachinePowerSupply contains details of the power supply of a machine.

@@ -11629,7 +11629,7 @@

MachinePowerSupply

MachineProvisioningEvent

-

MachineProvisioningEvent is an event that has occurred during provisioning

+

MachineProvisioningEvent is an event that has occurred during provisioning.

@@ -11847,7 +11847,7 @@

MachineRecentProvisio

- + @@ -11858,7 +11858,7 @@

MachineRecentProvisio

MachineServiceBMCCommandRequest

-

MachineServiceBMCCommandRequest is the request payload for a machine bmc command

+

MachineServiceBMCCommandRequest is the request payload for a machine bmc command.

state MachineProvisioningEventState

State can be either CrashLoop, FailedReclaim or something else

State can be either CrashLoop, FailedReclaim or something else.

@@ -11896,14 +11896,14 @@

MachineServiceBMCComm

MachineServiceBMCCommandResponse

-

MachineServiceBMCCommandResponse is the response payload for a machine bmc command

+

MachineServiceBMCCommandResponse is the response payload for a machine bmc command.

MachineServiceCreateRequest

-

MachineServiceCreateRequest is the request payload for a machine create request

+

MachineServiceCreateRequest is the request payload for a machine create request.

@@ -11968,7 +11968,7 @@

MachineServiceCreateReque

- + - @@ -12047,7 +12047,7 @@

MachineServiceCreateReque

- + @@ -12058,7 +12058,7 @@

MachineServiceCreateReque

MachineServiceCreateResponse

-

MachineServiceCreateResponse is the response payload for a machine create request

+

MachineServiceCreateResponse is the response payload for a machine create request.

string

Image which should be installed on this machine -The image can be specified either in the fully qualified form, e.g. including os, major, minor and patch +The image can be specified either in the fully qualified form, e.g. including os, major, minor and patch. - debian-13.0.20260402 or in a simplified form which omits the patch version - debian-13.0 @@ -11989,14 +11989,14 @@

MachineServiceCreateReque

ssh_public_keys string repeated

SSHPublicKeys defines the ssh public key to be installed on the machine to access it via ssh

SSHPublicKeys defines the ssh public key to be installed on the machine to access it via ssh.

userdata string optional

Userdata contains instructions required to bootstrap the machine +

Userdata contains instructions required to bootstrap the machine. AWS limits the max userdata size to 16k, lets allow twice as much

firewall_spec FirewallSpec

FirewallSpec provides firewall specific parameters if allocationType is firewall

FirewallSpec provides firewall specific parameters if allocationType is firewall.

@@ -12082,7 +12082,7 @@

MachineServiceCreateResp

MachineServiceDeleteRequest

-

MachineServiceDeleteRequest is the request payload for a machine delete request

+

MachineServiceDeleteRequest is the request payload for a machine delete request.

@@ -12113,7 +12113,7 @@

MachineServiceDeleteReque

MachineServiceDeleteResponse

-

MachineServiceDeleteResponse is the response payload for a machine delete request

+

MachineServiceDeleteResponse is the response payload for a machine delete request.

@@ -12137,7 +12137,7 @@

MachineServiceDeleteResp

MachineServiceGetBMCRequest

-

MachineServiceGetBMCRequest is the request payload for a machine getbmc request

+

MachineServiceGetBMCRequest is the request payload for a machine getbmc request.

@@ -12168,7 +12168,7 @@

MachineServiceGetBMCReque

MachineServiceGetBMCResponse

-

MachineServiceGetBMCResponse is the response payload for a machine getbmc request

+

MachineServiceGetBMCResponse is the response payload for a machine getbmc request.

@@ -12188,7 +12188,7 @@

MachineServiceGetBMCResp

- + @@ -12199,7 +12199,7 @@

MachineServiceGetBMCResp

MachineServiceGetRequest

-

MachineServiceGetRequest is the request payload for a machine get request

+

MachineServiceGetRequest is the request payload for a machine get request.

bmc MachineBMCReport

BMC contains the BMC details of this machine

BMC contains the BMC details of this machine.

@@ -12230,7 +12230,7 @@

MachineServiceGetRequest

MachineServiceGetResponse -

MachineServiceGetResponse is the response payload for a machine get request

+

MachineServiceGetResponse is the response payload for a machine get request.

@@ -12243,7 +12243,7 @@

MachineServiceGetResponsemachine

- + @@ -12254,7 +12254,7 @@

MachineServiceGetResponseMachineServiceListRequest

-

MachineServiceListRequest is the request payload for a machine list request

+

MachineServiceListRequest is the request payload for a machine list request.

Machine

Machine is the machine requested

Machine is the machine requested.

@@ -12274,7 +12274,7 @@

MachineServiceListRequestquery

- + @@ -12285,7 +12285,7 @@

MachineServiceListRequestMachineServiceListResponse

-

MachineServiceListResponse is the response payload for a machine list request

+

MachineServiceListResponse is the response payload for a machine list request.

MachineQuery

Query to list one ore more machines

Query to list one ore more machines.

@@ -12298,7 +12298,7 @@

MachineServiceListResponse

- + @@ -12309,7 +12309,7 @@

MachineServiceListResponse

MachineServiceUpdateRequest

-

MachineServiceUpdateRequest is the request payload for a machine update request

+

MachineServiceUpdateRequest is the request payload for a machine update request.

machines Machine repeated

Machines are the machines requested by a list request

Machines are the machines requested by a list request.

@@ -12329,7 +12329,7 @@

MachineServiceUpdateReque

- + @@ -12368,7 +12368,7 @@

MachineServiceUpdateReque

MachineServiceUpdateResponse

-

MachineServiceUpdateResponse is the response payload for a machine update request

+

MachineServiceUpdateResponse is the response payload for a machine update request.

update_meta UpdateMeta

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.

@@ -12392,7 +12392,7 @@

MachineServiceUpdateResp

MachineStatus

-

MachineStatus contains several status details related to this machine

+

MachineStatus contains several status details related to this machine.

@@ -12405,14 +12405,14 @@

MachineStatus

- + - + @@ -12437,7 +12437,7 @@

MachineStatus

MachineVPN

-

MachineVPN contains configuration data for the VPN connection

+

MachineVPN contains configuration data for the VPN connection.

condition MachineCondition

Condition describes the availability

Condition describes the availability.

led_state MachineChassisIdentifyLEDState

LEDState indicates the state of the indicator LED on this machine

LEDState indicates the state of the indicator LED on this machine.

@@ -12464,7 +12464,7 @@

MachineVPN

- + @@ -12482,7 +12482,7 @@

MachineVPN

MetalCPU

-

MetalCPU contains details of a cpu in this machine

+

MetalCPU contains details of a cpu in this machine.

connected bool

Connected indicate if this machine is connected to the VPN

Connected indicate if this machine is connected to the VPN.

@@ -12527,7 +12527,7 @@

MetalCPU

MetalGPU

-

MetalGPU contains details of a gpu in this machine

+

MetalGPU contains details of a gpu in this machine.

@@ -12560,7 +12560,7 @@

MetalGPU

IPProtocol

-

IPProtocol defines tcp|udp

+

IPProtocol defines tcp|udp.

@@ -12570,26 +12570,26 @@

IPProtocol

- + - + - +
NameNumberDescription
IP_PROTOCOL_UNSPECIFIED 0

IP_PROTOCOL_UNSPECIFIED is not specified

IP_PROTOCOL_UNSPECIFIED is not specified.
IP_PROTOCOL_TCP 1

IP_PROTOCOL_TCP is tcp

IP_PROTOCOL_TCP is tcp.
IP_PROTOCOL_UDP 2

IP_PROTOCOL_UDP is udp

IP_PROTOCOL_UDP is udp.

MachineAllocationType

-

MachineAllocationType defines if this is a machine or a firewall

+

MachineAllocationType defines if this is a machine or a firewall.

@@ -12599,26 +12599,26 @@

MachineAllocationType

- + - + - +
NameNumberDescription
MACHINE_ALLOCATION_TYPE_UNSPECIFIED 0

MACHINE_ALLOCATION_TYPE_UNSPECIFIED is unspecified

MACHINE_ALLOCATION_TYPE_UNSPECIFIED is unspecified.
MACHINE_ALLOCATION_TYPE_MACHINE 1

MACHINE_ALLOCATION_TYPE_MACHINE is a machine

MACHINE_ALLOCATION_TYPE_MACHINE is a machine.
MACHINE_ALLOCATION_TYPE_FIREWALL 2

MACHINE_ALLOCATION_TYPE_FIREWALL is a firewall

MACHINE_ALLOCATION_TYPE_FIREWALL is a firewall.

MachineBMCCommand

-

MachineBMCCommand defines commands send to the BMC of the machine

+

MachineBMCCommand defines commands send to the BMC of the machine.

@@ -12628,31 +12628,31 @@

MachineBMCCommand

- + - + - + - + - + @@ -12701,7 +12701,7 @@

MachineBMCCommand

NameNumberDescription
MACHINE_BMC_COMMAND_UNSPECIFIED 0

MACHINE_BMC_COMMAND_UNSPECIFIED is not defined

MACHINE_BMC_COMMAND_UNSPECIFIED is not defined.
MACHINE_BMC_COMMAND_ON 1

MACHINE_BMC_COMMAND_ON Power on the machine

MACHINE_BMC_COMMAND_ON Power on the machine.
MACHINE_BMC_COMMAND_OFF 2

MACHINE_BMC_COMMAND_OFF Power off the machine

MACHINE_BMC_COMMAND_OFF Power off the machine.
MACHINE_BMC_COMMAND_RESET 3

MACHINE_BMC_COMMAND_RESET Power reset the machine

MACHINE_BMC_COMMAND_RESET Power reset the machine.
MACHINE_BMC_COMMAND_CYCLE 4

MACHINE_BMC_COMMAND_CYCLE Power cycle the machine

MACHINE_BMC_COMMAND_CYCLE Power cycle the machine.

MachineIssueSeverity

-

MachineIssueSeverity defines the severity of an issue

+

MachineIssueSeverity defines the severity of an issue.

@@ -12736,7 +12736,7 @@

MachineIssueSeverity

NameNumberDescription

MachineIssueType

-

MachineIssueType defines which type of issue it is

+

MachineIssueType defines which type of issue it is.

@@ -12831,7 +12831,7 @@

MachineIssueType

NameNumberDescription

MachineLiveliness

-

MachineLiveliness specifies the liveliness of a machine

+

MachineLiveliness specifies the liveliness of a machine.

@@ -12841,7 +12841,7 @@

MachineLiveliness

- + @@ -12876,7 +12876,7 @@

MachineProvisioningEven

- + @@ -12895,7 +12895,7 @@

MachineProvisioningEven

NameNumberDescription
MACHINE_LIVELINESS_UNSPECIFIED 0

MACHINE_LIVELINESS_UNSPECIFIED is not defined

MACHINE_LIVELINESS_UNSPECIFIED is not defined.
MACHINE_PROVISIONING_EVENT_STATE_UNSPECIFIED 0

MACHINE_PROVISIONING_EVENT_STATE_UNSPECIFIED is not specified

MACHINE_PROVISIONING_EVENT_STATE_UNSPECIFIED is not specified.

MachineProvisioningEventType

-

MachineProvisioningEventType defines in which phase the machine actually is

+

MachineProvisioningEventType defines in which phase the machine actually is.

@@ -12905,7 +12905,7 @@

MachineProvisioningEvent

- + @@ -12978,7 +12978,7 @@

MachineProvisioningEvent

NameNumberDescription
MACHINE_PROVISIONING_EVENT_TYPE_UNSPECIFIED 0

MACHINE_PROVISIONING_EVENT_TYPE_UNSPECIFIED is not specified

MACHINE_PROVISIONING_EVENT_TYPE_UNSPECIFIED is not specified.

MachineState

-

MachineState defines if the machine was locked or reserved from a operator

+

MachineState defines if the machine was locked or reserved from a operator.

@@ -12988,7 +12988,7 @@

MachineState

- + @@ -13086,7 +13086,7 @@

metalstack/admin/v2/machine.proto

MachineServiceBMCCommandRequest -

MachineServiceBMCCommandRequest is the request payload for a machine bmc command

+

MachineServiceBMCCommandRequest is the request payload for a machine bmc command.

NameNumberDescription
MACHINE_STATE_UNSPECIFIED 0

MACHINE_STATE_UNSPECIFIED is not specified

MACHINE_STATE_UNSPECIFIED is not specified.
@@ -13117,7 +13117,7 @@

MachineServiceBMCCo

MachineServiceBMCCommandResponse

-

MachineServiceBMCCommandResponse is the response payload for a machine bmc command

+

MachineServiceBMCCommandResponse is the response payload for a machine bmc command.

@@ -13144,8 +13144,8 @@

MachineService

- + @@ -13187,7 +13187,7 @@

MachineServic

MachineServiceDeleteRequest

-

MachineServiceDeleteRequest is the request payload for a machine delete request

+

MachineServiceDeleteRequest is the request payload for a machine delete request.

reason string

Reason must be provided why access to the console is requested -Reason is only forwarded to an audit sink

Reason must be provided why access to the console is requested. +Reason is only forwarded to an audit sink.

@@ -13211,7 +13211,7 @@

MachineServiceDeleteReq

MachineServiceDeleteResponse

-

MachineServiceDeleteResponse is the response payload for a machine delete request

+

MachineServiceDeleteResponse is the response payload for a machine delete request.

@@ -13224,7 +13224,7 @@

MachineServiceDeleteRe

- + @@ -13235,7 +13235,7 @@

MachineServiceDeleteRe

MachineServiceGetBMCRequest

-

MachineServiceGetBMCRequest is the request payload for a machine getbmc request

+

MachineServiceGetBMCRequest is the request payload for a machine getbmc request.

machine metalstack.api.v2.Machine

Machine is the machine permanently deleted

Machine is the machine permanently deleted.

@@ -13259,7 +13259,7 @@

MachineServiceGetBMCReq

MachineServiceGetBMCResponse

-

MachineServiceGetBMCResponse is the response payload for a machine getbmc request

+

MachineServiceGetBMCResponse is the response payload for a machine getbmc request.

@@ -13279,7 +13279,7 @@

MachineServiceGetBMCRe

- + @@ -13290,7 +13290,7 @@

MachineServiceGetBMCRe

MachineServiceGetRequest

-

MachineServiceGetRequest is the request payload for a machine get request

+

MachineServiceGetRequest is the request payload for a machine get request.

bmc metalstack.api.v2.MachineBMCReport

BMC contains the BMC details of this machine

BMC contains the BMC details of this machine.

@@ -13314,7 +13314,7 @@

MachineServiceGetRequestMachineServiceGetResponse

-

MachineServiceGetResponse is the response payload for a machine get request

+

MachineServiceGetResponse is the response payload for a machine get request.

@@ -13327,7 +13327,7 @@

MachineServiceGetResponse

- + @@ -13338,7 +13338,7 @@

MachineServiceGetResponse

MachineServiceIssuesRequest

-

MachineServiceIssuesRequest is the request payload for a machine issues request

+

MachineServiceIssuesRequest is the request payload for a machine issues request.

machine metalstack.api.v2.Machine

Machine is the machine requested

Machine is the machine requested.

@@ -13351,7 +13351,7 @@

MachineServiceIssuesReq

- + @@ -13362,7 +13362,7 @@

MachineServiceIssuesReq

MachineServiceIssuesResponse

-

MachineServiceIssuesResponse is the response payload for a machine issues request

+

MachineServiceIssuesResponse is the response payload for a machine issues request.

query metalstack.api.v2.MachineIssuesQuery

Query which machine issues to include

Query which machine issues to include.

@@ -13375,7 +13375,7 @@

MachineServiceIssuesRe

- + @@ -13386,7 +13386,7 @@

MachineServiceIssuesRe

MachineServiceListBMCRequest

-

MachineServiceListBMCRequest is the request payload for a machine listbmc request

+

MachineServiceListBMCRequest is the request payload for a machine listbmc request.

issues metalstack.api.v2.MachineIssues repeated

Issues is the result of the issues query

Issues is the result of the issues query.

@@ -13399,7 +13399,7 @@

MachineServiceListBMCR

- + @@ -13410,7 +13410,7 @@

MachineServiceListBMCR

MachineServiceListBMCResponse

-

MachineServiceListBMCResponse is the response payload for a machine listbmc request

+

MachineServiceListBMCResponse is the response payload for a machine listbmc request.

query metalstack.api.v2.MachineBMCQuery

Query to list one or more BMCs of many machines

Query to list one or more BMCs of many machines.

@@ -13423,7 +13423,7 @@

MachineServiceListBMC

- + @@ -13465,7 +13465,7 @@

Machi

MachineServiceListRequest

-

MachineServiceListRequest is the request payload for a machine list request

+

MachineServiceListRequest is the request payload for a machine list request.

bmc_reports MachineServiceListBMCResponse.BmcReportsEntry repeated

BMCReports maps the bmc report per machine uuid

BMCReports maps the bmc report per machine uuid.

@@ -13478,7 +13478,7 @@

MachineServiceListRequest

- + @@ -13497,7 +13497,7 @@

MachineServiceListRequest

MachineServiceListResponse

-

MachineServiceListResponse is the response payload for a machine list request

+

MachineServiceListResponse is the response payload for a machine list request.

query metalstack.api.v2.MachineQuery

Query to list one or more machines

Query to list one or more machines.

@@ -13510,7 +13510,7 @@

MachineServiceListRespon

- + @@ -13521,7 +13521,7 @@

MachineServiceListRespon

MachineServiceSetStateRequest

-

MachineServiceSetStateRequest is the request payload for a machine set state request

+

MachineServiceSetStateRequest is the request payload for a machine set state request.

machines metalstack.api.v2.Machine repeated

Machines are the machines requested by a list request

Machines are the machines requested by a list request.

@@ -13560,7 +13560,7 @@

MachineServiceSetStat

MachineServiceSetStateResponse

-

MachineServiceSetStateResponse is the response payload for a machine set state request

+

MachineServiceSetStateResponse is the response payload for a machine set state request.

@@ -13657,7 +13657,7 @@

MachineService

- + @@ -13707,14 +13707,14 @@

NetworkServiceCreateReq

- + - + @@ -13749,14 +13749,14 @@

NetworkServiceCreateReq

- + - + @@ -13777,14 +13777,14 @@

NetworkServiceCreateReq

- + - + @@ -13822,7 +13822,7 @@

NetworkServiceCreateRe

- + @@ -13870,7 +13870,7 @@

NetworkServiceDeleteRe

- + @@ -13918,7 +13918,7 @@

NetworkServiceGetResponse

- + @@ -13942,7 +13942,7 @@

NetworkServiceListRequest

- + @@ -13966,7 +13966,7 @@

NetworkServiceListRespon

- + @@ -13997,7 +13997,7 @@

NetworkServiceUpdateReq

- + @@ -14039,14 +14039,14 @@

NetworkServiceUpdateReq

- + - + @@ -14060,7 +14060,7 @@

NetworkServiceUpdateReq

- + @@ -14091,7 +14091,7 @@

NetworkServiceUpdateRe

- + @@ -14163,7 +14163,7 @@

metalstack/admin/v2/partition.proto

MachineSizeCapacity

-

ServerCapacity is the capacity of one server type, eg machine size

+

ServerCapacity is the capacity of one server type, eg machine size.

Issues MachineServiceIssuesRequest MachineServiceIssuesResponse

Issues allows to query issues of machines

Issues allows to query issues of machines.
partition string optional

Partition where this network will be created

Partition where this network will be created.

project string optional

Project where this network belongs to

Project where this network belongs to.

default_child_prefix_length metalstack.api.v2.ChildPrefixLength

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

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

min_child_prefix_length metalstack.api.v2.ChildPrefixLength

Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length

Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length.

parent_network string optional

Parent Network points to the id of the parent network if any

Parent Network points to the id of the parent network if any.

additional_announcable_cidrs string repeated

AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced

AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced.

network metalstack.api.v2.Network

Network contains the created network

Network contains the created network.

network metalstack.api.v2.Network

Network contains the deleted network

Network contains the deleted network.

network metalstack.api.v2.Network

Network contains the requested network

Network contains the requested network.

query metalstack.api.v2.NetworkQuery

Query specifies which networks to return

Query specifies which networks to return.

networks metalstack.api.v2.Network repeated

Networks contains the list of networks

Networks contains the list of networks.

update_meta metalstack.api.v2.UpdateMeta

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.

default_child_prefix_length metalstack.api.v2.ChildPrefixLength optional

Default Child Prefix length defines the bit length of a child network created per addressfamily, if 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.

min_child_prefix_length metalstack.api.v2.ChildPrefixLength optional

Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length

Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length.

additional_announcable_cidrs string repeated

AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced

AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced.

network metalstack.api.v2.Network

Network contains the updated network

Network contains the updated network.

@@ -14288,7 +14288,7 @@

MachineSizeCapacity

PartitionCapacity

-

PartitionCapacity is the capacity of one partition

+

PartitionCapacity is the capacity of one partition.

@@ -14357,7 +14357,7 @@

PartitionServiceCap

PartitionServiceCapacityResponse

-

PartitionServiceCapacityResponse is the response payload for a partition capacity request

+

PartitionServiceCapacityResponse is the response payload for a partition capacity request.

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

PartitionServiceCa

- + @@ -14381,7 +14381,7 @@

PartitionServiceCa

PartitionServiceCreateRequest

-

PartitionServiceCreateRequest is the request payload for a partition create request

+

PartitionServiceCreateRequest is the request payload for a partition create request.

partition_capacity PartitionCapacity repeated

PartitionCapacity is a capacity report per partition

PartitionCapacity is a capacity report per partition.

@@ -14405,7 +14405,7 @@

PartitionServiceCreat

PartitionServiceCreateResponse

-

PartitionServiceCreateResponse is the response payload for a partition create request

+

PartitionServiceCreateResponse is the response payload for a partition create request.

@@ -14429,7 +14429,7 @@

PartitionServiceCrea

PartitionServiceDeleteRequest

-

PartitionServiceDeleteRequest is the request payload for a partition delete request

+

PartitionServiceDeleteRequest is the request payload for a partition delete request.

@@ -14466,7 +14466,7 @@

PartitionServiceDele

- + @@ -14497,7 +14497,7 @@

PartitionServiceUpdat

- + @@ -14511,7 +14511,7 @@

PartitionServiceUpdat

- + @@ -14532,7 +14532,7 @@

PartitionServiceUpdat

- @@ -14551,7 +14551,7 @@

PartitionServiceUpdat

PartitionServiceUpdateResponse

-

PartitionServiceUpdateResponse is the response payload for a partition update request

+

PartitionServiceUpdateResponse is the response payload for a partition update request.

partition metalstack.api.v2.Partition

Partition contains the deleted partition

Partition contains the deleted partition.

update_meta metalstack.api.v2.UpdateMeta

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.

boot_configuration metalstack.api.v2.PartitionBootConfiguration

PartitionBootConfiguration defines how metal-hammer boots

PartitionBootConfiguration defines how metal-hammer boots.

mgmt_service_addresses string repeated

ManagementServiceAddresses defines where the management is reachable +

ManagementServiceAddresses defines where the management is reachable. must be in the form <ip|host>:<port>

@@ -14629,7 +14629,7 @@

metalstack/api/v2/project.proto

Project -

Project defines a group of resources belonging to a tenant

a tenant can have multiple projects

+

Project defines a group of resources belonging to a tenant.

a tenant can have multiple projects

@@ -14688,7 +14688,7 @@

Project

ProjectInvite

-

ProjectInvite defines invite to project

+

ProjectInvite defines invite to project.

@@ -14701,49 +14701,49 @@

ProjectInvite

 - + - + - + - + - + - + - + @@ -14768,7 +14768,7 @@

ProjectInvite

ProjectMember

-

ProjectMember defines a user that participates in a project

+

ProjectMember defines a user that participates in a project.

secret string

Secret is the secret part of the invite, typically part of the url

Secret is the secret part of the invite, typically part of the url.

project string

Project is the project id for which this invite was created

Project is the project id for which this invite was created.

role ProjectRole

Role is the role in this project the user will get after accepting the invitation

Role is the role in this project the user will get after accepting the invitation.

joined bool

Joined is false as long as a user has not accepted the invite

Joined is false as long as a user has not accepted the invite.

project_name string

ProjectName is the project name for which this invite was created

ProjectName is the project name for which this invite was created.

tenant string

Tenant is the login of the tenant inviting another user 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 the tenant inviting another user to join this project

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

@@ -14781,14 +14781,14 @@

ProjectMember

 - + - + @@ -14822,7 +14822,7 @@

ProjectMember

ProjectQuery

-

ProjectQuery is used to search projects

+

ProjectQuery is used to search projects.

id string

Id is the user id of the member

Id is the user id of the member.

role ProjectRole

Role is the role of the member

Role is the role of the member.

@@ -14835,28 +14835,28 @@

ProjectQuery

 - + - + - + - + @@ -14867,7 +14867,7 @@

ProjectQuery

ProjectServiceAddMemberRequest

-

ProjectServiceAddMemberRequest is the request payload for adding a member to a project

+

ProjectServiceAddMemberRequest is the request payload for adding a member to a project.

uuid string optional

Uuid lists only projects with this uuid

Uuid lists only projects with this uuid.

name string optional

Name lists only projects with this name

Name lists only projects with this name.

tenant string optional

Tenant lists only projects of this tenant

Tenant lists only projects of this tenant.

labels Labels optional

Labels lists only projects containing the given labels

Labels lists only projects containing the given labels.

@@ -14880,7 +14880,7 @@

ProjectServiceAddMembe

- + @@ -14905,7 +14905,7 @@

ProjectServiceAddMembe

ProjectServiceAddMemberResponse

-

ProjectServiceAddMemberResponse is the response payload for the add member request

+

ProjectServiceAddMemberResponse is the response payload for the add member request.

project string

Project is the uuid of the project

Project is the uuid of the project.

@@ -14918,7 +14918,7 @@

ProjectServiceAddMemb

- + @@ -14929,7 +14929,7 @@

ProjectServiceAddMemb

ProjectServiceCreateRequest

-

ProjectServiceCreateRequest is the request payload to Create a project

+

ProjectServiceCreateRequest is the request payload to Create a project.

project_member ProjectRole

ProjectRole is the added project member

ProjectRole is the added project member.

@@ -14942,7 +14942,7 @@

ProjectServiceCreateReque

- @@ -14982,7 +14982,7 @@

ProjectServiceCreateReque

ProjectServiceCreateResponse

-

ProjectServiceCreateResponse is the response payload of creation of a project

+

ProjectServiceCreateResponse is the response payload of creation of a project.

login string

Login is the tenant of this project +

Login is the tenant of this project. TODO: is login really a good name?

@@ -14995,7 +14995,7 @@

ProjectServiceCreateResp

- + @@ -15006,7 +15006,7 @@

ProjectServiceCreateResp

ProjectServiceDeleteRequest

-

ProjectServiceDeleteRequest is the request payload to delete a project

+

ProjectServiceDeleteRequest is the request payload to delete a project.

project Project

Project is the project

Project is the project.

@@ -15019,7 +15019,7 @@

ProjectServiceDeleteReque

- + @@ -15030,7 +15030,7 @@

ProjectServiceDeleteReque

ProjectServiceDeleteResponse

-

ProjectServiceDeleteResponse is the response payload to delete a project

+

ProjectServiceDeleteResponse is the response payload to delete a project.

project string

Project is the uuid of the project to delete

Project is the uuid of the project to delete.

@@ -15043,7 +15043,7 @@

ProjectServiceDeleteResp

- + @@ -15054,7 +15054,7 @@

ProjectServiceDeleteResp

ProjectServiceGetRequest

-

ProjectServiceGetRequest is the request payload to get a project

+

ProjectServiceGetRequest is the request payload to get a project.

project Project

Project is the project

Project is the project.

@@ -15067,7 +15067,7 @@

ProjectServiceGetRequest

project - + @@ -15078,7 +15078,7 @@

ProjectServiceGetRequest

ProjectServiceGetResponse -

ProjectServiceGetResponse is the response payload to get a projects

+

ProjectServiceGetResponse is the response payload to get a projects.

string

Project is the uuid of the project to get

Project is the uuid of the project to get.

@@ -15091,7 +15091,7 @@

ProjectServiceGetResponseproject

- + @@ -15109,7 +15109,7 @@

ProjectServiceGetResponseProjectServiceInviteAcceptRequest

-

ProjectServiceInviteAcceptRequest is the request payload to a accept invite request

+

ProjectServiceInviteAcceptRequest is the request payload to a accept invite request.

Project

Project is the project

Project is the project.

@@ -15122,7 +15122,7 @@

ProjectServiceInvit

- + @@ -15133,7 +15133,7 @@

ProjectServiceInvit

ProjectServiceInviteAcceptResponse

-

ProjectServiceInviteAcceptResponse is the response payload to a accept invite request

+

ProjectServiceInviteAcceptResponse is the response payload to a accept invite request.

secret string

Secret is the invitation secret part of the invitation url

Secret is the invitation secret part of the invitation url.

@@ -15164,7 +15164,7 @@

ProjectServiceInvi

ProjectServiceInviteDeleteRequest

-

ProjectServiceInviteDeleteRequest is the request payload to a delete invite

+

ProjectServiceInviteDeleteRequest is the request payload to a delete invite.

@@ -15177,7 +15177,7 @@

ProjectServiceInvit

- + @@ -15195,14 +15195,14 @@

ProjectServiceInvit

ProjectServiceInviteDeleteResponse

-

ProjectServiceInviteDeleteResponse is the response payload of a delete invite request

+

ProjectServiceInviteDeleteResponse is the response payload of a delete invite request.

ProjectServiceInviteGetRequest

-

ProjectServiceInviteGetRequest is the request payload to get a invite

+

ProjectServiceInviteGetRequest is the request payload to get a invite.

project string

Project is the uuid of the project

Project is the uuid of the project.

@@ -15226,7 +15226,7 @@

ProjectServiceInviteGe

ProjectServiceInviteGetResponse

-

ProjectServiceInviteGetResponse is the response payload to a get invite request

+

ProjectServiceInviteGetResponse is the response payload to a get invite request.

@@ -15239,7 +15239,7 @@

ProjectServiceInviteG

- + @@ -15250,7 +15250,7 @@

ProjectServiceInviteG

ProjectServiceInviteRequest

-

ProjectServiceInviteRequest is used to invite a member to a project

+

ProjectServiceInviteRequest is used to invite a member to a project.

invite ProjectInvite

Invite is the invite

Invite is the invite.

@@ -15263,7 +15263,7 @@

ProjectServiceInviteReque

- + @@ -15281,7 +15281,7 @@

ProjectServiceInviteReque

ProjectServiceInviteResponse

-

ProjectServiceInviteResponse is the response payload to a invite member request

+

ProjectServiceInviteResponse is the response payload to a invite member request.

project string

Project is the uuid of the project

Project is the uuid of the project.

@@ -15294,7 +15294,7 @@

ProjectServiceInviteResp

- @@ -15307,7 +15307,7 @@

ProjectServiceInviteResp

ProjectServiceInvitesListRequest

-

ProjectServiceInvitesListRequest is the request payload to a list invites request

+

ProjectServiceInvitesListRequest is the request payload to a list invites request.

invite ProjectInvite

Inviter contains a secret which can be sent to a potential user +

Inviter contains a secret which can be sent to a potential user. can be appended to the invitation endpoint at our cloud console like console.metalstack.cloud/invite/<secret>

@@ -15320,7 +15320,7 @@

ProjectServiceInvite

- + @@ -15331,7 +15331,7 @@

ProjectServiceInvite

ProjectServiceInvitesListResponse

-

ProjectServiceInvitesListResponse is the response payload to a list invites request

+

ProjectServiceInvitesListResponse is the response payload to a list invites request.

project string

Project is the uuid of the project

Project is the uuid of the project.

@@ -15355,7 +15355,7 @@

ProjectServiceInvit

ProjectServiceLeaveRequest

-

ProjectServiceLeaveRequest is used to leave a project

+

ProjectServiceLeaveRequest is used to leave a project.

@@ -15368,7 +15368,7 @@

ProjectServiceLeaveRequest

- + @@ -15379,14 +15379,14 @@

ProjectServiceLeaveRequest

ProjectServiceLeaveResponse

-

ProjectServiceLeaveResponse is the response payload to a leave project request

+

ProjectServiceLeaveResponse is the response payload to a leave project request.

ProjectServiceListRequest

-

ProjectServiceListRequest is the request payload to list all projects

+

ProjectServiceListRequest is the request payload to list all projects.

project string

Project is the uuid of the project

Project is the uuid of the project.

@@ -15399,7 +15399,7 @@

ProjectServiceListRequestquery

- + @@ -15410,7 +15410,7 @@

ProjectServiceListRequestProjectServiceListResponse

-

ProjectServiceListResponse is the response payload to list all projects

+

ProjectServiceListResponse is the response payload to list all projects.

ProjectQuery

Query for projects

Query for projects.

@@ -15423,7 +15423,7 @@

ProjectServiceListResponse

- + @@ -15434,7 +15434,7 @@

ProjectServiceListResponse

ProjectServiceRemoveMemberRequest

-

ProjectServiceRemoveMemberRequest is used to remove a member from a project

+

ProjectServiceRemoveMemberRequest is used to remove a member from a project.

projects Project repeated

Projects is a list of all your projects

Projects is a list of all your projects.

@@ -15447,14 +15447,14 @@

ProjectServiceRemov

- + - + @@ -15465,14 +15465,14 @@

ProjectServiceRemov

ProjectServiceRemoveMemberResponse

-

ProjectServiceRemoveMemberResponse is the response payload to a remove member request

+

ProjectServiceRemoveMemberResponse is the response payload to a remove member request.

ProjectServiceUpdateMemberRequest

-

ProjectServiceUpdateMemberRequest is used to update a member of a project

+

ProjectServiceUpdateMemberRequest is used to update a member of a project.

project string

Project is the uuid of the project

Project is the uuid of the project.

member string

Member is the id of the member to remove from this project

Member is the id of the member to remove from this project.

@@ -15485,21 +15485,21 @@

ProjectServiceUpdat

- + - + - + @@ -15510,7 +15510,7 @@

ProjectServiceUpdat

ProjectServiceUpdateMemberResponse

-

ProjectServiceUpdateMemberResponse is the response payload to a update member request

+

ProjectServiceUpdateMemberResponse is the response payload to a update member request.

project string

Project is the uuid of the project

Project is the uuid of the project.

member string

Member is the id of the member to remove from this project

Member is the id of the member to remove from this project.

role ProjectRole

Role is the role in this project the user will get after the update

Role is the role in this project the user will get after the update.

@@ -15523,7 +15523,7 @@

ProjectServiceUpda

- + @@ -15534,7 +15534,7 @@

ProjectServiceUpda

ProjectServiceUpdateRequest

-

ProjectServiceUpdateRequest is the request payload to update a project

+

ProjectServiceUpdateRequest is the request payload to update a project.

project_member ProjectMember

ProjectMember is the updated project member

ProjectMember is the updated project member.

@@ -15547,14 +15547,14 @@

ProjectServiceUpdateReque

- + - + @@ -15593,7 +15593,7 @@

ProjectServiceUpdateReque

ProjectServiceUpdateResponse

-

ProjectServiceUpdateResponse is the response payload to update a project

+

ProjectServiceUpdateResponse is the response payload to update a project.

project string

Project is the uuid of the project to get

Project is the uuid of the project to get.

update_meta UpdateMeta

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.

@@ -15606,7 +15606,7 @@

ProjectServiceUpdateResp

- + @@ -15648,77 +15648,77 @@

ProjectService

 - + - + - + - + - + - + - + - + - + - + - + @@ -15754,7 +15754,7 @@

ProjectServiceListRequest

- + @@ -15778,7 +15778,7 @@

ProjectServiceListRespon

- + @@ -15835,7 +15835,7 @@

SizeServiceCreateRequestsize

- + @@ -15859,7 +15859,7 @@

SizeServiceCreateResponse

- + @@ -15907,7 +15907,7 @@

SizeServiceDeleteResponse

- + @@ -15938,7 +15938,7 @@

SizeServiceUpdateRequestupdate_meta

- + @@ -15990,7 +15990,7 @@

SizeServiceUpdateResponse

- + @@ -16048,7 +16048,7 @@

metalstack/api/v2/size_ima

ImageConstraint

-

ImageConstraint defines a constraint for an image

examples:

images:

ubuntu: ">= 20.04.20211011"

debian: ">= 10.0.20210101"

+

ImageConstraint defines a constraint for an image.

examples:

images:

ubuntu: ">= 20.04.20211011"

debian: ">= 10.0.20210101"

project Project

Project is the project

Project is the project.

Create ProjectServiceCreateRequest ProjectServiceCreateResponse

Create a project

Create a project.
Delete ProjectServiceDeleteRequest ProjectServiceDeleteResponse

Delete a project

Delete a project.
Update ProjectServiceUpdateRequest ProjectServiceUpdateResponse

Update a project

Update a project.
Leave ProjectServiceLeaveRequest ProjectServiceLeaveResponse

Leave project

Leave project.
AddMember ProjectServiceAddMemberRequest ProjectServiceAddMemberResponse

AddMember adds a user to a project

AddMember adds a user to a project.
RemoveMember ProjectServiceRemoveMemberRequest ProjectServiceRemoveMemberResponse

RemoveMember removes a user from a project

RemoveMember removes a user from a project.
UpdateMember ProjectServiceUpdateMemberRequest ProjectServiceUpdateMemberResponse

UpdateMember updates a user for a project

UpdateMember updates a user for a project.
Invite ProjectServiceInviteRequest ProjectServiceInviteResponse

Invite a user to a project

Invite a user to a project.
InviteAccept ProjectServiceInviteAcceptRequest ProjectServiceInviteAcceptResponse

InviteAccept is called by a user to accept an invitation

InviteAccept is called by a user to accept an invitation.
InviteDelete ProjectServiceInviteDeleteRequest ProjectServiceInviteDeleteResponse

InviteDelete deletes a pending invitation

InviteDelete deletes a pending invitation.
InvitesList ProjectServiceInvitesListRequest ProjectServiceInvitesListResponse

InvitesList list all invites to a project

InvitesList list all invites to a project.
query metalstack.api.v2.ProjectQuery optional

Query for projects

Query for projects.

projects metalstack.api.v2.Project repeated

Projects contains the list of projects

Projects contains the list of projects.

metalstack.api.v2.Size

Size is the size to create

Size is the size to create.

size metalstack.api.v2.Size

Size contains the created size

Size contains the created size.

size metalstack.api.v2.Size

Size contains the deleted size

Size contains the deleted size.

metalstack.api.v2.UpdateMeta

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.

size metalstack.api.v2.Size

Size contains the updated size

Size contains the updated size.

@@ -16079,7 +16079,7 @@

ImageConstraint

SizeImageConstraint

-

SizeImageConstraint expresses optional restrictions for specific size to image combinations

this might be required if the support for a specific hardware in a given size is only supported

with a newer version of the image.

If the size in question is not found, no restrictions apply.

If the image in question is not found, no restrictions apply as well.

If the image in question is found, but does not match the given expression, machine creation must be forbidden.

+

SizeImageConstraint expresses optional restrictions for specific size to image combinations.

this might be required if the support for a specific hardware in a given size is only supported

with a newer version of the image.

If the size in question is not found, no restrictions apply.

If the image in question is not found, no restrictions apply as well.

If the image in question is found, but does not match the given expression, machine creation must be forbidden.

@@ -16092,7 +16092,7 @@

SizeImageConstraint

 - + @@ -16131,7 +16131,7 @@

SizeImageConstraint

SizeImageConstraintQuery

-

SizeImageConstraintQuery is used to search size image constraints

+

SizeImageConstraintQuery is used to search size image constraints.

size string

Size where this constraint should apply

Size where this constraint should apply.

@@ -16169,7 +16169,7 @@

SizeImageConstraintQuery

SizeImageConstraintServiceTryRequest -

SizeImageConstraintServiceTryRequest is the request payload for a size image constraint try request

+

SizeImageConstraintServiceTryRequest is the request payload for a size image constraint try request.

@@ -16200,7 +16200,7 @@

SizeImageConstra

SizeImageConstraintServiceTryResponse

-

SizeImageConstraintServiceTryResponse is the response payload for a size image constraint try request

+

SizeImageConstraintServiceTryResponse is the response payload for a size image constraint try request.

@@ -16305,7 +16305,7 @@

SizeImageC

- + @@ -16353,7 +16353,7 @@

SizeImageC

- + @@ -16401,7 +16401,7 @@

SizeImageCons

- + @@ -16425,7 +16425,7 @@

SizeImageCons

- + @@ -16449,7 +16449,7 @@

SizeImageCon

- + @@ -16480,7 +16480,7 @@

SizeImageCo

- + @@ -16525,7 +16525,7 @@

SizeImageC

- + @@ -16670,7 +16670,7 @@

SizeReservation

SizeReservationQuery

-

SizeReservationQuery is used to search size reservations

+

SizeReservationQuery is used to search size reservations.

size_image_constraint metalstack.api.v2.SizeImageConstraint

SizeImageConstraint contains the created constraint

SizeImageConstraint contains the created constraint.

size_image_constraint metalstack.api.v2.SizeImageConstraint

SizeImageConstraint contains the deleted constraint

SizeImageConstraint contains the deleted constraint.

size_image_constraint metalstack.api.v2.SizeImageConstraint

SizeImageConstraint contains the retrieved constraint

SizeImageConstraint contains the retrieved constraint.

query metalstack.api.v2.SizeImageConstraintQuery

Query for size image constraints

Query for size image constraints.

size_image_constraints metalstack.api.v2.SizeImageConstraint repeated

SizeImageConstraints contains the list of constraints

SizeImageConstraints contains the list of constraints.

update_meta metalstack.api.v2.UpdateMeta

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.

size_image_constraint metalstack.api.v2.SizeImageConstraint

SizeImageConstraint contains the updated constraint

SizeImageConstraint contains the updated constraint.

@@ -16725,7 +16725,7 @@

SizeReservationQuery

 - + @@ -16736,7 +16736,7 @@

SizeReservationQuery

SizeReservationServiceGetRequest

-

SizeReservationServiceGetRequest is the request payload for a size get request

+

SizeReservationServiceGetRequest is the request payload for a size get request.

labels Labels optional

Labels lists only size reservations containing the given labels

Labels lists only size reservations containing the given labels.

@@ -16767,7 +16767,7 @@

SizeReservationServi

SizeReservationServiceGetResponse

-

SizeReservationServiceGetResponse is the response payload for a size reservation get request

+

SizeReservationServiceGetResponse is the response payload for a size reservation get request.

@@ -16791,7 +16791,7 @@

SizeReservationServ

SizeReservationServiceListRequest

-

SizeReservationServiceListRequest is the request payload for a size list request

+

SizeReservationServiceListRequest is the request payload for a size list request.

@@ -16811,7 +16811,7 @@

SizeReservationServ

- + @@ -16822,7 +16822,7 @@

SizeReservationServ

SizeReservationServiceListResponse

-

SizeReservationServiceListResponse is the response payload for a size reservation list request

+

SizeReservationServiceListResponse is the response payload for a size reservation list request.

query SizeReservationQuery

Query for size reservations

Query for size reservations.

@@ -16899,7 +16899,7 @@

SizeReservation

- + @@ -16923,7 +16923,7 @@

SizeReservatio

- + @@ -16971,7 +16971,7 @@

SizeReservatio

- + @@ -16995,7 +16995,7 @@

SizeReservationSe

- + @@ -17019,7 +17019,7 @@

SizeReservationS

- + @@ -17064,7 +17064,7 @@

SizeReservation

- + @@ -17109,7 +17109,7 @@

SizeReservatio

- + @@ -17943,7 +17943,7 @@

SwitchService

- + @@ -17974,7 +17974,7 @@

SwitchServic

- + @@ -18005,7 +18005,7 @@

SwitchServiceDeleteReque

- + @@ -18029,7 +18029,7 @@

SwitchServiceDeleteResp

- + @@ -18077,7 +18077,7 @@

SwitchServiceGetResponseswitch

- + @@ -18101,7 +18101,7 @@

SwitchServiceListRequestquery

- + @@ -18149,14 +18149,14 @@

SwitchServiceMigrateReq

- + - + @@ -18180,7 +18180,7 @@

SwitchServiceMigrateRe

- + @@ -18273,15 +18273,15 @@

SwitchServiceUpdateReque

- + - + @@ -18295,42 +18295,42 @@

SwitchServiceUpdateReque

- + - + - + - + - + - + @@ -18354,7 +18354,7 @@

SwitchServiceUpdateResp

- + @@ -18453,63 +18453,63 @@

TaskInfo

 - + - + - + - + - + - + - + - + - @@ -18517,33 +18517,33 @@

TaskInfo

 - + - + - +Empty string (default) indicates task does not belong to any groups, and no aggregation will be applied to the task.

- @@ -18551,34 +18551,34 @@

TaskInfo

 - +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.

- + - + - @@ -18603,14 +18603,14 @@

TaskServiceDeleteRequesttask_id

- + - + @@ -18641,14 +18641,14 @@

TaskServiceGetRequest

 - + - + @@ -18672,7 +18672,7 @@

TaskServiceGetResponse

 - + @@ -18696,22 +18696,22 @@

TaskServiceListRequest

 - + - + - + @@ -18735,7 +18735,7 @@

TaskServiceListResponse

tasks - + @@ -18789,49 +18789,49 @@

TaskState

 - + - + - + - + - + - + - + - + @@ -18890,7 +18890,7 @@

metalstack/api/v2/tenant.proto

Tenant -

Tenant is a customer of the platform

+

Tenant is a customer of the platform.

size_reservation metalstack.api.v2.SizeReservation

SizeReservation is the size reservation to create

SizeReservation is the size reservation to create.

size_reservation metalstack.api.v2.SizeReservation

SizeReservation contains the created reservation

SizeReservation contains the created reservation.

size_reservation metalstack.api.v2.SizeReservation

SizeReservation contains the deleted reservation

SizeReservation contains the deleted reservation.

query metalstack.api.v2.SizeReservationQuery

Query for size reservations

Query for size reservations.

size_reservations metalstack.api.v2.SizeReservation repeated

SizeReservations contains the list of reservations

SizeReservations contains the list of reservations.

update_meta metalstack.api.v2.UpdateMeta

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.

size_reservation metalstack.api.v2.SizeReservation

SizeReservation contains the updated reservation

SizeReservation contains the updated reservation.

query metalstack.api.v2.SwitchQuery

Query to filter the switch results

Query to filter the switch results.

switches_with_machines metalstack.api.v2.SwitchWithMachines repeated

SwitchesWithMachines contains all switches with their machine connections

SwitchesWithMachines contains all switches with their machine connections.

force bool

Force will allow switch deletion despite existing machine connections

Force will allow switch deletion despite existing machine connections.

switch metalstack.api.v2.Switch

Switch contains the deleted switch

Switch contains the deleted switch.

metalstack.api.v2.Switch

Switch contains the requested switch

Switch contains the requested switch.

metalstack.api.v2.SwitchQuery

Query to filter the results

Query to filter the results.

old_switch string

OldSwitch is the switch to migrate away from

OldSwitch is the switch to migrate away from.

new_switch string

NewSwitch is the switch to migrate to

NewSwitch is the switch to migrate to.

switch metalstack.api.v2.Switch

Switch contains the switch that was migrated to

Switch contains the switch that was migrated to.

update_meta metalstack.api.v2.UpdateMeta

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.

updated_at google.protobuf.Timestamp

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.

replace_mode metalstack.api.v2.SwitchReplaceMode optional

ReplaceMode is used to mark a switch ready for replacement

ReplaceMode is used to mark a switch ready for replacement.

management_ip string optional

ManagementIp is the switch's IP for management access

ManagementIp is the switch's IP for management access.

management_user string optional

ManagementUser is the user name to use for management access

ManagementUser is the user name to use for management access.

console_command string optional

ConsoleCommand is the command for accessing the switch's console

ConsoleCommand is the command for accessing the switch's console.

nics metalstack.api.v2.SwitchNic repeated

Nics are the front panel ports of the switch

Nics are the front panel ports of the switch.

os metalstack.api.v2.SwitchOS optional

SwitchOs is the OS running on the switch

SwitchOs is the OS running on the switch.

switch metalstack.api.v2.Switch

Switch contains the updated switch

Switch contains the updated switch.

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 of the last failure if any +

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 -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 +

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 -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 +

Result holds the result data associated with the task. Use ResultWriter to write result data from the Handler

string

TaskId is the identifier of the task to cancel

TaskId is the identifier of the task to cancel.

queue string

Queue is the queue where this task was scheduled to

Queue is the queue where this task was scheduled to.

task_id string

TaskId is the identifier of the task to get

TaskId is the identifier of the task to get.

queue string

Queue is the queue where this task was scheduled to

Queue is the queue where this task was scheduled to.

task TaskInfo

Task contains the task details

Task contains the task details.

queue string optional

Queue filters tasks by this queue -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 is the number of tasks to return

Count is the number of tasks to return.

page uint32 optional

Page is the page of tasks to return

Page is the page of tasks to return.

TaskInfo repeated

Tasks contains the list of requested tasks

Tasks contains the list of requested tasks.

TASK_STATE_UNSPECIFIED 0

TASK_STATE_UNSPECIFIED is not specified

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 is 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.
@@ -18956,7 +18956,7 @@

Tenant

TenantInvite

-

TenantInvite defines invite to tenant

+

TenantInvite defines invite to tenant.

@@ -18969,49 +18969,49 @@

TenantInvite

 - + - + - + - + - + - + - + @@ -19036,7 +19036,7 @@

TenantInvite

TenantMember

-

TenantMember defines a user that participates in a tenant

+

TenantMember defines a user that participates in a tenant.

secret string

Secret is the secret part of the invite, typically part of the url

Secret is the secret part of the invite, typically part of the url.

target_tenant string

TargetTenant is the tenant id for which this invite was created

TargetTenant is the tenant id for which this invite was created.

role TenantRole

Role is the role in this tenant the user will get after accepting the invitation

Role is the role in this tenant the user will get after accepting the invitation.

joined bool

Joined is false as long as a user has not accepted the invite

Joined is false as long as a user has not accepted the invite.

target_tenant_name string

TargetTenantName is the tenant name for which this invite was created

TargetTenantName is the tenant name for which this invite was created.

tenant string

Tenant is the login of the tenant inviting another user 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 the tenant inviting another user to join this tenant

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

@@ -19049,14 +19049,14 @@

TenantMember

 - + - + @@ -19088,7 +19088,7 @@

TenantMember

TenantQuery

-

TenantQuery is used to search tenants

+

TenantQuery is used to search tenants.

id string

Id is the user id of the member

Id is the user id of the member.

role TenantRole

Role is the role of the member

Role is the role of the member.

@@ -19101,28 +19101,28 @@

TenantQuery

 - + - + - + - + @@ -19133,7 +19133,7 @@

TenantQuery

TenantServiceAddMemberRequest

-

TenantServiceAddMemberRequest is the request payload for adding a member to a tenant

+

TenantServiceAddMemberRequest is the request payload for adding a member to a tenant.

login string optional

Id filters tenants by login

Id filters tenants by login.

name string optional

Name filters tenants by name

Name filters tenants by name.

labels Labels optional

Labels lists only projects containing the given labels

Labels lists only projects containing the given labels.

paging Paging

Paging details for the list request

Paging details for the list request.

@@ -19171,7 +19171,7 @@

TenantServiceAddMemberR

TenantServiceAddMemberResponse

-

TenantServiceAddMemberResponse is the response payload for the add member request

+

TenantServiceAddMemberResponse is the response payload for the add member request.

@@ -19184,7 +19184,7 @@

TenantServiceAddMember

- + @@ -19195,7 +19195,7 @@

TenantServiceAddMember

TenantServiceCreateRequest

-

TenantServiceCreateRequest is the request payload of the tenant create request

+

TenantServiceCreateRequest is the request payload of the tenant create request.

tenant_member TenantMember

TenantMember is the added tenant member

TenantMember is the added tenant member.

@@ -19247,7 +19247,7 @@

TenantServiceCreateRequest

TenantServiceCreateResponse

-

TenantServiceCreateResponse is the response payload of the tenant create request

+

TenantServiceCreateResponse is the response payload of the tenant create request.

@@ -19260,7 +19260,7 @@

TenantServiceCreateRespon

- + @@ -19271,7 +19271,7 @@

TenantServiceCreateRespon

TenantServiceDeleteRequest

-

TenantServiceDeleteRequest is the request payload of the tenant delete request

+

TenantServiceDeleteRequest is the request payload of the tenant delete request.

tenant Tenant

Tenant is the tenant

Tenant is the tenant.

@@ -19295,7 +19295,7 @@

TenantServiceDeleteRequest

TenantServiceDeleteResponse

-

TenantServiceDeleteResponse is the response payload of the tenant delete request

+

TenantServiceDeleteResponse is the response payload of the tenant delete request.

@@ -19308,7 +19308,7 @@

TenantServiceDeleteRespon

- + @@ -19319,7 +19319,7 @@

TenantServiceDeleteRespon

TenantServiceGetRequest

-

TenantServiceGetRequest is the request payload of the tenant get request

+

TenantServiceGetRequest is the request payload of the tenant get request.

tenant Tenant

Tenant is the tenant

Tenant is the tenant.

@@ -19343,7 +19343,7 @@

TenantServiceGetRequest

TenantServiceGetResponse

-

TenantServiceGetResponse is the response payload of the tenant get request

+

TenantServiceGetResponse is the response payload of the tenant get request.

@@ -19356,7 +19356,7 @@

TenantServiceGetResponse

tenant - + @@ -19374,7 +19374,7 @@

TenantServiceGetResponse

TenantServiceInviteAcceptRequest -

TenantServiceInviteAcceptRequest is the request payload to a accept invite request

+

TenantServiceInviteAcceptRequest is the request payload to a accept invite request.

Tenant

Tenant is the tenant

Tenant is the tenant.

@@ -19387,7 +19387,7 @@

TenantServiceInviteA

- + @@ -19398,7 +19398,7 @@

TenantServiceInviteA

TenantServiceInviteAcceptResponse

-

TenantServiceInviteAcceptResponse is the response payload to a accept invite request

+

TenantServiceInviteAcceptResponse is the response payload to a accept invite request.

secret string

Secret is the invitation secret part of the invitation url

Secret is the invitation secret part of the invitation url.

@@ -19429,7 +19429,7 @@

TenantServiceInvite

TenantServiceInviteDeleteRequest

-

TenantServiceInviteDeleteRequest is the request payload to a delete invite

+

TenantServiceInviteDeleteRequest is the request payload to a delete invite.

@@ -19460,14 +19460,14 @@

TenantServiceInviteD

TenantServiceInviteDeleteResponse

-

TenantServiceInviteDeleteResponse is the response payload of a delete invite request

+

TenantServiceInviteDeleteResponse is the response payload of a delete invite request.

TenantServiceInviteGetRequest

-

TenantServiceInviteGetRequest is the request payload to get a invite

+

TenantServiceInviteGetRequest is the request payload to get a invite.

@@ -19491,7 +19491,7 @@

TenantServiceInviteGetR

TenantServiceInviteGetResponse

-

TenantServiceInviteGetResponse is the response payload to a get invite request

+

TenantServiceInviteGetResponse is the response payload to a get invite request.

@@ -19504,7 +19504,7 @@

TenantServiceInviteGet

- + @@ -19515,7 +19515,7 @@

TenantServiceInviteGet

TenantServiceInviteRequest

-

TenantServiceInviteRequest is used to invite a member to a tenant

+

TenantServiceInviteRequest is used to invite a member to a tenant.

invite TenantInvite

Invite is the invite

Invite is the invite.

@@ -19546,7 +19546,7 @@

TenantServiceInviteRequest

TenantServiceInviteResponse

-

TenantServiceInviteRequest is the response payload to a invite member request

+

TenantServiceInviteRequest is the response payload to a invite member request.

@@ -19559,7 +19559,7 @@

TenantServiceInviteRespon

- @@ -19572,7 +19572,7 @@

TenantServiceInviteRespon

TenantServiceInvitesListRequest

-

TenantServiceInvitesListRequest is the request payload to a list invites request

+

TenantServiceInvitesListRequest is the request payload to a list invites request.

invite TenantInvite

Invite contains a secret which can be sent to a potential user +

Invite contains a secret which can be sent to a potential user. can be appended to the invitation endpoint at our cloud console like console.metalstack.cloud/invite/<secret>

@@ -19596,7 +19596,7 @@

TenantServiceInvitesL

TenantServiceInvitesListResponse

-

TenantServiceInvitesListResponse is the response payload to a list invites request

+

TenantServiceInvitesListResponse is the response payload to a list invites request.

@@ -19620,7 +19620,7 @@

TenantServiceInvites

TenantServiceLeaveRequest

-

TenantServiceLeaveTenantRequest is used to leave a tenant

+

TenantServiceLeaveTenantRequest is used to leave a tenant.

@@ -19644,14 +19644,14 @@

TenantServiceLeaveRequestTenantServiceLeaveResponse

-

TenantServiceLeaveTenantResponse is the response payload to a leave tenant request

+

TenantServiceLeaveTenantResponse is the response payload to a leave tenant request.

TenantServiceListRequest

-

TenantServiceListRequest is the request payload of the tenant list request

+

TenantServiceListRequest is the request payload of the tenant list request.

@@ -19664,7 +19664,7 @@

TenantServiceListRequest

query - + @@ -19675,7 +19675,7 @@

TenantServiceListRequest

TenantServiceListResponse -

TenantServiceListResponse is the response payload of the tenant list request

+

TenantServiceListResponse is the response payload of the tenant list request.

TenantQuery

Query for tenants

Query for tenants.

@@ -19688,7 +19688,7 @@

TenantServiceListResponsetenants

- + @@ -19699,7 +19699,7 @@

TenantServiceListResponseTenantServiceRemoveMemberRequest

-

TenantServiceRemoveMemberRequest is used to remove a member from a tenant

+

TenantServiceRemoveMemberRequest is used to remove a member from a tenant.

Tenant repeated

Tenants is the list of tenants

Tenants is the list of tenants.

@@ -19719,7 +19719,7 @@

TenantServiceRemoveM

- + @@ -19730,7 +19730,7 @@

TenantServiceRemoveM

TenantServiceRemoveMemberResponse

-

TenantServiceRemoveMemberResponse is the response payload to a remove member request

+

TenantServiceRemoveMemberResponse is the response payload to a remove member request.

member string

Member is the id of the member to remove from this tenant

Member is the id of the member to remove from this tenant.

@@ -19743,7 +19743,7 @@

TenantServiceRemove

- + @@ -19754,7 +19754,7 @@

TenantServiceRemove

TenantServiceUpdateMemberRequest

-

TenantServiceUpdateMemberRequest is used to update a member from a tenant

+

TenantServiceUpdateMemberRequest is used to update a member from a tenant.

tenant_member TenantMember

TenantMember is the removed tenant member

TenantMember is the removed tenant member.

@@ -19774,7 +19774,7 @@

TenantServiceUpdateM

- + @@ -19792,7 +19792,7 @@

TenantServiceUpdateM

TenantServiceUpdateMemberResponse

-

TenantServiceUpdateMemberResponse is the response payload to a update member request

+

TenantServiceUpdateMemberResponse is the response payload to a update member request.

member string

Member is the id of the member to update in this tenant

Member is the id of the member to update in this tenant.

@@ -19805,7 +19805,7 @@

TenantServiceUpdate

- + @@ -19816,7 +19816,7 @@

TenantServiceUpdate

TenantServiceUpdateRequest

-

TenantServiceUpdateRequest is the request payload of the tenant update request

+

TenantServiceUpdateRequest is the request payload of the tenant update request.

tenant_member TenantMember

TenantMember is the updated membership

TenantMember is the updated membership.

@@ -19836,7 +19836,7 @@

TenantServiceUpdateRequest

- + @@ -19882,7 +19882,7 @@

TenantServiceUpdateRequest

TenantServiceUpdateResponse

-

TenantServiceUpdateResponse is the response payload of the tenant update request

+

TenantServiceUpdateResponse is the response payload of the tenant update request.

update_meta UpdateMeta

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.

@@ -19895,7 +19895,7 @@

TenantServiceUpdateRespon

- + @@ -19937,42 +19937,42 @@

TenantService

 - + - + - + - + - + - + @@ -19986,28 +19986,28 @@

TenantService

 - + - + - + - + @@ -20030,7 +20030,7 @@

metalstack/admin/v2/tenant.proto

<

TenantServiceAddMemberRequest

-

TenantServiceAddMemberRequest is the request payload for adding a member to a tenant

+

TenantServiceAddMemberRequest is the request payload for adding a member to a tenant.

tenant Tenant

Tenant is the tenant

Tenant is the tenant.

Get TenantServiceGetRequest TenantServiceGetResponse

Get a tenant

Get a tenant.
Update TenantServiceUpdateRequest TenantServiceUpdateResponse

Update a tenant

Update a tenant.
Delete TenantServiceDeleteRequest TenantServiceDeleteResponse

Delete a tenant

Delete a tenant.
Leave TenantServiceLeaveRequest TenantServiceLeaveResponse

Leave removes a member from a tenant

Leave removes a member from a tenant.
AddMember TenantServiceAddMemberRequest TenantServiceAddMemberResponse

AddMember adds a member to a tenant

AddMember adds a member to a tenant.
RemoveMember TenantServiceRemoveMemberRequest TenantServiceRemoveMemberResponse

RemoveMember removes a member from a tenant

RemoveMember removes a member from a tenant.
Invite TenantServiceInviteRequest TenantServiceInviteResponse

Invite a user to a tenant

Invite a user to a tenant.
InviteAccept TenantServiceInviteAcceptRequest TenantServiceInviteAcceptResponse

InviteAccept is called from a user to accept an invitation

InviteAccept is called from a user to accept an invitation.
InviteDelete TenantServiceInviteDeleteRequest TenantServiceInviteDeleteResponse

InviteDelete deletes a pending invitation

InviteDelete deletes a pending invitation.
InvitesList TenantServiceInvitesListRequest TenantServiceInvitesListResponse

InvitesList list all invites to a tenant

InvitesList list all invites to a tenant.
@@ -20068,7 +20068,7 @@

TenantServiceAddMembe

TenantServiceAddMemberResponse

-

TenantServiceAddMemberResponse is the response payload for the add member request

+

TenantServiceAddMemberResponse is the response payload for the add member request.

@@ -20081,7 +20081,7 @@

TenantServiceAddMemb

- + @@ -20157,7 +20157,7 @@

TenantServiceCreateResp

- + @@ -20181,7 +20181,7 @@

TenantServiceListRequestquery

- + @@ -20205,14 +20205,14 @@

TenantServiceListResponse

- + - + @@ -20223,7 +20223,7 @@

TenantServiceListResponse

TenantServiceRemoveMemberRequest

-

TenantServiceRemoveMemberRequest is the request payload for removing a member from a tenant

+

TenantServiceRemoveMemberRequest is the request payload for removing a member from a tenant.

tenant_member metalstack.api.v2.TenantMember

TenantMember is the added tenant member

TenantMember is the added tenant member.

tenant metalstack.api.v2.Tenant

Tenant contains the created tenant

Tenant contains the created tenant.

metalstack.api.v2.TenantQuery

Query for tenants

Query for tenants.

tenants metalstack.api.v2.Tenant repeated

Tenants contains 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.

@@ -20254,7 +20254,7 @@

TenantServiceRemov

TenantServiceRemoveMemberResponse

-

TenantServiceRemoveMemberResponse is the response payload for the remove member request

+

TenantServiceRemoveMemberResponse is the response payload for the remove member request.

@@ -20267,7 +20267,7 @@

TenantServiceRemo

- + @@ -20309,14 +20309,14 @@

TenantService

 - + - + @@ -20376,14 +20376,14 @@

TokenServiceCreateRespon

- + - + @@ -20407,7 +20407,7 @@

TokenServiceListRequest

query - + @@ -20431,7 +20431,7 @@

TokenServiceListResponsetokens

- + @@ -20455,14 +20455,14 @@

TokenServiceRevokeRequest

- + - + @@ -20576,7 +20576,7 @@

VPNNode

 - + @@ -20621,22 +20621,22 @@

VPNServiceAuthKeyRequestephemeral

- + - + - + @@ -20660,22 +20660,22 @@

VPNServiceAuthKeyResponse

- + - + - + @@ -20713,7 +20713,7 @@

VPNServiceListNodesReque

- + @@ -20801,7 +20801,7 @@

Health

 - + @@ -20832,7 +20832,7 @@

HealthServiceGetResponse

health - + @@ -20856,28 +20856,28 @@

HealthStatus

 - + - + - + - + @@ -20932,14 +20932,14 @@

PartitionHealth

 - + - + @@ -20962,7 +20962,7 @@

Service

 - + @@ -21103,7 +21103,7 @@

MethodServiceListResponsemethods

- + @@ -21134,42 +21134,42 @@

MethodServiceTok

- + - + - + - + - + - + @@ -21326,7 +21326,7 @@

User

 - + @@ -21399,7 +21399,7 @@

UserServiceGetResponse

 - + @@ -21456,8 +21456,8 @@

BMCCommandDoneRequest

 - + @@ -21495,14 +21495,14 @@

UpdateBMCInfoRequest

 - + - + @@ -21557,14 +21557,14 @@

UpdateBMCInfoResponse

 - + - + @@ -21588,7 +21588,7 @@

WaitForBMCCommandRequestpartition

- + @@ -21626,15 +21626,15 @@

WaitForBMCCommandResponse

- + - + @@ -21692,7 +21692,7 @@

metalstack/infra/v2/boot.proto

BootServiceBootRequest -

BootServiceBootRequest is called to get specified parameters to boot a machine with the given mac

+

BootServiceBootRequest is called to get specified parameters to boot a machine with the given mac.

tenant_member metalstack.api.v2.TenantMember

TenantMember is the removed tenant member

TenantMember is the removed tenant member.

AddMember TenantServiceAddMemberRequest TenantServiceAddMemberResponse

Add a member to a tenant

Add a member to a tenant.
RemoveMember TenantServiceRemoveMemberRequest TenantServiceRemoveMemberResponse

RemoveMember removes a member from a tenant

RemoveMember removes a member from a tenant.
token metalstack.api.v2.Token

Token contains the created token

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.

metalstack.api.v2.TokenQuery

Query for tokens

Query for tokens.

metalstack.api.v2.Token repeated

Tokens contains the list of tokens

Tokens contains the list of tokens.

uuid string

Uuid is the uuid of the token which should be revoked

Uuid is the uuid of the token which should be revoked.

user string

User is the id of the user for which the token should be revoked

User is the id of the user for which the token should be revoked.

online bool

Online indicates if this node is online

Online indicates if this node is online.

bool

Ephemeral defines if the authentication key should be ephemeral

Ephemeral defines if the authentication key should be ephemeral.

expires google.protobuf.Duration

Expires defines the duration after which the authentication key 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 an audit sink

Reason must be provided why access to the VPN is requested. +Reason is only forwarded to an audit sink.

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 authentication key should be ephemeral

Ephemeral defines if the authentication key should be ephemeral.

project string optional

Project filters nodes by this project

Project filters nodes by this project.

services HealthStatus repeated

Services contains the health of all individual services

Services contains the health of all individual services.

Health

Health contains the overall health of the system

Health contains the overall health of the system.

name Service

Name is the name of the service

Name is the name of the service.

status ServiceStatus

Status is the status of this service

Status is the status of this service.

message string

Message describes the reason for the unhealthy status if possible

Message describes the reason for the unhealthy status if possible.

partitions HealthStatus.PartitionsEntry repeated

Partitions describes the health of the service by partition

Partitions describes the health of the service by partition.

status ServiceStatus

Status is the health status of the service in this partition

Status is the health status of the service in this partition.

message string

Message describes the reason for the unhealthy status if possible

Message describes the reason for the unhealthy status if possible.

SERVICE_UNSPECIFIED 0

SERVICE_UNSPECIFIED is a unknown service

SERVICE_UNSPECIFIED is a unknown service.
string repeated

Methods is a list of methods public callable

Methods is a list of methods public callable.

permissions MethodPermission repeated

Permissions contains 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.

admin_role AdminRole optional

AdminRole defines the admin role of the token owner

AdminRole defines the admin role of the token owner.

infra_role InfraRole optional

InfraRole defines the infrastructure role of the token owner

InfraRole defines the infrastructure role of the token owner.

machine_roles MethodServiceTokenScopedListResponse.MachineRolesEntry repeated

MachineRoles defines the machine roles of the token owner

MachineRoles defines the machine roles of the token owner.

login string

Login is the login at the provider

Login is the login at the provider.

user User

User contains the authenticated user

User contains the authenticated user.

command_id string

CommandId is a unique ID which must be sent back after execution -It is usually in the form: <machine-uuid>:machine-bmc-command

CommandId is a unique ID which must be sent back after execution. +It is usually in the form: <machine-uuid>:machine-bmc-command.

partition string

Partition is 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 maps the BMC report per machine UUID

BmcReports maps the BMC report per machine UUID.

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.

string

Partition is the partition ID where metal-bmc wants to receive BMC commands

Partition is the partition ID where metal-bmc wants to receive BMC commands.

machine_bmc metalstack.api.v2.MachineBMC

MachineBmc contains connection details of the machine to issue the BMC command to

MachineBmc contains connection details of the machine to issue the BMC command to.

command_id 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>

CommandId is a unique ID which must be sent back after execution. +It is usually in the form: <machine-uuid>:machine-bmc-command:<command>.

@@ -21712,7 +21712,7 @@

BootServiceBootRequest

 - + @@ -21723,7 +21723,7 @@

BootServiceBootRequest

BootServiceBootResponse

-

BootServiceBootResponse contains additional infos which are required to boot a machine

+

BootServiceBootResponse contains additional infos which are required to boot a machine.

partition string

Partition where this machine is located

Partition where this machine is located.

@@ -21736,21 +21736,21 @@

BootServiceBootResponse

kernel - + - + - + @@ -21761,7 +21761,7 @@

BootServiceBootResponse

BootServiceDhcpRequest -

BootServiceDhcpRequest is called once a machine issues a dhcp request

+

BootServiceDhcpRequest is called once a machine issues a dhcp request.

string

Kernel is the url to the linux kernel to boot

Kernel is the url to the linux kernel to boot.

init_ram_disks string repeated

Initial ram disk is the url to the initial ram disk to boot

Initial ram disk is the url to the initial ram disk to boot.

cmdline string optional

CMDLine contains kernel command line parameters to boot

CMDLine contains kernel command line parameters to boot.

@@ -21781,7 +21781,7 @@

BootServiceDhcpRequest

 - + @@ -21792,14 +21792,14 @@

BootServiceDhcpRequest

BootServiceDhcpResponse

-

BootServiceDhcpResponse contains the response to a dhcp request

+

BootServiceDhcpResponse contains the response to a dhcp request.

BootServiceInstallationSucceededRequest

-

BootServiceInstallationSucceededRequest is sent from metal-hammer to the api to report the installation succeeded

+

BootServiceInstallationSucceededRequest is sent from metal-hammer to the api to report the installation succeeded.

partition string

Partition where this machine is located

Partition where this machine is located.

@@ -21830,14 +21830,14 @@

BootService

BootServiceInstallationSucceededResponse

-

BootServiceInstallationSucceededResponse is the response to a BootServiceInstallationSucceededRequest

+

BootServiceInstallationSucceededResponse is the response to a BootServiceInstallationSucceededRequest.

BootServiceRegisterRequest

-

BootServiceRegisterRequest is called from metal-hammer to register a machine with as much hardware details as possible

+

BootServiceRegisterRequest is called from metal-hammer to register a machine with as much hardware details as possible.

@@ -21892,14 +21892,14 @@

BootServiceRegisterReque

- + - + @@ -21930,7 +21930,7 @@

BootServiceRegisterResp

- + @@ -21992,7 +21992,7 @@

BootServiceSup

- + @@ -22003,7 +22003,7 @@

BootServiceSup

BootServiceWaitRequest

-

BootServiceWaitRequest is called when a machine was registered and is waiting for allocation

+

BootServiceWaitRequest is called when a machine was registered and is waiting for allocation.

metal_hammer_version string

MetalHammer version this machine was booted into

MetalHammer version this machine was booted into.

partition string

Partition where this machine is located

Partition where this machine is located.

size string

Size is the calculated size from given hardware details

Size is the calculated size from given hardware details.

super_user_password string

SuperUserPassword is the password of the superuser on the ipmi device

SuperUserPassword is the password of the superuser on the ipmi device.

@@ -22040,7 +22040,7 @@

BootServiceWaitResponse

allocation - + @@ -22132,21 +22132,21 @@

ComponentServicePingReq

- + - + - + @@ -22286,7 +22286,7 @@

EventServiceSendResponsefailed

- + @@ -22367,7 +22367,7 @@

SwitchServiceGetResponseswitch

- + @@ -22412,14 +22412,14 @@

SwitchServiceHeartbea

- + - + @@ -22512,14 +22512,14 @@

SwitchServiceHeartbe

- + - + @@ -22567,7 +22567,7 @@

SwitchServiceRegister

- + diff --git a/go/metalstack/admin/v2/adminv2connect/machine.connect.go b/go/metalstack/admin/v2/adminv2connect/machine.connect.go index 7f53ab1a..bcccad43 100644 --- a/go/metalstack/admin/v2/adminv2connect/machine.connect.go +++ b/go/metalstack/admin/v2/adminv2connect/machine.connect.go @@ -73,7 +73,7 @@ type MachineServiceClient interface { ConsolePassword(context.Context, *v2.MachineServiceConsolePasswordRequest) (*v2.MachineServiceConsolePasswordResponse, error) // SetState set the state of a machine. SetState(context.Context, *v2.MachineServiceSetStateRequest) (*v2.MachineServiceSetStateResponse, error) - // Issues allows to query issues of machines + // Issues allows to query issues of machines. Issues(context.Context, *v2.MachineServiceIssuesRequest) (*v2.MachineServiceIssuesResponse, error) } @@ -257,7 +257,7 @@ type MachineServiceHandler interface { ConsolePassword(context.Context, *v2.MachineServiceConsolePasswordRequest) (*v2.MachineServiceConsolePasswordResponse, error) // SetState set the state of a machine. SetState(context.Context, *v2.MachineServiceSetStateRequest) (*v2.MachineServiceSetStateResponse, error) - // Issues allows to query issues of machines + // Issues allows to query issues of machines. Issues(context.Context, *v2.MachineServiceIssuesRequest) (*v2.MachineServiceIssuesResponse, error) } diff --git a/go/metalstack/admin/v2/adminv2connect/tenant.connect.go b/go/metalstack/admin/v2/adminv2connect/tenant.connect.go index fc984eaa..13890a76 100644 --- a/go/metalstack/admin/v2/adminv2connect/tenant.connect.go +++ b/go/metalstack/admin/v2/adminv2connect/tenant.connect.go @@ -50,9 +50,9 @@ type TenantServiceClient interface { Create(context.Context, *v2.TenantServiceCreateRequest) (*v2.TenantServiceCreateResponse, error) // Returns the list of all tenants. List(context.Context, *v2.TenantServiceListRequest) (*v2.TenantServiceListResponse, error) - // Add a member to a tenant + // Add a member to a tenant. AddMember(context.Context, *v2.TenantServiceAddMemberRequest) (*v2.TenantServiceAddMemberResponse, error) - // RemoveMember removes a member from a tenant + // RemoveMember removes a member from a tenant. RemoveMember(context.Context, *v2.TenantServiceRemoveMemberRequest) (*v2.TenantServiceRemoveMemberResponse, error) } @@ -144,9 +144,9 @@ type TenantServiceHandler interface { Create(context.Context, *v2.TenantServiceCreateRequest) (*v2.TenantServiceCreateResponse, error) // Returns the list of all tenants. List(context.Context, *v2.TenantServiceListRequest) (*v2.TenantServiceListResponse, error) - // Add a member to a tenant + // Add a member to a tenant. AddMember(context.Context, *v2.TenantServiceAddMemberRequest) (*v2.TenantServiceAddMemberResponse, error) - // RemoveMember removes a member from a tenant + // RemoveMember removes a member from a tenant. RemoveMember(context.Context, *v2.TenantServiceRemoveMemberRequest) (*v2.TenantServiceRemoveMemberResponse, error) } diff --git a/go/metalstack/admin/v2/audit.pb.go b/go/metalstack/admin/v2/audit.pb.go index 1363b5ce..6e8a2b9e 100644 --- a/go/metalstack/admin/v2/audit.pb.go +++ b/go/metalstack/admin/v2/audit.pb.go @@ -26,7 +26,7 @@ const ( // AuditServiceListRequest is the request payload for listing audit traces. type AuditServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Query for audit traces + // Query for audit traces. Query *v2.AuditQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -72,7 +72,7 @@ func (x *AuditServiceListRequest) GetQuery() *v2.AuditQuery { // AuditServiceListResponse is the response payload for listing audit traces. type AuditServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Traces contains the 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 @@ -120,7 +120,7 @@ type AuditServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Uuid of the audit trace Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` - // Phase specifies the audit phase. Defaults to request + // Phase specifies the audit phase. Defaults to request. Phase *v2.AuditPhase `protobuf:"varint,2,opt,name=phase,proto3,enum=metalstack.api.v2.AuditPhase,oneof" json:"phase,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -173,7 +173,7 @@ func (x *AuditServiceGetRequest) GetPhase() v2.AuditPhase { // AuditServiceGetResponse is the response payload for getting an audit trace. type AuditServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Trace is the audit trace + // Trace is the audit trace. Trace *v2.AuditTrace `protobuf:"bytes,1,opt,name=trace,proto3" json:"trace,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/admin/v2/component.pb.go b/go/metalstack/admin/v2/component.pb.go index 106339dd..a7ebe5a9 100644 --- a/go/metalstack/admin/v2/component.pb.go +++ b/go/metalstack/admin/v2/component.pb.go @@ -26,7 +26,7 @@ const ( // ComponentServiceListRequest is the request payload for listing components. type ComponentServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Query filters components + // Query filters components. Query *v2.ComponentQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -72,7 +72,7 @@ func (x *ComponentServiceListRequest) GetQuery() *v2.ComponentQuery { // ComponentServiceListResponse is the response payload for listing components. type ComponentServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Components contains the list of 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 @@ -118,7 +118,7 @@ func (x *ComponentServiceListResponse) GetComponents() []*v2.Component { // ComponentServiceGetRequest is the request payload for getting a component. type ComponentServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // UUID identifies the component to get + // UUID identifies the component to get. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -164,7 +164,7 @@ func (x *ComponentServiceGetRequest) GetUuid() string { // ComponentServiceGetResponse is the response payload for getting a component. type ComponentServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Component contains the retrieved 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 @@ -210,7 +210,7 @@ func (x *ComponentServiceGetResponse) GetComponent() *v2.Component { // ComponentServiceDeleteRequest is the request payload for deleting a component. type ComponentServiceDeleteRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // UUID identifies the component to delete + // UUID identifies the component to delete. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -256,7 +256,7 @@ func (x *ComponentServiceDeleteRequest) GetUuid() string { // ComponentServiceDeleteResponse is the response payload for deleting a component. type ComponentServiceDeleteResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Component contains the deleted 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 d64aab44..c791c696 100644 --- a/go/metalstack/admin/v2/filesystem.pb.go +++ b/go/metalstack/admin/v2/filesystem.pb.go @@ -26,7 +26,7 @@ const ( // FilesystemServiceCreateRequest is the request payload for creating a filesystem. type FilesystemServiceCreateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // FilesystemLayout is the filesystem layout to create + // 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 @@ -72,7 +72,7 @@ func (x *FilesystemServiceCreateRequest) GetFilesystemLayout() *v2.FilesystemLay // FilesystemServiceCreateResponse is the response payload for creating a filesystem. type FilesystemServiceCreateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // FilesystemLayout contains the created filesystem layout + // 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 @@ -120,21 +120,21 @@ type FilesystemServiceUpdateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Id of this filesystemLayout 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"` // Name of this filesystemLayout Name *string `protobuf:"bytes,3,opt,name=name,proto3,oneof" json:"name,omitempty"` // Description of this filesystemLayout Description *string `protobuf:"bytes,4,opt,name=description,proto3,oneof" json:"description,omitempty"` - // Filesystems is a list of filesystems to create on a machine + // Filesystems is a list of filesystems to create on a machine. Filesystems []*v2.Filesystem `protobuf:"bytes,5,rep,name=filesystems,proto3" json:"filesystems,omitempty"` - // Disks list of disks that belong to this layout + // 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 []*v2.Raid `protobuf:"bytes,7,rep,name=raid,proto3" json:"raid,omitempty"` - // VolumeGroups list of volumegroups to create + // VolumeGroups list of volumegroups to create. VolumeGroups []*v2.VolumeGroup `protobuf:"bytes,8,rep,name=volume_groups,json=volumeGroups,proto3" json:"volume_groups,omitempty"` - // LogicalVolumes list of logicalvolumes to create + // LogicalVolumes list of logicalvolumes to create. LogicalVolumes []*v2.LogicalVolume `protobuf:"bytes,9,rep,name=logical_volumes,json=logicalVolumes,proto3" json:"logical_volumes,omitempty"` // Constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts Constraints *v2.FilesystemLayoutConstraints `protobuf:"bytes,10,opt,name=constraints,proto3" json:"constraints,omitempty"` @@ -245,7 +245,7 @@ func (x *FilesystemServiceUpdateRequest) GetConstraints() *v2.FilesystemLayoutCo // FilesystemServiceUpdateResponse is the response payload for updating a filesystem. type FilesystemServiceUpdateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // FilesystemLayout contains the updated filesystem layout + // 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 @@ -337,7 +337,7 @@ func (x *FilesystemServiceDeleteRequest) GetId() string { // FilesystemServiceDeleteResponse is the response payload for deleting a filesystem. type FilesystemServiceDeleteResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // FilesystemLayout contains the deleted filesystem layout + // 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 @@ -383,7 +383,7 @@ func (x *FilesystemServiceDeleteResponse) GetFilesystemLayout() *v2.FilesystemLa // FilesystemServiceMatchRequest type FilesystemServiceMatchRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Match size and image to a filesystem layout + // Match size and image to a filesystem layout. // or match a machine to a filesystem layout // // Types that are valid to be assigned to Match: diff --git a/go/metalstack/admin/v2/image.pb.go b/go/metalstack/admin/v2/image.pb.go index fca107cc..33465139 100644 --- a/go/metalstack/admin/v2/image.pb.go +++ b/go/metalstack/admin/v2/image.pb.go @@ -27,7 +27,7 @@ const ( // ImageServiceCreateRequest is the request payload for creating an image. type ImageServiceCreateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Image is the image to create + // 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 @@ -73,7 +73,7 @@ func (x *ImageServiceCreateRequest) GetImage() *v2.Image { // ImageServiceCreateResponse is the response payload for creating an image. type ImageServiceCreateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Image contains the created 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 @@ -121,7 +121,7 @@ type ImageServiceUpdateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Id of this image 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"` // URL where this image is located Url *string `protobuf:"bytes,3,opt,name=url,proto3,oneof" json:"url,omitempty"` @@ -133,7 +133,7 @@ type ImageServiceUpdateRequest struct { Features []v2.ImageFeature `protobuf:"varint,6,rep,packed,name=features,proto3,enum=metalstack.api.v2.ImageFeature" json:"features,omitempty"` // Classification of this image Classification v2.ImageClassification `protobuf:"varint,7,opt,name=classification,proto3,enum=metalstack.api.v2.ImageClassification" json:"classification,omitempty"` - // ExpiresAt indicates that usage is not possible after this date + // ExpiresAt indicates that usage is not possible after this date. ExpiresAt *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"` // Labels to update on this image Labels *v2.UpdateLabels `protobuf:"bytes,9,opt,name=labels,proto3,oneof" json:"labels,omitempty"` @@ -237,7 +237,7 @@ func (x *ImageServiceUpdateRequest) GetLabels() *v2.UpdateLabels { // ImageServiceUpdateResponse is the response payload for updating an image. type ImageServiceUpdateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Image contains the updated 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 @@ -329,7 +329,7 @@ func (x *ImageServiceDeleteRequest) GetId() string { // ImageServiceDeleteResponse is the response payload for deleting an image. type ImageServiceDeleteResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Image contains the deleted image + // Image contains the deleted image. Image *v2.Image `protobuf:"bytes,1,opt,name=image,proto3" json:"image,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -375,7 +375,7 @@ func (x *ImageServiceDeleteResponse) GetImage() *v2.Image { // 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 + // Query for which images the usage should be reported. Query *v2.ImageQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -421,7 +421,7 @@ func (x *ImageServiceUsageRequest) GetQuery() *v2.ImageQuery { // ImageServiceUsageResponse is the response payload for getting image usage. type ImageServiceUsageResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Images contains usage information + // 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 9deda2f5..90d0092c 100644 --- a/go/metalstack/admin/v2/ip.pb.go +++ b/go/metalstack/admin/v2/ip.pb.go @@ -25,7 +25,7 @@ const ( // IPServiceListRequest is the request payload for listing IP addresses. type IPServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Query to search for IP addresses + // 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 @@ -71,7 +71,7 @@ func (x *IPServiceListRequest) GetQuery() *v2.IPQuery { // IPServiceListResponse is the response payload for listing IP addresses. type IPServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // IPs contains the list of IP addresses + // 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 440f7c31..ebc14bca 100644 --- a/go/metalstack/admin/v2/machine.pb.go +++ b/go/metalstack/admin/v2/machine.pb.go @@ -23,7 +23,7 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) -// MachineServiceGetRequest is the request payload for a machine get request +// MachineServiceGetRequest is the request payload for a machine get request. type MachineServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // UUID of the machine to get @@ -69,10 +69,10 @@ func (x *MachineServiceGetRequest) GetUuid() string { return "" } -// MachineServiceGetResponse is the response payload for a machine get request +// MachineServiceGetResponse is the response payload for a machine get request. type MachineServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Machine is the machine requested + // Machine is the machine requested. Machine *v2.Machine `protobuf:"bytes,1,opt,name=machine,proto3" json:"machine,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -115,10 +115,10 @@ func (x *MachineServiceGetResponse) GetMachine() *v2.Machine { return nil } -// MachineServiceListRequest is the request payload for a machine list request +// MachineServiceListRequest is the request payload for a machine list request. type MachineServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Query to list one or more machines + // Query to list one or more machines. Query *v2.MachineQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"` // Partition for which machines should be listed, could be left empty if only one partition is present // otherwise an error is thrown that the partition must be specified @@ -171,10 +171,10 @@ func (x *MachineServiceListRequest) GetPartition() string { return "" } -// MachineServiceListResponse is the response payload for a machine list request +// MachineServiceListResponse is the response payload for a machine list request. type MachineServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Machines are the machines requested by a list request + // Machines are the machines requested by a list request. Machines []*v2.Machine `protobuf:"bytes,1,rep,name=machines,proto3" json:"machines,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -217,7 +217,7 @@ func (x *MachineServiceListResponse) GetMachines() []*v2.Machine { return nil } -// MachineServiceDeleteRequest is the request payload for a machine delete request +// MachineServiceDeleteRequest is the request payload for a machine delete request. type MachineServiceDeleteRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // UUID of the machine to permanently delete @@ -263,10 +263,10 @@ func (x *MachineServiceDeleteRequest) GetUuid() string { return "" } -// MachineServiceDeleteResponse is the response payload for a machine delete request +// MachineServiceDeleteResponse is the response payload for a machine delete request. type MachineServiceDeleteResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Machine is the machine permanently deleted + // Machine is the machine permanently deleted. Machine *v2.Machine `protobuf:"bytes,1,opt,name=machine,proto3" json:"machine,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -309,7 +309,7 @@ func (x *MachineServiceDeleteResponse) GetMachine() *v2.Machine { return nil } -// MachineServiceBMCCommandRequest is the request payload for a machine bmc command +// MachineServiceBMCCommandRequest is the request payload for a machine bmc command. type MachineServiceBMCCommandRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // UUID of the machine to send the command to @@ -364,7 +364,7 @@ func (x *MachineServiceBMCCommandRequest) GetCommand() v2.MachineBMCCommand { return v2.MachineBMCCommand(0) } -// MachineServiceBMCCommandResponse is the response payload for a machine bmc command +// MachineServiceBMCCommandResponse is the response payload for a machine bmc command. type MachineServiceBMCCommandResponse struct { state protoimpl.MessageState `protogen:"open.v1"` unknownFields protoimpl.UnknownFields @@ -401,7 +401,7 @@ func (*MachineServiceBMCCommandResponse) Descriptor() ([]byte, []int) { return file_metalstack_admin_v2_machine_proto_rawDescGZIP(), []int{7} } -// MachineServiceGetBMCRequest is the request payload for a machine getbmc request +// MachineServiceGetBMCRequest is the request payload for a machine getbmc request. type MachineServiceGetBMCRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // UUID of the machine to get @@ -447,12 +447,12 @@ func (x *MachineServiceGetBMCRequest) GetUuid() string { return "" } -// MachineServiceGetBMCResponse is the response payload for a machine getbmc request +// MachineServiceGetBMCResponse is the response payload for a machine getbmc request. type MachineServiceGetBMCResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // UUID of the machine Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` - // BMC contains the BMC details of this machine + // BMC contains the BMC details of this machine. Bmc *v2.MachineBMCReport `protobuf:"bytes,2,opt,name=bmc,proto3" json:"bmc,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -502,10 +502,10 @@ func (x *MachineServiceGetBMCResponse) GetBmc() *v2.MachineBMCReport { return nil } -// MachineServiceListBMCRequest is the request payload for a machine listbmc request +// MachineServiceListBMCRequest is the request payload for a machine listbmc request. type MachineServiceListBMCRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Query to list one or more BMCs of many machines + // Query to list one or more BMCs of many machines. Query *v2.MachineBMCQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -548,10 +548,10 @@ func (x *MachineServiceListBMCRequest) GetQuery() *v2.MachineBMCQuery { return nil } -// MachineServiceListBMCResponse is the response payload for a machine listbmc request +// MachineServiceListBMCResponse is the response payload for a machine listbmc request. type MachineServiceListBMCResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // BMCReports maps the bmc report per machine uuid + // BMCReports maps the bmc report per machine uuid. BmcReports map[string]*v2.MachineBMCReport `protobuf:"bytes,1,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 @@ -599,8 +599,8 @@ 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 is only forwarded to an audit sink + // 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 sizeCache protoimpl.SizeCache @@ -705,7 +705,7 @@ func (x *MachineServiceConsolePasswordResponse) GetPassword() string { return "" } -// MachineServiceSetStateRequest is the request payload for a machine set state request +// MachineServiceSetStateRequest is the request payload for a machine set state request. type MachineServiceSetStateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // UUID of the machine to set the state to @@ -770,7 +770,7 @@ func (x *MachineServiceSetStateRequest) GetDescription() string { return "" } -// MachineServiceSetStateResponse is the response payload for a machine set state request +// MachineServiceSetStateResponse is the response payload for a machine set state request. type MachineServiceSetStateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Machine with the changed state. @@ -816,10 +816,10 @@ func (x *MachineServiceSetStateResponse) GetMachine() *v2.Machine { return nil } -// MachineServiceIssuesRequest is the request payload for a machine issues request +// MachineServiceIssuesRequest is the request payload for a machine issues request. type MachineServiceIssuesRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Query which machine issues to include + // Query which machine issues to include. Query *v2.MachineIssuesQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -862,10 +862,10 @@ func (x *MachineServiceIssuesRequest) GetQuery() *v2.MachineIssuesQuery { return nil } -// MachineServiceIssuesResponse is the response payload for a machine issues request +// MachineServiceIssuesResponse is the response payload for a machine issues request. type MachineServiceIssuesResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Issues is the result of the issues query + // Issues is the result of the issues query. Issues []*v2.MachineIssues `protobuf:"bytes,1,rep,name=issues,proto3" json:"issues,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/admin/v2/network.pb.go b/go/metalstack/admin/v2/network.pb.go index 07cee610..4a4d0112 100644 --- a/go/metalstack/admin/v2/network.pb.go +++ b/go/metalstack/admin/v2/network.pb.go @@ -72,7 +72,7 @@ func (x *NetworkServiceGetRequest) GetId() string { // NetworkServiceGetResponse is the response payload for getting a network. type NetworkServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Network contains the requested network + // Network contains the requested network. Network *v2.Network `protobuf:"bytes,1,opt,name=network,proto3" json:"network,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -124,9 +124,9 @@ type NetworkServiceCreateRequest struct { Name *string `protobuf:"bytes,2,opt,name=name,proto3,oneof" json:"name,omitempty"` // Description of this network Description *string `protobuf:"bytes,3,opt,name=description,proto3,oneof" json:"description,omitempty"` - // Partition where this network will be created + // Partition where this network will be created. Partition *string `protobuf:"bytes,4,opt,name=partition,proto3,oneof" json:"partition,omitempty"` - // Project where this network belongs to + // Project where this network belongs to. Project *string `protobuf:"bytes,5,opt,name=project,proto3,oneof" json:"project,omitempty"` // Type of the network to create Type v2.NetworkType `protobuf:"varint,6,opt,name=type,proto3,enum=metalstack.api.v2.NetworkType" json:"type,omitempty"` @@ -136,17 +136,17 @@ type NetworkServiceCreateRequest struct { Prefixes []string `protobuf:"bytes,8,rep,name=prefixes,proto3" json:"prefixes,omitempty"` // Destination Prefixes in this network DestinationPrefixes []string `protobuf:"bytes,9,rep,name=destination_prefixes,json=destinationPrefixes,proto3" json:"destination_prefixes,omitempty"` - // Default Child Prefix length defines the bitlength of a child network created per addressfamily, if not specified during the allocate request + // Default Child Prefix length defines the bitlength of a child network created per addressfamily, if not specified during the allocate request. DefaultChildPrefixLength *v2.ChildPrefixLength `protobuf:"bytes,10,opt,name=default_child_prefix_length,json=defaultChildPrefixLength,proto3" json:"default_child_prefix_length,omitempty"` - // Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length + // 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,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 *uint32 `protobuf:"varint,13,opt,name=vrf,proto3,oneof" json:"vrf,omitempty"` - // Parent Network points to the id of the parent network if any + // 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"` - // AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced + // AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced. AdditionalAnnouncableCidrs []string `protobuf:"bytes,15,rep,name=additional_announcable_cidrs,json=additionalAnnouncableCidrs,proto3" json:"additional_announcable_cidrs,omitempty"` // Length per addressfamily Length *v2.ChildPrefixLength `protobuf:"bytes,16,opt,name=length,proto3,oneof" json:"length,omitempty"` @@ -310,7 +310,7 @@ type NetworkServiceUpdateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Id of this network 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"` // Name of this network Name *string `protobuf:"bytes,3,opt,name=name,proto3,oneof" json:"name,omitempty"` @@ -322,13 +322,13 @@ 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, if 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 + // 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"` // NATType of this network 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 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, prevents accidental removal of additional_announcable_cidrs which will destroy your dataplane. Force bool `protobuf:"varint,12,opt,name=force,proto3" json:"force,omitempty"` @@ -499,7 +499,7 @@ func (x *NetworkServiceDeleteRequest) GetId() string { // NetworkServiceListRequest is the request payload for listing networks. type NetworkServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Query specifies which networks to return + // Query specifies which networks to return. Query *v2.NetworkQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -545,7 +545,7 @@ func (x *NetworkServiceListRequest) GetQuery() *v2.NetworkQuery { // NetworkServiceCreateResponse is the response payload for creating a network. type NetworkServiceCreateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Network contains the created 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 @@ -591,7 +591,7 @@ func (x *NetworkServiceCreateResponse) GetNetwork() *v2.Network { // NetworkServiceUpdateResponse is the response payload for updating a network. type NetworkServiceUpdateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Network contains the updated 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 @@ -637,7 +637,7 @@ func (x *NetworkServiceUpdateResponse) GetNetwork() *v2.Network { // NetworkServiceDeleteResponse is the response payload for deleting a network. type NetworkServiceDeleteResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Network contains the deleted 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 @@ -683,7 +683,7 @@ func (x *NetworkServiceDeleteResponse) GetNetwork() *v2.Network { // NetworkServiceListResponse is the response payload for listing networks. type NetworkServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Networks contains the list of 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 eec90fd4..1c0ef82f 100644 --- a/go/metalstack/admin/v2/partition.pb.go +++ b/go/metalstack/admin/v2/partition.pb.go @@ -23,7 +23,7 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) -// PartitionServiceCreateRequest is the request payload for a partition create request +// PartitionServiceCreateRequest is the request payload for a partition create request. type PartitionServiceCreateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Partition the partition @@ -74,17 +74,17 @@ type PartitionServiceUpdateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // ID of this partition 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"` // Description of this partition Description *string `protobuf:"bytes,3,opt,name=description,proto3,oneof" json:"description,omitempty"` - // PartitionBootConfiguration defines how metal-hammer boots + // PartitionBootConfiguration defines how metal-hammer boots. BootConfiguration *v2.PartitionBootConfiguration `protobuf:"bytes,4,opt,name=boot_configuration,json=bootConfiguration,proto3" json:"boot_configuration,omitempty"` // DNSServers for this partition DnsServers []*v2.DNSServer `protobuf:"bytes,5,rep,name=dns_servers,json=dnsServers,proto3" json:"dns_servers,omitempty"` // 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 + // ManagementServiceAddresses defines where the management is reachable. // 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 @@ -179,7 +179,7 @@ func (x *PartitionServiceUpdateRequest) GetLabels() *v2.UpdateLabels { return nil } -// PartitionServiceDeleteRequest is the request payload for a partition delete request +// PartitionServiceDeleteRequest is the request payload for a partition delete request. type PartitionServiceDeleteRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // ID of the partition to delete @@ -225,7 +225,7 @@ func (x *PartitionServiceDeleteRequest) GetId() string { return "" } -// PartitionServiceCreateResponse is the response payload for a partition create request +// PartitionServiceCreateResponse is the response payload for a partition create request. type PartitionServiceCreateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Partition the partition @@ -271,7 +271,7 @@ func (x *PartitionServiceCreateResponse) GetPartition() *v2.Partition { return nil } -// PartitionServiceUpdateResponse is the response payload for a partition update request +// PartitionServiceUpdateResponse is the response payload for a partition update request. type PartitionServiceUpdateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Partition the partition @@ -320,7 +320,7 @@ func (x *PartitionServiceUpdateResponse) GetPartition() *v2.Partition { // PartitionServiceDeleteResponse is the response payload for deleting a partition. type PartitionServiceDeleteResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Partition contains the deleted 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 @@ -427,10 +427,10 @@ func (x *PartitionServiceCapacityRequest) GetProject() string { return "" } -// PartitionServiceCapacityResponse is the response payload for a partition capacity request +// PartitionServiceCapacityResponse is the response payload for a partition capacity request. type PartitionServiceCapacityResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // PartitionCapacity is a capacity report per partition + // PartitionCapacity is a capacity report per partition. PartitionCapacity []*PartitionCapacity `protobuf:"bytes,1,rep,name=partition_capacity,json=partitionCapacity,proto3" json:"partition_capacity,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -473,7 +473,7 @@ func (x *PartitionServiceCapacityResponse) GetPartitionCapacity() []*PartitionCa return nil } -// PartitionCapacity is the capacity of one partition +// PartitionCapacity is the capacity of one partition. type PartitionCapacity struct { state protoimpl.MessageState `protogen:"open.v1"` // Partition of which this capacity is reported. @@ -528,7 +528,7 @@ func (x *PartitionCapacity) GetMachineSizeCapacities() []*MachineSizeCapacity { return nil } -// ServerCapacity is the capacity of one server type, eg machine size +// ServerCapacity is the capacity of one server type, eg machine size. type MachineSizeCapacity struct { state protoimpl.MessageState `protogen:"open.v1"` // Size is the size id correlating to all counts in this server capacity. diff --git a/go/metalstack/admin/v2/project.pb.go b/go/metalstack/admin/v2/project.pb.go index 1be7d8cd..dafae0fe 100644 --- a/go/metalstack/admin/v2/project.pb.go +++ b/go/metalstack/admin/v2/project.pb.go @@ -25,7 +25,7 @@ const ( // ProjectServiceListRequest is the request payload for listing projects. type ProjectServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Query for projects + // Query for projects. Query *v2.ProjectQuery `protobuf:"bytes,1,opt,name=query,proto3,oneof" json:"query,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -71,7 +71,7 @@ func (x *ProjectServiceListRequest) GetQuery() *v2.ProjectQuery { // ProjectServiceListResponse is the response payload for listing projects. type ProjectServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Projects contains the list of 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 19bb7768..c8fe7ea3 100644 --- a/go/metalstack/admin/v2/size.pb.go +++ b/go/metalstack/admin/v2/size.pb.go @@ -26,7 +26,7 @@ const ( // SizeServiceCreateRequest is the request payload for creating a size. type SizeServiceCreateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Size is the size to create + // Size is the size to create. Size *v2.Size `protobuf:"bytes,1,opt,name=size,proto3" json:"size,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -72,7 +72,7 @@ func (x *SizeServiceCreateRequest) GetSize() *v2.Size { // SizeServiceCreateResponse is the response payload for creating a size. type SizeServiceCreateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Size contains the created 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 @@ -120,7 +120,7 @@ type SizeServiceUpdateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Id of this size 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"` // Name of this size Name *string `protobuf:"bytes,3,opt,name=name,proto3,oneof" json:"name,omitempty"` @@ -209,7 +209,7 @@ func (x *SizeServiceUpdateRequest) GetLabels() *v2.UpdateLabels { // SizeServiceUpdateResponse is the response payload for updating a size. type SizeServiceUpdateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Size contains the updated 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 @@ -301,7 +301,7 @@ func (x *SizeServiceDeleteRequest) GetId() string { // SizeServiceDeleteResponse is the response payload for deleting a size. type SizeServiceDeleteResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Size contains the deleted 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 b6bf1359..f21ed3cd 100644 --- a/go/metalstack/admin/v2/size_imageconstraint.pb.go +++ b/go/metalstack/admin/v2/size_imageconstraint.pb.go @@ -108,7 +108,7 @@ func (x *SizeImageConstraintServiceCreateRequest) GetDescription() string { // SizeImageConstraintServiceCreateResponse is the response payload for creating a size image constraint. type SizeImageConstraintServiceCreateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // SizeImageConstraint contains the created constraint + // 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 @@ -156,7 +156,7 @@ type SizeImageConstraintServiceUpdateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Size of the image constraint to update Size string `protobuf:"bytes,1,opt,name=size,proto3" json:"size,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"` // ImageConstraints to apply to this size ImageConstraints []*v2.ImageConstraint `protobuf:"bytes,3,rep,name=image_constraints,json=imageConstraints,proto3" json:"image_constraints,omitempty"` @@ -236,7 +236,7 @@ func (x *SizeImageConstraintServiceUpdateRequest) GetDescription() string { // SizeImageConstraintServiceUpdateResponse is the response payload for updating a size image constraint. type SizeImageConstraintServiceUpdateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // SizeImageConstraint contains the updated constraint + // 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 @@ -328,7 +328,7 @@ func (x *SizeImageConstraintServiceDeleteRequest) GetSize() string { // SizeImageConstraintServiceDeleteResponse is the response payload for deleting a size image constraint. type SizeImageConstraintServiceDeleteResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // SizeImageConstraint contains the deleted constraint + // 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 @@ -420,7 +420,7 @@ func (x *SizeImageConstraintServiceGetRequest) GetSize() string { // SizeImageConstraintServiceGetResponse is the response payload for getting a size image constraint. type SizeImageConstraintServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // SizeImageConstraint contains the retrieved constraint + // 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 @@ -466,7 +466,7 @@ func (x *SizeImageConstraintServiceGetResponse) GetSizeImageConstraint() *v2.Siz // SizeImageConstraintServiceListRequest is the request payload for listing size image constraints. type SizeImageConstraintServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Query for size image constraints + // Query for size image constraints. Query *v2.SizeImageConstraintQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -512,7 +512,7 @@ func (x *SizeImageConstraintServiceListRequest) GetQuery() *v2.SizeImageConstrai // SizeImageConstraintServiceListResponse is the response payload for listing size image constraints. type SizeImageConstraintServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // SizeImageConstraints contains the list of constraints + // 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 0766e801..da94b127 100644 --- a/go/metalstack/admin/v2/size_reservation.pb.go +++ b/go/metalstack/admin/v2/size_reservation.pb.go @@ -26,7 +26,7 @@ const ( // 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 + // SizeReservation is the size reservation to create. SizeReservation *v2.SizeReservation `protobuf:"bytes,1,opt,name=size_reservation,json=sizeReservation,proto3" json:"size_reservation,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -72,7 +72,7 @@ func (x *SizeReservationServiceCreateRequest) GetSizeReservation() *v2.SizeReser // SizeReservationServiceCreateResponse is the response payload for creating a size reservation. type SizeReservationServiceCreateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // SizeReservation contains the created 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 @@ -124,7 +124,7 @@ type SizeReservationServiceUpdateRequest struct { Name *string `protobuf:"bytes,2,opt,name=name,proto3,oneof" json:"name,omitempty"` // Description of this size reservation Description *string `protobuf:"bytes,3,opt,name=description,proto3,oneof" json:"description,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,4,opt,name=update_meta,json=updateMeta,proto3" json:"update_meta,omitempty"` // Partition ids of this size reservation Partitions []string `protobuf:"bytes,5,rep,name=partitions,proto3" json:"partitions,omitempty"` @@ -218,7 +218,7 @@ func (x *SizeReservationServiceUpdateRequest) GetLabels() *v2.UpdateLabels { // SizeReservationServiceUpdateResponse is the response payload for updating a size reservation. type SizeReservationServiceUpdateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // SizeReservation contains the updated 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 @@ -310,7 +310,7 @@ func (x *SizeReservationServiceDeleteRequest) GetId() string { // SizeReservationServiceDeleteResponse is the response payload for deleting a size reservation. type SizeReservationServiceDeleteResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // SizeReservation contains the deleted 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 @@ -356,7 +356,7 @@ func (x *SizeReservationServiceDeleteResponse) GetSizeReservation() *v2.SizeRese // SizeReservationServiceListRequest is the request payload for listing size reservations. type SizeReservationServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Query for size reservations + // Query for size reservations. Query *v2.SizeReservationQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -402,7 +402,7 @@ func (x *SizeReservationServiceListRequest) GetQuery() *v2.SizeReservationQuery // SizeReservationServiceListResponse is the response payload for listing size reservations. type SizeReservationServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // SizeReservations contains the list of 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 b1f7576d..ba9527e2 100644 --- a/go/metalstack/admin/v2/switch.pb.go +++ b/go/metalstack/admin/v2/switch.pb.go @@ -73,7 +73,7 @@ func (x *SwitchServiceGetRequest) GetId() string { // SwitchServiceGetResponse is the response payload for getting a switch. type SwitchServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Switch contains the requested switch + // Switch contains the requested switch. Switch *v2.Switch `protobuf:"bytes,1,opt,name=switch,proto3" json:"switch,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -119,7 +119,7 @@ func (x *SwitchServiceGetResponse) GetSwitch() *v2.Switch { // 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 @@ -213,24 +213,24 @@ type SwitchServiceUpdateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // 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 *string `protobuf:"bytes,4,opt,name=description,proto3,oneof" json:"description,omitempty"` - // ReplaceMode 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"` - // ManagementIp 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"` - // ManagementUser 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"` - // ConsoleCommand 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 @@ -339,7 +339,7 @@ func (x *SwitchServiceUpdateRequest) GetOs() *v2.SwitchOS { // SwitchServiceUpdateResponse is the response payload for updating a switch. type SwitchServiceUpdateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Switch contains the updated switch + // Switch contains the updated switch. Switch *v2.Switch `protobuf:"bytes,1,opt,name=switch,proto3" json:"switch,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -387,7 +387,7 @@ type SwitchServiceDeleteRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // 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 @@ -440,7 +440,7 @@ func (x *SwitchServiceDeleteRequest) GetForce() bool { // SwitchServiceDeleteResponse is the response payload for deleting a switch. type SwitchServiceDeleteResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Switch contains the deleted switch + // Switch contains the deleted switch. Switch *v2.Switch `protobuf:"bytes,1,opt,name=switch,proto3" json:"switch,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -486,9 +486,9 @@ func (x *SwitchServiceDeleteResponse) GetSwitch() *v2.Switch { // SwitchServiceMigrateRequest is the request payload for migrating a switch. type SwitchServiceMigrateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // OldSwitch is the switch 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 is the switch 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 @@ -541,7 +541,7 @@ func (x *SwitchServiceMigrateRequest) GetNewSwitch() string { // SwitchServiceMigrateResponse is the response payload for migrating a switch. type SwitchServiceMigrateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Switch contains the switch that was migrated to + // Switch contains the switch that was migrated to. Switch *v2.Switch `protobuf:"bytes,1,opt,name=switch,proto3" json:"switch,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -697,7 +697,7 @@ func (x *SwitchServicePortResponse) GetSwitch() *v2.Switch { // 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 *v2.MachineQuery `protobuf:"bytes,2,opt,name=machine_query,json=machineQuery,proto3" json:"machine_query,omitempty"` @@ -752,7 +752,7 @@ func (x *SwitchServiceConnectedMachinesRequest) GetMachineQuery() *v2.MachineQue // 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 63c708af..0a668254 100644 --- a/go/metalstack/admin/v2/task.pb.go +++ b/go/metalstack/admin/v2/task.pb.go @@ -28,21 +28,21 @@ const ( type TaskState int32 const ( - // TASK_STATE_UNSPECIFIED is not specified + // 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 is 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 ) @@ -100,9 +100,9 @@ func (TaskState) EnumDescriptor() ([]byte, []int) { // TaskServiceGetRequest is the request payload for getting a task. type TaskServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // TaskId is the identifier of the task 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 is the 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 @@ -155,7 +155,7 @@ func (x *TaskServiceGetRequest) GetQueue() string { // TaskServiceGetResponse is the response payload for getting a task. type TaskServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Task contains the task details + // Task contains the task details. Task *TaskInfo `protobuf:"bytes,1,opt,name=task,proto3" json:"task,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -201,9 +201,9 @@ func (x *TaskServiceGetResponse) GetTask() *TaskInfo { // TaskServiceDeleteRequest is the request payload for deleting a task. type TaskServiceDeleteRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // TaskId is the identifier of the task 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 is the 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 @@ -376,12 +376,12 @@ func (x *TaskServiceQueuesResponse) GetQueues() []string { // TaskServiceListRequest is the request payload for listing tasks. type TaskServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Queue filters tasks by this queue - // 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 is the number 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 is the 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 @@ -441,7 +441,7 @@ func (x *TaskServiceListRequest) GetPage() uint32 { // TaskServiceListResponse is the response payload for listing tasks. type TaskServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Tasks contains the list of requested 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 @@ -487,52 +487,52 @@ func (x *TaskServiceListResponse) GetTasks() []*TaskInfo { // 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 of the last failure if any + // 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 // - // 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 + // 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 // - // 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 + // 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 diff --git a/go/metalstack/admin/v2/tenant.pb.go b/go/metalstack/admin/v2/tenant.pb.go index 99979079..ad0db648 100644 --- a/go/metalstack/admin/v2/tenant.pb.go +++ b/go/metalstack/admin/v2/tenant.pb.go @@ -108,7 +108,7 @@ func (x *TenantServiceCreateRequest) GetLabels() *v2.Labels { // TenantServiceCreateResponse is the response payload for creating a tenant. type TenantServiceCreateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Tenant contains the created 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 @@ -154,7 +154,7 @@ func (x *TenantServiceCreateResponse) GetTenant() *v2.Tenant { // TenantServiceListRequest is the request payload for listing tenants. type TenantServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Query for tenants + // Query for tenants. Query *v2.TenantQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -200,9 +200,9 @@ func (x *TenantServiceListRequest) GetQuery() *v2.TenantQuery { // TenantServiceListResponse is the response payload for listing tenants. type TenantServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Tenants contains 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 @@ -252,7 +252,7 @@ func (x *TenantServiceListResponse) GetNextPage() uint64 { return 0 } -// TenantServiceAddMemberRequest is the request payload for adding a member to a tenant +// TenantServiceAddMemberRequest is the request payload for adding a member to a tenant. type TenantServiceAddMemberRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Login of the tenant to which the member will be added @@ -316,10 +316,10 @@ func (x *TenantServiceAddMemberRequest) GetRole() v2.TenantRole { return v2.TenantRole(0) } -// TenantServiceAddMemberResponse is the response payload for the add member request +// TenantServiceAddMemberResponse is the response payload for the add member request. type TenantServiceAddMemberResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // TenantMember is the added tenant member + // TenantMember is the added tenant member. TenantMember *v2.TenantMember `protobuf:"bytes,1,opt,name=tenant_member,json=tenantMember,proto3" json:"tenant_member,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -362,7 +362,7 @@ func (x *TenantServiceAddMemberResponse) GetTenantMember() *v2.TenantMember { return nil } -// TenantServiceRemoveMemberRequest is the request payload for removing a member from a tenant +// TenantServiceRemoveMemberRequest is the request payload for removing a member from a tenant. type TenantServiceRemoveMemberRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Login of the tenant from which the member will be removed @@ -417,10 +417,10 @@ func (x *TenantServiceRemoveMemberRequest) GetMember() string { return "" } -// TenantServiceRemoveMemberResponse is the response payload for the remove member request +// TenantServiceRemoveMemberResponse is the response payload for the remove member request. type TenantServiceRemoveMemberResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // TenantMember is the removed tenant member + // TenantMember is the removed tenant member. TenantMember *v2.TenantMember `protobuf:"bytes,1,opt,name=tenant_member,json=tenantMember,proto3" json:"tenant_member,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 c5ad5f0c..7eb08e1e 100644 --- a/go/metalstack/admin/v2/token.pb.go +++ b/go/metalstack/admin/v2/token.pb.go @@ -26,7 +26,7 @@ const ( // TokenServiceListRequest is the request payload for listing tokens. type TokenServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Query for tokens + // Query for tokens. Query *v2.TokenQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -72,7 +72,7 @@ func (x *TokenServiceListRequest) GetQuery() *v2.TokenQuery { // TokenServiceListResponse is the response payload for listing tokens. type TokenServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Tokens contains 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 @@ -118,9 +118,9 @@ func (x *TokenServiceListResponse) GetTokens() []*v2.Token { // 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 + // Uuid is the uuid of the token which should be revoked. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` - // User is the id of the user for which the token should be revoked + // User is the id of the user for which the token should be revoked. User string `protobuf:"bytes,2,opt,name=user,proto3" json:"user,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -265,9 +265,9 @@ func (x *TokenServiceCreateRequest) GetTokenCreateRequest() *v2.TokenServiceCrea // TokenServiceCreateResponse is the response payload for creating a token. type TokenServiceCreateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Token contains the created token + // 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 f1682f0f..c396f97b 100644 --- a/go/metalstack/admin/v2/vpn.pb.go +++ b/go/metalstack/admin/v2/vpn.pb.go @@ -30,12 +30,12 @@ type VPNServiceAuthKeyRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // 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 authentication key 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 authentication key 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 an 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 @@ -102,12 +102,12 @@ func (x *VPNServiceAuthKeyRequest) GetReason() string { // 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 authentication key 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 *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"` @@ -185,7 +185,7 @@ func (x *VPNServiceAuthKeyResponse) GetCreatedAt() *timestamppb.Timestamp { // VPNServiceListNodesRequest is the request payload for listing VPN nodes. type VPNServiceListNodesRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Project filters nodes by this project + // 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 diff --git a/go/metalstack/api/v2/apiv2connect/project.connect.go b/go/metalstack/api/v2/apiv2connect/project.connect.go index c2acdcc6..0f428fc2 100644 --- a/go/metalstack/api/v2/apiv2connect/project.connect.go +++ b/go/metalstack/api/v2/apiv2connect/project.connect.go @@ -76,27 +76,27 @@ type ProjectServiceClient interface { List(context.Context, *v2.ProjectServiceListRequest) (*v2.ProjectServiceListResponse, error) // Returns the project with the specified UUID. Get(context.Context, *v2.ProjectServiceGetRequest) (*v2.ProjectServiceGetResponse, error) - // Create a project + // Create a project. Create(context.Context, *v2.ProjectServiceCreateRequest) (*v2.ProjectServiceCreateResponse, error) - // Delete a project + // Delete a project. Delete(context.Context, *v2.ProjectServiceDeleteRequest) (*v2.ProjectServiceDeleteResponse, error) - // Update a project + // Update a project. Update(context.Context, *v2.ProjectServiceUpdateRequest) (*v2.ProjectServiceUpdateResponse, error) - // Leave project + // Leave project. Leave(context.Context, *v2.ProjectServiceLeaveRequest) (*v2.ProjectServiceLeaveResponse, error) - // AddMember adds a user to a project + // AddMember adds a user to a project. AddMember(context.Context, *v2.ProjectServiceAddMemberRequest) (*v2.ProjectServiceAddMemberResponse, error) - // RemoveMember removes a user from a project + // RemoveMember removes a user from a project. RemoveMember(context.Context, *v2.ProjectServiceRemoveMemberRequest) (*v2.ProjectServiceRemoveMemberResponse, error) - // UpdateMember updates a user for a project + // UpdateMember updates a user for a project. UpdateMember(context.Context, *v2.ProjectServiceUpdateMemberRequest) (*v2.ProjectServiceUpdateMemberResponse, error) - // Invite a user to a project + // Invite a user to a project. Invite(context.Context, *v2.ProjectServiceInviteRequest) (*v2.ProjectServiceInviteResponse, error) - // InviteAccept is called by a user to accept an invitation + // InviteAccept is called by a user to accept an invitation. InviteAccept(context.Context, *v2.ProjectServiceInviteAcceptRequest) (*v2.ProjectServiceInviteAcceptResponse, error) - // InviteDelete deletes a pending invitation + // InviteDelete deletes a pending invitation. InviteDelete(context.Context, *v2.ProjectServiceInviteDeleteRequest) (*v2.ProjectServiceInviteDeleteResponse, error) - // InvitesList list all invites to a project + // InvitesList list all invites to a project. InvitesList(context.Context, *v2.ProjectServiceInvitesListRequest) (*v2.ProjectServiceInvitesListResponse, error) // InviteGet get an invite InviteGet(context.Context, *v2.ProjectServiceInviteGetRequest) (*v2.ProjectServiceInviteGetResponse, error) @@ -350,27 +350,27 @@ type ProjectServiceHandler interface { List(context.Context, *v2.ProjectServiceListRequest) (*v2.ProjectServiceListResponse, error) // Returns the project with the specified UUID. Get(context.Context, *v2.ProjectServiceGetRequest) (*v2.ProjectServiceGetResponse, error) - // Create a project + // Create a project. Create(context.Context, *v2.ProjectServiceCreateRequest) (*v2.ProjectServiceCreateResponse, error) - // Delete a project + // Delete a project. Delete(context.Context, *v2.ProjectServiceDeleteRequest) (*v2.ProjectServiceDeleteResponse, error) - // Update a project + // Update a project. Update(context.Context, *v2.ProjectServiceUpdateRequest) (*v2.ProjectServiceUpdateResponse, error) - // Leave project + // Leave project. Leave(context.Context, *v2.ProjectServiceLeaveRequest) (*v2.ProjectServiceLeaveResponse, error) - // AddMember adds a user to a project + // AddMember adds a user to a project. AddMember(context.Context, *v2.ProjectServiceAddMemberRequest) (*v2.ProjectServiceAddMemberResponse, error) - // RemoveMember removes a user from a project + // RemoveMember removes a user from a project. RemoveMember(context.Context, *v2.ProjectServiceRemoveMemberRequest) (*v2.ProjectServiceRemoveMemberResponse, error) - // UpdateMember updates a user for a project + // UpdateMember updates a user for a project. UpdateMember(context.Context, *v2.ProjectServiceUpdateMemberRequest) (*v2.ProjectServiceUpdateMemberResponse, error) - // Invite a user to a project + // Invite a user to a project. Invite(context.Context, *v2.ProjectServiceInviteRequest) (*v2.ProjectServiceInviteResponse, error) - // InviteAccept is called by a user to accept an invitation + // InviteAccept is called by a user to accept an invitation. InviteAccept(context.Context, *v2.ProjectServiceInviteAcceptRequest) (*v2.ProjectServiceInviteAcceptResponse, error) - // InviteDelete deletes a pending invitation + // InviteDelete deletes a pending invitation. InviteDelete(context.Context, *v2.ProjectServiceInviteDeleteRequest) (*v2.ProjectServiceInviteDeleteResponse, error) - // InvitesList list all invites to a project + // InvitesList list all invites to a project. InvitesList(context.Context, *v2.ProjectServiceInvitesListRequest) (*v2.ProjectServiceInvitesListResponse, error) // InviteGet get an invite InviteGet(context.Context, *v2.ProjectServiceInviteGetRequest) (*v2.ProjectServiceInviteGetResponse, error) diff --git a/go/metalstack/api/v2/apiv2connect/tenant.connect.go b/go/metalstack/api/v2/apiv2connect/tenant.connect.go index f1c99c66..bb135439 100644 --- a/go/metalstack/api/v2/apiv2connect/tenant.connect.go +++ b/go/metalstack/api/v2/apiv2connect/tenant.connect.go @@ -74,27 +74,27 @@ type TenantServiceClient interface { Create(context.Context, *v2.TenantServiceCreateRequest) (*v2.TenantServiceCreateResponse, error) // Returns the list of tenants. List(context.Context, *v2.TenantServiceListRequest) (*v2.TenantServiceListResponse, error) - // Get a tenant + // Get a tenant. Get(context.Context, *v2.TenantServiceGetRequest) (*v2.TenantServiceGetResponse, error) - // Update a tenant + // Update a tenant. Update(context.Context, *v2.TenantServiceUpdateRequest) (*v2.TenantServiceUpdateResponse, error) - // Delete a tenant + // Delete a tenant. Delete(context.Context, *v2.TenantServiceDeleteRequest) (*v2.TenantServiceDeleteResponse, error) - // Leave removes a member from a tenant + // Leave removes a member from a tenant. Leave(context.Context, *v2.TenantServiceLeaveRequest) (*v2.TenantServiceLeaveResponse, error) - // AddMember adds a member to a tenant + // AddMember adds a member to a tenant. AddMember(context.Context, *v2.TenantServiceAddMemberRequest) (*v2.TenantServiceAddMemberResponse, error) - // RemoveMember removes a member from a tenant + // RemoveMember removes a member from a tenant. RemoveMember(context.Context, *v2.TenantServiceRemoveMemberRequest) (*v2.TenantServiceRemoveMemberResponse, error) // UpdateMember update a member of a tenant UpdateMember(context.Context, *v2.TenantServiceUpdateMemberRequest) (*v2.TenantServiceUpdateMemberResponse, error) - // Invite a user to a tenant + // Invite a user to a tenant. Invite(context.Context, *v2.TenantServiceInviteRequest) (*v2.TenantServiceInviteResponse, error) - // InviteAccept is called from a user to accept an invitation + // InviteAccept is called from a user to accept an invitation. InviteAccept(context.Context, *v2.TenantServiceInviteAcceptRequest) (*v2.TenantServiceInviteAcceptResponse, error) - // InviteDelete deletes a pending invitation + // InviteDelete deletes a pending invitation. InviteDelete(context.Context, *v2.TenantServiceInviteDeleteRequest) (*v2.TenantServiceInviteDeleteResponse, error) - // InvitesList list all invites to a tenant + // InvitesList list all invites to a tenant. InvitesList(context.Context, *v2.TenantServiceInvitesListRequest) (*v2.TenantServiceInvitesListResponse, error) // InviteGet get an invite InviteGet(context.Context, *v2.TenantServiceInviteGetRequest) (*v2.TenantServiceInviteGetResponse, error) @@ -348,27 +348,27 @@ type TenantServiceHandler interface { Create(context.Context, *v2.TenantServiceCreateRequest) (*v2.TenantServiceCreateResponse, error) // Returns the list of tenants. List(context.Context, *v2.TenantServiceListRequest) (*v2.TenantServiceListResponse, error) - // Get a tenant + // Get a tenant. Get(context.Context, *v2.TenantServiceGetRequest) (*v2.TenantServiceGetResponse, error) - // Update a tenant + // Update a tenant. Update(context.Context, *v2.TenantServiceUpdateRequest) (*v2.TenantServiceUpdateResponse, error) - // Delete a tenant + // Delete a tenant. Delete(context.Context, *v2.TenantServiceDeleteRequest) (*v2.TenantServiceDeleteResponse, error) - // Leave removes a member from a tenant + // Leave removes a member from a tenant. Leave(context.Context, *v2.TenantServiceLeaveRequest) (*v2.TenantServiceLeaveResponse, error) - // AddMember adds a member to a tenant + // AddMember adds a member to a tenant. AddMember(context.Context, *v2.TenantServiceAddMemberRequest) (*v2.TenantServiceAddMemberResponse, error) - // RemoveMember removes a member from a tenant + // RemoveMember removes a member from a tenant. RemoveMember(context.Context, *v2.TenantServiceRemoveMemberRequest) (*v2.TenantServiceRemoveMemberResponse, error) // UpdateMember update a member of a tenant UpdateMember(context.Context, *v2.TenantServiceUpdateMemberRequest) (*v2.TenantServiceUpdateMemberResponse, error) - // Invite a user to a tenant + // Invite a user to a tenant. Invite(context.Context, *v2.TenantServiceInviteRequest) (*v2.TenantServiceInviteResponse, error) - // InviteAccept is called from a user to accept an invitation + // InviteAccept is called from a user to accept an invitation. InviteAccept(context.Context, *v2.TenantServiceInviteAcceptRequest) (*v2.TenantServiceInviteAcceptResponse, error) - // InviteDelete deletes a pending invitation + // InviteDelete deletes a pending invitation. InviteDelete(context.Context, *v2.TenantServiceInviteDeleteRequest) (*v2.TenantServiceInviteDeleteResponse, error) - // InvitesList list all invites to a tenant + // InvitesList list all invites to a tenant. InvitesList(context.Context, *v2.TenantServiceInvitesListRequest) (*v2.TenantServiceInvitesListResponse, error) // InviteGet get an invite InviteGet(context.Context, *v2.TenantServiceInviteGetRequest) (*v2.TenantServiceInviteGetResponse, error) diff --git a/go/metalstack/api/v2/audit.pb.go b/go/metalstack/api/v2/audit.pb.go index 25c5a1b5..88630a67 100644 --- a/go/metalstack/api/v2/audit.pb.go +++ b/go/metalstack/api/v2/audit.pb.go @@ -27,11 +27,11 @@ const ( type AuditPhase int32 const ( - // AUDIT_PHASE_UNSPECIFIED is not specified + // AUDIT_PHASE_UNSPECIFIED is not specified. AuditPhase_AUDIT_PHASE_UNSPECIFIED AuditPhase = 0 - // AUDIT_PHASE_REQUEST defines an audit trace in the request phase + // AUDIT_PHASE_REQUEST defines an audit trace in the request phase. AuditPhase_AUDIT_PHASE_REQUEST AuditPhase = 1 - // AUDIT_PHASE_RESPONSE 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 ) @@ -81,23 +81,23 @@ 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 response 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"` - // SourceIP 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"` - // 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 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 represents the phase of the audit trace. Phase AuditPhase `protobuf:"varint,10,opt,name=phase,proto3,enum=metalstack.api.v2.AuditPhase" json:"phase,omitempty"` // Meta for this audit trace Meta *Meta `protobuf:"bytes,11,opt,name=meta,proto3" json:"meta,omitempty"` @@ -212,30 +212,30 @@ func (x *AuditTrace) GetMeta() *Meta { return nil } -// AuditQuery is the query for audit traces +// AuditQuery is the query for audit traces. type AuditQuery struct { state protoimpl.MessageState `protogen:"open.v1"` // Uuid of the audit trace Uuid *string `protobuf:"bytes,2,opt,name=uuid,proto3,oneof" json:"uuid,omitempty"` - // From describes the start of the time window in which to list audit traces. Defaults to the last eight hours + // From describes the start of the time window in which to list audit traces. Defaults to the last eight hours. From *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=from,proto3,oneof" json:"from,omitempty"` - // To describes the end of the time window in which to list audit traces. Defaults to the time the request was issued + // To describes the end of the time window in which to list audit traces. Defaults to the time the request was issued. To *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=to,proto3,oneof" json:"to,omitempty"` - // User is the user who called the api method + // User is the user who called the api method. User *string `protobuf:"bytes,5,opt,name=user,proto3,oneof" json:"user,omitempty"` - // Project is the project targeted by the api call + // Project is the project targeted by the api call. Project *string `protobuf:"bytes,6,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,7,opt,name=method,proto3,oneof" json:"method,omitempty"` - // Source IP contains the ip address of the caller + // Source IP contains the ip address of the caller. SourceIp *string `protobuf:"bytes,8,opt,name=source_ip,json=sourceIp,proto3,oneof" json:"source_ip,omitempty"` - // Result Code is a string describing the result of the api call + // Result Code is a string describing the result of the api call. ResultCode *int32 `protobuf:"varint,9,opt,name=result_code,json=resultCode,proto3,oneof" json:"result_code,omitempty"` - // Body is a string providing text-search of the body field + // Body is a string providing text-search of the body field. Body *string `protobuf:"bytes,10,opt,name=body,proto3,oneof" json:"body,omitempty"` // Limit is a number limiting the length of the response (min: 1, max: 1000, defaults to 200) Limit *int32 `protobuf:"varint,11,opt,name=limit,proto3,oneof" json:"limit,omitempty"` - // Phase specifies the audit phase + // Phase specifies the audit phase. Phase *AuditPhase `protobuf:"varint,12,opt,name=phase,proto3,enum=metalstack.api.v2.AuditPhase,oneof" json:"phase,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -348,12 +348,12 @@ func (x *AuditQuery) GetPhase() AuditPhase { return AuditPhase_AUDIT_PHASE_UNSPECIFIED } -// AuditServiceListRequest is the request payload for an audit list request +// AuditServiceListRequest is the request payload for an audit list request. type AuditServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Login for this tenant Login string `protobuf:"bytes,1,opt,name=login,proto3" json:"login,omitempty"` - // Query for audit traces + // Query for audit traces. Query *AuditQuery `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -403,10 +403,10 @@ func (x *AuditServiceListRequest) GetQuery() *AuditQuery { return nil } -// AuditServiceListResponse is the response payload of a audit list request +// AuditServiceListResponse is the response payload of a audit list request. type AuditServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Traces is a list of audit traces + // Traces is a list of audit traces. Traces []*AuditTrace `protobuf:"bytes,1,rep,name=traces,proto3" json:"traces,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -449,14 +449,14 @@ func (x *AuditServiceListResponse) GetTraces() []*AuditTrace { return nil } -// AuditServiceGetRequest is the request payload of a audit get request +// AuditServiceGetRequest is the request payload of a audit get request. type AuditServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Login for this tenant Login string `protobuf:"bytes,1,opt,name=login,proto3" json:"login,omitempty"` // Uuid of the audit trace Uuid string `protobuf:"bytes,2,opt,name=uuid,proto3" json:"uuid,omitempty"` - // Phase specifies the audit phase. Defaults to request + // Phase specifies the audit phase. Defaults to request. Phase *AuditPhase `protobuf:"varint,3,opt,name=phase,proto3,enum=metalstack.api.v2.AuditPhase,oneof" json:"phase,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -513,10 +513,10 @@ func (x *AuditServiceGetRequest) GetPhase() AuditPhase { return AuditPhase_AUDIT_PHASE_UNSPECIFIED } -// AuditServiceGetResponse is the response payload of a audit get request +// AuditServiceGetResponse is the response payload of a audit get request. type AuditServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Trace is the audit trace + // Trace is the audit trace. Trace *AuditTrace `protobuf:"bytes,1,opt,name=trace,proto3" json:"trace,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/api/v2/common.pb.go b/go/metalstack/api/v2/common.pb.go index f3733236..e9c5230b 100644 --- a/go/metalstack/api/v2/common.pb.go +++ b/go/metalstack/api/v2/common.pb.go @@ -24,11 +24,11 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) -// TenantRole specifies what role a logged in user needs to call this tenant scoped service +// TenantRole specifies what role a logged in user needs to call this tenant scoped service. type TenantRole int32 const ( - // TENANT_ROLE_UNSPECIFIED is not specified + // TENANT_ROLE_UNSPECIFIED is not specified. TenantRole_TENANT_ROLE_UNSPECIFIED TenantRole = 0 // TENANT_ROLE_OWNER the logged in user needs at least owner role to call this method TenantRole_TENANT_ROLE_OWNER TenantRole = 1 @@ -37,7 +37,7 @@ const ( // TENANT_ROLE_VIEWER the logged in user needs at least viewer role to call this method TenantRole_TENANT_ROLE_VIEWER TenantRole = 3 // TENANT_ROLE_GUEST the logged in user needs at least guest role to call this method - // The guest role is assumed by users who are invited to a tenant's project without them + // The guest role is assumed by users who are invited to a tenant's project without them. // having a direct membership within the tenant. TenantRole_TENANT_ROLE_GUEST TenantRole = 4 ) @@ -87,11 +87,11 @@ func (TenantRole) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_common_proto_rawDescGZIP(), []int{0} } -// ProjectRole specifies what role a logged in user needs to call this project scoped service +// ProjectRole specifies what role a logged in user needs to call this project scoped service. type ProjectRole int32 const ( - // PROJECT_ROLE_UNSPECIFIED is not specified + // PROJECT_ROLE_UNSPECIFIED is not specified. ProjectRole_PROJECT_ROLE_UNSPECIFIED ProjectRole = 0 // PROJECT_ROLE_OWNER the logged in user needs at least owner role to call this method ProjectRole_PROJECT_ROLE_OWNER ProjectRole = 1 @@ -144,11 +144,11 @@ func (ProjectRole) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_common_proto_rawDescGZIP(), []int{1} } -// AdminRole specifies what role a logged in user needs to call this admin service +// AdminRole specifies what role a logged in user needs to call this admin service. type AdminRole int32 const ( - // ADMIN_ROLE_UNSPECIFIED is not specified + // ADMIN_ROLE_UNSPECIFIED is not specified. AdminRole_ADMIN_ROLE_UNSPECIFIED AdminRole = 0 // ADMIN_ROLE_EDITOR the logged in user needs at least editor role to call this method AdminRole_ADMIN_ROLE_EDITOR AdminRole = 1 @@ -197,11 +197,11 @@ func (AdminRole) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_common_proto_rawDescGZIP(), []int{2} } -// InfraRole specifies what role a microservice needs to call this infra service +// InfraRole specifies what role a microservice needs to call this infra service. type InfraRole int32 const ( - // INFRA_ROLE_UNSPECIFIED is not specified + // INFRA_ROLE_UNSPECIFIED is not specified. InfraRole_INFRA_ROLE_UNSPECIFIED InfraRole = 0 // INFRA_ROLE_EDITOR a microservice needs at least editor role to call this method InfraRole_INFRA_ROLE_EDITOR InfraRole = 1 @@ -250,11 +250,11 @@ func (InfraRole) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_common_proto_rawDescGZIP(), []int{3} } -// MachineRole specifies what role a microservice needs to call this machine service +// MachineRole specifies what role a microservice needs to call this machine service. type MachineRole int32 const ( - // MACHINE_ROLE_UNSPECIFIED is not specified + // MACHINE_ROLE_UNSPECIFIED is not specified. MachineRole_MACHINE_ROLE_UNSPECIFIED MachineRole = 0 // MACHINE_ROLE_EDITOR a microservice needs at least editor role to call this method MachineRole_MACHINE_ROLE_EDITOR MachineRole = 1 @@ -307,9 +307,9 @@ func (MachineRole) EnumDescriptor() ([]byte, []int) { type Visibility int32 const ( - // VISIBILITY_UNSPECIFIED is not defined + // VISIBILITY_UNSPECIFIED is not defined. Visibility_VISIBILITY_UNSPECIFIED Visibility = 0 - // VISIBILITY_PUBLIC specifies that this service is accessible without authentication + // VISIBILITY_PUBLIC specifies that this service is accessible without authentication. Visibility_VISIBILITY_PUBLIC Visibility = 1 // VISIBILITY_SELF restricts calls to the authenticated user only Visibility_VISIBILITY_SELF Visibility = 2 @@ -362,7 +362,7 @@ func (Visibility) EnumDescriptor() ([]byte, []int) { type Auditing int32 const ( - // AUDITING_UNSPECIFIED is not specified + // AUDITING_UNSPECIFIED is not specified. Auditing_AUDITING_UNSPECIFIED Auditing = 0 // AUDITING_INCLUDED if a method is annotated with this, all calls are audited Auditing_AUDITING_INCLUDED Auditing = 1 @@ -466,13 +466,13 @@ func (OptimisticLockingStrategy) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_common_proto_rawDescGZIP(), []int{7} } -// Paging defines paging for methods with a lot of results +// Paging defines paging for methods with a lot of results. type Paging struct { state protoimpl.MessageState `protogen:"open.v1"` // Page is used for pagination, if unset only the first page is returned, // the list response contains then the page number for the next page. Page *uint64 `protobuf:"varint,1,opt,name=page,proto3,oneof" json:"page,omitempty"` - // Count is the number of results returned per page, if not given server side defaults apply + // Count is the number of results returned per page, if not given server side defaults apply. Count *uint64 `protobuf:"varint,2,opt,name=count,proto3,oneof" json:"count,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -522,7 +522,7 @@ func (x *Paging) GetCount() uint64 { return 0 } -// Labels define additional information to a entity +// Labels define additional information to a entity. type Labels struct { state protoimpl.MessageState `protogen:"open.v1"` // Labels consists labels @@ -573,9 +573,9 @@ type Meta struct { state protoimpl.MessageState `protogen:"open.v1"` // Tags on this entity Labels *Labels `protobuf:"bytes,1,opt,name=labels,proto3,oneof" json:"labels,omitempty"` - // CreatedAt is the date when this entity was created + // CreatedAt is the date when this entity was created. CreatedAt *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"` - // UpdatedAt is the date when this entity was updated + // 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"` // Generation identifies how often this entity was modified since creation. @@ -652,10 +652,10 @@ func (x *Meta) GetDeletionTaskId() string { return "" } -// UpdateLabels is a message to update labels +// UpdateLabels is a message to update labels. type UpdateLabels struct { state protoimpl.MessageState `protogen:"open.v1"` - // Strategy defines the label update strategy + // Strategy defines the label update strategy. // // Types that are valid to be assigned to Strategy: // @@ -731,7 +731,7 @@ type UpdateLabels_Replace struct { } type UpdateLabels_Patch struct { - // Patch adds, updates or remove given labels without modifying others + // Patch adds, updates or remove given labels without modifying others. Patch *LabelsPatch `protobuf:"bytes,2,opt,name=patch,proto3,oneof"` } @@ -739,12 +739,12 @@ func (*UpdateLabels_Replace) isUpdateLabels_Strategy() {} func (*UpdateLabels_Patch) isUpdateLabels_Strategy() {} -// LabelsPatch adds, updates or remove given labels without modifying others +// LabelsPatch adds, updates or remove given labels without modifying others. type LabelsPatch struct { state protoimpl.MessageState `protogen:"open.v1"` - // Update labels. New ones will be added, existing ones overwritten + // Update labels. New ones will be added, existing ones overwritten. Update *Labels `protobuf:"bytes,1,opt,name=update,proto3" json:"update,omitempty"` - // Remove labels by key + // Remove labels by key. Remove []string `protobuf:"bytes,2,rep,name=remove,proto3" json:"remove,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -794,10 +794,10 @@ func (x *LabelsPatch) GetRemove() []string { return nil } -// UpdateMeta must be provided with every UpdateRequest to define how optimistic locking should be handled +// UpdateMeta must be provided with every UpdateRequest to define how optimistic locking should be handled. type UpdateMeta struct { state protoimpl.MessageState `protogen:"open.v1"` - // UpdatedAt is the date when this entity was updated + // 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,1,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"` // LockingStrategy to be used for this update request @@ -919,31 +919,31 @@ var file_metalstack_api_v2_common_proto_extTypes = []protoimpl.ExtensionInfo{ // Extension fields to descriptorpb.MethodOptions. var ( - // TenantRoles are used to define the tenant role a logged in user must provide to call this method + // TenantRoles are used to define the tenant role a logged in user must provide to call this method. // // repeated metalstack.api.v2.TenantRole tenant_roles = 51000; E_TenantRoles = &file_metalstack_api_v2_common_proto_extTypes[0] - // ProjectRoles are used to define the project role a logged in user must provide to call this method + // ProjectRoles are used to define the project role a logged in user must provide to call this method. // // repeated metalstack.api.v2.ProjectRole project_roles = 51001; E_ProjectRoles = &file_metalstack_api_v2_common_proto_extTypes[1] - // AdminRoles are used to define the admin role a logged in user must provide to call this method + // AdminRoles are used to define the admin role a logged in user must provide to call this method. // // repeated metalstack.api.v2.AdminRole admin_roles = 51002; E_AdminRoles = &file_metalstack_api_v2_common_proto_extTypes[2] - // Visibility defines the visibility of this method, this is used to have public or self visible methods + // Visibility defines the visibility of this method, this is used to have public or self visible methods. // // optional metalstack.api.v2.Visibility visibility = 51003; E_Visibility = &file_metalstack_api_v2_common_proto_extTypes[3] - // Auditing defines if calls to this method should be audited or not + // Auditing defines if calls to this method should be audited or not. // // optional metalstack.api.v2.Auditing auditing = 51004; E_Auditing = &file_metalstack_api_v2_common_proto_extTypes[4] - // InfraRoles are used to define the infra role a microservice must provide to call this method + // InfraRoles are used to define the infra role a microservice must provide to call this method. // // repeated metalstack.api.v2.InfraRole infra_roles = 51005; E_InfraRoles = &file_metalstack_api_v2_common_proto_extTypes[5] - // MachineRole are used to define which machine role a microservice must provide to call this method + // MachineRole are used to define which machine role a microservice must provide to call this method. // // repeated metalstack.api.v2.MachineRole machine_roles = 51006; E_MachineRoles = &file_metalstack_api_v2_common_proto_extTypes[6] diff --git a/go/metalstack/api/v2/component.pb.go b/go/metalstack/api/v2/component.pb.go index 6e92d8d3..ae66afc6 100644 --- a/go/metalstack/api/v2/component.pb.go +++ b/go/metalstack/api/v2/component.pb.go @@ -24,23 +24,23 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) -// ComponentType defines which service is actually pinging +// ComponentType defines which service is actually pinging. type ComponentType int32 const ( - // COMPONENT_TYPE_UNSPECIFIED is unspecified + // COMPONENT_TYPE_UNSPECIFIED is unspecified. ComponentType_COMPONENT_TYPE_UNSPECIFIED ComponentType = 0 - // COMPONENT_TYPE_PIXIECORE is pixiecore + // COMPONENT_TYPE_PIXIECORE is pixiecore. ComponentType_COMPONENT_TYPE_PIXIECORE ComponentType = 1 - // COMPONENT_TYPE_METAL_CORE is metal-core + // COMPONENT_TYPE_METAL_CORE is metal-core. ComponentType_COMPONENT_TYPE_METAL_CORE ComponentType = 2 - // COMPONENT_TYPE_METAL_BMC is metal-bmc + // COMPONENT_TYPE_METAL_BMC is metal-bmc. ComponentType_COMPONENT_TYPE_METAL_BMC ComponentType = 3 - // COMPONENT_TYPE_METAL_IMAGE_CACHE_SYNC is metal-image-cache-sync + // COMPONENT_TYPE_METAL_IMAGE_CACHE_SYNC is metal-image-cache-sync. ComponentType_COMPONENT_TYPE_METAL_IMAGE_CACHE_SYNC ComponentType = 4 - // COMPONENT_TYPE_METAL_CONSOLE is metal-console + // COMPONENT_TYPE_METAL_CONSOLE is metal-console. ComponentType_COMPONENT_TYPE_METAL_CONSOLE ComponentType = 5 - // COMPONENT_TYPE_METAL_METRICS_EXPORTER is metal-metrics-exporter + // COMPONENT_TYPE_METAL_METRICS_EXPORTER is metal-metrics-exporter. ComponentType_COMPONENT_TYPE_METAL_METRICS_EXPORTER ComponentType = 6 ) @@ -93,17 +93,17 @@ func (ComponentType) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_component_proto_rawDescGZIP(), []int{0} } -// Component represents a microservice connected to our apiserver +// Component represents a microservice connected to our apiserver. type Component struct { state protoimpl.MessageState `protogen:"open.v1"` - // UUID identifies this component event + // UUID identifies this component event. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` - // Type defines which service is actually pinging + // Type defines which service is actually pinging. Type ComponentType `protobuf:"varint,2,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 string `protobuf:"bytes,3,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,4,opt,name=started_at,json=startedAt,proto3" json:"started_at,omitempty"` // ReportedAt is the timestamp this service sent this ping. ReportedAt *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=reported_at,json=reportedAt,proto3" json:"reported_at,omitempty"` @@ -215,9 +215,9 @@ func (x *Component) GetMeta() *Meta { // ComponentQuery to query components type ComponentQuery struct { state protoimpl.MessageState `protogen:"open.v1"` - // UUID identifies this component + // UUID identifies this component. Uuid *string `protobuf:"bytes,1,opt,name=uuid,proto3,oneof" json:"uuid,omitempty"` - // Type defines which service is actually pinging + // Type defines which service is actually pinging. Type *ComponentType `protobuf:"varint,2,opt,name=type,proto3,enum=metalstack.api.v2.ComponentType,oneof" 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. diff --git a/go/metalstack/api/v2/filesystem.pb.go b/go/metalstack/api/v2/filesystem.pb.go index 296c13de..a2552191 100644 --- a/go/metalstack/api/v2/filesystem.pb.go +++ b/go/metalstack/api/v2/filesystem.pb.go @@ -26,7 +26,7 @@ const ( type LVMType int32 const ( - // LVM_TYPE_UNSPECIFIED is not specified + // LVM_TYPE_UNSPECIFIED is not specified. LVMType_LVM_TYPE_UNSPECIFIED LVMType = 0 // LVM_TYPE_LINEAR append across all physical volumes LVMType_LVM_TYPE_LINEAR LVMType = 1 @@ -79,21 +79,21 @@ func (LVMType) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_filesystem_proto_rawDescGZIP(), []int{0} } -// Format specifies the filesystem to use on a volume +// Format specifies the filesystem to use on a volume. type Format int32 const ( // FORMAT_UNSPECIFIED Format_FORMAT_UNSPECIFIED Format = 0 - // FORMAT_VFAT is used for the UEFI boot partition + // FORMAT_VFAT is used for the UEFI boot partition. Format_FORMAT_VFAT Format = 1 - // FORMAT_EXT3 is usually only used for /boot + // FORMAT_EXT3 is usually only used for /boot. Format_FORMAT_EXT3 Format = 2 - // FORMAT_EXT4 is the default fs + // FORMAT_EXT4 is the default fs. Format_FORMAT_EXT4 Format = 3 - // FORMAT_SWAP is for the swap partition + // FORMAT_SWAP is for the swap partition. Format_FORMAT_SWAP Format = 4 - // FORMAT_TMPFS is used for a memory filesystem typically /tmp + // FORMAT_TMPFS is used for a memory filesystem typically /tmp. Format_FORMAT_TMPFS Format = 5 // FORMAT_NONE Format_FORMAT_NONE Format = 6 @@ -148,11 +148,11 @@ func (Format) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_filesystem_proto_rawDescGZIP(), []int{1} } -// GPTType specifies the partition type in uefi systems +// GPTType specifies the partition type in uefi systems. type GPTType int32 const ( - // GPT_TYPE_UNSPECIFIED is no specified + // GPT_TYPE_UNSPECIFIED is no specified. GPTType_GPT_TYPE_UNSPECIFIED GPTType = 0 // GPT_TYPE_BOOT EFI Boot Partition GPTType_GPT_TYPE_BOOT GPTType = 1 @@ -209,15 +209,15 @@ func (GPTType) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_filesystem_proto_rawDescGZIP(), []int{2} } -// RaidLevel defines howto mirror two or more block devices +// RaidLevel defines howto mirror two or more block devices. type RaidLevel int32 const ( - // RAID_LEVEL_UNSPECIFIED is not specified + // RAID_LEVEL_UNSPECIFIED is not specified. RaidLevel_RAID_LEVEL_UNSPECIFIED RaidLevel = 0 - // RAID_LEVEL_0 is a stripe of two or more disks + // RAID_LEVEL_0 is a stripe of two or more disks. RaidLevel_RAID_LEVEL_0 RaidLevel = 1 - // RAID_LEVEL_1 is a mirror of two disks + // RAID_LEVEL_1 is a mirror of two disks. RaidLevel_RAID_LEVEL_1 RaidLevel = 2 ) @@ -262,7 +262,7 @@ func (RaidLevel) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_filesystem_proto_rawDescGZIP(), []int{3} } -// FilesystemServiceGetRequest is the request payload for a filesystem get request +// FilesystemServiceGetRequest is the request payload for a filesystem get request. type FilesystemServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // ID of the filesystem to get @@ -308,7 +308,7 @@ func (x *FilesystemServiceGetRequest) GetId() string { return "" } -// FilesystemServiceListRequest is the request payload for a filesystem list request +// FilesystemServiceListRequest is the request payload for a filesystem list request. type FilesystemServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // ID of the filesystem to get @@ -354,7 +354,7 @@ func (x *FilesystemServiceListRequest) GetId() string { return "" } -// FilesystemServiceGetResponse is the response payload for a filesystem get request +// FilesystemServiceGetResponse is the response payload for a filesystem get request. type FilesystemServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // FilesystemLayout the filesystemlayout @@ -400,7 +400,7 @@ func (x *FilesystemServiceGetResponse) GetFilesystemLayout() *FilesystemLayout { return nil } -// FilesystemServiceListResponse is the response payload for a filesystem list request +// FilesystemServiceListResponse is the response payload for a filesystem list request. type FilesystemServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // FilesystemLayouts the filesystemlayouts @@ -457,15 +457,15 @@ type FilesystemLayout struct { Name *string `protobuf:"bytes,3,opt,name=name,proto3,oneof" json:"name,omitempty"` // Description of this filesystemLayout Description *string `protobuf:"bytes,4,opt,name=description,proto3,oneof" json:"description,omitempty"` - // Filesystems is a list of filesystems to create on a machine + // Filesystems is a list of filesystems to create on a machine. Filesystems []*Filesystem `protobuf:"bytes,5,rep,name=filesystems,proto3" json:"filesystems,omitempty"` - // Disks list of disks that belong to this layout + // Disks list of disks that belong to this layout. Disks []*Disk `protobuf:"bytes,6,rep,name=disks,proto3" json:"disks,omitempty"` // raid arrays to create Raid []*Raid `protobuf:"bytes,7,rep,name=raid,proto3" json:"raid,omitempty"` - // VolumeGroups list of volumegroups to create + // VolumeGroups list of volumegroups to create. VolumeGroups []*VolumeGroup `protobuf:"bytes,8,rep,name=volume_groups,json=volumeGroups,proto3" json:"volume_groups,omitempty"` - // LogicalVolumes list of logicalvolumes to create + // LogicalVolumes list of logicalvolumes to create. LogicalVolumes []*LogicalVolume `protobuf:"bytes,9,rep,name=logical_volumes,json=logicalVolumes,proto3" json:"logical_volumes,omitempty"` // Constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts Constraints *FilesystemLayoutConstraints `protobuf:"bytes,10,opt,name=constraints,proto3" json:"constraints,omitempty"` @@ -576,10 +576,10 @@ func (x *FilesystemLayout) GetConstraints() *FilesystemLayoutConstraints { // FilesystemLayoutConstraints type FilesystemLayoutConstraints struct { state protoimpl.MessageState `protogen:"open.v1"` - // Sizes list of sizes this layout applies to + // Sizes list of sizes this layout applies to. // this could either be a concrete size, or a asterisk to match all sizes Sizes []string `protobuf:"bytes,1,rep,name=sizes,proto3" json:"sizes,omitempty"` - // Images list of images this layout applies to in the following form + // Images list of images this layout applies to in the following form. // key must be the first part of available images, e.g. the name of the image // value must be a semver match expression with the constraint and the version separated by space // this would match all debian images which are greater or equal 12.0 @@ -747,7 +747,7 @@ type Disk struct { state protoimpl.MessageState `protogen:"open.v1"` // Device the device to create the partitions Device string `protobuf:"bytes,1,opt,name=device,proto3" json:"device,omitempty"` - // Partitions list of partitions to create on this disk + // Partitions list of partitions to create on this disk. Partitions []*DiskPartition `protobuf:"bytes,2,rep,name=partitions,proto3" json:"partitions,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -802,9 +802,9 @@ type Raid struct { state protoimpl.MessageState `protogen:"open.v1"` // ArrayName the name of the resulting array device ArrayName string `protobuf:"bytes,1,opt,name=array_name,json=arrayName,proto3" json:"array_name,omitempty"` - // Devices list of devices to form the raid array from + // Devices list of devices to form the raid array from. Devices []string `protobuf:"bytes,2,rep,name=devices,proto3" json:"devices,omitempty"` - // Level raid level to create, should be 0 or 1 + // Level raid level to create, should be 0 or 1. Level RaidLevel `protobuf:"varint,3,opt,name=level,proto3,enum=metalstack.api.v2.RaidLevel" json:"level,omitempty"` // CreateOptions the options to use to create the raid array CreateOptions []string `protobuf:"bytes,4,rep,name=create_options,json=createOptions,proto3" json:"create_options,omitempty"` @@ -882,7 +882,7 @@ func (x *Raid) GetSpares() int32 { // DiskPartition type DiskPartition struct { state protoimpl.MessageState `protogen:"open.v1"` - // Number partition number, will be appended to partitionprefix to create the final devicename + // Number partition number, will be appended to partitionprefix to create the final devicename. Number uint32 `protobuf:"varint,1,opt,name=number,proto3" json:"number,omitempty"` // Label an optional label for this partition Label *string `protobuf:"bytes,2,opt,name=label,proto3,oneof" json:"label,omitempty"` @@ -957,9 +957,9 @@ type VolumeGroup struct { state protoimpl.MessageState `protogen:"open.v1"` // Name the name of the resulting volume group Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` - // Devices list of devices to form the volume group from + // Devices list of devices to form the volume group from. Devices []string `protobuf:"bytes,2,rep,name=devices,proto3" json:"devices,omitempty"` - // Tags list of tags to add to the volume group + // Tags list of tags to add to the volume group. Tags []string `protobuf:"bytes,3,rep,name=tags,proto3" json:"tags,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/api/v2/health.pb.go b/go/metalstack/api/v2/health.pb.go index fad45d15..fd8322b8 100644 --- a/go/metalstack/api/v2/health.pb.go +++ b/go/metalstack/api/v2/health.pb.go @@ -82,7 +82,7 @@ func (ServiceStatus) EnumDescriptor() ([]byte, []int) { type Service int32 const ( - // SERVICE_UNSPECIFIED is a unknown service + // SERVICE_UNSPECIFIED is a unknown service. Service_SERVICE_UNSPECIFIED Service = 0 // SERVICE_IPAM the IPAM service Service_SERVICE_IPAM Service = 1 @@ -158,7 +158,7 @@ func (Service) EnumDescriptor() ([]byte, []int) { // Health reports the health status of all services. type Health struct { state protoimpl.MessageState `protogen:"open.v1"` - // Services contains 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 @@ -204,13 +204,13 @@ func (x *Health) GetServices() []*HealthStatus { // HealthStatus represents the health status of one service. type HealthStatus struct { state protoimpl.MessageState `protogen:"open.v1"` - // Name is 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 is 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 describes the reason for the unhealthy status if possible. Message string `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"` - // Partitions describes the health of the service by partition + // Partitions describes the health of the service by partition. Partitions map[string]*PartitionHealth `protobuf:"bytes,4,rep,name=partitions,proto3" json:"partitions,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -277,9 +277,9 @@ func (x *HealthStatus) GetPartitions() map[string]*PartitionHealth { // PartitionHealth represents the status of a specific service in this partition. type PartitionHealth struct { state protoimpl.MessageState `protogen:"open.v1"` - // Status is 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 describes the reason for the unhealthy status if possible. Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -369,7 +369,7 @@ func (*HealthServiceGetRequest) Descriptor() ([]byte, []int) { // HealthServiceGetResponse is the response payload for getting the health of the system. type HealthServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Health contains 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/image.pb.go b/go/metalstack/api/v2/image.pb.go index e939d0b8..22ecdc3f 100644 --- a/go/metalstack/api/v2/image.pb.go +++ b/go/metalstack/api/v2/image.pb.go @@ -27,11 +27,11 @@ const ( type ImageFeature int32 const ( - // IMAGE_FEATURE_UNSPECIFIED is not specified + // IMAGE_FEATURE_UNSPECIFIED is not specified. ImageFeature_IMAGE_FEATURE_UNSPECIFIED ImageFeature = 0 - // IMAGE_FEATURE_MACHINE indicates this image is usable for a machine + // IMAGE_FEATURE_MACHINE indicates this image is usable for a machine. ImageFeature_IMAGE_FEATURE_MACHINE ImageFeature = 1 - // IMAGE_FEATURE_FIREWALL indicates this image is usable for a firewall + // IMAGE_FEATURE_FIREWALL indicates this image is usable for a firewall. ImageFeature_IMAGE_FEATURE_FIREWALL ImageFeature = 2 ) @@ -80,13 +80,13 @@ func (ImageFeature) EnumDescriptor() ([]byte, []int) { type ImageClassification int32 const ( - // IMAGE_CLASSIFICATION_UNSPECIFIED is not specified + // IMAGE_CLASSIFICATION_UNSPECIFIED is not specified. ImageClassification_IMAGE_CLASSIFICATION_UNSPECIFIED ImageClassification = 0 - // IMAGE_CLASSIFICATION_PREVIEW indicates that this image is in preview + // IMAGE_CLASSIFICATION_PREVIEW indicates that this image is in preview. ImageClassification_IMAGE_CLASSIFICATION_PREVIEW ImageClassification = 1 - // IMAGE_CLASSIFICATION_SUPPORTED indicates that this image is supported + // IMAGE_CLASSIFICATION_SUPPORTED indicates that this image is supported. ImageClassification_IMAGE_CLASSIFICATION_SUPPORTED ImageClassification = 2 - // IMAGE_CLASSIFICATION_DEPRECATED indicates that this image is deprecated + // IMAGE_CLASSIFICATION_DEPRECATED indicates that this image is deprecated. ImageClassification_IMAGE_CLASSIFICATION_DEPRECATED ImageClassification = 3 ) @@ -133,7 +133,7 @@ func (ImageClassification) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_image_proto_rawDescGZIP(), []int{1} } -// ImageServiceGetRequest is the request payload for an image get request +// ImageServiceGetRequest is the request payload for an image get request. type ImageServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // ID of the image to get @@ -179,10 +179,10 @@ func (x *ImageServiceGetRequest) GetId() string { return "" } -// ImageServiceListRequest is the request payload for an image list request +// ImageServiceListRequest is the request payload for an image list request. type ImageServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Query for images + // Query for images. Query *ImageQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -225,7 +225,7 @@ func (x *ImageServiceListRequest) GetQuery() *ImageQuery { return nil } -// ImageServiceLatestRequest is the request payload for an image latest request +// ImageServiceLatestRequest is the request payload for an image latest request. type ImageServiceLatestRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // OS for which the latest image should be fetched @@ -281,7 +281,7 @@ func (x *ImageServiceLatestRequest) GetClassification() ImageClassification { return ImageClassification_IMAGE_CLASSIFICATION_UNSPECIFIED } -// ImageServiceGetResponse is the response payload for an image get request +// ImageServiceGetResponse is the response payload for an image get request. type ImageServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Image the image @@ -327,7 +327,7 @@ func (x *ImageServiceGetResponse) GetImage() *Image { return nil } -// ImageServiceListResponse is the response payload for an image list request +// ImageServiceListResponse is the response payload for an image list request. type ImageServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Images the images @@ -373,7 +373,7 @@ func (x *ImageServiceListResponse) GetImages() []*Image { return nil } -// ImageServiceLatestResponse is the response payload for an image latest request +// ImageServiceLatestResponse is the response payload for an image latest request. type ImageServiceLatestResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Image which is the latest for one os @@ -436,7 +436,7 @@ type Image struct { Features []ImageFeature `protobuf:"varint,6,rep,packed,name=features,proto3,enum=metalstack.api.v2.ImageFeature" json:"features,omitempty"` // Classification of this image Classification ImageClassification `protobuf:"varint,7,opt,name=classification,proto3,enum=metalstack.api.v2.ImageClassification" json:"classification,omitempty"` - // ExpiresAt usage is not possible after this date + // ExpiresAt usage is not possible after this date. ExpiresAt *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -528,7 +528,7 @@ func (x *Image) GetExpiresAt() *timestamppb.Timestamp { return nil } -// ImageUsage reports which machines/firewalls actually use this image +// ImageUsage reports which machines/firewalls actually use this image. type ImageUsage struct { state protoimpl.MessageState `protogen:"open.v1"` // Image with usage @@ -583,7 +583,7 @@ func (x *ImageUsage) GetUsedBy() []string { return nil } -// ImageQuery is used to search images +// ImageQuery is used to search images. type ImageQuery struct { state protoimpl.MessageState `protogen:"open.v1"` // ID of the image to get @@ -602,7 +602,7 @@ type ImageQuery struct { Feature *ImageFeature `protobuf:"varint,7,opt,name=feature,proto3,enum=metalstack.api.v2.ImageFeature,oneof" json:"feature,omitempty"` // Classification of the image to query Classification *ImageClassification `protobuf:"varint,8,opt,name=classification,proto3,enum=metalstack.api.v2.ImageClassification,oneof" json:"classification,omitempty"` - // Labels lists only images containing the given labels + // Labels lists only images containing the given labels. Labels *Labels `protobuf:"bytes,9,opt,name=labels,proto3,oneof" json:"labels,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/api/v2/ip.pb.go b/go/metalstack/api/v2/ip.pb.go index aea26d36..60d599ff 100644 --- a/go/metalstack/api/v2/ip.pb.go +++ b/go/metalstack/api/v2/ip.pb.go @@ -22,15 +22,15 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) -// IPType specifies different IP address types +// IPType specifies different IP address types. type IPType int32 const ( - // IP_TYPE_UNSPECIFIED is not specified + // IP_TYPE_UNSPECIFIED is not specified. IPType_IP_TYPE_UNSPECIFIED IPType = 0 - // IP_TYPE_EPHEMERAL defines an ephemeral IP address which is freed/deleted after usage + // IP_TYPE_EPHEMERAL defines an ephemeral IP address which is freed/deleted after usage. IPType_IP_TYPE_EPHEMERAL IPType = 1 - // IP_TYPE_STATIC defines a static ip address which must be freed/deleted explicitly + // IP_TYPE_STATIC defines a static ip address which must be freed/deleted explicitly. IPType_IP_TYPE_STATIC IPType = 2 ) @@ -75,15 +75,15 @@ func (IPType) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_ip_proto_rawDescGZIP(), []int{0} } -// IPAddressFamily defines either IPv4 or IPv6 Addressfamily +// IPAddressFamily defines either IPv4 or IPv6 Addressfamily. type IPAddressFamily int32 const ( - // IP_ADDRESS_FAMILY_UNSPECIFIED is not specified + // IP_ADDRESS_FAMILY_UNSPECIFIED is not specified. IPAddressFamily_IP_ADDRESS_FAMILY_UNSPECIFIED IPAddressFamily = 0 - // IP_ADDRESS_FAMILY_V4 defines a IPv4 address + // IP_ADDRESS_FAMILY_V4 defines a IPv4 address. IPAddressFamily_IP_ADDRESS_FAMILY_V4 IPAddressFamily = 1 - // IP_ADDRESS_FAMILY_V6 defines a IPv6 address + // IP_ADDRESS_FAMILY_V6 defines a IPv6 address. IPAddressFamily_IP_ADDRESS_FAMILY_V6 IPAddressFamily = 2 ) @@ -128,26 +128,26 @@ func (IPAddressFamily) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_ip_proto_rawDescGZIP(), []int{1} } -// IP is an IP address which can be used as loadbalancer addresses +// IP is an IP address which can be used as loadbalancer addresses. type IP struct { state protoimpl.MessageState `protogen:"open.v1"` // Uuid of this ip Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` // Meta for this ip Meta *Meta `protobuf:"bytes,2,opt,name=meta,proto3" json:"meta,omitempty"` - // Ip is either ipv4 or ipv6 address + // Ip is either ipv4 or ipv6 address. Ip string `protobuf:"bytes,3,opt,name=ip,proto3" json:"ip,omitempty"` // Name of this ip Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"` // Description of this ip Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"` - // Network is the network this ip belongs to + // Network is the network this ip belongs to. Network string `protobuf:"bytes,6,opt,name=network,proto3" json:"network,omitempty"` - // Project where this ip address belongs to + // Project where this ip address belongs to. Project string `protobuf:"bytes,7,opt,name=project,proto3" json:"project,omitempty"` // Type of this ip Type IPType `protobuf:"varint,8,opt,name=type,proto3,enum=metalstack.api.v2.IPType" json:"type,omitempty"` - // Namespace if specified this ip is from a namespaced network and can therefore overlap with others + // Namespace if specified this ip is from a namespaced network and can therefore overlap with others. // Will be equal with project most of the time Namespace *string `protobuf:"bytes,9,opt,name=namespace,proto3,oneof" json:"namespace,omitempty"` unknownFields protoimpl.UnknownFields @@ -247,7 +247,7 @@ func (x *IP) GetNamespace() string { return "" } -// IPServiceGetRequest is the request payload for an IP get request +// IPServiceGetRequest is the request payload for an IP get request. type IPServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // IP of the ip to get @@ -311,10 +311,10 @@ func (x *IPServiceGetRequest) GetNamespace() string { return "" } -// IPServiceCreateRequest is the request payload for an IP create request +// IPServiceCreateRequest is the request payload for an IP create request. type IPServiceCreateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Network from which the IP should be created + // Network from which the IP should be created. Network string `protobuf:"bytes,1,opt,name=network,proto3" json:"network,omitempty"` // Project of the ip Project string `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"` @@ -429,12 +429,12 @@ func (x *IPServiceCreateRequest) GetAddressFamily() IPAddressFamily { return IPAddressFamily_IP_ADDRESS_FAMILY_UNSPECIFIED } -// IPServiceUpdateRequest is the request payload for an IP update request +// IPServiceUpdateRequest is the request payload for an IP update request. type IPServiceUpdateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Ip the ip address to update Ip string `protobuf:"bytes,1,opt,name=ip,proto3" json:"ip,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 *UpdateMeta `protobuf:"bytes,2,opt,name=update_meta,json=updateMeta,proto3" json:"update_meta,omitempty"` // Project id of the ip Project string `protobuf:"bytes,3,opt,name=project,proto3" json:"project,omitempty"` @@ -529,12 +529,12 @@ func (x *IPServiceUpdateRequest) GetLabels() *UpdateLabels { return nil } -// IPServiceListRequest is the request payload for an IP list request +// IPServiceListRequest is the request payload for an IP list request. type IPServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Project of the ips to list Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` - // Query to list one or more IPs + // Query to list one or more IPs. Query *IPQuery `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -584,12 +584,12 @@ func (x *IPServiceListRequest) GetQuery() *IPQuery { return nil } -// IPQuery can be used to query a IP or a list of IP +// IPQuery can be used to query a IP or a list of IP. type IPQuery struct { state protoimpl.MessageState `protogen:"open.v1"` // Ip the ip to list Ip *string `protobuf:"bytes,1,opt,name=ip,proto3,oneof" json:"ip,omitempty"` - // Network from which the IPs are to list + // Network from which the IPs are to list. Network *string `protobuf:"bytes,2,opt,name=network,proto3,oneof" json:"network,omitempty"` // Project of the ips to list Project *string `protobuf:"bytes,3,opt,name=project,proto3,oneof" json:"project,omitempty"` @@ -603,9 +603,9 @@ type IPQuery struct { ParentPrefixCidr *string `protobuf:"bytes,7,opt,name=parent_prefix_cidr,json=parentPrefixCidr,proto3,oneof" json:"parent_prefix_cidr,omitempty"` // Labels for which these IPs should be filtered Labels *Labels `protobuf:"bytes,8,opt,name=labels,proto3,oneof" json:"labels,omitempty"` - // Static if set to true, this will be a Static ip + // Static if set to true, this will be a Static ip. Type *IPType `protobuf:"varint,9,opt,name=type,proto3,enum=metalstack.api.v2.IPType,oneof" json:"type,omitempty"` - // Address family of the IPs to list, defaults to all address families + // Address family of the IPs to list, defaults to all address families. AddressFamily *IPAddressFamily `protobuf:"varint,10,opt,name=address_family,json=addressFamily,proto3,enum=metalstack.api.v2.IPAddressFamily,oneof" json:"address_family,omitempty"` // Namespace can be specified to get the ip of a namespace. Namespace *string `protobuf:"bytes,11,opt,name=namespace,proto3,oneof" json:"namespace,omitempty"` @@ -720,7 +720,7 @@ func (x *IPQuery) GetNamespace() string { return "" } -// IPServiceDeleteRequest is the request payload for a ip delete request +// IPServiceDeleteRequest is the request payload for a ip delete request. type IPServiceDeleteRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // IP of the ip to delete @@ -775,7 +775,7 @@ func (x *IPServiceDeleteRequest) GetProject() string { return "" } -// IPServiceGetResponse is the response payload for an IP get request +// IPServiceGetResponse is the response payload for an IP get request. type IPServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Ip the ip @@ -821,7 +821,7 @@ func (x *IPServiceGetResponse) GetIp() *IP { return nil } -// IPServiceUpdateResponse is the response payload for a ip update request +// IPServiceUpdateResponse is the response payload for a ip update request. type IPServiceUpdateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Ip the ip @@ -867,7 +867,7 @@ func (x *IPServiceUpdateResponse) GetIp() *IP { return nil } -// IPServiceCreateResponse is the response payload for an IP create request +// IPServiceCreateResponse is the response payload for an IP create request. type IPServiceCreateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Ip the ip @@ -913,7 +913,7 @@ func (x *IPServiceCreateResponse) GetIp() *IP { return nil } -// IPServiceListResponse is the response payload for an IP list request +// IPServiceListResponse is the response payload for an IP list request. type IPServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Ips the ips @@ -959,7 +959,7 @@ func (x *IPServiceListResponse) GetIps() []*IP { return nil } -// IPServiceDeleteResponse is the response payload for an IP delete request +// IPServiceDeleteResponse is the response payload for an IP delete request. type IPServiceDeleteResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Ip the ip diff --git a/go/metalstack/api/v2/machine.pb.go b/go/metalstack/api/v2/machine.pb.go index 174ee722..e110e679 100644 --- a/go/metalstack/api/v2/machine.pb.go +++ b/go/metalstack/api/v2/machine.pb.go @@ -24,15 +24,15 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) -// IPProtocol defines tcp|udp +// IPProtocol defines tcp|udp. type IPProtocol int32 const ( - // IP_PROTOCOL_UNSPECIFIED is not specified + // IP_PROTOCOL_UNSPECIFIED is not specified. IPProtocol_IP_PROTOCOL_UNSPECIFIED IPProtocol = 0 - // IP_PROTOCOL_TCP is tcp + // IP_PROTOCOL_TCP is tcp. IPProtocol_IP_PROTOCOL_TCP IPProtocol = 1 - // IP_PROTOCOL_UDP is udp + // IP_PROTOCOL_UDP is udp. IPProtocol_IP_PROTOCOL_UDP IPProtocol = 2 ) @@ -77,11 +77,11 @@ func (IPProtocol) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_machine_proto_rawDescGZIP(), []int{0} } -// MachineState defines if the machine was locked or reserved from a operator +// MachineState defines if the machine was locked or reserved from a operator. type MachineState int32 const ( - // MACHINE_STATE_UNSPECIFIED is not specified + // MACHINE_STATE_UNSPECIFIED is not specified. MachineState_MACHINE_STATE_UNSPECIFIED MachineState = 0 // MACHINE_STATE_TAINTED this machine is tainted, i.e. this machine is not considered during random machine allocation, but still by specifying the uuid MachineState_MACHINE_STATE_TAINTED MachineState = 1 @@ -138,7 +138,7 @@ func (MachineState) EnumDescriptor() ([]byte, []int) { type MachineProvisioningEventState int32 const ( - // MACHINE_PROVISIONING_EVENT_STATE_UNSPECIFIED is not specified + // MACHINE_PROVISIONING_EVENT_STATE_UNSPECIFIED is not specified. MachineProvisioningEventState_MACHINE_PROVISIONING_EVENT_STATE_UNSPECIFIED MachineProvisioningEventState = 0 // MACHINE_PROVISIONING_EVENT_STATE_CRASHLOOP machine is in crash loop MachineProvisioningEventState_MACHINE_PROVISIONING_EVENT_STATE_CRASHLOOP MachineProvisioningEventState = 1 @@ -187,11 +187,11 @@ func (MachineProvisioningEventState) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_machine_proto_rawDescGZIP(), []int{2} } -// MachineProvisioningEventType defines in which phase the machine actually is +// MachineProvisioningEventType defines in which phase the machine actually is. type MachineProvisioningEventType int32 const ( - // MACHINE_PROVISIONING_EVENT_TYPE_UNSPECIFIED is not specified + // MACHINE_PROVISIONING_EVENT_TYPE_UNSPECIFIED is not specified. MachineProvisioningEventType_MACHINE_PROVISIONING_EVENT_TYPE_UNSPECIFIED MachineProvisioningEventType = 0 // MACHINE_PROVISIONING_EVENT_TYPE_ALIVE machine is alive MachineProvisioningEventType_MACHINE_PROVISIONING_EVENT_TYPE_ALIVE MachineProvisioningEventType = 1 @@ -276,11 +276,11 @@ func (MachineProvisioningEventType) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_machine_proto_rawDescGZIP(), []int{3} } -// MachineLiveliness specifies the liveliness of a machine +// MachineLiveliness specifies the liveliness of a machine. type MachineLiveliness int32 const ( - // MACHINE_LIVELINESS_UNSPECIFIED is not defined + // MACHINE_LIVELINESS_UNSPECIFIED is not defined. MachineLiveliness_MACHINE_LIVELINESS_UNSPECIFIED MachineLiveliness = 0 // MACHINE_LIVELINESS_ALIVE liveliness is alive MachineLiveliness_MACHINE_LIVELINESS_ALIVE MachineLiveliness = 1 @@ -333,15 +333,15 @@ func (MachineLiveliness) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_machine_proto_rawDescGZIP(), []int{4} } -// MachineAllocationType defines if this is a machine or a firewall +// MachineAllocationType defines if this is a machine or a firewall. type MachineAllocationType int32 const ( - // MACHINE_ALLOCATION_TYPE_UNSPECIFIED is unspecified + // MACHINE_ALLOCATION_TYPE_UNSPECIFIED is unspecified. MachineAllocationType_MACHINE_ALLOCATION_TYPE_UNSPECIFIED MachineAllocationType = 0 - // MACHINE_ALLOCATION_TYPE_MACHINE is a machine + // MACHINE_ALLOCATION_TYPE_MACHINE is a machine. MachineAllocationType_MACHINE_ALLOCATION_TYPE_MACHINE MachineAllocationType = 1 - // MACHINE_ALLOCATION_TYPE_FIREWALL is a firewall + // MACHINE_ALLOCATION_TYPE_FIREWALL is a firewall. MachineAllocationType_MACHINE_ALLOCATION_TYPE_FIREWALL MachineAllocationType = 2 ) @@ -386,19 +386,19 @@ func (MachineAllocationType) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_machine_proto_rawDescGZIP(), []int{5} } -// MachineBMCCommand defines commands send to the BMC of the machine +// MachineBMCCommand defines commands send to the BMC of the machine. type MachineBMCCommand int32 const ( - // MACHINE_BMC_COMMAND_UNSPECIFIED is not defined + // MACHINE_BMC_COMMAND_UNSPECIFIED is not defined. MachineBMCCommand_MACHINE_BMC_COMMAND_UNSPECIFIED MachineBMCCommand = 0 - // MACHINE_BMC_COMMAND_ON Power on the machine + // MACHINE_BMC_COMMAND_ON Power on the machine. MachineBMCCommand_MACHINE_BMC_COMMAND_ON MachineBMCCommand = 1 - // MACHINE_BMC_COMMAND_OFF Power off the machine + // MACHINE_BMC_COMMAND_OFF Power off the machine. MachineBMCCommand_MACHINE_BMC_COMMAND_OFF MachineBMCCommand = 2 - // MACHINE_BMC_COMMAND_RESET Power reset the machine + // MACHINE_BMC_COMMAND_RESET Power reset the machine. MachineBMCCommand_MACHINE_BMC_COMMAND_RESET MachineBMCCommand = 3 - // MACHINE_BMC_COMMAND_CYCLE Power cycle the machine + // MACHINE_BMC_COMMAND_CYCLE Power cycle the machine. MachineBMCCommand_MACHINE_BMC_COMMAND_CYCLE MachineBMCCommand = 4 // MACHINE_BMC_COMMAND_BOOT_TO_BIOS boot the machine into bios MachineBMCCommand_MACHINE_BMC_COMMAND_BOOT_TO_BIOS MachineBMCCommand = 5 @@ -475,7 +475,7 @@ func (MachineBMCCommand) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_machine_proto_rawDescGZIP(), []int{6} } -// MachineIssueType defines which type of issue it is +// MachineIssueType defines which type of issue it is. type MachineIssueType int32 const ( @@ -572,7 +572,7 @@ func (MachineIssueType) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_machine_proto_rawDescGZIP(), []int{7} } -// MachineIssueSeverity defines the severity of an issue +// MachineIssueSeverity defines the severity of an issue. type MachineIssueSeverity int32 const ( @@ -629,7 +629,7 @@ func (MachineIssueSeverity) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_machine_proto_rawDescGZIP(), []int{8} } -// MachineServiceGetRequest is the request payload for a machine get request +// MachineServiceGetRequest is the request payload for a machine get request. type MachineServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // UUID of the machine to get @@ -684,10 +684,10 @@ func (x *MachineServiceGetRequest) GetProject() string { return "" } -// MachineServiceGetResponse is the response payload for a machine get request +// MachineServiceGetResponse is the response payload for a machine get request. type MachineServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Machine is the machine requested + // Machine is the machine requested. Machine *Machine `protobuf:"bytes,1,opt,name=machine,proto3" json:"machine,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -730,7 +730,7 @@ func (x *MachineServiceGetResponse) GetMachine() *Machine { return nil } -// MachineServiceCreateRequest is the request payload for a machine create request +// MachineServiceCreateRequest is the request payload for a machine create request. type MachineServiceCreateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Project of the machine @@ -750,7 +750,7 @@ type MachineServiceCreateRequest struct { // Size of the machine to create, must be omitted if uuid is given Size *string `protobuf:"bytes,7,opt,name=size,proto3,oneof" json:"size,omitempty"` // Image which should be installed on this machine - // The image can be specified either in the fully qualified form, e.g. including os, major, minor and patch + // The image can be specified either in the fully qualified form, e.g. including os, major, minor and patch. // - debian-13.0.20260402 // or in a simplified form which omits the patch version // - debian-13.0 @@ -761,9 +761,9 @@ type MachineServiceCreateRequest struct { // Is defaulted by a lookup at the available fsls for this size and image. // Can be specified to test new fsls during development of fsls FilesystemLayout *string `protobuf:"bytes,9,opt,name=filesystem_layout,json=filesystemLayout,proto3,oneof" json:"filesystem_layout,omitempty"` - // SSHPublicKeys defines the ssh public key to be installed on the machine to access it via ssh + // SSHPublicKeys defines the ssh public key to be installed on the machine to access it via ssh. SshPublicKeys []string `protobuf:"bytes,10,rep,name=ssh_public_keys,json=sshPublicKeys,proto3" json:"ssh_public_keys,omitempty"` - // Userdata contains instructions required to bootstrap the machine + // Userdata contains instructions required to bootstrap the machine. // AWS limits the max userdata size to 16k, lets allow twice as much Userdata *string `protobuf:"bytes,11,opt,name=userdata,proto3,oneof" json:"userdata,omitempty"` // Labels to be attached to this machine allocation @@ -779,7 +779,7 @@ type MachineServiceCreateRequest struct { NtpServers []*NTPServer `protobuf:"bytes,16,rep,name=ntp_servers,json=ntpServers,proto3" json:"ntp_servers,omitempty"` // AllocationType of this machine AllocationType MachineAllocationType `protobuf:"varint,17,opt,name=allocation_type,json=allocationType,proto3,enum=metalstack.api.v2.MachineAllocationType" json:"allocation_type,omitempty"` - // FirewallSpec provides firewall specific parameters if allocationType is firewall + // FirewallSpec provides firewall specific parameters if allocationType is firewall. FirewallSpec *FirewallSpec `protobuf:"bytes,18,opt,name=firewall_spec,json=firewallSpec,proto3" json:"firewall_spec,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -941,7 +941,7 @@ func (x *MachineServiceCreateRequest) GetFirewallSpec() *FirewallSpec { return nil } -// FirewallSpec contains firewall specific firewall creation parameters +// FirewallSpec contains firewall specific firewall creation parameters. type FirewallSpec struct { state protoimpl.MessageState `protogen:"open.v1"` // FirewallRules to be applied if this is a firewall @@ -987,7 +987,7 @@ func (x *FirewallSpec) GetFirewallRules() *FirewallRules { return nil } -// MachineServiceCreateResponse is the response payload for a machine create request +// MachineServiceCreateResponse is the response payload for a machine create request. type MachineServiceCreateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Machine which was created @@ -1033,12 +1033,12 @@ func (x *MachineServiceCreateResponse) GetMachine() *Machine { return nil } -// MachineServiceUpdateRequest is the request payload for a machine update request +// MachineServiceUpdateRequest is the request payload for a machine update request. type MachineServiceUpdateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // UUID of the machine to modify Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,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 *UpdateMeta `protobuf:"bytes,2,opt,name=update_meta,json=updateMeta,proto3" json:"update_meta,omitempty"` // Project of the machine Project string `protobuf:"bytes,3,opt,name=project,proto3" json:"project,omitempty"` @@ -1124,7 +1124,7 @@ func (x *MachineServiceUpdateRequest) GetSshPublicKeys() []string { return nil } -// MachineServiceUpdateResponse is the response payload for a machine update request +// MachineServiceUpdateResponse is the response payload for a machine update request. type MachineServiceUpdateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Machine which was updated @@ -1170,12 +1170,12 @@ func (x *MachineServiceUpdateResponse) GetMachine() *Machine { return nil } -// MachineServiceListRequest is the request payload for a machine list request +// MachineServiceListRequest is the request payload for a machine list request. type MachineServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Project of the machines to list Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` - // Query to list one ore more machines + // Query to list one ore more machines. Query *MachineQuery `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1225,10 +1225,10 @@ func (x *MachineServiceListRequest) GetQuery() *MachineQuery { return nil } -// MachineServiceListResponse is the response payload for a machine list request +// MachineServiceListResponse is the response payload for a machine list request. type MachineServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Machines are the machines requested by a list request + // Machines are the machines requested by a list request. Machines []*Machine `protobuf:"bytes,1,rep,name=machines,proto3" json:"machines,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1271,7 +1271,7 @@ func (x *MachineServiceListResponse) GetMachines() []*Machine { return nil } -// MachineServiceDeleteRequest is the request payload for a machine delete request +// MachineServiceDeleteRequest is the request payload for a machine delete request. type MachineServiceDeleteRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // UUID of the machine to delete @@ -1326,7 +1326,7 @@ func (x *MachineServiceDeleteRequest) GetProject() string { return "" } -// MachineServiceDeleteResponse is the response payload for a machine delete request +// MachineServiceDeleteResponse is the response payload for a machine delete request. type MachineServiceDeleteResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Machine which was deleted @@ -1372,7 +1372,7 @@ func (x *MachineServiceDeleteResponse) GetMachine() *Machine { return nil } -// MachineServiceBMCCommandRequest is the request payload for a machine bmc command +// MachineServiceBMCCommandRequest is the request payload for a machine bmc command. type MachineServiceBMCCommandRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // UUID of the machine to send the command to @@ -1436,7 +1436,7 @@ func (x *MachineServiceBMCCommandRequest) GetCommand() MachineBMCCommand { return MachineBMCCommand_MACHINE_BMC_COMMAND_UNSPECIFIED } -// MachineServiceBMCCommandResponse is the response payload for a machine bmc command +// MachineServiceBMCCommandResponse is the response payload for a machine bmc command. type MachineServiceBMCCommandResponse struct { state protoimpl.MessageState `protogen:"open.v1"` unknownFields protoimpl.UnknownFields @@ -1473,7 +1473,7 @@ func (*MachineServiceBMCCommandResponse) Descriptor() ([]byte, []int) { return file_metalstack_api_v2_machine_proto_rawDescGZIP(), []int{12} } -// MachineServiceGetBMCRequest is the request payload for a machine getbmc request +// MachineServiceGetBMCRequest is the request payload for a machine getbmc request. type MachineServiceGetBMCRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // UUID of the machine to get @@ -1528,12 +1528,12 @@ func (x *MachineServiceGetBMCRequest) GetProject() string { return "" } -// MachineServiceGetBMCResponse is the response payload for a machine getbmc request +// MachineServiceGetBMCResponse is the response payload for a machine getbmc request. type MachineServiceGetBMCResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // UUID of the machine Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` - // BMC contains the BMC details of this machine + // BMC contains the BMC details of this machine. Bmc *MachineBMCReport `protobuf:"bytes,2,opt,name=bmc,proto3" json:"bmc,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1592,9 +1592,9 @@ type Machine struct { Meta *Meta `protobuf:"bytes,2,opt,name=meta,proto3" json:"meta,omitempty"` // Partition where this machine resides Partition *Partition `protobuf:"bytes,3,opt,name=partition,proto3" json:"partition,omitempty"` - // Rack where this machine is located + // Rack where this machine is located. Rack string `protobuf:"bytes,4,opt,name=rack,proto3" json:"rack,omitempty"` - // Room where this machine is located + // Room where this machine is located. Room string `protobuf:"bytes,5,opt,name=room,proto3" json:"room,omitempty"` // Size of this machine Size *Size `protobuf:"bytes,6,opt,name=size,proto3" json:"size,omitempty"` @@ -1602,9 +1602,9 @@ type Machine struct { Hardware *MachineHardware `protobuf:"bytes,7,opt,name=hardware,proto3" json:"hardware,omitempty"` // Allocation details Allocation *MachineAllocation `protobuf:"bytes,8,opt,name=allocation,proto3" json:"allocation,omitempty"` - // Status contains several status details related to this machine + // Status contains several status details related to this machine. Status *MachineStatus `protobuf:"bytes,9,opt,name=status,proto3" json:"status,omitempty"` - // MachineRecentProvisioningEvents contains the recent provisioning events + // MachineRecentProvisioningEvents contains the recent provisioning events. RecentProvisioningEvents *MachineRecentProvisioningEvents `protobuf:"bytes,10,opt,name=recent_provisioning_events,json=recentProvisioningEvents,proto3" json:"recent_provisioning_events,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1710,12 +1710,12 @@ func (x *Machine) GetRecentProvisioningEvents() *MachineRecentProvisioningEvents return nil } -// MachineStatus contains several status details related to this machine +// MachineStatus contains several status details related to this machine. type MachineStatus struct { state protoimpl.MessageState `protogen:"open.v1"` - // Condition describes the availability + // Condition describes the availability. Condition *MachineCondition `protobuf:"bytes,1,opt,name=condition,proto3" json:"condition,omitempty"` - // LEDState indicates the state of the indicator LED on this machine + // LEDState indicates the state of the indicator LED on this machine. LedState *MachineChassisIdentifyLEDState `protobuf:"bytes,2,opt,name=led_state,json=ledState,proto3" json:"led_state,omitempty"` // Liveliness of this machine Liveliness MachineLiveliness `protobuf:"varint,3,opt,name=liveliness,proto3,enum=metalstack.api.v2.MachineLiveliness" json:"liveliness,omitempty"` @@ -1783,7 +1783,7 @@ func (x *MachineStatus) GetMetalHammerVersion() string { return "" } -// MachineCondition describes the availability of this machine +// MachineCondition describes the availability of this machine. type MachineCondition struct { state protoimpl.MessageState `protogen:"open.v1"` // State the state of this machine. empty means available for all @@ -1847,7 +1847,7 @@ func (x *MachineCondition) GetIssuer() string { return "" } -// MachineAllocation contains properties if this machine is allocated +// MachineAllocation contains properties if this machine is allocated. type MachineAllocation struct { state protoimpl.MessageState `protogen:"open.v1"` // UUID of this machine allocation @@ -2039,13 +2039,13 @@ func (x *MachineAllocation) GetVpn() *MachineVPN { return nil } -// MachineAllocationNetwork defines which network should be attached to a machine and if ips should be autoacquired +// MachineAllocationNetwork defines which network should be attached to a machine and if ips should be autoacquired. type MachineAllocationNetwork struct { state protoimpl.MessageState `protogen:"open.v1"` // Network the id of the network that this machine will be placed in Network string `protobuf:"bytes,1,opt,name=network,proto3" json:"network,omitempty"` // IPs to to attach to this machine additionally - // If none given, one ip address is acquired per network for the machine + // If none given, one ip address is acquired per network for the machine. // Order of ips is preserved on the loopback interface. Ips []string `protobuf:"bytes,2,rep,name=ips,proto3" json:"ips,omitempty"` unknownFields protoimpl.UnknownFields @@ -2096,12 +2096,12 @@ func (x *MachineAllocationNetwork) GetIps() []string { return nil } -// FirewallRules can be defined during firewall allocation +// FirewallRules can be defined during firewall allocation. type FirewallRules struct { state protoimpl.MessageState `protogen:"open.v1"` - // Egress list of egress rules to be deployed during firewall allocation + // Egress list of egress rules to be deployed during firewall allocation. Egress []*FirewallEgressRule `protobuf:"bytes,1,rep,name=egress,proto3" json:"egress,omitempty"` - // Ingress list of ingress rules to be deployed during firewall allocation + // Ingress list of ingress rules to be deployed during firewall allocation. Ingress []*FirewallIngressRule `protobuf:"bytes,2,rep,name=ingress,proto3" json:"ingress,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -2151,7 +2151,7 @@ func (x *FirewallRules) GetIngress() []*FirewallIngressRule { return nil } -// FirewallEgressRule defines rules for outgoing traffic +// FirewallEgressRule defines rules for outgoing traffic. type FirewallEgressRule struct { state protoimpl.MessageState `protogen:"open.v1"` // Protocol the protocol for the rule, defaults to tcp @@ -2224,7 +2224,7 @@ func (x *FirewallEgressRule) GetComment() string { return "" } -// FirewallIngressRule defines rules for incoming traffic +// FirewallIngressRule defines rules for incoming traffic. type FirewallIngressRule struct { state protoimpl.MessageState `protogen:"open.v1"` // Protocol the protocol for the rule, defaults to tcp @@ -2306,26 +2306,26 @@ func (x *FirewallIngressRule) GetComment() string { return "" } -// MachineNetwork contains details which network should be created on a allocated machine +// MachineNetwork contains details which network should be created on a allocated machine. type MachineNetwork struct { state protoimpl.MessageState `protogen:"open.v1"` // Network the networkID of the allocated machine in this vrf Network string `protobuf:"bytes,1,opt,name=network,proto3" json:"network,omitempty"` // Prefixes the prefixes of this network Prefixes []string `protobuf:"bytes,2,rep,name=prefixes,proto3" json:"prefixes,omitempty"` - // DestinationPrefixes prefixes that are reachable within this network + // DestinationPrefixes prefixes that are reachable within this network. DestinationPrefixes []string `protobuf:"bytes,3,rep,name=destination_prefixes,json=destinationPrefixes,proto3" json:"destination_prefixes,omitempty"` // IPs the ip addresses of the allocated machine in this vrf Ips []string `protobuf:"bytes,4,rep,name=ips,proto3" json:"ips,omitempty"` // NetworkType the type of network of this vrf NetworkType NetworkType `protobuf:"varint,5,opt,name=network_type,json=networkType,proto3,enum=metalstack.api.v2.NetworkType" json:"network_type,omitempty"` - // NatType what type of nat if any should be used + // NatType what type of nat if any should be used. NatType NATType `protobuf:"varint,6,opt,name=nat_type,json=natType,proto3,enum=metalstack.api.v2.NATType" json:"nat_type,omitempty"` // VRF the vrf id Vrf uint64 `protobuf:"varint,7,opt,name=vrf,proto3" json:"vrf,omitempty"` // ASN the autonomous system number for this network Asn uint32 `protobuf:"varint,8,opt,name=asn,proto3" json:"asn,omitempty"` - // Project is the project uuid associated with this network + // Project is the project uuid associated with this network. Project *string `protobuf:"bytes,9,opt,name=project,proto3,oneof" json:"project,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -2424,7 +2424,7 @@ func (x *MachineNetwork) GetProject() string { return "" } -// MachineHardware contains hardware details +// MachineHardware contains hardware details. type MachineHardware struct { state protoimpl.MessageState `protogen:"open.v1"` // Memory the total memory of the machine in bytes @@ -2506,7 +2506,7 @@ func (x *MachineHardware) GetNics() []*MachineNic { return nil } -// MetalCPU contains details of a cpu in this machine +// MetalCPU contains details of a cpu in this machine. type MetalCPU struct { state protoimpl.MessageState `protogen:"open.v1"` // Vendor of this cpu @@ -2579,7 +2579,7 @@ func (x *MetalCPU) GetThreads() uint32 { return 0 } -// MetalGPU contains details of a gpu in this machine +// MetalGPU contains details of a gpu in this machine. type MetalGPU struct { state protoimpl.MessageState `protogen:"open.v1"` // Vendor of this gpu @@ -2634,7 +2634,7 @@ func (x *MetalGPU) GetModel() string { return "" } -// MachineNic contains details of a network interface of this machine +// MachineNic contains details of a network interface of this machine. type MachineNic struct { state protoimpl.MessageState `protogen:"open.v1"` // Mac the macaddress of this interface @@ -2743,7 +2743,7 @@ func (x *MachineNic) GetHostname() string { return "" } -// MachineBlockDevice contains details of a block device of this machine +// MachineBlockDevice contains details of a block device of this machine. type MachineBlockDevice struct { state protoimpl.MessageState `protogen:"open.v1"` // Name of this block device @@ -2798,7 +2798,7 @@ func (x *MachineBlockDevice) GetSize() uint64 { return 0 } -// MachineChassisIdentifyLEDState describes the identifier led state +// MachineChassisIdentifyLEDState describes the identifier led state. type MachineChassisIdentifyLEDState struct { state protoimpl.MessageState `protogen:"open.v1"` // Value the state of this chassis identify LED. empty means LED-OFF @@ -2853,22 +2853,22 @@ func (x *MachineChassisIdentifyLEDState) GetDescription() string { return "" } -// MachineBMCReport is sent from the metal-bmc to update bmc and power related details +// MachineBMCReport is sent from the metal-bmc to update bmc and power related details. type MachineBMCReport struct { state protoimpl.MessageState `protogen:"open.v1"` - // Bmc contains bmc details + // Bmc contains bmc details. Bmc *MachineBMC `protobuf:"bytes,1,opt,name=bmc,proto3" json:"bmc,omitempty"` - // Bios contains bios details + // Bios contains bios details. Bios *MachineBios `protobuf:"bytes,2,opt,name=bios,proto3" json:"bios,omitempty"` - // Fru contains field replaceable unit details + // Fru contains field replaceable unit details. Fru *MachineFRU `protobuf:"bytes,3,opt,name=fru,proto3" json:"fru,omitempty"` - // PowerMetric contains the power statistics of the machine + // PowerMetric contains the power statistics of the machine. PowerMetric *MachinePowerMetric `protobuf:"bytes,4,opt,name=power_metric,json=powerMetric,proto3" json:"power_metric,omitempty"` - // PowerSupplies contains details about all power supplies and their state + // PowerSupplies contains details about all power supplies and their state. PowerSupplies []*MachinePowerSupply `protobuf:"bytes,5,rep,name=power_supplies,json=powerSupplies,proto3" json:"power_supplies,omitempty"` - // LedState indicates the state of the indicator LED on this machine + // LedState indicates the state of the indicator LED on this machine. LedState *MachineChassisIdentifyLEDState `protobuf:"bytes,6,opt,name=led_state,json=ledState,proto3" json:"led_state,omitempty"` - // UpdatedAt contains the date when this data was last updated + // UpdatedAt contains the date when this data was last updated. UpdatedAt *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -2953,7 +2953,7 @@ func (x *MachineBMCReport) GetUpdatedAt() *timestamppb.Timestamp { return nil } -// MachineBios contains BIOS details of this machine +// MachineBios contains BIOS details of this machine. type MachineBios struct { state protoimpl.MessageState `protogen:"open.v1"` // Version the bios version @@ -3017,7 +3017,7 @@ func (x *MachineBios) GetDate() string { return "" } -// MachineBMC describe details of the ipmi or out of band device +// MachineBMC describe details of the ipmi or out of band device. type MachineBMC struct { state protoimpl.MessageState `protogen:"open.v1"` // Address of this ipmi device from outside in the form of : @@ -3117,24 +3117,24 @@ func (x *MachineBMC) GetPowerState() string { return "" } -// MachineFRU describes details to the machine which are required in case of a necessary replacement +// MachineFRU describes details to the machine which are required in case of a necessary replacement. type MachineFRU struct { state protoimpl.MessageState `protogen:"open.v1"` - // ChassisPartNumber is the part number of the machine chassis + // ChassisPartNumber is the part number of the machine chassis. ChassisPartNumber *string `protobuf:"bytes,1,opt,name=chassis_part_number,json=chassisPartNumber,proto3,oneof" json:"chassis_part_number,omitempty"` - // ChassisPartSerial is the serial number of the machine chassis + // ChassisPartSerial is the serial number of the machine chassis. ChassisPartSerial *string `protobuf:"bytes,2,opt,name=chassis_part_serial,json=chassisPartSerial,proto3,oneof" json:"chassis_part_serial,omitempty"` - // BoardMfg is the short description of the mainboard + // BoardMfg is the short description of the mainboard. BoardMfg *string `protobuf:"bytes,3,opt,name=board_mfg,json=boardMfg,proto3,oneof" json:"board_mfg,omitempty"` - // BoardMfgSerial is the serial number of the mainboard + // BoardMfgSerial is the serial number of the mainboard. BoardMfgSerial *string `protobuf:"bytes,4,opt,name=board_mfg_serial,json=boardMfgSerial,proto3,oneof" json:"board_mfg_serial,omitempty"` - // BoardPartNumber is the part number of the mainboard + // BoardPartNumber is the part number of the mainboard. BoardPartNumber *string `protobuf:"bytes,5,opt,name=board_part_number,json=boardPartNumber,proto3,oneof" json:"board_part_number,omitempty"` - // ProductManufacturer is the manufacturer of the machine + // ProductManufacturer is the manufacturer of the machine. ProductManufacturer *string `protobuf:"bytes,6,opt,name=product_manufacturer,json=productManufacturer,proto3,oneof" json:"product_manufacturer,omitempty"` - // ProductPartNumber is the part number of the machine + // ProductPartNumber is the part number of the machine. ProductPartNumber *string `protobuf:"bytes,7,opt,name=product_part_number,json=productPartNumber,proto3,oneof" json:"product_part_number,omitempty"` - // ProductSerial is the serial number of the machine + // ProductSerial is the serial number of the machine. ProductSerial *string `protobuf:"bytes,8,opt,name=product_serial,json=productSerial,proto3,oneof" json:"product_serial,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -3226,7 +3226,7 @@ func (x *MachineFRU) GetProductSerial() string { return "" } -// MachinePowerMetric contains metrics of the power consumption of a machine +// MachinePowerMetric contains metrics of the power consumption of a machine. type MachinePowerMetric struct { state protoimpl.MessageState `protogen:"open.v1"` // AverageConsumedWatts shall represent the @@ -3308,7 +3308,7 @@ func (x *MachinePowerMetric) GetMinConsumedWatts() float32 { return 0 } -// MachinePowerSupply contains details of the power supply of a machine +// MachinePowerSupply contains details of the power supply of a machine. type MachinePowerSupply struct { state protoimpl.MessageState `protogen:"open.v1"` // Health of the powersupply @@ -3372,7 +3372,7 @@ type MachineRecentProvisioningEvents struct { LastEventTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=last_event_time,json=lastEventTime,proto3" json:"last_event_time,omitempty"` // LastErrorEvent the last erroneous event received LastErrorEvent *MachineProvisioningEvent `protobuf:"bytes,3,opt,name=last_error_event,json=lastErrorEvent,proto3" json:"last_error_event,omitempty"` - // State can be either CrashLoop, FailedReclaim or something else + // State can be either CrashLoop, FailedReclaim or something else. State MachineProvisioningEventState `protobuf:"varint,4,opt,name=state,proto3,enum=metalstack.api.v2.MachineProvisioningEventState" json:"state,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -3436,7 +3436,7 @@ func (x *MachineRecentProvisioningEvents) GetState() MachineProvisioningEventSta return MachineProvisioningEventState_MACHINE_PROVISIONING_EVENT_STATE_UNSPECIFIED } -// MachineProvisioningEvent is an event that has occurred during provisioning +// MachineProvisioningEvent is an event that has occurred during provisioning. type MachineProvisioningEvent struct { state protoimpl.MessageState `protogen:"open.v1"` // Time the time that this event was received @@ -3500,14 +3500,14 @@ func (x *MachineProvisioningEvent) GetMessage() string { return "" } -// MachineVPN contains configuration data for the VPN connection +// MachineVPN contains configuration data for the VPN connection. type MachineVPN struct { state protoimpl.MessageState `protogen:"open.v1"` // Address of VPN control plane ControlPlaneAddress string `protobuf:"bytes,1,opt,name=control_plane_address,json=controlPlaneAddress,proto3" json:"control_plane_address,omitempty"` // Auth key used to connect to VPN AuthKey string `protobuf:"bytes,2,opt,name=auth_key,json=authKey,proto3" json:"auth_key,omitempty"` - // Connected indicate if this machine is connected to the VPN + // Connected indicate if this machine is connected to the VPN. Connected bool `protobuf:"varint,3,opt,name=connected,proto3" json:"connected,omitempty"` // IPs of the machine connected to the vpn Ips []string `protobuf:"bytes,4,rep,name=ips,proto3" json:"ips,omitempty"` @@ -4349,18 +4349,18 @@ func (x *MachineHardwareQuery) GetCpuCores() uint32 { return 0 } -// MachineIssuesQuery defines which machine issues should be listed +// MachineIssuesQuery defines which machine issues should be listed. type MachineIssuesQuery struct { state protoimpl.MessageState `protogen:"open.v1"` // MachineQuery to select specific machines MachineQuery *MachineQuery `protobuf:"bytes,1,opt,name=machine_query,json=machineQuery,proto3" json:"machine_query,omitempty"` - // Only includes the specified machine issue types + // Only includes the specified machine issue types. Only []MachineIssueType `protobuf:"varint,2,rep,packed,name=only,proto3,enum=metalstack.api.v2.MachineIssueType" json:"only,omitempty"` // Omits the specified machine issues Omit []MachineIssueType `protobuf:"varint,3,rep,packed,name=omit,proto3,enum=metalstack.api.v2.MachineIssueType" json:"omit,omitempty"` - // Severity filters issue for given severity + // Severity filters issue for given severity. Severity *MachineIssueSeverity `protobuf:"varint,4,opt,name=severity,proto3,enum=metalstack.api.v2.MachineIssueSeverity,oneof" json:"severity,omitempty"` - // LastErrorThreshold defines the last error threshold + // LastErrorThreshold defines the last error threshold. LastErrorThreshold *durationpb.Duration `protobuf:"bytes,5,opt,name=last_error_threshold,json=lastErrorThreshold,proto3" json:"last_error_threshold,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -4431,7 +4431,7 @@ func (x *MachineIssuesQuery) GetLastErrorThreshold() *durationpb.Duration { return nil } -// MachineIssues is a list of issues for a machine +// MachineIssues is a list of issues for a machine. type MachineIssues struct { state protoimpl.MessageState `protogen:"open.v1"` // UUID of the machine for which the issues are listed @@ -4486,18 +4486,18 @@ func (x *MachineIssues) GetIssues() []*MachineIssue { return nil } -// MachineIssue contains details of one issue +// MachineIssue contains details of one issue. type MachineIssue struct { state protoimpl.MessageState `protogen:"open.v1"` // Type specifies the issue type (id) Type MachineIssueType `protobuf:"varint,1,opt,name=type,proto3,enum=metalstack.api.v2.MachineIssueType" json:"type,omitempty"` - // Severity specifies the severity of an issue + // Severity specifies the severity of an issue. Severity MachineIssueSeverity `protobuf:"varint,2,opt,name=severity,proto3,enum=metalstack.api.v2.MachineIssueSeverity" json:"severity,omitempty"` - // Description provides an issue description + // Description provides an issue description. Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"` - // RefURL provides a link to a more detailed issue description in the metal-stack documentation + // RefURL provides a link to a more detailed issue description in the metal-stack documentation. ReferenceUrl string `protobuf:"bytes,4,opt,name=reference_url,json=referenceUrl,proto3" json:"reference_url,omitempty"` - // Details may contain additional details on an evaluated issue + // Details may contain additional details on an evaluated issue. Details string `protobuf:"bytes,5,opt,name=details,proto3" json:"details,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/api/v2/method.pb.go b/go/metalstack/api/v2/method.pb.go index 6e666278..812a4985 100644 --- a/go/metalstack/api/v2/method.pb.go +++ b/go/metalstack/api/v2/method.pb.go @@ -62,7 +62,7 @@ func (*MethodServiceListRequest) Descriptor() ([]byte, []int) { // 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 + // Methods is a list of methods public callable. Methods []string `protobuf:"bytes,1,rep,name=methods,proto3" json:"methods,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -145,17 +145,17 @@ func (*MethodServiceTokenScopedListRequest) Descriptor() ([]byte, []int) { // 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 contains 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 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"` - // InfraRole defines the infrastructure role of the token owner + // InfraRole defines the infrastructure role of the token owner. InfraRole *InfraRole `protobuf:"varint,5,opt,name=infra_role,json=infraRole,proto3,enum=metalstack.api.v2.InfraRole,oneof" json:"infra_role,omitempty"` - // MachineRoles defines the machine roles of the token owner + // MachineRoles defines the machine roles of the token owner. MachineRoles map[string]MachineRole `protobuf:"bytes,6,rep,name=machine_roles,json=machineRoles,proto3" json:"machine_roles,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"varint,2,opt,name=value,enum=metalstack.api.v2.MachineRole"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/api/v2/network.pb.go b/go/metalstack/api/v2/network.pb.go index e17143c3..be833aea 100644 --- a/go/metalstack/api/v2/network.pb.go +++ b/go/metalstack/api/v2/network.pb.go @@ -22,13 +22,13 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) -// NATType defines how and if outgoing traffic is translated +// NATType defines how and if outgoing traffic is translated. type NATType int32 const ( - // NAT_TYPE_UNSPECIFIED indicates a unspecified nat type + // NAT_TYPE_UNSPECIFIED indicates a unspecified nat type. NATType_NAT_TYPE_UNSPECIFIED NATType = 0 - // NAT_TYPE_NONE indicates that no nat is configured + // NAT_TYPE_NONE indicates that no nat is configured. NATType_NAT_TYPE_NONE NATType = 1 // NAT_TYPE_IPV4_MASQUERADE masquerade ipv4 behind gateway ip when traffic enters this network NATType_NAT_TYPE_IPV4_MASQUERADE NATType = 2 @@ -75,28 +75,28 @@ func (NATType) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_network_proto_rawDescGZIP(), []int{0} } -// NetworkType indicates the purpose of the network, it cannot be changed after creation +// NetworkType indicates the purpose of the network, it cannot be changed after creation. type NetworkType int32 const ( - // NETWORK_TYPE_UNSPECIFIED indicates a unknown network type + // NETWORK_TYPE_UNSPECIFIED indicates a unknown network type. NetworkType_NETWORK_TYPE_UNSPECIFIED NetworkType = 0 - // NETWORK_TYPE_EXTERNAL indicates network where multiple projects can allocate ips, it offers connectivity to other external networks + // NETWORK_TYPE_EXTERNAL indicates network where multiple projects can allocate ips, it offers connectivity to other external networks. // In most cases this is the internet network or a network which offers connectivity to legacy datacenter networks. // If it is not project scoped everyone can allocate Ips in this network, otherwise only from the same project ip allocation is possible. NetworkType_NETWORK_TYPE_EXTERNAL NetworkType = 1 - // NETWORK_TYPE_UNDERLAY indicates a underlay network + // NETWORK_TYPE_UNDERLAY indicates a underlay network. // The underlay network connects all switches and the firewalls to build a EVPN dataplane // It is not project scoped. Is part of the dataplane and reserved for administrative purposes. NetworkType_NETWORK_TYPE_UNDERLAY NetworkType = 2 - // NETWORK_TYPE_SUPER indicates a super network which is only used to create child networks + // NETWORK_TYPE_SUPER indicates a super network which is only used to create child networks. // If the vrf id is given, child networks will inherit this vrf. // If the vrf id is nil in this network, child vrf is taken from the pool. // If the partition is given, child networks inherit the partition. // If the partition is nil, child networks also do not have a partition (i.e. requires vrf is distributed across all partitions). // If the partition is given, only one super network in that partition can be created. // If the partition is nil, multiple super networks can exist. Then, for child network creation the network id must be specified (base networks can be queried by label selector). - // For child creation destination prefixes will be inherited + // For child creation destination prefixes will be inherited. // If this is project scoped, the child project must match, otherwise can be freely specified. NetworkType_NETWORK_TYPE_SUPER NetworkType = 3 // NETWORK_TYPE_SUPER_NAMESPACED indicates a super network which is only used to create child networks. @@ -167,17 +167,17 @@ func (NetworkType) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_network_proto_rawDescGZIP(), []int{1} } -// NetworkAddressFamily defines the address family of a network +// NetworkAddressFamily defines the address family of a network. type NetworkAddressFamily int32 const ( - // NETWORK_ADDRESS_FAMILY_UNSPECIFIED is not specified + // NETWORK_ADDRESS_FAMILY_UNSPECIFIED is not specified. NetworkAddressFamily_NETWORK_ADDRESS_FAMILY_UNSPECIFIED NetworkAddressFamily = 0 - // NETWORK_ADDRESS_FAMILY_V4 defines a network with IPv4 address prefixes + // NETWORK_ADDRESS_FAMILY_V4 defines a network with IPv4 address prefixes. NetworkAddressFamily_NETWORK_ADDRESS_FAMILY_V4 NetworkAddressFamily = 1 - // NETWORK_ADDRESS_FAMILY_V6 defines a network with IPv6 address prefixes + // NETWORK_ADDRESS_FAMILY_V6 defines a network with IPv6 address prefixes. NetworkAddressFamily_NETWORK_ADDRESS_FAMILY_V6 NetworkAddressFamily = 2 - // NETWORK_ADDRESS_FAMILY_DUAL_STACK defines a network with both IPv4 and IPv6 address prefixes + // NETWORK_ADDRESS_FAMILY_DUAL_STACK defines a network with both IPv4 and IPv6 address prefixes. NetworkAddressFamily_NETWORK_ADDRESS_FAMILY_DUAL_STACK NetworkAddressFamily = 3 ) @@ -328,17 +328,17 @@ func (x *NetworkServiceGetResponse) GetNetwork() *Network { // NetworkServiceCreateRequest type NetworkServiceCreateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Project where this network belongs to + // Project where this network belongs to. Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` // Name of this network Name *string `protobuf:"bytes,2,opt,name=name,proto3,oneof" json:"name,omitempty"` // Description of this network Description *string `protobuf:"bytes,3,opt,name=description,proto3,oneof" json:"description,omitempty"` - // Partition where this network will be created + // Partition where this network will be created. Partition *string `protobuf:"bytes,4,opt,name=partition,proto3,oneof" json:"partition,omitempty"` // Labels on this network Labels *Labels `protobuf:"bytes,5,opt,name=labels,proto3" json:"labels,omitempty"` - // Parent Network points to the id of the parent network if any + // Parent Network points to the id of the parent network if any. ParentNetwork *string `protobuf:"bytes,6,opt,name=parent_network,json=parentNetwork,proto3,oneof" json:"parent_network,omitempty"` // Length per addressfamily Length *ChildPrefixLength `protobuf:"bytes,7,opt,name=length,proto3,oneof" json:"length,omitempty"` @@ -437,7 +437,7 @@ func (x *NetworkServiceCreateRequest) GetAddressFamily() NetworkAddressFamily { // NetworkServiceCreateResponse type NetworkServiceCreateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Network is the created network + // Network is the created network. Network *Network `protobuf:"bytes,1,opt,name=network,proto3" json:"network,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -485,7 +485,7 @@ type NetworkServiceUpdateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // ID of the network to get 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 *UpdateMeta `protobuf:"bytes,2,opt,name=update_meta,json=updateMeta,proto3" json:"update_meta,omitempty"` // Project of the network Project string `protobuf:"bytes,3,opt,name=project,proto3" json:"project,omitempty"` @@ -574,7 +574,7 @@ func (x *NetworkServiceUpdateRequest) GetLabels() *UpdateLabels { // NetworkServiceUpdateResponse type NetworkServiceUpdateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Network is the updated network + // Network is the updated network. Network *Network `protobuf:"bytes,1,opt,name=network,proto3" json:"network,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -622,7 +622,7 @@ type NetworkServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Project of the networks to list Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` - // Query which specifies which networks to return + // Query which specifies which networks to return. Query *NetworkQuery `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -675,7 +675,7 @@ func (x *NetworkServiceListRequest) GetQuery() *NetworkQuery { // NetworkServiceListResponse type NetworkServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Networks are the requested networks + // Networks are the requested networks. Networks []*Network `protobuf:"bytes,1,rep,name=networks,proto3" json:"networks,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -723,7 +723,7 @@ type NetworkServiceListBaseNetworksRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Project of the base networks to list Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` - // Query which specifies which networks to return + // Query which specifies which networks to return. Query *NetworkQuery `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -776,7 +776,7 @@ func (x *NetworkServiceListBaseNetworksRequest) GetQuery() *NetworkQuery { // NetworkServiceListResponse type NetworkServiceListBaseNetworksResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Networks are the requested networks + // Networks are the requested networks. Networks []*Network `protobuf:"bytes,1,rep,name=networks,proto3" json:"networks,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -877,7 +877,7 @@ func (x *NetworkServiceDeleteRequest) GetProject() string { // NetworkServiceDeleteResponse type NetworkServiceDeleteResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Network is the deleted network + // Network is the deleted network. Network *Network `protobuf:"bytes,1,opt,name=network,proto3" json:"network,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -931,20 +931,20 @@ type Network struct { Name *string `protobuf:"bytes,3,opt,name=name,proto3,oneof" json:"name,omitempty"` // Description of this network Description *string `protobuf:"bytes,4,opt,name=description,proto3,oneof" json:"description,omitempty"` - // Partition where this network will be created + // Partition where this network will be created. Partition *string `protobuf:"bytes,5,opt,name=partition,proto3,oneof" json:"partition,omitempty"` - // Project where this network belongs to + // Project where this network belongs to. Project *string `protobuf:"bytes,6,opt,name=project,proto3,oneof" json:"project,omitempty"` - // Namespace if specified, this network is namespaced and can therefore overlap with others + // Namespace if specified, this network is namespaced and can therefore overlap with others. // Will be equal with project most of the time Namespace *string `protobuf:"bytes,7,opt,name=namespace,proto3,oneof" json:"namespace,omitempty"` // Prefixes in this network Prefixes []string `protobuf:"bytes,8,rep,name=prefixes,proto3" json:"prefixes,omitempty"` // Destination Prefixes in this network DestinationPrefixes []string `protobuf:"bytes,9,rep,name=destination_prefixes,json=destinationPrefixes,proto3" json:"destination_prefixes,omitempty"` - // Default Child Prefix length defines the bit length of a child network created per address family, if not specified during the allocate request + // Default Child Prefix length defines the bit length of a child network created per address family, if not specified during the allocate request. DefaultChildPrefixLength *ChildPrefixLength `protobuf:"bytes,10,opt,name=default_child_prefix_length,json=defaultChildPrefixLength,proto3" json:"default_child_prefix_length,omitempty"` - // Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length + // Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length. MinChildPrefixLength *ChildPrefixLength `protobuf:"bytes,11,opt,name=min_child_prefix_length,json=minChildPrefixLength,proto3" json:"min_child_prefix_length,omitempty"` // Type of the network Type NetworkType `protobuf:"varint,12,opt,name=type,proto3,enum=metalstack.api.v2.NetworkType" json:"type,omitempty"` @@ -952,9 +952,9 @@ type Network struct { NatType NATType `protobuf:"varint,13,opt,name=nat_type,json=natType,proto3,enum=metalstack.api.v2.NATType" json:"nat_type,omitempty"` // VRF of this network has this VNI. Vrf *uint32 `protobuf:"varint,14,opt,name=vrf,proto3,oneof" json:"vrf,omitempty"` - // Parent Network points to the id of the parent network if any + // Parent Network points to the id of the parent network if any. ParentNetwork *string `protobuf:"bytes,15,opt,name=parent_network,json=parentNetwork,proto3,oneof" json:"parent_network,omitempty"` - // AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced + // AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced. AdditionalAnnouncableCidrs []string `protobuf:"bytes,16,rep,name=additional_announcable_cidrs,json=additionalAnnouncableCidrs,proto3" json:"additional_announcable_cidrs,omitempty"` // Consumption of IPs and prefixes in this network Consumption *NetworkConsumption `protobuf:"bytes,17,opt,name=consumption,proto3" json:"consumption,omitempty"` @@ -1111,7 +1111,7 @@ func (x *Network) GetConsumption() *NetworkConsumption { return nil } -// NetworkQuery defines which networks to query +// NetworkQuery defines which networks to query. type NetworkQuery struct { state protoimpl.MessageState `protogen:"open.v1"` // Id of the network to query @@ -1120,11 +1120,11 @@ type NetworkQuery struct { Name *string `protobuf:"bytes,2,opt,name=name,proto3,oneof" json:"name,omitempty"` // Description of this network Description *string `protobuf:"bytes,3,opt,name=description,proto3,oneof" json:"description,omitempty"` - // Partition where this network will be created + // Partition where this network will be created. Partition *string `protobuf:"bytes,4,opt,name=partition,proto3,oneof" json:"partition,omitempty"` - // Project where this network belongs to + // Project where this network belongs to. Project *string `protobuf:"bytes,5,opt,name=project,proto3,oneof" json:"project,omitempty"` - // Namespace where this network belongs to + // Namespace where this network belongs to. Namespace *string `protobuf:"bytes,6,opt,name=namespace,proto3,oneof" json:"namespace,omitempty"` // Prefixes in this network Prefixes []string `protobuf:"bytes,7,rep,name=prefixes,proto3" json:"prefixes,omitempty"` @@ -1132,7 +1132,7 @@ type NetworkQuery struct { DestinationPrefixes []string `protobuf:"bytes,8,rep,name=destination_prefixes,json=destinationPrefixes,proto3" json:"destination_prefixes,omitempty"` // VRF of this network has this VNI. Vrf *uint32 `protobuf:"varint,9,opt,name=vrf,proto3,oneof" json:"vrf,omitempty"` - // Parent Network points to the id of the parent network if any + // Parent Network points to the id of the parent network if any. ParentNetwork *string `protobuf:"bytes,10,opt,name=parent_network,json=parentNetwork,proto3,oneof" json:"parent_network,omitempty"` // Addressfamily to query AddressFamily *NetworkAddressFamily `protobuf:"varint,11,opt,name=address_family,json=addressFamily,proto3,enum=metalstack.api.v2.NetworkAddressFamily,oneof" json:"address_family,omitempty"` @@ -1329,12 +1329,12 @@ func (x *ChildPrefixLength) GetIpv6() uint32 { return 0 } -// NetworkConsumption contains ip and prefix usage by addressfamily +// NetworkConsumption contains ip and prefix usage by addressfamily. type NetworkConsumption struct { state protoimpl.MessageState `protogen:"open.v1"` // IPv4 network usage Ipv4 *NetworkUsage `protobuf:"bytes,1,opt,name=ipv4,proto3" json:"ipv4,omitempty"` - // IPv6 network usage, this can be approximated for high numbers + // IPv6 network usage, this can be approximated for high numbers. Ipv6 *NetworkUsage `protobuf:"bytes,2,opt,name=ipv6,proto3" json:"ipv6,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/api/v2/partition.pb.go b/go/metalstack/api/v2/partition.pb.go index cf4415ed..0ff98594 100644 --- a/go/metalstack/api/v2/partition.pb.go +++ b/go/metalstack/api/v2/partition.pb.go @@ -22,7 +22,7 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) -// Partition is a failure domain with machines and switches +// Partition is a failure domain with machines and switches. type Partition struct { state protoimpl.MessageState `protogen:"open.v1"` // ID of this partition @@ -31,13 +31,13 @@ type Partition struct { Meta *Meta `protobuf:"bytes,2,opt,name=meta,proto3" json:"meta,omitempty"` // Description of this partition Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"` - // PartitionBootConfiguration defines how metal-hammer boots + // PartitionBootConfiguration defines how metal-hammer boots. BootConfiguration *PartitionBootConfiguration `protobuf:"bytes,4,opt,name=boot_configuration,json=bootConfiguration,proto3" json:"boot_configuration,omitempty"` // DNSServers for this partition DnsServers []*DNSServer `protobuf:"bytes,5,rep,name=dns_servers,json=dnsServers,proto3" json:"dns_servers,omitempty"` // NTPServers for this partition NtpServers []*NTPServer `protobuf:"bytes,6,rep,name=ntp_servers,json=ntpServers,proto3" json:"ntp_servers,omitempty"` - // ManagementServiceAddresses defines where the management is reachable + // ManagementServiceAddresses defines where the management is reachable. // should be in the form : MgmtServiceAddresses []string `protobuf:"bytes,7,rep,name=mgmt_service_addresses,json=mgmtServiceAddresses,proto3" json:"mgmt_service_addresses,omitempty"` unknownFields protoimpl.UnknownFields @@ -123,12 +123,12 @@ func (x *Partition) GetMgmtServiceAddresses() []string { return nil } -// PartitionQuery is used to search partitions +// PartitionQuery is used to search partitions. type PartitionQuery struct { state protoimpl.MessageState `protogen:"open.v1"` // ID of the partition to get Id *string `protobuf:"bytes,1,opt,name=id,proto3,oneof" json:"id,omitempty"` - // Labels lists only partitions containing the given labels + // Labels lists only partitions containing the given labels. Labels *Labels `protobuf:"bytes,2,opt,name=labels,proto3,oneof" json:"labels,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -178,7 +178,7 @@ func (x *PartitionQuery) GetLabels() *Labels { return nil } -// PartitionBootConfiguration defines how metal-hammer boots +// PartitionBootConfiguration defines how metal-hammer boots. type PartitionBootConfiguration struct { state protoimpl.MessageState `protogen:"open.v1"` // ImageURL the url to download the initrd for the boot image @@ -334,7 +334,7 @@ func (x *NTPServer) GetAddress() string { return "" } -// PartitionServiceGetRequest is the request payload for a partition get request +// PartitionServiceGetRequest is the request payload for a partition get request. type PartitionServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // ID of the partition to get @@ -380,10 +380,10 @@ func (x *PartitionServiceGetRequest) GetId() string { return "" } -// PartitionServiceListRequest is the request payload for a partition list request +// PartitionServiceListRequest is the request payload for a partition list request. type PartitionServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Query for partitions + // Query for partitions. Query *PartitionQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -426,10 +426,10 @@ func (x *PartitionServiceListRequest) GetQuery() *PartitionQuery { return nil } -// PartitionServiceGetResponse is the response payload for a partition get request +// PartitionServiceGetResponse is the response payload for a partition get request. type PartitionServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Partition is the partition + // Partition is the partition. Partition *Partition `protobuf:"bytes,1,opt,name=partition,proto3" json:"partition,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -472,10 +472,10 @@ func (x *PartitionServiceGetResponse) GetPartition() *Partition { return nil } -// PartitionServiceListResponse is the response payload for a partition list request +// PartitionServiceListResponse is the response payload for a partition list request. type PartitionServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Partitions are the partitions + // Partitions are the partitions. Partitions []*Partition `protobuf:"bytes,1,rep,name=partitions,proto3" json:"partitions,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/api/v2/predefined_rules.pb.go b/go/metalstack/api/v2/predefined_rules.pb.go index dc4d1b28..1517a686 100644 --- a/go/metalstack/api/v2/predefined_rules.pb.go +++ b/go/metalstack/api/v2/predefined_rules.pb.go @@ -218,63 +218,63 @@ var file_metalstack_api_v2_predefined_rules_proto_extTypes = []protoimpl.Extensi // Extension fields to validate.StringRules. var ( - // Macaddress returns true if the given string is a valid macaddress + // Macaddress returns true if the given string is a valid macaddress. // // optional bool macaddress = 80048951; E_Macaddress = &file_metalstack_api_v2_predefined_rules_proto_extTypes[0] - // IsName returns true if name field satisfies our requirements + // IsName returns true if name field satisfies our requirements. // // optional bool is_name = 80048952; E_IsName = &file_metalstack_api_v2_predefined_rules_proto_extTypes[1] - // IsDescription returns true if description field satisfies our requirements + // IsDescription returns true if description field satisfies our requirements. // // optional bool is_description = 80048953; E_IsDescription = &file_metalstack_api_v2_predefined_rules_proto_extTypes[2] - // IsPartition returns true if partition field satisfies our requirements + // IsPartition returns true if partition field satisfies our requirements. // // optional bool is_partition = 80048954; E_IsPartition = &file_metalstack_api_v2_predefined_rules_proto_extTypes[3] - // IsPrefix validates if the given string is a valid prefix + // IsPrefix validates if the given string is a valid prefix. // // optional bool is_prefix = 80048955; E_IsPrefix = &file_metalstack_api_v2_predefined_rules_proto_extTypes[4] - // IsUri validates if the given string is a valid URI + // IsUri validates if the given string is a valid URI. // // optional bool is_uri = 80048956; E_IsUri = &file_metalstack_api_v2_predefined_rules_proto_extTypes[5] - // IsIpOrHostname validates that the given string is either a ip or a hostname + // IsIpOrHostname validates that the given string is either a ip or a hostname. // // 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] - // IsUser returns true if name field satisfies our requirements + // IsUser returns true if name field satisfies our requirements. // // optional bool is_user = 80048959; E_IsUser = &file_metalstack_api_v2_predefined_rules_proto_extTypes[8] - // IsOption returns true if name field satisfies our requirements + // IsOption returns true if name field satisfies our requirements. // // optional bool is_option = 80048960; E_IsOption = &file_metalstack_api_v2_predefined_rules_proto_extTypes[9] - // IsKey returns true if name field satisfies our requirements + // IsKey returns true if name field satisfies our requirements. // // optional bool is_key = 80048961; E_IsKey = &file_metalstack_api_v2_predefined_rules_proto_extTypes[10] - // IsTenantLogin returns true if name field satisfies our requirements + // IsTenantLogin returns true if name field satisfies our requirements. // // optional bool is_tenant_login = 80048962; E_IsTenantLogin = &file_metalstack_api_v2_predefined_rules_proto_extTypes[11] - // IsTenantSubjectPermission returns true if name field satisfies our requirements + // IsTenantSubjectPermission returns true if name field satisfies our requirements. // // optional bool is_tenant_subject_permission = 80048963; E_IsTenantSubjectPermission = &file_metalstack_api_v2_predefined_rules_proto_extTypes[12] - // IsProjectSubjectPermission returns true if name field satisfies our requirements + // IsProjectSubjectPermission returns true if name field satisfies our requirements. // // optional bool is_project_subject_permission = 80048964; E_IsProjectSubjectPermission = &file_metalstack_api_v2_predefined_rules_proto_extTypes[13] - // IsMachineSubjectPermission returns true if name field satisfies our requirements + // IsMachineSubjectPermission returns true if name field satisfies our requirements. // // optional bool is_machine_subject_permission = 80048965; E_IsMachineSubjectPermission = &file_metalstack_api_v2_predefined_rules_proto_extTypes[14] @@ -282,19 +282,19 @@ var ( // Extension fields to validate.RepeatedRules. var ( - // Prefixes validates if a slice of prefixes in string form are valid + // Prefixes validates if a slice of prefixes in string form are valid. // // optional bool prefixes = 80058951; E_Prefixes = &file_metalstack_api_v2_predefined_rules_proto_extTypes[15] - // Ips validates if a slice of ips in string form are valid + // Ips validates if a slice of ips in string form are valid. // // optional bool ips = 80058952; E_Ips = &file_metalstack_api_v2_predefined_rules_proto_extTypes[16] - // AreHostAndPort validates if a slice of strings are all in the form of : + // 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[17] - // All Trimmed enforces all strings to be trimmed, e.g. no whitespaces at the begin and end + // All Trimmed enforces all strings to be trimmed, e.g. no whitespaces at the begin and end. // // optional bool all_trimmed = 80058954; E_AllTrimmed = &file_metalstack_api_v2_predefined_rules_proto_extTypes[18] @@ -302,23 +302,23 @@ var ( // Extension fields to validate.MapRules. var ( - // Keys and Values trimmed enforces all map keys and values to be trimmed, e.g. no whitespaces at the begin and end + // Keys and Values trimmed enforces all map keys and values to be trimmed, e.g. no whitespaces at the begin and end. // // optional bool keys_and_values_trimmed = 80068951; E_KeysAndValuesTrimmed = &file_metalstack_api_v2_predefined_rules_proto_extTypes[19] - // Keys trimmed enforces all map keys and values to be trimmed, e.g. no whitespaces at the begin and end + // Keys trimmed enforces all map keys and values to be trimmed, e.g. no whitespaces at the begin and end. // // optional bool keys_trimmed = 80068952; E_KeysTrimmed = &file_metalstack_api_v2_predefined_rules_proto_extTypes[20] - // ProjectRolesKeysValid ensures that project roles keys met our requirements + // ProjectRolesKeysValid ensures that project roles keys met our requirements. // // optional bool project_roles_keys_valid = 80068953; E_ProjectRolesKeysValid = &file_metalstack_api_v2_predefined_rules_proto_extTypes[21] - // TenantRolesKeysValid ensures that tenant roles keys met our requirements + // TenantRolesKeysValid ensures that tenant roles keys met our requirements. // // optional bool tenant_roles_keys_valid = 80068954; E_TenantRolesKeysValid = &file_metalstack_api_v2_predefined_rules_proto_extTypes[22] - // MachineRolesKeysValid ensures that machine roles keys met our requirements + // MachineRolesKeysValid ensures that machine roles keys met our requirements. // // optional bool machine_roles_keys_valid = 80068955; E_MachineRolesKeysValid = &file_metalstack_api_v2_predefined_rules_proto_extTypes[23] diff --git a/go/metalstack/api/v2/project.pb.go b/go/metalstack/api/v2/project.pb.go index 61f3a099..226aaba4 100644 --- a/go/metalstack/api/v2/project.pb.go +++ b/go/metalstack/api/v2/project.pb.go @@ -23,7 +23,7 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) -// Project defines a group of resources belonging to a tenant +// Project defines a group of resources belonging to a tenant. // a tenant can have multiple projects type Project struct { state protoimpl.MessageState `protogen:"open.v1"` @@ -115,12 +115,12 @@ func (x *Project) GetAvatarUrl() string { return "" } -// ProjectMember defines a user that participates in a project +// ProjectMember defines a user that participates in a project. type ProjectMember struct { state protoimpl.MessageState `protogen:"open.v1"` - // Id is the user id of the member + // Id is the user id of the member. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` - // Role is the role of the member + // Role is the role of the member. Role ProjectRole `protobuf:"varint,2,opt,name=role,proto3,enum=metalstack.api.v2.ProjectRole" json:"role,omitempty"` // InheritedMembership indicates that this member has implicit permissions on the project through his membership within the tenant. // This member does not have direct project membership but gains permissions on this project from the role he has in the tenant. @@ -199,22 +199,22 @@ func (x *ProjectMember) GetMeta() *Meta { return nil } -// ProjectInvite defines invite to project +// ProjectInvite defines invite to project. type ProjectInvite struct { state protoimpl.MessageState `protogen:"open.v1"` - // Secret is the secret part of the invite, typically part of the url + // Secret is the secret part of the invite, typically part of the url. Secret string `protobuf:"bytes,1,opt,name=secret,proto3" json:"secret,omitempty"` - // Project is the project id for which this invite was created + // Project is the project id for which this invite was created. Project string `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"` - // Role is the role in this project the user will get after accepting the invitation + // Role is the role in this project the user will get after accepting the invitation. Role ProjectRole `protobuf:"varint,3,opt,name=role,proto3,enum=metalstack.api.v2.ProjectRole" json:"role,omitempty"` - // Joined is false as long as a user has not accepted the invite + // Joined is false as long as a user has not accepted the invite. Joined bool `protobuf:"varint,4,opt,name=joined,proto3" json:"joined,omitempty"` - // ProjectName is the project name for which this invite was created + // ProjectName is the project name for which this invite was created. ProjectName string `protobuf:"bytes,5,opt,name=project_name,json=projectName,proto3" json:"project_name,omitempty"` - // Tenant is the login of the tenant inviting another user to join this project + // Tenant is the login of the tenant inviting another user to join this project. Tenant string `protobuf:"bytes,6,opt,name=tenant,proto3" json:"tenant,omitempty"` - // TenantName is the name of the tenant inviting another user to join this project + // TenantName is the name of the tenant inviting another user to join this project. TenantName string `protobuf:"bytes,7,opt,name=tenant_name,json=tenantName,proto3" json:"tenant_name,omitempty"` // ExpiresAt the date when this invite expires ExpiresAt *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"` @@ -317,10 +317,10 @@ func (x *ProjectInvite) GetJoinedAt() *timestamppb.Timestamp { return nil } -// ProjectServiceListRequest is the request payload to list all projects +// ProjectServiceListRequest is the request payload to list all projects. type ProjectServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Query for projects + // Query for projects. Query *ProjectQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -363,16 +363,16 @@ func (x *ProjectServiceListRequest) GetQuery() *ProjectQuery { return nil } -// ProjectQuery is used to search projects +// ProjectQuery is used to search projects. type ProjectQuery struct { state protoimpl.MessageState `protogen:"open.v1"` - // Uuid lists only projects with this uuid + // Uuid lists only projects with this uuid. Uuid *string `protobuf:"bytes,1,opt,name=uuid,proto3,oneof" json:"uuid,omitempty"` - // Name lists only projects with this name + // Name lists only projects with this name. Name *string `protobuf:"bytes,2,opt,name=name,proto3,oneof" json:"name,omitempty"` - // Tenant lists only projects of this tenant + // Tenant lists only projects of this tenant. Tenant *string `protobuf:"bytes,3,opt,name=tenant,proto3,oneof" json:"tenant,omitempty"` - // Labels lists only projects containing the given labels + // Labels lists only projects containing the given labels. Labels *Labels `protobuf:"bytes,4,opt,name=labels,proto3,oneof" json:"labels,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -436,10 +436,10 @@ func (x *ProjectQuery) GetLabels() *Labels { return nil } -// ProjectServiceListResponse is the response payload to list all projects +// ProjectServiceListResponse is the response payload to list all projects. type ProjectServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Projects is a list of all your projects + // Projects is a list of all your projects. Projects []*Project `protobuf:"bytes,1,rep,name=projects,proto3" json:"projects,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -482,10 +482,10 @@ func (x *ProjectServiceListResponse) GetProjects() []*Project { return nil } -// ProjectServiceGetRequest is the request payload to get a project +// ProjectServiceGetRequest is the request payload to get a project. type ProjectServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Project is the uuid of the project to get + // Project is the uuid of the project to get. Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -528,10 +528,10 @@ func (x *ProjectServiceGetRequest) GetProject() string { return "" } -// ProjectServiceGetResponse is the response payload to get a projects +// ProjectServiceGetResponse is the response payload to get a projects. type ProjectServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Project is the project + // Project is the project. Project *Project `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` // ProjectMembers in this project, projects guests will only see direct project members and not implicit memberships from tenant permissions ProjectMembers []*ProjectMember `protobuf:"bytes,2,rep,name=project_members,json=projectMembers,proto3" json:"project_members,omitempty"` @@ -583,10 +583,10 @@ func (x *ProjectServiceGetResponse) GetProjectMembers() []*ProjectMember { return nil } -// ProjectServiceCreateRequest is the request payload to Create a project +// ProjectServiceCreateRequest is the request payload to Create a project. type ProjectServiceCreateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Login is the tenant of this project + // Login is the tenant of this project. // TODO: is login really a good name? Login string `protobuf:"bytes,1,opt,name=login,proto3" json:"login,omitempty"` // Name of this project, unique per tenant @@ -666,10 +666,10 @@ func (x *ProjectServiceCreateRequest) GetLabels() *Labels { return nil } -// ProjectServiceCreateResponse is the response payload of creation of a project +// ProjectServiceCreateResponse is the response payload of creation of a project. type ProjectServiceCreateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Project is the project + // Project is the project. Project *Project `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -712,10 +712,10 @@ func (x *ProjectServiceCreateResponse) GetProject() *Project { return nil } -// ProjectServiceDeleteRequest is the request payload to delete a project +// ProjectServiceDeleteRequest is the request payload to delete a project. type ProjectServiceDeleteRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Project is the uuid of the project to delete + // Project is the uuid of the project to delete. Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -758,10 +758,10 @@ func (x *ProjectServiceDeleteRequest) GetProject() string { return "" } -// ProjectServiceDeleteResponse is the response payload to delete a project +// ProjectServiceDeleteResponse is the response payload to delete a project. type ProjectServiceDeleteResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Project is the project + // Project is the project. Project *Project `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -804,12 +804,12 @@ func (x *ProjectServiceDeleteResponse) GetProject() *Project { return nil } -// ProjectServiceUpdateRequest is the request payload to update a project +// ProjectServiceUpdateRequest is the request payload to update a project. type ProjectServiceUpdateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Project is the uuid of the project to get + // Project is the uuid of the project to get. Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,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 *UpdateMeta `protobuf:"bytes,2,opt,name=update_meta,json=updateMeta,proto3" json:"update_meta,omitempty"` // Name of this project unique per tenant Name *string `protobuf:"bytes,3,opt,name=name,proto3,oneof" json:"name,omitempty"` @@ -895,10 +895,10 @@ func (x *ProjectServiceUpdateRequest) GetLabels() *UpdateLabels { return nil } -// ProjectServiceUpdateResponse is the response payload to update a project +// ProjectServiceUpdateResponse is the response payload to update a project. type ProjectServiceUpdateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Project is the project + // Project is the project. Project *Project `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -941,10 +941,10 @@ func (x *ProjectServiceUpdateResponse) GetProject() *Project { return nil } -// ProjectServiceInviteRequest is used to invite a member to a project +// ProjectServiceInviteRequest is used to invite a member to a project. type ProjectServiceInviteRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Project is the uuid of the project + // Project is the uuid of the project. Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` // Role of this user in this project Role ProjectRole `protobuf:"varint,2,opt,name=role,proto3,enum=metalstack.api.v2.ProjectRole" json:"role,omitempty"` @@ -996,10 +996,10 @@ func (x *ProjectServiceInviteRequest) GetRole() ProjectRole { return ProjectRole_PROJECT_ROLE_UNSPECIFIED } -// ProjectServiceInviteResponse is the response payload to a invite member request +// ProjectServiceInviteResponse is the response payload to a invite member request. type ProjectServiceInviteResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Inviter contains a secret which can be sent to a potential user + // Inviter contains a secret which can be sent to a potential user. // can be appended to the invitation endpoint at our cloud console like // console.metalstack.cloud/invite/ Invite *ProjectInvite `protobuf:"bytes,1,opt,name=invite,proto3" json:"invite,omitempty"` @@ -1044,10 +1044,10 @@ func (x *ProjectServiceInviteResponse) GetInvite() *ProjectInvite { return nil } -// ProjectServiceInvitesListRequest is the request payload to a list invites request +// ProjectServiceInvitesListRequest is the request payload to a list invites request. type ProjectServiceInvitesListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Project is the uuid of the project + // Project is the uuid of the project. Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1090,7 +1090,7 @@ func (x *ProjectServiceInvitesListRequest) GetProject() string { return "" } -// ProjectServiceInvitesListResponse is the response payload to a list invites request +// ProjectServiceInvitesListResponse is the response payload to a list invites request. type ProjectServiceInvitesListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Invites not already accepted the invitation to this project @@ -1136,7 +1136,7 @@ func (x *ProjectServiceInvitesListResponse) GetInvites() []*ProjectInvite { return nil } -// ProjectServiceInviteGetRequest is the request payload to get a invite +// ProjectServiceInviteGetRequest is the request payload to get a invite. type ProjectServiceInviteGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Secret of the invite to list @@ -1182,10 +1182,10 @@ func (x *ProjectServiceInviteGetRequest) GetSecret() string { return "" } -// ProjectServiceInviteGetResponse is the response payload to a get invite request +// ProjectServiceInviteGetResponse is the response payload to a get invite request. type ProjectServiceInviteGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Invite is the invite + // Invite is the invite. Invite *ProjectInvite `protobuf:"bytes,1,opt,name=invite,proto3" json:"invite,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1228,10 +1228,10 @@ func (x *ProjectServiceInviteGetResponse) GetInvite() *ProjectInvite { return nil } -// ProjectServiceLeaveRequest is used to leave a project +// ProjectServiceLeaveRequest is used to leave a project. type ProjectServiceLeaveRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Project is the uuid of the project + // Project is the uuid of the project. Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1274,7 +1274,7 @@ func (x *ProjectServiceLeaveRequest) GetProject() string { return "" } -// ProjectServiceLeaveResponse is the response payload to a leave project request +// ProjectServiceLeaveResponse is the response payload to a leave project request. type ProjectServiceLeaveResponse struct { state protoimpl.MessageState `protogen:"open.v1"` unknownFields protoimpl.UnknownFields @@ -1311,10 +1311,10 @@ func (*ProjectServiceLeaveResponse) Descriptor() ([]byte, []int) { return file_metalstack_api_v2_project_proto_rawDescGZIP(), []int{21} } -// ProjectServiceAddMemberRequest is the request payload for adding a member to a project +// ProjectServiceAddMemberRequest is the request payload for adding a member to a project. type ProjectServiceAddMemberRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Project is the uuid of the project + // Project is the uuid of the project. Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` // Login of the member to add Member string `protobuf:"bytes,2,opt,name=member,proto3" json:"member,omitempty"` @@ -1375,10 +1375,10 @@ func (x *ProjectServiceAddMemberRequest) GetRole() ProjectRole { return ProjectRole_PROJECT_ROLE_UNSPECIFIED } -// ProjectServiceAddMemberResponse is the response payload for the add member request +// ProjectServiceAddMemberResponse is the response payload for the add member request. type ProjectServiceAddMemberResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // ProjectRole is the added project member + // ProjectRole is the added project member. ProjectMember ProjectRole `protobuf:"varint,1,opt,name=project_member,json=projectMember,proto3,enum=metalstack.api.v2.ProjectRole" json:"project_member,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1421,12 +1421,12 @@ func (x *ProjectServiceAddMemberResponse) GetProjectMember() ProjectRole { return ProjectRole_PROJECT_ROLE_UNSPECIFIED } -// ProjectServiceRemoveMemberRequest is used to remove a member from a project +// ProjectServiceRemoveMemberRequest is used to remove a member from a project. type ProjectServiceRemoveMemberRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Project is the uuid of the project + // Project is the uuid of the project. Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` - // Member is the id of the member to remove from this project + // Member is the id of the member to remove from this project. Member string `protobuf:"bytes,2,opt,name=member,proto3" json:"member,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1476,7 +1476,7 @@ func (x *ProjectServiceRemoveMemberRequest) GetMember() string { return "" } -// ProjectServiceRemoveMemberResponse is the response payload to a remove member request +// ProjectServiceRemoveMemberResponse is the response payload to a remove member request. type ProjectServiceRemoveMemberResponse struct { state protoimpl.MessageState `protogen:"open.v1"` unknownFields protoimpl.UnknownFields @@ -1513,14 +1513,14 @@ func (*ProjectServiceRemoveMemberResponse) Descriptor() ([]byte, []int) { return file_metalstack_api_v2_project_proto_rawDescGZIP(), []int{25} } -// ProjectServiceUpdateMemberRequest is used to update a member of a project +// ProjectServiceUpdateMemberRequest is used to update a member of a project. type ProjectServiceUpdateMemberRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Project is the uuid of the project + // Project is the uuid of the project. Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` - // Member is the id of the member to remove from this project + // Member is the id of the member to remove from this project. Member string `protobuf:"bytes,2,opt,name=member,proto3" json:"member,omitempty"` - // Role is the role in this project the user will get after the update + // Role is the role in this project the user will get after the update. Role ProjectRole `protobuf:"varint,3,opt,name=role,proto3,enum=metalstack.api.v2.ProjectRole" json:"role,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1577,10 +1577,10 @@ func (x *ProjectServiceUpdateMemberRequest) GetRole() ProjectRole { return ProjectRole_PROJECT_ROLE_UNSPECIFIED } -// ProjectServiceUpdateMemberResponse is the response payload to a update member request +// ProjectServiceUpdateMemberResponse is the response payload to a update member request. type ProjectServiceUpdateMemberResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // ProjectMember is the updated project member + // ProjectMember is the updated project member. ProjectMember *ProjectMember `protobuf:"bytes,1,opt,name=project_member,json=projectMember,proto3" json:"project_member,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1623,10 +1623,10 @@ func (x *ProjectServiceUpdateMemberResponse) GetProjectMember() *ProjectMember { return nil } -// ProjectServiceInviteAcceptRequest is the request payload to a accept invite request +// ProjectServiceInviteAcceptRequest is the request payload to a accept invite request. type ProjectServiceInviteAcceptRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Secret is the invitation secret part of the invitation url + // Secret is the invitation secret part of the invitation url. Secret string `protobuf:"bytes,1,opt,name=secret,proto3" json:"secret,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1669,7 +1669,7 @@ func (x *ProjectServiceInviteAcceptRequest) GetSecret() string { return "" } -// ProjectServiceInviteAcceptResponse is the response payload to a accept invite request +// ProjectServiceInviteAcceptResponse is the response payload to a accept invite request. type ProjectServiceInviteAcceptResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Project ID of the project joined @@ -1724,10 +1724,10 @@ func (x *ProjectServiceInviteAcceptResponse) GetProjectName() string { return "" } -// ProjectServiceInviteDeleteRequest is the request payload to a delete invite +// ProjectServiceInviteDeleteRequest is the request payload to a delete invite. type ProjectServiceInviteDeleteRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Project is the uuid of the project + // Project is the uuid of the project. Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` // Secret of the invite to delete Secret string `protobuf:"bytes,2,opt,name=secret,proto3" json:"secret,omitempty"` @@ -1779,7 +1779,7 @@ func (x *ProjectServiceInviteDeleteRequest) GetSecret() string { return "" } -// ProjectServiceInviteDeleteResponse is the response payload of a delete invite request +// ProjectServiceInviteDeleteResponse is the response payload of a delete invite request. type ProjectServiceInviteDeleteResponse struct { state protoimpl.MessageState `protogen:"open.v1"` unknownFields protoimpl.UnknownFields diff --git a/go/metalstack/api/v2/size.pb.go b/go/metalstack/api/v2/size.pb.go index 86510469..e82118ec 100644 --- a/go/metalstack/api/v2/size.pb.go +++ b/go/metalstack/api/v2/size.pb.go @@ -22,19 +22,19 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) -// SizeConstraintType defines the property for which a constraint is defined +// SizeConstraintType defines the property for which a constraint is defined. type SizeConstraintType int32 const ( // SIZE_CONSTRAINT_TYPE_UNSPECIFIED type is not specified SizeConstraintType_SIZE_CONSTRAINT_TYPE_UNSPECIFIED SizeConstraintType = 0 - // SIZE_CONSTRAINT_TYPE_CORES defines the number of cores as property + // SIZE_CONSTRAINT_TYPE_CORES defines the number of cores as property. SizeConstraintType_SIZE_CONSTRAINT_TYPE_CORES SizeConstraintType = 1 - // SIZE_CONSTRAINT_TYPE_MEMORY defines the amount of memory as property + // SIZE_CONSTRAINT_TYPE_MEMORY defines the amount of memory as property. SizeConstraintType_SIZE_CONSTRAINT_TYPE_MEMORY SizeConstraintType = 2 - // SIZE_CONSTRAINT_TYPE_STORAGE defines the amount of storage as property + // SIZE_CONSTRAINT_TYPE_STORAGE defines the amount of storage as property. SizeConstraintType_SIZE_CONSTRAINT_TYPE_STORAGE SizeConstraintType = 3 - // SIZE_CONSTRAINT_TYPE_GPU defines the number of gpus as property + // SIZE_CONSTRAINT_TYPE_GPU defines the number of gpus as property. SizeConstraintType_SIZE_CONSTRAINT_TYPE_GPU SizeConstraintType = 4 ) @@ -83,7 +83,7 @@ func (SizeConstraintType) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_size_proto_rawDescGZIP(), []int{0} } -// SizeServiceGetRequest is the request payload for a size get request +// SizeServiceGetRequest is the request payload for a size get request. type SizeServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // ID of the size to get @@ -129,10 +129,10 @@ func (x *SizeServiceGetRequest) GetId() string { return "" } -// SizeServiceListRequest is the request payload for a size list request +// SizeServiceListRequest is the request payload for a size list request. type SizeServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Query for sizes + // Query for sizes. Query *SizeQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -175,7 +175,7 @@ func (x *SizeServiceListRequest) GetQuery() *SizeQuery { return nil } -// SizeServiceGetResponse is the response payload for a size get request +// SizeServiceGetResponse is the response payload for a size get request. type SizeServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Size the size @@ -221,7 +221,7 @@ func (x *SizeServiceGetResponse) GetSize() *Size { return nil } -// SizeServiceListResponse is the response payload for a size list request +// SizeServiceListResponse is the response payload for a size list request. type SizeServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Sizes the sizes @@ -358,7 +358,7 @@ type SizeConstraint struct { Min uint64 `protobuf:"varint,2,opt,name=min,proto3" json:"min,omitempty"` // Max the maximum value of the constraint Max uint64 `protobuf:"varint,3,opt,name=max,proto3" json:"max,omitempty"` - // Identifier glob pattern which matches to the given type, for example gpu pci id + // Identifier glob pattern which matches to the given type, for example gpu pci id. Identifier *string `protobuf:"bytes,4,opt,name=identifier,proto3,oneof" json:"identifier,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -422,7 +422,7 @@ func (x *SizeConstraint) GetIdentifier() string { return "" } -// SizeQuery is used to search sizes +// SizeQuery is used to search sizes. type SizeQuery struct { state protoimpl.MessageState `protogen:"open.v1"` // ID of the size to get @@ -431,7 +431,7 @@ type SizeQuery struct { Name *string `protobuf:"bytes,2,opt,name=name,proto3,oneof" json:"name,omitempty"` // Description of the size to query Description *string `protobuf:"bytes,3,opt,name=description,proto3,oneof" json:"description,omitempty"` - // Labels lists only sizes containing the given labels + // Labels lists only sizes containing the given labels. Labels *Labels `protobuf:"bytes,4,opt,name=labels,proto3,oneof" json:"labels,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/api/v2/size_imageconstraint.pb.go b/go/metalstack/api/v2/size_imageconstraint.pb.go index f164a0fc..5329d329 100644 --- a/go/metalstack/api/v2/size_imageconstraint.pb.go +++ b/go/metalstack/api/v2/size_imageconstraint.pb.go @@ -22,7 +22,7 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) -// SizeImageConstraintServiceTryRequest is the request payload for a size image constraint try request +// SizeImageConstraintServiceTryRequest is the request payload for a size image constraint try request. type SizeImageConstraintServiceTryRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Size to try @@ -77,7 +77,7 @@ func (x *SizeImageConstraintServiceTryRequest) GetImage() string { return "" } -// SizeImageConstraintServiceTryResponse is the response payload for a size image constraint try request +// SizeImageConstraintServiceTryResponse is the response payload for a size image constraint try request. type SizeImageConstraintServiceTryResponse struct { state protoimpl.MessageState `protogen:"open.v1"` unknownFields protoimpl.UnknownFields @@ -114,7 +114,7 @@ func (*SizeImageConstraintServiceTryResponse) Descriptor() ([]byte, []int) { return file_metalstack_api_v2_size_imageconstraint_proto_rawDescGZIP(), []int{1} } -// SizeImageConstraint expresses optional restrictions for specific size to image combinations +// SizeImageConstraint expresses optional restrictions for specific size to image combinations. // this might be required if the support for a specific hardware in a given size is only supported // with a newer version of the image. // @@ -123,7 +123,7 @@ func (*SizeImageConstraintServiceTryResponse) Descriptor() ([]byte, []int) { // If the image in question is found, but does not match the given expression, machine creation must be forbidden. type SizeImageConstraint struct { state protoimpl.MessageState `protogen:"open.v1"` - // Size where this constraint should apply + // Size where this constraint should apply. Size string `protobuf:"bytes,1,opt,name=size,proto3" json:"size,omitempty"` // ImageConstraints to apply to this size ImageConstraints []*ImageConstraint `protobuf:"bytes,2,rep,name=image_constraints,json=imageConstraints,proto3" json:"image_constraints,omitempty"` @@ -202,7 +202,7 @@ func (x *SizeImageConstraint) GetDescription() string { return "" } -// ImageConstraint defines a constraint for an image +// ImageConstraint defines a constraint for an image. // examples: // images: // @@ -262,7 +262,7 @@ func (x *ImageConstraint) GetSemverMatch() string { return "" } -// SizeImageConstraintQuery is used to search size image constraints +// SizeImageConstraintQuery is used to search size image constraints. type SizeImageConstraintQuery struct { state protoimpl.MessageState `protogen:"open.v1"` // Size of the size image constraint diff --git a/go/metalstack/api/v2/size_reservation.pb.go b/go/metalstack/api/v2/size_reservation.pb.go index 16974a85..ad01b759 100644 --- a/go/metalstack/api/v2/size_reservation.pb.go +++ b/go/metalstack/api/v2/size_reservation.pb.go @@ -22,7 +22,7 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) -// SizeReservationServiceGetRequest is the request payload for a size get request +// SizeReservationServiceGetRequest is the request payload for a size get request. type SizeReservationServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // ID of the size reservation to get @@ -77,12 +77,12 @@ func (x *SizeReservationServiceGetRequest) GetProject() string { return "" } -// SizeReservationServiceListRequest is the request payload for a size list request +// SizeReservationServiceListRequest is the request payload for a size list request. type SizeReservationServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Project of the size reservation Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` - // Query for size reservations + // Query for size reservations. Query *SizeReservationQuery `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -132,7 +132,7 @@ func (x *SizeReservationServiceListRequest) GetQuery() *SizeReservationQuery { return nil } -// SizeReservationServiceGetResponse is the response payload for a size reservation get request +// SizeReservationServiceGetResponse is the response payload for a size reservation get request. type SizeReservationServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Size reservation @@ -178,7 +178,7 @@ func (x *SizeReservationServiceGetResponse) GetSizeReservation() *SizeReservatio return nil } -// SizeReservationServiceListResponse is the response payload for a size reservation list request +// SizeReservationServiceListResponse is the response payload for a size reservation list request. type SizeReservationServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Size reservations @@ -333,7 +333,7 @@ func (x *SizeReservation) GetAmount() int32 { return 0 } -// SizeReservationQuery is used to search size reservations +// SizeReservationQuery is used to search size reservations. type SizeReservationQuery struct { state protoimpl.MessageState `protogen:"open.v1"` // ID of the size reservation to get @@ -348,7 +348,7 @@ type SizeReservationQuery struct { Project *string `protobuf:"bytes,5,opt,name=project,proto3,oneof" json:"project,omitempty"` // Partition of the size reservation Partition *string `protobuf:"bytes,6,opt,name=partition,proto3,oneof" json:"partition,omitempty"` - // Labels lists only size reservations containing the given labels + // Labels lists only size reservations containing the given labels. Labels *Labels `protobuf:"bytes,7,opt,name=labels,proto3,oneof" json:"labels,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/api/v2/tenant.pb.go b/go/metalstack/api/v2/tenant.pb.go index dbbc23d8..2d170058 100644 --- a/go/metalstack/api/v2/tenant.pb.go +++ b/go/metalstack/api/v2/tenant.pb.go @@ -23,7 +23,7 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) -// Tenant is a customer of the platform +// Tenant is a customer of the platform. type Tenant struct { state protoimpl.MessageState `protogen:"open.v1"` // Login of the tenant @@ -123,12 +123,12 @@ func (x *Tenant) GetCreatedBy() string { return "" } -// TenantMember defines a user that participates in a tenant +// TenantMember defines a user that participates in a tenant. type TenantMember struct { state protoimpl.MessageState `protogen:"open.v1"` - // Id is the user id of the member + // Id is the user id of the member. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` - // Role is the role of the member + // Role is the role of the member. Role TenantRole `protobuf:"varint,2,opt,name=role,proto3,enum=metalstack.api.v2.TenantRole" json:"role,omitempty"` // Projects in which a user is a direct member Projects []string `protobuf:"bytes,3,rep,name=projects,proto3" json:"projects,omitempty"` @@ -205,22 +205,22 @@ func (x *TenantMember) GetMeta() *Meta { return nil } -// TenantInvite defines invite to tenant +// TenantInvite defines invite to tenant. type TenantInvite struct { state protoimpl.MessageState `protogen:"open.v1"` - // Secret is the secret part of the invite, typically part of the url + // Secret is the secret part of the invite, typically part of the url. Secret string `protobuf:"bytes,1,opt,name=secret,proto3" json:"secret,omitempty"` - // TargetTenant is the tenant id for which this invite was created + // TargetTenant is the tenant id for which this invite was created. TargetTenant string `protobuf:"bytes,2,opt,name=target_tenant,json=targetTenant,proto3" json:"target_tenant,omitempty"` - // Role is the role in this tenant the user will get after accepting the invitation + // Role is the role in this tenant the user will get after accepting the invitation. Role TenantRole `protobuf:"varint,3,opt,name=role,proto3,enum=metalstack.api.v2.TenantRole" json:"role,omitempty"` - // Joined is false as long as a user has not accepted the invite + // Joined is false as long as a user has not accepted the invite. Joined bool `protobuf:"varint,4,opt,name=joined,proto3" json:"joined,omitempty"` - // TargetTenantName is the tenant name for which this invite was created + // TargetTenantName is the tenant name for which this invite was created. TargetTenantName string `protobuf:"bytes,5,opt,name=target_tenant_name,json=targetTenantName,proto3" json:"target_tenant_name,omitempty"` - // Tenant is the login of the tenant inviting another user to join this tenant + // Tenant is the login of the tenant inviting another user to join this tenant. Tenant string `protobuf:"bytes,6,opt,name=tenant,proto3" json:"tenant,omitempty"` - // TenantName is the name of the tenant inviting another user to join this tenant + // TenantName is the name of the tenant inviting another user to join this tenant. TenantName string `protobuf:"bytes,7,opt,name=tenant_name,json=tenantName,proto3" json:"tenant_name,omitempty"` // ExpiresAt the date when this invite expires ExpiresAt *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"` @@ -323,10 +323,10 @@ func (x *TenantInvite) GetJoinedAt() *timestamppb.Timestamp { return nil } -// TenantServiceListRequest is the request payload of the tenant list request +// TenantServiceListRequest is the request payload of the tenant list request. type TenantServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Query for tenants + // Query for tenants. Query *TenantQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -369,16 +369,16 @@ func (x *TenantServiceListRequest) GetQuery() *TenantQuery { return nil } -// TenantQuery is used to search tenants +// TenantQuery is used to search tenants. type TenantQuery struct { state protoimpl.MessageState `protogen:"open.v1"` - // Id filters tenants by login + // Id filters tenants by login. Login *string `protobuf:"bytes,1,opt,name=login,proto3,oneof" json:"login,omitempty"` - // Name filters tenants by name + // Name filters tenants by name. Name *string `protobuf:"bytes,2,opt,name=name,proto3,oneof" json:"name,omitempty"` - // Labels lists only projects containing the given labels + // Labels lists only projects containing the given labels. Labels *Labels `protobuf:"bytes,3,opt,name=labels,proto3,oneof" json:"labels,omitempty"` - // Paging details for the list request + // Paging details for the list request. Paging *Paging `protobuf:"bytes,4,opt,name=paging,proto3" json:"paging,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -442,7 +442,7 @@ func (x *TenantQuery) GetPaging() *Paging { return nil } -// TenantServiceGetRequest is the request payload of the tenant get request +// TenantServiceGetRequest is the request payload of the tenant get request. type TenantServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Login of the tenant @@ -488,7 +488,7 @@ func (x *TenantServiceGetRequest) GetLogin() string { return "" } -// TenantServiceCreateRequest is the request payload of the tenant create request +// TenantServiceCreateRequest is the request payload of the tenant create request. type TenantServiceCreateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Name of this tenant @@ -570,12 +570,12 @@ func (x *TenantServiceCreateRequest) GetLabels() *Labels { return nil } -// TenantServiceUpdateRequest is the request payload of the tenant update request +// TenantServiceUpdateRequest is the request payload of the tenant update request. type TenantServiceUpdateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Login of the tenant Login string `protobuf:"bytes,1,opt,name=login,proto3" json:"login,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 *UpdateMeta `protobuf:"bytes,2,opt,name=update_meta,json=updateMeta,proto3" json:"update_meta,omitempty"` // Name of the tenant Name *string `protobuf:"bytes,3,opt,name=name,proto3,oneof" json:"name,omitempty"` @@ -670,7 +670,7 @@ func (x *TenantServiceUpdateRequest) GetLabels() *UpdateLabels { return nil } -// TenantServiceDeleteRequest is the request payload of the tenant delete request +// TenantServiceDeleteRequest is the request payload of the tenant delete request. type TenantServiceDeleteRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Login of the tenant @@ -716,10 +716,10 @@ func (x *TenantServiceDeleteRequest) GetLogin() string { return "" } -// TenantServiceGetResponse is the response payload of the tenant get request +// TenantServiceGetResponse is the response payload of the tenant get request. type TenantServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Tenant is the tenant + // Tenant is the tenant. Tenant *Tenant `protobuf:"bytes,1,opt,name=tenant,proto3" json:"tenant,omitempty"` // TenantMembers of this tenant TenantMembers []*TenantMember `protobuf:"bytes,2,rep,name=tenant_members,json=tenantMembers,proto3" json:"tenant_members,omitempty"` @@ -771,10 +771,10 @@ func (x *TenantServiceGetResponse) GetTenantMembers() []*TenantMember { return nil } -// TenantServiceListResponse is the response payload of the tenant list request +// TenantServiceListResponse is the response payload of the tenant list request. type TenantServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Tenants is the list of tenants + // Tenants is the list of tenants. Tenants []*Tenant `protobuf:"bytes,1,rep,name=tenants,proto3" json:"tenants,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -817,10 +817,10 @@ func (x *TenantServiceListResponse) GetTenants() []*Tenant { return nil } -// TenantServiceCreateResponse is the response payload of the tenant create request +// TenantServiceCreateResponse is the response payload of the tenant create request. type TenantServiceCreateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Tenant is the tenant + // Tenant is the tenant. Tenant *Tenant `protobuf:"bytes,1,opt,name=tenant,proto3" json:"tenant,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -863,10 +863,10 @@ func (x *TenantServiceCreateResponse) GetTenant() *Tenant { return nil } -// TenantServiceUpdateResponse is the response payload of the tenant update request +// TenantServiceUpdateResponse is the response payload of the tenant update request. type TenantServiceUpdateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Tenant is the tenant + // Tenant is the tenant. Tenant *Tenant `protobuf:"bytes,1,opt,name=tenant,proto3" json:"tenant,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -909,10 +909,10 @@ func (x *TenantServiceUpdateResponse) GetTenant() *Tenant { return nil } -// TenantServiceDeleteResponse is the response payload of the tenant delete request +// TenantServiceDeleteResponse is the response payload of the tenant delete request. type TenantServiceDeleteResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Tenant is the tenant + // Tenant is the tenant. Tenant *Tenant `protobuf:"bytes,1,opt,name=tenant,proto3" json:"tenant,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -955,7 +955,7 @@ func (x *TenantServiceDeleteResponse) GetTenant() *Tenant { return nil } -// TenantServiceInviteRequest is used to invite a member to a tenant +// TenantServiceInviteRequest is used to invite a member to a tenant. type TenantServiceInviteRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Login of the tenant @@ -1010,10 +1010,10 @@ func (x *TenantServiceInviteRequest) GetRole() TenantRole { return TenantRole_TENANT_ROLE_UNSPECIFIED } -// TenantServiceInviteRequest is the response payload to a invite member request +// TenantServiceInviteRequest is the response payload to a invite member request. type TenantServiceInviteResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Invite contains a secret which can be sent to a potential user + // Invite contains a secret which can be sent to a potential user. // can be appended to the invitation endpoint at our cloud console like // console.metalstack.cloud/invite/ Invite *TenantInvite `protobuf:"bytes,1,opt,name=invite,proto3" json:"invite,omitempty"` @@ -1058,7 +1058,7 @@ func (x *TenantServiceInviteResponse) GetInvite() *TenantInvite { return nil } -// TenantServiceInvitesListRequest is the request payload to a list invites request +// TenantServiceInvitesListRequest is the request payload to a list invites request. type TenantServiceInvitesListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Login of the tenant @@ -1104,7 +1104,7 @@ func (x *TenantServiceInvitesListRequest) GetLogin() string { return "" } -// TenantServiceInvitesListResponse is the response payload to a list invites request +// TenantServiceInvitesListResponse is the response payload to a list invites request. type TenantServiceInvitesListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Invites that have not yet accepted the invitation to this tenant @@ -1150,7 +1150,7 @@ func (x *TenantServiceInvitesListResponse) GetInvites() []*TenantInvite { return nil } -// TenantServiceInviteGetRequest is the request payload to get a invite +// TenantServiceInviteGetRequest is the request payload to get a invite. type TenantServiceInviteGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Secret of the invite to get @@ -1196,10 +1196,10 @@ func (x *TenantServiceInviteGetRequest) GetSecret() string { return "" } -// TenantServiceInviteGetResponse is the response payload to a get invite request +// TenantServiceInviteGetResponse is the response payload to a get invite request. type TenantServiceInviteGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Invite is the invite + // Invite is the invite. Invite *TenantInvite `protobuf:"bytes,1,opt,name=invite,proto3" json:"invite,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1242,12 +1242,12 @@ func (x *TenantServiceInviteGetResponse) GetInvite() *TenantInvite { return nil } -// TenantServiceRemoveMemberRequest is used to remove a member from a tenant +// TenantServiceRemoveMemberRequest is used to remove a member from a tenant. type TenantServiceRemoveMemberRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Login of the tenant Login string `protobuf:"bytes,1,opt,name=login,proto3" json:"login,omitempty"` - // Member is the id of the member to remove from this tenant + // Member is the id of the member to remove from this tenant. Member string `protobuf:"bytes,2,opt,name=member,proto3" json:"member,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1297,7 +1297,7 @@ func (x *TenantServiceRemoveMemberRequest) GetMember() string { return "" } -// TenantServiceLeaveTenantRequest is used to leave a tenant +// TenantServiceLeaveTenantRequest is used to leave a tenant. type TenantServiceLeaveRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Login of the tenant @@ -1343,7 +1343,7 @@ func (x *TenantServiceLeaveRequest) GetLogin() string { return "" } -// TenantServiceLeaveTenantResponse is the response payload to a leave tenant request +// TenantServiceLeaveTenantResponse is the response payload to a leave tenant request. type TenantServiceLeaveResponse struct { state protoimpl.MessageState `protogen:"open.v1"` unknownFields protoimpl.UnknownFields @@ -1380,10 +1380,10 @@ func (*TenantServiceLeaveResponse) Descriptor() ([]byte, []int) { return file_metalstack_api_v2_tenant_proto_rawDescGZIP(), []int{22} } -// TenantServiceRemoveMemberResponse is the response payload to a remove member request +// TenantServiceRemoveMemberResponse is the response payload to a remove member request. type TenantServiceRemoveMemberResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // TenantMember is the removed tenant member + // TenantMember is the removed tenant member. TenantMember *TenantMember `protobuf:"bytes,1,opt,name=tenant_member,json=tenantMember,proto3" json:"tenant_member,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1426,10 +1426,10 @@ func (x *TenantServiceRemoveMemberResponse) GetTenantMember() *TenantMember { return nil } -// TenantServiceInviteAcceptRequest is the request payload to a accept invite request +// TenantServiceInviteAcceptRequest is the request payload to a accept invite request. type TenantServiceInviteAcceptRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Secret is the invitation secret part of the invitation url + // Secret is the invitation secret part of the invitation url. Secret string `protobuf:"bytes,1,opt,name=secret,proto3" json:"secret,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1472,7 +1472,7 @@ func (x *TenantServiceInviteAcceptRequest) GetSecret() string { return "" } -// TenantServiceInviteAcceptResponse is the response payload to a accept invite request +// TenantServiceInviteAcceptResponse is the response payload to a accept invite request. type TenantServiceInviteAcceptResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Tenant ID of the joined tenant @@ -1527,7 +1527,7 @@ func (x *TenantServiceInviteAcceptResponse) GetTenantName() string { return "" } -// TenantServiceInviteDeleteRequest is the request payload to a delete invite +// TenantServiceInviteDeleteRequest is the request payload to a delete invite. type TenantServiceInviteDeleteRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Login of the tenant @@ -1582,7 +1582,7 @@ func (x *TenantServiceInviteDeleteRequest) GetSecret() string { return "" } -// TenantServiceInviteDeleteResponse is the response payload of a delete invite request +// TenantServiceInviteDeleteResponse is the response payload of a delete invite request. type TenantServiceInviteDeleteResponse struct { state protoimpl.MessageState `protogen:"open.v1"` unknownFields protoimpl.UnknownFields @@ -1619,7 +1619,7 @@ func (*TenantServiceInviteDeleteResponse) Descriptor() ([]byte, []int) { return file_metalstack_api_v2_tenant_proto_rawDescGZIP(), []int{27} } -// TenantServiceAddMemberRequest is the request payload for adding a member to a tenant +// TenantServiceAddMemberRequest is the request payload for adding a member to a tenant. type TenantServiceAddMemberRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Login of the tenant to which the member will be added @@ -1683,10 +1683,10 @@ func (x *TenantServiceAddMemberRequest) GetRole() TenantRole { return TenantRole_TENANT_ROLE_UNSPECIFIED } -// TenantServiceAddMemberResponse is the response payload for the add member request +// TenantServiceAddMemberResponse is the response payload for the add member request. type TenantServiceAddMemberResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // TenantMember is the added tenant member + // TenantMember is the added tenant member. TenantMember *TenantMember `protobuf:"bytes,1,opt,name=tenant_member,json=tenantMember,proto3" json:"tenant_member,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1729,12 +1729,12 @@ func (x *TenantServiceAddMemberResponse) GetTenantMember() *TenantMember { return nil } -// TenantServiceUpdateMemberRequest is used to update a member from a tenant +// TenantServiceUpdateMemberRequest is used to update a member from a tenant. type TenantServiceUpdateMemberRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Login of the tenant Login string `protobuf:"bytes,1,opt,name=login,proto3" json:"login,omitempty"` - // Member is the id of the member to update in this tenant + // Member is the id of the member to update in this tenant. Member string `protobuf:"bytes,2,opt,name=member,proto3" json:"member,omitempty"` // Role of this user in this tenant Role TenantRole `protobuf:"varint,3,opt,name=role,proto3,enum=metalstack.api.v2.TenantRole" json:"role,omitempty"` @@ -1793,10 +1793,10 @@ func (x *TenantServiceUpdateMemberRequest) GetRole() TenantRole { return TenantRole_TENANT_ROLE_UNSPECIFIED } -// TenantServiceUpdateMemberResponse is the response payload to a update member request +// TenantServiceUpdateMemberResponse is the response payload to a update member request. type TenantServiceUpdateMemberResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // TenantMember is the updated membership + // TenantMember is the updated membership. TenantMember *TenantMember `protobuf:"bytes,1,opt,name=tenant_member,json=tenantMember,proto3" json:"tenant_member,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/api/v2/token.pb.go b/go/metalstack/api/v2/token.pb.go index 9e1f756f..d72c07cb 100644 --- a/go/metalstack/api/v2/token.pb.go +++ b/go/metalstack/api/v2/token.pb.go @@ -24,13 +24,13 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) -// TokenType specifies different use cases of tokens +// TokenType specifies different use cases of tokens. type TokenType int32 const ( - // TOKEN_TYPE_UNSPECIFIED is not specified + // TOKEN_TYPE_UNSPECIFIED is not specified. TokenType_TOKEN_TYPE_UNSPECIFIED TokenType = 0 - // TOKEN_TYPE_API is a token for api usage + // TOKEN_TYPE_API is a token for api usage. TokenType_TOKEN_TYPE_API TokenType = 1 // TOKEN_TYPE_USER is a token to access the api with cli, a web application or other user induced actions. TokenType_TOKEN_TYPE_USER TokenType = 2 @@ -77,12 +77,12 @@ func (TokenType) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_token_proto_rawDescGZIP(), []int{0} } -// Token generates a jwt authentication token to access the api +// Token generates a jwt authentication token to access the api. // -// # There are two different types of tokens, api- and user- tokens +// There are two different types of tokens, api- and user- tokens. // // A user token is used to authenticate end user requests for example from a cli. -// The configured roles in a user token are expanded in the api server +// The configured roles in a user token are expanded in the api server. // based on the memberships in other projects and tenants based on the role granted there. // User tokens will never contain permissions. // Permissions are always derived from the tenant and project roles and memberships. @@ -99,24 +99,24 @@ type Token struct { Meta *Meta `protobuf:"bytes,3,opt,name=meta,proto3" json:"meta,omitempty"` // Description is a user given description of this token. Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"` - // Permissions is a list of service methods this token can be used for + // Permissions is a list of service methods this token can be used for. Permissions []*MethodPermission `protobuf:"bytes,5,rep,name=permissions,proto3" json:"permissions,omitempty"` - // Expires gives the date in the future after which this token can not be used anymore + // Expires gives the date in the future after which this token can not be used anymore. Expires *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=expires,proto3" json:"expires,omitempty"` - // IssuedAt gives the date when this token was created + // IssuedAt gives the date when this token was created. IssuedAt *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=issued_at,json=issuedAt,proto3" json:"issued_at,omitempty"` - // TokenType describes the type of this token + // TokenType describes the type of this token. TokenType TokenType `protobuf:"varint,8,opt,name=token_type,json=tokenType,proto3,enum=metalstack.api.v2.TokenType" json:"token_type,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,9,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,10,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 defines the admin role of the token owner. AdminRole *AdminRole `protobuf:"varint,11,opt,name=admin_role,json=adminRole,proto3,enum=metalstack.api.v2.AdminRole,oneof" json:"admin_role,omitempty"` - // InfraRole defines the infrastructure role of the token owner + // InfraRole defines the infrastructure role of the token owner. InfraRole *InfraRole `protobuf:"varint,12,opt,name=infra_role,json=infraRole,proto3,enum=metalstack.api.v2.InfraRole,oneof" json:"infra_role,omitempty"` - // MachineRoles associates a machine uuid with the corresponding role of the token owner - // TODO: decide if we need this map from machine.uuid->role, we could instead use the subject in the token instead + // MachineRoles associates a machine uuid with the corresponding role of the token owner. + // TODO: decide if we need this map from machine.uuid->role, we could instead use the subject in the token instead. MachineRoles map[string]MachineRole `protobuf:"bytes,13,rep,name=machine_roles,json=machineRoles,proto3" json:"machine_roles,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"varint,2,opt,name=value,enum=metalstack.api.v2.MachineRole"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -243,24 +243,24 @@ func (x *Token) GetMachineRoles() map[string]MachineRole { return nil } -// TokenServiceCreateRequest is the request payload to create a token +// TokenServiceCreateRequest is the request payload to create a token. type TokenServiceCreateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Description of the token Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"` - // Permissions is a list of service methods this token can be used for + // Permissions is a list of service methods this token can be used for. Permissions []*PermissionsByVisibility `protobuf:"bytes,2,rep,name=permissions,proto3" json:"permissions,omitempty"` - // Expires gives the duration since now, after which this token can not be used anymore + // Expires gives the duration since now, after which this token can not be used anymore. Expires *durationpb.Duration `protobuf:"bytes,3,opt,name=expires,proto3" json:"expires,omitempty"` - // ProjectRoles associates a project id with the corresponding role of the token owner + // ProjectRoles associates a project id with the corresponding role of the token owner. ProjectRoles map[string]ProjectRole `protobuf:"bytes,4,rep,name=project_roles,json=projectRoles,proto3" json:"project_roles,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"varint,2,opt,name=value,enum=metalstack.api.v2.ProjectRole"` - // TenantRoles associates a tenant id with the corresponding role of the token owner + // TenantRoles associates a tenant id with the corresponding role of the token owner. TenantRoles map[string]TenantRole `protobuf:"bytes,5,rep,name=tenant_roles,json=tenantRoles,proto3" json:"tenant_roles,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"varint,2,opt,name=value,enum=metalstack.api.v2.TenantRole"` - // AdminRole defines the admin role of the token owner + // AdminRole defines the admin role of the token owner. AdminRole *AdminRole `protobuf:"varint,6,opt,name=admin_role,json=adminRole,proto3,enum=metalstack.api.v2.AdminRole,oneof" json:"admin_role,omitempty"` - // InfraRole defines the infrastructure role of the token owner + // InfraRole defines the infrastructure role of the token owner. InfraRole *InfraRole `protobuf:"varint,7,opt,name=infra_role,json=infraRole,proto3,enum=metalstack.api.v2.InfraRole,oneof" json:"infra_role,omitempty"` - // MachineRoles associates a machine uuid with the corresponding role of the token owner + // MachineRoles associates a machine uuid with the corresponding role of the token owner. MachineRoles map[string]MachineRole `protobuf:"bytes,8,rep,name=machine_roles,json=machineRoles,proto3" json:"machine_roles,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"varint,2,opt,name=value,enum=metalstack.api.v2.MachineRole"` // Labels on this token Labels *Labels `protobuf:"bytes,9,opt,name=labels,proto3" json:"labels,omitempty"` @@ -361,7 +361,7 @@ func (x *TokenServiceCreateRequest) GetLabels() *Labels { return nil } -// MethodPermission is a mapping from a subject/project to a service method +// MethodPermission is a mapping from a subject/project to a service method. type MethodPermission struct { state protoimpl.MessageState `protogen:"open.v1"` // Subject maybe either the project or the tenant @@ -421,10 +421,10 @@ func (x *MethodPermission) GetMethods() []string { return nil } -// PermissionsByVisibility contains method permissions by visibility +// PermissionsByVisibility contains method permissions by visibility. type PermissionsByVisibility struct { state protoimpl.MessageState `protogen:"open.v1"` - // Visibility defines the visibility of the requested method permissions + // Visibility defines the visibility of the requested method permissions. // // Types that are valid to be assigned to Visibility: // @@ -545,37 +545,37 @@ type isPermissionsByVisibility_Visibility interface { } type PermissionsByVisibility_Public struct { - // PublicPermissions carries public method permissions + // PublicPermissions carries public method permissions. Public *PublicPermissions `protobuf:"bytes,1,opt,name=public,proto3,oneof"` } type PermissionsByVisibility_Self struct { - // SelfPermissions carries self method permissions + // SelfPermissions carries self method permissions. Self *SelfPermissions `protobuf:"bytes,2,opt,name=self,proto3,oneof"` } type PermissionsByVisibility_Project struct { - // ProjectPermissions carries project method permissions + // ProjectPermissions carries project method permissions. Project *ProjectPermissions `protobuf:"bytes,3,opt,name=project,proto3,oneof"` } type PermissionsByVisibility_Tenant struct { - // TenantPermissions carries tenant method permissions + // TenantPermissions carries tenant method permissions. Tenant *TenantPermissions `protobuf:"bytes,4,opt,name=tenant,proto3,oneof"` } type PermissionsByVisibility_Admin struct { - // AdminPermissions carries admin method permissions + // AdminPermissions carries admin method permissions. Admin *AdminPermissions `protobuf:"bytes,5,opt,name=admin,proto3,oneof"` } type PermissionsByVisibility_Machine struct { - // MachinePermissions carries machine method permissions + // MachinePermissions carries machine method permissions. Machine *MachinePermissions `protobuf:"bytes,6,opt,name=machine,proto3,oneof"` } type PermissionsByVisibility_Infra struct { - // InfraPermissions carries infra method permissions + // InfraPermissions carries infra method permissions. Infra *InfraPermissions `protobuf:"bytes,7,opt,name=infra,proto3,oneof"` } @@ -593,7 +593,7 @@ func (*PermissionsByVisibility_Machine) isPermissionsByVisibility_Visibility() { func (*PermissionsByVisibility_Infra) isPermissionsByVisibility_Visibility() {} -// PublicPermissions carries public method permissions +// PublicPermissions carries public method permissions. type PublicPermissions struct { state protoimpl.MessageState `protogen:"open.v1"` // Methods which should be accessible @@ -639,7 +639,7 @@ func (x *PublicPermissions) GetMethods() []string { return nil } -// SelfPermissions carries self method permissions +// SelfPermissions carries self method permissions. type SelfPermissions struct { state protoimpl.MessageState `protogen:"open.v1"` // Methods which should be accessible @@ -685,7 +685,7 @@ func (x *SelfPermissions) GetMethods() []string { return nil } -// ProjectPermissions carries project method permissions +// ProjectPermissions carries project method permissions. type ProjectPermissions struct { state protoimpl.MessageState `protogen:"open.v1"` // asterisk (*) can be specified to match any subject @@ -740,7 +740,7 @@ func (x *ProjectPermissions) GetMethods() []string { return nil } -// TenantPermissions carries tenant method permissions +// TenantPermissions carries tenant method permissions. type TenantPermissions struct { state protoimpl.MessageState `protogen:"open.v1"` // Login of the tenant @@ -796,7 +796,7 @@ func (x *TenantPermissions) GetMethods() []string { return nil } -// AdminPermissions carries admin method permissions +// AdminPermissions carries admin method permissions. type AdminPermissions struct { state protoimpl.MessageState `protogen:"open.v1"` // Methods which should be accessible @@ -842,7 +842,7 @@ func (x *AdminPermissions) GetMethods() []string { return nil } -// MachinePermissions carries machine method permissions +// MachinePermissions carries machine method permissions. type MachinePermissions struct { state protoimpl.MessageState `protogen:"open.v1"` // UUID of this machine @@ -898,7 +898,7 @@ func (x *MachinePermissions) GetMethods() []string { return nil } -// InfraPermissions carries infra method permissions +// InfraPermissions carries infra method permissions. type InfraPermissions struct { state protoimpl.MessageState `protogen:"open.v1"` // Methods which should be accessible @@ -944,12 +944,12 @@ func (x *InfraPermissions) GetMethods() []string { return nil } -// TokenServiceCreateResponse is the response payload of a token create request +// TokenServiceCreateResponse is the response payload of a token create request. type TokenServiceCreateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Token which was created Token *Token `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"` - // Secret is the body of the JWT token, should be used in API requests as bearer token + // Secret is the body of the JWT token, should be used in API requests as bearer token. Secret string `protobuf:"bytes,2,opt,name=secret,proto3" json:"secret,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -999,10 +999,10 @@ func (x *TokenServiceCreateResponse) GetSecret() string { return "" } -// TokenServiceListRequest is the request payload to list tokens +// TokenServiceListRequest is the request payload to list tokens. type TokenServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Query for tokens + // Query for tokens. Query *TokenQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1045,10 +1045,10 @@ func (x *TokenServiceListRequest) GetQuery() *TokenQuery { return nil } -// TokenServiceListResponse is the response payload of a token list request +// TokenServiceListResponse is the response payload of a token list request. type TokenServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Tokens is a list of tokens without the secrets + // Tokens is a list of tokens without the secrets. Tokens []*Token `protobuf:"bytes,1,rep,name=tokens,proto3" json:"tokens,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1091,7 +1091,7 @@ func (x *TokenServiceListResponse) GetTokens() []*Token { return nil } -// TokenServiceRevokeRequest is the request payload of a token revoke request +// TokenServiceRevokeRequest is the request payload of a token revoke request. type TokenServiceRevokeRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Uuid of the token to revoke @@ -1137,7 +1137,7 @@ func (x *TokenServiceRevokeRequest) GetUuid() string { return "" } -// TokenServiceRevokeResponse is the response payload of a token revoke request +// TokenServiceRevokeResponse is the response payload of a token revoke request. type TokenServiceRevokeResponse struct { state protoimpl.MessageState `protogen:"open.v1"` unknownFields protoimpl.UnknownFields @@ -1174,27 +1174,27 @@ func (*TokenServiceRevokeResponse) Descriptor() ([]byte, []int) { return file_metalstack_api_v2_token_proto_rawDescGZIP(), []int{15} } -// TokenServiceUpdateRequest is the request payload of a token update request +// TokenServiceUpdateRequest is the request payload of a token update request. type TokenServiceUpdateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Uuid of the token to update Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` - // UpdateMeta contains the timestamp and strategy to be used in this update request - // TokenUpdate is not guarded with optlock in the backend + // UpdateMeta contains the timestamp and strategy to be used in this update request. + // TokenUpdate is not guarded with optlock in the backend. UpdateMeta *UpdateMeta `protobuf:"bytes,2,opt,name=update_meta,json=updateMeta,proto3" json:"update_meta,omitempty"` // Description is a user given description of this token. Description *string `protobuf:"bytes,3,opt,name=description,proto3,oneof" json:"description,omitempty"` - // Permissions is a list of service methods this token can be used for + // Permissions is a list of service methods this token can be used for. Permissions []*PermissionsByVisibility `protobuf:"bytes,4,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,5,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,6,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 defines the admin role of the token owner. AdminRole *AdminRole `protobuf:"varint,7,opt,name=admin_role,json=adminRole,proto3,enum=metalstack.api.v2.AdminRole,oneof" json:"admin_role,omitempty"` - // InfraRole defines the infrastructure role of the token owner + // InfraRole defines the infrastructure role of the token owner. InfraRole *InfraRole `protobuf:"varint,8,opt,name=infra_role,json=infraRole,proto3,enum=metalstack.api.v2.InfraRole,oneof" json:"infra_role,omitempty"` - // MachineRoles associates a machine uuid with the corresponding role of the token owner + // MachineRoles associates a machine uuid with the corresponding role of the token owner. MachineRoles map[string]MachineRole `protobuf:"bytes,9,rep,name=machine_roles,json=machineRoles,proto3" json:"machine_roles,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"varint,2,opt,name=value,enum=metalstack.api.v2.MachineRole"` // Labels on this token Labels *UpdateLabels `protobuf:"bytes,10,opt,name=labels,proto3" json:"labels,omitempty"` @@ -1302,10 +1302,10 @@ func (x *TokenServiceUpdateRequest) GetLabels() *UpdateLabels { return nil } -// TokenServiceUpdateResponse is the response payload of a token update request +// TokenServiceUpdateResponse is the response payload of a token update request. type TokenServiceUpdateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Token is the updated token + // Token is the updated token. Token *Token `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1348,7 +1348,7 @@ func (x *TokenServiceUpdateResponse) GetToken() *Token { return nil } -// TokenServiceGetRequest is the request payload of a token get request +// TokenServiceGetRequest is the request payload of a token get request. type TokenServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Uuid of the token to get @@ -1394,10 +1394,10 @@ func (x *TokenServiceGetRequest) GetUuid() string { return "" } -// TokenServiceGetResponse is the response payload of a token get request +// TokenServiceGetResponse is the response payload of a token get request. type TokenServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Token is the token + // Token is the token. Token *Token `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1440,7 +1440,7 @@ func (x *TokenServiceGetResponse) GetToken() *Token { return nil } -// TokenServiceRefreshRequest is the request payload of a token refresh request +// TokenServiceRefreshRequest is the request payload of a token refresh request. // Permissions, Roles and Expiration duration and all other properties are inherited from the calling token. // The expiration duration will be calculated from the existing token (exp - iat) type TokenServiceRefreshRequest struct { @@ -1479,12 +1479,12 @@ func (*TokenServiceRefreshRequest) Descriptor() ([]byte, []int) { return file_metalstack_api_v2_token_proto_rawDescGZIP(), []int{20} } -// TokenServiceRefreshResponse is the response payload of a token refresh request +// TokenServiceRefreshResponse is the response payload of a token refresh request. type TokenServiceRefreshResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Token which was refreshed Token *Token `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"` - // Secret is the body of the JWT token, should be used in API requests as bearer token + // Secret is the body of the JWT token, should be used in API requests as bearer token. Secret string `protobuf:"bytes,2,opt,name=secret,proto3" json:"secret,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1534,7 +1534,7 @@ func (x *TokenServiceRefreshResponse) GetSecret() string { return "" } -// TokenQuery is used to search tokens +// TokenQuery is used to search tokens. type TokenQuery struct { state protoimpl.MessageState `protogen:"open.v1"` // UUID of the token to get @@ -1544,7 +1544,7 @@ type TokenQuery struct { User *string `protobuf:"bytes,2,opt,name=user,proto3,oneof" json:"user,omitempty"` // Description of the token to query Description *string `protobuf:"bytes,3,opt,name=description,proto3,oneof" json:"description,omitempty"` - // Labels lists only tokens containing the given labels + // Labels lists only tokens containing the given labels. Labels *Labels `protobuf:"bytes,4,opt,name=labels,proto3,oneof" json:"labels,omitempty"` // Token type of the token to query TokenType *TokenType `protobuf:"varint,5,opt,name=token_type,json=tokenType,proto3,enum=metalstack.api.v2.TokenType,oneof" json:"token_type,omitempty"` diff --git a/go/metalstack/api/v2/user.pb.go b/go/metalstack/api/v2/user.pb.go index 3ae540c5..f4b057ad 100644 --- a/go/metalstack/api/v2/user.pb.go +++ b/go/metalstack/api/v2/user.pb.go @@ -25,7 +25,7 @@ const ( // User represents an end user of the platform. type User struct { state protoimpl.MessageState `protogen:"open.v1"` - // Login is 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"` @@ -162,7 +162,7 @@ func (*UserServiceGetRequest) Descriptor() ([]byte, []int) { // UserServiceGetResponse is the response payload for getting the user. type UserServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // User contains the authenticated 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 c994a555..b3481dbb 100644 --- a/go/metalstack/api/v2/version.pb.go +++ b/go/metalstack/api/v2/version.pb.go @@ -135,7 +135,7 @@ func (*VersionServiceGetRequest) Descriptor() ([]byte, []int) { // VersionServiceGetResponse is the response payload for getting the version. type VersionServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Version contains the 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 e9058277..f4802eb9 100644 --- a/go/metalstack/api/v2/vpn.pb.go +++ b/go/metalstack/api/v2/vpn.pb.go @@ -36,7 +36,7 @@ type VPNNode struct { IpAddresses []string `protobuf:"bytes,4,rep,name=ip_addresses,json=ipAddresses,proto3" json:"ip_addresses,omitempty"` // 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 indicates if this node is online. Online bool `protobuf:"varint,6,opt,name=online,proto3" json:"online,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/infra/v2/bmc.pb.go b/go/metalstack/infra/v2/bmc.pb.go index ca32240a..bf3be9cf 100644 --- a/go/metalstack/infra/v2/bmc.pb.go +++ b/go/metalstack/infra/v2/bmc.pb.go @@ -26,9 +26,9 @@ const ( // UpdateBMCInfoRequest is the request payload for updating BMC information. type UpdateBMCInfoRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Partition is 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 maps the BMC report per machine UUID + // BmcReports maps the BMC report per machine UUID. BmcReports map[string]*v2.MachineBMCReport `protobuf:"bytes,2,rep,name=bmc_reports,json=bmcReports,proto3" json:"bmc_reports,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -81,9 +81,9 @@ func (x *UpdateBMCInfoRequest) GetBmcReports() map[string]*v2.MachineBMCReport { // 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 @@ -136,7 +136,7 @@ func (x *UpdateBMCInfoResponse) GetCreatedMachines() []string { // WaitForBMCCommandRequest is the request payload for waiting for a BMC command. type WaitForBMCCommandRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Partition is 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 @@ -186,10 +186,10 @@ type WaitForBMCCommandResponse struct { Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` // 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 BMC command 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: + // CommandId is a unique ID which must be sent back after execution. + // 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 @@ -256,8 +256,8 @@ func (x *WaitForBMCCommandResponse) GetCommandId() string { // 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 + // CommandId is a unique ID which must be sent back after execution. + // 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"` diff --git a/go/metalstack/infra/v2/boot.pb.go b/go/metalstack/infra/v2/boot.pb.go index 32efb3a0..2295c47d 100644 --- a/go/metalstack/infra/v2/boot.pb.go +++ b/go/metalstack/infra/v2/boot.pb.go @@ -23,12 +23,12 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) -// BootServiceDhcpRequest is called once a machine issues a dhcp request +// BootServiceDhcpRequest is called once a machine issues a dhcp request. type BootServiceDhcpRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // UUID of the machine Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` - // Partition where this machine is located + // Partition where this machine is located. Partition string `protobuf:"bytes,2,opt,name=partition,proto3" json:"partition,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -78,7 +78,7 @@ func (x *BootServiceDhcpRequest) GetPartition() string { return "" } -// BootServiceDhcpResponse contains the response to a dhcp request +// BootServiceDhcpResponse contains the response to a dhcp request. type BootServiceDhcpResponse struct { state protoimpl.MessageState `protogen:"open.v1"` unknownFields protoimpl.UnknownFields @@ -115,12 +115,12 @@ func (*BootServiceDhcpResponse) Descriptor() ([]byte, []int) { return file_metalstack_infra_v2_boot_proto_rawDescGZIP(), []int{1} } -// BootServiceBootRequest is called to get specified parameters to boot a machine with the given mac +// BootServiceBootRequest is called to get specified parameters to boot a machine with the given mac. type BootServiceBootRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Mac address of the machine Mac string `protobuf:"bytes,1,opt,name=mac,proto3" json:"mac,omitempty"` - // Partition where this machine is located + // Partition where this machine is located. Partition string `protobuf:"bytes,2,opt,name=partition,proto3" json:"partition,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -170,14 +170,14 @@ func (x *BootServiceBootRequest) GetPartition() string { return "" } -// BootServiceBootResponse contains additional infos which are required to boot a machine +// BootServiceBootResponse contains additional infos which are required to boot a machine. type BootServiceBootResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Kernel is the url to the linux kernel to boot + // Kernel is the url to the linux kernel to boot. Kernel string `protobuf:"bytes,1,opt,name=kernel,proto3" json:"kernel,omitempty"` - // Initial ram disk is the url to the initial ram disk to boot + // Initial ram disk is the url to the initial ram disk to boot. InitRamDisks []string `protobuf:"bytes,2,rep,name=init_ram_disks,json=initRamDisks,proto3" json:"init_ram_disks,omitempty"` - // CMDLine contains kernel command line parameters to boot + // CMDLine contains kernel command line parameters to boot. Cmdline *string `protobuf:"bytes,3,opt,name=cmdline,proto3,oneof" json:"cmdline,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -234,7 +234,7 @@ func (x *BootServiceBootResponse) GetCmdline() string { return "" } -// BootServiceRegisterRequest is called from metal-hammer to register a machine with as much hardware details as possible +// BootServiceRegisterRequest is called from metal-hammer to register a machine with as much hardware details as possible. type BootServiceRegisterRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // UUID of this machine @@ -249,9 +249,9 @@ type BootServiceRegisterRequest struct { Fru *v2.MachineFRU `protobuf:"bytes,5,opt,name=fru,proto3" json:"fru,omitempty"` // Tags of this machine Tags []string `protobuf:"bytes,6,rep,name=tags,proto3" json:"tags,omitempty"` - // MetalHammer version this machine was booted into + // MetalHammer version this machine was booted into. MetalHammerVersion string `protobuf:"bytes,7,opt,name=metal_hammer_version,json=metalHammerVersion,proto3" json:"metal_hammer_version,omitempty"` - // Partition where this machine is located + // Partition where this machine is located. Partition string `protobuf:"bytes,8,opt,name=partition,proto3" json:"partition,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -348,7 +348,7 @@ type BootServiceRegisterResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // UUID of this machine Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` - // Size is the calculated size from given hardware details + // Size is the calculated size from given hardware details. Size string `protobuf:"bytes,2,opt,name=size,proto3" json:"size,omitempty"` // Partition of this machine Partition string `protobuf:"bytes,3,opt,name=partition,proto3" json:"partition,omitempty"` @@ -407,7 +407,7 @@ func (x *BootServiceRegisterResponse) GetPartition() string { return "" } -// BootServiceWaitRequest is called when a machine was registered and is waiting for allocation +// BootServiceWaitRequest is called when a machine was registered and is waiting for allocation. type BootServiceWaitRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // UUID of this machine @@ -456,7 +456,7 @@ func (x *BootServiceWaitRequest) GetUuid() string { // BootServiceWaitResponse response to a wait request type BootServiceWaitResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Allocation contains the machine.allocation to actually install the machine + // Allocation contains the machine.allocation to actually install the machine. Allocation *v2.MachineAllocation `protobuf:"bytes,1,opt,name=allocation,proto3" json:"allocation,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -499,7 +499,7 @@ func (x *BootServiceWaitResponse) GetAllocation() *v2.MachineAllocation { return nil } -// BootServiceInstallationSucceededRequest is sent from metal-hammer to the api to report the installation succeeded +// BootServiceInstallationSucceededRequest is sent from metal-hammer to the api to report the installation succeeded. type BootServiceInstallationSucceededRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // UUID of the machine to boot @@ -554,7 +554,7 @@ func (x *BootServiceInstallationSucceededRequest) GetConsolePassword() string { return "" } -// BootServiceInstallationSucceededResponse is the response to a BootServiceInstallationSucceededRequest +// BootServiceInstallationSucceededResponse is the response to a BootServiceInstallationSucceededRequest. type BootServiceInstallationSucceededResponse struct { state protoimpl.MessageState `protogen:"open.v1"` unknownFields protoimpl.UnknownFields @@ -642,7 +642,7 @@ type BootServiceSuperUserPasswordResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // FeatureDisabled on set the superuserpassword in the bmc if this feature is not disabled. FeatureDisabled bool `protobuf:"varint,1,opt,name=feature_disabled,json=featureDisabled,proto3" json:"feature_disabled,omitempty"` - // SuperUserPassword is the password of the superuser on the ipmi device + // SuperUserPassword is the password of the superuser on the ipmi device. SuperUserPassword string `protobuf:"bytes,2,opt,name=super_user_password,json=superUserPassword,proto3" json:"super_user_password,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/infra/v2/component.pb.go b/go/metalstack/infra/v2/component.pb.go index 7dffdf51..e84f8132 100644 --- a/go/metalstack/infra/v2/component.pb.go +++ b/go/metalstack/infra/v2/component.pb.go @@ -28,11 +28,11 @@ const ( // 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 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, for example if two instances are running, this might be the pod ID + // 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 Interval *durationpb.Duration `protobuf:"bytes,4,opt,name=interval,proto3" json:"interval,omitempty"` diff --git a/go/metalstack/infra/v2/event.pb.go b/go/metalstack/infra/v2/event.pb.go index 1cc203f1..bd1774b8 100644 --- a/go/metalstack/infra/v2/event.pb.go +++ b/go/metalstack/infra/v2/event.pb.go @@ -73,7 +73,7 @@ type EventServiceSendResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // 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 diff --git a/go/metalstack/infra/v2/switch.pb.go b/go/metalstack/infra/v2/switch.pb.go index aadc02d5..802db807 100644 --- a/go/metalstack/infra/v2/switch.pb.go +++ b/go/metalstack/infra/v2/switch.pb.go @@ -73,7 +73,7 @@ func (x *SwitchServiceGetRequest) GetId() string { // SwitchServiceGetResponse is the response payload for getting a switch. type SwitchServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Switch contains the requested switch + // Switch contains the requested switch. Switch *v2.Switch `protobuf:"bytes,1,opt,name=switch,proto3" json:"switch,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -165,7 +165,7 @@ func (x *SwitchServiceRegisterRequest) GetSwitch() *v2.Switch { // SwitchServiceRegisterResponse is the response payload for registering a switch. type SwitchServiceRegisterResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Switch contains the registered switch + // Switch contains the registered switch. Switch *v2.Switch `protobuf:"bytes,1,opt,name=switch,proto3" json:"switch,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -217,9 +217,9 @@ type SwitchServiceHeartbeatRequest struct { Duration *durationpb.Duration `protobuf:"bytes,2,opt,name=duration,proto3" json:"duration,omitempty"` // 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 @@ -295,9 +295,9 @@ type SwitchServiceHeartbeatResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // 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/client-test.d.ts b/js/client-test.d.ts new file mode 100644 index 00000000..cb0ff5c3 --- /dev/null +++ b/js/client-test.d.ts @@ -0,0 +1 @@ +export {}; diff --git a/js/client-test.js b/js/client-test.js new file mode 100644 index 00000000..05b9a1f6 --- /dev/null +++ b/js/client-test.js @@ -0,0 +1,45 @@ +var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) { + function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); } + return new (P || (P = Promise))(function (resolve, reject) { + function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } } + function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } } + function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); } + step((generator = generator.apply(thisArg, _arguments || [])).next()); + }); +}; +import { describe, it, expect } from "bun:test"; +import { create } from "@bufbuild/protobuf"; +import { VersionServiceGetRequestSchema, } from "./metalstack/api/v2/version_pb"; +import { newClient } from "./client"; +import { newTestInterceptor } from "./test-interceptor"; +function unaryResponse(schema, message) { + return { + stream: false, + message: message, + header: new Headers(), + trailer: new Headers(), + service: undefined, + method: undefined, + }; +} +describe("client", () => { + it("works with test interceptor", () => __awaiter(void 0, void 0, void 0, function* () { + var _a; + const c = newClient({ + baseUrl: "http://this-is-just-for-testing", + interceptors: [ + newTestInterceptor([ + { + wantRequest: create(VersionServiceGetRequestSchema, {}), + wantRequestSchema: VersionServiceGetRequestSchema, + wantResponse: () => unaryResponse(VersionServiceGetRequestSchema, { + version: { version: "1.0", revision: "", gitSha1: "", buildDate: "" }, + }), + }, + ]), + ], + }); + const v = yield c.apiv2().version().get({}); + expect((_a = v.version) === null || _a === void 0 ? void 0 : _a.version).toBe("1.0"); + })); +}); diff --git a/js/metalstack/admin/v2/audit_pb.d.ts b/js/metalstack/admin/v2/audit_pb.d.ts index 7403ed84..537c49b5 100644 --- a/js/metalstack/admin/v2/audit_pb.d.ts +++ b/js/metalstack/admin/v2/audit_pb.d.ts @@ -12,7 +12,7 @@ export declare const file_metalstack_admin_v2_audit: GenFile; */ export type AuditServiceListRequest = Message<"metalstack.admin.v2.AuditServiceListRequest"> & { /** - * Query for audit traces + * Query for audit traces. * * @generated from field: metalstack.api.v2.AuditQuery query = 1; */ @@ -30,7 +30,7 @@ export declare const AuditServiceListRequestSchema: GenMessage & { /** - * Traces contains the list of audit traces + * Traces contains the list of audit traces. * * @generated from field: repeated metalstack.api.v2.AuditTrace traces = 1; */ @@ -54,7 +54,7 @@ export type AuditServiceGetRequest = Message<"metalstack.admin.v2.AuditServiceGe */ uuid: string; /** - * Phase specifies the audit phase. Defaults to request + * Phase specifies the audit phase. Defaults to request. * * @generated from field: optional metalstack.api.v2.AuditPhase phase = 2; */ @@ -72,7 +72,7 @@ export declare const AuditServiceGetRequestSchema: GenMessage & { /** - * Trace is the audit trace + * Trace is the audit trace. * * @generated from field: metalstack.api.v2.AuditTrace trace = 1; */ diff --git a/js/metalstack/admin/v2/audit_pb.ts b/js/metalstack/admin/v2/audit_pb.ts index 04417754..dd4b8fbb 100644 --- a/js/metalstack/admin/v2/audit_pb.ts +++ b/js/metalstack/admin/v2/audit_pb.ts @@ -23,7 +23,7 @@ export const file_metalstack_admin_v2_audit: GenFile = /*@__PURE__*/ */ export type AuditServiceListRequest = Message<"metalstack.admin.v2.AuditServiceListRequest"> & { /** - * Query for audit traces + * Query for audit traces. * * @generated from field: metalstack.api.v2.AuditQuery query = 1; */ @@ -44,7 +44,7 @@ export const AuditServiceListRequestSchema: GenMessage */ export type AuditServiceListResponse = Message<"metalstack.admin.v2.AuditServiceListResponse"> & { /** - * Traces contains the list of audit traces + * Traces contains the list of audit traces. * * @generated from field: repeated metalstack.api.v2.AuditTrace traces = 1; */ @@ -72,7 +72,7 @@ export type AuditServiceGetRequest = Message<"metalstack.admin.v2.AuditServiceGe uuid: string; /** - * Phase specifies the audit phase. Defaults to request + * Phase specifies the audit phase. Defaults to request. * * @generated from field: optional metalstack.api.v2.AuditPhase phase = 2; */ @@ -93,7 +93,7 @@ export const AuditServiceGetRequestSchema: GenMessage = */ export type AuditServiceGetResponse = Message<"metalstack.admin.v2.AuditServiceGetResponse"> & { /** - * Trace is the audit trace + * Trace is the audit trace. * * @generated from field: metalstack.api.v2.AuditTrace trace = 1; */ diff --git a/js/metalstack/admin/v2/component_pb.d.ts b/js/metalstack/admin/v2/component_pb.d.ts index b226de01..b7991899 100644 --- a/js/metalstack/admin/v2/component_pb.d.ts +++ b/js/metalstack/admin/v2/component_pb.d.ts @@ -12,7 +12,7 @@ export declare const file_metalstack_admin_v2_component: GenFile; */ export type ComponentServiceListRequest = Message<"metalstack.admin.v2.ComponentServiceListRequest"> & { /** - * Query filters components + * Query filters components. * * @generated from field: metalstack.api.v2.ComponentQuery query = 1; */ @@ -30,7 +30,7 @@ export declare const ComponentServiceListRequestSchema: GenMessage & { /** - * Components contains the list of components + * Components contains the list of components. * * @generated from field: repeated metalstack.api.v2.Component components = 1; */ @@ -48,7 +48,7 @@ export declare const ComponentServiceListResponseSchema: GenMessage & { /** - * UUID identifies the component to get + * UUID identifies the component to get. * * @generated from field: string uuid = 1; */ @@ -66,7 +66,7 @@ export declare const ComponentServiceGetRequestSchema: GenMessage & { /** - * Component contains the retrieved component + * Component contains the retrieved component. * * @generated from field: metalstack.api.v2.Component component = 1; */ @@ -84,7 +84,7 @@ export declare const ComponentServiceGetResponseSchema: GenMessage & { /** - * UUID identifies the component to delete + * UUID identifies the component to delete. * * @generated from field: string uuid = 1; */ @@ -102,7 +102,7 @@ export declare const ComponentServiceDeleteRequestSchema: GenMessage & { /** - * Component contains the deleted component + * Component contains the deleted component. * * @generated from field: metalstack.api.v2.Component component = 1; */ diff --git a/js/metalstack/admin/v2/component_pb.ts b/js/metalstack/admin/v2/component_pb.ts index 947483e4..ceb0e98f 100644 --- a/js/metalstack/admin/v2/component_pb.ts +++ b/js/metalstack/admin/v2/component_pb.ts @@ -23,7 +23,7 @@ export const file_metalstack_admin_v2_component: GenFile = /*@__PURE__*/ */ export type ComponentServiceListRequest = Message<"metalstack.admin.v2.ComponentServiceListRequest"> & { /** - * Query filters components + * Query filters components. * * @generated from field: metalstack.api.v2.ComponentQuery query = 1; */ @@ -44,7 +44,7 @@ export const ComponentServiceListRequestSchema: GenMessage & { /** - * Components contains the list of components + * Components contains the list of components. * * @generated from field: repeated metalstack.api.v2.Component components = 1; */ @@ -65,7 +65,7 @@ export const ComponentServiceListResponseSchema: GenMessage & { /** - * UUID identifies the component to get + * UUID identifies the component to get. * * @generated from field: string uuid = 1; */ @@ -86,7 +86,7 @@ export const ComponentServiceGetRequestSchema: GenMessage & { /** - * Component contains the retrieved component + * Component contains the retrieved component. * * @generated from field: metalstack.api.v2.Component component = 1; */ @@ -107,7 +107,7 @@ export const ComponentServiceGetResponseSchema: GenMessage & { /** - * UUID identifies the component to delete + * UUID identifies the component to delete. * * @generated from field: string uuid = 1; */ @@ -128,7 +128,7 @@ export const ComponentServiceDeleteRequestSchema: GenMessage & { /** - * Component contains the deleted component + * Component contains the deleted component. * * @generated from field: metalstack.api.v2.Component component = 1; */ diff --git a/js/metalstack/admin/v2/filesystem_pb.d.ts b/js/metalstack/admin/v2/filesystem_pb.d.ts index 103ec78b..504518f2 100644 --- a/js/metalstack/admin/v2/filesystem_pb.d.ts +++ b/js/metalstack/admin/v2/filesystem_pb.d.ts @@ -13,7 +13,7 @@ export declare const file_metalstack_admin_v2_filesystem: GenFile; */ export type FilesystemServiceCreateRequest = Message<"metalstack.admin.v2.FilesystemServiceCreateRequest"> & { /** - * FilesystemLayout is the filesystem layout to create + * FilesystemLayout is the filesystem layout to create. * * @generated from field: metalstack.api.v2.FilesystemLayout filesystem_layout = 1; */ @@ -31,7 +31,7 @@ export declare const FilesystemServiceCreateRequestSchema: GenMessage & { /** - * FilesystemLayout contains the created filesystem layout + * FilesystemLayout contains the created filesystem layout. * * @generated from field: metalstack.api.v2.FilesystemLayout filesystem_layout = 1; */ @@ -55,7 +55,7 @@ export type FilesystemServiceUpdateRequest = Message<"metalstack.admin.v2.Filesy */ id: string; /** - * 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. * * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 2; */ @@ -73,13 +73,13 @@ export type FilesystemServiceUpdateRequest = Message<"metalstack.admin.v2.Filesy */ description?: string | undefined; /** - * Filesystems is a list of filesystems to create on a machine + * Filesystems is a list of filesystems to create on a machine. * * @generated from field: repeated metalstack.api.v2.Filesystem filesystems = 5; */ filesystems: Filesystem[]; /** - * Disks list of disks that belong to this layout + * Disks list of disks that belong to this layout. * * @generated from field: repeated metalstack.api.v2.Disk disks = 6; */ @@ -91,13 +91,13 @@ export type FilesystemServiceUpdateRequest = Message<"metalstack.admin.v2.Filesy */ raid: Raid[]; /** - * VolumeGroups list of volumegroups to create + * VolumeGroups list of volumegroups to create. * * @generated from field: repeated metalstack.api.v2.VolumeGroup volume_groups = 8; */ volumeGroups: VolumeGroup[]; /** - * LogicalVolumes list of logicalvolumes to create + * LogicalVolumes list of logicalvolumes to create. * * @generated from field: repeated metalstack.api.v2.LogicalVolume logical_volumes = 9; */ @@ -121,7 +121,7 @@ export declare const FilesystemServiceUpdateRequestSchema: GenMessage & { /** - * FilesystemLayout contains the updated filesystem layout + * FilesystemLayout contains the updated filesystem layout. * * @generated from field: metalstack.api.v2.FilesystemLayout filesystem_layout = 1; */ @@ -157,7 +157,7 @@ export declare const FilesystemServiceDeleteRequestSchema: GenMessage & { /** - * FilesystemLayout contains the deleted filesystem layout + * FilesystemLayout contains the deleted filesystem layout. * * @generated from field: metalstack.api.v2.FilesystemLayout filesystem_layout = 1; */ @@ -175,7 +175,7 @@ export declare const FilesystemServiceDeleteResponseSchema: GenMessage & { /** - * Match size and image to a filesystem layout + * Match size and image to a filesystem layout. * or match a machine to a filesystem layout * * @generated from oneof metalstack.admin.v2.FilesystemServiceMatchRequest.match diff --git a/js/metalstack/admin/v2/filesystem_pb.ts b/js/metalstack/admin/v2/filesystem_pb.ts index d0f8d005..35778380 100644 --- a/js/metalstack/admin/v2/filesystem_pb.ts +++ b/js/metalstack/admin/v2/filesystem_pb.ts @@ -25,7 +25,7 @@ export const file_metalstack_admin_v2_filesystem: GenFile = /*@__PURE__*/ */ export type FilesystemServiceCreateRequest = Message<"metalstack.admin.v2.FilesystemServiceCreateRequest"> & { /** - * FilesystemLayout is the filesystem layout to create + * FilesystemLayout is the filesystem layout to create. * * @generated from field: metalstack.api.v2.FilesystemLayout filesystem_layout = 1; */ @@ -46,7 +46,7 @@ export const FilesystemServiceCreateRequestSchema: GenMessage & { /** - * FilesystemLayout contains the created filesystem layout + * FilesystemLayout contains the created filesystem layout. * * @generated from field: metalstack.api.v2.FilesystemLayout filesystem_layout = 1; */ @@ -74,7 +74,7 @@ export type FilesystemServiceUpdateRequest = Message<"metalstack.admin.v2.Filesy id: string; /** - * 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. * * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 2; */ @@ -95,14 +95,14 @@ export type FilesystemServiceUpdateRequest = Message<"metalstack.admin.v2.Filesy description?: string | undefined; /** - * Filesystems is a list of filesystems to create on a machine + * Filesystems is a list of filesystems to create on a machine. * * @generated from field: repeated metalstack.api.v2.Filesystem filesystems = 5; */ filesystems: Filesystem[]; /** - * Disks list of disks that belong to this layout + * Disks list of disks that belong to this layout. * * @generated from field: repeated metalstack.api.v2.Disk disks = 6; */ @@ -116,14 +116,14 @@ export type FilesystemServiceUpdateRequest = Message<"metalstack.admin.v2.Filesy raid: Raid[]; /** - * VolumeGroups list of volumegroups to create + * VolumeGroups list of volumegroups to create. * * @generated from field: repeated metalstack.api.v2.VolumeGroup volume_groups = 8; */ volumeGroups: VolumeGroup[]; /** - * LogicalVolumes list of logicalvolumes to create + * LogicalVolumes list of logicalvolumes to create. * * @generated from field: repeated metalstack.api.v2.LogicalVolume logical_volumes = 9; */ @@ -151,7 +151,7 @@ export const FilesystemServiceUpdateRequestSchema: GenMessage & { /** - * FilesystemLayout contains the updated filesystem layout + * FilesystemLayout contains the updated filesystem layout. * * @generated from field: metalstack.api.v2.FilesystemLayout filesystem_layout = 1; */ @@ -193,7 +193,7 @@ export const FilesystemServiceDeleteRequestSchema: GenMessage & { /** - * FilesystemLayout contains the deleted filesystem layout + * FilesystemLayout contains the deleted filesystem layout. * * @generated from field: metalstack.api.v2.FilesystemLayout filesystem_layout = 1; */ @@ -214,7 +214,7 @@ export const FilesystemServiceDeleteResponseSchema: GenMessage & { /** - * Match size and image to a filesystem layout + * Match size and image to a filesystem layout. * or match a machine to a filesystem layout * * @generated from oneof metalstack.admin.v2.FilesystemServiceMatchRequest.match diff --git a/js/metalstack/admin/v2/image_pb.d.ts b/js/metalstack/admin/v2/image_pb.d.ts index 98cd02d2..f096eda3 100644 --- a/js/metalstack/admin/v2/image_pb.d.ts +++ b/js/metalstack/admin/v2/image_pb.d.ts @@ -14,7 +14,7 @@ export declare const file_metalstack_admin_v2_image: GenFile; */ export type ImageServiceCreateRequest = Message<"metalstack.admin.v2.ImageServiceCreateRequest"> & { /** - * Image is the image to create + * Image is the image to create. * * @generated from field: metalstack.api.v2.Image image = 1; */ @@ -32,7 +32,7 @@ export declare const ImageServiceCreateRequestSchema: GenMessage & { /** - * Image contains the created image + * Image contains the created image. * * @generated from field: metalstack.api.v2.Image image = 1; */ @@ -56,7 +56,7 @@ export type ImageServiceUpdateRequest = Message<"metalstack.admin.v2.ImageServic */ id: string; /** - * 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. * * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 2; */ @@ -92,7 +92,7 @@ export type ImageServiceUpdateRequest = Message<"metalstack.admin.v2.ImageServic */ classification: ImageClassification; /** - * ExpiresAt indicates that usage is not possible after this date + * ExpiresAt indicates that usage is not possible after this date. * * @generated from field: google.protobuf.Timestamp expires_at = 8; */ @@ -116,7 +116,7 @@ export declare const ImageServiceUpdateRequestSchema: GenMessage & { /** - * Image contains the updated image + * Image contains the updated image. * * @generated from field: metalstack.api.v2.Image image = 1; */ @@ -152,7 +152,7 @@ export declare const ImageServiceDeleteRequestSchema: GenMessage & { /** - * Image contains the deleted image + * Image contains the deleted image. * * @generated from field: metalstack.api.v2.Image image = 1; */ @@ -170,7 +170,7 @@ export declare const ImageServiceDeleteResponseSchema: GenMessage & { /** - * Query for which images the usage should be reported + * Query for which images the usage should be reported. * * @generated from field: metalstack.api.v2.ImageQuery query = 1; */ @@ -188,7 +188,7 @@ export declare const ImageServiceUsageRequestSchema: GenMessage & { /** - * Images contains usage information + * Images contains usage information. * * @generated from field: repeated metalstack.api.v2.ImageUsage image_usage = 1; */ diff --git a/js/metalstack/admin/v2/image_pb.ts b/js/metalstack/admin/v2/image_pb.ts index eeb5b914..884bf1ef 100644 --- a/js/metalstack/admin/v2/image_pb.ts +++ b/js/metalstack/admin/v2/image_pb.ts @@ -27,7 +27,7 @@ export const file_metalstack_admin_v2_image: GenFile = /*@__PURE__*/ */ export type ImageServiceCreateRequest = Message<"metalstack.admin.v2.ImageServiceCreateRequest"> & { /** - * Image is the image to create + * Image is the image to create. * * @generated from field: metalstack.api.v2.Image image = 1; */ @@ -48,7 +48,7 @@ export const ImageServiceCreateRequestSchema: GenMessage & { /** - * Image contains the created image + * Image contains the created image. * * @generated from field: metalstack.api.v2.Image image = 1; */ @@ -76,7 +76,7 @@ export type ImageServiceUpdateRequest = Message<"metalstack.admin.v2.ImageServic id: string; /** - * 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. * * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 2; */ @@ -118,7 +118,7 @@ export type ImageServiceUpdateRequest = Message<"metalstack.admin.v2.ImageServic classification: ImageClassification; /** - * ExpiresAt indicates that usage is not possible after this date + * ExpiresAt indicates that usage is not possible after this date. * * @generated from field: google.protobuf.Timestamp expires_at = 8; */ @@ -146,7 +146,7 @@ export const ImageServiceUpdateRequestSchema: GenMessage & { /** - * Image contains the updated image + * Image contains the updated image. * * @generated from field: metalstack.api.v2.Image image = 1; */ @@ -188,7 +188,7 @@ export const ImageServiceDeleteRequestSchema: GenMessage & { /** - * Image contains the deleted image + * Image contains the deleted image. * * @generated from field: metalstack.api.v2.Image image = 1; */ @@ -209,7 +209,7 @@ export const ImageServiceDeleteResponseSchema: GenMessage & { /** - * Query for which images the usage should be reported + * Query for which images the usage should be reported. * * @generated from field: metalstack.api.v2.ImageQuery query = 1; */ @@ -230,7 +230,7 @@ export const ImageServiceUsageRequestSchema: GenMessage & { /** - * Images contains usage information + * Images contains usage information. * * @generated from field: repeated metalstack.api.v2.ImageUsage image_usage = 1; */ diff --git a/js/metalstack/admin/v2/ip_pb.d.ts b/js/metalstack/admin/v2/ip_pb.d.ts index a12c13a9..8f007b6a 100644 --- a/js/metalstack/admin/v2/ip_pb.d.ts +++ b/js/metalstack/admin/v2/ip_pb.d.ts @@ -12,7 +12,7 @@ export declare const file_metalstack_admin_v2_ip: GenFile; */ export type IPServiceListRequest = Message<"metalstack.admin.v2.IPServiceListRequest"> & { /** - * Query to search for IP addresses + * Query to search for IP addresses. * * @generated from field: metalstack.api.v2.IPQuery query = 1; */ @@ -30,7 +30,7 @@ export declare const IPServiceListRequestSchema: GenMessage & { /** - * IPs contains the list of IP addresses + * IPs contains the list of IP addresses. * * @generated from field: repeated metalstack.api.v2.IP ips = 1; */ diff --git a/js/metalstack/admin/v2/ip_pb.ts b/js/metalstack/admin/v2/ip_pb.ts index 79c4e2b4..c930ef3e 100644 --- a/js/metalstack/admin/v2/ip_pb.ts +++ b/js/metalstack/admin/v2/ip_pb.ts @@ -22,7 +22,7 @@ export const file_metalstack_admin_v2_ip: GenFile = /*@__PURE__*/ */ export type IPServiceListRequest = Message<"metalstack.admin.v2.IPServiceListRequest"> & { /** - * Query to search for IP addresses + * Query to search for IP addresses. * * @generated from field: metalstack.api.v2.IPQuery query = 1; */ @@ -43,7 +43,7 @@ export const IPServiceListRequestSchema: GenMessage = /*@_ */ export type IPServiceListResponse = Message<"metalstack.admin.v2.IPServiceListResponse"> & { /** - * IPs contains the list of IP addresses + * IPs contains the list of IP addresses. * * @generated from field: repeated metalstack.api.v2.IP ips = 1; */ diff --git a/js/metalstack/admin/v2/machine_pb.d.ts b/js/metalstack/admin/v2/machine_pb.d.ts index 678ac1be..44b3990f 100644 --- a/js/metalstack/admin/v2/machine_pb.d.ts +++ b/js/metalstack/admin/v2/machine_pb.d.ts @@ -6,7 +6,7 @@ import type { Message } from "@bufbuild/protobuf"; */ export declare const file_metalstack_admin_v2_machine: GenFile; /** - * MachineServiceGetRequest is the request payload for a machine get request + * MachineServiceGetRequest is the request payload for a machine get request. * * @generated from message metalstack.admin.v2.MachineServiceGetRequest */ @@ -24,13 +24,13 @@ export type MachineServiceGetRequest = Message<"metalstack.admin.v2.MachineServi */ export declare const MachineServiceGetRequestSchema: GenMessage; /** - * MachineServiceGetResponse is the response payload for a machine get request + * MachineServiceGetResponse is the response payload for a machine get request. * * @generated from message metalstack.admin.v2.MachineServiceGetResponse */ export type MachineServiceGetResponse = Message<"metalstack.admin.v2.MachineServiceGetResponse"> & { /** - * Machine is the machine requested + * Machine is the machine requested. * * @generated from field: metalstack.api.v2.Machine machine = 1; */ @@ -42,13 +42,13 @@ export type MachineServiceGetResponse = Message<"metalstack.admin.v2.MachineServ */ export declare const MachineServiceGetResponseSchema: GenMessage; /** - * MachineServiceListRequest is the request payload for a machine list request + * MachineServiceListRequest is the request payload for a machine list request. * * @generated from message metalstack.admin.v2.MachineServiceListRequest */ export type MachineServiceListRequest = Message<"metalstack.admin.v2.MachineServiceListRequest"> & { /** - * Query to list one or more machines + * Query to list one or more machines. * * @generated from field: metalstack.api.v2.MachineQuery query = 1; */ @@ -67,13 +67,13 @@ export type MachineServiceListRequest = Message<"metalstack.admin.v2.MachineServ */ export declare const MachineServiceListRequestSchema: GenMessage; /** - * MachineServiceListResponse is the response payload for a machine list request + * MachineServiceListResponse is the response payload for a machine list request. * * @generated from message metalstack.admin.v2.MachineServiceListResponse */ export type MachineServiceListResponse = Message<"metalstack.admin.v2.MachineServiceListResponse"> & { /** - * Machines are the machines requested by a list request + * Machines are the machines requested by a list request. * * @generated from field: repeated metalstack.api.v2.Machine machines = 1; */ @@ -85,7 +85,7 @@ export type MachineServiceListResponse = Message<"metalstack.admin.v2.MachineSer */ export declare const MachineServiceListResponseSchema: GenMessage; /** - * MachineServiceDeleteRequest is the request payload for a machine delete request + * MachineServiceDeleteRequest is the request payload for a machine delete request. * * @generated from message metalstack.admin.v2.MachineServiceDeleteRequest */ @@ -103,13 +103,13 @@ export type MachineServiceDeleteRequest = Message<"metalstack.admin.v2.MachineSe */ export declare const MachineServiceDeleteRequestSchema: GenMessage; /** - * MachineServiceDeleteResponse is the response payload for a machine delete request + * MachineServiceDeleteResponse is the response payload for a machine delete request. * * @generated from message metalstack.admin.v2.MachineServiceDeleteResponse */ export type MachineServiceDeleteResponse = Message<"metalstack.admin.v2.MachineServiceDeleteResponse"> & { /** - * Machine is the machine permanently deleted + * Machine is the machine permanently deleted. * * @generated from field: metalstack.api.v2.Machine machine = 1; */ @@ -121,7 +121,7 @@ export type MachineServiceDeleteResponse = Message<"metalstack.admin.v2.MachineS */ export declare const MachineServiceDeleteResponseSchema: GenMessage; /** - * MachineServiceBMCCommandRequest is the request payload for a machine bmc command + * MachineServiceBMCCommandRequest is the request payload for a machine bmc command. * * @generated from message metalstack.admin.v2.MachineServiceBMCCommandRequest */ @@ -145,7 +145,7 @@ export type MachineServiceBMCCommandRequest = Message<"metalstack.admin.v2.Machi */ export declare const MachineServiceBMCCommandRequestSchema: GenMessage; /** - * MachineServiceBMCCommandResponse is the response payload for a machine bmc command + * MachineServiceBMCCommandResponse is the response payload for a machine bmc command. * * @generated from message metalstack.admin.v2.MachineServiceBMCCommandResponse */ @@ -156,7 +156,7 @@ export type MachineServiceBMCCommandResponse = Message<"metalstack.admin.v2.Mach */ export declare const MachineServiceBMCCommandResponseSchema: GenMessage; /** - * MachineServiceGetBMCRequest is the request payload for a machine getbmc request + * MachineServiceGetBMCRequest is the request payload for a machine getbmc request. * * @generated from message metalstack.admin.v2.MachineServiceGetBMCRequest */ @@ -174,7 +174,7 @@ export type MachineServiceGetBMCRequest = Message<"metalstack.admin.v2.MachineSe */ export declare const MachineServiceGetBMCRequestSchema: GenMessage; /** - * MachineServiceGetBMCResponse is the response payload for a machine getbmc request + * MachineServiceGetBMCResponse is the response payload for a machine getbmc request. * * @generated from message metalstack.admin.v2.MachineServiceGetBMCResponse */ @@ -186,7 +186,7 @@ export type MachineServiceGetBMCResponse = Message<"metalstack.admin.v2.MachineS */ uuid: string; /** - * BMC contains the BMC details of this machine + * BMC contains the BMC details of this machine. * * @generated from field: metalstack.api.v2.MachineBMCReport bmc = 2; */ @@ -198,13 +198,13 @@ export type MachineServiceGetBMCResponse = Message<"metalstack.admin.v2.MachineS */ export declare const MachineServiceGetBMCResponseSchema: GenMessage; /** - * MachineServiceListBMCRequest is the request payload for a machine listbmc request + * MachineServiceListBMCRequest is the request payload for a machine listbmc request. * * @generated from message metalstack.admin.v2.MachineServiceListBMCRequest */ export type MachineServiceListBMCRequest = Message<"metalstack.admin.v2.MachineServiceListBMCRequest"> & { /** - * Query to list one or more BMCs of many machines + * Query to list one or more BMCs of many machines. * * @generated from field: metalstack.api.v2.MachineBMCQuery query = 1; */ @@ -216,13 +216,13 @@ export type MachineServiceListBMCRequest = Message<"metalstack.admin.v2.MachineS */ export declare const MachineServiceListBMCRequestSchema: GenMessage; /** - * MachineServiceListBMCResponse is the response payload for a machine listbmc request + * MachineServiceListBMCResponse is the response payload for a machine listbmc request. * * @generated from message metalstack.admin.v2.MachineServiceListBMCResponse */ export type MachineServiceListBMCResponse = Message<"metalstack.admin.v2.MachineServiceListBMCResponse"> & { /** - * BMCReports maps the bmc report per machine uuid + * BMCReports maps the bmc report per machine uuid. * * @generated from field: map bmc_reports = 1; */ @@ -248,8 +248,8 @@ export type MachineServiceConsolePasswordRequest = Message<"metalstack.admin.v2. */ uuid: string; /** - * Reason must be provided why access to the console is requested - * Reason is only forwarded to an audit sink + * Reason must be provided why access to the console is requested. + * Reason is only forwarded to an audit sink. * * @generated from field: string reason = 2; */ @@ -285,7 +285,7 @@ export type MachineServiceConsolePasswordResponse = Message<"metalstack.admin.v2 */ export declare const MachineServiceConsolePasswordResponseSchema: GenMessage; /** - * MachineServiceSetStateRequest is the request payload for a machine set state request + * MachineServiceSetStateRequest is the request payload for a machine set state request. * * @generated from message metalstack.admin.v2.MachineServiceSetStateRequest */ @@ -316,7 +316,7 @@ export type MachineServiceSetStateRequest = Message<"metalstack.admin.v2.Machine */ export declare const MachineServiceSetStateRequestSchema: GenMessage; /** - * MachineServiceSetStateResponse is the response payload for a machine set state request + * MachineServiceSetStateResponse is the response payload for a machine set state request. * * @generated from message metalstack.admin.v2.MachineServiceSetStateResponse */ @@ -334,13 +334,13 @@ export type MachineServiceSetStateResponse = Message<"metalstack.admin.v2.Machin */ export declare const MachineServiceSetStateResponseSchema: GenMessage; /** - * MachineServiceIssuesRequest is the request payload for a machine issues request + * MachineServiceIssuesRequest is the request payload for a machine issues request. * * @generated from message metalstack.admin.v2.MachineServiceIssuesRequest */ export type MachineServiceIssuesRequest = Message<"metalstack.admin.v2.MachineServiceIssuesRequest"> & { /** - * Query which machine issues to include + * Query which machine issues to include. * * @generated from field: metalstack.api.v2.MachineIssuesQuery query = 1; */ @@ -352,13 +352,13 @@ export type MachineServiceIssuesRequest = Message<"metalstack.admin.v2.MachineSe */ export declare const MachineServiceIssuesRequestSchema: GenMessage; /** - * MachineServiceIssuesResponse is the response payload for a machine issues request + * MachineServiceIssuesResponse is the response payload for a machine issues request. * * @generated from message metalstack.admin.v2.MachineServiceIssuesResponse */ export type MachineServiceIssuesResponse = Message<"metalstack.admin.v2.MachineServiceIssuesResponse"> & { /** - * Issues is the result of the issues query + * Issues is the result of the issues query. * * @generated from field: repeated metalstack.api.v2.MachineIssues issues = 1; */ @@ -456,7 +456,7 @@ export declare const MachineService: GenService<{ output: typeof MachineServiceSetStateResponseSchema; }; /** - * Issues allows to query issues of machines + * Issues allows to query issues of machines. * * @generated from rpc metalstack.admin.v2.MachineService.Issues */ diff --git a/js/metalstack/admin/v2/machine_pb.ts b/js/metalstack/admin/v2/machine_pb.ts index 2210e097..ac23e1bf 100644 --- a/js/metalstack/admin/v2/machine_pb.ts +++ b/js/metalstack/admin/v2/machine_pb.ts @@ -18,7 +18,7 @@ export const file_metalstack_admin_v2_machine: GenFile = /*@__PURE__*/ fileDesc("CiFtZXRhbHN0YWNrL2FkbWluL3YyL21hY2hpbmUucHJvdG8SE21ldGFsc3RhY2suYWRtaW4udjIiMgoYTWFjaGluZVNlcnZpY2VHZXRSZXF1ZXN0EhYKBHV1aWQYASABKAlCCLpIBXIDsAEBIkgKGU1hY2hpbmVTZXJ2aWNlR2V0UmVzcG9uc2USKwoHbWFjaGluZRgBIAEoCzIaLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmUifgoZTWFjaGluZVNlcnZpY2VMaXN0UmVxdWVzdBIuCgVxdWVyeRgBIAEoCzIfLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVRdWVyeRIjCglwYXJ0aXRpb24YAiABKAlCC7pICHIG0LOusQIBSACIAQFCDAoKX3BhcnRpdGlvbiJKChpNYWNoaW5lU2VydmljZUxpc3RSZXNwb25zZRIsCghtYWNoaW5lcxgBIAMoCzIaLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmUiNQobTWFjaGluZVNlcnZpY2VEZWxldGVSZXF1ZXN0EhYKBHV1aWQYASABKAlCCLpIBXIDsAEBIksKHE1hY2hpbmVTZXJ2aWNlRGVsZXRlUmVzcG9uc2USKwoHbWFjaGluZRgBIAEoCzIaLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmUiegofTWFjaGluZVNlcnZpY2VCTUNDb21tYW5kUmVxdWVzdBIWCgR1dWlkGAEgASgJQgi6SAVyA7ABARI/Cgdjb21tYW5kGAIgASgOMiQubWV0YWxzdGFjay5hcGkudjIuTWFjaGluZUJNQ0NvbW1hbmRCCLpIBYIBAhABIiIKIE1hY2hpbmVTZXJ2aWNlQk1DQ29tbWFuZFJlc3BvbnNlIjUKG01hY2hpbmVTZXJ2aWNlR2V0Qk1DUmVxdWVzdBIWCgR1dWlkGAEgASgJQgi6SAVyA7ABASJoChxNYWNoaW5lU2VydmljZUdldEJNQ1Jlc3BvbnNlEhYKBHV1aWQYASABKAlCCLpIBXIDsAEBEjAKA2JtYxgCIAEoCzIjLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVCTUNSZXBvcnQiUQocTWFjaGluZVNlcnZpY2VMaXN0Qk1DUmVxdWVzdBIxCgVxdWVyeRgBIAEoCzIiLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVCTUNRdWVyeSLfAQodTWFjaGluZVNlcnZpY2VMaXN0Qk1DUmVzcG9uc2USZgoLYm1jX3JlcG9ydHMYASADKAsyQi5tZXRhbHN0YWNrLmFkbWluLnYyLk1hY2hpbmVTZXJ2aWNlTGlzdEJNQ1Jlc3BvbnNlLkJtY1JlcG9ydHNFbnRyeUINukgKmgEHIgVyA7ABARpWCg9CbWNSZXBvcnRzRW50cnkSCwoDa2V5GAEgASgJEjIKBXZhbHVlGAIgASgLMiMubWV0YWxzdGFjay5hcGkudjIuTWFjaGluZUJNQ1JlcG9ydDoCOAEiWgokTWFjaGluZVNlcnZpY2VDb25zb2xlUGFzc3dvcmRSZXF1ZXN0EhYKBHV1aWQYASABKAlCCLpIBXIDsAEBEhoKBnJlYXNvbhgCIAEoCUIKukgHcgUQChiABCJRCiVNYWNoaW5lU2VydmljZUNvbnNvbGVQYXNzd29yZFJlc3BvbnNlEhYKBHV1aWQYASABKAlCCLpIBXIDsAEBEhAKCHBhc3N3b3JkGAIgASgJIpMBCh1NYWNoaW5lU2VydmljZVNldFN0YXRlUmVxdWVzdBIWCgR1dWlkGAEgASgJQgi6SAVyA7ABARI4CgVzdGF0ZRgCIAEoDjIfLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVTdGF0ZUIIukgFggECEAESIAoLZGVzY3JpcHRpb24YAyABKAlCC7pICHIGyLOusQIBIk0KHk1hY2hpbmVTZXJ2aWNlU2V0U3RhdGVSZXNwb25zZRIrCgdtYWNoaW5lGAEgASgLMhoubWV0YWxzdGFjay5hcGkudjIuTWFjaGluZSJTChtNYWNoaW5lU2VydmljZUlzc3Vlc1JlcXVlc3QSNAoFcXVlcnkYASABKAsyJS5tZXRhbHN0YWNrLmFwaS52Mi5NYWNoaW5lSXNzdWVzUXVlcnkiUAocTWFjaGluZVNlcnZpY2VJc3N1ZXNSZXNwb25zZRIwCgZpc3N1ZXMYASADKAsyIC5tZXRhbHN0YWNrLmFwaS52Mi5NYWNoaW5lSXNzdWVzMoMJCg5NYWNoaW5lU2VydmljZRJwCgNHZXQSLS5tZXRhbHN0YWNrLmFkbWluLnYyLk1hY2hpbmVTZXJ2aWNlR2V0UmVxdWVzdBouLm1ldGFsc3RhY2suYWRtaW4udjIuTWFjaGluZVNlcnZpY2VHZXRSZXNwb25zZSIK0vMYAgEC4PMYAhJzCgRMaXN0Ei4ubWV0YWxzdGFjay5hZG1pbi52Mi5NYWNoaW5lU2VydmljZUxpc3RSZXF1ZXN0Gi8ubWV0YWxzdGFjay5hZG1pbi52Mi5NYWNoaW5lU2VydmljZUxpc3RSZXNwb25zZSIK0vMYAgEC4PMYAhJ4CgZEZWxldGUSMC5tZXRhbHN0YWNrLmFkbWluLnYyLk1hY2hpbmVTZXJ2aWNlRGVsZXRlUmVxdWVzdBoxLm1ldGFsc3RhY2suYWRtaW4udjIuTWFjaGluZVNlcnZpY2VEZWxldGVSZXNwb25zZSIJ0vMYAQHg8xgBEoQBCgpCTUNDb21tYW5kEjQubWV0YWxzdGFjay5hZG1pbi52Mi5NYWNoaW5lU2VydmljZUJNQ0NvbW1hbmRSZXF1ZXN0GjUubWV0YWxzdGFjay5hZG1pbi52Mi5NYWNoaW5lU2VydmljZUJNQ0NvbW1hbmRSZXNwb25zZSIJ0vMYAQHg8xgBEnkKBkdldEJNQxIwLm1ldGFsc3RhY2suYWRtaW4udjIuTWFjaGluZVNlcnZpY2VHZXRCTUNSZXF1ZXN0GjEubWV0YWxzdGFjay5hZG1pbi52Mi5NYWNoaW5lU2VydmljZUdldEJNQ1Jlc3BvbnNlIgrS8xgCAQLg8xgBEnwKB0xpc3RCTUMSMS5tZXRhbHN0YWNrLmFkbWluLnYyLk1hY2hpbmVTZXJ2aWNlTGlzdEJNQ1JlcXVlc3QaMi5tZXRhbHN0YWNrLmFkbWluLnYyLk1hY2hpbmVTZXJ2aWNlTGlzdEJNQ1Jlc3BvbnNlIgrS8xgCAQLg8xgBEpQBCg9Db25zb2xlUGFzc3dvcmQSOS5tZXRhbHN0YWNrLmFkbWluLnYyLk1hY2hpbmVTZXJ2aWNlQ29uc29sZVBhc3N3b3JkUmVxdWVzdBo6Lm1ldGFsc3RhY2suYWRtaW4udjIuTWFjaGluZVNlcnZpY2VDb25zb2xlUGFzc3dvcmRSZXNwb25zZSIK0vMYAgEC4PMYARJ+CghTZXRTdGF0ZRIyLm1ldGFsc3RhY2suYWRtaW4udjIuTWFjaGluZVNlcnZpY2VTZXRTdGF0ZVJlcXVlc3QaMy5tZXRhbHN0YWNrLmFkbWluLnYyLk1hY2hpbmVTZXJ2aWNlU2V0U3RhdGVSZXNwb25zZSIJ0vMYAQHg8xgBEnkKBklzc3VlcxIwLm1ldGFsc3RhY2suYWRtaW4udjIuTWFjaGluZVNlcnZpY2VJc3N1ZXNSZXF1ZXN0GjEubWV0YWxzdGFjay5hZG1pbi52Mi5NYWNoaW5lU2VydmljZUlzc3Vlc1Jlc3BvbnNlIgrS8xgCAQLg8xgCQtABChdjb20ubWV0YWxzdGFjay5hZG1pbi52MkIMTWFjaGluZVByb3RvUAFaOWdpdGh1Yi5jb20vbWV0YWwtc3RhY2svYXBpL2dvL21ldGFsc3RhY2svYWRtaW4vdjI7YWRtaW52MqICA01BWKoCE01ldGFsc3RhY2suQWRtaW4uVjLKAhNNZXRhbHN0YWNrXEFkbWluXFYy4gIfTWV0YWxzdGFja1xBZG1pblxWMlxHUEJNZXRhZGF0YeoCFU1ldGFsc3RhY2s6OkFkbWluOjpWMmIGcHJvdG8z", [file_buf_validate_validate, file_metalstack_api_v2_common, file_metalstack_api_v2_machine, file_metalstack_api_v2_predefined_rules]); /** - * MachineServiceGetRequest is the request payload for a machine get request + * MachineServiceGetRequest is the request payload for a machine get request. * * @generated from message metalstack.admin.v2.MachineServiceGetRequest */ @@ -39,13 +39,13 @@ export const MachineServiceGetRequestSchema: GenMessage & { /** - * Machine is the machine requested + * Machine is the machine requested. * * @generated from field: metalstack.api.v2.Machine machine = 1; */ @@ -60,13 +60,13 @@ export const MachineServiceGetResponseSchema: GenMessage & { /** - * Query to list one or more machines + * Query to list one or more machines. * * @generated from field: metalstack.api.v2.MachineQuery query = 1; */ @@ -89,13 +89,13 @@ export const MachineServiceListRequestSchema: GenMessage & { /** - * Machines are the machines requested by a list request + * Machines are the machines requested by a list request. * * @generated from field: repeated metalstack.api.v2.Machine machines = 1; */ @@ -110,7 +110,7 @@ export const MachineServiceListResponseSchema: GenMessage & { /** - * Machine is the machine permanently deleted + * Machine is the machine permanently deleted. * * @generated from field: metalstack.api.v2.Machine machine = 1; */ @@ -152,7 +152,7 @@ export const MachineServiceDeleteResponseSchema: GenMessage & { /** - * Query to list one or more BMCs of many machines + * Query to list one or more BMCs of many machines. * * @generated from field: metalstack.api.v2.MachineBMCQuery query = 1; */ @@ -265,13 +265,13 @@ export const MachineServiceListBMCRequestSchema: GenMessage & { /** - * BMCReports maps the bmc report per machine uuid + * BMCReports maps the bmc report per machine uuid. * * @generated from field: map bmc_reports = 1; */ @@ -299,8 +299,8 @@ export type MachineServiceConsolePasswordRequest = Message<"metalstack.admin.v2. uuid: string; /** - * Reason must be provided why access to the console is requested - * Reason is only forwarded to an audit sink + * Reason must be provided why access to the console is requested. + * Reason is only forwarded to an audit sink. * * @generated from field: string reason = 2; */ @@ -343,7 +343,7 @@ export const MachineServiceConsolePasswordResponseSchema: GenMessage & { /** - * Query which machine issues to include + * Query which machine issues to include. * * @generated from field: metalstack.api.v2.MachineIssuesQuery query = 1; */ @@ -421,13 +421,13 @@ export const MachineServiceIssuesRequestSchema: GenMessage & { /** - * Issues is the result of the issues query + * Issues is the result of the issues query. * * @generated from field: repeated metalstack.api.v2.MachineIssues issues = 1; */ @@ -528,7 +528,7 @@ export const MachineService: GenService<{ output: typeof MachineServiceSetStateResponseSchema; }, /** - * Issues allows to query issues of machines + * Issues allows to query issues of machines. * * @generated from rpc metalstack.admin.v2.MachineService.Issues */ diff --git a/js/metalstack/admin/v2/network_pb.d.ts b/js/metalstack/admin/v2/network_pb.d.ts index e9ffa986..603d5dad 100644 --- a/js/metalstack/admin/v2/network_pb.d.ts +++ b/js/metalstack/admin/v2/network_pb.d.ts @@ -31,7 +31,7 @@ export declare const NetworkServiceGetRequestSchema: GenMessage & { /** - * Network contains the requested network + * Network contains the requested network. * * @generated from field: metalstack.api.v2.Network network = 1; */ @@ -67,13 +67,13 @@ export type NetworkServiceCreateRequest = Message<"metalstack.admin.v2.NetworkSe */ description?: string | undefined; /** - * Partition where this network will be created + * Partition where this network will be created. * * @generated from field: optional string partition = 4; */ partition?: string | undefined; /** - * Project where this network belongs to + * Project where this network belongs to. * * @generated from field: optional string project = 5; */ @@ -103,13 +103,13 @@ export type NetworkServiceCreateRequest = Message<"metalstack.admin.v2.NetworkSe */ destinationPrefixes: string[]; /** - * Default Child Prefix length defines the bitlength of a child network created per addressfamily, if not specified during the allocate request + * Default Child Prefix length defines the bitlength of a child network created per addressfamily, if not specified during the allocate request. * * @generated from field: metalstack.api.v2.ChildPrefixLength default_child_prefix_length = 10; */ defaultChildPrefixLength?: ChildPrefixLength | undefined; /** - * Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length + * Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length. * * @generated from field: metalstack.api.v2.ChildPrefixLength min_child_prefix_length = 11; */ @@ -127,13 +127,13 @@ export type NetworkServiceCreateRequest = Message<"metalstack.admin.v2.NetworkSe */ vrf?: number | undefined; /** - * Parent Network points to the id of the parent network if any + * Parent Network points to the id of the parent network if any. * * @generated from field: optional string parent_network = 14; */ parentNetwork?: string | undefined; /** - * AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced + * AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced. * * @generated from field: repeated string additional_announcable_cidrs = 15; */ @@ -169,7 +169,7 @@ export type NetworkServiceUpdateRequest = Message<"metalstack.admin.v2.NetworkSe */ id: string; /** - * 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. * * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 2; */ @@ -205,13 +205,13 @@ export type NetworkServiceUpdateRequest = Message<"metalstack.admin.v2.NetworkSe */ destinationPrefixes: string[]; /** - * Default Child Prefix length defines the bit length of a child network created per addressfamily, if 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. * * @generated from field: optional metalstack.api.v2.ChildPrefixLength default_child_prefix_length = 8; */ defaultChildPrefixLength?: ChildPrefixLength | undefined; /** - * Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length + * Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length. * * @generated from field: optional metalstack.api.v2.ChildPrefixLength min_child_prefix_length = 9; */ @@ -223,7 +223,7 @@ export type NetworkServiceUpdateRequest = Message<"metalstack.admin.v2.NetworkSe */ natType?: NATType | undefined; /** - * AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced + * AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced. * * @generated from field: repeated string additional_announcable_cidrs = 11; */ @@ -265,7 +265,7 @@ export declare const NetworkServiceDeleteRequestSchema: GenMessage & { /** - * Query specifies which networks to return + * Query specifies which networks to return. * * @generated from field: metalstack.api.v2.NetworkQuery query = 1; */ @@ -283,7 +283,7 @@ export declare const NetworkServiceListRequestSchema: GenMessage & { /** - * Network contains the created network + * Network contains the created network. * * @generated from field: metalstack.api.v2.Network network = 1; */ @@ -301,7 +301,7 @@ export declare const NetworkServiceCreateResponseSchema: GenMessage & { /** - * Network contains the updated network + * Network contains the updated network. * * @generated from field: metalstack.api.v2.Network network = 1; */ @@ -319,7 +319,7 @@ export declare const NetworkServiceUpdateResponseSchema: GenMessage & { /** - * Network contains the deleted network + * Network contains the deleted network. * * @generated from field: metalstack.api.v2.Network network = 1; */ @@ -337,7 +337,7 @@ export declare const NetworkServiceDeleteResponseSchema: GenMessage & { /** - * Networks contains the list of networks + * Networks contains the list of networks. * * @generated from field: repeated metalstack.api.v2.Network networks = 1; */ diff --git a/js/metalstack/admin/v2/network_pb.ts b/js/metalstack/admin/v2/network_pb.ts index 048d4bdd..eb3b36ec 100644 --- a/js/metalstack/admin/v2/network_pb.ts +++ b/js/metalstack/admin/v2/network_pb.ts @@ -46,7 +46,7 @@ export const NetworkServiceGetRequestSchema: GenMessage & { /** - * Network contains the requested network + * Network contains the requested network. * * @generated from field: metalstack.api.v2.Network network = 1; */ @@ -88,14 +88,14 @@ export type NetworkServiceCreateRequest = Message<"metalstack.admin.v2.NetworkSe description?: string | undefined; /** - * Partition where this network will be created + * Partition where this network will be created. * * @generated from field: optional string partition = 4; */ partition?: string | undefined; /** - * Project where this network belongs to + * Project where this network belongs to. * * @generated from field: optional string project = 5; */ @@ -130,14 +130,14 @@ export type NetworkServiceCreateRequest = Message<"metalstack.admin.v2.NetworkSe destinationPrefixes: string[]; /** - * Default Child Prefix length defines the bitlength of a child network created per addressfamily, if not specified during the allocate request + * Default Child Prefix length defines the bitlength of a child network created per addressfamily, if not specified during the allocate request. * * @generated from field: metalstack.api.v2.ChildPrefixLength default_child_prefix_length = 10; */ defaultChildPrefixLength?: ChildPrefixLength | undefined; /** - * Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length + * Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length. * * @generated from field: metalstack.api.v2.ChildPrefixLength min_child_prefix_length = 11; */ @@ -158,14 +158,14 @@ export type NetworkServiceCreateRequest = Message<"metalstack.admin.v2.NetworkSe vrf?: number | undefined; /** - * Parent Network points to the id of the parent network if any + * Parent Network points to the id of the parent network if any. * * @generated from field: optional string parent_network = 14; */ parentNetwork?: string | undefined; /** - * AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced + * AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced. * * @generated from field: repeated string additional_announcable_cidrs = 15; */ @@ -207,7 +207,7 @@ export type NetworkServiceUpdateRequest = Message<"metalstack.admin.v2.NetworkSe id: string; /** - * 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. * * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 2; */ @@ -249,14 +249,14 @@ export type NetworkServiceUpdateRequest = Message<"metalstack.admin.v2.NetworkSe destinationPrefixes: string[]; /** - * Default Child Prefix length defines the bit length of a child network created per addressfamily, if 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. * * @generated from field: optional metalstack.api.v2.ChildPrefixLength default_child_prefix_length = 8; */ defaultChildPrefixLength?: ChildPrefixLength | undefined; /** - * Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length + * Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length. * * @generated from field: optional metalstack.api.v2.ChildPrefixLength min_child_prefix_length = 9; */ @@ -270,7 +270,7 @@ export type NetworkServiceUpdateRequest = Message<"metalstack.admin.v2.NetworkSe natType?: NATType | undefined; /** - * AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced + * AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced. * * @generated from field: repeated string additional_announcable_cidrs = 11; */ @@ -319,7 +319,7 @@ export const NetworkServiceDeleteRequestSchema: GenMessage & { /** - * Query specifies which networks to return + * Query specifies which networks to return. * * @generated from field: metalstack.api.v2.NetworkQuery query = 1; */ @@ -340,7 +340,7 @@ export const NetworkServiceListRequestSchema: GenMessage & { /** - * Network contains the created network + * Network contains the created network. * * @generated from field: metalstack.api.v2.Network network = 1; */ @@ -361,7 +361,7 @@ export const NetworkServiceCreateResponseSchema: GenMessage & { /** - * Network contains the updated network + * Network contains the updated network. * * @generated from field: metalstack.api.v2.Network network = 1; */ @@ -382,7 +382,7 @@ export const NetworkServiceUpdateResponseSchema: GenMessage & { /** - * Network contains the deleted network + * Network contains the deleted network. * * @generated from field: metalstack.api.v2.Network network = 1; */ @@ -403,7 +403,7 @@ export const NetworkServiceDeleteResponseSchema: GenMessage & { /** - * Networks contains the list of networks + * Networks contains the list of networks. * * @generated from field: repeated metalstack.api.v2.Network networks = 1; */ diff --git a/js/metalstack/admin/v2/partition_pb.d.ts b/js/metalstack/admin/v2/partition_pb.d.ts index 0836921a..95c2af1b 100644 --- a/js/metalstack/admin/v2/partition_pb.d.ts +++ b/js/metalstack/admin/v2/partition_pb.d.ts @@ -7,7 +7,7 @@ import type { Message } from "@bufbuild/protobuf"; */ export declare const file_metalstack_admin_v2_partition: GenFile; /** - * PartitionServiceCreateRequest is the request payload for a partition create request + * PartitionServiceCreateRequest is the request payload for a partition create request. * * @generated from message metalstack.admin.v2.PartitionServiceCreateRequest */ @@ -37,7 +37,7 @@ export type PartitionServiceUpdateRequest = Message<"metalstack.admin.v2.Partiti */ id: string; /** - * 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. * * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 2; */ @@ -49,7 +49,7 @@ export type PartitionServiceUpdateRequest = Message<"metalstack.admin.v2.Partiti */ description?: string | undefined; /** - * PartitionBootConfiguration defines how metal-hammer boots + * PartitionBootConfiguration defines how metal-hammer boots. * * @generated from field: metalstack.api.v2.PartitionBootConfiguration boot_configuration = 4; */ @@ -67,7 +67,7 @@ export type PartitionServiceUpdateRequest = Message<"metalstack.admin.v2.Partiti */ ntpServers: NTPServer[]; /** - * ManagementServiceAddresses defines where the management is reachable + * ManagementServiceAddresses defines where the management is reachable. * must be in the form : * * @generated from field: repeated string mgmt_service_addresses = 7; @@ -86,7 +86,7 @@ export type PartitionServiceUpdateRequest = Message<"metalstack.admin.v2.Partiti */ export declare const PartitionServiceUpdateRequestSchema: GenMessage; /** - * PartitionServiceDeleteRequest is the request payload for a partition delete request + * PartitionServiceDeleteRequest is the request payload for a partition delete request. * * @generated from message metalstack.admin.v2.PartitionServiceDeleteRequest */ @@ -104,7 +104,7 @@ export type PartitionServiceDeleteRequest = Message<"metalstack.admin.v2.Partiti */ export declare const PartitionServiceDeleteRequestSchema: GenMessage; /** - * PartitionServiceCreateResponse is the response payload for a partition create request + * PartitionServiceCreateResponse is the response payload for a partition create request. * * @generated from message metalstack.admin.v2.PartitionServiceCreateResponse */ @@ -122,7 +122,7 @@ export type PartitionServiceCreateResponse = Message<"metalstack.admin.v2.Partit */ export declare const PartitionServiceCreateResponseSchema: GenMessage; /** - * PartitionServiceUpdateResponse is the response payload for a partition update request + * PartitionServiceUpdateResponse is the response payload for a partition update request. * * @generated from message metalstack.admin.v2.PartitionServiceUpdateResponse */ @@ -146,7 +146,7 @@ export declare const PartitionServiceUpdateResponseSchema: GenMessage & { /** - * Partition contains the deleted partition + * Partition contains the deleted partition. * * @generated from field: metalstack.api.v2.Partition partition = 1; */ @@ -188,13 +188,13 @@ export type PartitionServiceCapacityRequest = Message<"metalstack.admin.v2.Parti */ export declare const PartitionServiceCapacityRequestSchema: GenMessage; /** - * PartitionServiceCapacityResponse is the response payload for a partition capacity request + * PartitionServiceCapacityResponse is the response payload for a partition capacity request. * * @generated from message metalstack.admin.v2.PartitionServiceCapacityResponse */ export type PartitionServiceCapacityResponse = Message<"metalstack.admin.v2.PartitionServiceCapacityResponse"> & { /** - * PartitionCapacity is a capacity report per partition + * PartitionCapacity is a capacity report per partition. * * @generated from field: repeated metalstack.admin.v2.PartitionCapacity partition_capacity = 1; */ @@ -206,7 +206,7 @@ export type PartitionServiceCapacityResponse = Message<"metalstack.admin.v2.Part */ export declare const PartitionServiceCapacityResponseSchema: GenMessage; /** - * PartitionCapacity is the capacity of one partition + * PartitionCapacity is the capacity of one partition. * * @generated from message metalstack.admin.v2.PartitionCapacity */ @@ -230,7 +230,7 @@ export type PartitionCapacity = Message<"metalstack.admin.v2.PartitionCapacity"> */ export declare const PartitionCapacitySchema: GenMessage; /** - * ServerCapacity is the capacity of one server type, eg machine size + * ServerCapacity is the capacity of one server type, eg machine size. * * @generated from message metalstack.admin.v2.MachineSizeCapacity */ diff --git a/js/metalstack/admin/v2/partition_pb.ts b/js/metalstack/admin/v2/partition_pb.ts index 16063f2f..4242f918 100644 --- a/js/metalstack/admin/v2/partition_pb.ts +++ b/js/metalstack/admin/v2/partition_pb.ts @@ -19,7 +19,7 @@ export const file_metalstack_admin_v2_partition: GenFile = /*@__PURE__*/ fileDesc("CiNtZXRhbHN0YWNrL2FkbWluL3YyL3BhcnRpdGlvbi5wcm90bxITbWV0YWxzdGFjay5hZG1pbi52MiJQCh1QYXJ0aXRpb25TZXJ2aWNlQ3JlYXRlUmVxdWVzdBIvCglwYXJ0aXRpb24YASABKAsyHC5tZXRhbHN0YWNrLmFwaS52Mi5QYXJ0aXRpb24i3wMKHVBhcnRpdGlvblNlcnZpY2VVcGRhdGVSZXF1ZXN0EhcKAmlkGAEgASgJQgu6SAhyBtCzrrECARI6Cgt1cGRhdGVfbWV0YRgCIAEoCzIdLm1ldGFsc3RhY2suYXBpLnYyLlVwZGF0ZU1ldGFCBrpIA8gBARIlCgtkZXNjcmlwdGlvbhgDIAEoCUILukgIcgbIs66xAgFIAIgBARJJChJib290X2NvbmZpZ3VyYXRpb24YBCABKAsyLS5tZXRhbHN0YWNrLmFwaS52Mi5QYXJ0aXRpb25Cb290Q29uZmlndXJhdGlvbhI7CgtkbnNfc2VydmVycxgFIAMoCzIcLm1ldGFsc3RhY2suYXBpLnYyLkROU1NlcnZlckIIukgFkgECEAMSOwoLbnRwX3NlcnZlcnMYBiADKAsyHC5tZXRhbHN0YWNrLmFwaS52Mi5OVFBTZXJ2ZXJCCLpIBZIBAhAKEiwKFm1nbXRfc2VydmljZV9hZGRyZXNzZXMYByADKAlCDLpICZIBBsiks7ECARI0CgZsYWJlbHMYCCABKAsyHy5tZXRhbHN0YWNrLmFwaS52Mi5VcGRhdGVMYWJlbHNIAYgBAUIOCgxfZGVzY3JpcHRpb25CCQoHX2xhYmVscyI4Ch1QYXJ0aXRpb25TZXJ2aWNlRGVsZXRlUmVxdWVzdBIXCgJpZBgBIAEoCUILukgIcgbQs66xAgEiUQoeUGFydGl0aW9uU2VydmljZUNyZWF0ZVJlc3BvbnNlEi8KCXBhcnRpdGlvbhgBIAEoCzIcLm1ldGFsc3RhY2suYXBpLnYyLlBhcnRpdGlvbiJRCh5QYXJ0aXRpb25TZXJ2aWNlVXBkYXRlUmVzcG9uc2USLwoJcGFydGl0aW9uGAEgASgLMhwubWV0YWxzdGFjay5hcGkudjIuUGFydGl0aW9uIlEKHlBhcnRpdGlvblNlcnZpY2VEZWxldGVSZXNwb25zZRIvCglwYXJ0aXRpb24YASABKAsyHC5tZXRhbHN0YWNrLmFwaS52Mi5QYXJ0aXRpb24imwEKH1BhcnRpdGlvblNlcnZpY2VDYXBhY2l0eVJlcXVlc3QSHAoCaWQYASABKAlCC7pICHIG0LOusQIBSACIAQESHgoEc2l6ZRgCIAEoCUILukgIcgbAs66xAgFIAYgBARIeCgdwcm9qZWN0GAMgASgJQgi6SAVyA7ABAUgCiAEBQgUKA19pZEIHCgVfc2l6ZUIKCghfcHJvamVjdCJmCiBQYXJ0aXRpb25TZXJ2aWNlQ2FwYWNpdHlSZXNwb25zZRJCChJwYXJ0aXRpb25fY2FwYWNpdHkYASADKAsyJi5tZXRhbHN0YWNrLmFkbWluLnYyLlBhcnRpdGlvbkNhcGFjaXR5In4KEVBhcnRpdGlvbkNhcGFjaXR5Eh4KCXBhcnRpdGlvbhgBIAEoCUILukgIcgbQs66xAgESSQoXbWFjaGluZV9zaXplX2NhcGFjaXRpZXMYAiADKAsyKC5tZXRhbHN0YWNrLmFkbWluLnYyLk1hY2hpbmVTaXplQ2FwYWNpdHki0QIKE01hY2hpbmVTaXplQ2FwYWNpdHkSGQoEc2l6ZRgCIAEoCUILukgIcgbAs66xAgESDQoFdG90YWwYAyABKAMSEwoLcGhvbmVkX2hvbWUYBCABKAMSDwoHd2FpdGluZxgFIAEoAxINCgVvdGhlchgGIAEoAxIWCg5vdGhlcl9tYWNoaW5lcxgHIAMoCRIRCglhbGxvY2F0ZWQYCCABKAMSEwoLYWxsb2NhdGFibGUYCSABKAMSDAoEZnJlZRgKIAEoAxITCgt1bmF2YWlsYWJsZRgLIAEoAxIOCgZmYXVsdHkYDCABKAMSFwoPZmF1bHR5X21hY2hpbmVzGA0gAygJEhQKDHJlc2VydmF0aW9ucxgOIAEoAxIZChF1c2VkX3Jlc2VydmF0aW9ucxgPIAEoAxIeChZyZW1haW5pbmdfcmVzZXJ2YXRpb25zGBAgASgDMpIEChBQYXJ0aXRpb25TZXJ2aWNlEnwKBkNyZWF0ZRIyLm1ldGFsc3RhY2suYWRtaW4udjIuUGFydGl0aW9uU2VydmljZUNyZWF0ZVJlcXVlc3QaMy5tZXRhbHN0YWNrLmFkbWluLnYyLlBhcnRpdGlvblNlcnZpY2VDcmVhdGVSZXNwb25zZSIJ0vMYAQHg8xgBEnwKBlVwZGF0ZRIyLm1ldGFsc3RhY2suYWRtaW4udjIuUGFydGl0aW9uU2VydmljZVVwZGF0ZVJlcXVlc3QaMy5tZXRhbHN0YWNrLmFkbWluLnYyLlBhcnRpdGlvblNlcnZpY2VVcGRhdGVSZXNwb25zZSIJ0vMYAQHg8xgBEnwKBkRlbGV0ZRIyLm1ldGFsc3RhY2suYWRtaW4udjIuUGFydGl0aW9uU2VydmljZURlbGV0ZVJlcXVlc3QaMy5tZXRhbHN0YWNrLmFkbWluLnYyLlBhcnRpdGlvblNlcnZpY2VEZWxldGVSZXNwb25zZSIJ0vMYAQHg8xgBEoMBCghDYXBhY2l0eRI0Lm1ldGFsc3RhY2suYWRtaW4udjIuUGFydGl0aW9uU2VydmljZUNhcGFjaXR5UmVxdWVzdBo1Lm1ldGFsc3RhY2suYWRtaW4udjIuUGFydGl0aW9uU2VydmljZUNhcGFjaXR5UmVzcG9uc2UiCtLzGAICAeDzGAJC0gEKF2NvbS5tZXRhbHN0YWNrLmFkbWluLnYyQg5QYXJ0aXRpb25Qcm90b1ABWjlnaXRodWIuY29tL21ldGFsLXN0YWNrL2FwaS9nby9tZXRhbHN0YWNrL2FkbWluL3YyO2FkbWludjKiAgNNQViqAhNNZXRhbHN0YWNrLkFkbWluLlYyygITTWV0YWxzdGFja1xBZG1pblxWMuICH01ldGFsc3RhY2tcQWRtaW5cVjJcR1BCTWV0YWRhdGHqAhVNZXRhbHN0YWNrOjpBZG1pbjo6VjJiBnByb3RvMw", [file_buf_validate_validate, file_metalstack_api_v2_common, file_metalstack_api_v2_partition, file_metalstack_api_v2_predefined_rules]); /** - * PartitionServiceCreateRequest is the request payload for a partition create request + * PartitionServiceCreateRequest is the request payload for a partition create request. * * @generated from message metalstack.admin.v2.PartitionServiceCreateRequest */ @@ -53,7 +53,7 @@ export type PartitionServiceUpdateRequest = Message<"metalstack.admin.v2.Partiti id: string; /** - * 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. * * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 2; */ @@ -67,7 +67,7 @@ export type PartitionServiceUpdateRequest = Message<"metalstack.admin.v2.Partiti description?: string | undefined; /** - * PartitionBootConfiguration defines how metal-hammer boots + * PartitionBootConfiguration defines how metal-hammer boots. * * @generated from field: metalstack.api.v2.PartitionBootConfiguration boot_configuration = 4; */ @@ -88,7 +88,7 @@ export type PartitionServiceUpdateRequest = Message<"metalstack.admin.v2.Partiti ntpServers: NTPServer[]; /** - * ManagementServiceAddresses defines where the management is reachable + * ManagementServiceAddresses defines where the management is reachable. * must be in the form : * * @generated from field: repeated string mgmt_service_addresses = 7; @@ -111,7 +111,7 @@ export const PartitionServiceUpdateRequestSchema: GenMessage & { /** - * Partition contains the deleted partition + * Partition contains the deleted partition. * * @generated from field: metalstack.api.v2.Partition partition = 1; */ @@ -230,13 +230,13 @@ export const PartitionServiceCapacityRequestSchema: GenMessage & { /** - * PartitionCapacity is a capacity report per partition + * PartitionCapacity is a capacity report per partition. * * @generated from field: repeated metalstack.admin.v2.PartitionCapacity partition_capacity = 1; */ @@ -251,7 +251,7 @@ export const PartitionServiceCapacityResponseSchema: GenMessage = /*@__PURE_ messageDesc(file_metalstack_admin_v2_partition, 8); /** - * ServerCapacity is the capacity of one server type, eg machine size + * ServerCapacity is the capacity of one server type, eg machine size. * * @generated from message metalstack.admin.v2.MachineSizeCapacity */ diff --git a/js/metalstack/admin/v2/project_pb.d.ts b/js/metalstack/admin/v2/project_pb.d.ts index c662ad13..47336ba7 100644 --- a/js/metalstack/admin/v2/project_pb.d.ts +++ b/js/metalstack/admin/v2/project_pb.d.ts @@ -12,7 +12,7 @@ export declare const file_metalstack_admin_v2_project: GenFile; */ export type ProjectServiceListRequest = Message<"metalstack.admin.v2.ProjectServiceListRequest"> & { /** - * Query for projects + * Query for projects. * * @generated from field: optional metalstack.api.v2.ProjectQuery query = 1; */ @@ -30,7 +30,7 @@ export declare const ProjectServiceListRequestSchema: GenMessage & { /** - * Projects contains the list of projects + * Projects contains the list of projects. * * @generated from field: repeated metalstack.api.v2.Project projects = 1; */ diff --git a/js/metalstack/admin/v2/project_pb.ts b/js/metalstack/admin/v2/project_pb.ts index e5f8954b..a486e8d3 100644 --- a/js/metalstack/admin/v2/project_pb.ts +++ b/js/metalstack/admin/v2/project_pb.ts @@ -22,7 +22,7 @@ export const file_metalstack_admin_v2_project: GenFile = /*@__PURE__*/ */ export type ProjectServiceListRequest = Message<"metalstack.admin.v2.ProjectServiceListRequest"> & { /** - * Query for projects + * Query for projects. * * @generated from field: optional metalstack.api.v2.ProjectQuery query = 1; */ @@ -43,7 +43,7 @@ export const ProjectServiceListRequestSchema: GenMessage & { /** - * Projects contains the list of projects + * Projects contains the list of projects. * * @generated from field: repeated metalstack.api.v2.Project projects = 1; */ diff --git a/js/metalstack/admin/v2/size_imageconstraint_pb.d.ts b/js/metalstack/admin/v2/size_imageconstraint_pb.d.ts index 4d1fea09..a15cd637 100644 --- a/js/metalstack/admin/v2/size_imageconstraint_pb.d.ts +++ b/js/metalstack/admin/v2/size_imageconstraint_pb.d.ts @@ -55,7 +55,7 @@ export declare const SizeImageConstraintServiceCreateRequestSchema: GenMessage & { /** - * SizeImageConstraint contains the created constraint + * SizeImageConstraint contains the created constraint. * * @generated from field: metalstack.api.v2.SizeImageConstraint size_image_constraint = 1; */ @@ -79,7 +79,7 @@ export type SizeImageConstraintServiceUpdateRequest = Message<"metalstack.admin. */ size: string; /** - * 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. * * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 2; */ @@ -115,7 +115,7 @@ export declare const SizeImageConstraintServiceUpdateRequestSchema: GenMessage & { /** - * SizeImageConstraint contains the updated constraint + * SizeImageConstraint contains the updated constraint. * * @generated from field: metalstack.api.v2.SizeImageConstraint size_image_constraint = 1; */ @@ -151,7 +151,7 @@ export declare const SizeImageConstraintServiceDeleteRequestSchema: GenMessage & { /** - * SizeImageConstraint contains the deleted constraint + * SizeImageConstraint contains the deleted constraint. * * @generated from field: metalstack.api.v2.SizeImageConstraint size_image_constraint = 1; */ @@ -187,7 +187,7 @@ export declare const SizeImageConstraintServiceGetRequestSchema: GenMessage & { /** - * SizeImageConstraint contains the retrieved constraint + * SizeImageConstraint contains the retrieved constraint. * * @generated from field: metalstack.api.v2.SizeImageConstraint size_image_constraint = 1; */ @@ -205,7 +205,7 @@ export declare const SizeImageConstraintServiceGetResponseSchema: GenMessage & { /** - * Query for size image constraints + * Query for size image constraints. * * @generated from field: metalstack.api.v2.SizeImageConstraintQuery query = 1; */ @@ -223,7 +223,7 @@ export declare const SizeImageConstraintServiceListRequestSchema: GenMessage & { /** - * SizeImageConstraints contains the list of constraints + * SizeImageConstraints contains the list of constraints. * * @generated from field: repeated metalstack.api.v2.SizeImageConstraint size_image_constraints = 1; */ diff --git a/js/metalstack/admin/v2/size_imageconstraint_pb.ts b/js/metalstack/admin/v2/size_imageconstraint_pb.ts index 9dd851f6..5240d17b 100644 --- a/js/metalstack/admin/v2/size_imageconstraint_pb.ts +++ b/js/metalstack/admin/v2/size_imageconstraint_pb.ts @@ -74,7 +74,7 @@ export const SizeImageConstraintServiceCreateRequestSchema: GenMessage & { /** - * SizeImageConstraint contains the created constraint + * SizeImageConstraint contains the created constraint. * * @generated from field: metalstack.api.v2.SizeImageConstraint size_image_constraint = 1; */ @@ -102,7 +102,7 @@ export type SizeImageConstraintServiceUpdateRequest = Message<"metalstack.admin. size: string; /** - * 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. * * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 2; */ @@ -144,7 +144,7 @@ export const SizeImageConstraintServiceUpdateRequestSchema: GenMessage & { /** - * SizeImageConstraint contains the updated constraint + * SizeImageConstraint contains the updated constraint. * * @generated from field: metalstack.api.v2.SizeImageConstraint size_image_constraint = 1; */ @@ -186,7 +186,7 @@ export const SizeImageConstraintServiceDeleteRequestSchema: GenMessage & { /** - * SizeImageConstraint contains the deleted constraint + * SizeImageConstraint contains the deleted constraint. * * @generated from field: metalstack.api.v2.SizeImageConstraint size_image_constraint = 1; */ @@ -228,7 +228,7 @@ export const SizeImageConstraintServiceGetRequestSchema: GenMessage & { /** - * SizeImageConstraint contains the retrieved constraint + * SizeImageConstraint contains the retrieved constraint. * * @generated from field: metalstack.api.v2.SizeImageConstraint size_image_constraint = 1; */ @@ -249,7 +249,7 @@ export const SizeImageConstraintServiceGetResponseSchema: GenMessage & { /** - * Query for size image constraints + * Query for size image constraints. * * @generated from field: metalstack.api.v2.SizeImageConstraintQuery query = 1; */ @@ -270,7 +270,7 @@ export const SizeImageConstraintServiceListRequestSchema: GenMessage & { /** - * SizeImageConstraints contains the list of constraints + * SizeImageConstraints contains the list of constraints. * * @generated from field: repeated metalstack.api.v2.SizeImageConstraint size_image_constraints = 1; */ diff --git a/js/metalstack/admin/v2/size_pb.d.ts b/js/metalstack/admin/v2/size_pb.d.ts index d2f9fc18..bc21fa37 100644 --- a/js/metalstack/admin/v2/size_pb.d.ts +++ b/js/metalstack/admin/v2/size_pb.d.ts @@ -13,7 +13,7 @@ export declare const file_metalstack_admin_v2_size: GenFile; */ export type SizeServiceCreateRequest = Message<"metalstack.admin.v2.SizeServiceCreateRequest"> & { /** - * Size is the size to create + * Size is the size to create. * * @generated from field: metalstack.api.v2.Size size = 1; */ @@ -31,7 +31,7 @@ export declare const SizeServiceCreateRequestSchema: GenMessage & { /** - * Size contains the created size + * Size contains the created size. * * @generated from field: metalstack.api.v2.Size size = 1; */ @@ -55,7 +55,7 @@ export type SizeServiceUpdateRequest = Message<"metalstack.admin.v2.SizeServiceU */ id: string; /** - * 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. * * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 2; */ @@ -97,7 +97,7 @@ export declare const SizeServiceUpdateRequestSchema: GenMessage & { /** - * Size contains the updated size + * Size contains the updated size. * * @generated from field: metalstack.api.v2.Size size = 1; */ @@ -133,7 +133,7 @@ export declare const SizeServiceDeleteRequestSchema: GenMessage & { /** - * Size contains the deleted size + * Size contains the deleted size. * * @generated from field: metalstack.api.v2.Size size = 1; */ diff --git a/js/metalstack/admin/v2/size_pb.ts b/js/metalstack/admin/v2/size_pb.ts index d336f075..1e6590d0 100644 --- a/js/metalstack/admin/v2/size_pb.ts +++ b/js/metalstack/admin/v2/size_pb.ts @@ -25,7 +25,7 @@ export const file_metalstack_admin_v2_size: GenFile = /*@__PURE__*/ */ export type SizeServiceCreateRequest = Message<"metalstack.admin.v2.SizeServiceCreateRequest"> & { /** - * Size is the size to create + * Size is the size to create. * * @generated from field: metalstack.api.v2.Size size = 1; */ @@ -46,7 +46,7 @@ export const SizeServiceCreateRequestSchema: GenMessage & { /** - * Size contains the created size + * Size contains the created size. * * @generated from field: metalstack.api.v2.Size size = 1; */ @@ -74,7 +74,7 @@ export type SizeServiceUpdateRequest = Message<"metalstack.admin.v2.SizeServiceU id: string; /** - * 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. * * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 2; */ @@ -123,7 +123,7 @@ export const SizeServiceUpdateRequestSchema: GenMessage & { /** - * Size contains the updated size + * Size contains the updated size. * * @generated from field: metalstack.api.v2.Size size = 1; */ @@ -165,7 +165,7 @@ export const SizeServiceDeleteRequestSchema: GenMessage & { /** - * Size contains the deleted size + * Size contains the deleted size. * * @generated from field: metalstack.api.v2.Size size = 1; */ diff --git a/js/metalstack/admin/v2/size_reservation_pb.d.ts b/js/metalstack/admin/v2/size_reservation_pb.d.ts index bee37bce..9b505e4b 100644 --- a/js/metalstack/admin/v2/size_reservation_pb.d.ts +++ b/js/metalstack/admin/v2/size_reservation_pb.d.ts @@ -13,7 +13,7 @@ export declare const file_metalstack_admin_v2_size_reservation: GenFile; */ export type SizeReservationServiceCreateRequest = Message<"metalstack.admin.v2.SizeReservationServiceCreateRequest"> & { /** - * SizeReservation is the size reservation to create + * SizeReservation is the size reservation to create. * * @generated from field: metalstack.api.v2.SizeReservation size_reservation = 1; */ @@ -31,7 +31,7 @@ export declare const SizeReservationServiceCreateRequestSchema: GenMessage & { /** - * SizeReservation contains the created reservation + * SizeReservation contains the created reservation. * * @generated from field: metalstack.api.v2.SizeReservation size_reservation = 1; */ @@ -67,7 +67,7 @@ export type SizeReservationServiceUpdateRequest = Message<"metalstack.admin.v2.S */ description?: string | undefined; /** - * 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. * * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 4; */ @@ -103,7 +103,7 @@ export declare const SizeReservationServiceUpdateRequestSchema: GenMessage & { /** - * SizeReservation contains the updated reservation + * SizeReservation contains the updated reservation. * * @generated from field: metalstack.api.v2.SizeReservation size_reservation = 1; */ @@ -139,7 +139,7 @@ export declare const SizeReservationServiceDeleteRequestSchema: GenMessage & { /** - * SizeReservation contains the deleted reservation + * SizeReservation contains the deleted reservation. * * @generated from field: metalstack.api.v2.SizeReservation size_reservation = 1; */ @@ -157,7 +157,7 @@ export declare const SizeReservationServiceDeleteResponseSchema: GenMessage & { /** - * Query for size reservations + * Query for size reservations. * * @generated from field: metalstack.api.v2.SizeReservationQuery query = 1; */ @@ -175,7 +175,7 @@ export declare const SizeReservationServiceListRequestSchema: GenMessage & { /** - * SizeReservations contains the list of reservations + * SizeReservations contains the list of reservations. * * @generated from field: repeated metalstack.api.v2.SizeReservation size_reservations = 1; */ diff --git a/js/metalstack/admin/v2/size_reservation_pb.ts b/js/metalstack/admin/v2/size_reservation_pb.ts index 23f18cd7..6d4d0143 100644 --- a/js/metalstack/admin/v2/size_reservation_pb.ts +++ b/js/metalstack/admin/v2/size_reservation_pb.ts @@ -25,7 +25,7 @@ export const file_metalstack_admin_v2_size_reservation: GenFile = /*@__PURE__*/ */ export type SizeReservationServiceCreateRequest = Message<"metalstack.admin.v2.SizeReservationServiceCreateRequest"> & { /** - * SizeReservation is the size reservation to create + * SizeReservation is the size reservation to create. * * @generated from field: metalstack.api.v2.SizeReservation size_reservation = 1; */ @@ -46,7 +46,7 @@ export const SizeReservationServiceCreateRequestSchema: GenMessage & { /** - * SizeReservation contains the created reservation + * SizeReservation contains the created reservation. * * @generated from field: metalstack.api.v2.SizeReservation size_reservation = 1; */ @@ -88,7 +88,7 @@ export type SizeReservationServiceUpdateRequest = Message<"metalstack.admin.v2.S description?: string | undefined; /** - * 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. * * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 4; */ @@ -130,7 +130,7 @@ export const SizeReservationServiceUpdateRequestSchema: GenMessage & { /** - * SizeReservation contains the updated reservation + * SizeReservation contains the updated reservation. * * @generated from field: metalstack.api.v2.SizeReservation size_reservation = 1; */ @@ -172,7 +172,7 @@ export const SizeReservationServiceDeleteRequestSchema: GenMessage & { /** - * SizeReservation contains the deleted reservation + * SizeReservation contains the deleted reservation. * * @generated from field: metalstack.api.v2.SizeReservation size_reservation = 1; */ @@ -193,7 +193,7 @@ export const SizeReservationServiceDeleteResponseSchema: GenMessage & { /** - * Query for size reservations + * Query for size reservations. * * @generated from field: metalstack.api.v2.SizeReservationQuery query = 1; */ @@ -214,7 +214,7 @@ export const SizeReservationServiceListRequestSchema: GenMessage & { /** - * SizeReservations contains the list of reservations + * SizeReservations contains the list of reservations. * * @generated from field: repeated metalstack.api.v2.SizeReservation size_reservations = 1; */ diff --git a/js/metalstack/admin/v2/switch_pb.d.ts b/js/metalstack/admin/v2/switch_pb.d.ts index 6920526e..fec1f391 100644 --- a/js/metalstack/admin/v2/switch_pb.d.ts +++ b/js/metalstack/admin/v2/switch_pb.d.ts @@ -33,7 +33,7 @@ export declare const SwitchServiceGetRequestSchema: GenMessage & { /** - * Switch contains the requested switch + * Switch contains the requested switch. * * @generated from field: metalstack.api.v2.Switch switch = 1; */ @@ -51,7 +51,7 @@ export declare const SwitchServiceGetResponseSchema: GenMessage & { /** - * Query to filter the results + * Query to filter the results. * * @generated from field: metalstack.api.v2.SwitchQuery query = 1; */ @@ -93,14 +93,14 @@ export type SwitchServiceUpdateRequest = Message<"metalstack.admin.v2.SwitchServ */ id: string; /** - * 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. * * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 2; */ updateMeta?: UpdateMeta | undefined; /** - * 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. * * @generated from field: google.protobuf.Timestamp updated_at = 3; */ @@ -112,37 +112,37 @@ export type SwitchServiceUpdateRequest = Message<"metalstack.admin.v2.SwitchServ */ description?: string | undefined; /** - * ReplaceMode is used to mark a switch ready for replacement + * ReplaceMode is used to mark a switch ready for replacement. * * @generated from field: optional metalstack.api.v2.SwitchReplaceMode replace_mode = 5; */ replaceMode?: SwitchReplaceMode | undefined; /** - * ManagementIp is the switch's IP for management access + * ManagementIp is the switch's IP for management access. * * @generated from field: optional string management_ip = 6; */ managementIp?: string | undefined; /** - * ManagementUser is the user name to use for management access + * ManagementUser is the user name to use for management access. * * @generated from field: optional string management_user = 7; */ managementUser?: string | undefined; /** - * ConsoleCommand is the command for accessing the switch's console + * ConsoleCommand is the command for accessing the switch's console. * * @generated from field: optional string console_command = 8; */ consoleCommand?: string | undefined; /** - * Nics are the front panel ports of the switch + * Nics are the front panel ports of the switch. * * @generated from field: repeated metalstack.api.v2.SwitchNic nics = 9; */ nics: SwitchNic[]; /** - * SwitchOs is the OS running on the switch + * SwitchOs is the OS running on the switch. * * @generated from field: optional metalstack.api.v2.SwitchOS os = 10; */ @@ -160,7 +160,7 @@ export declare const SwitchServiceUpdateRequestSchema: GenMessage & { /** - * Switch contains the updated switch + * Switch contains the updated switch. * * @generated from field: metalstack.api.v2.Switch switch = 1; */ @@ -184,7 +184,7 @@ export type SwitchServiceDeleteRequest = Message<"metalstack.admin.v2.SwitchServ */ id: string; /** - * Force will allow switch deletion despite existing machine connections + * Force will allow switch deletion despite existing machine connections. * * @generated from field: bool force = 2; */ @@ -202,7 +202,7 @@ export declare const SwitchServiceDeleteRequestSchema: GenMessage & { /** - * Switch contains the deleted switch + * Switch contains the deleted switch. * * @generated from field: metalstack.api.v2.Switch switch = 1; */ @@ -220,13 +220,13 @@ export declare const SwitchServiceDeleteResponseSchema: GenMessage & { /** - * OldSwitch is the switch to migrate away from + * OldSwitch is the switch to migrate away from. * * @generated from field: string old_switch = 1; */ oldSwitch: string; /** - * NewSwitch is the switch to migrate to + * NewSwitch is the switch to migrate to. * * @generated from field: string new_switch = 2; */ @@ -244,7 +244,7 @@ export declare const SwitchServiceMigrateRequestSchema: GenMessage & { /** - * Switch contains the switch that was migrated to + * Switch contains the switch that was migrated to. * * @generated from field: metalstack.api.v2.Switch switch = 1; */ @@ -310,7 +310,7 @@ export declare const SwitchServicePortResponseSchema: GenMessage & { /** - * Query to filter the switch results + * Query to filter the switch results. * * @generated from field: metalstack.api.v2.SwitchQuery query = 1; */ @@ -334,7 +334,7 @@ export declare const SwitchServiceConnectedMachinesRequestSchema: GenMessage & { /** - * SwitchesWithMachines contains all switches with their machine connections + * SwitchesWithMachines contains all switches with their machine connections. * * @generated from field: repeated metalstack.api.v2.SwitchWithMachines switches_with_machines = 1; */ diff --git a/js/metalstack/admin/v2/switch_pb.ts b/js/metalstack/admin/v2/switch_pb.ts index 28fdc2d4..021cdf4c 100644 --- a/js/metalstack/admin/v2/switch_pb.ts +++ b/js/metalstack/admin/v2/switch_pb.ts @@ -50,7 +50,7 @@ export const SwitchServiceGetRequestSchema: GenMessage */ export type SwitchServiceGetResponse = Message<"metalstack.admin.v2.SwitchServiceGetResponse"> & { /** - * Switch contains the requested switch + * Switch contains the requested switch. * * @generated from field: metalstack.api.v2.Switch switch = 1; */ @@ -71,7 +71,7 @@ export const SwitchServiceGetResponseSchema: GenMessage & { /** - * Query to filter the results + * Query to filter the results. * * @generated from field: metalstack.api.v2.SwitchQuery query = 1; */ @@ -120,15 +120,15 @@ export type SwitchServiceUpdateRequest = Message<"metalstack.admin.v2.SwitchServ id: string; /** - * 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. * * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 2; */ updateMeta?: UpdateMeta | undefined; /** - * 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. * * @generated from field: google.protobuf.Timestamp updated_at = 3; */ @@ -142,42 +142,42 @@ export type SwitchServiceUpdateRequest = Message<"metalstack.admin.v2.SwitchServ description?: string | undefined; /** - * ReplaceMode is used to mark a switch ready for replacement + * ReplaceMode is used to mark a switch ready for replacement. * * @generated from field: optional metalstack.api.v2.SwitchReplaceMode replace_mode = 5; */ replaceMode?: SwitchReplaceMode | undefined; /** - * ManagementIp is the switch's IP for management access + * ManagementIp is the switch's IP for management access. * * @generated from field: optional string management_ip = 6; */ managementIp?: string | undefined; /** - * ManagementUser is the user name to use for management access + * ManagementUser is the user name to use for management access. * * @generated from field: optional string management_user = 7; */ managementUser?: string | undefined; /** - * ConsoleCommand is the command for accessing the switch's console + * ConsoleCommand is the command for accessing the switch's console. * * @generated from field: optional string console_command = 8; */ consoleCommand?: string | undefined; /** - * Nics are the front panel ports of the switch + * Nics are the front panel ports of the switch. * * @generated from field: repeated metalstack.api.v2.SwitchNic nics = 9; */ nics: SwitchNic[]; /** - * SwitchOs is the OS running on the switch + * SwitchOs is the OS running on the switch. * * @generated from field: optional metalstack.api.v2.SwitchOS os = 10; */ @@ -198,7 +198,7 @@ export const SwitchServiceUpdateRequestSchema: GenMessage & { /** - * Switch contains the updated switch + * Switch contains the updated switch. * * @generated from field: metalstack.api.v2.Switch switch = 1; */ @@ -226,7 +226,7 @@ export type SwitchServiceDeleteRequest = Message<"metalstack.admin.v2.SwitchServ id: string; /** - * Force will allow switch deletion despite existing machine connections + * Force will allow switch deletion despite existing machine connections. * * @generated from field: bool force = 2; */ @@ -247,7 +247,7 @@ export const SwitchServiceDeleteRequestSchema: GenMessage & { /** - * Switch contains the deleted switch + * Switch contains the deleted switch. * * @generated from field: metalstack.api.v2.Switch switch = 1; */ @@ -268,14 +268,14 @@ export const SwitchServiceDeleteResponseSchema: GenMessage & { /** - * OldSwitch is the switch to migrate away from + * OldSwitch is the switch to migrate away from. * * @generated from field: string old_switch = 1; */ oldSwitch: string; /** - * NewSwitch is the switch to migrate to + * NewSwitch is the switch to migrate to. * * @generated from field: string new_switch = 2; */ @@ -296,7 +296,7 @@ export const SwitchServiceMigrateRequestSchema: GenMessage & { /** - * Switch contains the switch that was migrated to + * Switch contains the switch that was migrated to. * * @generated from field: metalstack.api.v2.Switch switch = 1; */ @@ -373,7 +373,7 @@ export const SwitchServicePortResponseSchema: GenMessage & { /** - * Query to filter the switch results + * Query to filter the switch results. * * @generated from field: metalstack.api.v2.SwitchQuery query = 1; */ @@ -401,7 +401,7 @@ export const SwitchServiceConnectedMachinesRequestSchema: GenMessage & { /** - * SwitchesWithMachines contains all switches with their machine connections + * SwitchesWithMachines contains all switches with their machine connections. * * @generated from field: repeated metalstack.api.v2.SwitchWithMachines switches_with_machines = 1; */ diff --git a/js/metalstack/admin/v2/task_pb.d.ts b/js/metalstack/admin/v2/task_pb.d.ts index 8792ceb6..f3807990 100644 --- a/js/metalstack/admin/v2/task_pb.d.ts +++ b/js/metalstack/admin/v2/task_pb.d.ts @@ -12,13 +12,13 @@ export declare const file_metalstack_admin_v2_task: GenFile; */ export type TaskServiceGetRequest = Message<"metalstack.admin.v2.TaskServiceGetRequest"> & { /** - * TaskId is the identifier of the task to get + * TaskId is the identifier of the task to get. * * @generated from field: string task_id = 1; */ taskId: string; /** - * Queue is the queue where this task was scheduled to + * Queue is the queue where this task was scheduled to. * * @generated from field: string queue = 2; */ @@ -36,7 +36,7 @@ export declare const TaskServiceGetRequestSchema: GenMessage & { /** - * Task contains the task details + * Task contains the task details. * * @generated from field: metalstack.admin.v2.TaskInfo task = 1; */ @@ -54,13 +54,13 @@ export declare const TaskServiceGetResponseSchema: GenMessage & { /** - * TaskId is the identifier of the task to cancel + * TaskId is the identifier of the task to cancel. * * @generated from field: string task_id = 1; */ taskId: string; /** - * Queue is the queue where this task was scheduled to + * Queue is the queue where this task was scheduled to. * * @generated from field: string queue = 2; */ @@ -118,20 +118,20 @@ export declare const TaskServiceQueuesResponseSchema: GenMessage & { /** - * Queue filters tasks by this queue - * Will return tasks from all queues if not specified + * Queue filters tasks by this queue. + * Will return tasks from all queues if not specified. * * @generated from field: optional string queue = 1; */ queue?: string | undefined; /** - * Count is the number of tasks to return + * Count is the number of tasks to return. * * @generated from field: optional uint32 count = 2; */ count?: number | undefined; /** - * Page is the page of tasks to return + * Page is the page of tasks to return. * * @generated from field: optional uint32 page = 3; */ @@ -149,7 +149,7 @@ export declare const TaskServiceListRequestSchema: GenMessage & { /** - * Tasks contains the list of requested tasks + * Tasks contains the list of requested tasks. * * @generated from field: repeated metalstack.admin.v2.TaskInfo tasks = 1; */ @@ -167,116 +167,116 @@ export declare const TaskServiceListResponseSchema: GenMessage & { /** - * ID is the identifier of the task + * ID is the identifier of the task. * * @generated from field: string id = 1; */ id: 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. * * @generated from field: string queue = 2; */ queue: string; /** - * Type is the type name of the task + * Type is the type name of the task. * * @generated from field: string type = 3; */ type: string; /** - * Payload is the payload data of the task + * Payload is the payload data of the task. * * @generated from field: bytes payload = 4; */ payload: Uint8Array; /** - * State indicates the task state + * State indicates the task state. * * @generated from field: metalstack.admin.v2.TaskState state = 5; */ state: TaskState; /** - * MaxRetry is the maximum number of times the task can be retried + * MaxRetry is the maximum number of times the task can be retried. * * @generated from field: int32 max_retry = 6; */ maxRetry: number; /** - * Retried is the number of times the task has retried so far + * Retried is the number of times the task has retried so far. * * @generated from field: int32 retried = 7; */ retried: number; /** - * LastError is the error message from the last failure + * LastError is the error message from the last failure. * * @generated from field: string last_error = 8; */ lastError: string; /** - * LastFailedAt is the time of the last failure if any + * LastFailedAt is the time of the last failure if any. * If the task has no failures, LastFailedAt is zero time (i.e. time.Time{}) * * @generated from field: google.protobuf.Timestamp last_failed_at = 9; */ lastFailedAt?: Timestamp | undefined; /** - * 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. * * @generated from field: google.protobuf.Duration timeout = 10; */ timeout?: Duration | undefined; /** - * Deadline is the deadline for the task + * Deadline is the deadline for the task. * * @generated from field: google.protobuf.Timestamp deadline = 11; */ deadline?: Timestamp | undefined; /** - * 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 * - * 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. * * @generated from field: string group = 12; */ group: string; /** - * NextProcessAt is the time the task is scheduled to be processed + * NextProcessAt is the time the task is scheduled to be processed. * Zero if not applicable * * @generated from field: google.protobuf.Timestamp next_process_at = 13; */ nextProcessAt?: Timestamp | undefined; /** - * 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 * - * 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. * * @generated from field: bool is_orphaned = 14; */ isOrphaned: boolean; /** - * 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. * * @generated from field: google.protobuf.Duration retention = 15; */ retention?: Duration | undefined; /** - * 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. * * @generated from field: google.protobuf.Timestamp completed_at = 16; */ completedAt?: Timestamp | undefined; /** - * Result holds the result data associated with the task + * Result holds the result data associated with the task. * Use ResultWriter to write result data from the Handler * * @generated from field: bytes result = 17; @@ -295,49 +295,49 @@ export declare const TaskInfoSchema: GenMessage; */ export declare enum TaskState { /** - * TASK_STATE_UNSPECIFIED is not specified + * TASK_STATE_UNSPECIFIED is not specified. * * @generated from enum value: TASK_STATE_UNSPECIFIED = 0; */ UNSPECIFIED = 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. * * @generated from enum value: TASK_STATE_ACTIVE = 1; */ ACTIVE = 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. * * @generated from enum value: TASK_STATE_PENDING = 2; */ PENDING = 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. * * @generated from enum value: TASK_STATE_SCHEDULED = 3; */ SCHEDULED = 3, /** - * TASK_STATE_RETRY indicates that the task has previously failed and is 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. * * @generated from enum value: TASK_STATE_RETRY = 4; */ RETRY = 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. * * @generated from enum value: TASK_STATE_ARCHIVED = 5; */ ARCHIVED = 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. * * @generated from enum value: TASK_STATE_COMPLETED = 6; */ COMPLETED = 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. * * @generated from enum value: TASK_STATE_AGGREGATING = 7; */ diff --git a/js/metalstack/admin/v2/task_pb.js b/js/metalstack/admin/v2/task_pb.js index d4d3c44f..288d87da 100644 --- a/js/metalstack/admin/v2/task_pb.js +++ b/js/metalstack/admin/v2/task_pb.js @@ -61,49 +61,49 @@ export const TaskInfoSchema = /*@__PURE__*/ messageDesc(file_metalstack_admin_v2 export var TaskState; (function (TaskState) { /** - * TASK_STATE_UNSPECIFIED is not specified + * TASK_STATE_UNSPECIFIED is not specified. * * @generated from enum value: TASK_STATE_UNSPECIFIED = 0; */ TaskState[TaskState["UNSPECIFIED"] = 0] = "UNSPECIFIED"; /** - * 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. * * @generated from enum value: TASK_STATE_ACTIVE = 1; */ TaskState[TaskState["ACTIVE"] = 1] = "ACTIVE"; /** - * 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. * * @generated from enum value: TASK_STATE_PENDING = 2; */ TaskState[TaskState["PENDING"] = 2] = "PENDING"; /** - * 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. * * @generated from enum value: TASK_STATE_SCHEDULED = 3; */ TaskState[TaskState["SCHEDULED"] = 3] = "SCHEDULED"; /** - * TASK_STATE_RETRY indicates that the task has previously failed and is 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. * * @generated from enum value: TASK_STATE_RETRY = 4; */ TaskState[TaskState["RETRY"] = 4] = "RETRY"; /** - * 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. * * @generated from enum value: TASK_STATE_ARCHIVED = 5; */ TaskState[TaskState["ARCHIVED"] = 5] = "ARCHIVED"; /** - * 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. * * @generated from enum value: TASK_STATE_COMPLETED = 6; */ TaskState[TaskState["COMPLETED"] = 6] = "COMPLETED"; /** - * 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. * * @generated from enum value: TASK_STATE_AGGREGATING = 7; */ diff --git a/js/metalstack/admin/v2/task_pb.ts b/js/metalstack/admin/v2/task_pb.ts index bab23ca1..b4db81f3 100644 --- a/js/metalstack/admin/v2/task_pb.ts +++ b/js/metalstack/admin/v2/task_pb.ts @@ -22,14 +22,14 @@ export const file_metalstack_admin_v2_task: GenFile = /*@__PURE__*/ */ export type TaskServiceGetRequest = Message<"metalstack.admin.v2.TaskServiceGetRequest"> & { /** - * TaskId is the identifier of the task to get + * TaskId is the identifier of the task to get. * * @generated from field: string task_id = 1; */ taskId: string; /** - * Queue is the queue where this task was scheduled to + * Queue is the queue where this task was scheduled to. * * @generated from field: string queue = 2; */ @@ -50,7 +50,7 @@ export const TaskServiceGetRequestSchema: GenMessage = /* */ export type TaskServiceGetResponse = Message<"metalstack.admin.v2.TaskServiceGetResponse"> & { /** - * Task contains the task details + * Task contains the task details. * * @generated from field: metalstack.admin.v2.TaskInfo task = 1; */ @@ -71,14 +71,14 @@ export const TaskServiceGetResponseSchema: GenMessage = */ export type TaskServiceDeleteRequest = Message<"metalstack.admin.v2.TaskServiceDeleteRequest"> & { /** - * TaskId is the identifier of the task to cancel + * TaskId is the identifier of the task to cancel. * * @generated from field: string task_id = 1; */ taskId: string; /** - * Queue is the queue where this task was scheduled to + * Queue is the queue where this task was scheduled to. * * @generated from field: string queue = 2; */ @@ -150,22 +150,22 @@ export const TaskServiceQueuesResponseSchema: GenMessage & { /** - * Queue filters tasks by this queue - * Will return tasks from all queues if not specified + * Queue filters tasks by this queue. + * Will return tasks from all queues if not specified. * * @generated from field: optional string queue = 1; */ queue?: string | undefined; /** - * Count is the number of tasks to return + * Count is the number of tasks to return. * * @generated from field: optional uint32 count = 2; */ count?: number | undefined; /** - * Page is the page of tasks to return + * Page is the page of tasks to return. * * @generated from field: optional uint32 page = 3; */ @@ -186,7 +186,7 @@ export const TaskServiceListRequestSchema: GenMessage = */ export type TaskServiceListResponse = Message<"metalstack.admin.v2.TaskServiceListResponse"> & { /** - * Tasks contains the list of requested tasks + * Tasks contains the list of requested tasks. * * @generated from field: repeated metalstack.admin.v2.TaskInfo tasks = 1; */ @@ -207,63 +207,63 @@ export const TaskServiceListResponseSchema: GenMessage */ export type TaskInfo = Message<"metalstack.admin.v2.TaskInfo"> & { /** - * ID is the identifier of the task + * ID is the identifier of the task. * * @generated from field: string id = 1; */ id: 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. * * @generated from field: string queue = 2; */ queue: string; /** - * Type is the type name of the task + * Type is the type name of the task. * * @generated from field: string type = 3; */ type: string; /** - * Payload is the payload data of the task + * Payload is the payload data of the task. * * @generated from field: bytes payload = 4; */ payload: Uint8Array; /** - * State indicates the task state + * State indicates the task state. * * @generated from field: metalstack.admin.v2.TaskState state = 5; */ state: TaskState; /** - * MaxRetry is the maximum number of times the task can be retried + * MaxRetry is the maximum number of times the task can be retried. * * @generated from field: int32 max_retry = 6; */ maxRetry: number; /** - * Retried is the number of times the task has retried so far + * Retried is the number of times the task has retried so far. * * @generated from field: int32 retried = 7; */ retried: number; /** - * LastError is the error message from the last failure + * LastError is the error message from the last failure. * * @generated from field: string last_error = 8; */ lastError: string; /** - * LastFailedAt is the time of the last failure if any + * LastFailedAt is the time of the last failure if any. * If the task has no failures, LastFailedAt is zero time (i.e. time.Time{}) * * @generated from field: google.protobuf.Timestamp last_failed_at = 9; @@ -271,33 +271,33 @@ export type TaskInfo = Message<"metalstack.admin.v2.TaskInfo"> & { lastFailedAt?: Timestamp | undefined; /** - * 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. * * @generated from field: google.protobuf.Duration timeout = 10; */ timeout?: Duration | undefined; /** - * Deadline is the deadline for the task + * Deadline is the deadline for the task. * * @generated from field: google.protobuf.Timestamp deadline = 11; */ deadline?: Timestamp | undefined; /** - * 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 * - * 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. * * @generated from field: string group = 12; */ group: string; /** - * NextProcessAt is the time the task is scheduled to be processed + * NextProcessAt is the time the task is scheduled to be processed. * Zero if not applicable * * @generated from field: google.protobuf.Timestamp next_process_at = 13; @@ -305,34 +305,34 @@ export type TaskInfo = Message<"metalstack.admin.v2.TaskInfo"> & { nextProcessAt?: Timestamp | undefined; /** - * 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 * - * 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. * * @generated from field: bool is_orphaned = 14; */ isOrphaned: boolean; /** - * 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. * * @generated from field: google.protobuf.Duration retention = 15; */ retention?: Duration | undefined; /** - * 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. * * @generated from field: google.protobuf.Timestamp completed_at = 16; */ completedAt?: Timestamp | undefined; /** - * Result holds the result data associated with the task + * Result holds the result data associated with the task. * Use ResultWriter to write result data from the Handler * * @generated from field: bytes result = 17; @@ -354,56 +354,56 @@ export const TaskInfoSchema: GenMessage = /*@__PURE__*/ */ export enum TaskState { /** - * TASK_STATE_UNSPECIFIED is not specified + * TASK_STATE_UNSPECIFIED is not specified. * * @generated from enum value: TASK_STATE_UNSPECIFIED = 0; */ UNSPECIFIED = 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. * * @generated from enum value: TASK_STATE_ACTIVE = 1; */ ACTIVE = 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. * * @generated from enum value: TASK_STATE_PENDING = 2; */ PENDING = 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. * * @generated from enum value: TASK_STATE_SCHEDULED = 3; */ SCHEDULED = 3, /** - * TASK_STATE_RETRY indicates that the task has previously failed and is 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. * * @generated from enum value: TASK_STATE_RETRY = 4; */ RETRY = 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. * * @generated from enum value: TASK_STATE_ARCHIVED = 5; */ ARCHIVED = 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. * * @generated from enum value: TASK_STATE_COMPLETED = 6; */ COMPLETED = 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. * * @generated from enum value: TASK_STATE_AGGREGATING = 7; */ diff --git a/js/metalstack/admin/v2/tenant_pb.d.ts b/js/metalstack/admin/v2/tenant_pb.d.ts index da20c2d6..3213929d 100644 --- a/js/metalstack/admin/v2/tenant_pb.d.ts +++ b/js/metalstack/admin/v2/tenant_pb.d.ts @@ -55,7 +55,7 @@ export declare const TenantServiceCreateRequestSchema: GenMessage & { /** - * Tenant contains the created tenant + * Tenant contains the created tenant. * * @generated from field: metalstack.api.v2.Tenant tenant = 1; */ @@ -73,7 +73,7 @@ export declare const TenantServiceCreateResponseSchema: GenMessage & { /** - * Query for tenants + * Query for tenants. * * @generated from field: metalstack.api.v2.TenantQuery query = 1; */ @@ -91,13 +91,13 @@ export declare const TenantServiceListRequestSchema: GenMessage & { /** - * Tenants contains the list of tenants + * Tenants contains the list of tenants. * * @generated from field: repeated metalstack.api.v2.Tenant tenants = 1; */ tenants: Tenant[]; /** - * 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. * * @generated from field: optional uint64 next_page = 2; */ @@ -109,7 +109,7 @@ export type TenantServiceListResponse = Message<"metalstack.admin.v2.TenantServi */ export declare const TenantServiceListResponseSchema: GenMessage; /** - * TenantServiceAddMemberRequest is the request payload for adding a member to a tenant + * TenantServiceAddMemberRequest is the request payload for adding a member to a tenant. * * @generated from message metalstack.admin.v2.TenantServiceAddMemberRequest */ @@ -139,13 +139,13 @@ export type TenantServiceAddMemberRequest = Message<"metalstack.admin.v2.TenantS */ export declare const TenantServiceAddMemberRequestSchema: GenMessage; /** - * TenantServiceAddMemberResponse is the response payload for the add member request + * TenantServiceAddMemberResponse is the response payload for the add member request. * * @generated from message metalstack.admin.v2.TenantServiceAddMemberResponse */ export type TenantServiceAddMemberResponse = Message<"metalstack.admin.v2.TenantServiceAddMemberResponse"> & { /** - * TenantMember is the added tenant member + * TenantMember is the added tenant member. * * @generated from field: metalstack.api.v2.TenantMember tenant_member = 1; */ @@ -157,7 +157,7 @@ export type TenantServiceAddMemberResponse = Message<"metalstack.admin.v2.Tenant */ export declare const TenantServiceAddMemberResponseSchema: GenMessage; /** - * TenantServiceRemoveMemberRequest is the request payload for removing a member from a tenant + * TenantServiceRemoveMemberRequest is the request payload for removing a member from a tenant. * * @generated from message metalstack.admin.v2.TenantServiceRemoveMemberRequest */ @@ -181,13 +181,13 @@ export type TenantServiceRemoveMemberRequest = Message<"metalstack.admin.v2.Tena */ export declare const TenantServiceRemoveMemberRequestSchema: GenMessage; /** - * TenantServiceRemoveMemberResponse is the response payload for the remove member request + * TenantServiceRemoveMemberResponse is the response payload for the remove member request. * * @generated from message metalstack.admin.v2.TenantServiceRemoveMemberResponse */ export type TenantServiceRemoveMemberResponse = Message<"metalstack.admin.v2.TenantServiceRemoveMemberResponse"> & { /** - * TenantMember is the removed tenant member + * TenantMember is the removed tenant member. * * @generated from field: metalstack.api.v2.TenantMember tenant_member = 1; */ @@ -225,7 +225,7 @@ export declare const TenantService: GenService<{ output: typeof TenantServiceListResponseSchema; }; /** - * Add a member to a tenant + * Add a member to a tenant. * * @generated from rpc metalstack.admin.v2.TenantService.AddMember */ @@ -235,7 +235,7 @@ export declare const TenantService: GenService<{ output: typeof TenantServiceAddMemberResponseSchema; }; /** - * RemoveMember removes a member from a tenant + * RemoveMember removes a member from a tenant. * * @generated from rpc metalstack.admin.v2.TenantService.RemoveMember */ diff --git a/js/metalstack/admin/v2/tenant_pb.ts b/js/metalstack/admin/v2/tenant_pb.ts index 518a6f4f..5f0439d3 100644 --- a/js/metalstack/admin/v2/tenant_pb.ts +++ b/js/metalstack/admin/v2/tenant_pb.ts @@ -74,7 +74,7 @@ export const TenantServiceCreateRequestSchema: GenMessage & { /** - * Tenant contains the created tenant + * Tenant contains the created tenant. * * @generated from field: metalstack.api.v2.Tenant tenant = 1; */ @@ -95,7 +95,7 @@ export const TenantServiceCreateResponseSchema: GenMessage & { /** - * Query for tenants + * Query for tenants. * * @generated from field: metalstack.api.v2.TenantQuery query = 1; */ @@ -116,14 +116,14 @@ export const TenantServiceListRequestSchema: GenMessage & { /** - * Tenants contains the list of tenants + * Tenants contains the list of tenants. * * @generated from field: repeated metalstack.api.v2.Tenant tenants = 1; */ tenants: Tenant[]; /** - * 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. * * @generated from field: optional uint64 next_page = 2; */ @@ -138,7 +138,7 @@ export const TenantServiceListResponseSchema: GenMessage & { /** - * TenantMember is the added tenant member + * TenantMember is the added tenant member. * * @generated from field: metalstack.api.v2.TenantMember tenant_member = 1; */ @@ -194,7 +194,7 @@ export const TenantServiceAddMemberResponseSchema: GenMessage & { /** - * TenantMember is the removed tenant member + * TenantMember is the removed tenant member. * * @generated from field: metalstack.api.v2.TenantMember tenant_member = 1; */ @@ -269,7 +269,7 @@ export const TenantService: GenService<{ output: typeof TenantServiceListResponseSchema; }, /** - * Add a member to a tenant + * Add a member to a tenant. * * @generated from rpc metalstack.admin.v2.TenantService.AddMember */ @@ -279,7 +279,7 @@ export const TenantService: GenService<{ output: typeof TenantServiceAddMemberResponseSchema; }, /** - * RemoveMember removes a member from a tenant + * RemoveMember removes a member from a tenant. * * @generated from rpc metalstack.admin.v2.TenantService.RemoveMember */ diff --git a/js/metalstack/admin/v2/token_pb.d.ts b/js/metalstack/admin/v2/token_pb.d.ts index 17280c88..7580e6e4 100644 --- a/js/metalstack/admin/v2/token_pb.d.ts +++ b/js/metalstack/admin/v2/token_pb.d.ts @@ -12,7 +12,7 @@ export declare const file_metalstack_admin_v2_token: GenFile; */ export type TokenServiceListRequest = Message<"metalstack.admin.v2.TokenServiceListRequest"> & { /** - * Query for tokens + * Query for tokens. * * @generated from field: metalstack.api.v2.TokenQuery query = 1; */ @@ -30,7 +30,7 @@ export declare const TokenServiceListRequestSchema: GenMessage & { /** - * Tokens contains the list of tokens + * Tokens contains the list of tokens. * * @generated from field: repeated metalstack.api.v2.Token tokens = 1; */ @@ -48,13 +48,13 @@ export declare const TokenServiceListResponseSchema: GenMessage & { /** - * Uuid is the uuid of the token which should be revoked + * Uuid is the uuid of the token which should be revoked. * * @generated from field: string uuid = 1; */ uuid: string; /** - * User is the id of the user for which the token should be revoked + * User is the id of the user for which the token should be revoked. * * @generated from field: string user = 2; */ @@ -107,13 +107,13 @@ export declare const TokenServiceCreateRequestSchema: GenMessage & { /** - * Token contains the created token + * Token contains the created token. * * @generated from field: metalstack.api.v2.Token token = 1; */ token?: Token | undefined; /** - * 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. * * @generated from field: string secret = 2; */ diff --git a/js/metalstack/admin/v2/token_pb.ts b/js/metalstack/admin/v2/token_pb.ts index 4a211d13..75e96b9f 100644 --- a/js/metalstack/admin/v2/token_pb.ts +++ b/js/metalstack/admin/v2/token_pb.ts @@ -24,7 +24,7 @@ export const file_metalstack_admin_v2_token: GenFile = /*@__PURE__*/ */ export type TokenServiceListRequest = Message<"metalstack.admin.v2.TokenServiceListRequest"> & { /** - * Query for tokens + * Query for tokens. * * @generated from field: metalstack.api.v2.TokenQuery query = 1; */ @@ -45,7 +45,7 @@ export const TokenServiceListRequestSchema: GenMessage */ export type TokenServiceListResponse = Message<"metalstack.admin.v2.TokenServiceListResponse"> & { /** - * Tokens contains the list of tokens + * Tokens contains the list of tokens. * * @generated from field: repeated metalstack.api.v2.Token tokens = 1; */ @@ -66,14 +66,14 @@ export const TokenServiceListResponseSchema: GenMessage & { /** - * Uuid is the uuid of the token which should be revoked + * Uuid is the uuid of the token which should be revoked. * * @generated from field: string uuid = 1; */ uuid: string; /** - * User is the id of the user for which the token should be revoked + * User is the id of the user for which the token should be revoked. * * @generated from field: string user = 2; */ @@ -137,14 +137,14 @@ export const TokenServiceCreateRequestSchema: GenMessage & { /** - * Token contains the created token + * Token contains the created token. * * @generated from field: metalstack.api.v2.Token token = 1; */ token?: Token | undefined; /** - * 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. * * @generated from field: string secret = 2; */ diff --git a/js/metalstack/admin/v2/vpn_pb.d.ts b/js/metalstack/admin/v2/vpn_pb.d.ts index b5f69d43..37b9c812 100644 --- a/js/metalstack/admin/v2/vpn_pb.d.ts +++ b/js/metalstack/admin/v2/vpn_pb.d.ts @@ -19,20 +19,20 @@ export type VPNServiceAuthKeyRequest = Message<"metalstack.admin.v2.VPNServiceAu */ project: string; /** - * Ephemeral defines if the authentication key should be ephemeral + * Ephemeral defines if the authentication key should be ephemeral. * * @generated from field: bool ephemeral = 2; */ ephemeral: boolean; /** - * Expires defines the duration after which the authentication key expires + * Expires defines the duration after which the authentication key expires. * * @generated from field: google.protobuf.Duration expires = 3; */ expires?: Duration | undefined; /** - * Reason must be provided why access to the VPN is requested - * Reason is only forwarded to an audit sink + * Reason must be provided why access to the VPN is requested. + * Reason is only forwarded to an audit sink. * * @generated from field: string reason = 4; */ @@ -50,20 +50,20 @@ export declare const VPNServiceAuthKeyRequestSchema: GenMessage & { /** - * Address is the address of the VPN control plane + * Address is the address of the VPN control plane. * * @generated from field: string address = 1; */ address: 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. * * @generated from field: string auth_key = 2; */ authKey: string; /** - * Ephemeral defines if the authentication key should be ephemeral + * Ephemeral defines if the authentication key should be ephemeral. * * @generated from field: bool ephemeral = 3; */ @@ -93,7 +93,7 @@ export declare const VPNServiceAuthKeyResponseSchema: GenMessage & { /** - * Project filters nodes by this project + * Project filters nodes by this project. * * @generated from field: optional string project = 1; */ diff --git a/js/metalstack/admin/v2/vpn_pb.ts b/js/metalstack/admin/v2/vpn_pb.ts index 01afdf57..ef61e397 100644 --- a/js/metalstack/admin/v2/vpn_pb.ts +++ b/js/metalstack/admin/v2/vpn_pb.ts @@ -32,22 +32,22 @@ export type VPNServiceAuthKeyRequest = Message<"metalstack.admin.v2.VPNServiceAu project: string; /** - * Ephemeral defines if the authentication key should be ephemeral + * Ephemeral defines if the authentication key should be ephemeral. * * @generated from field: bool ephemeral = 2; */ ephemeral: boolean; /** - * Expires defines the duration after which the authentication key expires + * Expires defines the duration after which the authentication key expires. * * @generated from field: google.protobuf.Duration expires = 3; */ expires?: Duration | undefined; /** - * Reason must be provided why access to the VPN is requested - * Reason is only forwarded to an audit sink + * Reason must be provided why access to the VPN is requested. + * Reason is only forwarded to an audit sink. * * @generated from field: string reason = 4; */ @@ -68,22 +68,22 @@ export const VPNServiceAuthKeyRequestSchema: GenMessage & { /** - * Address is the address of the VPN control plane + * Address is the address of the VPN control plane. * * @generated from field: string address = 1; */ address: 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. * * @generated from field: string auth_key = 2; */ authKey: string; /** - * Ephemeral defines if the authentication key should be ephemeral + * Ephemeral defines if the authentication key should be ephemeral. * * @generated from field: bool ephemeral = 3; */ @@ -118,7 +118,7 @@ export const VPNServiceAuthKeyResponseSchema: GenMessage & { /** - * Project filters nodes by this project + * Project filters nodes by this project. * * @generated from field: optional string project = 1; */ diff --git a/js/metalstack/api/v2/audit_pb.d.ts b/js/metalstack/api/v2/audit_pb.d.ts index 4651f5cd..b01a5b68 100644 --- a/js/metalstack/api/v2/audit_pb.d.ts +++ b/js/metalstack/api/v2/audit_pb.d.ts @@ -19,55 +19,55 @@ export type AuditTrace = Message<"metalstack.api.v2.AuditTrace"> & { */ uuid: string; /** - * Timestamp is the timestamp when the request arrived at the API + * Timestamp is the timestamp when the request arrived at the API. * * @generated from field: google.protobuf.Timestamp timestamp = 2; */ timestamp?: Timestamp | undefined; /** - * User is the login user who called the API method + * User is the login user who called the API method. * * @generated from field: string user = 3; */ user: string; /** - * Tenant is the tenant targeted by the API call + * Tenant is the tenant targeted by the API call. * * @generated from field: string tenant = 4; */ tenant: string; /** - * Project is the project targeted by the API call + * Project is the project targeted by the API call. * * @generated from field: optional string project = 5; */ project?: string | undefined; /** - * Method is the API method that was called + * Method is the API method that was called. * * @generated from field: string method = 6; */ method: string; /** - * 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 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. * * @generated from field: optional string body = 7; */ body?: string | undefined; /** - * SourceIP contains the source IP address of the API call + * SourceIP contains the source IP address of the API call. * * @generated from field: string source_ip = 8; */ sourceIp: string; /** - * 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 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. * * @generated from field: optional int32 result_code = 9; */ resultCode?: number | undefined; /** - * Phase represents the phase of the audit trace + * Phase represents the phase of the audit trace. * * @generated from field: metalstack.api.v2.AuditPhase phase = 10; */ @@ -85,7 +85,7 @@ export type AuditTrace = Message<"metalstack.api.v2.AuditTrace"> & { */ export declare const AuditTraceSchema: GenMessage; /** - * AuditQuery is the query for audit traces + * AuditQuery is the query for audit traces. * * @generated from message metalstack.api.v2.AuditQuery */ @@ -97,49 +97,49 @@ export type AuditQuery = Message<"metalstack.api.v2.AuditQuery"> & { */ uuid?: string | undefined; /** - * From describes the start of the time window in which to list audit traces. Defaults to the last eight hours + * From describes the start of the time window in which to list audit traces. Defaults to the last eight hours. * * @generated from field: optional google.protobuf.Timestamp from = 3; */ from?: Timestamp | undefined; /** - * To describes the end of the time window in which to list audit traces. Defaults to the time the request was issued + * To describes the end of the time window in which to list audit traces. Defaults to the time the request was issued. * * @generated from field: optional google.protobuf.Timestamp to = 4; */ to?: Timestamp | undefined; /** - * User is the user who called the api method + * User is the user who called the api method. * * @generated from field: optional string user = 5; */ user?: string | undefined; /** - * Project is the project targeted by the api call + * Project is the project targeted by the api call. * * @generated from field: optional string project = 6; */ project?: string | undefined; /** - * Method is the api method that was called + * Method is the api method that was called. * * @generated from field: optional string method = 7; */ method?: string | undefined; /** - * Source IP contains the ip address of the caller + * Source IP contains the ip address of the caller. * * @generated from field: optional string source_ip = 8; */ sourceIp?: string | undefined; /** - * Result Code is a string describing the result of the api call + * Result Code is a string describing the result of the api call. * * @generated from field: optional int32 result_code = 9; */ resultCode?: number | undefined; /** - * Body is a string providing text-search of the body field + * Body is a string providing text-search of the body field. * * @generated from field: optional string body = 10; */ @@ -151,7 +151,7 @@ export type AuditQuery = Message<"metalstack.api.v2.AuditQuery"> & { */ limit?: number | undefined; /** - * Phase specifies the audit phase + * Phase specifies the audit phase. * * @generated from field: optional metalstack.api.v2.AuditPhase phase = 12; */ @@ -163,7 +163,7 @@ export type AuditQuery = Message<"metalstack.api.v2.AuditQuery"> & { */ export declare const AuditQuerySchema: GenMessage; /** - * AuditServiceListRequest is the request payload for an audit list request + * AuditServiceListRequest is the request payload for an audit list request. * * @generated from message metalstack.api.v2.AuditServiceListRequest */ @@ -175,7 +175,7 @@ export type AuditServiceListRequest = Message<"metalstack.api.v2.AuditServiceLis */ login: string; /** - * Query for audit traces + * Query for audit traces. * * @generated from field: metalstack.api.v2.AuditQuery query = 2; */ @@ -187,13 +187,13 @@ export type AuditServiceListRequest = Message<"metalstack.api.v2.AuditServiceLis */ export declare const AuditServiceListRequestSchema: GenMessage; /** - * AuditServiceListResponse is the response payload of a audit list request + * AuditServiceListResponse is the response payload of a audit list request. * * @generated from message metalstack.api.v2.AuditServiceListResponse */ export type AuditServiceListResponse = Message<"metalstack.api.v2.AuditServiceListResponse"> & { /** - * Traces is a list of audit traces + * Traces is a list of audit traces. * * @generated from field: repeated metalstack.api.v2.AuditTrace traces = 1; */ @@ -205,7 +205,7 @@ export type AuditServiceListResponse = Message<"metalstack.api.v2.AuditServiceLi */ export declare const AuditServiceListResponseSchema: GenMessage; /** - * AuditServiceGetRequest is the request payload of a audit get request + * AuditServiceGetRequest is the request payload of a audit get request. * * @generated from message metalstack.api.v2.AuditServiceGetRequest */ @@ -223,7 +223,7 @@ export type AuditServiceGetRequest = Message<"metalstack.api.v2.AuditServiceGetR */ uuid: string; /** - * Phase specifies the audit phase. Defaults to request + * Phase specifies the audit phase. Defaults to request. * * @generated from field: optional metalstack.api.v2.AuditPhase phase = 3; */ @@ -235,13 +235,13 @@ export type AuditServiceGetRequest = Message<"metalstack.api.v2.AuditServiceGetR */ export declare const AuditServiceGetRequestSchema: GenMessage; /** - * AuditServiceGetResponse is the response payload of a audit get request + * AuditServiceGetResponse is the response payload of a audit get request. * * @generated from message metalstack.api.v2.AuditServiceGetResponse */ export type AuditServiceGetResponse = Message<"metalstack.api.v2.AuditServiceGetResponse"> & { /** - * Trace is the audit trace + * Trace is the audit trace. * * @generated from field: metalstack.api.v2.AuditTrace trace = 1; */ @@ -259,19 +259,19 @@ export declare const AuditServiceGetResponseSchema: GenMessage & { uuid: string; /** - * Timestamp is the timestamp when the request arrived at the API + * Timestamp is the timestamp when the request arrived at the API. * * @generated from field: google.protobuf.Timestamp timestamp = 2; */ timestamp?: Timestamp | undefined; /** - * User is the login user who called the API method + * User is the login user who called the API method. * * @generated from field: string user = 3; */ user: string; /** - * Tenant is the tenant targeted by the API call + * Tenant is the tenant targeted by the API call. * * @generated from field: string tenant = 4; */ tenant: string; /** - * Project is the project targeted by the API call + * Project is the project targeted by the API call. * * @generated from field: optional string project = 5; */ project?: string | undefined; /** - * Method is the API method that was called + * Method is the API method that was called. * * @generated from field: string method = 6; */ method: string; /** - * 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 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. * * @generated from field: optional string body = 7; */ body?: string | undefined; /** - * SourceIP contains the source IP address of the API call + * SourceIP contains the source IP address of the API call. * * @generated from field: string source_ip = 8; */ sourceIp: string; /** - * 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 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. * * @generated from field: optional int32 result_code = 9; */ resultCode?: number | undefined; /** - * Phase represents the phase of the audit trace + * Phase represents the phase of the audit trace. * * @generated from field: metalstack.api.v2.AuditPhase phase = 10; */ @@ -110,7 +110,7 @@ export const AuditTraceSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_audit, 0); /** - * AuditQuery is the query for audit traces + * AuditQuery is the query for audit traces. * * @generated from message metalstack.api.v2.AuditQuery */ @@ -123,56 +123,56 @@ export type AuditQuery = Message<"metalstack.api.v2.AuditQuery"> & { uuid?: string | undefined; /** - * From describes the start of the time window in which to list audit traces. Defaults to the last eight hours + * From describes the start of the time window in which to list audit traces. Defaults to the last eight hours. * * @generated from field: optional google.protobuf.Timestamp from = 3; */ from?: Timestamp | undefined; /** - * To describes the end of the time window in which to list audit traces. Defaults to the time the request was issued + * To describes the end of the time window in which to list audit traces. Defaults to the time the request was issued. * * @generated from field: optional google.protobuf.Timestamp to = 4; */ to?: Timestamp | undefined; /** - * User is the user who called the api method + * User is the user who called the api method. * * @generated from field: optional string user = 5; */ user?: string | undefined; /** - * Project is the project targeted by the api call + * Project is the project targeted by the api call. * * @generated from field: optional string project = 6; */ project?: string | undefined; /** - * Method is the api method that was called + * Method is the api method that was called. * * @generated from field: optional string method = 7; */ method?: string | undefined; /** - * Source IP contains the ip address of the caller + * Source IP contains the ip address of the caller. * * @generated from field: optional string source_ip = 8; */ sourceIp?: string | undefined; /** - * Result Code is a string describing the result of the api call + * Result Code is a string describing the result of the api call. * * @generated from field: optional int32 result_code = 9; */ resultCode?: number | undefined; /** - * Body is a string providing text-search of the body field + * Body is a string providing text-search of the body field. * * @generated from field: optional string body = 10; */ @@ -186,7 +186,7 @@ export type AuditQuery = Message<"metalstack.api.v2.AuditQuery"> & { limit?: number | undefined; /** - * Phase specifies the audit phase + * Phase specifies the audit phase. * * @generated from field: optional metalstack.api.v2.AuditPhase phase = 12; */ @@ -201,7 +201,7 @@ export const AuditQuerySchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_audit, 1); /** - * AuditServiceListRequest is the request payload for an audit list request + * AuditServiceListRequest is the request payload for an audit list request. * * @generated from message metalstack.api.v2.AuditServiceListRequest */ @@ -214,7 +214,7 @@ export type AuditServiceListRequest = Message<"metalstack.api.v2.AuditServiceLis login: string; /** - * Query for audit traces + * Query for audit traces. * * @generated from field: metalstack.api.v2.AuditQuery query = 2; */ @@ -229,13 +229,13 @@ export const AuditServiceListRequestSchema: GenMessage messageDesc(file_metalstack_api_v2_audit, 2); /** - * AuditServiceListResponse is the response payload of a audit list request + * AuditServiceListResponse is the response payload of a audit list request. * * @generated from message metalstack.api.v2.AuditServiceListResponse */ export type AuditServiceListResponse = Message<"metalstack.api.v2.AuditServiceListResponse"> & { /** - * Traces is a list of audit traces + * Traces is a list of audit traces. * * @generated from field: repeated metalstack.api.v2.AuditTrace traces = 1; */ @@ -250,7 +250,7 @@ export const AuditServiceListResponseSchema: GenMessage = messageDesc(file_metalstack_api_v2_audit, 4); /** - * AuditServiceGetResponse is the response payload of a audit get request + * AuditServiceGetResponse is the response payload of a audit get request. * * @generated from message metalstack.api.v2.AuditServiceGetResponse */ export type AuditServiceGetResponse = Message<"metalstack.api.v2.AuditServiceGetResponse"> & { /** - * Trace is the audit trace + * Trace is the audit trace. * * @generated from field: metalstack.api.v2.AuditTrace trace = 1; */ @@ -312,21 +312,21 @@ export const AuditServiceGetResponseSchema: GenMessage */ export enum AuditPhase { /** - * AUDIT_PHASE_UNSPECIFIED is not specified + * AUDIT_PHASE_UNSPECIFIED is not specified. * * @generated from enum value: AUDIT_PHASE_UNSPECIFIED = 0; */ UNSPECIFIED = 0, /** - * AUDIT_PHASE_REQUEST defines an audit trace in the request phase + * AUDIT_PHASE_REQUEST defines an audit trace in the request phase. * * @generated from enum value: AUDIT_PHASE_REQUEST = 1; */ REQUEST = 1, /** - * AUDIT_PHASE_RESPONSE defines an audit trace in the response phase + * AUDIT_PHASE_RESPONSE defines an audit trace in the response phase. * * @generated from enum value: AUDIT_PHASE_RESPONSE = 2; */ diff --git a/js/metalstack/api/v2/common_pb.d.ts b/js/metalstack/api/v2/common_pb.d.ts index b8ba51d5..36426c6d 100644 --- a/js/metalstack/api/v2/common_pb.d.ts +++ b/js/metalstack/api/v2/common_pb.d.ts @@ -6,7 +6,7 @@ import type { Message } from "@bufbuild/protobuf"; */ export declare const file_metalstack_api_v2_common: GenFile; /** - * Paging defines paging for methods with a lot of results + * Paging defines paging for methods with a lot of results. * * @generated from message metalstack.api.v2.Paging */ @@ -19,7 +19,7 @@ export type Paging = Message<"metalstack.api.v2.Paging"> & { */ page?: bigint | undefined; /** - * Count is the number of results returned per page, if not given server side defaults apply + * Count is the number of results returned per page, if not given server side defaults apply. * * @generated from field: optional uint64 count = 2; */ @@ -31,7 +31,7 @@ export type Paging = Message<"metalstack.api.v2.Paging"> & { */ export declare const PagingSchema: GenMessage; /** - * Labels define additional information to a entity + * Labels define additional information to a entity. * * @generated from message metalstack.api.v2.Labels */ @@ -63,13 +63,13 @@ export type Meta = Message<"metalstack.api.v2.Meta"> & { */ labels?: Labels | undefined; /** - * CreatedAt is the date when this entity was created + * CreatedAt is the date when this entity was created. * * @generated from field: google.protobuf.Timestamp created_at = 2; */ createdAt?: Timestamp | undefined; /** - * UpdatedAt is the date when this entity was updated + * UpdatedAt is the date when this entity was updated. * must be part of the update request to ensure optimistic locking * * @generated from field: google.protobuf.Timestamp updated_at = 3; @@ -95,13 +95,13 @@ export type Meta = Message<"metalstack.api.v2.Meta"> & { */ export declare const MetaSchema: GenMessage; /** - * UpdateLabels is a message to update labels + * UpdateLabels is a message to update labels. * * @generated from message metalstack.api.v2.UpdateLabels */ export type UpdateLabels = Message<"metalstack.api.v2.UpdateLabels"> & { /** - * Strategy defines the label update strategy + * Strategy defines the label update strategy. * * @generated from oneof metalstack.api.v2.UpdateLabels.strategy */ @@ -115,7 +115,7 @@ export type UpdateLabels = Message<"metalstack.api.v2.UpdateLabels"> & { case: "replace"; } | { /** - * Patch adds, updates or remove given labels without modifying others + * Patch adds, updates or remove given labels without modifying others. * * @generated from field: metalstack.api.v2.LabelsPatch patch = 2; */ @@ -132,19 +132,19 @@ export type UpdateLabels = Message<"metalstack.api.v2.UpdateLabels"> & { */ export declare const UpdateLabelsSchema: GenMessage; /** - * LabelsPatch adds, updates or remove given labels without modifying others + * LabelsPatch adds, updates or remove given labels without modifying others. * * @generated from message metalstack.api.v2.LabelsPatch */ export type LabelsPatch = Message<"metalstack.api.v2.LabelsPatch"> & { /** - * Update labels. New ones will be added, existing ones overwritten + * Update labels. New ones will be added, existing ones overwritten. * * @generated from field: metalstack.api.v2.Labels update = 1; */ update?: Labels | undefined; /** - * Remove labels by key + * Remove labels by key. * * @generated from field: repeated string remove = 2; */ @@ -156,13 +156,13 @@ export type LabelsPatch = Message<"metalstack.api.v2.LabelsPatch"> & { */ export declare const LabelsPatchSchema: GenMessage; /** - * UpdateMeta must be provided with every UpdateRequest to define how optimistic locking should be handled + * UpdateMeta must be provided with every UpdateRequest to define how optimistic locking should be handled. * * @generated from message metalstack.api.v2.UpdateMeta */ export type UpdateMeta = Message<"metalstack.api.v2.UpdateMeta"> & { /** - * UpdatedAt is the date when this entity was updated + * UpdatedAt is the date when this entity was updated. * must be part of the update request to ensure optimistic locking * * @generated from field: google.protobuf.Timestamp updated_at = 1; @@ -181,13 +181,13 @@ export type UpdateMeta = Message<"metalstack.api.v2.UpdateMeta"> & { */ export declare const UpdateMetaSchema: GenMessage; /** - * TenantRole specifies what role a logged in user needs to call this tenant scoped service + * TenantRole specifies what role a logged in user needs to call this tenant scoped service. * * @generated from enum metalstack.api.v2.TenantRole */ export declare enum TenantRole { /** - * TENANT_ROLE_UNSPECIFIED is not specified + * TENANT_ROLE_UNSPECIFIED is not specified. * * @generated from enum value: TENANT_ROLE_UNSPECIFIED = 0; */ @@ -212,7 +212,7 @@ export declare enum TenantRole { VIEWER = 3, /** * TENANT_ROLE_GUEST the logged in user needs at least guest role to call this method - * The guest role is assumed by users who are invited to a tenant's project without them + * The guest role is assumed by users who are invited to a tenant's project without them. * having a direct membership within the tenant. * * @generated from enum value: TENANT_ROLE_GUEST = 4; @@ -224,13 +224,13 @@ export declare enum TenantRole { */ export declare const TenantRoleSchema: GenEnum; /** - * ProjectRole specifies what role a logged in user needs to call this project scoped service + * ProjectRole specifies what role a logged in user needs to call this project scoped service. * * @generated from enum metalstack.api.v2.ProjectRole */ export declare enum ProjectRole { /** - * PROJECT_ROLE_UNSPECIFIED is not specified + * PROJECT_ROLE_UNSPECIFIED is not specified. * * @generated from enum value: PROJECT_ROLE_UNSPECIFIED = 0; */ @@ -259,13 +259,13 @@ export declare enum ProjectRole { */ export declare const ProjectRoleSchema: GenEnum; /** - * AdminRole specifies what role a logged in user needs to call this admin service + * AdminRole specifies what role a logged in user needs to call this admin service. * * @generated from enum metalstack.api.v2.AdminRole */ export declare enum AdminRole { /** - * ADMIN_ROLE_UNSPECIFIED is not specified + * ADMIN_ROLE_UNSPECIFIED is not specified. * * @generated from enum value: ADMIN_ROLE_UNSPECIFIED = 0; */ @@ -288,13 +288,13 @@ export declare enum AdminRole { */ export declare const AdminRoleSchema: GenEnum; /** - * InfraRole specifies what role a microservice needs to call this infra service + * InfraRole specifies what role a microservice needs to call this infra service. * * @generated from enum metalstack.api.v2.InfraRole */ export declare enum InfraRole { /** - * INFRA_ROLE_UNSPECIFIED is not specified + * INFRA_ROLE_UNSPECIFIED is not specified. * * @generated from enum value: INFRA_ROLE_UNSPECIFIED = 0; */ @@ -317,13 +317,13 @@ export declare enum InfraRole { */ export declare const InfraRoleSchema: GenEnum; /** - * MachineRole specifies what role a microservice needs to call this machine service + * MachineRole specifies what role a microservice needs to call this machine service. * * @generated from enum metalstack.api.v2.MachineRole */ export declare enum MachineRole { /** - * MACHINE_ROLE_UNSPECIFIED is not specified + * MACHINE_ROLE_UNSPECIFIED is not specified. * * @generated from enum value: MACHINE_ROLE_UNSPECIFIED = 0; */ @@ -352,13 +352,13 @@ export declare const MachineRoleSchema: GenEnum; */ export declare enum Visibility { /** - * VISIBILITY_UNSPECIFIED is not defined + * VISIBILITY_UNSPECIFIED is not defined. * * @generated from enum value: VISIBILITY_UNSPECIFIED = 0; */ UNSPECIFIED = 0, /** - * VISIBILITY_PUBLIC specifies that this service is accessible without authentication + * VISIBILITY_PUBLIC specifies that this service is accessible without authentication. * * @generated from enum value: VISIBILITY_PUBLIC = 1; */ @@ -383,7 +383,7 @@ export declare const VisibilitySchema: GenEnum; */ export declare enum Auditing { /** - * AUDITING_UNSPECIFIED is not specified + * AUDITING_UNSPECIFIED is not specified. * * @generated from enum value: AUDITING_UNSPECIFIED = 0; */ @@ -437,43 +437,43 @@ export declare enum OptimisticLockingStrategy { */ export declare const OptimisticLockingStrategySchema: GenEnum; /** - * TenantRoles are used to define the tenant role a logged in user must provide to call this method + * TenantRoles are used to define the tenant role a logged in user must provide to call this method. * * @generated from extension: repeated metalstack.api.v2.TenantRole tenant_roles = 51000; */ export declare const tenant_roles: GenExtension; /** - * ProjectRoles are used to define the project role a logged in user must provide to call this method + * ProjectRoles are used to define the project role a logged in user must provide to call this method. * * @generated from extension: repeated metalstack.api.v2.ProjectRole project_roles = 51001; */ export declare const project_roles: GenExtension; /** - * AdminRoles are used to define the admin role a logged in user must provide to call this method + * AdminRoles are used to define the admin role a logged in user must provide to call this method. * * @generated from extension: repeated metalstack.api.v2.AdminRole admin_roles = 51002; */ export declare const admin_roles: GenExtension; /** - * Visibility defines the visibility of this method, this is used to have public or self visible methods + * Visibility defines the visibility of this method, this is used to have public or self visible methods. * * @generated from extension: metalstack.api.v2.Visibility visibility = 51003; */ export declare const visibility: GenExtension; /** - * Auditing defines if calls to this method should be audited or not + * Auditing defines if calls to this method should be audited or not. * * @generated from extension: metalstack.api.v2.Auditing auditing = 51004; */ export declare const auditing: GenExtension; /** - * InfraRoles are used to define the infra role a microservice must provide to call this method + * InfraRoles are used to define the infra role a microservice must provide to call this method. * * @generated from extension: repeated metalstack.api.v2.InfraRole infra_roles = 51005; */ export declare const infra_roles: GenExtension; /** - * MachineRole are used to define which machine role a microservice must provide to call this method + * MachineRole are used to define which machine role a microservice must provide to call this method. * * @generated from extension: repeated metalstack.api.v2.MachineRole machine_roles = 51006; */ diff --git a/js/metalstack/api/v2/common_pb.js b/js/metalstack/api/v2/common_pb.js index c2309e10..d1fcd234 100644 --- a/js/metalstack/api/v2/common_pb.js +++ b/js/metalstack/api/v2/common_pb.js @@ -40,14 +40,14 @@ export const LabelsPatchSchema = /*@__PURE__*/ messageDesc(file_metalstack_api_v */ export const UpdateMetaSchema = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_common, 5); /** - * TenantRole specifies what role a logged in user needs to call this tenant scoped service + * TenantRole specifies what role a logged in user needs to call this tenant scoped service. * * @generated from enum metalstack.api.v2.TenantRole */ export var TenantRole; (function (TenantRole) { /** - * TENANT_ROLE_UNSPECIFIED is not specified + * TENANT_ROLE_UNSPECIFIED is not specified. * * @generated from enum value: TENANT_ROLE_UNSPECIFIED = 0; */ @@ -72,7 +72,7 @@ export var TenantRole; TenantRole[TenantRole["VIEWER"] = 3] = "VIEWER"; /** * TENANT_ROLE_GUEST the logged in user needs at least guest role to call this method - * The guest role is assumed by users who are invited to a tenant's project without them + * The guest role is assumed by users who are invited to a tenant's project without them. * having a direct membership within the tenant. * * @generated from enum value: TENANT_ROLE_GUEST = 4; @@ -84,14 +84,14 @@ export var TenantRole; */ export const TenantRoleSchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_common, 0); /** - * ProjectRole specifies what role a logged in user needs to call this project scoped service + * ProjectRole specifies what role a logged in user needs to call this project scoped service. * * @generated from enum metalstack.api.v2.ProjectRole */ export var ProjectRole; (function (ProjectRole) { /** - * PROJECT_ROLE_UNSPECIFIED is not specified + * PROJECT_ROLE_UNSPECIFIED is not specified. * * @generated from enum value: PROJECT_ROLE_UNSPECIFIED = 0; */ @@ -120,14 +120,14 @@ export var ProjectRole; */ export const ProjectRoleSchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_common, 1); /** - * AdminRole specifies what role a logged in user needs to call this admin service + * AdminRole specifies what role a logged in user needs to call this admin service. * * @generated from enum metalstack.api.v2.AdminRole */ export var AdminRole; (function (AdminRole) { /** - * ADMIN_ROLE_UNSPECIFIED is not specified + * ADMIN_ROLE_UNSPECIFIED is not specified. * * @generated from enum value: ADMIN_ROLE_UNSPECIFIED = 0; */ @@ -150,14 +150,14 @@ export var AdminRole; */ export const AdminRoleSchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_common, 2); /** - * InfraRole specifies what role a microservice needs to call this infra service + * InfraRole specifies what role a microservice needs to call this infra service. * * @generated from enum metalstack.api.v2.InfraRole */ export var InfraRole; (function (InfraRole) { /** - * INFRA_ROLE_UNSPECIFIED is not specified + * INFRA_ROLE_UNSPECIFIED is not specified. * * @generated from enum value: INFRA_ROLE_UNSPECIFIED = 0; */ @@ -180,14 +180,14 @@ export var InfraRole; */ export const InfraRoleSchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_common, 3); /** - * MachineRole specifies what role a microservice needs to call this machine service + * MachineRole specifies what role a microservice needs to call this machine service. * * @generated from enum metalstack.api.v2.MachineRole */ export var MachineRole; (function (MachineRole) { /** - * MACHINE_ROLE_UNSPECIFIED is not specified + * MACHINE_ROLE_UNSPECIFIED is not specified. * * @generated from enum value: MACHINE_ROLE_UNSPECIFIED = 0; */ @@ -217,13 +217,13 @@ export const MachineRoleSchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_c export var Visibility; (function (Visibility) { /** - * VISIBILITY_UNSPECIFIED is not defined + * VISIBILITY_UNSPECIFIED is not defined. * * @generated from enum value: VISIBILITY_UNSPECIFIED = 0; */ Visibility[Visibility["UNSPECIFIED"] = 0] = "UNSPECIFIED"; /** - * VISIBILITY_PUBLIC specifies that this service is accessible without authentication + * VISIBILITY_PUBLIC specifies that this service is accessible without authentication. * * @generated from enum value: VISIBILITY_PUBLIC = 1; */ @@ -249,7 +249,7 @@ export const VisibilitySchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_co export var Auditing; (function (Auditing) { /** - * AUDITING_UNSPECIFIED is not specified + * AUDITING_UNSPECIFIED is not specified. * * @generated from enum value: AUDITING_UNSPECIFIED = 0; */ @@ -304,43 +304,43 @@ export var OptimisticLockingStrategy; */ export const OptimisticLockingStrategySchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_common, 7); /** - * TenantRoles are used to define the tenant role a logged in user must provide to call this method + * TenantRoles are used to define the tenant role a logged in user must provide to call this method. * * @generated from extension: repeated metalstack.api.v2.TenantRole tenant_roles = 51000; */ export const tenant_roles = /*@__PURE__*/ extDesc(file_metalstack_api_v2_common, 0); /** - * ProjectRoles are used to define the project role a logged in user must provide to call this method + * ProjectRoles are used to define the project role a logged in user must provide to call this method. * * @generated from extension: repeated metalstack.api.v2.ProjectRole project_roles = 51001; */ export const project_roles = /*@__PURE__*/ extDesc(file_metalstack_api_v2_common, 1); /** - * AdminRoles are used to define the admin role a logged in user must provide to call this method + * AdminRoles are used to define the admin role a logged in user must provide to call this method. * * @generated from extension: repeated metalstack.api.v2.AdminRole admin_roles = 51002; */ export const admin_roles = /*@__PURE__*/ extDesc(file_metalstack_api_v2_common, 2); /** - * Visibility defines the visibility of this method, this is used to have public or self visible methods + * Visibility defines the visibility of this method, this is used to have public or self visible methods. * * @generated from extension: metalstack.api.v2.Visibility visibility = 51003; */ export const visibility = /*@__PURE__*/ extDesc(file_metalstack_api_v2_common, 3); /** - * Auditing defines if calls to this method should be audited or not + * Auditing defines if calls to this method should be audited or not. * * @generated from extension: metalstack.api.v2.Auditing auditing = 51004; */ export const auditing = /*@__PURE__*/ extDesc(file_metalstack_api_v2_common, 4); /** - * InfraRoles are used to define the infra role a microservice must provide to call this method + * InfraRoles are used to define the infra role a microservice must provide to call this method. * * @generated from extension: repeated metalstack.api.v2.InfraRole infra_roles = 51005; */ export const infra_roles = /*@__PURE__*/ extDesc(file_metalstack_api_v2_common, 5); /** - * MachineRole are used to define which machine role a microservice must provide to call this method + * MachineRole are used to define which machine role a microservice must provide to call this method. * * @generated from extension: repeated metalstack.api.v2.MachineRole machine_roles = 51006; */ diff --git a/js/metalstack/api/v2/common_pb.ts b/js/metalstack/api/v2/common_pb.ts index 3146378d..585f0a62 100644 --- a/js/metalstack/api/v2/common_pb.ts +++ b/js/metalstack/api/v2/common_pb.ts @@ -17,7 +17,7 @@ export const file_metalstack_api_v2_common: GenFile = /*@__PURE__*/ fileDesc("Ch5tZXRhbHN0YWNrL2FwaS92Mi9jb21tb24ucHJvdG8SEW1ldGFsc3RhY2suYXBpLnYyIkIKBlBhZ2luZxIRCgRwYWdlGAEgASgESACIAQESEgoFY291bnQYAiABKARIAYgBAUIHCgVfcGFnZUIICgZfY291bnQijgEKBkxhYmVscxJVCgZsYWJlbHMYASADKAsyJS5tZXRhbHN0YWNrLmFwaS52Mi5MYWJlbHMuTGFiZWxzRW50cnlCHrpIG5oBGLiVuLECASIHcgUQARiAAioHcgUQABiAAhotCgtMYWJlbHNFbnRyeRILCgNrZXkYASABKAkSDQoFdmFsdWUYAiABKAk6AjgBIukBCgRNZXRhEi4KBmxhYmVscxgBIAEoCzIZLm1ldGFsc3RhY2suYXBpLnYyLkxhYmVsc0gAiAEBEi4KCmNyZWF0ZWRfYXQYAiABKAsyGi5nb29nbGUucHJvdG9idWYuVGltZXN0YW1wEi4KCnVwZGF0ZWRfYXQYAyABKAsyGi5nb29nbGUucHJvdG9idWYuVGltZXN0YW1wEhIKCmdlbmVyYXRpb24YBCABKAQSHQoQZGVsZXRpb25fdGFza19pZBgFIAEoCUgBiAEBQgkKB19sYWJlbHNCEwoRX2RlbGV0aW9uX3Rhc2tfaWQigAEKDFVwZGF0ZUxhYmVscxIsCgdyZXBsYWNlGAEgASgLMhkubWV0YWxzdGFjay5hcGkudjIuTGFiZWxzSAASLwoFcGF0Y2gYAiABKAsyHi5tZXRhbHN0YWNrLmFwaS52Mi5MYWJlbHNQYXRjaEgAQhEKCHN0cmF0ZWd5EgW6SAIIASJcCgtMYWJlbHNQYXRjaBIpCgZ1cGRhdGUYASABKAsyGS5tZXRhbHN0YWNrLmFwaS52Mi5MYWJlbHMSIgoGcmVtb3ZlGAIgAygJQhK6SA+SAQwYASIIcgbws66xAgEijgEKClVwZGF0ZU1ldGESLgoKdXBkYXRlZF9hdBgBIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5UaW1lc3RhbXASUAoQbG9ja2luZ19zdHJhdGVneRgCIAEoDjIsLm1ldGFsc3RhY2suYXBpLnYyLk9wdGltaXN0aWNMb2NraW5nU3RyYXRlZ3lCCLpIBYIBAhABKocBCgpUZW5hbnRSb2xlEhsKF1RFTkFOVF9ST0xFX1VOU1BFQ0lGSUVEEAASFQoRVEVOQU5UX1JPTEVfT1dORVIQARIWChJURU5BTlRfUk9MRV9FRElUT1IQAhIWChJURU5BTlRfUk9MRV9WSUVXRVIQAxIVChFURU5BTlRfUk9MRV9HVUVTVBAEKnUKC1Byb2plY3RSb2xlEhwKGFBST0pFQ1RfUk9MRV9VTlNQRUNJRklFRBAAEhYKElBST0pFQ1RfUk9MRV9PV05FUhABEhcKE1BST0pFQ1RfUk9MRV9FRElUT1IQAhIXChNQUk9KRUNUX1JPTEVfVklFV0VSEAMqVQoJQWRtaW5Sb2xlEhoKFkFETUlOX1JPTEVfVU5TUEVDSUZJRUQQABIVChFBRE1JTl9ST0xFX0VESVRPUhABEhUKEUFETUlOX1JPTEVfVklFV0VSEAIqVQoJSW5mcmFSb2xlEhoKFklORlJBX1JPTEVfVU5TUEVDSUZJRUQQABIVChFJTkZSQV9ST0xFX0VESVRPUhABEhUKEUlORlJBX1JPTEVfVklFV0VSEAIqXQoLTWFjaGluZVJvbGUSHAoYTUFDSElORV9ST0xFX1VOU1BFQ0lGSUVEEAASFwoTTUFDSElORV9ST0xFX0VESVRPUhABEhcKE01BQ0hJTkVfUk9MRV9WSUVXRVIQAipUCgpWaXNpYmlsaXR5EhoKFlZJU0lCSUxJVFlfVU5TUEVDSUZJRUQQABIVChFWSVNJQklMSVRZX1BVQkxJQxABEhMKD1ZJU0lCSUxJVFlfU0VMRhACKlIKCEF1ZGl0aW5nEhgKFEFVRElUSU5HX1VOU1BFQ0lGSUVEEAASFQoRQVVESVRJTkdfSU5DTFVERUQQARIVChFBVURJVElOR19FWENMVURFRBACKpgBChlPcHRpbWlzdGljTG9ja2luZ1N0cmF0ZWd5EisKJ09QVElNSVNUSUNfTE9DS0lOR19TVFJBVEVHWV9VTlNQRUNJRklFRBAAEiYKIk9QVElNSVNUSUNfTE9DS0lOR19TVFJBVEVHWV9DTElFTlQQARImCiJPUFRJTUlTVElDX0xPQ0tJTkdfU1RSQVRFR1lfU0VSVkVSEAI6YgoMdGVuYW50X3JvbGVzEh4uZ29vZ2xlLnByb3RvYnVmLk1ldGhvZE9wdGlvbnMYuI4DIAMoDjIdLm1ldGFsc3RhY2suYXBpLnYyLlRlbmFudFJvbGVSC3RlbmFudFJvbGVzOmUKDXByb2plY3Rfcm9sZXMSHi5nb29nbGUucHJvdG9idWYuTWV0aG9kT3B0aW9ucxi5jgMgAygOMh4ubWV0YWxzdGFjay5hcGkudjIuUHJvamVjdFJvbGVSDHByb2plY3RSb2xlczpfCgthZG1pbl9yb2xlcxIeLmdvb2dsZS5wcm90b2J1Zi5NZXRob2RPcHRpb25zGLqOAyADKA4yHC5tZXRhbHN0YWNrLmFwaS52Mi5BZG1pblJvbGVSCmFkbWluUm9sZXM6XwoKdmlzaWJpbGl0eRIeLmdvb2dsZS5wcm90b2J1Zi5NZXRob2RPcHRpb25zGLuOAyABKA4yHS5tZXRhbHN0YWNrLmFwaS52Mi5WaXNpYmlsaXR5Ugp2aXNpYmlsaXR5OlkKCGF1ZGl0aW5nEh4uZ29vZ2xlLnByb3RvYnVmLk1ldGhvZE9wdGlvbnMYvI4DIAEoDjIbLm1ldGFsc3RhY2suYXBpLnYyLkF1ZGl0aW5nUghhdWRpdGluZzpfCgtpbmZyYV9yb2xlcxIeLmdvb2dsZS5wcm90b2J1Zi5NZXRob2RPcHRpb25zGL2OAyADKA4yHC5tZXRhbHN0YWNrLmFwaS52Mi5JbmZyYVJvbGVSCmluZnJhUm9sZXM6ZQoNbWFjaGluZV9yb2xlcxIeLmdvb2dsZS5wcm90b2J1Zi5NZXRob2RPcHRpb25zGL6OAyADKA4yHi5tZXRhbHN0YWNrLmFwaS52Mi5NYWNoaW5lUm9sZVIMbWFjaGluZVJvbGVzOk8KEWVudW1fc3RyaW5nX3ZhbHVlEiEuZ29vZ2xlLnByb3RvYnVmLkVudW1WYWx1ZU9wdGlvbnMYoJYDIAEoCVIPZW51bVN0cmluZ1ZhbHVlQsEBChVjb20ubWV0YWxzdGFjay5hcGkudjJCC0NvbW1vblByb3RvUAFaNWdpdGh1Yi5jb20vbWV0YWwtc3RhY2svYXBpL2dvL21ldGFsc3RhY2svYXBpL3YyO2FwaXYyogIDTUFYqgIRTWV0YWxzdGFjay5BcGkuVjLKAhFNZXRhbHN0YWNrXEFwaVxWMuICHU1ldGFsc3RhY2tcQXBpXFYyXEdQQk1ldGFkYXRh6gITTWV0YWxzdGFjazo6QXBpOjpWMmIGcHJvdG8z", [file_buf_validate_validate, file_google_protobuf_descriptor, file_google_protobuf_timestamp, file_metalstack_api_v2_predefined_rules]); /** - * Paging defines paging for methods with a lot of results + * Paging defines paging for methods with a lot of results. * * @generated from message metalstack.api.v2.Paging */ @@ -31,7 +31,7 @@ export type Paging = Message<"metalstack.api.v2.Paging"> & { page?: bigint | undefined; /** - * Count is the number of results returned per page, if not given server side defaults apply + * Count is the number of results returned per page, if not given server side defaults apply. * * @generated from field: optional uint64 count = 2; */ @@ -46,7 +46,7 @@ export const PagingSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_common, 0); /** - * Labels define additional information to a entity + * Labels define additional information to a entity. * * @generated from message metalstack.api.v2.Labels */ @@ -80,14 +80,14 @@ export type Meta = Message<"metalstack.api.v2.Meta"> & { labels?: Labels | undefined; /** - * CreatedAt is the date when this entity was created + * CreatedAt is the date when this entity was created. * * @generated from field: google.protobuf.Timestamp created_at = 2; */ createdAt?: Timestamp | undefined; /** - * UpdatedAt is the date when this entity was updated + * UpdatedAt is the date when this entity was updated. * must be part of the update request to ensure optimistic locking * * @generated from field: google.protobuf.Timestamp updated_at = 3; @@ -118,13 +118,13 @@ export const MetaSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_common, 2); /** - * UpdateLabels is a message to update labels + * UpdateLabels is a message to update labels. * * @generated from message metalstack.api.v2.UpdateLabels */ export type UpdateLabels = Message<"metalstack.api.v2.UpdateLabels"> & { /** - * Strategy defines the label update strategy + * Strategy defines the label update strategy. * * @generated from oneof metalstack.api.v2.UpdateLabels.strategy */ @@ -138,7 +138,7 @@ export type UpdateLabels = Message<"metalstack.api.v2.UpdateLabels"> & { case: "replace"; } | { /** - * Patch adds, updates or remove given labels without modifying others + * Patch adds, updates or remove given labels without modifying others. * * @generated from field: metalstack.api.v2.LabelsPatch patch = 2; */ @@ -155,20 +155,20 @@ export const UpdateLabelsSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_common, 3); /** - * LabelsPatch adds, updates or remove given labels without modifying others + * LabelsPatch adds, updates or remove given labels without modifying others. * * @generated from message metalstack.api.v2.LabelsPatch */ export type LabelsPatch = Message<"metalstack.api.v2.LabelsPatch"> & { /** - * Update labels. New ones will be added, existing ones overwritten + * Update labels. New ones will be added, existing ones overwritten. * * @generated from field: metalstack.api.v2.Labels update = 1; */ update?: Labels | undefined; /** - * Remove labels by key + * Remove labels by key. * * @generated from field: repeated string remove = 2; */ @@ -183,13 +183,13 @@ export const LabelsPatchSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_common, 4); /** - * UpdateMeta must be provided with every UpdateRequest to define how optimistic locking should be handled + * UpdateMeta must be provided with every UpdateRequest to define how optimistic locking should be handled. * * @generated from message metalstack.api.v2.UpdateMeta */ export type UpdateMeta = Message<"metalstack.api.v2.UpdateMeta"> & { /** - * UpdatedAt is the date when this entity was updated + * UpdatedAt is the date when this entity was updated. * must be part of the update request to ensure optimistic locking * * @generated from field: google.protobuf.Timestamp updated_at = 1; @@ -212,13 +212,13 @@ export const UpdateMetaSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_common, 5); /** - * TenantRole specifies what role a logged in user needs to call this tenant scoped service + * TenantRole specifies what role a logged in user needs to call this tenant scoped service. * * @generated from enum metalstack.api.v2.TenantRole */ export enum TenantRole { /** - * TENANT_ROLE_UNSPECIFIED is not specified + * TENANT_ROLE_UNSPECIFIED is not specified. * * @generated from enum value: TENANT_ROLE_UNSPECIFIED = 0; */ @@ -247,7 +247,7 @@ export enum TenantRole { /** * TENANT_ROLE_GUEST the logged in user needs at least guest role to call this method - * The guest role is assumed by users who are invited to a tenant's project without them + * The guest role is assumed by users who are invited to a tenant's project without them. * having a direct membership within the tenant. * * @generated from enum value: TENANT_ROLE_GUEST = 4; @@ -262,13 +262,13 @@ export const TenantRoleSchema: GenEnum = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_common, 0); /** - * ProjectRole specifies what role a logged in user needs to call this project scoped service + * ProjectRole specifies what role a logged in user needs to call this project scoped service. * * @generated from enum metalstack.api.v2.ProjectRole */ export enum ProjectRole { /** - * PROJECT_ROLE_UNSPECIFIED is not specified + * PROJECT_ROLE_UNSPECIFIED is not specified. * * @generated from enum value: PROJECT_ROLE_UNSPECIFIED = 0; */ @@ -303,13 +303,13 @@ export const ProjectRoleSchema: GenEnum = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_common, 1); /** - * AdminRole specifies what role a logged in user needs to call this admin service + * AdminRole specifies what role a logged in user needs to call this admin service. * * @generated from enum metalstack.api.v2.AdminRole */ export enum AdminRole { /** - * ADMIN_ROLE_UNSPECIFIED is not specified + * ADMIN_ROLE_UNSPECIFIED is not specified. * * @generated from enum value: ADMIN_ROLE_UNSPECIFIED = 0; */ @@ -337,13 +337,13 @@ export const AdminRoleSchema: GenEnum = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_common, 2); /** - * InfraRole specifies what role a microservice needs to call this infra service + * InfraRole specifies what role a microservice needs to call this infra service. * * @generated from enum metalstack.api.v2.InfraRole */ export enum InfraRole { /** - * INFRA_ROLE_UNSPECIFIED is not specified + * INFRA_ROLE_UNSPECIFIED is not specified. * * @generated from enum value: INFRA_ROLE_UNSPECIFIED = 0; */ @@ -371,13 +371,13 @@ export const InfraRoleSchema: GenEnum = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_common, 3); /** - * MachineRole specifies what role a microservice needs to call this machine service + * MachineRole specifies what role a microservice needs to call this machine service. * * @generated from enum metalstack.api.v2.MachineRole */ export enum MachineRole { /** - * MACHINE_ROLE_UNSPECIFIED is not specified + * MACHINE_ROLE_UNSPECIFIED is not specified. * * @generated from enum value: MACHINE_ROLE_UNSPECIFIED = 0; */ @@ -411,14 +411,14 @@ export const MachineRoleSchema: GenEnum = /*@__PURE__*/ */ export enum Visibility { /** - * VISIBILITY_UNSPECIFIED is not defined + * VISIBILITY_UNSPECIFIED is not defined. * * @generated from enum value: VISIBILITY_UNSPECIFIED = 0; */ UNSPECIFIED = 0, /** - * VISIBILITY_PUBLIC specifies that this service is accessible without authentication + * VISIBILITY_PUBLIC specifies that this service is accessible without authentication. * * @generated from enum value: VISIBILITY_PUBLIC = 1; */ @@ -447,7 +447,7 @@ export const VisibilitySchema: GenEnum = /*@__PURE__*/ */ export enum Auditing { /** - * AUDITING_UNSPECIFIED is not specified + * AUDITING_UNSPECIFIED is not specified. * * @generated from enum value: AUDITING_UNSPECIFIED = 0; */ @@ -511,7 +511,7 @@ export const OptimisticLockingStrategySchema: GenEnum enumDesc(file_metalstack_api_v2_common, 7); /** - * TenantRoles are used to define the tenant role a logged in user must provide to call this method + * TenantRoles are used to define the tenant role a logged in user must provide to call this method. * * @generated from extension: repeated metalstack.api.v2.TenantRole tenant_roles = 51000; */ @@ -519,7 +519,7 @@ export const tenant_roles: GenExtension = /*@__PURE extDesc(file_metalstack_api_v2_common, 0); /** - * ProjectRoles are used to define the project role a logged in user must provide to call this method + * ProjectRoles are used to define the project role a logged in user must provide to call this method. * * @generated from extension: repeated metalstack.api.v2.ProjectRole project_roles = 51001; */ @@ -527,7 +527,7 @@ export const project_roles: GenExtension = /*@__PU extDesc(file_metalstack_api_v2_common, 1); /** - * AdminRoles are used to define the admin role a logged in user must provide to call this method + * AdminRoles are used to define the admin role a logged in user must provide to call this method. * * @generated from extension: repeated metalstack.api.v2.AdminRole admin_roles = 51002; */ @@ -535,7 +535,7 @@ export const admin_roles: GenExtension = /*@__PURE__ extDesc(file_metalstack_api_v2_common, 2); /** - * Visibility defines the visibility of this method, this is used to have public or self visible methods + * Visibility defines the visibility of this method, this is used to have public or self visible methods. * * @generated from extension: metalstack.api.v2.Visibility visibility = 51003; */ @@ -543,7 +543,7 @@ export const visibility: GenExtension = /*@__PURE__*/ extDesc(file_metalstack_api_v2_common, 3); /** - * Auditing defines if calls to this method should be audited or not + * Auditing defines if calls to this method should be audited or not. * * @generated from extension: metalstack.api.v2.Auditing auditing = 51004; */ @@ -551,7 +551,7 @@ export const auditing: GenExtension = /*@__PURE__*/ extDesc(file_metalstack_api_v2_common, 4); /** - * InfraRoles are used to define the infra role a microservice must provide to call this method + * InfraRoles are used to define the infra role a microservice must provide to call this method. * * @generated from extension: repeated metalstack.api.v2.InfraRole infra_roles = 51005; */ @@ -559,7 +559,7 @@ export const infra_roles: GenExtension = /*@__PURE__ extDesc(file_metalstack_api_v2_common, 5); /** - * MachineRole are used to define which machine role a microservice must provide to call this method + * MachineRole are used to define which machine role a microservice must provide to call this method. * * @generated from extension: repeated metalstack.api.v2.MachineRole machine_roles = 51006; */ diff --git a/js/metalstack/api/v2/component_pb.d.ts b/js/metalstack/api/v2/component_pb.d.ts index a1d8bf53..5847a6d5 100644 --- a/js/metalstack/api/v2/component_pb.d.ts +++ b/js/metalstack/api/v2/component_pb.d.ts @@ -9,19 +9,19 @@ import type { Message } from "@bufbuild/protobuf"; */ export declare const file_metalstack_api_v2_component: GenFile; /** - * Component represents a microservice connected to our apiserver + * Component represents a microservice connected to our apiserver. * * @generated from message metalstack.api.v2.Component */ export type Component = Message<"metalstack.api.v2.Component"> & { /** - * UUID identifies this component event + * UUID identifies this component event. * * @generated from field: string uuid = 1; */ uuid: string; /** - * Type defines which service is actually pinging + * Type defines which service is actually pinging. * * @generated from field: metalstack.api.v2.ComponentType type = 2; */ @@ -34,7 +34,7 @@ export type Component = Message<"metalstack.api.v2.Component"> & { */ identifier: string; /** - * StartedAt is the timestamp this service was started + * StartedAt is the timestamp this service was started. * * @generated from field: google.protobuf.Timestamp started_at = 4; */ @@ -82,13 +82,13 @@ export declare const ComponentSchema: GenMessage; */ export type ComponentQuery = Message<"metalstack.api.v2.ComponentQuery"> & { /** - * UUID identifies this component + * UUID identifies this component. * * @generated from field: optional string uuid = 1; */ uuid?: string | undefined; /** - * Type defines which service is actually pinging + * Type defines which service is actually pinging. * * @generated from field: optional metalstack.api.v2.ComponentType type = 2; */ @@ -107,49 +107,49 @@ export type ComponentQuery = Message<"metalstack.api.v2.ComponentQuery"> & { */ export declare const ComponentQuerySchema: GenMessage; /** - * ComponentType defines which service is actually pinging + * ComponentType defines which service is actually pinging. * * @generated from enum metalstack.api.v2.ComponentType */ export declare enum ComponentType { /** - * COMPONENT_TYPE_UNSPECIFIED is unspecified + * COMPONENT_TYPE_UNSPECIFIED is unspecified. * * @generated from enum value: COMPONENT_TYPE_UNSPECIFIED = 0; */ UNSPECIFIED = 0, /** - * COMPONENT_TYPE_PIXIECORE is pixiecore + * COMPONENT_TYPE_PIXIECORE is pixiecore. * * @generated from enum value: COMPONENT_TYPE_PIXIECORE = 1; */ PIXIECORE = 1, /** - * COMPONENT_TYPE_METAL_CORE is metal-core + * COMPONENT_TYPE_METAL_CORE is metal-core. * * @generated from enum value: COMPONENT_TYPE_METAL_CORE = 2; */ METAL_CORE = 2, /** - * COMPONENT_TYPE_METAL_BMC is metal-bmc + * COMPONENT_TYPE_METAL_BMC is metal-bmc. * * @generated from enum value: COMPONENT_TYPE_METAL_BMC = 3; */ METAL_BMC = 3, /** - * COMPONENT_TYPE_METAL_IMAGE_CACHE_SYNC is metal-image-cache-sync + * COMPONENT_TYPE_METAL_IMAGE_CACHE_SYNC is metal-image-cache-sync. * * @generated from enum value: COMPONENT_TYPE_METAL_IMAGE_CACHE_SYNC = 4; */ METAL_IMAGE_CACHE_SYNC = 4, /** - * COMPONENT_TYPE_METAL_CONSOLE is metal-console + * COMPONENT_TYPE_METAL_CONSOLE is metal-console. * * @generated from enum value: COMPONENT_TYPE_METAL_CONSOLE = 5; */ METAL_CONSOLE = 5, /** - * COMPONENT_TYPE_METAL_METRICS_EXPORTER is metal-metrics-exporter + * COMPONENT_TYPE_METAL_METRICS_EXPORTER is metal-metrics-exporter. * * @generated from enum value: COMPONENT_TYPE_METAL_METRICS_EXPORTER = 6; */ diff --git a/js/metalstack/api/v2/component_pb.js b/js/metalstack/api/v2/component_pb.js index 84e193f0..4cc54172 100644 --- a/js/metalstack/api/v2/component_pb.js +++ b/js/metalstack/api/v2/component_pb.js @@ -23,50 +23,50 @@ export const ComponentSchema = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_ */ export const ComponentQuerySchema = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_component, 1); /** - * ComponentType defines which service is actually pinging + * ComponentType defines which service is actually pinging. * * @generated from enum metalstack.api.v2.ComponentType */ export var ComponentType; (function (ComponentType) { /** - * COMPONENT_TYPE_UNSPECIFIED is unspecified + * COMPONENT_TYPE_UNSPECIFIED is unspecified. * * @generated from enum value: COMPONENT_TYPE_UNSPECIFIED = 0; */ ComponentType[ComponentType["UNSPECIFIED"] = 0] = "UNSPECIFIED"; /** - * COMPONENT_TYPE_PIXIECORE is pixiecore + * COMPONENT_TYPE_PIXIECORE is pixiecore. * * @generated from enum value: COMPONENT_TYPE_PIXIECORE = 1; */ ComponentType[ComponentType["PIXIECORE"] = 1] = "PIXIECORE"; /** - * COMPONENT_TYPE_METAL_CORE is metal-core + * COMPONENT_TYPE_METAL_CORE is metal-core. * * @generated from enum value: COMPONENT_TYPE_METAL_CORE = 2; */ ComponentType[ComponentType["METAL_CORE"] = 2] = "METAL_CORE"; /** - * COMPONENT_TYPE_METAL_BMC is metal-bmc + * COMPONENT_TYPE_METAL_BMC is metal-bmc. * * @generated from enum value: COMPONENT_TYPE_METAL_BMC = 3; */ ComponentType[ComponentType["METAL_BMC"] = 3] = "METAL_BMC"; /** - * COMPONENT_TYPE_METAL_IMAGE_CACHE_SYNC is metal-image-cache-sync + * COMPONENT_TYPE_METAL_IMAGE_CACHE_SYNC is metal-image-cache-sync. * * @generated from enum value: COMPONENT_TYPE_METAL_IMAGE_CACHE_SYNC = 4; */ ComponentType[ComponentType["METAL_IMAGE_CACHE_SYNC"] = 4] = "METAL_IMAGE_CACHE_SYNC"; /** - * COMPONENT_TYPE_METAL_CONSOLE is metal-console + * COMPONENT_TYPE_METAL_CONSOLE is metal-console. * * @generated from enum value: COMPONENT_TYPE_METAL_CONSOLE = 5; */ ComponentType[ComponentType["METAL_CONSOLE"] = 5] = "METAL_CONSOLE"; /** - * COMPONENT_TYPE_METAL_METRICS_EXPORTER is metal-metrics-exporter + * COMPONENT_TYPE_METAL_METRICS_EXPORTER is metal-metrics-exporter. * * @generated from enum value: COMPONENT_TYPE_METAL_METRICS_EXPORTER = 6; */ diff --git a/js/metalstack/api/v2/component_pb.ts b/js/metalstack/api/v2/component_pb.ts index 686d3036..b06225fa 100644 --- a/js/metalstack/api/v2/component_pb.ts +++ b/js/metalstack/api/v2/component_pb.ts @@ -23,20 +23,20 @@ export const file_metalstack_api_v2_component: GenFile = /*@__PURE__*/ fileDesc("CiFtZXRhbHN0YWNrL2FwaS92Mi9jb21wb25lbnQucHJvdG8SEW1ldGFsc3RhY2suYXBpLnYyIokDCglDb21wb25lbnQSFgoEdXVpZBgBIAEoCUIIukgFcgOwAQESOAoEdHlwZRgCIAEoDjIgLm1ldGFsc3RhY2suYXBpLnYyLkNvbXBvbmVudFR5cGVCCLpIBYIBAhABEh8KCmlkZW50aWZpZXIYAyABKAlCC7pICHIGwLOusQIBEi4KCnN0YXJ0ZWRfYXQYBCABKAsyGi5nb29nbGUucHJvdG9idWYuVGltZXN0YW1wEi8KC3JlcG9ydGVkX2F0GAUgASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcBIrCghpbnRlcnZhbBgGIAEoCzIZLmdvb2dsZS5wcm90b2J1Zi5EdXJhdGlvbhIrCgd2ZXJzaW9uGAcgASgLMhoubWV0YWxzdGFjay5hcGkudjIuVmVyc2lvbhInCgV0b2tlbhgIIAEoCzIYLm1ldGFsc3RhY2suYXBpLnYyLlRva2VuEiUKBG1ldGEYCSABKAsyFy5tZXRhbHN0YWNrLmFwaS52Mi5NZXRhIrMBCg5Db21wb25lbnRRdWVyeRIbCgR1dWlkGAEgASgJQgi6SAVyA7ABAUgAiAEBEj0KBHR5cGUYAiABKA4yIC5tZXRhbHN0YWNrLmFwaS52Mi5Db21wb25lbnRUeXBlQgi6SAWCAQIQAUgBiAEBEiQKCmlkZW50aWZpZXIYAyABKAlCC7pICHIGwLOusQIBSAKIAQFCBwoFX3V1aWRCBwoFX3R5cGVCDQoLX2lkZW50aWZpZXIqjAMKDUNvbXBvbmVudFR5cGUSLwoaQ09NUE9ORU5UX1RZUEVfVU5TUEVDSUZJRUQQABoPgrIZC3Vuc3BlY2lmaWVkEisKGENPTVBPTkVOVF9UWVBFX1BJWElFQ09SRRABGg2CshkJcGl4aWVjb3JlEi0KGUNPTVBPTkVOVF9UWVBFX01FVEFMX0NPUkUQAhoOgrIZCm1ldGFsLWNvcmUSKwoYQ09NUE9ORU5UX1RZUEVfTUVUQUxfQk1DEAMaDYKyGQltZXRhbC1ibWMSRQolQ09NUE9ORU5UX1RZUEVfTUVUQUxfSU1BR0VfQ0FDSEVfU1lOQxAEGhqCshkWbWV0YWwtaW1hZ2UtY2FjaGUtc3luYxIzChxDT01QT05FTlRfVFlQRV9NRVRBTF9DT05TT0xFEAUaEYKyGQ1tZXRhbC1jb25zb2xlEkUKJUNPTVBPTkVOVF9UWVBFX01FVEFMX01FVFJJQ1NfRVhQT1JURVIQBhoagrIZFm1ldGFsLW1ldHJpY3MtZXhwb3J0ZXJCxAEKFWNvbS5tZXRhbHN0YWNrLmFwaS52MkIOQ29tcG9uZW50UHJvdG9QAVo1Z2l0aHViLmNvbS9tZXRhbC1zdGFjay9hcGkvZ28vbWV0YWxzdGFjay9hcGkvdjI7YXBpdjKiAgNNQViqAhFNZXRhbHN0YWNrLkFwaS5WMsoCEU1ldGFsc3RhY2tcQXBpXFYy4gIdTWV0YWxzdGFja1xBcGlcVjJcR1BCTWV0YWRhdGHqAhNNZXRhbHN0YWNrOjpBcGk6OlYyYgZwcm90bzM", [file_buf_validate_validate, file_google_protobuf_duration, file_google_protobuf_timestamp, file_metalstack_api_v2_common, file_metalstack_api_v2_predefined_rules, file_metalstack_api_v2_token, file_metalstack_api_v2_version]); /** - * Component represents a microservice connected to our apiserver + * Component represents a microservice connected to our apiserver. * * @generated from message metalstack.api.v2.Component */ export type Component = Message<"metalstack.api.v2.Component"> & { /** - * UUID identifies this component event + * UUID identifies this component event. * * @generated from field: string uuid = 1; */ uuid: string; /** - * Type defines which service is actually pinging + * Type defines which service is actually pinging. * * @generated from field: metalstack.api.v2.ComponentType type = 2; */ @@ -51,7 +51,7 @@ export type Component = Message<"metalstack.api.v2.Component"> & { identifier: string; /** - * StartedAt is the timestamp this service was started + * StartedAt is the timestamp this service was started. * * @generated from field: google.protobuf.Timestamp started_at = 4; */ @@ -107,14 +107,14 @@ export const ComponentSchema: GenMessage = /*@__PURE__*/ */ export type ComponentQuery = Message<"metalstack.api.v2.ComponentQuery"> & { /** - * UUID identifies this component + * UUID identifies this component. * * @generated from field: optional string uuid = 1; */ uuid?: string | undefined; /** - * Type defines which service is actually pinging + * Type defines which service is actually pinging. * * @generated from field: optional metalstack.api.v2.ComponentType type = 2; */ @@ -137,55 +137,55 @@ export const ComponentQuerySchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_component, 1); /** - * ComponentType defines which service is actually pinging + * ComponentType defines which service is actually pinging. * * @generated from enum metalstack.api.v2.ComponentType */ export enum ComponentType { /** - * COMPONENT_TYPE_UNSPECIFIED is unspecified + * COMPONENT_TYPE_UNSPECIFIED is unspecified. * * @generated from enum value: COMPONENT_TYPE_UNSPECIFIED = 0; */ UNSPECIFIED = 0, /** - * COMPONENT_TYPE_PIXIECORE is pixiecore + * COMPONENT_TYPE_PIXIECORE is pixiecore. * * @generated from enum value: COMPONENT_TYPE_PIXIECORE = 1; */ PIXIECORE = 1, /** - * COMPONENT_TYPE_METAL_CORE is metal-core + * COMPONENT_TYPE_METAL_CORE is metal-core. * * @generated from enum value: COMPONENT_TYPE_METAL_CORE = 2; */ METAL_CORE = 2, /** - * COMPONENT_TYPE_METAL_BMC is metal-bmc + * COMPONENT_TYPE_METAL_BMC is metal-bmc. * * @generated from enum value: COMPONENT_TYPE_METAL_BMC = 3; */ METAL_BMC = 3, /** - * COMPONENT_TYPE_METAL_IMAGE_CACHE_SYNC is metal-image-cache-sync + * COMPONENT_TYPE_METAL_IMAGE_CACHE_SYNC is metal-image-cache-sync. * * @generated from enum value: COMPONENT_TYPE_METAL_IMAGE_CACHE_SYNC = 4; */ METAL_IMAGE_CACHE_SYNC = 4, /** - * COMPONENT_TYPE_METAL_CONSOLE is metal-console + * COMPONENT_TYPE_METAL_CONSOLE is metal-console. * * @generated from enum value: COMPONENT_TYPE_METAL_CONSOLE = 5; */ METAL_CONSOLE = 5, /** - * COMPONENT_TYPE_METAL_METRICS_EXPORTER is metal-metrics-exporter + * COMPONENT_TYPE_METAL_METRICS_EXPORTER is metal-metrics-exporter. * * @generated from enum value: COMPONENT_TYPE_METAL_METRICS_EXPORTER = 6; */ diff --git a/js/metalstack/api/v2/filesystem_pb.d.ts b/js/metalstack/api/v2/filesystem_pb.d.ts index 825dc9f6..b605aea9 100644 --- a/js/metalstack/api/v2/filesystem_pb.d.ts +++ b/js/metalstack/api/v2/filesystem_pb.d.ts @@ -6,7 +6,7 @@ import type { Message } from "@bufbuild/protobuf"; */ export declare const file_metalstack_api_v2_filesystem: GenFile; /** - * FilesystemServiceGetRequest is the request payload for a filesystem get request + * FilesystemServiceGetRequest is the request payload for a filesystem get request. * * @generated from message metalstack.api.v2.FilesystemServiceGetRequest */ @@ -24,7 +24,7 @@ export type FilesystemServiceGetRequest = Message<"metalstack.api.v2.FilesystemS */ export declare const FilesystemServiceGetRequestSchema: GenMessage; /** - * FilesystemServiceListRequest is the request payload for a filesystem list request + * FilesystemServiceListRequest is the request payload for a filesystem list request. * * @generated from message metalstack.api.v2.FilesystemServiceListRequest */ @@ -42,7 +42,7 @@ export type FilesystemServiceListRequest = Message<"metalstack.api.v2.Filesystem */ export declare const FilesystemServiceListRequestSchema: GenMessage; /** - * FilesystemServiceGetResponse is the response payload for a filesystem get request + * FilesystemServiceGetResponse is the response payload for a filesystem get request. * * @generated from message metalstack.api.v2.FilesystemServiceGetResponse */ @@ -60,7 +60,7 @@ export type FilesystemServiceGetResponse = Message<"metalstack.api.v2.Filesystem */ export declare const FilesystemServiceGetResponseSchema: GenMessage; /** - * FilesystemServiceListResponse is the response payload for a filesystem list request + * FilesystemServiceListResponse is the response payload for a filesystem list request. * * @generated from message metalstack.api.v2.FilesystemServiceListResponse */ @@ -108,13 +108,13 @@ export type FilesystemLayout = Message<"metalstack.api.v2.FilesystemLayout"> & { */ description?: string | undefined; /** - * Filesystems is a list of filesystems to create on a machine + * Filesystems is a list of filesystems to create on a machine. * * @generated from field: repeated metalstack.api.v2.Filesystem filesystems = 5; */ filesystems: Filesystem[]; /** - * Disks list of disks that belong to this layout + * Disks list of disks that belong to this layout. * * @generated from field: repeated metalstack.api.v2.Disk disks = 6; */ @@ -126,13 +126,13 @@ export type FilesystemLayout = Message<"metalstack.api.v2.FilesystemLayout"> & { */ raid: Raid[]; /** - * VolumeGroups list of volumegroups to create + * VolumeGroups list of volumegroups to create. * * @generated from field: repeated metalstack.api.v2.VolumeGroup volume_groups = 8; */ volumeGroups: VolumeGroup[]; /** - * LogicalVolumes list of logicalvolumes to create + * LogicalVolumes list of logicalvolumes to create. * * @generated from field: repeated metalstack.api.v2.LogicalVolume logical_volumes = 9; */ @@ -156,14 +156,14 @@ export declare const FilesystemLayoutSchema: GenMessage; */ export type FilesystemLayoutConstraints = Message<"metalstack.api.v2.FilesystemLayoutConstraints"> & { /** - * Sizes list of sizes this layout applies to + * Sizes list of sizes this layout applies to. * this could either be a concrete size, or a asterisk to match all sizes * * @generated from field: repeated string sizes = 1; */ sizes: string[]; /** - * Images list of images this layout applies to in the following form + * Images list of images this layout applies to in the following form. * key must be the first part of available images, e.g. the name of the image * value must be a semver match expression with the constraint and the version separated by space * this would match all debian images which are greater or equal 12.0 @@ -253,7 +253,7 @@ export type Disk = Message<"metalstack.api.v2.Disk"> & { */ device: string; /** - * Partitions list of partitions to create on this disk + * Partitions list of partitions to create on this disk. * * @generated from field: repeated metalstack.api.v2.DiskPartition partitions = 2; */ @@ -277,13 +277,13 @@ export type Raid = Message<"metalstack.api.v2.Raid"> & { */ arrayName: string; /** - * Devices list of devices to form the raid array from + * Devices list of devices to form the raid array from. * * @generated from field: repeated string devices = 2; */ devices: string[]; /** - * Level raid level to create, should be 0 or 1 + * Level raid level to create, should be 0 or 1. * * @generated from field: metalstack.api.v2.RaidLevel level = 3; */ @@ -313,7 +313,7 @@ export declare const RaidSchema: GenMessage; */ export type DiskPartition = Message<"metalstack.api.v2.DiskPartition"> & { /** - * Number partition number, will be appended to partitionprefix to create the final devicename + * Number partition number, will be appended to partitionprefix to create the final devicename. * * @generated from field: uint32 number = 1; */ @@ -355,13 +355,13 @@ export type VolumeGroup = Message<"metalstack.api.v2.VolumeGroup"> & { */ name: string; /** - * Devices list of devices to form the volume group from + * Devices list of devices to form the volume group from. * * @generated from field: repeated string devices = 2; */ devices: string[]; /** - * Tags list of tags to add to the volume group + * Tags list of tags to add to the volume group. * * @generated from field: repeated string tags = 3; */ @@ -415,7 +415,7 @@ export declare const LogicalVolumeSchema: GenMessage; */ export declare enum LVMType { /** - * LVM_TYPE_UNSPECIFIED is not specified + * LVM_TYPE_UNSPECIFIED is not specified. * * @generated from enum value: LVM_TYPE_UNSPECIFIED = 0; */ @@ -444,7 +444,7 @@ export declare enum LVMType { */ export declare const LVMTypeSchema: GenEnum; /** - * Format specifies the filesystem to use on a volume + * Format specifies the filesystem to use on a volume. * * @generated from enum metalstack.api.v2.Format */ @@ -456,31 +456,31 @@ export declare enum Format { */ UNSPECIFIED = 0, /** - * FORMAT_VFAT is used for the UEFI boot partition + * FORMAT_VFAT is used for the UEFI boot partition. * * @generated from enum value: FORMAT_VFAT = 1; */ VFAT = 1, /** - * FORMAT_EXT3 is usually only used for /boot + * FORMAT_EXT3 is usually only used for /boot. * * @generated from enum value: FORMAT_EXT3 = 2; */ EXT3 = 2, /** - * FORMAT_EXT4 is the default fs + * FORMAT_EXT4 is the default fs. * * @generated from enum value: FORMAT_EXT4 = 3; */ EXT4 = 3, /** - * FORMAT_SWAP is for the swap partition + * FORMAT_SWAP is for the swap partition. * * @generated from enum value: FORMAT_SWAP = 4; */ SWAP = 4, /** - * FORMAT_TMPFS is used for a memory filesystem typically /tmp + * FORMAT_TMPFS is used for a memory filesystem typically /tmp. * * @generated from enum value: FORMAT_TMPFS = 5; */ @@ -497,13 +497,13 @@ export declare enum Format { */ export declare const FormatSchema: GenEnum; /** - * GPTType specifies the partition type in uefi systems + * GPTType specifies the partition type in uefi systems. * * @generated from enum metalstack.api.v2.GPTType */ export declare enum GPTType { /** - * GPT_TYPE_UNSPECIFIED is no specified + * GPT_TYPE_UNSPECIFIED is no specified. * * @generated from enum value: GPT_TYPE_UNSPECIFIED = 0; */ @@ -538,25 +538,25 @@ export declare enum GPTType { */ export declare const GPTTypeSchema: GenEnum; /** - * RaidLevel defines howto mirror two or more block devices + * RaidLevel defines howto mirror two or more block devices. * * @generated from enum metalstack.api.v2.RaidLevel */ export declare enum RaidLevel { /** - * RAID_LEVEL_UNSPECIFIED is not specified + * RAID_LEVEL_UNSPECIFIED is not specified. * * @generated from enum value: RAID_LEVEL_UNSPECIFIED = 0; */ RAID_LEVEL_UNSPECIFIED = 0, /** - * RAID_LEVEL_0 is a stripe of two or more disks + * RAID_LEVEL_0 is a stripe of two or more disks. * * @generated from enum value: RAID_LEVEL_0 = 1; */ RAID_LEVEL_0 = 1, /** - * RAID_LEVEL_1 is a mirror of two disks + * RAID_LEVEL_1 is a mirror of two disks. * * @generated from enum value: RAID_LEVEL_1 = 2; */ diff --git a/js/metalstack/api/v2/filesystem_pb.js b/js/metalstack/api/v2/filesystem_pb.js index e074fe15..41855d75 100644 --- a/js/metalstack/api/v2/filesystem_pb.js +++ b/js/metalstack/api/v2/filesystem_pb.js @@ -77,7 +77,7 @@ export const LogicalVolumeSchema = /*@__PURE__*/ messageDesc(file_metalstack_api export var LVMType; (function (LVMType) { /** - * LVM_TYPE_UNSPECIFIED is not specified + * LVM_TYPE_UNSPECIFIED is not specified. * * @generated from enum value: LVM_TYPE_UNSPECIFIED = 0; */ @@ -106,7 +106,7 @@ export var LVMType; */ export const LVMTypeSchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_filesystem, 0); /** - * Format specifies the filesystem to use on a volume + * Format specifies the filesystem to use on a volume. * * @generated from enum metalstack.api.v2.Format */ @@ -119,31 +119,31 @@ export var Format; */ Format[Format["UNSPECIFIED"] = 0] = "UNSPECIFIED"; /** - * FORMAT_VFAT is used for the UEFI boot partition + * FORMAT_VFAT is used for the UEFI boot partition. * * @generated from enum value: FORMAT_VFAT = 1; */ Format[Format["VFAT"] = 1] = "VFAT"; /** - * FORMAT_EXT3 is usually only used for /boot + * FORMAT_EXT3 is usually only used for /boot. * * @generated from enum value: FORMAT_EXT3 = 2; */ Format[Format["EXT3"] = 2] = "EXT3"; /** - * FORMAT_EXT4 is the default fs + * FORMAT_EXT4 is the default fs. * * @generated from enum value: FORMAT_EXT4 = 3; */ Format[Format["EXT4"] = 3] = "EXT4"; /** - * FORMAT_SWAP is for the swap partition + * FORMAT_SWAP is for the swap partition. * * @generated from enum value: FORMAT_SWAP = 4; */ Format[Format["SWAP"] = 4] = "SWAP"; /** - * FORMAT_TMPFS is used for a memory filesystem typically /tmp + * FORMAT_TMPFS is used for a memory filesystem typically /tmp. * * @generated from enum value: FORMAT_TMPFS = 5; */ @@ -160,14 +160,14 @@ export var Format; */ export const FormatSchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_filesystem, 1); /** - * GPTType specifies the partition type in uefi systems + * GPTType specifies the partition type in uefi systems. * * @generated from enum metalstack.api.v2.GPTType */ export var GPTType; (function (GPTType) { /** - * GPT_TYPE_UNSPECIFIED is no specified + * GPT_TYPE_UNSPECIFIED is no specified. * * @generated from enum value: GPT_TYPE_UNSPECIFIED = 0; */ @@ -202,26 +202,26 @@ export var GPTType; */ export const GPTTypeSchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_filesystem, 2); /** - * RaidLevel defines howto mirror two or more block devices + * RaidLevel defines howto mirror two or more block devices. * * @generated from enum metalstack.api.v2.RaidLevel */ export var RaidLevel; (function (RaidLevel) { /** - * RAID_LEVEL_UNSPECIFIED is not specified + * RAID_LEVEL_UNSPECIFIED is not specified. * * @generated from enum value: RAID_LEVEL_UNSPECIFIED = 0; */ RaidLevel[RaidLevel["RAID_LEVEL_UNSPECIFIED"] = 0] = "RAID_LEVEL_UNSPECIFIED"; /** - * RAID_LEVEL_0 is a stripe of two or more disks + * RAID_LEVEL_0 is a stripe of two or more disks. * * @generated from enum value: RAID_LEVEL_0 = 1; */ RaidLevel[RaidLevel["RAID_LEVEL_0"] = 1] = "RAID_LEVEL_0"; /** - * RAID_LEVEL_1 is a mirror of two disks + * RAID_LEVEL_1 is a mirror of two disks. * * @generated from enum value: RAID_LEVEL_1 = 2; */ diff --git a/js/metalstack/api/v2/filesystem_pb.ts b/js/metalstack/api/v2/filesystem_pb.ts index 9adae361..4493af17 100644 --- a/js/metalstack/api/v2/filesystem_pb.ts +++ b/js/metalstack/api/v2/filesystem_pb.ts @@ -17,7 +17,7 @@ export const file_metalstack_api_v2_filesystem: GenFile = /*@__PURE__*/ fileDesc("CiJtZXRhbHN0YWNrL2FwaS92Mi9maWxlc3lzdGVtLnByb3RvEhFtZXRhbHN0YWNrLmFwaS52MiI2ChtGaWxlc3lzdGVtU2VydmljZUdldFJlcXVlc3QSFwoCaWQYASABKAlCC7pICHIGwLOusQIBIkMKHEZpbGVzeXN0ZW1TZXJ2aWNlTGlzdFJlcXVlc3QSHAoCaWQYASABKAlCC7pICHIGwLOusQIBSACIAQFCBQoDX2lkIl4KHEZpbGVzeXN0ZW1TZXJ2aWNlR2V0UmVzcG9uc2USPgoRZmlsZXN5c3RlbV9sYXlvdXQYASABKAsyIy5tZXRhbHN0YWNrLmFwaS52Mi5GaWxlc3lzdGVtTGF5b3V0ImAKHUZpbGVzeXN0ZW1TZXJ2aWNlTGlzdFJlc3BvbnNlEj8KEmZpbGVzeXN0ZW1fbGF5b3V0cxgBIAMoCzIjLm1ldGFsc3RhY2suYXBpLnYyLkZpbGVzeXN0ZW1MYXlvdXQi7AMKEEZpbGVzeXN0ZW1MYXlvdXQSFwoCaWQYASABKAlCC7pICHIGwLOusQIBEiUKBG1ldGEYAiABKAsyFy5tZXRhbHN0YWNrLmFwaS52Mi5NZXRhEh4KBG5hbWUYAyABKAlCC7pICHIGwLOusQIBSACIAQESJQoLZGVzY3JpcHRpb24YBCABKAlCC7pICHIGyLOusQIBSAGIAQESMgoLZmlsZXN5c3RlbXMYBSADKAsyHS5tZXRhbHN0YWNrLmFwaS52Mi5GaWxlc3lzdGVtEiYKBWRpc2tzGAYgAygLMhcubWV0YWxzdGFjay5hcGkudjIuRGlzaxIlCgRyYWlkGAcgAygLMhcubWV0YWxzdGFjay5hcGkudjIuUmFpZBI1Cg12b2x1bWVfZ3JvdXBzGAggAygLMh4ubWV0YWxzdGFjay5hcGkudjIuVm9sdW1lR3JvdXASOQoPbG9naWNhbF92b2x1bWVzGAkgAygLMiAubWV0YWxzdGFjay5hcGkudjIuTG9naWNhbFZvbHVtZRJDCgtjb25zdHJhaW50cxgKIAEoCzIuLm1ldGFsc3RhY2suYXBpLnYyLkZpbGVzeXN0ZW1MYXlvdXRDb25zdHJhaW50c0IHCgVfbmFtZUIOCgxfZGVzY3JpcHRpb24ipwEKG0ZpbGVzeXN0ZW1MYXlvdXRDb25zdHJhaW50cxINCgVzaXplcxgBIAMoCRJKCgZpbWFnZXMYAiADKAsyOi5tZXRhbHN0YWNrLmFwaS52Mi5GaWxlc3lzdGVtTGF5b3V0Q29uc3RyYWludHMuSW1hZ2VzRW50cnkaLQoLSW1hZ2VzRW50cnkSCwoDa2V5GAEgASgJEg0KBXZhbHVlGAIgASgJOgI4ASL1AgoKRmlsZXN5c3RlbRIbCgZkZXZpY2UYASABKAlCC7pICHIGwLOusQIBEjYKBmZvcm1hdBgCIAEoDjIZLm1ldGFsc3RhY2suYXBpLnYyLkZvcm1hdEILukgIyAEBggECEAESHgoEbmFtZRgDIAEoCUILukgIcgbAs66xAgFIAIgBARIlCgtkZXNjcmlwdGlvbhgEIAEoCUILukgIcgbIs66xAgFIAYgBARIdCgRwYXRoGAUgASgJQgq6SAdyBRABGIAgSAKIAQESJQoFbGFiZWwYBiABKAlCEbpIDnIMwLOusQIB8LOusQIBSAOIAQESKwoNbW91bnRfb3B0aW9ucxgHIAMoCUIUukgRkgEOECAYASIIcgaAtK6xAgESLAoOY3JlYXRlX29wdGlvbnMYCCADKAlCFLpIEZIBDhAgGAEiCHIGgLSusQIBQgcKBV9uYW1lQg4KDF9kZXNjcmlwdGlvbkIHCgVfcGF0aEIICgZfbGFiZWwiXwoERGlzaxIhCgZkZXZpY2UYASABKAlCEbpIDnIMwLOusQIB8LOusQIBEjQKCnBhcnRpdGlvbnMYAiADKAsyIC5tZXRhbHN0YWNrLmFwaS52Mi5EaXNrUGFydGl0aW9uItEBCgRSYWlkEiUKCmFycmF5X25hbWUYASABKAlCEbpIDnIMwLOusQIB8LOusQIBEioKB2RldmljZXMYAiADKAlCGbpIFpIBE9Cks7ECARCAASIIcgbAs66xAgESOAoFbGV2ZWwYAyABKA4yHC5tZXRhbHN0YWNrLmFwaS52Mi5SYWlkTGV2ZWxCC7pICMgBAYIBAhABEiwKDmNyZWF0ZV9vcHRpb25zGAQgAygJQhS6SBGSAQ4QIBgBIghyBoC0rrECARIOCgZzcGFyZXMYBSABKAUiqwEKDURpc2tQYXJ0aXRpb24SDgoGbnVtYmVyGAEgASgNEiUKBWxhYmVsGAIgASgJQhG6SA5yDMCzrrECAfCzrrECAUgAiAEBEgwKBHNpemUYAyABKAQSPgoIZ3B0X3R5cGUYBCABKA4yGi5tZXRhbHN0YWNrLmFwaS52Mi5HUFRUeXBlQgu6SAjIAQGCAQIQAUgBiAEBQggKBl9sYWJlbEILCglfZ3B0X3R5cGUifQoLVm9sdW1lR3JvdXASGQoEbmFtZRgBIAEoCUILukgIcgbAs66xAgESKgoHZGV2aWNlcxgCIAMoCUIZukgWkgET0KSzsQIBEIABIghyBsCzrrECARInCgR0YWdzGAMgAygJQhm6SBaSARPQpLOxAgEQgAEiCHIGwLOusQIBIpMBCg1Mb2dpY2FsVm9sdW1lEhkKBG5hbWUYASABKAlCC7pICHIGwLOusQIBEiEKDHZvbHVtZV9ncm91cBgCIAEoCUILukgIcgbAs66xAgESDAoEc2l6ZRgDIAEoBBI2Cghsdm1fdHlwZRgEIAEoDjIaLm1ldGFsc3RhY2suYXBpLnYyLkxWTVR5cGVCCLpIBYIBAhABKoYBCgdMVk1UeXBlEhgKFExWTV9UWVBFX1VOU1BFQ0lGSUVEEAASHwoPTFZNX1RZUEVfTElORUFSEAEaCoKyGQZsaW5lYXISIQoQTFZNX1RZUEVfU1RSSVBFRBACGguCshkHc3RyaXBlZBIdCg5MVk1fVFlQRV9SQUlEMRADGgmCshkFcmFpZDEqxAEKBkZvcm1hdBIWChJGT1JNQVRfVU5TUEVDSUZJRUQQABIZCgtGT1JNQVRfVkZBVBABGgiCshkEdmZhdBIZCgtGT1JNQVRfRVhUMxACGgiCshkEZXh0MxIZCgtGT1JNQVRfRVhUNBADGgiCshkEZXh0NBIZCgtGT1JNQVRfU1dBUBAEGgiCshkEc3dhcBIbCgxGT1JNQVRfVE1QRlMQBRoJgrIZBXRtcGZzEhkKC0ZPUk1BVF9OT05FEAYaCIKyGQRub25lKqMBCgdHUFRUeXBlEhgKFEdQVF9UWVBFX1VOU1BFQ0lGSUVEEAASGwoNR1BUX1RZUEVfQk9PVBABGgiCshkEZWYwMBIcCg5HUFRfVFlQRV9MSU5VWBACGgiCshkEODMwMBIhChNHUFRfVFlQRV9MSU5VWF9SQUlEEAMaCIKyGQRmZDAwEiAKEkdQVF9UWVBFX0xJTlVYX0xWTRAEGgiCshkEOGUwMCpZCglSYWlkTGV2ZWwSGgoWUkFJRF9MRVZFTF9VTlNQRUNJRklFRBAAEhcKDFJBSURfTEVWRUxfMBABGgWCshkBMBIXCgxSQUlEX0xFVkVMXzEQAhoFgrIZATEy+gEKEUZpbGVzeXN0ZW1TZXJ2aWNlEnAKA0dldBIuLm1ldGFsc3RhY2suYXBpLnYyLkZpbGVzeXN0ZW1TZXJ2aWNlR2V0UmVxdWVzdBovLm1ldGFsc3RhY2suYXBpLnYyLkZpbGVzeXN0ZW1TZXJ2aWNlR2V0UmVzcG9uc2UiCNjzGALg8xgCEnMKBExpc3QSLy5tZXRhbHN0YWNrLmFwaS52Mi5GaWxlc3lzdGVtU2VydmljZUxpc3RSZXF1ZXN0GjAubWV0YWxzdGFjay5hcGkudjIuRmlsZXN5c3RlbVNlcnZpY2VMaXN0UmVzcG9uc2UiCNjzGALg8xgCQsUBChVjb20ubWV0YWxzdGFjay5hcGkudjJCD0ZpbGVzeXN0ZW1Qcm90b1ABWjVnaXRodWIuY29tL21ldGFsLXN0YWNrL2FwaS9nby9tZXRhbHN0YWNrL2FwaS92MjthcGl2MqICA01BWKoCEU1ldGFsc3RhY2suQXBpLlYyygIRTWV0YWxzdGFja1xBcGlcVjLiAh1NZXRhbHN0YWNrXEFwaVxWMlxHUEJNZXRhZGF0YeoCE01ldGFsc3RhY2s6OkFwaTo6VjJiBnByb3RvMw", [file_buf_validate_validate, file_metalstack_api_v2_common, file_metalstack_api_v2_predefined_rules]); /** - * FilesystemServiceGetRequest is the request payload for a filesystem get request + * FilesystemServiceGetRequest is the request payload for a filesystem get request. * * @generated from message metalstack.api.v2.FilesystemServiceGetRequest */ @@ -38,7 +38,7 @@ export const FilesystemServiceGetRequestSchema: GenMessage & { description?: string | undefined; /** - * Filesystems is a list of filesystems to create on a machine + * Filesystems is a list of filesystems to create on a machine. * * @generated from field: repeated metalstack.api.v2.Filesystem filesystems = 5; */ filesystems: Filesystem[]; /** - * Disks list of disks that belong to this layout + * Disks list of disks that belong to this layout. * * @generated from field: repeated metalstack.api.v2.Disk disks = 6; */ @@ -156,14 +156,14 @@ export type FilesystemLayout = Message<"metalstack.api.v2.FilesystemLayout"> & { raid: Raid[]; /** - * VolumeGroups list of volumegroups to create + * VolumeGroups list of volumegroups to create. * * @generated from field: repeated metalstack.api.v2.VolumeGroup volume_groups = 8; */ volumeGroups: VolumeGroup[]; /** - * LogicalVolumes list of logicalvolumes to create + * LogicalVolumes list of logicalvolumes to create. * * @generated from field: repeated metalstack.api.v2.LogicalVolume logical_volumes = 9; */ @@ -191,7 +191,7 @@ export const FilesystemLayoutSchema: GenMessage = /*@__PURE__* */ export type FilesystemLayoutConstraints = Message<"metalstack.api.v2.FilesystemLayoutConstraints"> & { /** - * Sizes list of sizes this layout applies to + * Sizes list of sizes this layout applies to. * this could either be a concrete size, or a asterisk to match all sizes * * @generated from field: repeated string sizes = 1; @@ -199,7 +199,7 @@ export type FilesystemLayoutConstraints = Message<"metalstack.api.v2.FilesystemL sizes: string[]; /** - * Images list of images this layout applies to in the following form + * Images list of images this layout applies to in the following form. * key must be the first part of available images, e.g. the name of the image * value must be a semver match expression with the constraint and the version separated by space * this would match all debian images which are greater or equal 12.0 @@ -301,7 +301,7 @@ export type Disk = Message<"metalstack.api.v2.Disk"> & { device: string; /** - * Partitions list of partitions to create on this disk + * Partitions list of partitions to create on this disk. * * @generated from field: repeated metalstack.api.v2.DiskPartition partitions = 2; */ @@ -329,14 +329,14 @@ export type Raid = Message<"metalstack.api.v2.Raid"> & { arrayName: string; /** - * Devices list of devices to form the raid array from + * Devices list of devices to form the raid array from. * * @generated from field: repeated string devices = 2; */ devices: string[]; /** - * Level raid level to create, should be 0 or 1 + * Level raid level to create, should be 0 or 1. * * @generated from field: metalstack.api.v2.RaidLevel level = 3; */ @@ -371,7 +371,7 @@ export const RaidSchema: GenMessage = /*@__PURE__*/ */ export type DiskPartition = Message<"metalstack.api.v2.DiskPartition"> & { /** - * Number partition number, will be appended to partitionprefix to create the final devicename + * Number partition number, will be appended to partitionprefix to create the final devicename. * * @generated from field: uint32 number = 1; */ @@ -420,14 +420,14 @@ export type VolumeGroup = Message<"metalstack.api.v2.VolumeGroup"> & { name: string; /** - * Devices list of devices to form the volume group from + * Devices list of devices to form the volume group from. * * @generated from field: repeated string devices = 2; */ devices: string[]; /** - * Tags list of tags to add to the volume group + * Tags list of tags to add to the volume group. * * @generated from field: repeated string tags = 3; */ @@ -490,7 +490,7 @@ export const LogicalVolumeSchema: GenMessage = /*@__PURE__*/ */ export enum LVMType { /** - * LVM_TYPE_UNSPECIFIED is not specified + * LVM_TYPE_UNSPECIFIED is not specified. * * @generated from enum value: LVM_TYPE_UNSPECIFIED = 0; */ @@ -525,7 +525,7 @@ export const LVMTypeSchema: GenEnum = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_filesystem, 0); /** - * Format specifies the filesystem to use on a volume + * Format specifies the filesystem to use on a volume. * * @generated from enum metalstack.api.v2.Format */ @@ -538,35 +538,35 @@ export enum Format { UNSPECIFIED = 0, /** - * FORMAT_VFAT is used for the UEFI boot partition + * FORMAT_VFAT is used for the UEFI boot partition. * * @generated from enum value: FORMAT_VFAT = 1; */ VFAT = 1, /** - * FORMAT_EXT3 is usually only used for /boot + * FORMAT_EXT3 is usually only used for /boot. * * @generated from enum value: FORMAT_EXT3 = 2; */ EXT3 = 2, /** - * FORMAT_EXT4 is the default fs + * FORMAT_EXT4 is the default fs. * * @generated from enum value: FORMAT_EXT4 = 3; */ EXT4 = 3, /** - * FORMAT_SWAP is for the swap partition + * FORMAT_SWAP is for the swap partition. * * @generated from enum value: FORMAT_SWAP = 4; */ SWAP = 4, /** - * FORMAT_TMPFS is used for a memory filesystem typically /tmp + * FORMAT_TMPFS is used for a memory filesystem typically /tmp. * * @generated from enum value: FORMAT_TMPFS = 5; */ @@ -587,13 +587,13 @@ export const FormatSchema: GenEnum = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_filesystem, 1); /** - * GPTType specifies the partition type in uefi systems + * GPTType specifies the partition type in uefi systems. * * @generated from enum metalstack.api.v2.GPTType */ export enum GPTType { /** - * GPT_TYPE_UNSPECIFIED is no specified + * GPT_TYPE_UNSPECIFIED is no specified. * * @generated from enum value: GPT_TYPE_UNSPECIFIED = 0; */ @@ -635,27 +635,27 @@ export const GPTTypeSchema: GenEnum = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_filesystem, 2); /** - * RaidLevel defines howto mirror two or more block devices + * RaidLevel defines howto mirror two or more block devices. * * @generated from enum metalstack.api.v2.RaidLevel */ export enum RaidLevel { /** - * RAID_LEVEL_UNSPECIFIED is not specified + * RAID_LEVEL_UNSPECIFIED is not specified. * * @generated from enum value: RAID_LEVEL_UNSPECIFIED = 0; */ RAID_LEVEL_UNSPECIFIED = 0, /** - * RAID_LEVEL_0 is a stripe of two or more disks + * RAID_LEVEL_0 is a stripe of two or more disks. * * @generated from enum value: RAID_LEVEL_0 = 1; */ RAID_LEVEL_0 = 1, /** - * RAID_LEVEL_1 is a mirror of two disks + * RAID_LEVEL_1 is a mirror of two disks. * * @generated from enum value: RAID_LEVEL_1 = 2; */ diff --git a/js/metalstack/api/v2/health_pb.d.ts b/js/metalstack/api/v2/health_pb.d.ts index cda94c85..5152f4ae 100644 --- a/js/metalstack/api/v2/health_pb.d.ts +++ b/js/metalstack/api/v2/health_pb.d.ts @@ -11,7 +11,7 @@ export declare const file_metalstack_api_v2_health: GenFile; */ export type Health = Message<"metalstack.api.v2.Health"> & { /** - * Services contains the health of all individual services + * Services contains the health of all individual services. * * @generated from field: repeated metalstack.api.v2.HealthStatus services = 1; */ @@ -29,25 +29,25 @@ export declare const HealthSchema: GenMessage; */ export type HealthStatus = Message<"metalstack.api.v2.HealthStatus"> & { /** - * Name is the name of the service + * Name is the name of the service. * * @generated from field: metalstack.api.v2.Service name = 1; */ name: Service; /** - * Status is the status of this service + * Status is the status of this service. * * @generated from field: metalstack.api.v2.ServiceStatus status = 2; */ status: ServiceStatus; /** - * Message describes the reason for the unhealthy status if possible + * Message describes the reason for the unhealthy status if possible. * * @generated from field: string message = 3; */ message: string; /** - * Partitions describes the health of the service by partition + * Partitions describes the health of the service by partition. * * @generated from field: map partitions = 4; */ @@ -67,13 +67,13 @@ export declare const HealthStatusSchema: GenMessage; */ export type PartitionHealth = Message<"metalstack.api.v2.PartitionHealth"> & { /** - * Status is the health status of the service in this partition + * Status is the health status of the service in this partition. * * @generated from field: metalstack.api.v2.ServiceStatus status = 1; */ status: ServiceStatus; /** - * Message describes the reason for the unhealthy status if possible + * Message describes the reason for the unhealthy status if possible. * * @generated from field: string message = 2; */ @@ -102,7 +102,7 @@ export declare const HealthServiceGetRequestSchema: GenMessage & { /** - * Health contains the overall health of the system + * Health contains the overall health of the system. * * @generated from field: metalstack.api.v2.Health health = 1; */ @@ -155,7 +155,7 @@ export declare const ServiceStatusSchema: GenEnum; */ export declare enum Service { /** - * SERVICE_UNSPECIFIED is a unknown service + * SERVICE_UNSPECIFIED is a unknown service. * * @generated from enum value: SERVICE_UNSPECIFIED = 0; */ diff --git a/js/metalstack/api/v2/health_pb.js b/js/metalstack/api/v2/health_pb.js index d914e708..8c11dd6d 100644 --- a/js/metalstack/api/v2/health_pb.js +++ b/js/metalstack/api/v2/health_pb.js @@ -76,7 +76,7 @@ export const ServiceStatusSchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2 export var Service; (function (Service) { /** - * SERVICE_UNSPECIFIED is a unknown service + * SERVICE_UNSPECIFIED is a unknown service. * * @generated from enum value: SERVICE_UNSPECIFIED = 0; */ diff --git a/js/metalstack/api/v2/health_pb.ts b/js/metalstack/api/v2/health_pb.ts index 05d9a891..b6ac4d00 100644 --- a/js/metalstack/api/v2/health_pb.ts +++ b/js/metalstack/api/v2/health_pb.ts @@ -20,7 +20,7 @@ export const file_metalstack_api_v2_health: GenFile = /*@__PURE__*/ */ export type Health = Message<"metalstack.api.v2.Health"> & { /** - * Services contains the health of all individual services + * Services contains the health of all individual services. * * @generated from field: repeated metalstack.api.v2.HealthStatus services = 1; */ @@ -41,28 +41,28 @@ export const HealthSchema: GenMessage = /*@__PURE__*/ */ export type HealthStatus = Message<"metalstack.api.v2.HealthStatus"> & { /** - * Name is the name of the service + * Name is the name of the service. * * @generated from field: metalstack.api.v2.Service name = 1; */ name: Service; /** - * Status is the status of this service + * Status is the status of this service. * * @generated from field: metalstack.api.v2.ServiceStatus status = 2; */ status: ServiceStatus; /** - * Message describes the reason for the unhealthy status if possible + * Message describes the reason for the unhealthy status if possible. * * @generated from field: string message = 3; */ message: string; /** - * Partitions describes the health of the service by partition + * Partitions describes the health of the service by partition. * * @generated from field: map partitions = 4; */ @@ -83,14 +83,14 @@ export const HealthStatusSchema: GenMessage = /*@__PURE__*/ */ export type PartitionHealth = Message<"metalstack.api.v2.PartitionHealth"> & { /** - * Status is the health status of the service in this partition + * Status is the health status of the service in this partition. * * @generated from field: metalstack.api.v2.ServiceStatus status = 1; */ status: ServiceStatus; /** - * Message describes the reason for the unhealthy status if possible + * Message describes the reason for the unhealthy status if possible. * * @generated from field: string message = 2; */ @@ -126,7 +126,7 @@ export const HealthServiceGetRequestSchema: GenMessage */ export type HealthServiceGetResponse = Message<"metalstack.api.v2.HealthServiceGetResponse"> & { /** - * Health contains the overall health of the system + * Health contains the overall health of the system. * * @generated from field: metalstack.api.v2.Health health = 1; */ @@ -188,7 +188,7 @@ export const ServiceStatusSchema: GenEnum = /*@__PURE__*/ */ export enum Service { /** - * SERVICE_UNSPECIFIED is a unknown service + * SERVICE_UNSPECIFIED is a unknown service. * * @generated from enum value: SERVICE_UNSPECIFIED = 0; */ diff --git a/js/metalstack/api/v2/image_pb.d.ts b/js/metalstack/api/v2/image_pb.d.ts index 8b66849e..8fd48081 100644 --- a/js/metalstack/api/v2/image_pb.d.ts +++ b/js/metalstack/api/v2/image_pb.d.ts @@ -7,7 +7,7 @@ import type { Message } from "@bufbuild/protobuf"; */ export declare const file_metalstack_api_v2_image: GenFile; /** - * ImageServiceGetRequest is the request payload for an image get request + * ImageServiceGetRequest is the request payload for an image get request. * * @generated from message metalstack.api.v2.ImageServiceGetRequest */ @@ -25,13 +25,13 @@ export type ImageServiceGetRequest = Message<"metalstack.api.v2.ImageServiceGetR */ export declare const ImageServiceGetRequestSchema: GenMessage; /** - * ImageServiceListRequest is the request payload for an image list request + * ImageServiceListRequest is the request payload for an image list request. * * @generated from message metalstack.api.v2.ImageServiceListRequest */ export type ImageServiceListRequest = Message<"metalstack.api.v2.ImageServiceListRequest"> & { /** - * Query for images + * Query for images. * * @generated from field: metalstack.api.v2.ImageQuery query = 1; */ @@ -43,7 +43,7 @@ export type ImageServiceListRequest = Message<"metalstack.api.v2.ImageServiceLis */ export declare const ImageServiceListRequestSchema: GenMessage; /** - * ImageServiceLatestRequest is the request payload for an image latest request + * ImageServiceLatestRequest is the request payload for an image latest request. * * @generated from message metalstack.api.v2.ImageServiceLatestRequest */ @@ -68,7 +68,7 @@ export type ImageServiceLatestRequest = Message<"metalstack.api.v2.ImageServiceL */ export declare const ImageServiceLatestRequestSchema: GenMessage; /** - * ImageServiceGetResponse is the response payload for an image get request + * ImageServiceGetResponse is the response payload for an image get request. * * @generated from message metalstack.api.v2.ImageServiceGetResponse */ @@ -86,7 +86,7 @@ export type ImageServiceGetResponse = Message<"metalstack.api.v2.ImageServiceGet */ export declare const ImageServiceGetResponseSchema: GenMessage; /** - * ImageServiceListResponse is the response payload for an image list request + * ImageServiceListResponse is the response payload for an image list request. * * @generated from message metalstack.api.v2.ImageServiceListResponse */ @@ -104,7 +104,7 @@ export type ImageServiceListResponse = Message<"metalstack.api.v2.ImageServiceLi */ export declare const ImageServiceListResponseSchema: GenMessage; /** - * ImageServiceLatestResponse is the response payload for an image latest request + * ImageServiceLatestResponse is the response payload for an image latest request. * * @generated from message metalstack.api.v2.ImageServiceLatestResponse */ @@ -170,7 +170,7 @@ export type Image = Message<"metalstack.api.v2.Image"> & { */ classification: ImageClassification; /** - * ExpiresAt usage is not possible after this date + * ExpiresAt usage is not possible after this date. * * @generated from field: google.protobuf.Timestamp expires_at = 8; */ @@ -182,7 +182,7 @@ export type Image = Message<"metalstack.api.v2.Image"> & { */ export declare const ImageSchema: GenMessage; /** - * ImageUsage reports which machines/firewalls actually use this image + * ImageUsage reports which machines/firewalls actually use this image. * * @generated from message metalstack.api.v2.ImageUsage */ @@ -206,7 +206,7 @@ export type ImageUsage = Message<"metalstack.api.v2.ImageUsage"> & { */ export declare const ImageUsageSchema: GenMessage; /** - * ImageQuery is used to search images + * ImageQuery is used to search images. * * @generated from message metalstack.api.v2.ImageQuery */ @@ -260,7 +260,7 @@ export type ImageQuery = Message<"metalstack.api.v2.ImageQuery"> & { */ classification?: ImageClassification | undefined; /** - * Labels lists only images containing the given labels + * Labels lists only images containing the given labels. * * @generated from field: optional metalstack.api.v2.Labels labels = 9; */ @@ -278,19 +278,19 @@ export declare const ImageQuerySchema: GenMessage; */ export declare enum ImageFeature { /** - * IMAGE_FEATURE_UNSPECIFIED is not specified + * IMAGE_FEATURE_UNSPECIFIED is not specified. * * @generated from enum value: IMAGE_FEATURE_UNSPECIFIED = 0; */ UNSPECIFIED = 0, /** - * IMAGE_FEATURE_MACHINE indicates this image is usable for a machine + * IMAGE_FEATURE_MACHINE indicates this image is usable for a machine. * * @generated from enum value: IMAGE_FEATURE_MACHINE = 1; */ MACHINE = 1, /** - * IMAGE_FEATURE_FIREWALL indicates this image is usable for a firewall + * IMAGE_FEATURE_FIREWALL indicates this image is usable for a firewall. * * @generated from enum value: IMAGE_FEATURE_FIREWALL = 2; */ @@ -307,25 +307,25 @@ export declare const ImageFeatureSchema: GenEnum; */ export declare enum ImageClassification { /** - * IMAGE_CLASSIFICATION_UNSPECIFIED is not specified + * IMAGE_CLASSIFICATION_UNSPECIFIED is not specified. * * @generated from enum value: IMAGE_CLASSIFICATION_UNSPECIFIED = 0; */ UNSPECIFIED = 0, /** - * IMAGE_CLASSIFICATION_PREVIEW indicates that this image is in preview + * IMAGE_CLASSIFICATION_PREVIEW indicates that this image is in preview. * * @generated from enum value: IMAGE_CLASSIFICATION_PREVIEW = 1; */ PREVIEW = 1, /** - * IMAGE_CLASSIFICATION_SUPPORTED indicates that this image is supported + * IMAGE_CLASSIFICATION_SUPPORTED indicates that this image is supported. * * @generated from enum value: IMAGE_CLASSIFICATION_SUPPORTED = 2; */ SUPPORTED = 2, /** - * IMAGE_CLASSIFICATION_DEPRECATED indicates that this image is deprecated + * IMAGE_CLASSIFICATION_DEPRECATED indicates that this image is deprecated. * * @generated from enum value: IMAGE_CLASSIFICATION_DEPRECATED = 3; */ diff --git a/js/metalstack/api/v2/image_pb.js b/js/metalstack/api/v2/image_pb.js index 9728f7df..8d3f45bf 100644 --- a/js/metalstack/api/v2/image_pb.js +++ b/js/metalstack/api/v2/image_pb.js @@ -63,19 +63,19 @@ export const ImageQuerySchema = /*@__PURE__*/ messageDesc(file_metalstack_api_v2 export var ImageFeature; (function (ImageFeature) { /** - * IMAGE_FEATURE_UNSPECIFIED is not specified + * IMAGE_FEATURE_UNSPECIFIED is not specified. * * @generated from enum value: IMAGE_FEATURE_UNSPECIFIED = 0; */ ImageFeature[ImageFeature["UNSPECIFIED"] = 0] = "UNSPECIFIED"; /** - * IMAGE_FEATURE_MACHINE indicates this image is usable for a machine + * IMAGE_FEATURE_MACHINE indicates this image is usable for a machine. * * @generated from enum value: IMAGE_FEATURE_MACHINE = 1; */ ImageFeature[ImageFeature["MACHINE"] = 1] = "MACHINE"; /** - * IMAGE_FEATURE_FIREWALL indicates this image is usable for a firewall + * IMAGE_FEATURE_FIREWALL indicates this image is usable for a firewall. * * @generated from enum value: IMAGE_FEATURE_FIREWALL = 2; */ @@ -93,25 +93,25 @@ export const ImageFeatureSchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_ export var ImageClassification; (function (ImageClassification) { /** - * IMAGE_CLASSIFICATION_UNSPECIFIED is not specified + * IMAGE_CLASSIFICATION_UNSPECIFIED is not specified. * * @generated from enum value: IMAGE_CLASSIFICATION_UNSPECIFIED = 0; */ ImageClassification[ImageClassification["UNSPECIFIED"] = 0] = "UNSPECIFIED"; /** - * IMAGE_CLASSIFICATION_PREVIEW indicates that this image is in preview + * IMAGE_CLASSIFICATION_PREVIEW indicates that this image is in preview. * * @generated from enum value: IMAGE_CLASSIFICATION_PREVIEW = 1; */ ImageClassification[ImageClassification["PREVIEW"] = 1] = "PREVIEW"; /** - * IMAGE_CLASSIFICATION_SUPPORTED indicates that this image is supported + * IMAGE_CLASSIFICATION_SUPPORTED indicates that this image is supported. * * @generated from enum value: IMAGE_CLASSIFICATION_SUPPORTED = 2; */ ImageClassification[ImageClassification["SUPPORTED"] = 2] = "SUPPORTED"; /** - * IMAGE_CLASSIFICATION_DEPRECATED indicates that this image is deprecated + * IMAGE_CLASSIFICATION_DEPRECATED indicates that this image is deprecated. * * @generated from enum value: IMAGE_CLASSIFICATION_DEPRECATED = 3; */ diff --git a/js/metalstack/api/v2/image_pb.ts b/js/metalstack/api/v2/image_pb.ts index bb4f4fc8..c509ceb6 100644 --- a/js/metalstack/api/v2/image_pb.ts +++ b/js/metalstack/api/v2/image_pb.ts @@ -19,7 +19,7 @@ export const file_metalstack_api_v2_image: GenFile = /*@__PURE__*/ fileDesc("Ch1tZXRhbHN0YWNrL2FwaS92Mi9pbWFnZS5wcm90bxIRbWV0YWxzdGFjay5hcGkudjIiMQoWSW1hZ2VTZXJ2aWNlR2V0UmVxdWVzdBIXCgJpZBgBIAEoCUILukgIcgbAs66xAgEiRwoXSW1hZ2VTZXJ2aWNlTGlzdFJlcXVlc3QSLAoFcXVlcnkYASABKAsyHS5tZXRhbHN0YWNrLmFwaS52Mi5JbWFnZVF1ZXJ5IokBChlJbWFnZVNlcnZpY2VMYXRlc3RSZXF1ZXN0EgoKAm9zGAEgASgJEk0KDmNsYXNzaWZpY2F0aW9uGAIgASgOMiYubWV0YWxzdGFjay5hcGkudjIuSW1hZ2VDbGFzc2lmaWNhdGlvbkIIukgFggECEAFIAIgBAUIRCg9fY2xhc3NpZmljYXRpb24iQgoXSW1hZ2VTZXJ2aWNlR2V0UmVzcG9uc2USJwoFaW1hZ2UYASABKAsyGC5tZXRhbHN0YWNrLmFwaS52Mi5JbWFnZSJEChhJbWFnZVNlcnZpY2VMaXN0UmVzcG9uc2USKAoGaW1hZ2VzGAEgAygLMhgubWV0YWxzdGFjay5hcGkudjIuSW1hZ2UiRQoaSW1hZ2VTZXJ2aWNlTGF0ZXN0UmVzcG9uc2USJwoFaW1hZ2UYASABKAsyGC5tZXRhbHN0YWNrLmFwaS52Mi5JbWFnZSL/AgoFSW1hZ2USFwoCaWQYASABKAlCC7pICHIGwLOusQIBEiUKBG1ldGEYAiABKAsyFy5tZXRhbHN0YWNrLmFwaS52Mi5NZXRhEhgKA3VybBgDIAEoCUILukgIcgbgs66xAgESHgoEbmFtZRgEIAEoCUILukgIcgbAs66xAgFIAIgBARIlCgtkZXNjcmlwdGlvbhgFIAEoCUILukgIcgbIs66xAgFIAYgBARJCCghmZWF0dXJlcxgGIAMoDjIfLm1ldGFsc3RhY2suYXBpLnYyLkltYWdlRmVhdHVyZUIPukgMkgEJGAEiBYIBAhABEkgKDmNsYXNzaWZpY2F0aW9uGAcgASgOMiYubWV0YWxzdGFjay5hcGkudjIuSW1hZ2VDbGFzc2lmaWNhdGlvbkIIukgFggECEAESLgoKZXhwaXJlc19hdBgIIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5UaW1lc3RhbXBCBwoFX25hbWVCDgoMX2Rlc2NyaXB0aW9uIkYKCkltYWdlVXNhZ2USJwoFaW1hZ2UYASABKAsyGC5tZXRhbHN0YWNrLmFwaS52Mi5JbWFnZRIPCgd1c2VkX2J5GAIgAygJIvQDCgpJbWFnZVF1ZXJ5EhwKAmlkGAEgASgJQgu6SAhyBsCzrrECAUgAiAEBEhsKAm9zGAIgASgJQgq6SAdyBRACGIABSAGIAQESIAoHdmVyc2lvbhgDIAEoCUIKukgHcgUQARiAAUgCiAEBEh4KBG5hbWUYBCABKAlCC7pICHIGwLOusQIBSAOIAQESJQoLZGVzY3JpcHRpb24YBSABKAlCC7pICHIGyLOusQIBSASIAQESHQoDdXJsGAYgASgJQgu6SAhyBuCzrrECAUgFiAEBEj8KB2ZlYXR1cmUYByABKA4yHy5tZXRhbHN0YWNrLmFwaS52Mi5JbWFnZUZlYXR1cmVCCLpIBYIBAhABSAaIAQESTQoOY2xhc3NpZmljYXRpb24YCCABKA4yJi5tZXRhbHN0YWNrLmFwaS52Mi5JbWFnZUNsYXNzaWZpY2F0aW9uQgi6SAWCAQIQAUgHiAEBEi4KBmxhYmVscxgJIAEoCzIZLm1ldGFsc3RhY2suYXBpLnYyLkxhYmVsc0gIiAEBQgUKA19pZEIFCgNfb3NCCgoIX3ZlcnNpb25CBwoFX25hbWVCDgoMX2Rlc2NyaXB0aW9uQgYKBF91cmxCCgoIX2ZlYXR1cmVCEQoPX2NsYXNzaWZpY2F0aW9uQgkKB19sYWJlbHMqfwoMSW1hZ2VGZWF0dXJlEh0KGUlNQUdFX0ZFQVRVUkVfVU5TUEVDSUZJRUQQABImChVJTUFHRV9GRUFUVVJFX01BQ0hJTkUQARoLgrIZB21hY2hpbmUSKAoWSU1BR0VfRkVBVFVSRV9GSVJFV0FMTBACGgyCshkIZmlyZXdhbGwq0gEKE0ltYWdlQ2xhc3NpZmljYXRpb24SJAogSU1BR0VfQ0xBU1NJRklDQVRJT05fVU5TUEVDSUZJRUQQABItChxJTUFHRV9DTEFTU0lGSUNBVElPTl9QUkVWSUVXEAEaC4KyGQdwcmV2aWV3EjEKHklNQUdFX0NMQVNTSUZJQ0FUSU9OX1NVUFBPUlRFRBACGg2CshkJc3VwcG9ydGVkEjMKH0lNQUdFX0NMQVNTSUZJQ0FUSU9OX0RFUFJFQ0FURUQQAxoOgrIZCmRlcHJlY2F0ZWQy0gIKDEltYWdlU2VydmljZRJmCgNHZXQSKS5tZXRhbHN0YWNrLmFwaS52Mi5JbWFnZVNlcnZpY2VHZXRSZXF1ZXN0GioubWV0YWxzdGFjay5hcGkudjIuSW1hZ2VTZXJ2aWNlR2V0UmVzcG9uc2UiCNjzGALg8xgCEmkKBExpc3QSKi5tZXRhbHN0YWNrLmFwaS52Mi5JbWFnZVNlcnZpY2VMaXN0UmVxdWVzdBorLm1ldGFsc3RhY2suYXBpLnYyLkltYWdlU2VydmljZUxpc3RSZXNwb25zZSII2PMYAuDzGAISbwoGTGF0ZXN0EiwubWV0YWxzdGFjay5hcGkudjIuSW1hZ2VTZXJ2aWNlTGF0ZXN0UmVxdWVzdBotLm1ldGFsc3RhY2suYXBpLnYyLkltYWdlU2VydmljZUxhdGVzdFJlc3BvbnNlIgjY8xgC4PMYAkLAAQoVY29tLm1ldGFsc3RhY2suYXBpLnYyQgpJbWFnZVByb3RvUAFaNWdpdGh1Yi5jb20vbWV0YWwtc3RhY2svYXBpL2dvL21ldGFsc3RhY2svYXBpL3YyO2FwaXYyogIDTUFYqgIRTWV0YWxzdGFjay5BcGkuVjLKAhFNZXRhbHN0YWNrXEFwaVxWMuICHU1ldGFsc3RhY2tcQXBpXFYyXEdQQk1ldGFkYXRh6gITTWV0YWxzdGFjazo6QXBpOjpWMmIGcHJvdG8z", [file_buf_validate_validate, file_google_protobuf_timestamp, file_metalstack_api_v2_common, file_metalstack_api_v2_predefined_rules]); /** - * ImageServiceGetRequest is the request payload for an image get request + * ImageServiceGetRequest is the request payload for an image get request. * * @generated from message metalstack.api.v2.ImageServiceGetRequest */ @@ -40,13 +40,13 @@ export const ImageServiceGetRequestSchema: GenMessage = messageDesc(file_metalstack_api_v2_image, 0); /** - * ImageServiceListRequest is the request payload for an image list request + * ImageServiceListRequest is the request payload for an image list request. * * @generated from message metalstack.api.v2.ImageServiceListRequest */ export type ImageServiceListRequest = Message<"metalstack.api.v2.ImageServiceListRequest"> & { /** - * Query for images + * Query for images. * * @generated from field: metalstack.api.v2.ImageQuery query = 1; */ @@ -61,7 +61,7 @@ export const ImageServiceListRequestSchema: GenMessage messageDesc(file_metalstack_api_v2_image, 1); /** - * ImageServiceLatestRequest is the request payload for an image latest request + * ImageServiceLatestRequest is the request payload for an image latest request. * * @generated from message metalstack.api.v2.ImageServiceLatestRequest */ @@ -90,7 +90,7 @@ export const ImageServiceLatestRequestSchema: GenMessage messageDesc(file_metalstack_api_v2_image, 3); /** - * ImageServiceListResponse is the response payload for an image list request + * ImageServiceListResponse is the response payload for an image list request. * * @generated from message metalstack.api.v2.ImageServiceListResponse */ @@ -132,7 +132,7 @@ export const ImageServiceListResponseSchema: GenMessage & { classification: ImageClassification; /** - * ExpiresAt usage is not possible after this date + * ExpiresAt usage is not possible after this date. * * @generated from field: google.protobuf.Timestamp expires_at = 8; */ @@ -223,7 +223,7 @@ export const ImageSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_image, 6); /** - * ImageUsage reports which machines/firewalls actually use this image + * ImageUsage reports which machines/firewalls actually use this image. * * @generated from message metalstack.api.v2.ImageUsage */ @@ -251,7 +251,7 @@ export const ImageUsageSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_image, 7); /** - * ImageQuery is used to search images + * ImageQuery is used to search images. * * @generated from message metalstack.api.v2.ImageQuery */ @@ -313,7 +313,7 @@ export type ImageQuery = Message<"metalstack.api.v2.ImageQuery"> & { classification?: ImageClassification | undefined; /** - * Labels lists only images containing the given labels + * Labels lists only images containing the given labels. * * @generated from field: optional metalstack.api.v2.Labels labels = 9; */ @@ -334,21 +334,21 @@ export const ImageQuerySchema: GenMessage = /*@__PURE__*/ */ export enum ImageFeature { /** - * IMAGE_FEATURE_UNSPECIFIED is not specified + * IMAGE_FEATURE_UNSPECIFIED is not specified. * * @generated from enum value: IMAGE_FEATURE_UNSPECIFIED = 0; */ UNSPECIFIED = 0, /** - * IMAGE_FEATURE_MACHINE indicates this image is usable for a machine + * IMAGE_FEATURE_MACHINE indicates this image is usable for a machine. * * @generated from enum value: IMAGE_FEATURE_MACHINE = 1; */ MACHINE = 1, /** - * IMAGE_FEATURE_FIREWALL indicates this image is usable for a firewall + * IMAGE_FEATURE_FIREWALL indicates this image is usable for a firewall. * * @generated from enum value: IMAGE_FEATURE_FIREWALL = 2; */ @@ -368,28 +368,28 @@ export const ImageFeatureSchema: GenEnum = /*@__PURE__*/ */ export enum ImageClassification { /** - * IMAGE_CLASSIFICATION_UNSPECIFIED is not specified + * IMAGE_CLASSIFICATION_UNSPECIFIED is not specified. * * @generated from enum value: IMAGE_CLASSIFICATION_UNSPECIFIED = 0; */ UNSPECIFIED = 0, /** - * IMAGE_CLASSIFICATION_PREVIEW indicates that this image is in preview + * IMAGE_CLASSIFICATION_PREVIEW indicates that this image is in preview. * * @generated from enum value: IMAGE_CLASSIFICATION_PREVIEW = 1; */ PREVIEW = 1, /** - * IMAGE_CLASSIFICATION_SUPPORTED indicates that this image is supported + * IMAGE_CLASSIFICATION_SUPPORTED indicates that this image is supported. * * @generated from enum value: IMAGE_CLASSIFICATION_SUPPORTED = 2; */ SUPPORTED = 2, /** - * IMAGE_CLASSIFICATION_DEPRECATED indicates that this image is deprecated + * IMAGE_CLASSIFICATION_DEPRECATED indicates that this image is deprecated. * * @generated from enum value: IMAGE_CLASSIFICATION_DEPRECATED = 3; */ diff --git a/js/metalstack/api/v2/ip_pb.d.ts b/js/metalstack/api/v2/ip_pb.d.ts index c966e713..03f70edb 100644 --- a/js/metalstack/api/v2/ip_pb.d.ts +++ b/js/metalstack/api/v2/ip_pb.d.ts @@ -6,7 +6,7 @@ import type { Message } from "@bufbuild/protobuf"; */ export declare const file_metalstack_api_v2_ip: GenFile; /** - * IP is an IP address which can be used as loadbalancer addresses + * IP is an IP address which can be used as loadbalancer addresses. * * @generated from message metalstack.api.v2.IP */ @@ -24,7 +24,7 @@ export type IP = Message<"metalstack.api.v2.IP"> & { */ meta?: Meta | undefined; /** - * Ip is either ipv4 or ipv6 address + * Ip is either ipv4 or ipv6 address. * * @generated from field: string ip = 3; */ @@ -42,13 +42,13 @@ export type IP = Message<"metalstack.api.v2.IP"> & { */ description: string; /** - * Network is the network this ip belongs to + * Network is the network this ip belongs to. * * @generated from field: string network = 6; */ network: string; /** - * Project where this ip address belongs to + * Project where this ip address belongs to. * * @generated from field: string project = 7; */ @@ -60,7 +60,7 @@ export type IP = Message<"metalstack.api.v2.IP"> & { */ type: IPType; /** - * Namespace if specified this ip is from a namespaced network and can therefore overlap with others + * Namespace if specified this ip is from a namespaced network and can therefore overlap with others. * Will be equal with project most of the time * * @generated from field: optional string namespace = 9; @@ -73,7 +73,7 @@ export type IP = Message<"metalstack.api.v2.IP"> & { */ export declare const IPSchema: GenMessage; /** - * IPServiceGetRequest is the request payload for an IP get request + * IPServiceGetRequest is the request payload for an IP get request. * * @generated from message metalstack.api.v2.IPServiceGetRequest */ @@ -103,13 +103,13 @@ export type IPServiceGetRequest = Message<"metalstack.api.v2.IPServiceGetRequest */ export declare const IPServiceGetRequestSchema: GenMessage; /** - * IPServiceCreateRequest is the request payload for an IP create request + * IPServiceCreateRequest is the request payload for an IP create request. * * @generated from message metalstack.api.v2.IPServiceCreateRequest */ export type IPServiceCreateRequest = Message<"metalstack.api.v2.IPServiceCreateRequest"> & { /** - * Network from which the IP should be created + * Network from which the IP should be created. * * @generated from field: string network = 1; */ @@ -169,7 +169,7 @@ export type IPServiceCreateRequest = Message<"metalstack.api.v2.IPServiceCreateR */ export declare const IPServiceCreateRequestSchema: GenMessage; /** - * IPServiceUpdateRequest is the request payload for an IP update request + * IPServiceUpdateRequest is the request payload for an IP update request. * * @generated from message metalstack.api.v2.IPServiceUpdateRequest */ @@ -181,7 +181,7 @@ export type IPServiceUpdateRequest = Message<"metalstack.api.v2.IPServiceUpdateR */ ip: string; /** - * 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. * * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 2; */ @@ -223,7 +223,7 @@ export type IPServiceUpdateRequest = Message<"metalstack.api.v2.IPServiceUpdateR */ export declare const IPServiceUpdateRequestSchema: GenMessage; /** - * IPServiceListRequest is the request payload for an IP list request + * IPServiceListRequest is the request payload for an IP list request. * * @generated from message metalstack.api.v2.IPServiceListRequest */ @@ -235,7 +235,7 @@ export type IPServiceListRequest = Message<"metalstack.api.v2.IPServiceListReque */ project: string; /** - * Query to list one or more IPs + * Query to list one or more IPs. * * @generated from field: metalstack.api.v2.IPQuery query = 2; */ @@ -247,7 +247,7 @@ export type IPServiceListRequest = Message<"metalstack.api.v2.IPServiceListReque */ export declare const IPServiceListRequestSchema: GenMessage; /** - * IPQuery can be used to query a IP or a list of IP + * IPQuery can be used to query a IP or a list of IP. * * @generated from message metalstack.api.v2.IPQuery */ @@ -259,7 +259,7 @@ export type IPQuery = Message<"metalstack.api.v2.IPQuery"> & { */ ip?: string | undefined; /** - * Network from which the IPs are to list + * Network from which the IPs are to list. * * @generated from field: optional string network = 2; */ @@ -301,13 +301,13 @@ export type IPQuery = Message<"metalstack.api.v2.IPQuery"> & { */ labels?: Labels | undefined; /** - * Static if set to true, this will be a Static ip + * Static if set to true, this will be a Static ip. * * @generated from field: optional metalstack.api.v2.IPType type = 9; */ type?: IPType | undefined; /** - * Address family of the IPs to list, defaults to all address families + * Address family of the IPs to list, defaults to all address families. * * @generated from field: optional metalstack.api.v2.IPAddressFamily address_family = 10; */ @@ -325,7 +325,7 @@ export type IPQuery = Message<"metalstack.api.v2.IPQuery"> & { */ export declare const IPQuerySchema: GenMessage; /** - * IPServiceDeleteRequest is the request payload for a ip delete request + * IPServiceDeleteRequest is the request payload for a ip delete request. * * @generated from message metalstack.api.v2.IPServiceDeleteRequest */ @@ -349,7 +349,7 @@ export type IPServiceDeleteRequest = Message<"metalstack.api.v2.IPServiceDeleteR */ export declare const IPServiceDeleteRequestSchema: GenMessage; /** - * IPServiceGetResponse is the response payload for an IP get request + * IPServiceGetResponse is the response payload for an IP get request. * * @generated from message metalstack.api.v2.IPServiceGetResponse */ @@ -367,7 +367,7 @@ export type IPServiceGetResponse = Message<"metalstack.api.v2.IPServiceGetRespon */ export declare const IPServiceGetResponseSchema: GenMessage; /** - * IPServiceUpdateResponse is the response payload for a ip update request + * IPServiceUpdateResponse is the response payload for a ip update request. * * @generated from message metalstack.api.v2.IPServiceUpdateResponse */ @@ -385,7 +385,7 @@ export type IPServiceUpdateResponse = Message<"metalstack.api.v2.IPServiceUpdate */ export declare const IPServiceUpdateResponseSchema: GenMessage; /** - * IPServiceCreateResponse is the response payload for an IP create request + * IPServiceCreateResponse is the response payload for an IP create request. * * @generated from message metalstack.api.v2.IPServiceCreateResponse */ @@ -403,7 +403,7 @@ export type IPServiceCreateResponse = Message<"metalstack.api.v2.IPServiceCreate */ export declare const IPServiceCreateResponseSchema: GenMessage; /** - * IPServiceListResponse is the response payload for an IP list request + * IPServiceListResponse is the response payload for an IP list request. * * @generated from message metalstack.api.v2.IPServiceListResponse */ @@ -421,7 +421,7 @@ export type IPServiceListResponse = Message<"metalstack.api.v2.IPServiceListResp */ export declare const IPServiceListResponseSchema: GenMessage; /** - * IPServiceDeleteResponse is the response payload for an IP delete request + * IPServiceDeleteResponse is the response payload for an IP delete request. * * @generated from message metalstack.api.v2.IPServiceDeleteResponse */ @@ -439,25 +439,25 @@ export type IPServiceDeleteResponse = Message<"metalstack.api.v2.IPServiceDelete */ export declare const IPServiceDeleteResponseSchema: GenMessage; /** - * IPType specifies different IP address types + * IPType specifies different IP address types. * * @generated from enum metalstack.api.v2.IPType */ export declare enum IPType { /** - * IP_TYPE_UNSPECIFIED is not specified + * IP_TYPE_UNSPECIFIED is not specified. * * @generated from enum value: IP_TYPE_UNSPECIFIED = 0; */ IP_TYPE_UNSPECIFIED = 0, /** - * IP_TYPE_EPHEMERAL defines an ephemeral IP address which is freed/deleted after usage + * IP_TYPE_EPHEMERAL defines an ephemeral IP address which is freed/deleted after usage. * * @generated from enum value: IP_TYPE_EPHEMERAL = 1; */ IP_TYPE_EPHEMERAL = 1, /** - * IP_TYPE_STATIC defines a static ip address which must be freed/deleted explicitly + * IP_TYPE_STATIC defines a static ip address which must be freed/deleted explicitly. * * @generated from enum value: IP_TYPE_STATIC = 2; */ @@ -468,25 +468,25 @@ export declare enum IPType { */ export declare const IPTypeSchema: GenEnum; /** - * IPAddressFamily defines either IPv4 or IPv6 Addressfamily + * IPAddressFamily defines either IPv4 or IPv6 Addressfamily. * * @generated from enum metalstack.api.v2.IPAddressFamily */ export declare enum IPAddressFamily { /** - * IP_ADDRESS_FAMILY_UNSPECIFIED is not specified + * IP_ADDRESS_FAMILY_UNSPECIFIED is not specified. * * @generated from enum value: IP_ADDRESS_FAMILY_UNSPECIFIED = 0; */ IP_ADDRESS_FAMILY_UNSPECIFIED = 0, /** - * IP_ADDRESS_FAMILY_V4 defines a IPv4 address + * IP_ADDRESS_FAMILY_V4 defines a IPv4 address. * * @generated from enum value: IP_ADDRESS_FAMILY_V4 = 1; */ IP_ADDRESS_FAMILY_V4 = 1, /** - * IP_ADDRESS_FAMILY_V6 defines a IPv6 address + * IP_ADDRESS_FAMILY_V6 defines a IPv6 address. * * @generated from enum value: IP_ADDRESS_FAMILY_V6 = 2; */ diff --git a/js/metalstack/api/v2/ip_pb.js b/js/metalstack/api/v2/ip_pb.js index 0cb1410a..eed41bdc 100644 --- a/js/metalstack/api/v2/ip_pb.js +++ b/js/metalstack/api/v2/ip_pb.js @@ -70,26 +70,26 @@ export const IPServiceListResponseSchema = /*@__PURE__*/ messageDesc(file_metals */ export const IPServiceDeleteResponseSchema = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_ip, 11); /** - * IPType specifies different IP address types + * IPType specifies different IP address types. * * @generated from enum metalstack.api.v2.IPType */ export var IPType; (function (IPType) { /** - * IP_TYPE_UNSPECIFIED is not specified + * IP_TYPE_UNSPECIFIED is not specified. * * @generated from enum value: IP_TYPE_UNSPECIFIED = 0; */ IPType[IPType["IP_TYPE_UNSPECIFIED"] = 0] = "IP_TYPE_UNSPECIFIED"; /** - * IP_TYPE_EPHEMERAL defines an ephemeral IP address which is freed/deleted after usage + * IP_TYPE_EPHEMERAL defines an ephemeral IP address which is freed/deleted after usage. * * @generated from enum value: IP_TYPE_EPHEMERAL = 1; */ IPType[IPType["IP_TYPE_EPHEMERAL"] = 1] = "IP_TYPE_EPHEMERAL"; /** - * IP_TYPE_STATIC defines a static ip address which must be freed/deleted explicitly + * IP_TYPE_STATIC defines a static ip address which must be freed/deleted explicitly. * * @generated from enum value: IP_TYPE_STATIC = 2; */ @@ -100,26 +100,26 @@ export var IPType; */ export const IPTypeSchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_ip, 0); /** - * IPAddressFamily defines either IPv4 or IPv6 Addressfamily + * IPAddressFamily defines either IPv4 or IPv6 Addressfamily. * * @generated from enum metalstack.api.v2.IPAddressFamily */ export var IPAddressFamily; (function (IPAddressFamily) { /** - * IP_ADDRESS_FAMILY_UNSPECIFIED is not specified + * IP_ADDRESS_FAMILY_UNSPECIFIED is not specified. * * @generated from enum value: IP_ADDRESS_FAMILY_UNSPECIFIED = 0; */ IPAddressFamily[IPAddressFamily["IP_ADDRESS_FAMILY_UNSPECIFIED"] = 0] = "IP_ADDRESS_FAMILY_UNSPECIFIED"; /** - * IP_ADDRESS_FAMILY_V4 defines a IPv4 address + * IP_ADDRESS_FAMILY_V4 defines a IPv4 address. * * @generated from enum value: IP_ADDRESS_FAMILY_V4 = 1; */ IPAddressFamily[IPAddressFamily["IP_ADDRESS_FAMILY_V4"] = 1] = "IP_ADDRESS_FAMILY_V4"; /** - * IP_ADDRESS_FAMILY_V6 defines a IPv6 address + * IP_ADDRESS_FAMILY_V6 defines a IPv6 address. * * @generated from enum value: IP_ADDRESS_FAMILY_V6 = 2; */ diff --git a/js/metalstack/api/v2/ip_pb.ts b/js/metalstack/api/v2/ip_pb.ts index e45f7eb9..aa7836c8 100644 --- a/js/metalstack/api/v2/ip_pb.ts +++ b/js/metalstack/api/v2/ip_pb.ts @@ -17,7 +17,7 @@ export const file_metalstack_api_v2_ip: GenFile = /*@__PURE__*/ fileDesc("ChptZXRhbHN0YWNrL2FwaS92Mi9pcC5wcm90bxIRbWV0YWxzdGFjay5hcGkudjIisQIKAklQEhYKBHV1aWQYASABKAlCCLpIBXIDsAEBEiUKBG1ldGEYAiABKAsyFy5tZXRhbHN0YWNrLmFwaS52Mi5NZXRhEhMKAmlwGAMgASgJQge6SARyAnABEhkKBG5hbWUYBCABKAlCC7pICHIGwLOusQIBEiAKC2Rlc2NyaXB0aW9uGAUgASgJQgu6SAhyBsizrrECARIcCgduZXR3b3JrGAYgASgJQgu6SAhyBsCzrrECARIZCgdwcm9qZWN0GAcgASgJQgi6SAVyA7ABARIxCgR0eXBlGAggASgOMhkubWV0YWxzdGFjay5hcGkudjIuSVBUeXBlQgi6SAWCAQIQARIgCgluYW1lc3BhY2UYCSABKAlCCLpIBXIDsAEBSACIAQFCDAoKX25hbWVzcGFjZSJ1ChNJUFNlcnZpY2VHZXRSZXF1ZXN0EhMKAmlwGAEgASgJQge6SARyAnABEhkKB3Byb2plY3QYAiABKAlCCLpIBXIDsAEBEiAKCW5hbWVzcGFjZRgDIAEoCUIIukgFcgOwAQFIAIgBAUIMCgpfbmFtZXNwYWNlItgDChZJUFNlcnZpY2VDcmVhdGVSZXF1ZXN0EhwKB25ldHdvcmsYASABKAlCC7pICHIGwLOusQIBEhkKB3Byb2plY3QYAiABKAlCCLpIBXIDsAEBEh4KBG5hbWUYAyABKAlCC7pICHIGwLOusQIBSACIAQESJQoLZGVzY3JpcHRpb24YBCABKAlCC7pICHIGyLOusQIBSAGIAQESGAoCaXAYBSABKAlCB7pIBHICcAFIAogBARIeCgdtYWNoaW5lGAYgASgJQgi6SAVyA7ABAUgDiAEBEi4KBmxhYmVscxgHIAEoCzIZLm1ldGFsc3RhY2suYXBpLnYyLkxhYmVsc0gEiAEBEjYKBHR5cGUYCCABKA4yGS5tZXRhbHN0YWNrLmFwaS52Mi5JUFR5cGVCCLpIBYIBAhABSAWIAQESSQoOYWRkcmVzc19mYW1pbHkYCSABKA4yIi5tZXRhbHN0YWNrLmFwaS52Mi5JUEFkZHJlc3NGYW1pbHlCCLpIBYIBAhABSAaIAQFCBwoFX25hbWVCDgoMX2Rlc2NyaXB0aW9uQgUKA19pcEIKCghfbWFjaGluZUIJCgdfbGFiZWxzQgcKBV90eXBlQhEKD19hZGRyZXNzX2ZhbWlseSLmAgoWSVBTZXJ2aWNlVXBkYXRlUmVxdWVzdBITCgJpcBgBIAEoCUIHukgEcgJwARI6Cgt1cGRhdGVfbWV0YRgCIAEoCzIdLm1ldGFsc3RhY2suYXBpLnYyLlVwZGF0ZU1ldGFCBrpIA8gBARIZCgdwcm9qZWN0GAMgASgJQgi6SAVyA7ABARIeCgRuYW1lGAQgASgJQgu6SAhyBsCzrrECAUgAiAEBEiUKC2Rlc2NyaXB0aW9uGAUgASgJQgu6SAhyBsizrrECAUgBiAEBEjYKBHR5cGUYBiABKA4yGS5tZXRhbHN0YWNrLmFwaS52Mi5JUFR5cGVCCLpIBYIBAhABSAKIAQESNAoGbGFiZWxzGAcgASgLMh8ubWV0YWxzdGFjay5hcGkudjIuVXBkYXRlTGFiZWxzSAOIAQFCBwoFX25hbWVCDgoMX2Rlc2NyaXB0aW9uQgcKBV90eXBlQgkKB19sYWJlbHMiXAoUSVBTZXJ2aWNlTGlzdFJlcXVlc3QSGQoHcHJvamVjdBgBIAEoCUIIukgFcgOwAQESKQoFcXVlcnkYAiABKAsyGi5tZXRhbHN0YWNrLmFwaS52Mi5JUFF1ZXJ5IswECgdJUFF1ZXJ5EhgKAmlwGAEgASgJQge6SARyAnABSACIAQESIQoHbmV0d29yaxgCIAEoCUILukgIcgbAs66xAgFIAYgBARIeCgdwcm9qZWN0GAMgASgJQgi6SAVyA7ABAUgCiAEBEh4KBG5hbWUYBCABKAlCC7pICHIGwLOusQIBSAOIAQESGwoEdXVpZBgFIAEoCUIIukgFcgOwAQFIBIgBARIeCgdtYWNoaW5lGAYgASgJQgi6SAVyA7ABAUgFiAEBEikKEnBhcmVudF9wcmVmaXhfY2lkchgHIAEoCUIIukgFcgPoAQFIBogBARIuCgZsYWJlbHMYCCABKAsyGS5tZXRhbHN0YWNrLmFwaS52Mi5MYWJlbHNIB4gBARI2CgR0eXBlGAkgASgOMhkubWV0YWxzdGFjay5hcGkudjIuSVBUeXBlQgi6SAWCAQIQAUgIiAEBEkkKDmFkZHJlc3NfZmFtaWx5GAogASgOMiIubWV0YWxzdGFjay5hcGkudjIuSVBBZGRyZXNzRmFtaWx5Qgi6SAWCAQIQAUgJiAEBEiAKCW5hbWVzcGFjZRgLIAEoCUIIukgFcgOwAQFICogBAUIFCgNfaXBCCgoIX25ldHdvcmtCCgoIX3Byb2plY3RCBwoFX25hbWVCBwoFX3V1aWRCCgoIX21hY2hpbmVCFQoTX3BhcmVudF9wcmVmaXhfY2lkckIJCgdfbGFiZWxzQgcKBV90eXBlQhEKD19hZGRyZXNzX2ZhbWlseUIMCgpfbmFtZXNwYWNlIkgKFklQU2VydmljZURlbGV0ZVJlcXVlc3QSEwoCaXAYASABKAlCB7pIBHICcAESGQoHcHJvamVjdBgCIAEoCUIIukgFcgOwAQEiOQoUSVBTZXJ2aWNlR2V0UmVzcG9uc2USIQoCaXAYASABKAsyFS5tZXRhbHN0YWNrLmFwaS52Mi5JUCI8ChdJUFNlcnZpY2VVcGRhdGVSZXNwb25zZRIhCgJpcBgBIAEoCzIVLm1ldGFsc3RhY2suYXBpLnYyLklQIjwKF0lQU2VydmljZUNyZWF0ZVJlc3BvbnNlEiEKAmlwGAEgASgLMhUubWV0YWxzdGFjay5hcGkudjIuSVAiOwoVSVBTZXJ2aWNlTGlzdFJlc3BvbnNlEiIKA2lwcxgBIAMoCzIVLm1ldGFsc3RhY2suYXBpLnYyLklQIjwKF0lQU2VydmljZURlbGV0ZVJlc3BvbnNlEiEKAmlwGAEgASgLMhUubWV0YWxzdGFjay5hcGkudjIuSVAqZwoGSVBUeXBlEhcKE0lQX1RZUEVfVU5TUEVDSUZJRUQQABIkChFJUF9UWVBFX0VQSEVNRVJBTBABGg2CshkJZXBoZW1lcmFsEh4KDklQX1RZUEVfU1RBVElDEAIaCoKyGQZzdGF0aWMqfAoPSVBBZGRyZXNzRmFtaWx5EiEKHUlQX0FERFJFU1NfRkFNSUxZX1VOU1BFQ0lGSUVEEAASIgoUSVBfQUREUkVTU19GQU1JTFlfVjQQARoIgrIZBGlwdjQSIgoUSVBfQUREUkVTU19GQU1JTFlfVjYQAhoIgrIZBGlwdjYynwQKCUlQU2VydmljZRJjCgNHZXQSJi5tZXRhbHN0YWNrLmFwaS52Mi5JUFNlcnZpY2VHZXRSZXF1ZXN0GicubWV0YWxzdGFjay5hcGkudjIuSVBTZXJ2aWNlR2V0UmVzcG9uc2UiC8rzGAMBAgPg8xgCEmsKBkNyZWF0ZRIpLm1ldGFsc3RhY2suYXBpLnYyLklQU2VydmljZUNyZWF0ZVJlcXVlc3QaKi5tZXRhbHN0YWNrLmFwaS52Mi5JUFNlcnZpY2VDcmVhdGVSZXNwb25zZSIKyvMYAgEC4PMYARJrCgZVcGRhdGUSKS5tZXRhbHN0YWNrLmFwaS52Mi5JUFNlcnZpY2VVcGRhdGVSZXF1ZXN0GioubWV0YWxzdGFjay5hcGkudjIuSVBTZXJ2aWNlVXBkYXRlUmVzcG9uc2UiCsrzGAIBAuDzGAESZgoETGlzdBInLm1ldGFsc3RhY2suYXBpLnYyLklQU2VydmljZUxpc3RSZXF1ZXN0GigubWV0YWxzdGFjay5hcGkudjIuSVBTZXJ2aWNlTGlzdFJlc3BvbnNlIgvK8xgDAQID4PMYAhJrCgZEZWxldGUSKS5tZXRhbHN0YWNrLmFwaS52Mi5JUFNlcnZpY2VEZWxldGVSZXF1ZXN0GioubWV0YWxzdGFjay5hcGkudjIuSVBTZXJ2aWNlRGVsZXRlUmVzcG9uc2UiCsrzGAIBAuDzGAFCvQEKFWNvbS5tZXRhbHN0YWNrLmFwaS52MkIHSXBQcm90b1ABWjVnaXRodWIuY29tL21ldGFsLXN0YWNrL2FwaS9nby9tZXRhbHN0YWNrL2FwaS92MjthcGl2MqICA01BWKoCEU1ldGFsc3RhY2suQXBpLlYyygIRTWV0YWxzdGFja1xBcGlcVjLiAh1NZXRhbHN0YWNrXEFwaVxWMlxHUEJNZXRhZGF0YeoCE01ldGFsc3RhY2s6OkFwaTo6VjJiBnByb3RvMw", [file_buf_validate_validate, file_metalstack_api_v2_common, file_metalstack_api_v2_predefined_rules]); /** - * IP is an IP address which can be used as loadbalancer addresses + * IP is an IP address which can be used as loadbalancer addresses. * * @generated from message metalstack.api.v2.IP */ @@ -37,7 +37,7 @@ export type IP = Message<"metalstack.api.v2.IP"> & { meta?: Meta | undefined; /** - * Ip is either ipv4 or ipv6 address + * Ip is either ipv4 or ipv6 address. * * @generated from field: string ip = 3; */ @@ -58,14 +58,14 @@ export type IP = Message<"metalstack.api.v2.IP"> & { description: string; /** - * Network is the network this ip belongs to + * Network is the network this ip belongs to. * * @generated from field: string network = 6; */ network: string; /** - * Project where this ip address belongs to + * Project where this ip address belongs to. * * @generated from field: string project = 7; */ @@ -79,7 +79,7 @@ export type IP = Message<"metalstack.api.v2.IP"> & { type: IPType; /** - * Namespace if specified this ip is from a namespaced network and can therefore overlap with others + * Namespace if specified this ip is from a namespaced network and can therefore overlap with others. * Will be equal with project most of the time * * @generated from field: optional string namespace = 9; @@ -95,7 +95,7 @@ export const IPSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_ip, 0); /** - * IPServiceGetRequest is the request payload for an IP get request + * IPServiceGetRequest is the request payload for an IP get request. * * @generated from message metalstack.api.v2.IPServiceGetRequest */ @@ -130,13 +130,13 @@ export const IPServiceGetRequestSchema: GenMessage = /*@__P messageDesc(file_metalstack_api_v2_ip, 1); /** - * IPServiceCreateRequest is the request payload for an IP create request + * IPServiceCreateRequest is the request payload for an IP create request. * * @generated from message metalstack.api.v2.IPServiceCreateRequest */ export type IPServiceCreateRequest = Message<"metalstack.api.v2.IPServiceCreateRequest"> & { /** - * Network from which the IP should be created + * Network from which the IP should be created. * * @generated from field: string network = 1; */ @@ -207,7 +207,7 @@ export const IPServiceCreateRequestSchema: GenMessage = messageDesc(file_metalstack_api_v2_ip, 2); /** - * IPServiceUpdateRequest is the request payload for an IP update request + * IPServiceUpdateRequest is the request payload for an IP update request. * * @generated from message metalstack.api.v2.IPServiceUpdateRequest */ @@ -220,7 +220,7 @@ export type IPServiceUpdateRequest = Message<"metalstack.api.v2.IPServiceUpdateR ip: string; /** - * 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. * * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 2; */ @@ -270,7 +270,7 @@ export const IPServiceUpdateRequestSchema: GenMessage = messageDesc(file_metalstack_api_v2_ip, 3); /** - * IPServiceListRequest is the request payload for an IP list request + * IPServiceListRequest is the request payload for an IP list request. * * @generated from message metalstack.api.v2.IPServiceListRequest */ @@ -283,7 +283,7 @@ export type IPServiceListRequest = Message<"metalstack.api.v2.IPServiceListReque project: string; /** - * Query to list one or more IPs + * Query to list one or more IPs. * * @generated from field: metalstack.api.v2.IPQuery query = 2; */ @@ -298,7 +298,7 @@ export const IPServiceListRequestSchema: GenMessage = /*@_ messageDesc(file_metalstack_api_v2_ip, 4); /** - * IPQuery can be used to query a IP or a list of IP + * IPQuery can be used to query a IP or a list of IP. * * @generated from message metalstack.api.v2.IPQuery */ @@ -311,7 +311,7 @@ export type IPQuery = Message<"metalstack.api.v2.IPQuery"> & { ip?: string | undefined; /** - * Network from which the IPs are to list + * Network from which the IPs are to list. * * @generated from field: optional string network = 2; */ @@ -360,14 +360,14 @@ export type IPQuery = Message<"metalstack.api.v2.IPQuery"> & { labels?: Labels | undefined; /** - * Static if set to true, this will be a Static ip + * Static if set to true, this will be a Static ip. * * @generated from field: optional metalstack.api.v2.IPType type = 9; */ type?: IPType | undefined; /** - * Address family of the IPs to list, defaults to all address families + * Address family of the IPs to list, defaults to all address families. * * @generated from field: optional metalstack.api.v2.IPAddressFamily address_family = 10; */ @@ -389,7 +389,7 @@ export const IPQuerySchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_ip, 5); /** - * IPServiceDeleteRequest is the request payload for a ip delete request + * IPServiceDeleteRequest is the request payload for a ip delete request. * * @generated from message metalstack.api.v2.IPServiceDeleteRequest */ @@ -417,7 +417,7 @@ export const IPServiceDeleteRequestSchema: GenMessage = messageDesc(file_metalstack_api_v2_ip, 6); /** - * IPServiceGetResponse is the response payload for an IP get request + * IPServiceGetResponse is the response payload for an IP get request. * * @generated from message metalstack.api.v2.IPServiceGetResponse */ @@ -438,7 +438,7 @@ export const IPServiceGetResponseSchema: GenMessage = /*@_ messageDesc(file_metalstack_api_v2_ip, 7); /** - * IPServiceUpdateResponse is the response payload for a ip update request + * IPServiceUpdateResponse is the response payload for a ip update request. * * @generated from message metalstack.api.v2.IPServiceUpdateResponse */ @@ -459,7 +459,7 @@ export const IPServiceUpdateResponseSchema: GenMessage messageDesc(file_metalstack_api_v2_ip, 8); /** - * IPServiceCreateResponse is the response payload for an IP create request + * IPServiceCreateResponse is the response payload for an IP create request. * * @generated from message metalstack.api.v2.IPServiceCreateResponse */ @@ -480,7 +480,7 @@ export const IPServiceCreateResponseSchema: GenMessage messageDesc(file_metalstack_api_v2_ip, 9); /** - * IPServiceListResponse is the response payload for an IP list request + * IPServiceListResponse is the response payload for an IP list request. * * @generated from message metalstack.api.v2.IPServiceListResponse */ @@ -501,7 +501,7 @@ export const IPServiceListResponseSchema: GenMessage = /* messageDesc(file_metalstack_api_v2_ip, 10); /** - * IPServiceDeleteResponse is the response payload for an IP delete request + * IPServiceDeleteResponse is the response payload for an IP delete request. * * @generated from message metalstack.api.v2.IPServiceDeleteResponse */ @@ -522,27 +522,27 @@ export const IPServiceDeleteResponseSchema: GenMessage messageDesc(file_metalstack_api_v2_ip, 11); /** - * IPType specifies different IP address types + * IPType specifies different IP address types. * * @generated from enum metalstack.api.v2.IPType */ export enum IPType { /** - * IP_TYPE_UNSPECIFIED is not specified + * IP_TYPE_UNSPECIFIED is not specified. * * @generated from enum value: IP_TYPE_UNSPECIFIED = 0; */ IP_TYPE_UNSPECIFIED = 0, /** - * IP_TYPE_EPHEMERAL defines an ephemeral IP address which is freed/deleted after usage + * IP_TYPE_EPHEMERAL defines an ephemeral IP address which is freed/deleted after usage. * * @generated from enum value: IP_TYPE_EPHEMERAL = 1; */ IP_TYPE_EPHEMERAL = 1, /** - * IP_TYPE_STATIC defines a static ip address which must be freed/deleted explicitly + * IP_TYPE_STATIC defines a static ip address which must be freed/deleted explicitly. * * @generated from enum value: IP_TYPE_STATIC = 2; */ @@ -556,27 +556,27 @@ export const IPTypeSchema: GenEnum = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_ip, 0); /** - * IPAddressFamily defines either IPv4 or IPv6 Addressfamily + * IPAddressFamily defines either IPv4 or IPv6 Addressfamily. * * @generated from enum metalstack.api.v2.IPAddressFamily */ export enum IPAddressFamily { /** - * IP_ADDRESS_FAMILY_UNSPECIFIED is not specified + * IP_ADDRESS_FAMILY_UNSPECIFIED is not specified. * * @generated from enum value: IP_ADDRESS_FAMILY_UNSPECIFIED = 0; */ IP_ADDRESS_FAMILY_UNSPECIFIED = 0, /** - * IP_ADDRESS_FAMILY_V4 defines a IPv4 address + * IP_ADDRESS_FAMILY_V4 defines a IPv4 address. * * @generated from enum value: IP_ADDRESS_FAMILY_V4 = 1; */ IP_ADDRESS_FAMILY_V4 = 1, /** - * IP_ADDRESS_FAMILY_V6 defines a IPv6 address + * IP_ADDRESS_FAMILY_V6 defines a IPv6 address. * * @generated from enum value: IP_ADDRESS_FAMILY_V6 = 2; */ diff --git a/js/metalstack/api/v2/machine_pb.d.ts b/js/metalstack/api/v2/machine_pb.d.ts index 273ffc3d..40c54a65 100644 --- a/js/metalstack/api/v2/machine_pb.d.ts +++ b/js/metalstack/api/v2/machine_pb.d.ts @@ -12,7 +12,7 @@ import type { Message } from "@bufbuild/protobuf"; */ export declare const file_metalstack_api_v2_machine: GenFile; /** - * MachineServiceGetRequest is the request payload for a machine get request + * MachineServiceGetRequest is the request payload for a machine get request. * * @generated from message metalstack.api.v2.MachineServiceGetRequest */ @@ -36,13 +36,13 @@ export type MachineServiceGetRequest = Message<"metalstack.api.v2.MachineService */ export declare const MachineServiceGetRequestSchema: GenMessage; /** - * MachineServiceGetResponse is the response payload for a machine get request + * MachineServiceGetResponse is the response payload for a machine get request. * * @generated from message metalstack.api.v2.MachineServiceGetResponse */ export type MachineServiceGetResponse = Message<"metalstack.api.v2.MachineServiceGetResponse"> & { /** - * Machine is the machine requested + * Machine is the machine requested. * * @generated from field: metalstack.api.v2.Machine machine = 1; */ @@ -54,7 +54,7 @@ export type MachineServiceGetResponse = Message<"metalstack.api.v2.MachineServic */ export declare const MachineServiceGetResponseSchema: GenMessage; /** - * MachineServiceCreateRequest is the request payload for a machine create request + * MachineServiceCreateRequest is the request payload for a machine create request. * * @generated from message metalstack.api.v2.MachineServiceCreateRequest */ @@ -105,7 +105,7 @@ export type MachineServiceCreateRequest = Message<"metalstack.api.v2.MachineServ size?: string | undefined; /** * Image which should be installed on this machine - * The image can be specified either in the fully qualified form, e.g. including os, major, minor and patch + * The image can be specified either in the fully qualified form, e.g. including os, major, minor and patch. * - debian-13.0.20260402 * or in a simplified form which omits the patch version * - debian-13.0 @@ -124,13 +124,13 @@ export type MachineServiceCreateRequest = Message<"metalstack.api.v2.MachineServ */ filesystemLayout?: string | undefined; /** - * SSHPublicKeys defines the ssh public key to be installed on the machine to access it via ssh + * SSHPublicKeys defines the ssh public key to be installed on the machine to access it via ssh. * * @generated from field: repeated string ssh_public_keys = 10; */ sshPublicKeys: string[]; /** - * Userdata contains instructions required to bootstrap the machine + * Userdata contains instructions required to bootstrap the machine. * AWS limits the max userdata size to 16k, lets allow twice as much * * @generated from field: optional string userdata = 11; @@ -174,7 +174,7 @@ export type MachineServiceCreateRequest = Message<"metalstack.api.v2.MachineServ */ allocationType: MachineAllocationType; /** - * FirewallSpec provides firewall specific parameters if allocationType is firewall + * FirewallSpec provides firewall specific parameters if allocationType is firewall. * * @generated from field: metalstack.api.v2.FirewallSpec firewall_spec = 18; */ @@ -186,7 +186,7 @@ export type MachineServiceCreateRequest = Message<"metalstack.api.v2.MachineServ */ export declare const MachineServiceCreateRequestSchema: GenMessage; /** - * FirewallSpec contains firewall specific firewall creation parameters + * FirewallSpec contains firewall specific firewall creation parameters. * * @generated from message metalstack.api.v2.FirewallSpec */ @@ -204,7 +204,7 @@ export type FirewallSpec = Message<"metalstack.api.v2.FirewallSpec"> & { */ export declare const FirewallSpecSchema: GenMessage; /** - * MachineServiceCreateResponse is the response payload for a machine create request + * MachineServiceCreateResponse is the response payload for a machine create request. * * @generated from message metalstack.api.v2.MachineServiceCreateResponse */ @@ -222,7 +222,7 @@ export type MachineServiceCreateResponse = Message<"metalstack.api.v2.MachineSer */ export declare const MachineServiceCreateResponseSchema: GenMessage; /** - * MachineServiceUpdateRequest is the request payload for a machine update request + * MachineServiceUpdateRequest is the request payload for a machine update request. * * @generated from message metalstack.api.v2.MachineServiceUpdateRequest */ @@ -234,7 +234,7 @@ export type MachineServiceUpdateRequest = Message<"metalstack.api.v2.MachineServ */ uuid: string; /** - * 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. * * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 2; */ @@ -270,7 +270,7 @@ export type MachineServiceUpdateRequest = Message<"metalstack.api.v2.MachineServ */ export declare const MachineServiceUpdateRequestSchema: GenMessage; /** - * MachineServiceUpdateResponse is the response payload for a machine update request + * MachineServiceUpdateResponse is the response payload for a machine update request. * * @generated from message metalstack.api.v2.MachineServiceUpdateResponse */ @@ -288,7 +288,7 @@ export type MachineServiceUpdateResponse = Message<"metalstack.api.v2.MachineSer */ export declare const MachineServiceUpdateResponseSchema: GenMessage; /** - * MachineServiceListRequest is the request payload for a machine list request + * MachineServiceListRequest is the request payload for a machine list request. * * @generated from message metalstack.api.v2.MachineServiceListRequest */ @@ -300,7 +300,7 @@ export type MachineServiceListRequest = Message<"metalstack.api.v2.MachineServic */ project: string; /** - * Query to list one ore more machines + * Query to list one ore more machines. * * @generated from field: metalstack.api.v2.MachineQuery query = 2; */ @@ -312,13 +312,13 @@ export type MachineServiceListRequest = Message<"metalstack.api.v2.MachineServic */ export declare const MachineServiceListRequestSchema: GenMessage; /** - * MachineServiceListResponse is the response payload for a machine list request + * MachineServiceListResponse is the response payload for a machine list request. * * @generated from message metalstack.api.v2.MachineServiceListResponse */ export type MachineServiceListResponse = Message<"metalstack.api.v2.MachineServiceListResponse"> & { /** - * Machines are the machines requested by a list request + * Machines are the machines requested by a list request. * * @generated from field: repeated metalstack.api.v2.Machine machines = 1; */ @@ -330,7 +330,7 @@ export type MachineServiceListResponse = Message<"metalstack.api.v2.MachineServi */ export declare const MachineServiceListResponseSchema: GenMessage; /** - * MachineServiceDeleteRequest is the request payload for a machine delete request + * MachineServiceDeleteRequest is the request payload for a machine delete request. * * @generated from message metalstack.api.v2.MachineServiceDeleteRequest */ @@ -354,7 +354,7 @@ export type MachineServiceDeleteRequest = Message<"metalstack.api.v2.MachineServ */ export declare const MachineServiceDeleteRequestSchema: GenMessage; /** - * MachineServiceDeleteResponse is the response payload for a machine delete request + * MachineServiceDeleteResponse is the response payload for a machine delete request. * * @generated from message metalstack.api.v2.MachineServiceDeleteResponse */ @@ -372,7 +372,7 @@ export type MachineServiceDeleteResponse = Message<"metalstack.api.v2.MachineSer */ export declare const MachineServiceDeleteResponseSchema: GenMessage; /** - * MachineServiceBMCCommandRequest is the request payload for a machine bmc command + * MachineServiceBMCCommandRequest is the request payload for a machine bmc command. * * @generated from message metalstack.api.v2.MachineServiceBMCCommandRequest */ @@ -402,7 +402,7 @@ export type MachineServiceBMCCommandRequest = Message<"metalstack.api.v2.Machine */ export declare const MachineServiceBMCCommandRequestSchema: GenMessage; /** - * MachineServiceBMCCommandResponse is the response payload for a machine bmc command + * MachineServiceBMCCommandResponse is the response payload for a machine bmc command. * * @generated from message metalstack.api.v2.MachineServiceBMCCommandResponse */ @@ -413,7 +413,7 @@ export type MachineServiceBMCCommandResponse = Message<"metalstack.api.v2.Machin */ export declare const MachineServiceBMCCommandResponseSchema: GenMessage; /** - * MachineServiceGetBMCRequest is the request payload for a machine getbmc request + * MachineServiceGetBMCRequest is the request payload for a machine getbmc request. * * @generated from message metalstack.api.v2.MachineServiceGetBMCRequest */ @@ -437,7 +437,7 @@ export type MachineServiceGetBMCRequest = Message<"metalstack.api.v2.MachineServ */ export declare const MachineServiceGetBMCRequestSchema: GenMessage; /** - * MachineServiceGetBMCResponse is the response payload for a machine getbmc request + * MachineServiceGetBMCResponse is the response payload for a machine getbmc request. * * @generated from message metalstack.api.v2.MachineServiceGetBMCResponse */ @@ -449,7 +449,7 @@ export type MachineServiceGetBMCResponse = Message<"metalstack.api.v2.MachineSer */ uuid: string; /** - * BMC contains the BMC details of this machine + * BMC contains the BMC details of this machine. * * @generated from field: metalstack.api.v2.MachineBMCReport bmc = 2; */ @@ -485,13 +485,13 @@ export type Machine = Message<"metalstack.api.v2.Machine"> & { */ partition?: Partition | undefined; /** - * Rack where this machine is located + * Rack where this machine is located. * * @generated from field: string rack = 4; */ rack: string; /** - * Room where this machine is located + * Room where this machine is located. * * @generated from field: string room = 5; */ @@ -515,13 +515,13 @@ export type Machine = Message<"metalstack.api.v2.Machine"> & { */ allocation?: MachineAllocation | undefined; /** - * Status contains several status details related to this machine + * Status contains several status details related to this machine. * * @generated from field: metalstack.api.v2.MachineStatus status = 9; */ status?: MachineStatus | undefined; /** - * MachineRecentProvisioningEvents contains the recent provisioning events + * MachineRecentProvisioningEvents contains the recent provisioning events. * * @generated from field: metalstack.api.v2.MachineRecentProvisioningEvents recent_provisioning_events = 10; */ @@ -533,19 +533,19 @@ export type Machine = Message<"metalstack.api.v2.Machine"> & { */ export declare const MachineSchema: GenMessage; /** - * MachineStatus contains several status details related to this machine + * MachineStatus contains several status details related to this machine. * * @generated from message metalstack.api.v2.MachineStatus */ export type MachineStatus = Message<"metalstack.api.v2.MachineStatus"> & { /** - * Condition describes the availability + * Condition describes the availability. * * @generated from field: metalstack.api.v2.MachineCondition condition = 1; */ condition?: MachineCondition | undefined; /** - * LEDState indicates the state of the indicator LED on this machine + * LEDState indicates the state of the indicator LED on this machine. * * @generated from field: metalstack.api.v2.MachineChassisIdentifyLEDState led_state = 2; */ @@ -569,7 +569,7 @@ export type MachineStatus = Message<"metalstack.api.v2.MachineStatus"> & { */ export declare const MachineStatusSchema: GenMessage; /** - * MachineCondition describes the availability of this machine + * MachineCondition describes the availability of this machine. * * @generated from message metalstack.api.v2.MachineCondition */ @@ -599,7 +599,7 @@ export type MachineCondition = Message<"metalstack.api.v2.MachineCondition"> & { */ export declare const MachineConditionSchema: GenMessage; /** - * MachineAllocation contains properties if this machine is allocated + * MachineAllocation contains properties if this machine is allocated. * * @generated from message metalstack.api.v2.MachineAllocation */ @@ -715,7 +715,7 @@ export type MachineAllocation = Message<"metalstack.api.v2.MachineAllocation"> & */ export declare const MachineAllocationSchema: GenMessage; /** - * MachineAllocationNetwork defines which network should be attached to a machine and if ips should be autoacquired + * MachineAllocationNetwork defines which network should be attached to a machine and if ips should be autoacquired. * * @generated from message metalstack.api.v2.MachineAllocationNetwork */ @@ -728,7 +728,7 @@ export type MachineAllocationNetwork = Message<"metalstack.api.v2.MachineAllocat network: string; /** * IPs to to attach to this machine additionally - * If none given, one ip address is acquired per network for the machine + * If none given, one ip address is acquired per network for the machine. * Order of ips is preserved on the loopback interface. * * @generated from field: repeated string ips = 2; @@ -741,19 +741,19 @@ export type MachineAllocationNetwork = Message<"metalstack.api.v2.MachineAllocat */ export declare const MachineAllocationNetworkSchema: GenMessage; /** - * FirewallRules can be defined during firewall allocation + * FirewallRules can be defined during firewall allocation. * * @generated from message metalstack.api.v2.FirewallRules */ export type FirewallRules = Message<"metalstack.api.v2.FirewallRules"> & { /** - * Egress list of egress rules to be deployed during firewall allocation + * Egress list of egress rules to be deployed during firewall allocation. * * @generated from field: repeated metalstack.api.v2.FirewallEgressRule egress = 1; */ egress: FirewallEgressRule[]; /** - * Ingress list of ingress rules to be deployed during firewall allocation + * Ingress list of ingress rules to be deployed during firewall allocation. * * @generated from field: repeated metalstack.api.v2.FirewallIngressRule ingress = 2; */ @@ -765,7 +765,7 @@ export type FirewallRules = Message<"metalstack.api.v2.FirewallRules"> & { */ export declare const FirewallRulesSchema: GenMessage; /** - * FirewallEgressRule defines rules for outgoing traffic + * FirewallEgressRule defines rules for outgoing traffic. * * @generated from message metalstack.api.v2.FirewallEgressRule */ @@ -801,7 +801,7 @@ export type FirewallEgressRule = Message<"metalstack.api.v2.FirewallEgressRule"> */ export declare const FirewallEgressRuleSchema: GenMessage; /** - * FirewallIngressRule defines rules for incoming traffic + * FirewallIngressRule defines rules for incoming traffic. * * @generated from message metalstack.api.v2.FirewallIngressRule */ @@ -843,7 +843,7 @@ export type FirewallIngressRule = Message<"metalstack.api.v2.FirewallIngressRule */ export declare const FirewallIngressRuleSchema: GenMessage; /** - * MachineNetwork contains details which network should be created on a allocated machine + * MachineNetwork contains details which network should be created on a allocated machine. * * @generated from message metalstack.api.v2.MachineNetwork */ @@ -861,7 +861,7 @@ export type MachineNetwork = Message<"metalstack.api.v2.MachineNetwork"> & { */ prefixes: string[]; /** - * DestinationPrefixes prefixes that are reachable within this network + * DestinationPrefixes prefixes that are reachable within this network. * * @generated from field: repeated string destination_prefixes = 3; */ @@ -879,7 +879,7 @@ export type MachineNetwork = Message<"metalstack.api.v2.MachineNetwork"> & { */ networkType: NetworkType; /** - * NatType what type of nat if any should be used + * NatType what type of nat if any should be used. * * @generated from field: metalstack.api.v2.NATType nat_type = 6; */ @@ -897,7 +897,7 @@ export type MachineNetwork = Message<"metalstack.api.v2.MachineNetwork"> & { */ asn: number; /** - * Project is the project uuid associated with this network + * Project is the project uuid associated with this network. * * @generated from field: optional string project = 9; */ @@ -909,7 +909,7 @@ export type MachineNetwork = Message<"metalstack.api.v2.MachineNetwork"> & { */ export declare const MachineNetworkSchema: GenMessage; /** - * MachineHardware contains hardware details + * MachineHardware contains hardware details. * * @generated from message metalstack.api.v2.MachineHardware */ @@ -951,7 +951,7 @@ export type MachineHardware = Message<"metalstack.api.v2.MachineHardware"> & { */ export declare const MachineHardwareSchema: GenMessage; /** - * MetalCPU contains details of a cpu in this machine + * MetalCPU contains details of a cpu in this machine. * * @generated from message metalstack.api.v2.MetalCPU */ @@ -987,7 +987,7 @@ export type MetalCPU = Message<"metalstack.api.v2.MetalCPU"> & { */ export declare const MetalCPUSchema: GenMessage; /** - * MetalGPU contains details of a gpu in this machine + * MetalGPU contains details of a gpu in this machine. * * @generated from message metalstack.api.v2.MetalGPU */ @@ -1011,7 +1011,7 @@ export type MetalGPU = Message<"metalstack.api.v2.MetalGPU"> & { */ export declare const MetalGPUSchema: GenMessage; /** - * MachineNic contains details of a network interface of this machine + * MachineNic contains details of a network interface of this machine. * * @generated from message metalstack.api.v2.MachineNic */ @@ -1071,7 +1071,7 @@ export type MachineNic = Message<"metalstack.api.v2.MachineNic"> & { */ export declare const MachineNicSchema: GenMessage; /** - * MachineBlockDevice contains details of a block device of this machine + * MachineBlockDevice contains details of a block device of this machine. * * @generated from message metalstack.api.v2.MachineBlockDevice */ @@ -1095,7 +1095,7 @@ export type MachineBlockDevice = Message<"metalstack.api.v2.MachineBlockDevice"> */ export declare const MachineBlockDeviceSchema: GenMessage; /** - * MachineChassisIdentifyLEDState describes the identifier led state + * MachineChassisIdentifyLEDState describes the identifier led state. * * @generated from message metalstack.api.v2.MachineChassisIdentifyLEDState */ @@ -1119,49 +1119,49 @@ export type MachineChassisIdentifyLEDState = Message<"metalstack.api.v2.MachineC */ export declare const MachineChassisIdentifyLEDStateSchema: GenMessage; /** - * MachineBMCReport is sent from the metal-bmc to update bmc and power related details + * MachineBMCReport is sent from the metal-bmc to update bmc and power related details. * * @generated from message metalstack.api.v2.MachineBMCReport */ export type MachineBMCReport = Message<"metalstack.api.v2.MachineBMCReport"> & { /** - * Bmc contains bmc details + * Bmc contains bmc details. * * @generated from field: metalstack.api.v2.MachineBMC bmc = 1; */ bmc?: MachineBMC | undefined; /** - * Bios contains bios details + * Bios contains bios details. * * @generated from field: metalstack.api.v2.MachineBios bios = 2; */ bios?: MachineBios | undefined; /** - * Fru contains field replaceable unit details + * Fru contains field replaceable unit details. * * @generated from field: metalstack.api.v2.MachineFRU fru = 3; */ fru?: MachineFRU | undefined; /** - * PowerMetric contains the power statistics of the machine + * PowerMetric contains the power statistics of the machine. * * @generated from field: metalstack.api.v2.MachinePowerMetric power_metric = 4; */ powerMetric?: MachinePowerMetric | undefined; /** - * PowerSupplies contains details about all power supplies and their state + * PowerSupplies contains details about all power supplies and their state. * * @generated from field: repeated metalstack.api.v2.MachinePowerSupply power_supplies = 5; */ powerSupplies: MachinePowerSupply[]; /** - * LedState indicates the state of the indicator LED on this machine + * LedState indicates the state of the indicator LED on this machine. * * @generated from field: metalstack.api.v2.MachineChassisIdentifyLEDState led_state = 6; */ ledState?: MachineChassisIdentifyLEDState | undefined; /** - * UpdatedAt contains the date when this data was last updated + * UpdatedAt contains the date when this data was last updated. * * @generated from field: google.protobuf.Timestamp updated_at = 7; */ @@ -1173,7 +1173,7 @@ export type MachineBMCReport = Message<"metalstack.api.v2.MachineBMCReport"> & { */ export declare const MachineBMCReportSchema: GenMessage; /** - * MachineBios contains BIOS details of this machine + * MachineBios contains BIOS details of this machine. * * @generated from message metalstack.api.v2.MachineBios */ @@ -1203,7 +1203,7 @@ export type MachineBios = Message<"metalstack.api.v2.MachineBios"> & { */ export declare const MachineBiosSchema: GenMessage; /** - * MachineBMC describe details of the ipmi or out of band device + * MachineBMC describe details of the ipmi or out of band device. * * @generated from message metalstack.api.v2.MachineBMC */ @@ -1257,55 +1257,55 @@ export type MachineBMC = Message<"metalstack.api.v2.MachineBMC"> & { */ export declare const MachineBMCSchema: GenMessage; /** - * MachineFRU describes details to the machine which are required in case of a necessary replacement + * MachineFRU describes details to the machine which are required in case of a necessary replacement. * * @generated from message metalstack.api.v2.MachineFRU */ export type MachineFRU = Message<"metalstack.api.v2.MachineFRU"> & { /** - * ChassisPartNumber is the part number of the machine chassis + * ChassisPartNumber is the part number of the machine chassis. * * @generated from field: optional string chassis_part_number = 1; */ chassisPartNumber?: string | undefined; /** - * ChassisPartSerial is the serial number of the machine chassis + * ChassisPartSerial is the serial number of the machine chassis. * * @generated from field: optional string chassis_part_serial = 2; */ chassisPartSerial?: string | undefined; /** - * BoardMfg is the short description of the mainboard + * BoardMfg is the short description of the mainboard. * * @generated from field: optional string board_mfg = 3; */ boardMfg?: string | undefined; /** - * BoardMfgSerial is the serial number of the mainboard + * BoardMfgSerial is the serial number of the mainboard. * * @generated from field: optional string board_mfg_serial = 4; */ boardMfgSerial?: string | undefined; /** - * BoardPartNumber is the part number of the mainboard + * BoardPartNumber is the part number of the mainboard. * * @generated from field: optional string board_part_number = 5; */ boardPartNumber?: string | undefined; /** - * ProductManufacturer is the manufacturer of the machine + * ProductManufacturer is the manufacturer of the machine. * * @generated from field: optional string product_manufacturer = 6; */ productManufacturer?: string | undefined; /** - * ProductPartNumber is the part number of the machine + * ProductPartNumber is the part number of the machine. * * @generated from field: optional string product_part_number = 7; */ productPartNumber?: string | undefined; /** - * ProductSerial is the serial number of the machine + * ProductSerial is the serial number of the machine. * * @generated from field: optional string product_serial = 8; */ @@ -1317,7 +1317,7 @@ export type MachineFRU = Message<"metalstack.api.v2.MachineFRU"> & { */ export declare const MachineFRUSchema: GenMessage; /** - * MachinePowerMetric contains metrics of the power consumption of a machine + * MachinePowerMetric contains metrics of the power consumption of a machine. * * @generated from message metalstack.api.v2.MachinePowerMetric */ @@ -1362,7 +1362,7 @@ export type MachinePowerMetric = Message<"metalstack.api.v2.MachinePowerMetric"> */ export declare const MachinePowerMetricSchema: GenMessage; /** - * MachinePowerSupply contains details of the power supply of a machine + * MachinePowerSupply contains details of the power supply of a machine. * * @generated from message metalstack.api.v2.MachinePowerSupply */ @@ -1410,7 +1410,7 @@ export type MachineRecentProvisioningEvents = Message<"metalstack.api.v2.Machine */ lastErrorEvent?: MachineProvisioningEvent | undefined; /** - * State can be either CrashLoop, FailedReclaim or something else + * State can be either CrashLoop, FailedReclaim or something else. * * @generated from field: metalstack.api.v2.MachineProvisioningEventState state = 4; */ @@ -1422,7 +1422,7 @@ export type MachineRecentProvisioningEvents = Message<"metalstack.api.v2.Machine */ export declare const MachineRecentProvisioningEventsSchema: GenMessage; /** - * MachineProvisioningEvent is an event that has occurred during provisioning + * MachineProvisioningEvent is an event that has occurred during provisioning. * * @generated from message metalstack.api.v2.MachineProvisioningEvent */ @@ -1452,7 +1452,7 @@ export type MachineProvisioningEvent = Message<"metalstack.api.v2.MachineProvisi */ export declare const MachineProvisioningEventSchema: GenMessage; /** - * MachineVPN contains configuration data for the VPN connection + * MachineVPN contains configuration data for the VPN connection. * * @generated from message metalstack.api.v2.MachineVPN */ @@ -1470,7 +1470,7 @@ export type MachineVPN = Message<"metalstack.api.v2.MachineVPN"> & { */ authKey: string; /** - * Connected indicate if this machine is connected to the VPN + * Connected indicate if this machine is connected to the VPN. * * @generated from field: bool connected = 3; */ @@ -1905,7 +1905,7 @@ export type MachineHardwareQuery = Message<"metalstack.api.v2.MachineHardwareQue */ export declare const MachineHardwareQuerySchema: GenMessage; /** - * MachineIssuesQuery defines which machine issues should be listed + * MachineIssuesQuery defines which machine issues should be listed. * * @generated from message metalstack.api.v2.MachineIssuesQuery */ @@ -1917,7 +1917,7 @@ export type MachineIssuesQuery = Message<"metalstack.api.v2.MachineIssuesQuery"> */ machineQuery?: MachineQuery | undefined; /** - * Only includes the specified machine issue types + * Only includes the specified machine issue types. * * @generated from field: repeated metalstack.api.v2.MachineIssueType only = 2; */ @@ -1929,13 +1929,13 @@ export type MachineIssuesQuery = Message<"metalstack.api.v2.MachineIssuesQuery"> */ omit: MachineIssueType[]; /** - * Severity filters issue for given severity + * Severity filters issue for given severity. * * @generated from field: optional metalstack.api.v2.MachineIssueSeverity severity = 4; */ severity?: MachineIssueSeverity | undefined; /** - * LastErrorThreshold defines the last error threshold + * LastErrorThreshold defines the last error threshold. * * @generated from field: google.protobuf.Duration last_error_threshold = 5; */ @@ -1947,7 +1947,7 @@ export type MachineIssuesQuery = Message<"metalstack.api.v2.MachineIssuesQuery"> */ export declare const MachineIssuesQuerySchema: GenMessage; /** - * MachineIssues is a list of issues for a machine + * MachineIssues is a list of issues for a machine. * * @generated from message metalstack.api.v2.MachineIssues */ @@ -1971,7 +1971,7 @@ export type MachineIssues = Message<"metalstack.api.v2.MachineIssues"> & { */ export declare const MachineIssuesSchema: GenMessage; /** - * MachineIssue contains details of one issue + * MachineIssue contains details of one issue. * * @generated from message metalstack.api.v2.MachineIssue */ @@ -1983,25 +1983,25 @@ export type MachineIssue = Message<"metalstack.api.v2.MachineIssue"> & { */ type: MachineIssueType; /** - * Severity specifies the severity of an issue + * Severity specifies the severity of an issue. * * @generated from field: metalstack.api.v2.MachineIssueSeverity severity = 2; */ severity: MachineIssueSeverity; /** - * Description provides an issue description + * Description provides an issue description. * * @generated from field: string description = 3; */ description: string; /** - * RefURL provides a link to a more detailed issue description in the metal-stack documentation + * RefURL provides a link to a more detailed issue description in the metal-stack documentation. * * @generated from field: string reference_url = 4; */ referenceUrl: string; /** - * Details may contain additional details on an evaluated issue + * Details may contain additional details on an evaluated issue. * * @generated from field: string details = 5; */ @@ -2013,25 +2013,25 @@ export type MachineIssue = Message<"metalstack.api.v2.MachineIssue"> & { */ export declare const MachineIssueSchema: GenMessage; /** - * IPProtocol defines tcp|udp + * IPProtocol defines tcp|udp. * * @generated from enum metalstack.api.v2.IPProtocol */ export declare enum IPProtocol { /** - * IP_PROTOCOL_UNSPECIFIED is not specified + * IP_PROTOCOL_UNSPECIFIED is not specified. * * @generated from enum value: IP_PROTOCOL_UNSPECIFIED = 0; */ IP_PROTOCOL_UNSPECIFIED = 0, /** - * IP_PROTOCOL_TCP is tcp + * IP_PROTOCOL_TCP is tcp. * * @generated from enum value: IP_PROTOCOL_TCP = 1; */ IP_PROTOCOL_TCP = 1, /** - * IP_PROTOCOL_UDP is udp + * IP_PROTOCOL_UDP is udp. * * @generated from enum value: IP_PROTOCOL_UDP = 2; */ @@ -2042,13 +2042,13 @@ export declare enum IPProtocol { */ export declare const IPProtocolSchema: GenEnum; /** - * MachineState defines if the machine was locked or reserved from a operator + * MachineState defines if the machine was locked or reserved from a operator. * * @generated from enum metalstack.api.v2.MachineState */ export declare enum MachineState { /** - * MACHINE_STATE_UNSPECIFIED is not specified + * MACHINE_STATE_UNSPECIFIED is not specified. * * @generated from enum value: MACHINE_STATE_UNSPECIFIED = 0; */ @@ -2083,7 +2083,7 @@ export declare const MachineStateSchema: GenEnum; */ export declare enum MachineProvisioningEventState { /** - * MACHINE_PROVISIONING_EVENT_STATE_UNSPECIFIED is not specified + * MACHINE_PROVISIONING_EVENT_STATE_UNSPECIFIED is not specified. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_STATE_UNSPECIFIED = 0; */ @@ -2106,13 +2106,13 @@ export declare enum MachineProvisioningEventState { */ export declare const MachineProvisioningEventStateSchema: GenEnum; /** - * MachineProvisioningEventType defines in which phase the machine actually is + * MachineProvisioningEventType defines in which phase the machine actually is. * * @generated from enum metalstack.api.v2.MachineProvisioningEventType */ export declare enum MachineProvisioningEventType { /** - * MACHINE_PROVISIONING_EVENT_TYPE_UNSPECIFIED is not specified + * MACHINE_PROVISIONING_EVENT_TYPE_UNSPECIFIED is not specified. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_UNSPECIFIED = 0; */ @@ -2189,13 +2189,13 @@ export declare enum MachineProvisioningEventType { */ export declare const MachineProvisioningEventTypeSchema: GenEnum; /** - * MachineLiveliness specifies the liveliness of a machine + * MachineLiveliness specifies the liveliness of a machine. * * @generated from enum metalstack.api.v2.MachineLiveliness */ export declare enum MachineLiveliness { /** - * MACHINE_LIVELINESS_UNSPECIFIED is not defined + * MACHINE_LIVELINESS_UNSPECIFIED is not defined. * * @generated from enum value: MACHINE_LIVELINESS_UNSPECIFIED = 0; */ @@ -2224,25 +2224,25 @@ export declare enum MachineLiveliness { */ export declare const MachineLivelinessSchema: GenEnum; /** - * MachineAllocationType defines if this is a machine or a firewall + * MachineAllocationType defines if this is a machine or a firewall. * * @generated from enum metalstack.api.v2.MachineAllocationType */ export declare enum MachineAllocationType { /** - * MACHINE_ALLOCATION_TYPE_UNSPECIFIED is unspecified + * MACHINE_ALLOCATION_TYPE_UNSPECIFIED is unspecified. * * @generated from enum value: MACHINE_ALLOCATION_TYPE_UNSPECIFIED = 0; */ UNSPECIFIED = 0, /** - * MACHINE_ALLOCATION_TYPE_MACHINE is a machine + * MACHINE_ALLOCATION_TYPE_MACHINE is a machine. * * @generated from enum value: MACHINE_ALLOCATION_TYPE_MACHINE = 1; */ MACHINE = 1, /** - * MACHINE_ALLOCATION_TYPE_FIREWALL is a firewall + * MACHINE_ALLOCATION_TYPE_FIREWALL is a firewall. * * @generated from enum value: MACHINE_ALLOCATION_TYPE_FIREWALL = 2; */ @@ -2253,37 +2253,37 @@ export declare enum MachineAllocationType { */ export declare const MachineAllocationTypeSchema: GenEnum; /** - * MachineBMCCommand defines commands send to the BMC of the machine + * MachineBMCCommand defines commands send to the BMC of the machine. * * @generated from enum metalstack.api.v2.MachineBMCCommand */ export declare enum MachineBMCCommand { /** - * MACHINE_BMC_COMMAND_UNSPECIFIED is not defined + * MACHINE_BMC_COMMAND_UNSPECIFIED is not defined. * * @generated from enum value: MACHINE_BMC_COMMAND_UNSPECIFIED = 0; */ MACHINE_BMC_COMMAND_UNSPECIFIED = 0, /** - * MACHINE_BMC_COMMAND_ON Power on the machine + * MACHINE_BMC_COMMAND_ON Power on the machine. * * @generated from enum value: MACHINE_BMC_COMMAND_ON = 1; */ MACHINE_BMC_COMMAND_ON = 1, /** - * MACHINE_BMC_COMMAND_OFF Power off the machine + * MACHINE_BMC_COMMAND_OFF Power off the machine. * * @generated from enum value: MACHINE_BMC_COMMAND_OFF = 2; */ MACHINE_BMC_COMMAND_OFF = 2, /** - * MACHINE_BMC_COMMAND_RESET Power reset the machine + * MACHINE_BMC_COMMAND_RESET Power reset the machine. * * @generated from enum value: MACHINE_BMC_COMMAND_RESET = 3; */ MACHINE_BMC_COMMAND_RESET = 3, /** - * MACHINE_BMC_COMMAND_CYCLE Power cycle the machine + * MACHINE_BMC_COMMAND_CYCLE Power cycle the machine. * * @generated from enum value: MACHINE_BMC_COMMAND_CYCLE = 4; */ @@ -2336,7 +2336,7 @@ export declare enum MachineBMCCommand { */ export declare const MachineBMCCommandSchema: GenEnum; /** - * MachineIssueType defines which type of issue it is + * MachineIssueType defines which type of issue it is. * * @generated from enum metalstack.api.v2.MachineIssueType */ @@ -2431,7 +2431,7 @@ export declare enum MachineIssueType { */ export declare const MachineIssueTypeSchema: GenEnum; /** - * MachineIssueSeverity defines the severity of an issue + * MachineIssueSeverity defines the severity of an issue. * * @generated from enum metalstack.api.v2.MachineIssueSeverity */ diff --git a/js/metalstack/api/v2/machine_pb.js b/js/metalstack/api/v2/machine_pb.js index 633e7fcb..26ea8592 100644 --- a/js/metalstack/api/v2/machine_pb.js +++ b/js/metalstack/api/v2/machine_pb.js @@ -266,26 +266,26 @@ export const MachineIssuesSchema = /*@__PURE__*/ messageDesc(file_metalstack_api */ export const MachineIssueSchema = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_machine, 49); /** - * IPProtocol defines tcp|udp + * IPProtocol defines tcp|udp. * * @generated from enum metalstack.api.v2.IPProtocol */ export var IPProtocol; (function (IPProtocol) { /** - * IP_PROTOCOL_UNSPECIFIED is not specified + * IP_PROTOCOL_UNSPECIFIED is not specified. * * @generated from enum value: IP_PROTOCOL_UNSPECIFIED = 0; */ IPProtocol[IPProtocol["IP_PROTOCOL_UNSPECIFIED"] = 0] = "IP_PROTOCOL_UNSPECIFIED"; /** - * IP_PROTOCOL_TCP is tcp + * IP_PROTOCOL_TCP is tcp. * * @generated from enum value: IP_PROTOCOL_TCP = 1; */ IPProtocol[IPProtocol["IP_PROTOCOL_TCP"] = 1] = "IP_PROTOCOL_TCP"; /** - * IP_PROTOCOL_UDP is udp + * IP_PROTOCOL_UDP is udp. * * @generated from enum value: IP_PROTOCOL_UDP = 2; */ @@ -296,14 +296,14 @@ export var IPProtocol; */ export const IPProtocolSchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_machine, 0); /** - * MachineState defines if the machine was locked or reserved from a operator + * MachineState defines if the machine was locked or reserved from a operator. * * @generated from enum metalstack.api.v2.MachineState */ export var MachineState; (function (MachineState) { /** - * MACHINE_STATE_UNSPECIFIED is not specified + * MACHINE_STATE_UNSPECIFIED is not specified. * * @generated from enum value: MACHINE_STATE_UNSPECIFIED = 0; */ @@ -339,7 +339,7 @@ export const MachineStateSchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_ export var MachineProvisioningEventState; (function (MachineProvisioningEventState) { /** - * MACHINE_PROVISIONING_EVENT_STATE_UNSPECIFIED is not specified + * MACHINE_PROVISIONING_EVENT_STATE_UNSPECIFIED is not specified. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_STATE_UNSPECIFIED = 0; */ @@ -362,14 +362,14 @@ export var MachineProvisioningEventState; */ export const MachineProvisioningEventStateSchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_machine, 2); /** - * MachineProvisioningEventType defines in which phase the machine actually is + * MachineProvisioningEventType defines in which phase the machine actually is. * * @generated from enum metalstack.api.v2.MachineProvisioningEventType */ export var MachineProvisioningEventType; (function (MachineProvisioningEventType) { /** - * MACHINE_PROVISIONING_EVENT_TYPE_UNSPECIFIED is not specified + * MACHINE_PROVISIONING_EVENT_TYPE_UNSPECIFIED is not specified. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_UNSPECIFIED = 0; */ @@ -446,14 +446,14 @@ export var MachineProvisioningEventType; */ export const MachineProvisioningEventTypeSchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_machine, 3); /** - * MachineLiveliness specifies the liveliness of a machine + * MachineLiveliness specifies the liveliness of a machine. * * @generated from enum metalstack.api.v2.MachineLiveliness */ export var MachineLiveliness; (function (MachineLiveliness) { /** - * MACHINE_LIVELINESS_UNSPECIFIED is not defined + * MACHINE_LIVELINESS_UNSPECIFIED is not defined. * * @generated from enum value: MACHINE_LIVELINESS_UNSPECIFIED = 0; */ @@ -482,26 +482,26 @@ export var MachineLiveliness; */ export const MachineLivelinessSchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_machine, 4); /** - * MachineAllocationType defines if this is a machine or a firewall + * MachineAllocationType defines if this is a machine or a firewall. * * @generated from enum metalstack.api.v2.MachineAllocationType */ export var MachineAllocationType; (function (MachineAllocationType) { /** - * MACHINE_ALLOCATION_TYPE_UNSPECIFIED is unspecified + * MACHINE_ALLOCATION_TYPE_UNSPECIFIED is unspecified. * * @generated from enum value: MACHINE_ALLOCATION_TYPE_UNSPECIFIED = 0; */ MachineAllocationType[MachineAllocationType["UNSPECIFIED"] = 0] = "UNSPECIFIED"; /** - * MACHINE_ALLOCATION_TYPE_MACHINE is a machine + * MACHINE_ALLOCATION_TYPE_MACHINE is a machine. * * @generated from enum value: MACHINE_ALLOCATION_TYPE_MACHINE = 1; */ MachineAllocationType[MachineAllocationType["MACHINE"] = 1] = "MACHINE"; /** - * MACHINE_ALLOCATION_TYPE_FIREWALL is a firewall + * MACHINE_ALLOCATION_TYPE_FIREWALL is a firewall. * * @generated from enum value: MACHINE_ALLOCATION_TYPE_FIREWALL = 2; */ @@ -512,38 +512,38 @@ export var MachineAllocationType; */ export const MachineAllocationTypeSchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_machine, 5); /** - * MachineBMCCommand defines commands send to the BMC of the machine + * MachineBMCCommand defines commands send to the BMC of the machine. * * @generated from enum metalstack.api.v2.MachineBMCCommand */ export var MachineBMCCommand; (function (MachineBMCCommand) { /** - * MACHINE_BMC_COMMAND_UNSPECIFIED is not defined + * MACHINE_BMC_COMMAND_UNSPECIFIED is not defined. * * @generated from enum value: MACHINE_BMC_COMMAND_UNSPECIFIED = 0; */ MachineBMCCommand[MachineBMCCommand["MACHINE_BMC_COMMAND_UNSPECIFIED"] = 0] = "MACHINE_BMC_COMMAND_UNSPECIFIED"; /** - * MACHINE_BMC_COMMAND_ON Power on the machine + * MACHINE_BMC_COMMAND_ON Power on the machine. * * @generated from enum value: MACHINE_BMC_COMMAND_ON = 1; */ MachineBMCCommand[MachineBMCCommand["MACHINE_BMC_COMMAND_ON"] = 1] = "MACHINE_BMC_COMMAND_ON"; /** - * MACHINE_BMC_COMMAND_OFF Power off the machine + * MACHINE_BMC_COMMAND_OFF Power off the machine. * * @generated from enum value: MACHINE_BMC_COMMAND_OFF = 2; */ MachineBMCCommand[MachineBMCCommand["MACHINE_BMC_COMMAND_OFF"] = 2] = "MACHINE_BMC_COMMAND_OFF"; /** - * MACHINE_BMC_COMMAND_RESET Power reset the machine + * MACHINE_BMC_COMMAND_RESET Power reset the machine. * * @generated from enum value: MACHINE_BMC_COMMAND_RESET = 3; */ MachineBMCCommand[MachineBMCCommand["MACHINE_BMC_COMMAND_RESET"] = 3] = "MACHINE_BMC_COMMAND_RESET"; /** - * MACHINE_BMC_COMMAND_CYCLE Power cycle the machine + * MACHINE_BMC_COMMAND_CYCLE Power cycle the machine. * * @generated from enum value: MACHINE_BMC_COMMAND_CYCLE = 4; */ @@ -596,7 +596,7 @@ export var MachineBMCCommand; */ export const MachineBMCCommandSchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_machine, 6); /** - * MachineIssueType defines which type of issue it is + * MachineIssueType defines which type of issue it is. * * @generated from enum metalstack.api.v2.MachineIssueType */ @@ -692,7 +692,7 @@ export var MachineIssueType; */ export const MachineIssueTypeSchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_machine, 7); /** - * MachineIssueSeverity defines the severity of an issue + * MachineIssueSeverity defines the severity of an issue. * * @generated from enum metalstack.api.v2.MachineIssueSeverity */ diff --git a/js/metalstack/api/v2/machine_pb.ts b/js/metalstack/api/v2/machine_pb.ts index 76a0fe40..99aa02e5 100644 --- a/js/metalstack/api/v2/machine_pb.ts +++ b/js/metalstack/api/v2/machine_pb.ts @@ -29,7 +29,7 @@ export const file_metalstack_api_v2_machine: GenFile = /*@__PURE__*/ fileDesc("Ch9tZXRhbHN0YWNrL2FwaS92Mi9tYWNoaW5lLnByb3RvEhFtZXRhbHN0YWNrLmFwaS52MiJNChhNYWNoaW5lU2VydmljZUdldFJlcXVlc3QSFgoEdXVpZBgBIAEoCUIIukgFcgOwAQESGQoHcHJvamVjdBgCIAEoCUIIukgFcgOwAQEiSAoZTWFjaGluZVNlcnZpY2VHZXRSZXNwb25zZRIrCgdtYWNoaW5lGAEgASgLMhoubWV0YWxzdGFjay5hcGkudjIuTWFjaGluZSKVBwobTWFjaGluZVNlcnZpY2VDcmVhdGVSZXF1ZXN0EhkKB3Byb2plY3QYASABKAlCCLpIBXIDsAEBEhsKBHV1aWQYAiABKAlCCLpIBXIDsAEBSACIAQESGQoEbmFtZRgDIAEoCUILukgIcgbAs66xAgESJQoLZGVzY3JpcHRpb24YBCABKAlCC7pICHIGyLOusQIBSAGIAQESHgoIaG9zdG5hbWUYBSABKAlCB7pIBHICaAFIAogBARIjCglwYXJ0aXRpb24YBiABKAlCC7pICHIG0LOusQIBSAOIAQESHgoEc2l6ZRgHIAEoCUILukgIcgbAs66xAgFIBIgBARIaCgVpbWFnZRgIIAEoCUILukgIcgbAs66xAgESKwoRZmlsZXN5c3RlbV9sYXlvdXQYCSABKAlCC7pICHIGwLOusQIBSAWIAQESMQoPc3NoX3B1YmxpY19rZXlzGAogAygJQhi6SBWSARLQpLOxAgEQMiIIcgaItK6xAgESJgoIdXNlcmRhdGEYCyABKAlCD7pIDHIK8LOusQIBGICAAkgGiAEBEikKBmxhYmVscxgMIAEoCzIZLm1ldGFsc3RhY2suYXBpLnYyLkxhYmVscxJHCghuZXR3b3JrcxgNIAMoCzIrLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVBbGxvY2F0aW9uTmV0d29ya0IIukgFkgECCAESIAoOcGxhY2VtZW50X3RhZ3MYDiADKAlCCLpIBZIBAhBAEjsKC2Ruc19zZXJ2ZXJzGA8gAygLMhwubWV0YWxzdGFjay5hcGkudjIuRE5TU2VydmVyQgi6SAWSAQIQAxI7CgtudHBfc2VydmVycxgQIAMoCzIcLm1ldGFsc3RhY2suYXBpLnYyLk5UUFNlcnZlckIIukgFkgECEAoSSwoPYWxsb2NhdGlvbl90eXBlGBEgASgOMigubWV0YWxzdGFjay5hcGkudjIuTWFjaGluZUFsbG9jYXRpb25UeXBlQgi6SAWCAQIQARI2Cg1maXJld2FsbF9zcGVjGBIgASgLMh8ubWV0YWxzdGFjay5hcGkudjIuRmlyZXdhbGxTcGVjQgcKBV91dWlkQg4KDF9kZXNjcmlwdGlvbkILCglfaG9zdG5hbWVCDAoKX3BhcnRpdGlvbkIHCgVfc2l6ZUIUChJfZmlsZXN5c3RlbV9sYXlvdXRCCwoJX3VzZXJkYXRhIkgKDEZpcmV3YWxsU3BlYxI4Cg5maXJld2FsbF9ydWxlcxgBIAEoCzIgLm1ldGFsc3RhY2suYXBpLnYyLkZpcmV3YWxsUnVsZXMiSwocTWFjaGluZVNlcnZpY2VDcmVhdGVSZXNwb25zZRIrCgdtYWNoaW5lGAEgASgLMhoubWV0YWxzdGFjay5hcGkudjIuTWFjaGluZSK3AgobTWFjaGluZVNlcnZpY2VVcGRhdGVSZXF1ZXN0EhYKBHV1aWQYASABKAlCCLpIBXIDsAEBEjoKC3VwZGF0ZV9tZXRhGAIgASgLMh0ubWV0YWxzdGFjay5hcGkudjIuVXBkYXRlTWV0YUIGukgDyAEBEhkKB3Byb2plY3QYAyABKAlCCLpIBXIDsAEBEiUKC2Rlc2NyaXB0aW9uGAQgASgJQgu6SAhyBsizrrECAUgAiAEBEjQKBmxhYmVscxgFIAEoCzIfLm1ldGFsc3RhY2suYXBpLnYyLlVwZGF0ZUxhYmVsc0gBiAEBEjEKD3NzaF9wdWJsaWNfa2V5cxgGIAMoCUIYukgVkgES0KSzsQIBEDIiCHIGiLSusQIBQg4KDF9kZXNjcmlwdGlvbkIJCgdfbGFiZWxzIksKHE1hY2hpbmVTZXJ2aWNlVXBkYXRlUmVzcG9uc2USKwoHbWFjaGluZRgBIAEoCzIaLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmUiZgoZTWFjaGluZVNlcnZpY2VMaXN0UmVxdWVzdBIZCgdwcm9qZWN0GAEgASgJQgi6SAVyA7ABARIuCgVxdWVyeRgCIAEoCzIfLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVRdWVyeSJKChpNYWNoaW5lU2VydmljZUxpc3RSZXNwb25zZRIsCghtYWNoaW5lcxgBIAMoCzIaLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmUiUAobTWFjaGluZVNlcnZpY2VEZWxldGVSZXF1ZXN0EhYKBHV1aWQYASABKAlCCLpIBXIDsAEBEhkKB3Byb2plY3QYAiABKAlCCLpIBXIDsAEBIksKHE1hY2hpbmVTZXJ2aWNlRGVsZXRlUmVzcG9uc2USKwoHbWFjaGluZRgBIAEoCzIaLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmUilQEKH01hY2hpbmVTZXJ2aWNlQk1DQ29tbWFuZFJlcXVlc3QSFgoEdXVpZBgBIAEoCUIIukgFcgOwAQESGQoHcHJvamVjdBgCIAEoCUIIukgFcgOwAQESPwoHY29tbWFuZBgDIAEoDjIkLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVCTUNDb21tYW5kQgi6SAWCAQIQASIiCiBNYWNoaW5lU2VydmljZUJNQ0NvbW1hbmRSZXNwb25zZSJQChtNYWNoaW5lU2VydmljZUdldEJNQ1JlcXVlc3QSFgoEdXVpZBgBIAEoCUIIukgFcgOwAQESGQoHcHJvamVjdBgCIAEoCUIIukgFcgOwAQEiaAocTWFjaGluZVNlcnZpY2VHZXRCTUNSZXNwb25zZRIWCgR1dWlkGAEgASgJQgi6SAVyA7ABARIwCgNibWMYAiABKAsyIy5tZXRhbHN0YWNrLmFwaS52Mi5NYWNoaW5lQk1DUmVwb3J0IsoDCgdNYWNoaW5lEhYKBHV1aWQYASABKAlCCLpIBXIDsAEBEiUKBG1ldGEYAiABKAsyFy5tZXRhbHN0YWNrLmFwaS52Mi5NZXRhEi8KCXBhcnRpdGlvbhgDIAEoCzIcLm1ldGFsc3RhY2suYXBpLnYyLlBhcnRpdGlvbhIWCgRyYWNrGAQgASgJQgi6SAVyAxiAARIWCgRyb29tGAUgASgJQgi6SAVyAxiAARIlCgRzaXplGAYgASgLMhcubWV0YWxzdGFjay5hcGkudjIuU2l6ZRI0CghoYXJkd2FyZRgHIAEoCzIiLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVIYXJkd2FyZRI4CgphbGxvY2F0aW9uGAggASgLMiQubWV0YWxzdGFjay5hcGkudjIuTWFjaGluZUFsbG9jYXRpb24SMAoGc3RhdHVzGAkgASgLMiAubWV0YWxzdGFjay5hcGkudjIuTWFjaGluZVN0YXR1cxJWChpyZWNlbnRfcHJvdmlzaW9uaW5nX2V2ZW50cxgKIAEoCzIyLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVSZWNlbnRQcm92aXNpb25pbmdFdmVudHMi7wEKDU1hY2hpbmVTdGF0dXMSNgoJY29uZGl0aW9uGAEgASgLMiMubWV0YWxzdGFjay5hcGkudjIuTWFjaGluZUNvbmRpdGlvbhJECglsZWRfc3RhdGUYAiABKAsyMS5tZXRhbHN0YWNrLmFwaS52Mi5NYWNoaW5lQ2hhc3Npc0lkZW50aWZ5TEVEU3RhdGUSQgoKbGl2ZWxpbmVzcxgDIAEoDjIkLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVMaXZlbGluZXNzQgi6SAWCAQIQARIcChRtZXRhbF9oYW1tZXJfdmVyc2lvbhgEIAEoCSKIAQoQTWFjaGluZUNvbmRpdGlvbhI4CgVzdGF0ZRgBIAEoDjIfLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVTdGF0ZUIIukgFggECEAESIAoLZGVzY3JpcHRpb24YAiABKAlCC7pICHIGyLOusQIBEhgKBmlzc3VlchgDIAEoCUIIukgFcgMYgAIihAYKEU1hY2hpbmVBbGxvY2F0aW9uEhYKBHV1aWQYASABKAlCCLpIBXIDsAEBEiUKBG1ldGEYAiABKAsyFy5tZXRhbHN0YWNrLmFwaS52Mi5NZXRhEhkKBG5hbWUYAyABKAlCC7pICHIGwLOusQIBEiAKC2Rlc2NyaXB0aW9uGAQgASgJQgu6SAhyBsizrrECARIcCgpjcmVhdGVkX2J5GAUgASgJQgi6SAVyAxiAARIZCgdwcm9qZWN0GAYgASgJQgi6SAVyA7ABARInCgVpbWFnZRgHIAEoCzIYLm1ldGFsc3RhY2suYXBpLnYyLkltYWdlEj4KEWZpbGVzeXN0ZW1fbGF5b3V0GAggASgLMiMubWV0YWxzdGFjay5hcGkudjIuRmlsZXN5c3RlbUxheW91dBIzCghuZXR3b3JrcxgJIAMoCzIhLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVOZXR3b3JrEhkKCGhvc3RuYW1lGAogASgJQge6SARyAmgBEjEKD3NzaF9wdWJsaWNfa2V5cxgLIAMoCUIYukgVkgES0KSzsQIBEDIiCHIGiLSusQIBEiEKCHVzZXJkYXRhGAwgASgJQg+6SAxyCvCzrrECARiAgAISSwoPYWxsb2NhdGlvbl90eXBlGA0gASgOMigubWV0YWxzdGFjay5hcGkudjIuTWFjaGluZUFsbG9jYXRpb25UeXBlQgi6SAWCAQIQARI4Cg5maXJld2FsbF9ydWxlcxgOIAEoCzIgLm1ldGFsc3RhY2suYXBpLnYyLkZpcmV3YWxsUnVsZXMSOwoLZG5zX3NlcnZlcnMYDyADKAsyHC5tZXRhbHN0YWNrLmFwaS52Mi5ETlNTZXJ2ZXJCCLpIBZIBAhADEjsKC250cF9zZXJ2ZXJzGBAgAygLMhwubWV0YWxzdGFjay5hcGkudjIuTlRQU2VydmVyQgi6SAWSAQIQChIqCgN2cG4YESABKAsyHS5tZXRhbHN0YWNrLmFwaS52Mi5NYWNoaW5lVlBOIlMKGE1hY2hpbmVBbGxvY2F0aW9uTmV0d29yaxIcCgduZXR3b3JrGAEgASgJQgu6SAhyBsCzrrECARIZCgNpcHMYAiADKAlCDLpICZIBBsCks7ECASJ/Cg1GaXJld2FsbFJ1bGVzEjUKBmVncmVzcxgBIAMoCzIlLm1ldGFsc3RhY2suYXBpLnYyLkZpcmV3YWxsRWdyZXNzUnVsZRI3CgdpbmdyZXNzGAIgAygLMiYubWV0YWxzdGFjay5hcGkudjIuRmlyZXdhbGxJbmdyZXNzUnVsZSKyAQoSRmlyZXdhbGxFZ3Jlc3NSdWxlEjkKCHByb3RvY29sGAEgASgOMh0ubWV0YWxzdGFjay5hcGkudjIuSVBQcm90b2NvbEIIukgFggECEAESHQoFcG9ydHMYAiADKA1CDrpIC5IBCCIGKgQY/P8DEhgKAnRvGAMgAygJQgy6SAmSAQa4pLOxAgESKAoHY29tbWVudBgEIAEoCUIXukgU2AEBcg8YZDILXlthLXpfIC1dKiQizwEKE0ZpcmV3YWxsSW5ncmVzc1J1bGUSOQoIcHJvdG9jb2wYASABKA4yHS5tZXRhbHN0YWNrLmFwaS52Mi5JUFByb3RvY29sQgi6SAWCAQIQARIdCgVwb3J0cxgCIAMoDUIOukgLkgEIIgYqBBj8/wMSGAoCdG8YAyADKAlCDLpICZIBBriks7ECARIaCgRmcm9tGAQgAygJQgy6SAmSAQa4pLOxAgESKAoHY29tbWVudBgFIAEoCUIXukgU2AEBcg8YZDILXlthLXpfIC1dKiQixgIKDk1hY2hpbmVOZXR3b3JrEg8KB25ldHdvcmsYASABKAkSHgoIcHJlZml4ZXMYAiADKAlCDLpICZIBBriks7ECARIqChRkZXN0aW5hdGlvbl9wcmVmaXhlcxgDIAMoCUIMukgJkgEGuKSzsQIBEhkKA2lwcxgEIAMoCUIMukgJkgEGwKSzsQIBEj4KDG5ldHdvcmtfdHlwZRgFIAEoDjIeLm1ldGFsc3RhY2suYXBpLnYyLk5ldHdvcmtUeXBlQgi6SAWCAQIQARI2CghuYXRfdHlwZRgGIAEoDjIaLm1ldGFsc3RhY2suYXBpLnYyLk5BVFR5cGVCCLpIBYIBAhABEgsKA3ZyZhgHIAEoBBILCgNhc24YCCABKA0SHgoHcHJvamVjdBgJIAEoCUIIukgFcgOwAQFIAIgBAUIKCghfcHJvamVjdCLaAQoPTWFjaGluZUhhcmR3YXJlEg4KBm1lbW9yeRgBIAEoBBI0CgVkaXNrcxgCIAMoCzIlLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVCbG9ja0RldmljZRIpCgRjcHVzGAMgAygLMhsubWV0YWxzdGFjay5hcGkudjIuTWV0YWxDUFUSKQoEZ3B1cxgEIAMoCzIbLm1ldGFsc3RhY2suYXBpLnYyLk1ldGFsR1BVEisKBG5pY3MYBSADKAsyHS5tZXRhbHN0YWNrLmFwaS52Mi5NYWNoaW5lTmljIl0KCE1ldGFsQ1BVEhgKBnZlbmRvchgBIAEoCUIIukgFcgMYgAISFwoFbW9kZWwYAiABKAlCCLpIBXIDGIACEg0KBWNvcmVzGAMgASgNEg8KB3RocmVhZHMYBCABKA0iPQoITWV0YWxHUFUSGAoGdmVuZG9yGAEgASgJQgi6SAVyAxiAAhIXCgVtb2RlbBgCIAEoCUIIukgFcgMYgAIi5QEKCk1hY2hpbmVOaWMSGAoDbWFjGAEgASgJQgu6SAhyBrizrrECARIZCgRuYW1lGAIgASgJQgu6SAhyBsCzrrECARIcCgppZGVudGlmaWVyGAMgASgJQgi6SAVyAxiAARIYCgZ2ZW5kb3IYBCABKAlCCLpIBXIDGIABEhcKBW1vZGVsGAUgASgJQgi6SAVyAxiAARINCgVzcGVlZBgGIAEoBBIwCgluZWlnaGJvcnMYByADKAsyHS5tZXRhbHN0YWNrLmFwaS52Mi5NYWNoaW5lTmljEhAKCGhvc3RuYW1lGAggASgJIj0KEk1hY2hpbmVCbG9ja0RldmljZRIZCgRuYW1lGAEgASgJQgu6SAhyBsCzrrECARIMCgRzaXplGAIgASgEIlsKHk1hY2hpbmVDaGFzc2lzSWRlbnRpZnlMRURTdGF0ZRIXCgV2YWx1ZRgBIAEoCUIIukgFcgMYgAESIAoLZGVzY3JpcHRpb24YAiABKAlCC7pICHIGyLOusQIBIooDChBNYWNoaW5lQk1DUmVwb3J0EioKA2JtYxgBIAEoCzIdLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVCTUMSLAoEYmlvcxgCIAEoCzIeLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVCaW9zEioKA2ZydRgDIAEoCzIdLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVGUlUSOwoMcG93ZXJfbWV0cmljGAQgASgLMiUubWV0YWxzdGFjay5hcGkudjIuTWFjaGluZVBvd2VyTWV0cmljEj0KDnBvd2VyX3N1cHBsaWVzGAUgAygLMiUubWV0YWxzdGFjay5hcGkudjIuTWFjaGluZVBvd2VyU3VwcGx5EkQKCWxlZF9zdGF0ZRgGIAEoCzIxLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVDaGFzc2lzSWRlbnRpZnlMRURTdGF0ZRIuCgp1cGRhdGVkX2F0GAcgASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcCJjCgtNYWNoaW5lQmlvcxIcCgd2ZXJzaW9uGAEgASgJQgu6SAhyBsizrrECARIbCgZ2ZW5kb3IYAiABKAlCC7pICHIGyLOusQIBEhkKBGRhdGUYAyABKAlCC7pICHIGyLOusQIBItsBCgpNYWNoaW5lQk1DEhkKB2FkZHJlc3MYASABKAlCCLpIBXIDgAIBEhgKA21hYxgCIAEoCUILukgIcga4s66xAgESGQoEdXNlchgDIAEoCUILukgIcgbIs66xAgESHQoIcGFzc3dvcmQYBCABKAlCC7pICHIGyLOusQIBEh4KCWludGVyZmFjZRgFIAEoCUILukgIcgbIs66xAgESHAoHdmVyc2lvbhgGIAEoCUILukgIcgbIs66xAgESIAoLcG93ZXJfc3RhdGUYByABKAlCC7pICHIGyLOusQIBIp4ECgpNYWNoaW5lRlJVEi0KE2NoYXNzaXNfcGFydF9udW1iZXIYASABKAlCC7pICHIGyLOusQIBSACIAQESLQoTY2hhc3Npc19wYXJ0X3NlcmlhbBgCIAEoCUILukgIcgbIs66xAgFIAYgBARIjCglib2FyZF9tZmcYAyABKAlCC7pICHIGyLOusQIBSAKIAQESKgoQYm9hcmRfbWZnX3NlcmlhbBgEIAEoCUILukgIcgbIs66xAgFIA4gBARIrChFib2FyZF9wYXJ0X251bWJlchgFIAEoCUILukgIcgbIs66xAgFIBIgBARIuChRwcm9kdWN0X21hbnVmYWN0dXJlchgGIAEoCUILukgIcgbIs66xAgFIBYgBARItChNwcm9kdWN0X3BhcnRfbnVtYmVyGAcgASgJQgu6SAhyBsizrrECAUgGiAEBEigKDnByb2R1Y3Rfc2VyaWFsGAggASgJQgu6SAhyBsizrrECAUgHiAEBQhYKFF9jaGFzc2lzX3BhcnRfbnVtYmVyQhYKFF9jaGFzc2lzX3BhcnRfc2VyaWFsQgwKCl9ib2FyZF9tZmdCEwoRX2JvYXJkX21mZ19zZXJpYWxCFAoSX2JvYXJkX3BhcnRfbnVtYmVyQhcKFV9wcm9kdWN0X21hbnVmYWN0dXJlckIWChRfcHJvZHVjdF9wYXJ0X251bWJlckIRCg9fcHJvZHVjdF9zZXJpYWwihQEKEk1hY2hpbmVQb3dlck1ldHJpYxIeChZhdmVyYWdlX2NvbnN1bWVkX3dhdHRzGAEgASgCEhcKD2ludGVydmFsX2luX21pbhgCIAEoAhIaChJtYXhfY29uc3VtZWRfd2F0dHMYAyABKAISGgoSbWluX2NvbnN1bWVkX3dhdHRzGAQgASgCIjMKEk1hY2hpbmVQb3dlclN1cHBseRIOCgZoZWFsdGgYASABKAkSDQoFc3RhdGUYAiABKAkipQIKH01hY2hpbmVSZWNlbnRQcm92aXNpb25pbmdFdmVudHMSOwoGZXZlbnRzGAEgAygLMisubWV0YWxzdGFjay5hcGkudjIuTWFjaGluZVByb3Zpc2lvbmluZ0V2ZW50EjMKD2xhc3RfZXZlbnRfdGltZRgCIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5UaW1lc3RhbXASRQoQbGFzdF9lcnJvcl9ldmVudBgDIAEoCzIrLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVQcm92aXNpb25pbmdFdmVudBJJCgVzdGF0ZRgEIAEoDjIwLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVQcm92aXNpb25pbmdFdmVudFN0YXRlQgi6SAWCAQIQASKfAQoYTWFjaGluZVByb3Zpc2lvbmluZ0V2ZW50EigKBHRpbWUYASABKAsyGi5nb29nbGUucHJvdG9idWYuVGltZXN0YW1wEkgKBWV2ZW50GAIgASgOMi8ubWV0YWxzdGFjay5hcGkudjIuTWFjaGluZVByb3Zpc2lvbmluZ0V2ZW50VHlwZUIIukgFggECEAESDwoHbWVzc2FnZRgDIAEoCSJrCgpNYWNoaW5lVlBOEh0KFWNvbnRyb2xfcGxhbmVfYWRkcmVzcxgBIAEoCRIQCghhdXRoX2tleRgCIAEoCRIRCgljb25uZWN0ZWQYAyABKAgSGQoDaXBzGAQgAygJQgy6SAmSAQbApLOxAgEi5gcKDE1hY2hpbmVRdWVyeRIbCgR1dWlkGAEgASgJQgi6SAVyA7ABAUgAiAEBEh4KBG5hbWUYAiABKAlCC7pICHIGwLOusQIBSAGIAQESIwoJcGFydGl0aW9uGAMgASgJQgu6SAhyBtCzrrECAUgCiAEBEh4KBHNpemUYBCABKAlCC7pICHIGwLOusQIBSAOIAQESHgoEcmFjaxgFIAEoCUILukgIcgbAs66xAgFIBIgBARIeCgRyb29tGAYgASgJQgu6SAhyBsCzrrECAUgFiAEBEi4KBmxhYmVscxgHIAEoCzIZLm1ldGFsc3RhY2suYXBpLnYyLkxhYmVsc0gGiAEBEkIKCmFsbG9jYXRpb24YCCABKAsyKS5tZXRhbHN0YWNrLmFwaS52Mi5NYWNoaW5lQWxsb2NhdGlvblF1ZXJ5SAeIAQESPAoHbmV0d29yaxgJIAEoCzImLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVOZXR3b3JrUXVlcnlICIgBARI0CgNuaWMYCiABKAsyIi5tZXRhbHN0YWNrLmFwaS52Mi5NYWNoaW5lTmljUXVlcnlICYgBARI2CgRkaXNrGAsgASgLMiMubWV0YWxzdGFjay5hcGkudjIuTWFjaGluZURpc2tRdWVyeUgKiAEBEjQKA2JtYxgMIAEoCzIiLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVCTUNRdWVyeUgLiAEBEjQKA2ZydRgNIAEoCzIiLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVGUlVRdWVyeUgMiAEBEj4KCGhhcmR3YXJlGA4gASgLMicubWV0YWxzdGFjay5hcGkudjIuTWFjaGluZUhhcmR3YXJlUXVlcnlIDYgBARIzCgVzdGF0ZRgPIAEoDjIfLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVTdGF0ZUgOiAEBEhQKB3dhaXRpbmcYECABKAhID4gBARIZCgxwcmVhbGxvY2F0ZWQYESABKAhIEIgBARIaCg1ub3RfYWxsb2NhdGVkGBIgASgISBGIAQFCBwoFX3V1aWRCBwoFX25hbWVCDAoKX3BhcnRpdGlvbkIHCgVfc2l6ZUIHCgVfcmFja0IHCgVfcm9vbUIJCgdfbGFiZWxzQg0KC19hbGxvY2F0aW9uQgoKCF9uZXR3b3JrQgYKBF9uaWNCBwoFX2Rpc2tCBgoEX2JtY0IGCgRfZnJ1QgsKCV9oYXJkd2FyZUIICgZfc3RhdGVCCgoIX3dhaXRpbmdCDwoNX3ByZWFsbG9jYXRlZEIQCg5fbm90X2FsbG9jYXRlZCKIBAoWTWFjaGluZUFsbG9jYXRpb25RdWVyeRIbCgR1dWlkGAEgASgJQgi6SAVyA7ABAUgAiAEBEh4KBG5hbWUYAiABKAlCC7pICHIGwLOusQIBSAGIAQESHgoHcHJvamVjdBgDIAEoCUIIukgFcgOwAQFIAogBARIfCgVpbWFnZRgEIAEoCUILukgIcgbAs66xAgFIA4gBARIrChFmaWxlc3lzdGVtX2xheW91dBgFIAEoCUILukgIcgbAs66xAgFIBIgBARIeCghob3N0bmFtZRgGIAEoCUIHukgEcgJoAUgFiAEBElAKD2FsbG9jYXRpb25fdHlwZRgHIAEoDjIoLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVBbGxvY2F0aW9uVHlwZUIIukgFggECEAFIBogBARIuCgZsYWJlbHMYCCABKAsyGS5tZXRhbHN0YWNrLmFwaS52Mi5MYWJlbHNIB4gBARIvCgN2cG4YCSABKAsyHS5tZXRhbHN0YWNrLmFwaS52Mi5NYWNoaW5lVlBOSAiIAQFCBwoFX3V1aWRCBwoFX25hbWVCCgoIX3Byb2plY3RCCAoGX2ltYWdlQhQKEl9maWxlc3lzdGVtX2xheW91dEILCglfaG9zdG5hbWVCEgoQX2FsbG9jYXRpb25fdHlwZUIJCgdfbGFiZWxzQgYKBF92cG4iqgEKE01hY2hpbmVOZXR3b3JrUXVlcnkSEAoIbmV0d29ya3MYASADKAkSHgoIcHJlZml4ZXMYAiADKAlCDLpICZIBBriks7ECARIqChRkZXN0aW5hdGlvbl9wcmVmaXhlcxgDIAMoCUIMukgJkgEGuKSzsQIBEhkKA2lwcxgEIAMoCUIMukgJkgEGwKSzsQIBEgwKBHZyZnMYBSADKAQSDAoEYXNucxgGIAMoDSKvAQoPTWFjaGluZU5pY1F1ZXJ5EiIKBG1hY3MYASADKAlCFLpIEZIBDhBkGAEiCHIGuLOusQIBEiAKBW5hbWVzGAIgAygJQhG6SA6SAQsQZBgBIgVyAxiAARIrCg1uZWlnaGJvcl9tYWNzGAMgAygJQhS6SBGSAQ4QZBgBIghyBrizrrECARIpCg5uZWlnaGJvcl9uYW1lcxgEIAMoCUIRukgOkgELEGQYASIFcgMYgAEiSwoQTWFjaGluZURpc2tRdWVyeRIeCgVuYW1lcxgBIAMoCUIPukgMkgEJEGQiBXIDGIABEhcKBXNpemVzGAIgAygEQgi6SAWSAQIQZCK5AQoPTWFjaGluZUJNQ1F1ZXJ5Eh0KB2FkZHJlc3MYASABKAlCB7pIBHICcAFIAIgBARIdCgNtYWMYAiABKAlCC7pICHIGuLOusQIBSAGIAQESGwoEdXNlchgDIAEoCUIIukgFcgMYgAFIAogBARIgCglpbnRlcmZhY2UYBCABKAlCCLpIBXIDGIABSAOIAQFCCgoIX2FkZHJlc3NCBgoEX21hY0IHCgVfdXNlckIMCgpfaW50ZXJmYWNlIoMECg9NYWNoaW5lRlJVUXVlcnkSKgoTY2hhc3Npc19wYXJ0X251bWJlchgBIAEoCUIIukgFcgMYgAFIAIgBARIqChNjaGFzc2lzX3BhcnRfc2VyaWFsGAIgASgJQgi6SAVyAxiAAUgBiAEBEiAKCWJvYXJkX21mZxgDIAEoCUIIukgFcgMYgAFIAogBARIjCgxib2FyZF9zZXJpYWwYBCABKAlCCLpIBXIDGIABSAOIAQESKAoRYm9hcmRfcGFydF9udW1iZXIYBSABKAlCCLpIBXIDGIABSASIAQESKwoUcHJvZHVjdF9tYW51ZmFjdHVyZXIYBiABKAlCCLpIBXIDGIABSAWIAQESKgoTcHJvZHVjdF9wYXJ0X251bWJlchgHIAEoCUIIukgFcgMYgAFIBogBARIlCg5wcm9kdWN0X3NlcmlhbBgIIAEoCUIIukgFcgMYgAFIB4gBAUIWChRfY2hhc3Npc19wYXJ0X251bWJlckIWChRfY2hhc3Npc19wYXJ0X3NlcmlhbEIMCgpfYm9hcmRfbWZnQg8KDV9ib2FyZF9zZXJpYWxCFAoSX2JvYXJkX3BhcnRfbnVtYmVyQhcKFV9wcm9kdWN0X21hbnVmYWN0dXJlckIWChRfcHJvZHVjdF9wYXJ0X251bWJlckIRCg9fcHJvZHVjdF9zZXJpYWwiXAoUTWFjaGluZUhhcmR3YXJlUXVlcnkSEwoGbWVtb3J5GAEgASgESACIAQESFgoJY3B1X2NvcmVzGAIgASgNSAGIAQFCCQoHX21lbW9yeUIMCgpfY3B1X2NvcmVzIuACChJNYWNoaW5lSXNzdWVzUXVlcnkSNgoNbWFjaGluZV9xdWVyeRgBIAEoCzIfLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVRdWVyeRJACgRvbmx5GAIgAygOMiMubWV0YWxzdGFjay5hcGkudjIuTWFjaGluZUlzc3VlVHlwZUINukgKkgEHIgWCAQIQARJACgRvbWl0GAMgAygOMiMubWV0YWxzdGFjay5hcGkudjIuTWFjaGluZUlzc3VlVHlwZUINukgKkgEHIgWCAQIQARJICghzZXZlcml0eRgEIAEoDjInLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVJc3N1ZVNldmVyaXR5Qgi6SAWCAQIQAUgAiAEBEjcKFGxhc3RfZXJyb3JfdGhyZXNob2xkGAUgASgLMhkuZ29vZ2xlLnByb3RvYnVmLkR1cmF0aW9uQgsKCV9zZXZlcml0eSJYCg1NYWNoaW5lSXNzdWVzEhYKBHV1aWQYASABKAlCCLpIBXIDsAEBEi8KBmlzc3VlcxgCIAMoCzIfLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVJc3N1ZSLnAQoMTWFjaGluZUlzc3VlEjsKBHR5cGUYASABKA4yIy5tZXRhbHN0YWNrLmFwaS52Mi5NYWNoaW5lSXNzdWVUeXBlQgi6SAWCAQIQARJDCghzZXZlcml0eRgCIAEoDjInLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVJc3N1ZVNldmVyaXR5Qgi6SAWCAQIQARIgCgtkZXNjcmlwdGlvbhgDIAEoCUILukgIcgbIs66xAgESIgoNcmVmZXJlbmNlX3VybBgEIAEoCUILukgIcgbgs66xAgESDwoHZGV0YWlscxgFIAEoCSplCgpJUFByb3RvY29sEhsKF0lQX1BST1RPQ09MX1VOU1BFQ0lGSUVEEAASHAoPSVBfUFJPVE9DT0xfVENQEAEaB4KyGQN0Y3ASHAoPSVBfUFJPVE9DT0xfVURQEAIaB4KyGQN1ZHAqrQEKDE1hY2hpbmVTdGF0ZRIjChlNQUNISU5FX1NUQVRFX1VOU1BFQ0lGSUVEEAAaBIKyGQASJgoVTUFDSElORV9TVEFURV9UQUlOVEVEEAEaC4KyGQd0YWludGVkEiQKFE1BQ0hJTkVfU1RBVEVfTE9DS0VEEAIaCoKyGQZsb2NrZWQSKgoXTUFDSElORV9TVEFURV9BVkFJTEFCTEUQAxoNgrIZCWF2YWlsYWJsZSrfAQodTWFjaGluZVByb3Zpc2lvbmluZ0V2ZW50U3RhdGUSNgosTUFDSElORV9QUk9WSVNJT05JTkdfRVZFTlRfU1RBVEVfVU5TUEVDSUZJRUQQABoEgrIZABI9CipNQUNISU5FX1BST1ZJU0lPTklOR19FVkVOVF9TVEFURV9DUkFTSExPT1AQARoNgrIZCWNyYXNobG9vcBJHCi9NQUNISU5FX1BST1ZJU0lPTklOR19FVkVOVF9TVEFURV9GQUlMRURfUkVDTEFJTRACGhKCshkOZmFpbGVkLXJlY2xhaW0qnwYKHE1hY2hpbmVQcm92aXNpb25pbmdFdmVudFR5cGUSLworTUFDSElORV9QUk9WSVNJT05JTkdfRVZFTlRfVFlQRV9VTlNQRUNJRklFRBAAEjQKJU1BQ0hJTkVfUFJPVklTSU9OSU5HX0VWRU5UX1RZUEVfQUxJVkUQARoJgrIZBUFsaXZlEjgKJ01BQ0hJTkVfUFJPVklTSU9OSU5HX0VWRU5UX1RZUEVfQ1JBU0hFRBACGguCshkHQ3Jhc2hlZBJACitNQUNISU5FX1BST1ZJU0lPTklOR19FVkVOVF9UWVBFX1BYRV9CT09USU5HEAMaD4KyGQtQWEUgQm9vdGluZxJGCi5NQUNISU5FX1BST1ZJU0lPTklOR19FVkVOVF9UWVBFX1BMQU5ORURfUkVCT09UEAQaEoKyGQ5QbGFubmVkIFJlYm9vdBI8CilNQUNISU5FX1BST1ZJU0lPTklOR19FVkVOVF9UWVBFX1BSRVBBUklORxAFGg2CshkJUHJlcGFyaW5nEkAKK01BQ0hJTkVfUFJPVklTSU9OSU5HX0VWRU5UX1RZUEVfUkVHSVNURVJJTkcQBhoPgrIZC1JlZ2lzdGVyaW5nEjgKJ01BQ0hJTkVfUFJPVklTSU9OSU5HX0VWRU5UX1RZUEVfV0FJVElORxAHGguCshkHV2FpdGluZxI+CipNQUNISU5FX1BST1ZJU0lPTklOR19FVkVOVF9UWVBFX0lOU1RBTExJTkcQCBoOgrIZCkluc3RhbGxpbmcSTgoyTUFDSElORV9QUk9WSVNJT05JTkdfRVZFTlRfVFlQRV9CT09USU5HX05FV19LRVJORUwQCRoWgrIZEkJvb3RpbmcgTmV3IEtlcm5lbBJACitNQUNISU5FX1BST1ZJU0lPTklOR19FVkVOVF9UWVBFX1BIT05FRF9IT01FEAoaD4KyGQtQaG9uZWQgSG9tZRJICi9NQUNISU5FX1BST1ZJU0lPTklOR19FVkVOVF9UWVBFX01BQ0hJTkVfUkVDTEFJTRALGhOCshkPTWFjaGluZSBSZWNsYWltKroBChFNYWNoaW5lTGl2ZWxpbmVzcxIoCh5NQUNISU5FX0xJVkVMSU5FU1NfVU5TUEVDSUZJRUQQABoEgrIZABInChhNQUNISU5FX0xJVkVMSU5FU1NfQUxJVkUQARoJgrIZBWFsaXZlEiUKF01BQ0hJTkVfTElWRUxJTkVTU19ERUFEEAIaCIKyGQRkZWFkEisKGk1BQ0hJTkVfTElWRUxJTkVTU19VTktOT1dOEAMaC4KyGQd1bmtub3duKqwBChVNYWNoaW5lQWxsb2NhdGlvblR5cGUSLQojTUFDSElORV9BTExPQ0FUSU9OX1RZUEVfVU5TUEVDSUZJRUQQABoEgrIZABIwCh9NQUNISU5FX0FMTE9DQVRJT05fVFlQRV9NQUNISU5FEAEaC4KyGQdtYWNoaW5lEjIKIE1BQ0hJTkVfQUxMT0NBVElPTl9UWVBFX0ZJUkVXQUxMEAIaDIKyGQhmaXJld2FsbCr+BAoRTWFjaGluZUJNQ0NvbW1hbmQSIwofTUFDSElORV9CTUNfQ09NTUFORF9VTlNQRUNJRklFRBAAEiIKFk1BQ0hJTkVfQk1DX0NPTU1BTkRfT04QARoGgrIZAm9uEiQKF01BQ0hJTkVfQk1DX0NPTU1BTkRfT0ZGEAIaB4KyGQNvZmYSKAoZTUFDSElORV9CTUNfQ09NTUFORF9SRVNFVBADGgmCshkFcmVzZXQSKAoZTUFDSElORV9CTUNfQ09NTUFORF9DWUNMRRAEGgmCshkFY3ljbGUSNgogTUFDSElORV9CTUNfQ09NTUFORF9CT09UX1RPX0JJT1MQBRoQgrIZDGJvb3QtdG8tYmlvcxI6CiJNQUNISU5FX0JNQ19DT01NQU5EX0JPT1RfRlJPTV9ESVNLEAYaEoKyGQ5ib290LWZyb20tZGlzaxI4CiFNQUNISU5FX0JNQ19DT01NQU5EX0JPT1RfRlJPTV9QWEUQBxoRgrIZDWJvb3QtZnJvbS1weGUSPAojTUFDSElORV9CTUNfQ09NTUFORF9JREVOVElGWV9MRURfT04QCBoTgrIZD2lkZW50aWZ5LWxlZC1vbhI+CiRNQUNISU5FX0JNQ19DT01NQU5EX0lERU5USUZZX0xFRF9PRkYQCRoUgrIZEGlkZW50aWZ5LWxlZC1vZmYSPAojTUFDSElORV9CTUNfQ09NTUFORF9NQUNISU5FX0RFTEVURUQQChoTgrIZD21hY2hpbmUtZGVsZXRlZBI8CiNNQUNISU5FX0JNQ19DT01NQU5EX01BQ0hJTkVfQ1JFQVRFRBALGhOCshkPbWFjaGluZS1jcmVhdGVkKvMGChBNYWNoaW5lSXNzdWVUeXBlEiIKHk1BQ0hJTkVfSVNTVUVfVFlQRV9VTlNQRUNJRklFRBAAEjkKIU1BQ0hJTkVfSVNTVUVfVFlQRV9BU05fVU5JUVVFTkVTUxABGhKCshkOYXNuLW5vdC11bmlxdWUSPwokTUFDSElORV9JU1NVRV9UWVBFX0JNQ19JTkZPX09VVERBVEVEEAIaFYKyGRFibWMtaW5mby1vdXRkYXRlZBJCCiZNQUNISU5FX0lTU1VFX1RZUEVfQk1DX05PTl9ESVNUSU5DVF9JUBADGhaCshkSYm1jLW5vLWRpc3RpbmN0LWlwEjkKIU1BQ0hJTkVfSVNTVUVfVFlQRV9CTUNfV0lUSE9VVF9JUBAEGhKCshkOYm1jLXdpdGhvdXQtaXASOwoiTUFDSElORV9JU1NVRV9UWVBFX0JNQ19XSVRIT1VUX01BQxAFGhOCshkPYm1jLXdpdGhvdXQtbWFjEjAKHU1BQ0hJTkVfSVNTVUVfVFlQRV9DUkFTSF9MT09QEAYaDYKyGQljcmFzaGxvb3ASSQopTUFDSElORV9JU1NVRV9UWVBFX0ZBSUxFRF9NQUNISU5FX1JFQ0xBSU0QBxoagrIZFmZhaWxlZC1tYWNoaW5lLXJlY2xhaW0SPQojTUFDSElORV9JU1NVRV9UWVBFX0xBU1RfRVZFTlRfRVJST1IQCBoUgrIZEGxhc3QtZXZlbnQtZXJyb3ISOwoiTUFDSElORV9JU1NVRV9UWVBFX0xJVkVMSU5FU1NfREVBRBAJGhOCshkPbGl2ZWxpbmVzcy1kZWFkEk0KK01BQ0hJTkVfSVNTVUVfVFlQRV9MSVZFTElORVNTX05PVF9BVkFJTEFCTEUQChocgrIZGGxpdmVsaW5lc3Mtbm90LWF2YWlsYWJsZRJBCiVNQUNISU5FX0lTU1VFX1RZUEVfTElWRUxJTkVTU19VTktOT1dOEAsaFoKyGRJsaXZlbGluZXNzLXVua25vd24SQQolTUFDSElORV9JU1NVRV9UWVBFX05PX0VWRU5UX0NPTlRBSU5FUhAMGhaCshkSbm8tZXZlbnQtY29udGFpbmVyEjUKH01BQ0hJTkVfSVNTVUVfVFlQRV9OT19QQVJUSVRJT04QDRoQgrIZDG5vLXBhcnRpdGlvbirLAQoUTWFjaGluZUlzc3VlU2V2ZXJpdHkSJgoiTUFDSElORV9JU1NVRV9TRVZFUklUWV9VTlNQRUNJRklFRBAAEisKHE1BQ0hJTkVfSVNTVUVfU0VWRVJJVFlfTUlOT1IQARoJgrIZBW1pbm9yEisKHE1BQ0hJTkVfSVNTVUVfU0VWRVJJVFlfTUFKT1IQAhoJgrIZBW1ham9yEjEKH01BQ0hJTkVfSVNTVUVfU0VWRVJJVFlfQ1JJVElDQUwQAxoMgrIZCGNyaXRpY2FsMtEGCg5NYWNoaW5lU2VydmljZRJtCgNHZXQSKy5tZXRhbHN0YWNrLmFwaS52Mi5NYWNoaW5lU2VydmljZUdldFJlcXVlc3QaLC5tZXRhbHN0YWNrLmFwaS52Mi5NYWNoaW5lU2VydmljZUdldFJlc3BvbnNlIgvK8xgDAQID4PMYAhJ1CgZDcmVhdGUSLi5tZXRhbHN0YWNrLmFwaS52Mi5NYWNoaW5lU2VydmljZUNyZWF0ZVJlcXVlc3QaLy5tZXRhbHN0YWNrLmFwaS52Mi5NYWNoaW5lU2VydmljZUNyZWF0ZVJlc3BvbnNlIgrK8xgCAQLg8xgBEnUKBlVwZGF0ZRIuLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVTZXJ2aWNlVXBkYXRlUmVxdWVzdBovLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVTZXJ2aWNlVXBkYXRlUmVzcG9uc2UiCsrzGAIBAuDzGAEScAoETGlzdBIsLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVTZXJ2aWNlTGlzdFJlcXVlc3QaLS5tZXRhbHN0YWNrLmFwaS52Mi5NYWNoaW5lU2VydmljZUxpc3RSZXNwb25zZSILyvMYAwECA+DzGAISdQoGRGVsZXRlEi4ubWV0YWxzdGFjay5hcGkudjIuTWFjaGluZVNlcnZpY2VEZWxldGVSZXF1ZXN0Gi8ubWV0YWxzdGFjay5hcGkudjIuTWFjaGluZVNlcnZpY2VEZWxldGVSZXNwb25zZSIKyvMYAgEC4PMYARKBAQoKQk1DQ29tbWFuZBIyLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVTZXJ2aWNlQk1DQ29tbWFuZFJlcXVlc3QaMy5tZXRhbHN0YWNrLmFwaS52Mi5NYWNoaW5lU2VydmljZUJNQ0NvbW1hbmRSZXNwb25zZSIKyvMYAgEC4PMYARJ1CgZHZXRCTUMSLi5tZXRhbHN0YWNrLmFwaS52Mi5NYWNoaW5lU2VydmljZUdldEJNQ1JlcXVlc3QaLy5tZXRhbHN0YWNrLmFwaS52Mi5NYWNoaW5lU2VydmljZUdldEJNQ1Jlc3BvbnNlIgrK8xgCAQLg8xgBQsIBChVjb20ubWV0YWxzdGFjay5hcGkudjJCDE1hY2hpbmVQcm90b1ABWjVnaXRodWIuY29tL21ldGFsLXN0YWNrL2FwaS9nby9tZXRhbHN0YWNrL2FwaS92MjthcGl2MqICA01BWKoCEU1ldGFsc3RhY2suQXBpLlYyygIRTWV0YWxzdGFja1xBcGlcVjLiAh1NZXRhbHN0YWNrXEFwaVxWMlxHUEJNZXRhZGF0YeoCE01ldGFsc3RhY2s6OkFwaTo6VjJiBnByb3RvMw", [file_buf_validate_validate, file_google_protobuf_duration, file_google_protobuf_timestamp, file_metalstack_api_v2_common, file_metalstack_api_v2_filesystem, file_metalstack_api_v2_image, file_metalstack_api_v2_network, file_metalstack_api_v2_partition, file_metalstack_api_v2_predefined_rules, file_metalstack_api_v2_size]); /** - * MachineServiceGetRequest is the request payload for a machine get request + * MachineServiceGetRequest is the request payload for a machine get request. * * @generated from message metalstack.api.v2.MachineServiceGetRequest */ @@ -57,13 +57,13 @@ export const MachineServiceGetRequestSchema: GenMessage & { /** - * Machine is the machine requested + * Machine is the machine requested. * * @generated from field: metalstack.api.v2.Machine machine = 1; */ @@ -78,7 +78,7 @@ export const MachineServiceGetResponseSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_machine, 3); /** - * MachineServiceCreateResponse is the response payload for a machine create request + * MachineServiceCreateResponse is the response payload for a machine create request. * * @generated from message metalstack.api.v2.MachineServiceCreateResponse */ @@ -272,7 +272,7 @@ export const MachineServiceCreateResponseSchema: GenMessage & { /** - * Machines are the machines requested by a list request + * Machines are the machines requested by a list request. * * @generated from field: repeated metalstack.api.v2.Machine machines = 1; */ @@ -398,7 +398,7 @@ export const MachineServiceListResponseSchema: GenMessage & { partition?: Partition | undefined; /** - * Rack where this machine is located + * Rack where this machine is located. * * @generated from field: string rack = 4; */ rack: string; /** - * Room where this machine is located + * Room where this machine is located. * * @generated from field: string room = 5; */ @@ -615,14 +615,14 @@ export type Machine = Message<"metalstack.api.v2.Machine"> & { allocation?: MachineAllocation | undefined; /** - * Status contains several status details related to this machine + * Status contains several status details related to this machine. * * @generated from field: metalstack.api.v2.MachineStatus status = 9; */ status?: MachineStatus | undefined; /** - * MachineRecentProvisioningEvents contains the recent provisioning events + * MachineRecentProvisioningEvents contains the recent provisioning events. * * @generated from field: metalstack.api.v2.MachineRecentProvisioningEvents recent_provisioning_events = 10; */ @@ -637,20 +637,20 @@ export const MachineSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_machine, 15); /** - * MachineStatus contains several status details related to this machine + * MachineStatus contains several status details related to this machine. * * @generated from message metalstack.api.v2.MachineStatus */ export type MachineStatus = Message<"metalstack.api.v2.MachineStatus"> & { /** - * Condition describes the availability + * Condition describes the availability. * * @generated from field: metalstack.api.v2.MachineCondition condition = 1; */ condition?: MachineCondition | undefined; /** - * LEDState indicates the state of the indicator LED on this machine + * LEDState indicates the state of the indicator LED on this machine. * * @generated from field: metalstack.api.v2.MachineChassisIdentifyLEDState led_state = 2; */ @@ -679,7 +679,7 @@ export const MachineStatusSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_machine, 16); /** - * MachineCondition describes the availability of this machine + * MachineCondition describes the availability of this machine. * * @generated from message metalstack.api.v2.MachineCondition */ @@ -714,7 +714,7 @@ export const MachineConditionSchema: GenMessage = /*@__PURE__* messageDesc(file_metalstack_api_v2_machine, 17); /** - * MachineAllocation contains properties if this machine is allocated + * MachineAllocation contains properties if this machine is allocated. * * @generated from message metalstack.api.v2.MachineAllocation */ @@ -849,7 +849,7 @@ export const MachineAllocationSchema: GenMessage = /*@__PURE_ messageDesc(file_metalstack_api_v2_machine, 18); /** - * MachineAllocationNetwork defines which network should be attached to a machine and if ips should be autoacquired + * MachineAllocationNetwork defines which network should be attached to a machine and if ips should be autoacquired. * * @generated from message metalstack.api.v2.MachineAllocationNetwork */ @@ -863,7 +863,7 @@ export type MachineAllocationNetwork = Message<"metalstack.api.v2.MachineAllocat /** * IPs to to attach to this machine additionally - * If none given, one ip address is acquired per network for the machine + * If none given, one ip address is acquired per network for the machine. * Order of ips is preserved on the loopback interface. * * @generated from field: repeated string ips = 2; @@ -879,20 +879,20 @@ export const MachineAllocationNetworkSchema: GenMessage & { /** - * Egress list of egress rules to be deployed during firewall allocation + * Egress list of egress rules to be deployed during firewall allocation. * * @generated from field: repeated metalstack.api.v2.FirewallEgressRule egress = 1; */ egress: FirewallEgressRule[]; /** - * Ingress list of ingress rules to be deployed during firewall allocation + * Ingress list of ingress rules to be deployed during firewall allocation. * * @generated from field: repeated metalstack.api.v2.FirewallIngressRule ingress = 2; */ @@ -907,7 +907,7 @@ export const FirewallRulesSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_machine, 20); /** - * FirewallEgressRule defines rules for outgoing traffic + * FirewallEgressRule defines rules for outgoing traffic. * * @generated from message metalstack.api.v2.FirewallEgressRule */ @@ -949,7 +949,7 @@ export const FirewallEgressRuleSchema: GenMessage = /*@__PUR messageDesc(file_metalstack_api_v2_machine, 21); /** - * FirewallIngressRule defines rules for incoming traffic + * FirewallIngressRule defines rules for incoming traffic. * * @generated from message metalstack.api.v2.FirewallIngressRule */ @@ -998,7 +998,7 @@ export const FirewallIngressRuleSchema: GenMessage = /*@__P messageDesc(file_metalstack_api_v2_machine, 22); /** - * MachineNetwork contains details which network should be created on a allocated machine + * MachineNetwork contains details which network should be created on a allocated machine. * * @generated from message metalstack.api.v2.MachineNetwork */ @@ -1018,7 +1018,7 @@ export type MachineNetwork = Message<"metalstack.api.v2.MachineNetwork"> & { prefixes: string[]; /** - * DestinationPrefixes prefixes that are reachable within this network + * DestinationPrefixes prefixes that are reachable within this network. * * @generated from field: repeated string destination_prefixes = 3; */ @@ -1039,7 +1039,7 @@ export type MachineNetwork = Message<"metalstack.api.v2.MachineNetwork"> & { networkType: NetworkType; /** - * NatType what type of nat if any should be used + * NatType what type of nat if any should be used. * * @generated from field: metalstack.api.v2.NATType nat_type = 6; */ @@ -1060,7 +1060,7 @@ export type MachineNetwork = Message<"metalstack.api.v2.MachineNetwork"> & { asn: number; /** - * Project is the project uuid associated with this network + * Project is the project uuid associated with this network. * * @generated from field: optional string project = 9; */ @@ -1075,7 +1075,7 @@ export const MachineNetworkSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_machine, 23); /** - * MachineHardware contains hardware details + * MachineHardware contains hardware details. * * @generated from message metalstack.api.v2.MachineHardware */ @@ -1124,7 +1124,7 @@ export const MachineHardwareSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_machine, 24); /** - * MetalCPU contains details of a cpu in this machine + * MetalCPU contains details of a cpu in this machine. * * @generated from message metalstack.api.v2.MetalCPU */ @@ -1166,7 +1166,7 @@ export const MetalCPUSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_machine, 25); /** - * MetalGPU contains details of a gpu in this machine + * MetalGPU contains details of a gpu in this machine. * * @generated from message metalstack.api.v2.MetalGPU */ @@ -1194,7 +1194,7 @@ export const MetalGPUSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_machine, 26); /** - * MachineNic contains details of a network interface of this machine + * MachineNic contains details of a network interface of this machine. * * @generated from message metalstack.api.v2.MachineNic */ @@ -1264,7 +1264,7 @@ export const MachineNicSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_machine, 27); /** - * MachineBlockDevice contains details of a block device of this machine + * MachineBlockDevice contains details of a block device of this machine. * * @generated from message metalstack.api.v2.MachineBlockDevice */ @@ -1292,7 +1292,7 @@ export const MachineBlockDeviceSchema: GenMessage = /*@__PUR messageDesc(file_metalstack_api_v2_machine, 28); /** - * MachineChassisIdentifyLEDState describes the identifier led state + * MachineChassisIdentifyLEDState describes the identifier led state. * * @generated from message metalstack.api.v2.MachineChassisIdentifyLEDState */ @@ -1320,55 +1320,55 @@ export const MachineChassisIdentifyLEDStateSchema: GenMessage & { /** - * Bmc contains bmc details + * Bmc contains bmc details. * * @generated from field: metalstack.api.v2.MachineBMC bmc = 1; */ bmc?: MachineBMC | undefined; /** - * Bios contains bios details + * Bios contains bios details. * * @generated from field: metalstack.api.v2.MachineBios bios = 2; */ bios?: MachineBios | undefined; /** - * Fru contains field replaceable unit details + * Fru contains field replaceable unit details. * * @generated from field: metalstack.api.v2.MachineFRU fru = 3; */ fru?: MachineFRU | undefined; /** - * PowerMetric contains the power statistics of the machine + * PowerMetric contains the power statistics of the machine. * * @generated from field: metalstack.api.v2.MachinePowerMetric power_metric = 4; */ powerMetric?: MachinePowerMetric | undefined; /** - * PowerSupplies contains details about all power supplies and their state + * PowerSupplies contains details about all power supplies and their state. * * @generated from field: repeated metalstack.api.v2.MachinePowerSupply power_supplies = 5; */ powerSupplies: MachinePowerSupply[]; /** - * LedState indicates the state of the indicator LED on this machine + * LedState indicates the state of the indicator LED on this machine. * * @generated from field: metalstack.api.v2.MachineChassisIdentifyLEDState led_state = 6; */ ledState?: MachineChassisIdentifyLEDState | undefined; /** - * UpdatedAt contains the date when this data was last updated + * UpdatedAt contains the date when this data was last updated. * * @generated from field: google.protobuf.Timestamp updated_at = 7; */ @@ -1383,7 +1383,7 @@ export const MachineBMCReportSchema: GenMessage = /*@__PURE__* messageDesc(file_metalstack_api_v2_machine, 30); /** - * MachineBios contains BIOS details of this machine + * MachineBios contains BIOS details of this machine. * * @generated from message metalstack.api.v2.MachineBios */ @@ -1418,7 +1418,7 @@ export const MachineBiosSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_machine, 31); /** - * MachineBMC describe details of the ipmi or out of band device + * MachineBMC describe details of the ipmi or out of band device. * * @generated from message metalstack.api.v2.MachineBMC */ @@ -1481,62 +1481,62 @@ export const MachineBMCSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_machine, 32); /** - * MachineFRU describes details to the machine which are required in case of a necessary replacement + * MachineFRU describes details to the machine which are required in case of a necessary replacement. * * @generated from message metalstack.api.v2.MachineFRU */ export type MachineFRU = Message<"metalstack.api.v2.MachineFRU"> & { /** - * ChassisPartNumber is the part number of the machine chassis + * ChassisPartNumber is the part number of the machine chassis. * * @generated from field: optional string chassis_part_number = 1; */ chassisPartNumber?: string | undefined; /** - * ChassisPartSerial is the serial number of the machine chassis + * ChassisPartSerial is the serial number of the machine chassis. * * @generated from field: optional string chassis_part_serial = 2; */ chassisPartSerial?: string | undefined; /** - * BoardMfg is the short description of the mainboard + * BoardMfg is the short description of the mainboard. * * @generated from field: optional string board_mfg = 3; */ boardMfg?: string | undefined; /** - * BoardMfgSerial is the serial number of the mainboard + * BoardMfgSerial is the serial number of the mainboard. * * @generated from field: optional string board_mfg_serial = 4; */ boardMfgSerial?: string | undefined; /** - * BoardPartNumber is the part number of the mainboard + * BoardPartNumber is the part number of the mainboard. * * @generated from field: optional string board_part_number = 5; */ boardPartNumber?: string | undefined; /** - * ProductManufacturer is the manufacturer of the machine + * ProductManufacturer is the manufacturer of the machine. * * @generated from field: optional string product_manufacturer = 6; */ productManufacturer?: string | undefined; /** - * ProductPartNumber is the part number of the machine + * ProductPartNumber is the part number of the machine. * * @generated from field: optional string product_part_number = 7; */ productPartNumber?: string | undefined; /** - * ProductSerial is the serial number of the machine + * ProductSerial is the serial number of the machine. * * @generated from field: optional string product_serial = 8; */ @@ -1551,7 +1551,7 @@ export const MachineFRUSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_machine, 33); /** - * MachinePowerMetric contains metrics of the power consumption of a machine + * MachinePowerMetric contains metrics of the power consumption of a machine. * * @generated from message metalstack.api.v2.MachinePowerMetric */ @@ -1602,7 +1602,7 @@ export const MachinePowerMetricSchema: GenMessage = /*@__PUR messageDesc(file_metalstack_api_v2_machine, 34); /** - * MachinePowerSupply contains details of the power supply of a machine + * MachinePowerSupply contains details of the power supply of a machine. * * @generated from message metalstack.api.v2.MachinePowerSupply */ @@ -1657,7 +1657,7 @@ export type MachineRecentProvisioningEvents = Message<"metalstack.api.v2.Machine lastErrorEvent?: MachineProvisioningEvent | undefined; /** - * State can be either CrashLoop, FailedReclaim or something else + * State can be either CrashLoop, FailedReclaim or something else. * * @generated from field: metalstack.api.v2.MachineProvisioningEventState state = 4; */ @@ -1672,7 +1672,7 @@ export const MachineRecentProvisioningEventsSchema: GenMessage & { authKey: string; /** - * Connected indicate if this machine is connected to the VPN + * Connected indicate if this machine is connected to the VPN. * * @generated from field: bool connected = 3; */ @@ -2235,7 +2235,7 @@ export const MachineHardwareQuerySchema: GenMessage = /*@_ messageDesc(file_metalstack_api_v2_machine, 46); /** - * MachineIssuesQuery defines which machine issues should be listed + * MachineIssuesQuery defines which machine issues should be listed. * * @generated from message metalstack.api.v2.MachineIssuesQuery */ @@ -2248,7 +2248,7 @@ export type MachineIssuesQuery = Message<"metalstack.api.v2.MachineIssuesQuery"> machineQuery?: MachineQuery | undefined; /** - * Only includes the specified machine issue types + * Only includes the specified machine issue types. * * @generated from field: repeated metalstack.api.v2.MachineIssueType only = 2; */ @@ -2262,14 +2262,14 @@ export type MachineIssuesQuery = Message<"metalstack.api.v2.MachineIssuesQuery"> omit: MachineIssueType[]; /** - * Severity filters issue for given severity + * Severity filters issue for given severity. * * @generated from field: optional metalstack.api.v2.MachineIssueSeverity severity = 4; */ severity?: MachineIssueSeverity | undefined; /** - * LastErrorThreshold defines the last error threshold + * LastErrorThreshold defines the last error threshold. * * @generated from field: google.protobuf.Duration last_error_threshold = 5; */ @@ -2284,7 +2284,7 @@ export const MachineIssuesQuerySchema: GenMessage = /*@__PUR messageDesc(file_metalstack_api_v2_machine, 47); /** - * MachineIssues is a list of issues for a machine + * MachineIssues is a list of issues for a machine. * * @generated from message metalstack.api.v2.MachineIssues */ @@ -2312,7 +2312,7 @@ export const MachineIssuesSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_machine, 48); /** - * MachineIssue contains details of one issue + * MachineIssue contains details of one issue. * * @generated from message metalstack.api.v2.MachineIssue */ @@ -2325,28 +2325,28 @@ export type MachineIssue = Message<"metalstack.api.v2.MachineIssue"> & { type: MachineIssueType; /** - * Severity specifies the severity of an issue + * Severity specifies the severity of an issue. * * @generated from field: metalstack.api.v2.MachineIssueSeverity severity = 2; */ severity: MachineIssueSeverity; /** - * Description provides an issue description + * Description provides an issue description. * * @generated from field: string description = 3; */ description: string; /** - * RefURL provides a link to a more detailed issue description in the metal-stack documentation + * RefURL provides a link to a more detailed issue description in the metal-stack documentation. * * @generated from field: string reference_url = 4; */ referenceUrl: string; /** - * Details may contain additional details on an evaluated issue + * Details may contain additional details on an evaluated issue. * * @generated from field: string details = 5; */ @@ -2361,27 +2361,27 @@ export const MachineIssueSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_machine, 49); /** - * IPProtocol defines tcp|udp + * IPProtocol defines tcp|udp. * * @generated from enum metalstack.api.v2.IPProtocol */ export enum IPProtocol { /** - * IP_PROTOCOL_UNSPECIFIED is not specified + * IP_PROTOCOL_UNSPECIFIED is not specified. * * @generated from enum value: IP_PROTOCOL_UNSPECIFIED = 0; */ IP_PROTOCOL_UNSPECIFIED = 0, /** - * IP_PROTOCOL_TCP is tcp + * IP_PROTOCOL_TCP is tcp. * * @generated from enum value: IP_PROTOCOL_TCP = 1; */ IP_PROTOCOL_TCP = 1, /** - * IP_PROTOCOL_UDP is udp + * IP_PROTOCOL_UDP is udp. * * @generated from enum value: IP_PROTOCOL_UDP = 2; */ @@ -2395,13 +2395,13 @@ export const IPProtocolSchema: GenEnum = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_machine, 0); /** - * MachineState defines if the machine was locked or reserved from a operator + * MachineState defines if the machine was locked or reserved from a operator. * * @generated from enum metalstack.api.v2.MachineState */ export enum MachineState { /** - * MACHINE_STATE_UNSPECIFIED is not specified + * MACHINE_STATE_UNSPECIFIED is not specified. * * @generated from enum value: MACHINE_STATE_UNSPECIFIED = 0; */ @@ -2442,7 +2442,7 @@ export const MachineStateSchema: GenEnum = /*@__PURE__*/ */ export enum MachineProvisioningEventState { /** - * MACHINE_PROVISIONING_EVENT_STATE_UNSPECIFIED is not specified + * MACHINE_PROVISIONING_EVENT_STATE_UNSPECIFIED is not specified. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_STATE_UNSPECIFIED = 0; */ @@ -2470,13 +2470,13 @@ export const MachineProvisioningEventStateSchema: GenEnum = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_machine, 4); /** - * MachineAllocationType defines if this is a machine or a firewall + * MachineAllocationType defines if this is a machine or a firewall. * * @generated from enum metalstack.api.v2.MachineAllocationType */ export enum MachineAllocationType { /** - * MACHINE_ALLOCATION_TYPE_UNSPECIFIED is unspecified + * MACHINE_ALLOCATION_TYPE_UNSPECIFIED is unspecified. * * @generated from enum value: MACHINE_ALLOCATION_TYPE_UNSPECIFIED = 0; */ UNSPECIFIED = 0, /** - * MACHINE_ALLOCATION_TYPE_MACHINE is a machine + * MACHINE_ALLOCATION_TYPE_MACHINE is a machine. * * @generated from enum value: MACHINE_ALLOCATION_TYPE_MACHINE = 1; */ MACHINE = 1, /** - * MACHINE_ALLOCATION_TYPE_FIREWALL is a firewall + * MACHINE_ALLOCATION_TYPE_FIREWALL is a firewall. * * @generated from enum value: MACHINE_ALLOCATION_TYPE_FIREWALL = 2; */ @@ -2642,41 +2642,41 @@ export const MachineAllocationTypeSchema: GenEnum = /*@__ enumDesc(file_metalstack_api_v2_machine, 5); /** - * MachineBMCCommand defines commands send to the BMC of the machine + * MachineBMCCommand defines commands send to the BMC of the machine. * * @generated from enum metalstack.api.v2.MachineBMCCommand */ export enum MachineBMCCommand { /** - * MACHINE_BMC_COMMAND_UNSPECIFIED is not defined + * MACHINE_BMC_COMMAND_UNSPECIFIED is not defined. * * @generated from enum value: MACHINE_BMC_COMMAND_UNSPECIFIED = 0; */ MACHINE_BMC_COMMAND_UNSPECIFIED = 0, /** - * MACHINE_BMC_COMMAND_ON Power on the machine + * MACHINE_BMC_COMMAND_ON Power on the machine. * * @generated from enum value: MACHINE_BMC_COMMAND_ON = 1; */ MACHINE_BMC_COMMAND_ON = 1, /** - * MACHINE_BMC_COMMAND_OFF Power off the machine + * MACHINE_BMC_COMMAND_OFF Power off the machine. * * @generated from enum value: MACHINE_BMC_COMMAND_OFF = 2; */ MACHINE_BMC_COMMAND_OFF = 2, /** - * MACHINE_BMC_COMMAND_RESET Power reset the machine + * MACHINE_BMC_COMMAND_RESET Power reset the machine. * * @generated from enum value: MACHINE_BMC_COMMAND_RESET = 3; */ MACHINE_BMC_COMMAND_RESET = 3, /** - * MACHINE_BMC_COMMAND_CYCLE Power cycle the machine + * MACHINE_BMC_COMMAND_CYCLE Power cycle the machine. * * @generated from enum value: MACHINE_BMC_COMMAND_CYCLE = 4; */ @@ -2739,7 +2739,7 @@ export const MachineBMCCommandSchema: GenEnum = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_machine, 6); /** - * MachineIssueType defines which type of issue it is + * MachineIssueType defines which type of issue it is. * * @generated from enum metalstack.api.v2.MachineIssueType */ @@ -2850,7 +2850,7 @@ export const MachineIssueTypeSchema: GenEnum = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_machine, 7); /** - * MachineIssueSeverity defines the severity of an issue + * MachineIssueSeverity defines the severity of an issue. * * @generated from enum metalstack.api.v2.MachineIssueSeverity */ diff --git a/js/metalstack/api/v2/method_pb.d.ts b/js/metalstack/api/v2/method_pb.d.ts index a2b51a2d..0501bd19 100644 --- a/js/metalstack/api/v2/method_pb.d.ts +++ b/js/metalstack/api/v2/method_pb.d.ts @@ -24,7 +24,7 @@ export declare const MethodServiceListRequestSchema: GenMessage & { /** - * Methods is a list of methods public callable + * Methods is a list of methods public callable. * * @generated from field: repeated string methods = 1; */ @@ -53,13 +53,13 @@ export declare const MethodServiceTokenScopedListRequestSchema: GenMessage & { /** - * Permissions contains a list of methods which can be called + * Permissions contains a list of methods which can be called. * * @generated from field: repeated metalstack.api.v2.MethodPermission permissions = 1; */ permissions: MethodPermission[]; /** - * 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. * * @generated from field: map project_roles = 2; */ @@ -67,7 +67,7 @@ export type MethodServiceTokenScopedListResponse = Message<"metalstack.api.v2.Me [key: string]: ProjectRole; }; /** - * TenantRoles associates a tenant ID with the corresponding role of the token owner + * TenantRoles associates a tenant ID with the corresponding role of the token owner. * * @generated from field: map tenant_roles = 3; */ @@ -75,19 +75,19 @@ export type MethodServiceTokenScopedListResponse = Message<"metalstack.api.v2.Me [key: string]: TenantRole; }; /** - * AdminRole defines the admin role of the token owner + * AdminRole defines the admin role of the token owner. * * @generated from field: optional metalstack.api.v2.AdminRole admin_role = 4; */ adminRole?: AdminRole | undefined; /** - * InfraRole defines the infrastructure role of the token owner + * InfraRole defines the infrastructure role of the token owner. * * @generated from field: optional metalstack.api.v2.InfraRole infra_role = 5; */ infraRole?: InfraRole | undefined; /** - * MachineRoles defines the machine roles of the token owner + * MachineRoles defines the machine roles of the token owner. * * @generated from field: map machine_roles = 6; */ diff --git a/js/metalstack/api/v2/method_pb.ts b/js/metalstack/api/v2/method_pb.ts index 7a3e1a3f..65e400fa 100644 --- a/js/metalstack/api/v2/method_pb.ts +++ b/js/metalstack/api/v2/method_pb.ts @@ -39,7 +39,7 @@ export const MethodServiceListRequestSchema: GenMessage & { /** - * Methods is a list of methods public callable + * Methods is a list of methods public callable. * * @generated from field: repeated string methods = 1; */ @@ -75,42 +75,42 @@ export const MethodServiceTokenScopedListRequestSchema: GenMessage & { /** - * Permissions contains a list of methods which can be called + * Permissions contains a list of methods which can be called. * * @generated from field: repeated metalstack.api.v2.MethodPermission permissions = 1; */ permissions: MethodPermission[]; /** - * 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. * * @generated from field: map project_roles = 2; */ projectRoles: { [key: string]: ProjectRole }; /** - * TenantRoles associates a tenant ID with the corresponding role of the token owner + * TenantRoles associates a tenant ID with the corresponding role of the token owner. * * @generated from field: map tenant_roles = 3; */ tenantRoles: { [key: string]: TenantRole }; /** - * AdminRole defines the admin role of the token owner + * AdminRole defines the admin role of the token owner. * * @generated from field: optional metalstack.api.v2.AdminRole admin_role = 4; */ adminRole?: AdminRole | undefined; /** - * InfraRole defines the infrastructure role of the token owner + * InfraRole defines the infrastructure role of the token owner. * * @generated from field: optional metalstack.api.v2.InfraRole infra_role = 5; */ infraRole?: InfraRole | undefined; /** - * MachineRoles defines the machine roles of the token owner + * MachineRoles defines the machine roles of the token owner. * * @generated from field: map machine_roles = 6; */ diff --git a/js/metalstack/api/v2/network_pb.d.ts b/js/metalstack/api/v2/network_pb.d.ts index 5141c440..3929ab3c 100644 --- a/js/metalstack/api/v2/network_pb.d.ts +++ b/js/metalstack/api/v2/network_pb.d.ts @@ -54,7 +54,7 @@ export declare const NetworkServiceGetResponseSchema: GenMessage & { /** - * Project where this network belongs to + * Project where this network belongs to. * * @generated from field: string project = 1; */ @@ -72,7 +72,7 @@ export type NetworkServiceCreateRequest = Message<"metalstack.api.v2.NetworkServ */ description?: string | undefined; /** - * Partition where this network will be created + * Partition where this network will be created. * * @generated from field: optional string partition = 4; */ @@ -84,7 +84,7 @@ export type NetworkServiceCreateRequest = Message<"metalstack.api.v2.NetworkServ */ labels?: Labels | undefined; /** - * Parent Network points to the id of the parent network if any + * Parent Network points to the id of the parent network if any. * * @generated from field: optional string parent_network = 6; */ @@ -114,7 +114,7 @@ export declare const NetworkServiceCreateRequestSchema: GenMessage & { /** - * Network is the created network + * Network is the created network. * * @generated from field: metalstack.api.v2.Network network = 1; */ @@ -138,7 +138,7 @@ export type NetworkServiceUpdateRequest = Message<"metalstack.api.v2.NetworkServ */ id: string; /** - * 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. * * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 2; */ @@ -180,7 +180,7 @@ export declare const NetworkServiceUpdateRequestSchema: GenMessage & { /** - * Network is the updated network + * Network is the updated network. * * @generated from field: metalstack.api.v2.Network network = 1; */ @@ -204,7 +204,7 @@ export type NetworkServiceListRequest = Message<"metalstack.api.v2.NetworkServic */ project: string; /** - * Query which specifies which networks to return + * Query which specifies which networks to return. * * @generated from field: metalstack.api.v2.NetworkQuery query = 2; */ @@ -222,7 +222,7 @@ export declare const NetworkServiceListRequestSchema: GenMessage & { /** - * Networks are the requested networks + * Networks are the requested networks. * * @generated from field: repeated metalstack.api.v2.Network networks = 1; */ @@ -246,7 +246,7 @@ export type NetworkServiceListBaseNetworksRequest = Message<"metalstack.api.v2.N */ project: string; /** - * Query which specifies which networks to return + * Query which specifies which networks to return. * * @generated from field: metalstack.api.v2.NetworkQuery query = 2; */ @@ -264,7 +264,7 @@ export declare const NetworkServiceListBaseNetworksRequestSchema: GenMessage & { /** - * Networks are the requested networks + * Networks are the requested networks. * * @generated from field: repeated metalstack.api.v2.Network networks = 1; */ @@ -306,7 +306,7 @@ export declare const NetworkServiceDeleteRequestSchema: GenMessage & { /** - * Network is the deleted network + * Network is the deleted network. * * @generated from field: metalstack.api.v2.Network network = 1; */ @@ -348,19 +348,19 @@ export type Network = Message<"metalstack.api.v2.Network"> & { */ description?: string | undefined; /** - * Partition where this network will be created + * Partition where this network will be created. * * @generated from field: optional string partition = 5; */ partition?: string | undefined; /** - * Project where this network belongs to + * Project where this network belongs to. * * @generated from field: optional string project = 6; */ project?: string | undefined; /** - * Namespace if specified, this network is namespaced and can therefore overlap with others + * Namespace if specified, this network is namespaced and can therefore overlap with others. * Will be equal with project most of the time * * @generated from field: optional string namespace = 7; @@ -379,13 +379,13 @@ export type Network = Message<"metalstack.api.v2.Network"> & { */ destinationPrefixes: string[]; /** - * Default Child Prefix length defines the bit length of a child network created per address family, if not specified during the allocate request + * Default Child Prefix length defines the bit length of a child network created per address family, if not specified during the allocate request. * * @generated from field: metalstack.api.v2.ChildPrefixLength default_child_prefix_length = 10; */ defaultChildPrefixLength?: ChildPrefixLength | undefined; /** - * Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length + * Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length. * * @generated from field: metalstack.api.v2.ChildPrefixLength min_child_prefix_length = 11; */ @@ -409,13 +409,13 @@ export type Network = Message<"metalstack.api.v2.Network"> & { */ vrf?: number | undefined; /** - * Parent Network points to the id of the parent network if any + * Parent Network points to the id of the parent network if any. * * @generated from field: optional string parent_network = 15; */ parentNetwork?: string | undefined; /** - * AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced + * AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced. * * @generated from field: repeated string additional_announcable_cidrs = 16; */ @@ -433,7 +433,7 @@ export type Network = Message<"metalstack.api.v2.Network"> & { */ export declare const NetworkSchema: GenMessage; /** - * NetworkQuery defines which networks to query + * NetworkQuery defines which networks to query. * * @generated from message metalstack.api.v2.NetworkQuery */ @@ -457,19 +457,19 @@ export type NetworkQuery = Message<"metalstack.api.v2.NetworkQuery"> & { */ description?: string | undefined; /** - * Partition where this network will be created + * Partition where this network will be created. * * @generated from field: optional string partition = 4; */ partition?: string | undefined; /** - * Project where this network belongs to + * Project where this network belongs to. * * @generated from field: optional string project = 5; */ project?: string | undefined; /** - * Namespace where this network belongs to + * Namespace where this network belongs to. * * @generated from field: optional string namespace = 6; */ @@ -493,7 +493,7 @@ export type NetworkQuery = Message<"metalstack.api.v2.NetworkQuery"> & { */ vrf?: number | undefined; /** - * Parent Network points to the id of the parent network if any + * Parent Network points to the id of the parent network if any. * * @generated from field: optional string parent_network = 10; */ @@ -553,7 +553,7 @@ export type ChildPrefixLength = Message<"metalstack.api.v2.ChildPrefixLength"> & */ export declare const ChildPrefixLengthSchema: GenMessage; /** - * NetworkConsumption contains ip and prefix usage by addressfamily + * NetworkConsumption contains ip and prefix usage by addressfamily. * * @generated from message metalstack.api.v2.NetworkConsumption */ @@ -565,7 +565,7 @@ export type NetworkConsumption = Message<"metalstack.api.v2.NetworkConsumption"> */ ipv4?: NetworkUsage | undefined; /** - * IPv6 network usage, this can be approximated for high numbers + * IPv6 network usage, this can be approximated for high numbers. * * @generated from field: metalstack.api.v2.NetworkUsage ipv6 = 2; */ @@ -613,19 +613,19 @@ export type NetworkUsage = Message<"metalstack.api.v2.NetworkUsage"> & { */ export declare const NetworkUsageSchema: GenMessage; /** - * NATType defines how and if outgoing traffic is translated + * NATType defines how and if outgoing traffic is translated. * * @generated from enum metalstack.api.v2.NATType */ export declare enum NATType { /** - * NAT_TYPE_UNSPECIFIED indicates a unspecified nat type + * NAT_TYPE_UNSPECIFIED indicates a unspecified nat type. * * @generated from enum value: NAT_TYPE_UNSPECIFIED = 0; */ NAT_TYPE_UNSPECIFIED = 0, /** - * NAT_TYPE_NONE indicates that no nat is configured + * NAT_TYPE_NONE indicates that no nat is configured. * * @generated from enum value: NAT_TYPE_NONE = 1; */ @@ -642,19 +642,19 @@ export declare enum NATType { */ export declare const NATTypeSchema: GenEnum; /** - * NetworkType indicates the purpose of the network, it cannot be changed after creation + * NetworkType indicates the purpose of the network, it cannot be changed after creation. * * @generated from enum metalstack.api.v2.NetworkType */ export declare enum NetworkType { /** - * NETWORK_TYPE_UNSPECIFIED indicates a unknown network type + * NETWORK_TYPE_UNSPECIFIED indicates a unknown network type. * * @generated from enum value: NETWORK_TYPE_UNSPECIFIED = 0; */ UNSPECIFIED = 0, /** - * NETWORK_TYPE_EXTERNAL indicates network where multiple projects can allocate ips, it offers connectivity to other external networks + * NETWORK_TYPE_EXTERNAL indicates network where multiple projects can allocate ips, it offers connectivity to other external networks. * In most cases this is the internet network or a network which offers connectivity to legacy datacenter networks. * If it is not project scoped everyone can allocate Ips in this network, otherwise only from the same project ip allocation is possible. * @@ -662,7 +662,7 @@ export declare enum NetworkType { */ EXTERNAL = 1, /** - * NETWORK_TYPE_UNDERLAY indicates a underlay network + * NETWORK_TYPE_UNDERLAY indicates a underlay network. * The underlay network connects all switches and the firewalls to build a EVPN dataplane * It is not project scoped. Is part of the dataplane and reserved for administrative purposes. * @@ -670,14 +670,14 @@ export declare enum NetworkType { */ UNDERLAY = 2, /** - * NETWORK_TYPE_SUPER indicates a super network which is only used to create child networks + * NETWORK_TYPE_SUPER indicates a super network which is only used to create child networks. * If the vrf id is given, child networks will inherit this vrf. * If the vrf id is nil in this network, child vrf is taken from the pool. * If the partition is given, child networks inherit the partition. * If the partition is nil, child networks also do not have a partition (i.e. requires vrf is distributed across all partitions). * If the partition is given, only one super network in that partition can be created. * If the partition is nil, multiple super networks can exist. Then, for child network creation the network id must be specified (base networks can be queried by label selector). - * For child creation destination prefixes will be inherited + * For child creation destination prefixes will be inherited. * If this is project scoped, the child project must match, otherwise can be freely specified. * * @generated from enum value: NETWORK_TYPE_SUPER = 3; @@ -718,31 +718,31 @@ export declare enum NetworkType { */ export declare const NetworkTypeSchema: GenEnum; /** - * NetworkAddressFamily defines the address family of a network + * NetworkAddressFamily defines the address family of a network. * * @generated from enum metalstack.api.v2.NetworkAddressFamily */ export declare enum NetworkAddressFamily { /** - * NETWORK_ADDRESS_FAMILY_UNSPECIFIED is not specified + * NETWORK_ADDRESS_FAMILY_UNSPECIFIED is not specified. * * @generated from enum value: NETWORK_ADDRESS_FAMILY_UNSPECIFIED = 0; */ UNSPECIFIED = 0, /** - * NETWORK_ADDRESS_FAMILY_V4 defines a network with IPv4 address prefixes + * NETWORK_ADDRESS_FAMILY_V4 defines a network with IPv4 address prefixes. * * @generated from enum value: NETWORK_ADDRESS_FAMILY_V4 = 1; */ V4 = 1, /** - * NETWORK_ADDRESS_FAMILY_V6 defines a network with IPv6 address prefixes + * NETWORK_ADDRESS_FAMILY_V6 defines a network with IPv6 address prefixes. * * @generated from enum value: NETWORK_ADDRESS_FAMILY_V6 = 2; */ V6 = 2, /** - * NETWORK_ADDRESS_FAMILY_DUAL_STACK defines a network with both IPv4 and IPv6 address prefixes + * NETWORK_ADDRESS_FAMILY_DUAL_STACK defines a network with both IPv4 and IPv6 address prefixes. * * @generated from enum value: NETWORK_ADDRESS_FAMILY_DUAL_STACK = 3; */ diff --git a/js/metalstack/api/v2/network_pb.js b/js/metalstack/api/v2/network_pb.js index 5dfc3f7f..3690a46a 100644 --- a/js/metalstack/api/v2/network_pb.js +++ b/js/metalstack/api/v2/network_pb.js @@ -95,20 +95,20 @@ export const NetworkConsumptionSchema = /*@__PURE__*/ messageDesc(file_metalstac */ export const NetworkUsageSchema = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_network, 16); /** - * NATType defines how and if outgoing traffic is translated + * NATType defines how and if outgoing traffic is translated. * * @generated from enum metalstack.api.v2.NATType */ export var NATType; (function (NATType) { /** - * NAT_TYPE_UNSPECIFIED indicates a unspecified nat type + * NAT_TYPE_UNSPECIFIED indicates a unspecified nat type. * * @generated from enum value: NAT_TYPE_UNSPECIFIED = 0; */ NATType[NATType["NAT_TYPE_UNSPECIFIED"] = 0] = "NAT_TYPE_UNSPECIFIED"; /** - * NAT_TYPE_NONE indicates that no nat is configured + * NAT_TYPE_NONE indicates that no nat is configured. * * @generated from enum value: NAT_TYPE_NONE = 1; */ @@ -125,20 +125,20 @@ export var NATType; */ export const NATTypeSchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_network, 0); /** - * NetworkType indicates the purpose of the network, it cannot be changed after creation + * NetworkType indicates the purpose of the network, it cannot be changed after creation. * * @generated from enum metalstack.api.v2.NetworkType */ export var NetworkType; (function (NetworkType) { /** - * NETWORK_TYPE_UNSPECIFIED indicates a unknown network type + * NETWORK_TYPE_UNSPECIFIED indicates a unknown network type. * * @generated from enum value: NETWORK_TYPE_UNSPECIFIED = 0; */ NetworkType[NetworkType["UNSPECIFIED"] = 0] = "UNSPECIFIED"; /** - * NETWORK_TYPE_EXTERNAL indicates network where multiple projects can allocate ips, it offers connectivity to other external networks + * NETWORK_TYPE_EXTERNAL indicates network where multiple projects can allocate ips, it offers connectivity to other external networks. * In most cases this is the internet network or a network which offers connectivity to legacy datacenter networks. * If it is not project scoped everyone can allocate Ips in this network, otherwise only from the same project ip allocation is possible. * @@ -146,7 +146,7 @@ export var NetworkType; */ NetworkType[NetworkType["EXTERNAL"] = 1] = "EXTERNAL"; /** - * NETWORK_TYPE_UNDERLAY indicates a underlay network + * NETWORK_TYPE_UNDERLAY indicates a underlay network. * The underlay network connects all switches and the firewalls to build a EVPN dataplane * It is not project scoped. Is part of the dataplane and reserved for administrative purposes. * @@ -154,14 +154,14 @@ export var NetworkType; */ NetworkType[NetworkType["UNDERLAY"] = 2] = "UNDERLAY"; /** - * NETWORK_TYPE_SUPER indicates a super network which is only used to create child networks + * NETWORK_TYPE_SUPER indicates a super network which is only used to create child networks. * If the vrf id is given, child networks will inherit this vrf. * If the vrf id is nil in this network, child vrf is taken from the pool. * If the partition is given, child networks inherit the partition. * If the partition is nil, child networks also do not have a partition (i.e. requires vrf is distributed across all partitions). * If the partition is given, only one super network in that partition can be created. * If the partition is nil, multiple super networks can exist. Then, for child network creation the network id must be specified (base networks can be queried by label selector). - * For child creation destination prefixes will be inherited + * For child creation destination prefixes will be inherited. * If this is project scoped, the child project must match, otherwise can be freely specified. * * @generated from enum value: NETWORK_TYPE_SUPER = 3; @@ -202,32 +202,32 @@ export var NetworkType; */ export const NetworkTypeSchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_network, 1); /** - * NetworkAddressFamily defines the address family of a network + * NetworkAddressFamily defines the address family of a network. * * @generated from enum metalstack.api.v2.NetworkAddressFamily */ export var NetworkAddressFamily; (function (NetworkAddressFamily) { /** - * NETWORK_ADDRESS_FAMILY_UNSPECIFIED is not specified + * NETWORK_ADDRESS_FAMILY_UNSPECIFIED is not specified. * * @generated from enum value: NETWORK_ADDRESS_FAMILY_UNSPECIFIED = 0; */ NetworkAddressFamily[NetworkAddressFamily["UNSPECIFIED"] = 0] = "UNSPECIFIED"; /** - * NETWORK_ADDRESS_FAMILY_V4 defines a network with IPv4 address prefixes + * NETWORK_ADDRESS_FAMILY_V4 defines a network with IPv4 address prefixes. * * @generated from enum value: NETWORK_ADDRESS_FAMILY_V4 = 1; */ NetworkAddressFamily[NetworkAddressFamily["V4"] = 1] = "V4"; /** - * NETWORK_ADDRESS_FAMILY_V6 defines a network with IPv6 address prefixes + * NETWORK_ADDRESS_FAMILY_V6 defines a network with IPv6 address prefixes. * * @generated from enum value: NETWORK_ADDRESS_FAMILY_V6 = 2; */ NetworkAddressFamily[NetworkAddressFamily["V6"] = 2] = "V6"; /** - * NETWORK_ADDRESS_FAMILY_DUAL_STACK defines a network with both IPv4 and IPv6 address prefixes + * NETWORK_ADDRESS_FAMILY_DUAL_STACK defines a network with both IPv4 and IPv6 address prefixes. * * @generated from enum value: NETWORK_ADDRESS_FAMILY_DUAL_STACK = 3; */ diff --git a/js/metalstack/api/v2/network_pb.ts b/js/metalstack/api/v2/network_pb.ts index c77681af..ac318869 100644 --- a/js/metalstack/api/v2/network_pb.ts +++ b/js/metalstack/api/v2/network_pb.ts @@ -72,7 +72,7 @@ export const NetworkServiceGetResponseSchema: GenMessage & { /** - * Project where this network belongs to + * Project where this network belongs to. * * @generated from field: string project = 1; */ @@ -93,7 +93,7 @@ export type NetworkServiceCreateRequest = Message<"metalstack.api.v2.NetworkServ description?: string | undefined; /** - * Partition where this network will be created + * Partition where this network will be created. * * @generated from field: optional string partition = 4; */ @@ -107,7 +107,7 @@ export type NetworkServiceCreateRequest = Message<"metalstack.api.v2.NetworkServ labels?: Labels | undefined; /** - * Parent Network points to the id of the parent network if any + * Parent Network points to the id of the parent network if any. * * @generated from field: optional string parent_network = 6; */ @@ -142,7 +142,7 @@ export const NetworkServiceCreateRequestSchema: GenMessage & { /** - * Network is the created network + * Network is the created network. * * @generated from field: metalstack.api.v2.Network network = 1; */ @@ -170,7 +170,7 @@ export type NetworkServiceUpdateRequest = Message<"metalstack.api.v2.NetworkServ id: string; /** - * 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. * * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 2; */ @@ -219,7 +219,7 @@ export const NetworkServiceUpdateRequestSchema: GenMessage & { /** - * Network is the updated network + * Network is the updated network. * * @generated from field: metalstack.api.v2.Network network = 1; */ @@ -247,7 +247,7 @@ export type NetworkServiceListRequest = Message<"metalstack.api.v2.NetworkServic project: string; /** - * Query which specifies which networks to return + * Query which specifies which networks to return. * * @generated from field: metalstack.api.v2.NetworkQuery query = 2; */ @@ -268,7 +268,7 @@ export const NetworkServiceListRequestSchema: GenMessage & { /** - * Networks are the requested networks + * Networks are the requested networks. * * @generated from field: repeated metalstack.api.v2.Network networks = 1; */ @@ -296,7 +296,7 @@ export type NetworkServiceListBaseNetworksRequest = Message<"metalstack.api.v2.N project: string; /** - * Query which specifies which networks to return + * Query which specifies which networks to return. * * @generated from field: metalstack.api.v2.NetworkQuery query = 2; */ @@ -317,7 +317,7 @@ export const NetworkServiceListBaseNetworksRequestSchema: GenMessage & { /** - * Networks are the requested networks + * Networks are the requested networks. * * @generated from field: repeated metalstack.api.v2.Network networks = 1; */ @@ -366,7 +366,7 @@ export const NetworkServiceDeleteRequestSchema: GenMessage & { /** - * Network is the deleted network + * Network is the deleted network. * * @generated from field: metalstack.api.v2.Network network = 1; */ @@ -415,21 +415,21 @@ export type Network = Message<"metalstack.api.v2.Network"> & { description?: string | undefined; /** - * Partition where this network will be created + * Partition where this network will be created. * * @generated from field: optional string partition = 5; */ partition?: string | undefined; /** - * Project where this network belongs to + * Project where this network belongs to. * * @generated from field: optional string project = 6; */ project?: string | undefined; /** - * Namespace if specified, this network is namespaced and can therefore overlap with others + * Namespace if specified, this network is namespaced and can therefore overlap with others. * Will be equal with project most of the time * * @generated from field: optional string namespace = 7; @@ -451,14 +451,14 @@ export type Network = Message<"metalstack.api.v2.Network"> & { destinationPrefixes: string[]; /** - * Default Child Prefix length defines the bit length of a child network created per address family, if not specified during the allocate request + * Default Child Prefix length defines the bit length of a child network created per address family, if not specified during the allocate request. * * @generated from field: metalstack.api.v2.ChildPrefixLength default_child_prefix_length = 10; */ defaultChildPrefixLength?: ChildPrefixLength | undefined; /** - * Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length + * Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length. * * @generated from field: metalstack.api.v2.ChildPrefixLength min_child_prefix_length = 11; */ @@ -486,14 +486,14 @@ export type Network = Message<"metalstack.api.v2.Network"> & { vrf?: number | undefined; /** - * Parent Network points to the id of the parent network if any + * Parent Network points to the id of the parent network if any. * * @generated from field: optional string parent_network = 15; */ parentNetwork?: string | undefined; /** - * AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced + * AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced. * * @generated from field: repeated string additional_announcable_cidrs = 16; */ @@ -515,7 +515,7 @@ export const NetworkSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_network, 12); /** - * NetworkQuery defines which networks to query + * NetworkQuery defines which networks to query. * * @generated from message metalstack.api.v2.NetworkQuery */ @@ -542,21 +542,21 @@ export type NetworkQuery = Message<"metalstack.api.v2.NetworkQuery"> & { description?: string | undefined; /** - * Partition where this network will be created + * Partition where this network will be created. * * @generated from field: optional string partition = 4; */ partition?: string | undefined; /** - * Project where this network belongs to + * Project where this network belongs to. * * @generated from field: optional string project = 5; */ project?: string | undefined; /** - * Namespace where this network belongs to + * Namespace where this network belongs to. * * @generated from field: optional string namespace = 6; */ @@ -584,7 +584,7 @@ export type NetworkQuery = Message<"metalstack.api.v2.NetworkQuery"> & { vrf?: number | undefined; /** - * Parent Network points to the id of the parent network if any + * Parent Network points to the id of the parent network if any. * * @generated from field: optional string parent_network = 10; */ @@ -655,7 +655,7 @@ export const ChildPrefixLengthSchema: GenMessage = /*@__PURE_ messageDesc(file_metalstack_api_v2_network, 14); /** - * NetworkConsumption contains ip and prefix usage by addressfamily + * NetworkConsumption contains ip and prefix usage by addressfamily. * * @generated from message metalstack.api.v2.NetworkConsumption */ @@ -668,7 +668,7 @@ export type NetworkConsumption = Message<"metalstack.api.v2.NetworkConsumption"> ipv4?: NetworkUsage | undefined; /** - * IPv6 network usage, this can be approximated for high numbers + * IPv6 network usage, this can be approximated for high numbers. * * @generated from field: metalstack.api.v2.NetworkUsage ipv6 = 2; */ @@ -725,20 +725,20 @@ export const NetworkUsageSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_network, 16); /** - * NATType defines how and if outgoing traffic is translated + * NATType defines how and if outgoing traffic is translated. * * @generated from enum metalstack.api.v2.NATType */ export enum NATType { /** - * NAT_TYPE_UNSPECIFIED indicates a unspecified nat type + * NAT_TYPE_UNSPECIFIED indicates a unspecified nat type. * * @generated from enum value: NAT_TYPE_UNSPECIFIED = 0; */ NAT_TYPE_UNSPECIFIED = 0, /** - * NAT_TYPE_NONE indicates that no nat is configured + * NAT_TYPE_NONE indicates that no nat is configured. * * @generated from enum value: NAT_TYPE_NONE = 1; */ @@ -759,20 +759,20 @@ export const NATTypeSchema: GenEnum = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_network, 0); /** - * NetworkType indicates the purpose of the network, it cannot be changed after creation + * NetworkType indicates the purpose of the network, it cannot be changed after creation. * * @generated from enum metalstack.api.v2.NetworkType */ export enum NetworkType { /** - * NETWORK_TYPE_UNSPECIFIED indicates a unknown network type + * NETWORK_TYPE_UNSPECIFIED indicates a unknown network type. * * @generated from enum value: NETWORK_TYPE_UNSPECIFIED = 0; */ UNSPECIFIED = 0, /** - * NETWORK_TYPE_EXTERNAL indicates network where multiple projects can allocate ips, it offers connectivity to other external networks + * NETWORK_TYPE_EXTERNAL indicates network where multiple projects can allocate ips, it offers connectivity to other external networks. * In most cases this is the internet network or a network which offers connectivity to legacy datacenter networks. * If it is not project scoped everyone can allocate Ips in this network, otherwise only from the same project ip allocation is possible. * @@ -781,7 +781,7 @@ export enum NetworkType { EXTERNAL = 1, /** - * NETWORK_TYPE_UNDERLAY indicates a underlay network + * NETWORK_TYPE_UNDERLAY indicates a underlay network. * The underlay network connects all switches and the firewalls to build a EVPN dataplane * It is not project scoped. Is part of the dataplane and reserved for administrative purposes. * @@ -790,14 +790,14 @@ export enum NetworkType { UNDERLAY = 2, /** - * NETWORK_TYPE_SUPER indicates a super network which is only used to create child networks + * NETWORK_TYPE_SUPER indicates a super network which is only used to create child networks. * If the vrf id is given, child networks will inherit this vrf. * If the vrf id is nil in this network, child vrf is taken from the pool. * If the partition is given, child networks inherit the partition. * If the partition is nil, child networks also do not have a partition (i.e. requires vrf is distributed across all partitions). * If the partition is given, only one super network in that partition can be created. * If the partition is nil, multiple super networks can exist. Then, for child network creation the network id must be specified (base networks can be queried by label selector). - * For child creation destination prefixes will be inherited + * For child creation destination prefixes will be inherited. * If this is project scoped, the child project must match, otherwise can be freely specified. * * @generated from enum value: NETWORK_TYPE_SUPER = 3; @@ -844,34 +844,34 @@ export const NetworkTypeSchema: GenEnum = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_network, 1); /** - * NetworkAddressFamily defines the address family of a network + * NetworkAddressFamily defines the address family of a network. * * @generated from enum metalstack.api.v2.NetworkAddressFamily */ export enum NetworkAddressFamily { /** - * NETWORK_ADDRESS_FAMILY_UNSPECIFIED is not specified + * NETWORK_ADDRESS_FAMILY_UNSPECIFIED is not specified. * * @generated from enum value: NETWORK_ADDRESS_FAMILY_UNSPECIFIED = 0; */ UNSPECIFIED = 0, /** - * NETWORK_ADDRESS_FAMILY_V4 defines a network with IPv4 address prefixes + * NETWORK_ADDRESS_FAMILY_V4 defines a network with IPv4 address prefixes. * * @generated from enum value: NETWORK_ADDRESS_FAMILY_V4 = 1; */ V4 = 1, /** - * NETWORK_ADDRESS_FAMILY_V6 defines a network with IPv6 address prefixes + * NETWORK_ADDRESS_FAMILY_V6 defines a network with IPv6 address prefixes. * * @generated from enum value: NETWORK_ADDRESS_FAMILY_V6 = 2; */ V6 = 2, /** - * NETWORK_ADDRESS_FAMILY_DUAL_STACK defines a network with both IPv4 and IPv6 address prefixes + * NETWORK_ADDRESS_FAMILY_DUAL_STACK defines a network with both IPv4 and IPv6 address prefixes. * * @generated from enum value: NETWORK_ADDRESS_FAMILY_DUAL_STACK = 3; */ diff --git a/js/metalstack/api/v2/partition_pb.d.ts b/js/metalstack/api/v2/partition_pb.d.ts index 0ffba5ae..bde66e38 100644 --- a/js/metalstack/api/v2/partition_pb.d.ts +++ b/js/metalstack/api/v2/partition_pb.d.ts @@ -6,7 +6,7 @@ import type { Message } from "@bufbuild/protobuf"; */ export declare const file_metalstack_api_v2_partition: GenFile; /** - * Partition is a failure domain with machines and switches + * Partition is a failure domain with machines and switches. * * @generated from message metalstack.api.v2.Partition */ @@ -30,7 +30,7 @@ export type Partition = Message<"metalstack.api.v2.Partition"> & { */ description: string; /** - * PartitionBootConfiguration defines how metal-hammer boots + * PartitionBootConfiguration defines how metal-hammer boots. * * @generated from field: metalstack.api.v2.PartitionBootConfiguration boot_configuration = 4; */ @@ -48,7 +48,7 @@ export type Partition = Message<"metalstack.api.v2.Partition"> & { */ ntpServers: NTPServer[]; /** - * ManagementServiceAddresses defines where the management is reachable + * ManagementServiceAddresses defines where the management is reachable. * should be in the form : * * @generated from field: repeated string mgmt_service_addresses = 7; @@ -61,7 +61,7 @@ export type Partition = Message<"metalstack.api.v2.Partition"> & { */ export declare const PartitionSchema: GenMessage; /** - * PartitionQuery is used to search partitions + * PartitionQuery is used to search partitions. * * @generated from message metalstack.api.v2.PartitionQuery */ @@ -73,7 +73,7 @@ export type PartitionQuery = Message<"metalstack.api.v2.PartitionQuery"> & { */ id?: string | undefined; /** - * Labels lists only partitions containing the given labels + * Labels lists only partitions containing the given labels. * * @generated from field: optional metalstack.api.v2.Labels labels = 2; */ @@ -85,7 +85,7 @@ export type PartitionQuery = Message<"metalstack.api.v2.PartitionQuery"> & { */ export declare const PartitionQuerySchema: GenMessage; /** - * PartitionBootConfiguration defines how metal-hammer boots + * PartitionBootConfiguration defines how metal-hammer boots. * * @generated from message metalstack.api.v2.PartitionBootConfiguration */ @@ -151,7 +151,7 @@ export type NTPServer = Message<"metalstack.api.v2.NTPServer"> & { */ export declare const NTPServerSchema: GenMessage; /** - * PartitionServiceGetRequest is the request payload for a partition get request + * PartitionServiceGetRequest is the request payload for a partition get request. * * @generated from message metalstack.api.v2.PartitionServiceGetRequest */ @@ -169,13 +169,13 @@ export type PartitionServiceGetRequest = Message<"metalstack.api.v2.PartitionSer */ export declare const PartitionServiceGetRequestSchema: GenMessage; /** - * PartitionServiceListRequest is the request payload for a partition list request + * PartitionServiceListRequest is the request payload for a partition list request. * * @generated from message metalstack.api.v2.PartitionServiceListRequest */ export type PartitionServiceListRequest = Message<"metalstack.api.v2.PartitionServiceListRequest"> & { /** - * Query for partitions + * Query for partitions. * * @generated from field: metalstack.api.v2.PartitionQuery query = 1; */ @@ -187,13 +187,13 @@ export type PartitionServiceListRequest = Message<"metalstack.api.v2.PartitionSe */ export declare const PartitionServiceListRequestSchema: GenMessage; /** - * PartitionServiceGetResponse is the response payload for a partition get request + * PartitionServiceGetResponse is the response payload for a partition get request. * * @generated from message metalstack.api.v2.PartitionServiceGetResponse */ export type PartitionServiceGetResponse = Message<"metalstack.api.v2.PartitionServiceGetResponse"> & { /** - * Partition is the partition + * Partition is the partition. * * @generated from field: metalstack.api.v2.Partition partition = 1; */ @@ -205,13 +205,13 @@ export type PartitionServiceGetResponse = Message<"metalstack.api.v2.PartitionSe */ export declare const PartitionServiceGetResponseSchema: GenMessage; /** - * PartitionServiceListResponse is the response payload for a partition list request + * PartitionServiceListResponse is the response payload for a partition list request. * * @generated from message metalstack.api.v2.PartitionServiceListResponse */ export type PartitionServiceListResponse = Message<"metalstack.api.v2.PartitionServiceListResponse"> & { /** - * Partitions are the partitions + * Partitions are the partitions. * * @generated from field: repeated metalstack.api.v2.Partition partitions = 1; */ diff --git a/js/metalstack/api/v2/partition_pb.ts b/js/metalstack/api/v2/partition_pb.ts index d866c33c..184bb297 100644 --- a/js/metalstack/api/v2/partition_pb.ts +++ b/js/metalstack/api/v2/partition_pb.ts @@ -17,7 +17,7 @@ export const file_metalstack_api_v2_partition: GenFile = /*@__PURE__*/ fileDesc("CiFtZXRhbHN0YWNrL2FwaS92Mi9wYXJ0aXRpb24ucHJvdG8SEW1ldGFsc3RhY2suYXBpLnYyIuACCglQYXJ0aXRpb24SFwoCaWQYASABKAlCC7pICHIG0LOusQIBEiUKBG1ldGEYAiABKAsyFy5tZXRhbHN0YWNrLmFwaS52Mi5NZXRhEiAKC2Rlc2NyaXB0aW9uGAMgASgJQgu6SAhyBsizrrECARJJChJib290X2NvbmZpZ3VyYXRpb24YBCABKAsyLS5tZXRhbHN0YWNrLmFwaS52Mi5QYXJ0aXRpb25Cb290Q29uZmlndXJhdGlvbhI7CgtkbnNfc2VydmVycxgFIAMoCzIcLm1ldGFsc3RhY2suYXBpLnYyLkROU1NlcnZlckIIukgFkgECEAMSOwoLbnRwX3NlcnZlcnMYBiADKAsyHC5tZXRhbHN0YWNrLmFwaS52Mi5OVFBTZXJ2ZXJCCLpIBZIBAhAKEiwKFm1nbXRfc2VydmljZV9hZGRyZXNzZXMYByADKAlCDLpICZIBBsiks7ECASJwCg5QYXJ0aXRpb25RdWVyeRIcCgJpZBgBIAEoCUILukgIcgbQs66xAgFIAIgBARIuCgZsYWJlbHMYAiABKAsyGS5tZXRhbHN0YWNrLmFwaS52Mi5MYWJlbHNIAYgBAUIFCgNfaWRCCQoHX2xhYmVscyJ8ChpQYXJ0aXRpb25Cb290Q29uZmlndXJhdGlvbhIeCglpbWFnZV91cmwYASABKAlCC7pICHIG4LOusQIBEh8KCmtlcm5lbF91cmwYAiABKAlCC7pICHIG4LOusQIBEh0KC2NvbW1hbmRsaW5lGAMgASgJQgi6SAVyAxiAICIgCglETlNTZXJ2ZXISEwoCaXAYASABKAlCB7pIBHICcAEiKQoJTlRQU2VydmVyEhwKB2FkZHJlc3MYASABKAlCC7pICHIG6LOusQIBIjUKGlBhcnRpdGlvblNlcnZpY2VHZXRSZXF1ZXN0EhcKAmlkGAEgASgJQgu6SAhyBtCzrrECASJPChtQYXJ0aXRpb25TZXJ2aWNlTGlzdFJlcXVlc3QSMAoFcXVlcnkYASABKAsyIS5tZXRhbHN0YWNrLmFwaS52Mi5QYXJ0aXRpb25RdWVyeSJOChtQYXJ0aXRpb25TZXJ2aWNlR2V0UmVzcG9uc2USLwoJcGFydGl0aW9uGAEgASgLMhwubWV0YWxzdGFjay5hcGkudjIuUGFydGl0aW9uIlAKHFBhcnRpdGlvblNlcnZpY2VMaXN0UmVzcG9uc2USMAoKcGFydGl0aW9ucxgBIAMoCzIcLm1ldGFsc3RhY2suYXBpLnYyLlBhcnRpdGlvbjL1AQoQUGFydGl0aW9uU2VydmljZRJuCgNHZXQSLS5tZXRhbHN0YWNrLmFwaS52Mi5QYXJ0aXRpb25TZXJ2aWNlR2V0UmVxdWVzdBouLm1ldGFsc3RhY2suYXBpLnYyLlBhcnRpdGlvblNlcnZpY2VHZXRSZXNwb25zZSII2PMYAuDzGAIScQoETGlzdBIuLm1ldGFsc3RhY2suYXBpLnYyLlBhcnRpdGlvblNlcnZpY2VMaXN0UmVxdWVzdBovLm1ldGFsc3RhY2suYXBpLnYyLlBhcnRpdGlvblNlcnZpY2VMaXN0UmVzcG9uc2UiCNjzGALg8xgCQsQBChVjb20ubWV0YWxzdGFjay5hcGkudjJCDlBhcnRpdGlvblByb3RvUAFaNWdpdGh1Yi5jb20vbWV0YWwtc3RhY2svYXBpL2dvL21ldGFsc3RhY2svYXBpL3YyO2FwaXYyogIDTUFYqgIRTWV0YWxzdGFjay5BcGkuVjLKAhFNZXRhbHN0YWNrXEFwaVxWMuICHU1ldGFsc3RhY2tcQXBpXFYyXEdQQk1ldGFkYXRh6gITTWV0YWxzdGFjazo6QXBpOjpWMmIGcHJvdG8z", [file_buf_validate_validate, file_metalstack_api_v2_common, file_metalstack_api_v2_predefined_rules]); /** - * Partition is a failure domain with machines and switches + * Partition is a failure domain with machines and switches. * * @generated from message metalstack.api.v2.Partition */ @@ -44,7 +44,7 @@ export type Partition = Message<"metalstack.api.v2.Partition"> & { description: string; /** - * PartitionBootConfiguration defines how metal-hammer boots + * PartitionBootConfiguration defines how metal-hammer boots. * * @generated from field: metalstack.api.v2.PartitionBootConfiguration boot_configuration = 4; */ @@ -65,7 +65,7 @@ export type Partition = Message<"metalstack.api.v2.Partition"> & { ntpServers: NTPServer[]; /** - * ManagementServiceAddresses defines where the management is reachable + * ManagementServiceAddresses defines where the management is reachable. * should be in the form : * * @generated from field: repeated string mgmt_service_addresses = 7; @@ -81,7 +81,7 @@ export const PartitionSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_partition, 0); /** - * PartitionQuery is used to search partitions + * PartitionQuery is used to search partitions. * * @generated from message metalstack.api.v2.PartitionQuery */ @@ -94,7 +94,7 @@ export type PartitionQuery = Message<"metalstack.api.v2.PartitionQuery"> & { id?: string | undefined; /** - * Labels lists only partitions containing the given labels + * Labels lists only partitions containing the given labels. * * @generated from field: optional metalstack.api.v2.Labels labels = 2; */ @@ -109,7 +109,7 @@ export const PartitionQuerySchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_partition, 1); /** - * PartitionBootConfiguration defines how metal-hammer boots + * PartitionBootConfiguration defines how metal-hammer boots. * * @generated from message metalstack.api.v2.PartitionBootConfiguration */ @@ -186,7 +186,7 @@ export const NTPServerSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_partition, 4); /** - * PartitionServiceGetRequest is the request payload for a partition get request + * PartitionServiceGetRequest is the request payload for a partition get request. * * @generated from message metalstack.api.v2.PartitionServiceGetRequest */ @@ -207,13 +207,13 @@ export const PartitionServiceGetRequestSchema: GenMessage & { /** - * Query for partitions + * Query for partitions. * * @generated from field: metalstack.api.v2.PartitionQuery query = 1; */ @@ -228,13 +228,13 @@ export const PartitionServiceListRequestSchema: GenMessage & { /** - * Partition is the partition + * Partition is the partition. * * @generated from field: metalstack.api.v2.Partition partition = 1; */ @@ -249,13 +249,13 @@ export const PartitionServiceGetResponseSchema: GenMessage & { /** - * Partitions are the partitions + * Partitions are the partitions. * * @generated from field: repeated metalstack.api.v2.Partition partitions = 1; */ diff --git a/js/metalstack/api/v2/predefined_rules_pb.d.ts b/js/metalstack/api/v2/predefined_rules_pb.d.ts index 5d785f8c..ac239fea 100644 --- a/js/metalstack/api/v2/predefined_rules_pb.d.ts +++ b/js/metalstack/api/v2/predefined_rules_pb.d.ts @@ -5,145 +5,145 @@ import type { MapRules, RepeatedRules, StringRules } from "../../../buf/validate */ export declare const file_metalstack_api_v2_predefined_rules: GenFile; /** - * Macaddress returns true if the given string is a valid macaddress + * Macaddress returns true if the given string is a valid macaddress. * * @generated from extension: optional bool macaddress = 80048951; */ export declare const macaddress: GenExtension; /** - * IsName returns true if name field satisfies our requirements + * IsName returns true if name field satisfies our requirements. * * @generated from extension: optional bool is_name = 80048952; */ export declare const is_name: GenExtension; /** - * IsDescription returns true if description field satisfies our requirements + * IsDescription returns true if description field satisfies our requirements. * * @generated from extension: optional bool is_description = 80048953; */ export declare const is_description: GenExtension; /** - * IsPartition returns true if partition field satisfies our requirements + * IsPartition returns true if partition field satisfies our requirements. * * @generated from extension: optional bool is_partition = 80048954; */ export declare const is_partition: GenExtension; /** - * IsPrefix validates if the given string is a valid prefix + * IsPrefix validates if the given string is a valid prefix. * * @generated from extension: optional bool is_prefix = 80048955; */ export declare const is_prefix: GenExtension; /** - * IsUri validates if the given string is a valid URI + * IsUri validates if the given string is a valid URI. * * @generated from extension: optional bool is_uri = 80048956; */ export declare const is_uri: GenExtension; /** - * IsIpOrHostname validates that the given string is either a ip or a hostname + * IsIpOrHostname validates that the given string is either a ip or a hostname. * * @generated from extension: optional bool is_ip_or_hostname = 80048957; */ export declare const is_ip_or_hostname: GenExtension; /** - * 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. * * @generated from extension: optional bool trimmed = 80048958; */ export declare const trimmed: GenExtension; /** - * IsUser returns true if name field satisfies our requirements + * IsUser returns true if name field satisfies our requirements. * * @generated from extension: optional bool is_user = 80048959; */ export declare const is_user: GenExtension; /** - * IsOption returns true if name field satisfies our requirements + * IsOption returns true if name field satisfies our requirements. * * @generated from extension: optional bool is_option = 80048960; */ export declare const is_option: GenExtension; /** - * IsKey returns true if name field satisfies our requirements + * IsKey returns true if name field satisfies our requirements. * * @generated from extension: optional bool is_key = 80048961; */ export declare const is_key: GenExtension; /** - * IsTenantLogin returns true if name field satisfies our requirements + * IsTenantLogin returns true if name field satisfies our requirements. * * @generated from extension: optional bool is_tenant_login = 80048962; */ export declare const is_tenant_login: GenExtension; /** - * IsTenantSubjectPermission returns true if name field satisfies our requirements + * IsTenantSubjectPermission returns true if name field satisfies our requirements. * * @generated from extension: optional bool is_tenant_subject_permission = 80048963; */ export declare const is_tenant_subject_permission: GenExtension; /** - * IsProjectSubjectPermission returns true if name field satisfies our requirements + * IsProjectSubjectPermission returns true if name field satisfies our requirements. * * @generated from extension: optional bool is_project_subject_permission = 80048964; */ export declare const is_project_subject_permission: GenExtension; /** - * IsMachineSubjectPermission returns true if name field satisfies our requirements + * IsMachineSubjectPermission returns true if name field satisfies our requirements. * * @generated from extension: optional bool is_machine_subject_permission = 80048965; */ export declare const is_machine_subject_permission: GenExtension; /** - * Prefixes validates if a slice of prefixes in string form are valid + * Prefixes validates if a slice of prefixes in string form are valid. * * @generated from extension: optional bool prefixes = 80058951; */ export declare const prefixes: GenExtension; /** - * Ips validates if a slice of ips in string form are valid + * Ips validates if a slice of ips in string form are valid. * * @generated from extension: optional bool ips = 80058952; */ export declare const ips: GenExtension; /** - * AreHostAndPort validates if a slice of strings are all in the form of : + * AreHostAndPort validates if a slice of strings are all in the form of :. * * @generated from extension: optional bool are_host_and_port = 80058953; */ export declare const are_host_and_port: GenExtension; /** - * All Trimmed enforces all strings to be trimmed, e.g. no whitespaces at the begin and end + * All Trimmed enforces all strings to be trimmed, e.g. no whitespaces at the begin and end. * * @generated from extension: optional bool all_trimmed = 80058954; */ export declare const all_trimmed: GenExtension; /** - * Keys and Values trimmed enforces all map keys and values to be trimmed, e.g. no whitespaces at the begin and end + * Keys and Values trimmed enforces all map keys and values to be trimmed, e.g. no whitespaces at the begin and end. * * @generated from extension: optional bool keys_and_values_trimmed = 80068951; */ export declare const keys_and_values_trimmed: GenExtension; /** - * Keys trimmed enforces all map keys and values to be trimmed, e.g. no whitespaces at the begin and end + * Keys trimmed enforces all map keys and values to be trimmed, e.g. no whitespaces at the begin and end. * * @generated from extension: optional bool keys_trimmed = 80068952; */ export declare const keys_trimmed: GenExtension; /** - * ProjectRolesKeysValid ensures that project roles keys met our requirements + * ProjectRolesKeysValid ensures that project roles keys met our requirements. * * @generated from extension: optional bool project_roles_keys_valid = 80068953; */ export declare const project_roles_keys_valid: GenExtension; /** - * TenantRolesKeysValid ensures that tenant roles keys met our requirements + * TenantRolesKeysValid ensures that tenant roles keys met our requirements. * * @generated from extension: optional bool tenant_roles_keys_valid = 80068954; */ export declare const tenant_roles_keys_valid: GenExtension; /** - * MachineRolesKeysValid ensures that machine roles keys met our requirements + * MachineRolesKeysValid ensures that machine roles keys met our requirements. * * @generated from extension: optional bool machine_roles_keys_valid = 80068955; */ diff --git a/js/metalstack/api/v2/predefined_rules_pb.js b/js/metalstack/api/v2/predefined_rules_pb.js index 6a7fd08b..07e11c99 100644 --- a/js/metalstack/api/v2/predefined_rules_pb.js +++ b/js/metalstack/api/v2/predefined_rules_pb.js @@ -8,145 +8,145 @@ import { file_buf_validate_validate } from "../../../buf/validate/validate_pb"; */ export const file_metalstack_api_v2_predefined_rules = /*@__PURE__*/ fileDesc("CihtZXRhbHN0YWNrL2FwaS92Mi9wcmVkZWZpbmVkX3J1bGVzLnByb3RvEhFtZXRhbHN0YWNrLmFwaS52Mjq4AQoKbWFjYWRkcmVzcxIZLmJ1Zi52YWxpZGF0ZS5TdHJpbmdSdWxlcxi35pUmIAEoCEJ6wkh3CnUKEXN0cmluZy5tYWNhZGRyZXNzEiZ0aGlzIHN0cmluZyBtdXN0IGJlIGEgdmFsaWQgbWFjYWRkcmVzcxo4dGhpcy5tYXRjaGVzKCdeKFswLTlBLUZhLWZdezJ9WzpdKXs1fShbMC05QS1GYS1mXXsyfSkkJylSCm1hY2FkZHJlc3M6mQEKB2lzX25hbWUSGS5idWYudmFsaWRhdGUuU3RyaW5nUnVsZXMYuOaVJiABKAhCYsJIXwpdCg5zdHJpbmcuaXNfbmFtZRIjbXVzdCBiZSB3aXRoaW4gMiBhbmQgMTI4IGNoYXJhY3RlcnMaJnRoaXMuc2l6ZSgpID49IDIgJiYgdGhpcy5zaXplKCkgPD0gMTI4UgZpc05hbWU6mgEKDmlzX2Rlc2NyaXB0aW9uEhkuYnVmLnZhbGlkYXRlLlN0cmluZ1J1bGVzGLnmlSYgASgIQlXCSFIKUAoVc3RyaW5nLmlzX2Rlc2NyaXB0aW9uEiNtdXN0IGJlIHNob3J0ZXIgdGhhbiAyNTYgY2hhcmFjdGVycxoSdGhpcy5zaXplKCkgPD0gMjU2Ug1pc0Rlc2NyaXB0aW9uOqgBCgxpc19wYXJ0aXRpb24SGS5idWYudmFsaWRhdGUuU3RyaW5nUnVsZXMYuuaVJiABKAhCZ8JIZApiChNzdHJpbmcuaXNfcGFydGl0aW9uEiNtdXN0IGJlIHdpdGhpbiAyIGFuZCAxMjggY2hhcmFjdGVycxomdGhpcy5zaXplKCkgPj0gMiAmJiB0aGlzLnNpemUoKSA8PSAxMjhSC2lzUGFydGl0aW9uOoIBCglpc19wcmVmaXgSGS5idWYudmFsaWRhdGUuU3RyaW5nUnVsZXMYu+aVJiABKAhCR8JIRApCCg9zdHJpbmcucHJlZml4ZXMSHGdpdmVuIHByZWZpeGVzIG11c3QgYmUgdmFsaWQaEXRoaXMuaXNJcFByZWZpeCgpUghpc1ByZWZpeDptCgZpc191cmkSGS5idWYudmFsaWRhdGUuU3RyaW5nUnVsZXMYvOaVJiABKAhCOMJINQozCgpzdHJpbmcudXJpEhdnaXZlbiB1cmkgbXVzdCBiZSB2YWxpZBoMdGhpcy5pc1VyaSgpUgVpc1VyaTqnAQoRaXNfaXBfb3JfaG9zdG5hbWUSGS5idWYudmFsaWRhdGUuU3RyaW5nUnVsZXMYveaVJiABKAhCXsJIWwpZCg12YWxpZF9hZGRyZXNzEiZtdXN0IGJlIGEgdmFsaWQgSVAgYWRkcmVzcyBvciBob3N0bmFtZRogdGhpcy5pc0lwKCkgfHwgdGhpcy5pc0hvc3RuYW1lKClSDmlzSXBPckhvc3RuYW1lOp0BCgd0cmltbWVkEhkuYnVmLnZhbGlkYXRlLlN0cmluZ1J1bGVzGL7mlSYgASgIQmXCSGIKYAoOc3RyaW5nLnRyaW1tZWQSK3ZhbHVlIG11c3Qgbm90IHN0YXJ0IG9yIGVuZCB3aXRoIHdoaXRlc3BhY2UaIXRoaXMudHJpbSgpLnNpemUoKSA9PSB0aGlzLnNpemUoKVIHdHJpbW1lZDqZAQoHaXNfdXNlchIZLmJ1Zi52YWxpZGF0ZS5TdHJpbmdSdWxlcxi/5pUmIAEoCEJiwkhfCl0KDnN0cmluZy5pc191c2VyEiNtdXN0IGJlIHdpdGhpbiAyIGFuZCA1MTIgY2hhcmFjdGVycxomdGhpcy5zaXplKCkgPj0gMiAmJiB0aGlzLnNpemUoKSA8PSA1MTJSBmlzVXNlcjqfAQoJaXNfb3B0aW9uEhkuYnVmLnZhbGlkYXRlLlN0cmluZ1J1bGVzGMDmlSYgASgIQmTCSGEKXwoQc3RyaW5nLmlzX29wdGlvbhIjbXVzdCBiZSB3aXRoaW4gMSBhbmQgMTI4IGNoYXJhY3RlcnMaJnRoaXMuc2l6ZSgpID49IDEgJiYgdGhpcy5zaXplKCkgPD0gMTI4Ughpc09wdGlvbjqYAQoGaXNfa2V5EhkuYnVmLnZhbGlkYXRlLlN0cmluZ1J1bGVzGMHmlSYgASgIQmPCSGAKXgoNc3RyaW5nLmlzX2tleRIkbXVzdCBiZSB3aXRoaW4gMSBhbmQgODE5MiBjaGFyYWN0ZXJzGid0aGlzLnNpemUoKSA+PSAxICYmIHRoaXMuc2l6ZSgpIDw9IDgxOTJSBWlzS2V5OrABCg9pc190ZW5hbnRfbG9naW4SGS5idWYudmFsaWRhdGUuU3RyaW5nUnVsZXMYwuaVJiABKAhCasJIZwplChZzdHJpbmcuaXNfdGVuYW50X2xvZ2luEiNtdXN0IGJlIHdpdGhpbiAyIGFuZCAxMjggY2hhcmFjdGVycxomdGhpcy5zaXplKCkgPj0gMiAmJiB0aGlzLnNpemUoKSA8PSAxMjhSDWlzVGVuYW50TG9naW467wEKHGlzX3RlbmFudF9zdWJqZWN0X3Blcm1pc3Npb24SGS5idWYudmFsaWRhdGUuU3RyaW5nUnVsZXMYw+aVJiABKAhCjwHCSIsBCogBCiNzdHJpbmcuaXNfdGVuYW50X3N1YmplY3RfcGVybWlzc2lvbhIqbXVzdCBiZSAnKicgb3Igd2l0aGluIDIgYW5kIDEyOCBjaGFyYWN0ZXJzGjV0aGlzID09ICcqJyB8fCB0aGlzLnNpemUoKSA+PSAyICYmIHRoaXMuc2l6ZSgpIDw9IDEyOFIZaXNUZW5hbnRTdWJqZWN0UGVybWlzc2lvbjqUAgodaXNfcHJvamVjdF9zdWJqZWN0X3Blcm1pc3Npb24SGS5idWYudmFsaWRhdGUuU3RyaW5nUnVsZXMYxOaVJiABKAhCsgHCSK4BCqsBCiRzdHJpbmcuaXNfcHJvamVjdF9zdWJqZWN0X3Blcm1pc3Npb24SFW11c3QgYmUgJyonIG9yIGEgdXVpZBpsdGhpcyA9PSAnKicgfHwgdGhpcy5tYXRjaGVzKCdeWzAtOWEtZkEtRl17OH0tWzAtOWEtZkEtRl17NH0tWzAtOWEtZkEtRl17NH0tWzAtOWEtZkEtRl17NH0tWzAtOWEtZkEtRl17MTJ9JCcpUhppc1Byb2plY3RTdWJqZWN0UGVybWlzc2lvbjqUAgodaXNfbWFjaGluZV9zdWJqZWN0X3Blcm1pc3Npb24SGS5idWYudmFsaWRhdGUuU3RyaW5nUnVsZXMYxeaVJiABKAhCsgHCSK4BCqsBCiRzdHJpbmcuaXNfbWFjaGluZV9zdWJqZWN0X3Blcm1pc3Npb24SFW11c3QgYmUgJyonIG9yIGEgdXVpZBpsdGhpcyA9PSAnKicgfHwgdGhpcy5tYXRjaGVzKCdeWzAtOWEtZkEtRl17OH0tWzAtOWEtZkEtRl17NH0tWzAtOWEtZkEtRl17NH0tWzAtOWEtZkEtRl17NH0tWzAtOWEtZkEtRl17MTJ9JCcpUhppc01hY2hpbmVTdWJqZWN0UGVybWlzc2lvbjqPAQoIcHJlZml4ZXMSGy5idWYudmFsaWRhdGUuUmVwZWF0ZWRSdWxlcxjHtJYmIAEoCEJTwkhQCk4KEXJlcGVhdGVkLnByZWZpeGVzEhxnaXZlbiBwcmVmaXhlcyBtdXN0IGJlIHZhbGlkGht0aGlzLmFsbChtLCBtLmlzSXBQcmVmaXgoKSlSCHByZWZpeGVzOnUKA2lwcxIbLmJ1Zi52YWxpZGF0ZS5SZXBlYXRlZFJ1bGVzGMi0liYgASgIQkPCSEAKPgoMcmVwZWF0ZWQuaXBzEhdnaXZlbiBpcHMgbXVzdCBiZSB2YWxpZBoVdGhpcy5hbGwobSwgbS5pc0lwKCkpUgNpcHM65gEKEWFyZV9ob3N0X2FuZF9wb3J0EhsuYnVmLnZhbGlkYXRlLlJlcGVhdGVkUnVsZXMYybSWJiABKAhCmgHCSJYBCpMBChpyZXBlYXRlZC5hcmVfaG9zdF9hbmRfcG9ydBJQZ2l2ZW4gZW50cmllcyBtdXN0IGFsbCBiZSBpbiB0aGUgZm9ybSBvZiA8aXAgfCBob3N0Pjo8cG9ydD4gYnV0IHBvcnQgaXMgb3B0aW9uYWwaI3RoaXMuYWxsKG0sIG0uaXNIb3N0QW5kUG9ydChmYWxzZSkpUg5hcmVIb3N0QW5kUG9ydDq6AQoLYWxsX3RyaW1tZWQSGy5idWYudmFsaWRhdGUuUmVwZWF0ZWRSdWxlcxjKtJYmIAEoCEJ5wkh2CnQKFHJlcGVhdGVkLmFsbF90cmltbWVkEjJnaXZlbiB2YWx1ZXMgbXVzdCBub3Qgc3RhcnQgb3IgZW5kIHdpdGggd2hpdGVzcGFjZRoodGhpcy5hbGwobSwgbS50cmltKCkuc2l6ZSgpID09IG0uc2l6ZSgpKVIKYWxsVHJpbW1lZDqEAgoXa2V5c19hbmRfdmFsdWVzX3RyaW1tZWQSFi5idWYudmFsaWRhdGUuTWFwUnVsZXMY14KXJiABKAhCsQHCSK0BCqoBChttYXAua2V5c19hbmRfdmFsdWVzX3RyaW1tZWQSNWtleXMgYW5kIHZhbHVlcyBtdXN0IG5vdCBzdGFydCBvciBlbmQgd2l0aCB3aGl0ZXNwYWNlGlR0aGlzLmFsbChrLCBrLnRyaW0oKS5zaXplKCkgPT0gay5zaXplKCkpICYmIHRoaXMuYWxsKHYsIHYudHJpbSgpLnNpemUoKSA9PSB2LnNpemUoKSlSFGtleXNBbmRWYWx1ZXNUcmltbWVkOqsBCgxrZXlzX3RyaW1tZWQSFi5idWYudmFsaWRhdGUuTWFwUnVsZXMY2IKXJiABKAhCbcJIagpoChBtYXAua2V5c190cmltbWVkEiprZXlzIG11c3Qgbm90IHN0YXJ0IG9yIGVuZCB3aXRoIHdoaXRlc3BhY2UaKHRoaXMuYWxsKGssIGsudHJpbSgpLnNpemUoKSA9PSBrLnNpemUoKSlSC2tleXNUcmltbWVkOpICChhwcm9qZWN0X3JvbGVzX2tleXNfdmFsaWQSFi5idWYudmFsaWRhdGUuTWFwUnVsZXMY2YKXJiABKAhCvQHCSLkBCrYBChdwcm9qZWN0X3JvbGVzLmtleS52YWxpZBImc3ViamVjdCBtdXN0IGJlIGEgJyonLCBvciBhIHZhbGlkIFVVSUQac3RoaXMuYWxsKGssIGsgPT0gJyonIHx8IGsubWF0Y2hlcygnXlswLTlhLWZBLUZdezh9LVswLTlhLWZBLUZdezR9LVswLTlhLWZBLUZdezR9LVswLTlhLWZBLUZdezR9LVswLTlhLWZBLUZdezEyfSQnKSlSFXByb2plY3RSb2xlc0tleXNWYWxpZDroAQoXdGVuYW50X3JvbGVzX2tleXNfdmFsaWQSFi5idWYudmFsaWRhdGUuTWFwUnVsZXMY2oKXJiABKAhClQHCSJEBCo4BChZ0ZW5hbnRfcm9sZXMua2V5LnZhbGlkEjNzdWJqZWN0IG11c3QgYmUgJyonIG9yIGJldHdlZW4gMiBhbmQgMTI4IGNoYXJhY3RlcnMaP3RoaXMuYWxsKGssIGsgPT0gJyonIHx8IHRoaXMuc2l6ZSgpID49IDIgfHwgdGhpcy5zaXplKCkgPD0xMjggKVIUdGVuYW50Um9sZXNLZXlzVmFsaWQ6ngIKGG1hY2hpbmVfcm9sZXNfa2V5c192YWxpZBIWLmJ1Zi52YWxpZGF0ZS5NYXBSdWxlcxjbgpcmIAEoCELJAcJIxQEKwgEKF21hY2hpbmVfcm9sZXMua2V5LnZhbGlkEjJzdWJqZWN0IG11c3QgYmUgZW1wdHkgc3RyaW5nLCAnKicsIG9yIGEgdmFsaWQgVVVJRBpzdGhpcy5hbGwoaywgayA9PSAnKicgfHwgay5tYXRjaGVzKCdeWzAtOWEtZkEtRl17OH0tWzAtOWEtZkEtRl17NH0tWzAtOWEtZkEtRl17NH0tWzAtOWEtZkEtRl17NH0tWzAtOWEtZkEtRl17MTJ9JCcpKVIVbWFjaGluZVJvbGVzS2V5c1ZhbGlkQsoBChVjb20ubWV0YWxzdGFjay5hcGkudjJCFFByZWRlZmluZWRSdWxlc1Byb3RvUAFaNWdpdGh1Yi5jb20vbWV0YWwtc3RhY2svYXBpL2dvL21ldGFsc3RhY2svYXBpL3YyO2FwaXYyogIDTUFYqgIRTWV0YWxzdGFjay5BcGkuVjLKAhFNZXRhbHN0YWNrXEFwaVxWMuICHU1ldGFsc3RhY2tcQXBpXFYyXEdQQk1ldGFkYXRh6gITTWV0YWxzdGFjazo6QXBpOjpWMg", [file_buf_validate_validate]); /** - * Macaddress returns true if the given string is a valid macaddress + * Macaddress returns true if the given string is a valid macaddress. * * @generated from extension: optional bool macaddress = 80048951; */ export const macaddress = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 0); /** - * IsName returns true if name field satisfies our requirements + * IsName returns true if name field satisfies our requirements. * * @generated from extension: optional bool is_name = 80048952; */ export const is_name = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 1); /** - * IsDescription returns true if description field satisfies our requirements + * IsDescription returns true if description field satisfies our requirements. * * @generated from extension: optional bool is_description = 80048953; */ export const is_description = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 2); /** - * IsPartition returns true if partition field satisfies our requirements + * IsPartition returns true if partition field satisfies our requirements. * * @generated from extension: optional bool is_partition = 80048954; */ export const is_partition = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 3); /** - * IsPrefix validates if the given string is a valid prefix + * IsPrefix validates if the given string is a valid prefix. * * @generated from extension: optional bool is_prefix = 80048955; */ export const is_prefix = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 4); /** - * IsUri validates if the given string is a valid URI + * IsUri validates if the given string is a valid URI. * * @generated from extension: optional bool is_uri = 80048956; */ export const is_uri = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 5); /** - * IsIpOrHostname validates that the given string is either a ip or a hostname + * IsIpOrHostname validates that the given string is either a ip or a hostname. * * @generated from extension: optional bool is_ip_or_hostname = 80048957; */ export const is_ip_or_hostname = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 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. * * @generated from extension: optional bool trimmed = 80048958; */ export const trimmed = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 7); /** - * IsUser returns true if name field satisfies our requirements + * IsUser returns true if name field satisfies our requirements. * * @generated from extension: optional bool is_user = 80048959; */ export const is_user = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 8); /** - * IsOption returns true if name field satisfies our requirements + * IsOption returns true if name field satisfies our requirements. * * @generated from extension: optional bool is_option = 80048960; */ export const is_option = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 9); /** - * IsKey returns true if name field satisfies our requirements + * IsKey returns true if name field satisfies our requirements. * * @generated from extension: optional bool is_key = 80048961; */ export const is_key = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 10); /** - * IsTenantLogin returns true if name field satisfies our requirements + * IsTenantLogin returns true if name field satisfies our requirements. * * @generated from extension: optional bool is_tenant_login = 80048962; */ export const is_tenant_login = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 11); /** - * IsTenantSubjectPermission returns true if name field satisfies our requirements + * IsTenantSubjectPermission returns true if name field satisfies our requirements. * * @generated from extension: optional bool is_tenant_subject_permission = 80048963; */ export const is_tenant_subject_permission = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 12); /** - * IsProjectSubjectPermission returns true if name field satisfies our requirements + * IsProjectSubjectPermission returns true if name field satisfies our requirements. * * @generated from extension: optional bool is_project_subject_permission = 80048964; */ export const is_project_subject_permission = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 13); /** - * IsMachineSubjectPermission returns true if name field satisfies our requirements + * IsMachineSubjectPermission returns true if name field satisfies our requirements. * * @generated from extension: optional bool is_machine_subject_permission = 80048965; */ export const is_machine_subject_permission = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 14); /** - * Prefixes validates if a slice of prefixes in string form are valid + * Prefixes validates if a slice of prefixes in string form are valid. * * @generated from extension: optional bool prefixes = 80058951; */ export const prefixes = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 15); /** - * Ips validates if a slice of ips in string form are valid + * Ips validates if a slice of ips in string form are valid. * * @generated from extension: optional bool ips = 80058952; */ export const ips = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 16); /** - * AreHostAndPort validates if a slice of strings are all in the form of : + * AreHostAndPort validates if a slice of strings are all in the form of :. * * @generated from extension: optional bool are_host_and_port = 80058953; */ export const are_host_and_port = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 17); /** - * All Trimmed enforces all strings to be trimmed, e.g. no whitespaces at the begin and end + * All Trimmed enforces all strings to be trimmed, e.g. no whitespaces at the begin and end. * * @generated from extension: optional bool all_trimmed = 80058954; */ export const all_trimmed = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 18); /** - * Keys and Values trimmed enforces all map keys and values to be trimmed, e.g. no whitespaces at the begin and end + * Keys and Values trimmed enforces all map keys and values to be trimmed, e.g. no whitespaces at the begin and end. * * @generated from extension: optional bool keys_and_values_trimmed = 80068951; */ export const keys_and_values_trimmed = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 19); /** - * Keys trimmed enforces all map keys and values to be trimmed, e.g. no whitespaces at the begin and end + * Keys trimmed enforces all map keys and values to be trimmed, e.g. no whitespaces at the begin and end. * * @generated from extension: optional bool keys_trimmed = 80068952; */ export const keys_trimmed = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 20); /** - * ProjectRolesKeysValid ensures that project roles keys met our requirements + * ProjectRolesKeysValid ensures that project roles keys met our requirements. * * @generated from extension: optional bool project_roles_keys_valid = 80068953; */ export const project_roles_keys_valid = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 21); /** - * TenantRolesKeysValid ensures that tenant roles keys met our requirements + * TenantRolesKeysValid ensures that tenant roles keys met our requirements. * * @generated from extension: optional bool tenant_roles_keys_valid = 80068954; */ export const tenant_roles_keys_valid = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 22); /** - * MachineRolesKeysValid ensures that machine roles keys met our requirements + * MachineRolesKeysValid ensures that machine roles keys met our requirements. * * @generated from extension: optional bool machine_roles_keys_valid = 80068955; */ diff --git a/js/metalstack/api/v2/predefined_rules_pb.ts b/js/metalstack/api/v2/predefined_rules_pb.ts index e035d7dc..92551561 100644 --- a/js/metalstack/api/v2/predefined_rules_pb.ts +++ b/js/metalstack/api/v2/predefined_rules_pb.ts @@ -14,7 +14,7 @@ export const file_metalstack_api_v2_predefined_rules: GenFile = /*@__PURE__*/ fileDesc("CihtZXRhbHN0YWNrL2FwaS92Mi9wcmVkZWZpbmVkX3J1bGVzLnByb3RvEhFtZXRhbHN0YWNrLmFwaS52Mjq4AQoKbWFjYWRkcmVzcxIZLmJ1Zi52YWxpZGF0ZS5TdHJpbmdSdWxlcxi35pUmIAEoCEJ6wkh3CnUKEXN0cmluZy5tYWNhZGRyZXNzEiZ0aGlzIHN0cmluZyBtdXN0IGJlIGEgdmFsaWQgbWFjYWRkcmVzcxo4dGhpcy5tYXRjaGVzKCdeKFswLTlBLUZhLWZdezJ9WzpdKXs1fShbMC05QS1GYS1mXXsyfSkkJylSCm1hY2FkZHJlc3M6mQEKB2lzX25hbWUSGS5idWYudmFsaWRhdGUuU3RyaW5nUnVsZXMYuOaVJiABKAhCYsJIXwpdCg5zdHJpbmcuaXNfbmFtZRIjbXVzdCBiZSB3aXRoaW4gMiBhbmQgMTI4IGNoYXJhY3RlcnMaJnRoaXMuc2l6ZSgpID49IDIgJiYgdGhpcy5zaXplKCkgPD0gMTI4UgZpc05hbWU6mgEKDmlzX2Rlc2NyaXB0aW9uEhkuYnVmLnZhbGlkYXRlLlN0cmluZ1J1bGVzGLnmlSYgASgIQlXCSFIKUAoVc3RyaW5nLmlzX2Rlc2NyaXB0aW9uEiNtdXN0IGJlIHNob3J0ZXIgdGhhbiAyNTYgY2hhcmFjdGVycxoSdGhpcy5zaXplKCkgPD0gMjU2Ug1pc0Rlc2NyaXB0aW9uOqgBCgxpc19wYXJ0aXRpb24SGS5idWYudmFsaWRhdGUuU3RyaW5nUnVsZXMYuuaVJiABKAhCZ8JIZApiChNzdHJpbmcuaXNfcGFydGl0aW9uEiNtdXN0IGJlIHdpdGhpbiAyIGFuZCAxMjggY2hhcmFjdGVycxomdGhpcy5zaXplKCkgPj0gMiAmJiB0aGlzLnNpemUoKSA8PSAxMjhSC2lzUGFydGl0aW9uOoIBCglpc19wcmVmaXgSGS5idWYudmFsaWRhdGUuU3RyaW5nUnVsZXMYu+aVJiABKAhCR8JIRApCCg9zdHJpbmcucHJlZml4ZXMSHGdpdmVuIHByZWZpeGVzIG11c3QgYmUgdmFsaWQaEXRoaXMuaXNJcFByZWZpeCgpUghpc1ByZWZpeDptCgZpc191cmkSGS5idWYudmFsaWRhdGUuU3RyaW5nUnVsZXMYvOaVJiABKAhCOMJINQozCgpzdHJpbmcudXJpEhdnaXZlbiB1cmkgbXVzdCBiZSB2YWxpZBoMdGhpcy5pc1VyaSgpUgVpc1VyaTqnAQoRaXNfaXBfb3JfaG9zdG5hbWUSGS5idWYudmFsaWRhdGUuU3RyaW5nUnVsZXMYveaVJiABKAhCXsJIWwpZCg12YWxpZF9hZGRyZXNzEiZtdXN0IGJlIGEgdmFsaWQgSVAgYWRkcmVzcyBvciBob3N0bmFtZRogdGhpcy5pc0lwKCkgfHwgdGhpcy5pc0hvc3RuYW1lKClSDmlzSXBPckhvc3RuYW1lOp0BCgd0cmltbWVkEhkuYnVmLnZhbGlkYXRlLlN0cmluZ1J1bGVzGL7mlSYgASgIQmXCSGIKYAoOc3RyaW5nLnRyaW1tZWQSK3ZhbHVlIG11c3Qgbm90IHN0YXJ0IG9yIGVuZCB3aXRoIHdoaXRlc3BhY2UaIXRoaXMudHJpbSgpLnNpemUoKSA9PSB0aGlzLnNpemUoKVIHdHJpbW1lZDqZAQoHaXNfdXNlchIZLmJ1Zi52YWxpZGF0ZS5TdHJpbmdSdWxlcxi/5pUmIAEoCEJiwkhfCl0KDnN0cmluZy5pc191c2VyEiNtdXN0IGJlIHdpdGhpbiAyIGFuZCA1MTIgY2hhcmFjdGVycxomdGhpcy5zaXplKCkgPj0gMiAmJiB0aGlzLnNpemUoKSA8PSA1MTJSBmlzVXNlcjqfAQoJaXNfb3B0aW9uEhkuYnVmLnZhbGlkYXRlLlN0cmluZ1J1bGVzGMDmlSYgASgIQmTCSGEKXwoQc3RyaW5nLmlzX29wdGlvbhIjbXVzdCBiZSB3aXRoaW4gMSBhbmQgMTI4IGNoYXJhY3RlcnMaJnRoaXMuc2l6ZSgpID49IDEgJiYgdGhpcy5zaXplKCkgPD0gMTI4Ughpc09wdGlvbjqYAQoGaXNfa2V5EhkuYnVmLnZhbGlkYXRlLlN0cmluZ1J1bGVzGMHmlSYgASgIQmPCSGAKXgoNc3RyaW5nLmlzX2tleRIkbXVzdCBiZSB3aXRoaW4gMSBhbmQgODE5MiBjaGFyYWN0ZXJzGid0aGlzLnNpemUoKSA+PSAxICYmIHRoaXMuc2l6ZSgpIDw9IDgxOTJSBWlzS2V5OrABCg9pc190ZW5hbnRfbG9naW4SGS5idWYudmFsaWRhdGUuU3RyaW5nUnVsZXMYwuaVJiABKAhCasJIZwplChZzdHJpbmcuaXNfdGVuYW50X2xvZ2luEiNtdXN0IGJlIHdpdGhpbiAyIGFuZCAxMjggY2hhcmFjdGVycxomdGhpcy5zaXplKCkgPj0gMiAmJiB0aGlzLnNpemUoKSA8PSAxMjhSDWlzVGVuYW50TG9naW467wEKHGlzX3RlbmFudF9zdWJqZWN0X3Blcm1pc3Npb24SGS5idWYudmFsaWRhdGUuU3RyaW5nUnVsZXMYw+aVJiABKAhCjwHCSIsBCogBCiNzdHJpbmcuaXNfdGVuYW50X3N1YmplY3RfcGVybWlzc2lvbhIqbXVzdCBiZSAnKicgb3Igd2l0aGluIDIgYW5kIDEyOCBjaGFyYWN0ZXJzGjV0aGlzID09ICcqJyB8fCB0aGlzLnNpemUoKSA+PSAyICYmIHRoaXMuc2l6ZSgpIDw9IDEyOFIZaXNUZW5hbnRTdWJqZWN0UGVybWlzc2lvbjqUAgodaXNfcHJvamVjdF9zdWJqZWN0X3Blcm1pc3Npb24SGS5idWYudmFsaWRhdGUuU3RyaW5nUnVsZXMYxOaVJiABKAhCsgHCSK4BCqsBCiRzdHJpbmcuaXNfcHJvamVjdF9zdWJqZWN0X3Blcm1pc3Npb24SFW11c3QgYmUgJyonIG9yIGEgdXVpZBpsdGhpcyA9PSAnKicgfHwgdGhpcy5tYXRjaGVzKCdeWzAtOWEtZkEtRl17OH0tWzAtOWEtZkEtRl17NH0tWzAtOWEtZkEtRl17NH0tWzAtOWEtZkEtRl17NH0tWzAtOWEtZkEtRl17MTJ9JCcpUhppc1Byb2plY3RTdWJqZWN0UGVybWlzc2lvbjqUAgodaXNfbWFjaGluZV9zdWJqZWN0X3Blcm1pc3Npb24SGS5idWYudmFsaWRhdGUuU3RyaW5nUnVsZXMYxeaVJiABKAhCsgHCSK4BCqsBCiRzdHJpbmcuaXNfbWFjaGluZV9zdWJqZWN0X3Blcm1pc3Npb24SFW11c3QgYmUgJyonIG9yIGEgdXVpZBpsdGhpcyA9PSAnKicgfHwgdGhpcy5tYXRjaGVzKCdeWzAtOWEtZkEtRl17OH0tWzAtOWEtZkEtRl17NH0tWzAtOWEtZkEtRl17NH0tWzAtOWEtZkEtRl17NH0tWzAtOWEtZkEtRl17MTJ9JCcpUhppc01hY2hpbmVTdWJqZWN0UGVybWlzc2lvbjqPAQoIcHJlZml4ZXMSGy5idWYudmFsaWRhdGUuUmVwZWF0ZWRSdWxlcxjHtJYmIAEoCEJTwkhQCk4KEXJlcGVhdGVkLnByZWZpeGVzEhxnaXZlbiBwcmVmaXhlcyBtdXN0IGJlIHZhbGlkGht0aGlzLmFsbChtLCBtLmlzSXBQcmVmaXgoKSlSCHByZWZpeGVzOnUKA2lwcxIbLmJ1Zi52YWxpZGF0ZS5SZXBlYXRlZFJ1bGVzGMi0liYgASgIQkPCSEAKPgoMcmVwZWF0ZWQuaXBzEhdnaXZlbiBpcHMgbXVzdCBiZSB2YWxpZBoVdGhpcy5hbGwobSwgbS5pc0lwKCkpUgNpcHM65gEKEWFyZV9ob3N0X2FuZF9wb3J0EhsuYnVmLnZhbGlkYXRlLlJlcGVhdGVkUnVsZXMYybSWJiABKAhCmgHCSJYBCpMBChpyZXBlYXRlZC5hcmVfaG9zdF9hbmRfcG9ydBJQZ2l2ZW4gZW50cmllcyBtdXN0IGFsbCBiZSBpbiB0aGUgZm9ybSBvZiA8aXAgfCBob3N0Pjo8cG9ydD4gYnV0IHBvcnQgaXMgb3B0aW9uYWwaI3RoaXMuYWxsKG0sIG0uaXNIb3N0QW5kUG9ydChmYWxzZSkpUg5hcmVIb3N0QW5kUG9ydDq6AQoLYWxsX3RyaW1tZWQSGy5idWYudmFsaWRhdGUuUmVwZWF0ZWRSdWxlcxjKtJYmIAEoCEJ5wkh2CnQKFHJlcGVhdGVkLmFsbF90cmltbWVkEjJnaXZlbiB2YWx1ZXMgbXVzdCBub3Qgc3RhcnQgb3IgZW5kIHdpdGggd2hpdGVzcGFjZRoodGhpcy5hbGwobSwgbS50cmltKCkuc2l6ZSgpID09IG0uc2l6ZSgpKVIKYWxsVHJpbW1lZDqEAgoXa2V5c19hbmRfdmFsdWVzX3RyaW1tZWQSFi5idWYudmFsaWRhdGUuTWFwUnVsZXMY14KXJiABKAhCsQHCSK0BCqoBChttYXAua2V5c19hbmRfdmFsdWVzX3RyaW1tZWQSNWtleXMgYW5kIHZhbHVlcyBtdXN0IG5vdCBzdGFydCBvciBlbmQgd2l0aCB3aGl0ZXNwYWNlGlR0aGlzLmFsbChrLCBrLnRyaW0oKS5zaXplKCkgPT0gay5zaXplKCkpICYmIHRoaXMuYWxsKHYsIHYudHJpbSgpLnNpemUoKSA9PSB2LnNpemUoKSlSFGtleXNBbmRWYWx1ZXNUcmltbWVkOqsBCgxrZXlzX3RyaW1tZWQSFi5idWYudmFsaWRhdGUuTWFwUnVsZXMY2IKXJiABKAhCbcJIagpoChBtYXAua2V5c190cmltbWVkEiprZXlzIG11c3Qgbm90IHN0YXJ0IG9yIGVuZCB3aXRoIHdoaXRlc3BhY2UaKHRoaXMuYWxsKGssIGsudHJpbSgpLnNpemUoKSA9PSBrLnNpemUoKSlSC2tleXNUcmltbWVkOpICChhwcm9qZWN0X3JvbGVzX2tleXNfdmFsaWQSFi5idWYudmFsaWRhdGUuTWFwUnVsZXMY2YKXJiABKAhCvQHCSLkBCrYBChdwcm9qZWN0X3JvbGVzLmtleS52YWxpZBImc3ViamVjdCBtdXN0IGJlIGEgJyonLCBvciBhIHZhbGlkIFVVSUQac3RoaXMuYWxsKGssIGsgPT0gJyonIHx8IGsubWF0Y2hlcygnXlswLTlhLWZBLUZdezh9LVswLTlhLWZBLUZdezR9LVswLTlhLWZBLUZdezR9LVswLTlhLWZBLUZdezR9LVswLTlhLWZBLUZdezEyfSQnKSlSFXByb2plY3RSb2xlc0tleXNWYWxpZDroAQoXdGVuYW50X3JvbGVzX2tleXNfdmFsaWQSFi5idWYudmFsaWRhdGUuTWFwUnVsZXMY2oKXJiABKAhClQHCSJEBCo4BChZ0ZW5hbnRfcm9sZXMua2V5LnZhbGlkEjNzdWJqZWN0IG11c3QgYmUgJyonIG9yIGJldHdlZW4gMiBhbmQgMTI4IGNoYXJhY3RlcnMaP3RoaXMuYWxsKGssIGsgPT0gJyonIHx8IHRoaXMuc2l6ZSgpID49IDIgfHwgdGhpcy5zaXplKCkgPD0xMjggKVIUdGVuYW50Um9sZXNLZXlzVmFsaWQ6ngIKGG1hY2hpbmVfcm9sZXNfa2V5c192YWxpZBIWLmJ1Zi52YWxpZGF0ZS5NYXBSdWxlcxjbgpcmIAEoCELJAcJIxQEKwgEKF21hY2hpbmVfcm9sZXMua2V5LnZhbGlkEjJzdWJqZWN0IG11c3QgYmUgZW1wdHkgc3RyaW5nLCAnKicsIG9yIGEgdmFsaWQgVVVJRBpzdGhpcy5hbGwoaywgayA9PSAnKicgfHwgay5tYXRjaGVzKCdeWzAtOWEtZkEtRl17OH0tWzAtOWEtZkEtRl17NH0tWzAtOWEtZkEtRl17NH0tWzAtOWEtZkEtRl17NH0tWzAtOWEtZkEtRl17MTJ9JCcpKVIVbWFjaGluZVJvbGVzS2V5c1ZhbGlkQsoBChVjb20ubWV0YWxzdGFjay5hcGkudjJCFFByZWRlZmluZWRSdWxlc1Byb3RvUAFaNWdpdGh1Yi5jb20vbWV0YWwtc3RhY2svYXBpL2dvL21ldGFsc3RhY2svYXBpL3YyO2FwaXYyogIDTUFYqgIRTWV0YWxzdGFjay5BcGkuVjLKAhFNZXRhbHN0YWNrXEFwaVxWMuICHU1ldGFsc3RhY2tcQXBpXFYyXEdQQk1ldGFkYXRh6gITTWV0YWxzdGFjazo6QXBpOjpWMg", [file_buf_validate_validate]); /** - * Macaddress returns true if the given string is a valid macaddress + * Macaddress returns true if the given string is a valid macaddress. * * @generated from extension: optional bool macaddress = 80048951; */ @@ -22,7 +22,7 @@ export const macaddress: GenExtension = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 0); /** - * IsName returns true if name field satisfies our requirements + * IsName returns true if name field satisfies our requirements. * * @generated from extension: optional bool is_name = 80048952; */ @@ -30,7 +30,7 @@ export const is_name: GenExtension = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 1); /** - * IsDescription returns true if description field satisfies our requirements + * IsDescription returns true if description field satisfies our requirements. * * @generated from extension: optional bool is_description = 80048953; */ @@ -38,7 +38,7 @@ export const is_description: GenExtension = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 2); /** - * IsPartition returns true if partition field satisfies our requirements + * IsPartition returns true if partition field satisfies our requirements. * * @generated from extension: optional bool is_partition = 80048954; */ @@ -46,7 +46,7 @@ export const is_partition: GenExtension = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 3); /** - * IsPrefix validates if the given string is a valid prefix + * IsPrefix validates if the given string is a valid prefix. * * @generated from extension: optional bool is_prefix = 80048955; */ @@ -54,7 +54,7 @@ export const is_prefix: GenExtension = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 4); /** - * IsUri validates if the given string is a valid URI + * IsUri validates if the given string is a valid URI. * * @generated from extension: optional bool is_uri = 80048956; */ @@ -62,7 +62,7 @@ export const is_uri: GenExtension = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 5); /** - * IsIpOrHostname validates that the given string is either a ip or a hostname + * IsIpOrHostname validates that the given string is either a ip or a hostname. * * @generated from extension: optional bool is_ip_or_hostname = 80048957; */ @@ -70,7 +70,7 @@ export const is_ip_or_hostname: GenExtension = /*@__PURE__ extDesc(file_metalstack_api_v2_predefined_rules, 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. * * @generated from extension: optional bool trimmed = 80048958; */ @@ -78,7 +78,7 @@ export const trimmed: GenExtension = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 7); /** - * IsUser returns true if name field satisfies our requirements + * IsUser returns true if name field satisfies our requirements. * * @generated from extension: optional bool is_user = 80048959; */ @@ -86,7 +86,7 @@ export const is_user: GenExtension = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 8); /** - * IsOption returns true if name field satisfies our requirements + * IsOption returns true if name field satisfies our requirements. * * @generated from extension: optional bool is_option = 80048960; */ @@ -94,7 +94,7 @@ export const is_option: GenExtension = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 9); /** - * IsKey returns true if name field satisfies our requirements + * IsKey returns true if name field satisfies our requirements. * * @generated from extension: optional bool is_key = 80048961; */ @@ -102,7 +102,7 @@ export const is_key: GenExtension = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 10); /** - * IsTenantLogin returns true if name field satisfies our requirements + * IsTenantLogin returns true if name field satisfies our requirements. * * @generated from extension: optional bool is_tenant_login = 80048962; */ @@ -110,7 +110,7 @@ export const is_tenant_login: GenExtension = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 11); /** - * IsTenantSubjectPermission returns true if name field satisfies our requirements + * IsTenantSubjectPermission returns true if name field satisfies our requirements. * * @generated from extension: optional bool is_tenant_subject_permission = 80048963; */ @@ -118,7 +118,7 @@ export const is_tenant_subject_permission: GenExtension = extDesc(file_metalstack_api_v2_predefined_rules, 12); /** - * IsProjectSubjectPermission returns true if name field satisfies our requirements + * IsProjectSubjectPermission returns true if name field satisfies our requirements. * * @generated from extension: optional bool is_project_subject_permission = 80048964; */ @@ -126,7 +126,7 @@ export const is_project_subject_permission: GenExtension = extDesc(file_metalstack_api_v2_predefined_rules, 13); /** - * IsMachineSubjectPermission returns true if name field satisfies our requirements + * IsMachineSubjectPermission returns true if name field satisfies our requirements. * * @generated from extension: optional bool is_machine_subject_permission = 80048965; */ @@ -134,7 +134,7 @@ export const is_machine_subject_permission: GenExtension = extDesc(file_metalstack_api_v2_predefined_rules, 14); /** - * Prefixes validates if a slice of prefixes in string form are valid + * Prefixes validates if a slice of prefixes in string form are valid. * * @generated from extension: optional bool prefixes = 80058951; */ @@ -142,7 +142,7 @@ export const prefixes: GenExtension = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 15); /** - * Ips validates if a slice of ips in string form are valid + * Ips validates if a slice of ips in string form are valid. * * @generated from extension: optional bool ips = 80058952; */ @@ -150,7 +150,7 @@ export const ips: GenExtension = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 16); /** - * AreHostAndPort validates if a slice of strings are all in the form of : + * AreHostAndPort validates if a slice of strings are all in the form of :. * * @generated from extension: optional bool are_host_and_port = 80058953; */ @@ -158,7 +158,7 @@ export const are_host_and_port: GenExtension = /*@__PURE extDesc(file_metalstack_api_v2_predefined_rules, 17); /** - * All Trimmed enforces all strings to be trimmed, e.g. no whitespaces at the begin and end + * All Trimmed enforces all strings to be trimmed, e.g. no whitespaces at the begin and end. * * @generated from extension: optional bool all_trimmed = 80058954; */ @@ -166,7 +166,7 @@ export const all_trimmed: GenExtension = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 18); /** - * Keys and Values trimmed enforces all map keys and values to be trimmed, e.g. no whitespaces at the begin and end + * Keys and Values trimmed enforces all map keys and values to be trimmed, e.g. no whitespaces at the begin and end. * * @generated from extension: optional bool keys_and_values_trimmed = 80068951; */ @@ -174,7 +174,7 @@ export const keys_and_values_trimmed: GenExtension = /*@__PUR extDesc(file_metalstack_api_v2_predefined_rules, 19); /** - * Keys trimmed enforces all map keys and values to be trimmed, e.g. no whitespaces at the begin and end + * Keys trimmed enforces all map keys and values to be trimmed, e.g. no whitespaces at the begin and end. * * @generated from extension: optional bool keys_trimmed = 80068952; */ @@ -182,7 +182,7 @@ export const keys_trimmed: GenExtension = /*@__PURE__*/ extDesc(file_metalstack_api_v2_predefined_rules, 20); /** - * ProjectRolesKeysValid ensures that project roles keys met our requirements + * ProjectRolesKeysValid ensures that project roles keys met our requirements. * * @generated from extension: optional bool project_roles_keys_valid = 80068953; */ @@ -190,7 +190,7 @@ export const project_roles_keys_valid: GenExtension = /*@__PU extDesc(file_metalstack_api_v2_predefined_rules, 21); /** - * TenantRolesKeysValid ensures that tenant roles keys met our requirements + * TenantRolesKeysValid ensures that tenant roles keys met our requirements. * * @generated from extension: optional bool tenant_roles_keys_valid = 80068954; */ @@ -198,7 +198,7 @@ export const tenant_roles_keys_valid: GenExtension = /*@__PUR extDesc(file_metalstack_api_v2_predefined_rules, 22); /** - * MachineRolesKeysValid ensures that machine roles keys met our requirements + * MachineRolesKeysValid ensures that machine roles keys met our requirements. * * @generated from extension: optional bool machine_roles_keys_valid = 80068955; */ diff --git a/js/metalstack/api/v2/project_pb.d.ts b/js/metalstack/api/v2/project_pb.d.ts index 91656379..45f206e8 100644 --- a/js/metalstack/api/v2/project_pb.d.ts +++ b/js/metalstack/api/v2/project_pb.d.ts @@ -7,7 +7,7 @@ import type { Message } from "@bufbuild/protobuf"; */ export declare const file_metalstack_api_v2_project: GenFile; /** - * Project defines a group of resources belonging to a tenant + * Project defines a group of resources belonging to a tenant. * a tenant can have multiple projects * * @generated from message metalstack.api.v2.Project @@ -56,19 +56,19 @@ export type Project = Message<"metalstack.api.v2.Project"> & { */ export declare const ProjectSchema: GenMessage; /** - * ProjectMember defines a user that participates in a project + * ProjectMember defines a user that participates in a project. * * @generated from message metalstack.api.v2.ProjectMember */ export type ProjectMember = Message<"metalstack.api.v2.ProjectMember"> & { /** - * Id is the user id of the member + * Id is the user id of the member. * * @generated from field: string id = 1; */ id: string; /** - * Role is the role of the member + * Role is the role of the member. * * @generated from field: metalstack.api.v2.ProjectRole role = 2; */ @@ -100,49 +100,49 @@ export type ProjectMember = Message<"metalstack.api.v2.ProjectMember"> & { */ export declare const ProjectMemberSchema: GenMessage; /** - * ProjectInvite defines invite to project + * ProjectInvite defines invite to project. * * @generated from message metalstack.api.v2.ProjectInvite */ export type ProjectInvite = Message<"metalstack.api.v2.ProjectInvite"> & { /** - * Secret is the secret part of the invite, typically part of the url + * Secret is the secret part of the invite, typically part of the url. * * @generated from field: string secret = 1; */ secret: string; /** - * Project is the project id for which this invite was created + * Project is the project id for which this invite was created. * * @generated from field: string project = 2; */ project: string; /** - * Role is the role in this project the user will get after accepting the invitation + * Role is the role in this project the user will get after accepting the invitation. * * @generated from field: metalstack.api.v2.ProjectRole role = 3; */ role: ProjectRole; /** - * Joined is false as long as a user has not accepted the invite + * Joined is false as long as a user has not accepted the invite. * * @generated from field: bool joined = 4; */ joined: boolean; /** - * ProjectName is the project name for which this invite was created + * ProjectName is the project name for which this invite was created. * * @generated from field: string project_name = 5; */ projectName: string; /** - * Tenant is the login of the tenant inviting another user to join this project + * Tenant is the login of the tenant inviting another user to join this project. * * @generated from field: string tenant = 6; */ tenant: string; /** - * TenantName is the name of the tenant inviting another user to join this project + * TenantName is the name of the tenant inviting another user to join this project. * * @generated from field: string tenant_name = 7; */ @@ -166,13 +166,13 @@ export type ProjectInvite = Message<"metalstack.api.v2.ProjectInvite"> & { */ export declare const ProjectInviteSchema: GenMessage; /** - * ProjectServiceListRequest is the request payload to list all projects + * ProjectServiceListRequest is the request payload to list all projects. * * @generated from message metalstack.api.v2.ProjectServiceListRequest */ export type ProjectServiceListRequest = Message<"metalstack.api.v2.ProjectServiceListRequest"> & { /** - * Query for projects + * Query for projects. * * @generated from field: metalstack.api.v2.ProjectQuery query = 1; */ @@ -184,31 +184,31 @@ export type ProjectServiceListRequest = Message<"metalstack.api.v2.ProjectServic */ export declare const ProjectServiceListRequestSchema: GenMessage; /** - * ProjectQuery is used to search projects + * ProjectQuery is used to search projects. * * @generated from message metalstack.api.v2.ProjectQuery */ export type ProjectQuery = Message<"metalstack.api.v2.ProjectQuery"> & { /** - * Uuid lists only projects with this uuid + * Uuid lists only projects with this uuid. * * @generated from field: optional string uuid = 1; */ uuid?: string | undefined; /** - * Name lists only projects with this name + * Name lists only projects with this name. * * @generated from field: optional string name = 2; */ name?: string | undefined; /** - * Tenant lists only projects of this tenant + * Tenant lists only projects of this tenant. * * @generated from field: optional string tenant = 3; */ tenant?: string | undefined; /** - * Labels lists only projects containing the given labels + * Labels lists only projects containing the given labels. * * @generated from field: optional metalstack.api.v2.Labels labels = 4; */ @@ -220,13 +220,13 @@ export type ProjectQuery = Message<"metalstack.api.v2.ProjectQuery"> & { */ export declare const ProjectQuerySchema: GenMessage; /** - * ProjectServiceListResponse is the response payload to list all projects + * ProjectServiceListResponse is the response payload to list all projects. * * @generated from message metalstack.api.v2.ProjectServiceListResponse */ export type ProjectServiceListResponse = Message<"metalstack.api.v2.ProjectServiceListResponse"> & { /** - * Projects is a list of all your projects + * Projects is a list of all your projects. * * @generated from field: repeated metalstack.api.v2.Project projects = 1; */ @@ -238,13 +238,13 @@ export type ProjectServiceListResponse = Message<"metalstack.api.v2.ProjectServi */ export declare const ProjectServiceListResponseSchema: GenMessage; /** - * ProjectServiceGetRequest is the request payload to get a project + * ProjectServiceGetRequest is the request payload to get a project. * * @generated from message metalstack.api.v2.ProjectServiceGetRequest */ export type ProjectServiceGetRequest = Message<"metalstack.api.v2.ProjectServiceGetRequest"> & { /** - * Project is the uuid of the project to get + * Project is the uuid of the project to get. * * @generated from field: string project = 1; */ @@ -256,13 +256,13 @@ export type ProjectServiceGetRequest = Message<"metalstack.api.v2.ProjectService */ export declare const ProjectServiceGetRequestSchema: GenMessage; /** - * ProjectServiceGetResponse is the response payload to get a projects + * ProjectServiceGetResponse is the response payload to get a projects. * * @generated from message metalstack.api.v2.ProjectServiceGetResponse */ export type ProjectServiceGetResponse = Message<"metalstack.api.v2.ProjectServiceGetResponse"> & { /** - * Project is the project + * Project is the project. * * @generated from field: metalstack.api.v2.Project project = 1; */ @@ -280,13 +280,13 @@ export type ProjectServiceGetResponse = Message<"metalstack.api.v2.ProjectServic */ export declare const ProjectServiceGetResponseSchema: GenMessage; /** - * ProjectServiceCreateRequest is the request payload to Create a project + * ProjectServiceCreateRequest is the request payload to Create a project. * * @generated from message metalstack.api.v2.ProjectServiceCreateRequest */ export type ProjectServiceCreateRequest = Message<"metalstack.api.v2.ProjectServiceCreateRequest"> & { /** - * Login is the tenant of this project + * Login is the tenant of this project. * TODO: is login really a good name? * * @generated from field: string login = 1; @@ -323,13 +323,13 @@ export type ProjectServiceCreateRequest = Message<"metalstack.api.v2.ProjectServ */ export declare const ProjectServiceCreateRequestSchema: GenMessage; /** - * ProjectServiceCreateResponse is the response payload of creation of a project + * ProjectServiceCreateResponse is the response payload of creation of a project. * * @generated from message metalstack.api.v2.ProjectServiceCreateResponse */ export type ProjectServiceCreateResponse = Message<"metalstack.api.v2.ProjectServiceCreateResponse"> & { /** - * Project is the project + * Project is the project. * * @generated from field: metalstack.api.v2.Project project = 1; */ @@ -341,13 +341,13 @@ export type ProjectServiceCreateResponse = Message<"metalstack.api.v2.ProjectSer */ export declare const ProjectServiceCreateResponseSchema: GenMessage; /** - * ProjectServiceDeleteRequest is the request payload to delete a project + * ProjectServiceDeleteRequest is the request payload to delete a project. * * @generated from message metalstack.api.v2.ProjectServiceDeleteRequest */ export type ProjectServiceDeleteRequest = Message<"metalstack.api.v2.ProjectServiceDeleteRequest"> & { /** - * Project is the uuid of the project to delete + * Project is the uuid of the project to delete. * * @generated from field: string project = 1; */ @@ -359,13 +359,13 @@ export type ProjectServiceDeleteRequest = Message<"metalstack.api.v2.ProjectServ */ export declare const ProjectServiceDeleteRequestSchema: GenMessage; /** - * ProjectServiceDeleteResponse is the response payload to delete a project + * ProjectServiceDeleteResponse is the response payload to delete a project. * * @generated from message metalstack.api.v2.ProjectServiceDeleteResponse */ export type ProjectServiceDeleteResponse = Message<"metalstack.api.v2.ProjectServiceDeleteResponse"> & { /** - * Project is the project + * Project is the project. * * @generated from field: metalstack.api.v2.Project project = 1; */ @@ -377,19 +377,19 @@ export type ProjectServiceDeleteResponse = Message<"metalstack.api.v2.ProjectSer */ export declare const ProjectServiceDeleteResponseSchema: GenMessage; /** - * ProjectServiceUpdateRequest is the request payload to update a project + * ProjectServiceUpdateRequest is the request payload to update a project. * * @generated from message metalstack.api.v2.ProjectServiceUpdateRequest */ export type ProjectServiceUpdateRequest = Message<"metalstack.api.v2.ProjectServiceUpdateRequest"> & { /** - * Project is the uuid of the project to get + * Project is the uuid of the project to get. * * @generated from field: string project = 1; */ project: string; /** - * 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. * * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 2; */ @@ -425,13 +425,13 @@ export type ProjectServiceUpdateRequest = Message<"metalstack.api.v2.ProjectServ */ export declare const ProjectServiceUpdateRequestSchema: GenMessage; /** - * ProjectServiceUpdateResponse is the response payload to update a project + * ProjectServiceUpdateResponse is the response payload to update a project. * * @generated from message metalstack.api.v2.ProjectServiceUpdateResponse */ export type ProjectServiceUpdateResponse = Message<"metalstack.api.v2.ProjectServiceUpdateResponse"> & { /** - * Project is the project + * Project is the project. * * @generated from field: metalstack.api.v2.Project project = 1; */ @@ -443,13 +443,13 @@ export type ProjectServiceUpdateResponse = Message<"metalstack.api.v2.ProjectSer */ export declare const ProjectServiceUpdateResponseSchema: GenMessage; /** - * ProjectServiceInviteRequest is used to invite a member to a project + * ProjectServiceInviteRequest is used to invite a member to a project. * * @generated from message metalstack.api.v2.ProjectServiceInviteRequest */ export type ProjectServiceInviteRequest = Message<"metalstack.api.v2.ProjectServiceInviteRequest"> & { /** - * Project is the uuid of the project + * Project is the uuid of the project. * * @generated from field: string project = 1; */ @@ -467,13 +467,13 @@ export type ProjectServiceInviteRequest = Message<"metalstack.api.v2.ProjectServ */ export declare const ProjectServiceInviteRequestSchema: GenMessage; /** - * ProjectServiceInviteResponse is the response payload to a invite member request + * ProjectServiceInviteResponse is the response payload to a invite member request. * * @generated from message metalstack.api.v2.ProjectServiceInviteResponse */ export type ProjectServiceInviteResponse = Message<"metalstack.api.v2.ProjectServiceInviteResponse"> & { /** - * Inviter contains a secret which can be sent to a potential user + * Inviter contains a secret which can be sent to a potential user. * can be appended to the invitation endpoint at our cloud console like * console.metalstack.cloud/invite/ * @@ -487,13 +487,13 @@ export type ProjectServiceInviteResponse = Message<"metalstack.api.v2.ProjectSer */ export declare const ProjectServiceInviteResponseSchema: GenMessage; /** - * ProjectServiceInvitesListRequest is the request payload to a list invites request + * ProjectServiceInvitesListRequest is the request payload to a list invites request. * * @generated from message metalstack.api.v2.ProjectServiceInvitesListRequest */ export type ProjectServiceInvitesListRequest = Message<"metalstack.api.v2.ProjectServiceInvitesListRequest"> & { /** - * Project is the uuid of the project + * Project is the uuid of the project. * * @generated from field: string project = 1; */ @@ -505,7 +505,7 @@ export type ProjectServiceInvitesListRequest = Message<"metalstack.api.v2.Projec */ export declare const ProjectServiceInvitesListRequestSchema: GenMessage; /** - * ProjectServiceInvitesListResponse is the response payload to a list invites request + * ProjectServiceInvitesListResponse is the response payload to a list invites request. * * @generated from message metalstack.api.v2.ProjectServiceInvitesListResponse */ @@ -523,7 +523,7 @@ export type ProjectServiceInvitesListResponse = Message<"metalstack.api.v2.Proje */ export declare const ProjectServiceInvitesListResponseSchema: GenMessage; /** - * ProjectServiceInviteGetRequest is the request payload to get a invite + * ProjectServiceInviteGetRequest is the request payload to get a invite. * * @generated from message metalstack.api.v2.ProjectServiceInviteGetRequest */ @@ -541,13 +541,13 @@ export type ProjectServiceInviteGetRequest = Message<"metalstack.api.v2.ProjectS */ export declare const ProjectServiceInviteGetRequestSchema: GenMessage; /** - * ProjectServiceInviteGetResponse is the response payload to a get invite request + * ProjectServiceInviteGetResponse is the response payload to a get invite request. * * @generated from message metalstack.api.v2.ProjectServiceInviteGetResponse */ export type ProjectServiceInviteGetResponse = Message<"metalstack.api.v2.ProjectServiceInviteGetResponse"> & { /** - * Invite is the invite + * Invite is the invite. * * @generated from field: metalstack.api.v2.ProjectInvite invite = 1; */ @@ -559,13 +559,13 @@ export type ProjectServiceInviteGetResponse = Message<"metalstack.api.v2.Project */ export declare const ProjectServiceInviteGetResponseSchema: GenMessage; /** - * ProjectServiceLeaveRequest is used to leave a project + * ProjectServiceLeaveRequest is used to leave a project. * * @generated from message metalstack.api.v2.ProjectServiceLeaveRequest */ export type ProjectServiceLeaveRequest = Message<"metalstack.api.v2.ProjectServiceLeaveRequest"> & { /** - * Project is the uuid of the project + * Project is the uuid of the project. * * @generated from field: string project = 1; */ @@ -577,7 +577,7 @@ export type ProjectServiceLeaveRequest = Message<"metalstack.api.v2.ProjectServi */ export declare const ProjectServiceLeaveRequestSchema: GenMessage; /** - * ProjectServiceLeaveResponse is the response payload to a leave project request + * ProjectServiceLeaveResponse is the response payload to a leave project request. * * @generated from message metalstack.api.v2.ProjectServiceLeaveResponse */ @@ -588,13 +588,13 @@ export type ProjectServiceLeaveResponse = Message<"metalstack.api.v2.ProjectServ */ export declare const ProjectServiceLeaveResponseSchema: GenMessage; /** - * ProjectServiceAddMemberRequest is the request payload for adding a member to a project + * ProjectServiceAddMemberRequest is the request payload for adding a member to a project. * * @generated from message metalstack.api.v2.ProjectServiceAddMemberRequest */ export type ProjectServiceAddMemberRequest = Message<"metalstack.api.v2.ProjectServiceAddMemberRequest"> & { /** - * Project is the uuid of the project + * Project is the uuid of the project. * * @generated from field: string project = 1; */ @@ -618,13 +618,13 @@ export type ProjectServiceAddMemberRequest = Message<"metalstack.api.v2.ProjectS */ export declare const ProjectServiceAddMemberRequestSchema: GenMessage; /** - * ProjectServiceAddMemberResponse is the response payload for the add member request + * ProjectServiceAddMemberResponse is the response payload for the add member request. * * @generated from message metalstack.api.v2.ProjectServiceAddMemberResponse */ export type ProjectServiceAddMemberResponse = Message<"metalstack.api.v2.ProjectServiceAddMemberResponse"> & { /** - * ProjectRole is the added project member + * ProjectRole is the added project member. * * @generated from field: metalstack.api.v2.ProjectRole project_member = 1; */ @@ -636,19 +636,19 @@ export type ProjectServiceAddMemberResponse = Message<"metalstack.api.v2.Project */ export declare const ProjectServiceAddMemberResponseSchema: GenMessage; /** - * ProjectServiceRemoveMemberRequest is used to remove a member from a project + * ProjectServiceRemoveMemberRequest is used to remove a member from a project. * * @generated from message metalstack.api.v2.ProjectServiceRemoveMemberRequest */ export type ProjectServiceRemoveMemberRequest = Message<"metalstack.api.v2.ProjectServiceRemoveMemberRequest"> & { /** - * Project is the uuid of the project + * Project is the uuid of the project. * * @generated from field: string project = 1; */ project: string; /** - * Member is the id of the member to remove from this project + * Member is the id of the member to remove from this project. * * @generated from field: string member = 2; */ @@ -660,7 +660,7 @@ export type ProjectServiceRemoveMemberRequest = Message<"metalstack.api.v2.Proje */ export declare const ProjectServiceRemoveMemberRequestSchema: GenMessage; /** - * ProjectServiceRemoveMemberResponse is the response payload to a remove member request + * ProjectServiceRemoveMemberResponse is the response payload to a remove member request. * * @generated from message metalstack.api.v2.ProjectServiceRemoveMemberResponse */ @@ -671,25 +671,25 @@ export type ProjectServiceRemoveMemberResponse = Message<"metalstack.api.v2.Proj */ export declare const ProjectServiceRemoveMemberResponseSchema: GenMessage; /** - * ProjectServiceUpdateMemberRequest is used to update a member of a project + * ProjectServiceUpdateMemberRequest is used to update a member of a project. * * @generated from message metalstack.api.v2.ProjectServiceUpdateMemberRequest */ export type ProjectServiceUpdateMemberRequest = Message<"metalstack.api.v2.ProjectServiceUpdateMemberRequest"> & { /** - * Project is the uuid of the project + * Project is the uuid of the project. * * @generated from field: string project = 1; */ project: string; /** - * Member is the id of the member to remove from this project + * Member is the id of the member to remove from this project. * * @generated from field: string member = 2; */ member: string; /** - * Role is the role in this project the user will get after the update + * Role is the role in this project the user will get after the update. * * @generated from field: metalstack.api.v2.ProjectRole role = 3; */ @@ -701,13 +701,13 @@ export type ProjectServiceUpdateMemberRequest = Message<"metalstack.api.v2.Proje */ export declare const ProjectServiceUpdateMemberRequestSchema: GenMessage; /** - * ProjectServiceUpdateMemberResponse is the response payload to a update member request + * ProjectServiceUpdateMemberResponse is the response payload to a update member request. * * @generated from message metalstack.api.v2.ProjectServiceUpdateMemberResponse */ export type ProjectServiceUpdateMemberResponse = Message<"metalstack.api.v2.ProjectServiceUpdateMemberResponse"> & { /** - * ProjectMember is the updated project member + * ProjectMember is the updated project member. * * @generated from field: metalstack.api.v2.ProjectMember project_member = 1; */ @@ -719,13 +719,13 @@ export type ProjectServiceUpdateMemberResponse = Message<"metalstack.api.v2.Proj */ export declare const ProjectServiceUpdateMemberResponseSchema: GenMessage; /** - * ProjectServiceInviteAcceptRequest is the request payload to a accept invite request + * ProjectServiceInviteAcceptRequest is the request payload to a accept invite request. * * @generated from message metalstack.api.v2.ProjectServiceInviteAcceptRequest */ export type ProjectServiceInviteAcceptRequest = Message<"metalstack.api.v2.ProjectServiceInviteAcceptRequest"> & { /** - * Secret is the invitation secret part of the invitation url + * Secret is the invitation secret part of the invitation url. * * @generated from field: string secret = 1; */ @@ -737,7 +737,7 @@ export type ProjectServiceInviteAcceptRequest = Message<"metalstack.api.v2.Proje */ export declare const ProjectServiceInviteAcceptRequestSchema: GenMessage; /** - * ProjectServiceInviteAcceptResponse is the response payload to a accept invite request + * ProjectServiceInviteAcceptResponse is the response payload to a accept invite request. * * @generated from message metalstack.api.v2.ProjectServiceInviteAcceptResponse */ @@ -761,13 +761,13 @@ export type ProjectServiceInviteAcceptResponse = Message<"metalstack.api.v2.Proj */ export declare const ProjectServiceInviteAcceptResponseSchema: GenMessage; /** - * ProjectServiceInviteDeleteRequest is the request payload to a delete invite + * ProjectServiceInviteDeleteRequest is the request payload to a delete invite. * * @generated from message metalstack.api.v2.ProjectServiceInviteDeleteRequest */ export type ProjectServiceInviteDeleteRequest = Message<"metalstack.api.v2.ProjectServiceInviteDeleteRequest"> & { /** - * Project is the uuid of the project + * Project is the uuid of the project. * * @generated from field: string project = 1; */ @@ -785,7 +785,7 @@ export type ProjectServiceInviteDeleteRequest = Message<"metalstack.api.v2.Proje */ export declare const ProjectServiceInviteDeleteRequestSchema: GenMessage; /** - * ProjectServiceInviteDeleteResponse is the response payload of a delete invite request + * ProjectServiceInviteDeleteResponse is the response payload of a delete invite request. * * @generated from message metalstack.api.v2.ProjectServiceInviteDeleteResponse */ @@ -822,7 +822,7 @@ export declare const ProjectService: GenService<{ output: typeof ProjectServiceGetResponseSchema; }; /** - * Create a project + * Create a project. * * @generated from rpc metalstack.api.v2.ProjectService.Create */ @@ -832,7 +832,7 @@ export declare const ProjectService: GenService<{ output: typeof ProjectServiceCreateResponseSchema; }; /** - * Delete a project + * Delete a project. * * @generated from rpc metalstack.api.v2.ProjectService.Delete */ @@ -842,7 +842,7 @@ export declare const ProjectService: GenService<{ output: typeof ProjectServiceDeleteResponseSchema; }; /** - * Update a project + * Update a project. * * @generated from rpc metalstack.api.v2.ProjectService.Update */ @@ -852,7 +852,7 @@ export declare const ProjectService: GenService<{ output: typeof ProjectServiceUpdateResponseSchema; }; /** - * Leave project + * Leave project. * * @generated from rpc metalstack.api.v2.ProjectService.Leave */ @@ -862,7 +862,7 @@ export declare const ProjectService: GenService<{ output: typeof ProjectServiceLeaveResponseSchema; }; /** - * AddMember adds a user to a project + * AddMember adds a user to a project. * * @generated from rpc metalstack.api.v2.ProjectService.AddMember */ @@ -872,7 +872,7 @@ export declare const ProjectService: GenService<{ output: typeof ProjectServiceAddMemberResponseSchema; }; /** - * RemoveMember removes a user from a project + * RemoveMember removes a user from a project. * * @generated from rpc metalstack.api.v2.ProjectService.RemoveMember */ @@ -882,7 +882,7 @@ export declare const ProjectService: GenService<{ output: typeof ProjectServiceRemoveMemberResponseSchema; }; /** - * UpdateMember updates a user for a project + * UpdateMember updates a user for a project. * * @generated from rpc metalstack.api.v2.ProjectService.UpdateMember */ @@ -892,7 +892,7 @@ export declare const ProjectService: GenService<{ output: typeof ProjectServiceUpdateMemberResponseSchema; }; /** - * Invite a user to a project + * Invite a user to a project. * * @generated from rpc metalstack.api.v2.ProjectService.Invite */ @@ -902,7 +902,7 @@ export declare const ProjectService: GenService<{ output: typeof ProjectServiceInviteResponseSchema; }; /** - * InviteAccept is called by a user to accept an invitation + * InviteAccept is called by a user to accept an invitation. * * @generated from rpc metalstack.api.v2.ProjectService.InviteAccept */ @@ -912,7 +912,7 @@ export declare const ProjectService: GenService<{ output: typeof ProjectServiceInviteAcceptResponseSchema; }; /** - * InviteDelete deletes a pending invitation + * InviteDelete deletes a pending invitation. * * @generated from rpc metalstack.api.v2.ProjectService.InviteDelete */ @@ -922,7 +922,7 @@ export declare const ProjectService: GenService<{ output: typeof ProjectServiceInviteDeleteResponseSchema; }; /** - * InvitesList list all invites to a project + * InvitesList list all invites to a project. * * @generated from rpc metalstack.api.v2.ProjectService.InvitesList */ diff --git a/js/metalstack/api/v2/project_pb.ts b/js/metalstack/api/v2/project_pb.ts index 4ce74626..0d07008d 100644 --- a/js/metalstack/api/v2/project_pb.ts +++ b/js/metalstack/api/v2/project_pb.ts @@ -19,7 +19,7 @@ export const file_metalstack_api_v2_project: GenFile = /*@__PURE__*/ fileDesc("Ch9tZXRhbHN0YWNrL2FwaS92Mi9wcm9qZWN0LnByb3RvEhFtZXRhbHN0YWNrLmFwaS52MiLAAQoHUHJvamVjdBIMCgR1dWlkGAEgASgJEiUKBG1ldGEYAiABKAsyFy5tZXRhbHN0YWNrLmFwaS52Mi5NZXRhEhkKBG5hbWUYAyABKAlCC7pICHIGwLOusQIBEiAKC2Rlc2NyaXB0aW9uGAQgASgJQgu6SAhyBsizrrECARIOCgZ0ZW5hbnQYBSABKAkSJAoKYXZhdGFyX3VybBgGIAEoCUILukgIcgbgs66xAgFIAIgBAUINCgtfYXZhdGFyX3VybCLIAQoNUHJvamVjdE1lbWJlchIKCgJpZBgBIAEoCRI2CgRyb2xlGAIgASgOMh4ubWV0YWxzdGFjay5hcGkudjIuUHJvamVjdFJvbGVCCLpIBYIBAhABEhwKFGluaGVyaXRlZF9tZW1iZXJzaGlwGAMgASgIEi4KCmNyZWF0ZWRfYXQYBCABKAsyGi5nb29nbGUucHJvdG9idWYuVGltZXN0YW1wEiUKBG1ldGEYBSABKAsyFy5tZXRhbHN0YWNrLmFwaS52Mi5NZXRhIpICCg1Qcm9qZWN0SW52aXRlEg4KBnNlY3JldBgBIAEoCRIPCgdwcm9qZWN0GAIgASgJEjYKBHJvbGUYAyABKA4yHi5tZXRhbHN0YWNrLmFwaS52Mi5Qcm9qZWN0Um9sZUIIukgFggECEAESDgoGam9pbmVkGAQgASgIEhQKDHByb2plY3RfbmFtZRgFIAEoCRIOCgZ0ZW5hbnQYBiABKAkSEwoLdGVuYW50X25hbWUYByABKAkSLgoKZXhwaXJlc19hdBgIIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5UaW1lc3RhbXASLQoJam9pbmVkX2F0GAkgASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcCJLChlQcm9qZWN0U2VydmljZUxpc3RSZXF1ZXN0Ei4KBXF1ZXJ5GAEgASgLMh8ubWV0YWxzdGFjay5hcGkudjIuUHJvamVjdFF1ZXJ5IsUBCgxQcm9qZWN0UXVlcnkSGwoEdXVpZBgBIAEoCUIIukgFcgOwAQFIAIgBARIeCgRuYW1lGAIgASgJQgu6SAhyBsCzrrECAUgBiAEBEiAKBnRlbmFudBgDIAEoCUILukgIcgaQtK6xAgFIAogBARIuCgZsYWJlbHMYBCABKAsyGS5tZXRhbHN0YWNrLmFwaS52Mi5MYWJlbHNIA4gBAUIHCgVfdXVpZEIHCgVfbmFtZUIJCgdfdGVuYW50QgkKB19sYWJlbHMiSgoaUHJvamVjdFNlcnZpY2VMaXN0UmVzcG9uc2USLAoIcHJvamVjdHMYASADKAsyGi5tZXRhbHN0YWNrLmFwaS52Mi5Qcm9qZWN0IjUKGFByb2plY3RTZXJ2aWNlR2V0UmVxdWVzdBIZCgdwcm9qZWN0GAEgASgJQgi6SAVyA7ABASKDAQoZUHJvamVjdFNlcnZpY2VHZXRSZXNwb25zZRIrCgdwcm9qZWN0GAEgASgLMhoubWV0YWxzdGFjay5hcGkudjIuUHJvamVjdBI5Cg9wcm9qZWN0X21lbWJlcnMYAiADKAsyIC5tZXRhbHN0YWNrLmFwaS52Mi5Qcm9qZWN0TWVtYmVyItYBChtQcm9qZWN0U2VydmljZUNyZWF0ZVJlcXVlc3QSGgoFbG9naW4YASABKAlCC7pICHIGwLOusQIBEhkKBG5hbWUYAiABKAlCC7pICHIGwLOusQIBEiAKC2Rlc2NyaXB0aW9uGAMgASgJQgu6SAhyBsizrrECARIkCgphdmF0YXJfdXJsGAQgASgJQgu6SAhyBuCzrrECAUgAiAEBEikKBmxhYmVscxgFIAEoCzIZLm1ldGFsc3RhY2suYXBpLnYyLkxhYmVsc0INCgtfYXZhdGFyX3VybCJLChxQcm9qZWN0U2VydmljZUNyZWF0ZVJlc3BvbnNlEisKB3Byb2plY3QYASABKAsyGi5tZXRhbHN0YWNrLmFwaS52Mi5Qcm9qZWN0IjgKG1Byb2plY3RTZXJ2aWNlRGVsZXRlUmVxdWVzdBIZCgdwcm9qZWN0GAEgASgJQgi6SAVyA7ABASJLChxQcm9qZWN0U2VydmljZURlbGV0ZVJlc3BvbnNlEisKB3Byb2plY3QYASABKAsyGi5tZXRhbHN0YWNrLmFwaS52Mi5Qcm9qZWN0IsoCChtQcm9qZWN0U2VydmljZVVwZGF0ZVJlcXVlc3QSGQoHcHJvamVjdBgBIAEoCUIIukgFcgOwAQESOgoLdXBkYXRlX21ldGEYAiABKAsyHS5tZXRhbHN0YWNrLmFwaS52Mi5VcGRhdGVNZXRhQga6SAPIAQESHgoEbmFtZRgDIAEoCUILukgIcgbAs66xAgFIAIgBARIlCgtkZXNjcmlwdGlvbhgEIAEoCUILukgIcgbIs66xAgFIAYgBARIkCgphdmF0YXJfdXJsGAUgASgJQgu6SAhyBuCzrrECAUgCiAEBEjQKBmxhYmVscxgGIAEoCzIfLm1ldGFsc3RhY2suYXBpLnYyLlVwZGF0ZUxhYmVsc0gDiAEBQgcKBV9uYW1lQg4KDF9kZXNjcmlwdGlvbkINCgtfYXZhdGFyX3VybEIJCgdfbGFiZWxzIksKHFByb2plY3RTZXJ2aWNlVXBkYXRlUmVzcG9uc2USKwoHcHJvamVjdBgBIAEoCzIaLm1ldGFsc3RhY2suYXBpLnYyLlByb2plY3QicAobUHJvamVjdFNlcnZpY2VJbnZpdGVSZXF1ZXN0EhkKB3Byb2plY3QYASABKAlCCLpIBXIDsAEBEjYKBHJvbGUYAiABKA4yHi5tZXRhbHN0YWNrLmFwaS52Mi5Qcm9qZWN0Um9sZUIIukgFggECEAEiUAocUHJvamVjdFNlcnZpY2VJbnZpdGVSZXNwb25zZRIwCgZpbnZpdGUYASABKAsyIC5tZXRhbHN0YWNrLmFwaS52Mi5Qcm9qZWN0SW52aXRlIj0KIFByb2plY3RTZXJ2aWNlSW52aXRlc0xpc3RSZXF1ZXN0EhkKB3Byb2plY3QYASABKAlCCLpIBXIDsAEBIlYKIVByb2plY3RTZXJ2aWNlSW52aXRlc0xpc3RSZXNwb25zZRIxCgdpbnZpdGVzGAEgAygLMiAubWV0YWxzdGFjay5hcGkudjIuUHJvamVjdEludml0ZSIwCh5Qcm9qZWN0U2VydmljZUludml0ZUdldFJlcXVlc3QSDgoGc2VjcmV0GAEgASgJIlMKH1Byb2plY3RTZXJ2aWNlSW52aXRlR2V0UmVzcG9uc2USMAoGaW52aXRlGAEgASgLMiAubWV0YWxzdGFjay5hcGkudjIuUHJvamVjdEludml0ZSI3ChpQcm9qZWN0U2VydmljZUxlYXZlUmVxdWVzdBIZCgdwcm9qZWN0GAEgASgJQgi6SAVyA7ABASIdChtQcm9qZWN0U2VydmljZUxlYXZlUmVzcG9uc2UikAEKHlByb2plY3RTZXJ2aWNlQWRkTWVtYmVyUmVxdWVzdBIZCgdwcm9qZWN0GAEgASgJQgi6SAVyA7ABARIbCgZtZW1iZXIYAiABKAlCC7pICHIGkLSusQIBEjYKBHJvbGUYAyABKA4yHi5tZXRhbHN0YWNrLmFwaS52Mi5Qcm9qZWN0Um9sZUIIukgFggECEAEiWQofUHJvamVjdFNlcnZpY2VBZGRNZW1iZXJSZXNwb25zZRI2Cg5wcm9qZWN0X21lbWJlchgBIAEoDjIeLm1ldGFsc3RhY2suYXBpLnYyLlByb2plY3RSb2xlIk4KIVByb2plY3RTZXJ2aWNlUmVtb3ZlTWVtYmVyUmVxdWVzdBIZCgdwcm9qZWN0GAEgASgJQgi6SAVyA7ABARIOCgZtZW1iZXIYAiABKAkiJAoiUHJvamVjdFNlcnZpY2VSZW1vdmVNZW1iZXJSZXNwb25zZSKGAQohUHJvamVjdFNlcnZpY2VVcGRhdGVNZW1iZXJSZXF1ZXN0EhkKB3Byb2plY3QYASABKAlCCLpIBXIDsAEBEg4KBm1lbWJlchgCIAEoCRI2CgRyb2xlGAMgASgOMh4ubWV0YWxzdGFjay5hcGkudjIuUHJvamVjdFJvbGVCCLpIBYIBAhABIl4KIlByb2plY3RTZXJ2aWNlVXBkYXRlTWVtYmVyUmVzcG9uc2USOAoOcHJvamVjdF9tZW1iZXIYASABKAsyIC5tZXRhbHN0YWNrLmFwaS52Mi5Qcm9qZWN0TWVtYmVyIjMKIVByb2plY3RTZXJ2aWNlSW52aXRlQWNjZXB0UmVxdWVzdBIOCgZzZWNyZXQYASABKAkiSwoiUHJvamVjdFNlcnZpY2VJbnZpdGVBY2NlcHRSZXNwb25zZRIPCgdwcm9qZWN0GAEgASgJEhQKDHByb2plY3RfbmFtZRgCIAEoCSJOCiFQcm9qZWN0U2VydmljZUludml0ZURlbGV0ZVJlcXVlc3QSGQoHcHJvamVjdBgBIAEoCUIIukgFcgOwAQESDgoGc2VjcmV0GAIgASgJIiQKIlByb2plY3RTZXJ2aWNlSW52aXRlRGVsZXRlUmVzcG9uc2Uy4Q0KDlByb2plY3RTZXJ2aWNlEm0KBExpc3QSLC5tZXRhbHN0YWNrLmFwaS52Mi5Qcm9qZWN0U2VydmljZUxpc3RSZXF1ZXN0Gi0ubWV0YWxzdGFjay5hcGkudjIuUHJvamVjdFNlcnZpY2VMaXN0UmVzcG9uc2UiCNjzGALg8xgCEm0KA0dldBIrLm1ldGFsc3RhY2suYXBpLnYyLlByb2plY3RTZXJ2aWNlR2V0UmVxdWVzdBosLm1ldGFsc3RhY2suYXBpLnYyLlByb2plY3RTZXJ2aWNlR2V0UmVzcG9uc2UiC8rzGAMBAgPg8xgCEnUKBkNyZWF0ZRIuLm1ldGFsc3RhY2suYXBpLnYyLlByb2plY3RTZXJ2aWNlQ3JlYXRlUmVxdWVzdBovLm1ldGFsc3RhY2suYXBpLnYyLlByb2plY3RTZXJ2aWNlQ3JlYXRlUmVzcG9uc2UiCsLzGAIBAuDzGAESdAoGRGVsZXRlEi4ubWV0YWxzdGFjay5hcGkudjIuUHJvamVjdFNlcnZpY2VEZWxldGVSZXF1ZXN0Gi8ubWV0YWxzdGFjay5hcGkudjIuUHJvamVjdFNlcnZpY2VEZWxldGVSZXNwb25zZSIJyvMYAQHg8xgBEnUKBlVwZGF0ZRIuLm1ldGFsc3RhY2suYXBpLnYyLlByb2plY3RTZXJ2aWNlVXBkYXRlUmVxdWVzdBovLm1ldGFsc3RhY2suYXBpLnYyLlByb2plY3RTZXJ2aWNlVXBkYXRlUmVzcG9uc2UiCsrzGAIBAuDzGAEScQoFTGVhdmUSLS5tZXRhbHN0YWNrLmFwaS52Mi5Qcm9qZWN0U2VydmljZUxlYXZlUmVxdWVzdBouLm1ldGFsc3RhY2suYXBpLnYyLlByb2plY3RTZXJ2aWNlTGVhdmVSZXNwb25zZSIJyvMYAQPg8xgBEn0KCUFkZE1lbWJlchIxLm1ldGFsc3RhY2suYXBpLnYyLlByb2plY3RTZXJ2aWNlQWRkTWVtYmVyUmVxdWVzdBoyLm1ldGFsc3RhY2suYXBpLnYyLlByb2plY3RTZXJ2aWNlQWRkTWVtYmVyUmVzcG9uc2UiCcrzGAEB4PMYARKGAQoMUmVtb3ZlTWVtYmVyEjQubWV0YWxzdGFjay5hcGkudjIuUHJvamVjdFNlcnZpY2VSZW1vdmVNZW1iZXJSZXF1ZXN0GjUubWV0YWxzdGFjay5hcGkudjIuUHJvamVjdFNlcnZpY2VSZW1vdmVNZW1iZXJSZXNwb25zZSIJyvMYAQHg8xgBEoYBCgxVcGRhdGVNZW1iZXISNC5tZXRhbHN0YWNrLmFwaS52Mi5Qcm9qZWN0U2VydmljZVVwZGF0ZU1lbWJlclJlcXVlc3QaNS5tZXRhbHN0YWNrLmFwaS52Mi5Qcm9qZWN0U2VydmljZVVwZGF0ZU1lbWJlclJlc3BvbnNlIgnK8xgBAeDzGAESdAoGSW52aXRlEi4ubWV0YWxzdGFjay5hcGkudjIuUHJvamVjdFNlcnZpY2VJbnZpdGVSZXF1ZXN0Gi8ubWV0YWxzdGFjay5hcGkudjIuUHJvamVjdFNlcnZpY2VJbnZpdGVSZXNwb25zZSIJyvMYAQHg8xgBEoUBCgxJbnZpdGVBY2NlcHQSNC5tZXRhbHN0YWNrLmFwaS52Mi5Qcm9qZWN0U2VydmljZUludml0ZUFjY2VwdFJlcXVlc3QaNS5tZXRhbHN0YWNrLmFwaS52Mi5Qcm9qZWN0U2VydmljZUludml0ZUFjY2VwdFJlc3BvbnNlIgjY8xgC4PMYARKGAQoMSW52aXRlRGVsZXRlEjQubWV0YWxzdGFjay5hcGkudjIuUHJvamVjdFNlcnZpY2VJbnZpdGVEZWxldGVSZXF1ZXN0GjUubWV0YWxzdGFjay5hcGkudjIuUHJvamVjdFNlcnZpY2VJbnZpdGVEZWxldGVSZXNwb25zZSIJyvMYAQHg8xgBEoMBCgtJbnZpdGVzTGlzdBIzLm1ldGFsc3RhY2suYXBpLnYyLlByb2plY3RTZXJ2aWNlSW52aXRlc0xpc3RSZXF1ZXN0GjQubWV0YWxzdGFjay5hcGkudjIuUHJvamVjdFNlcnZpY2VJbnZpdGVzTGlzdFJlc3BvbnNlIgnK8xgBAeDzGAISfAoJSW52aXRlR2V0EjEubWV0YWxzdGFjay5hcGkudjIuUHJvamVjdFNlcnZpY2VJbnZpdGVHZXRSZXF1ZXN0GjIubWV0YWxzdGFjay5hcGkudjIuUHJvamVjdFNlcnZpY2VJbnZpdGVHZXRSZXNwb25zZSII2PMYAuDzGAJCwgEKFWNvbS5tZXRhbHN0YWNrLmFwaS52MkIMUHJvamVjdFByb3RvUAFaNWdpdGh1Yi5jb20vbWV0YWwtc3RhY2svYXBpL2dvL21ldGFsc3RhY2svYXBpL3YyO2FwaXYyogIDTUFYqgIRTWV0YWxzdGFjay5BcGkuVjLKAhFNZXRhbHN0YWNrXEFwaVxWMuICHU1ldGFsc3RhY2tcQXBpXFYyXEdQQk1ldGFkYXRh6gITTWV0YWxzdGFjazo6QXBpOjpWMmIGcHJvdG8z", [file_buf_validate_validate, file_google_protobuf_timestamp, file_metalstack_api_v2_common, file_metalstack_api_v2_predefined_rules]); /** - * Project defines a group of resources belonging to a tenant + * Project defines a group of resources belonging to a tenant. * a tenant can have multiple projects * * @generated from message metalstack.api.v2.Project @@ -76,20 +76,20 @@ export const ProjectSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_project, 0); /** - * ProjectMember defines a user that participates in a project + * ProjectMember defines a user that participates in a project. * * @generated from message metalstack.api.v2.ProjectMember */ export type ProjectMember = Message<"metalstack.api.v2.ProjectMember"> & { /** - * Id is the user id of the member + * Id is the user id of the member. * * @generated from field: string id = 1; */ id: string; /** - * Role is the role of the member + * Role is the role of the member. * * @generated from field: metalstack.api.v2.ProjectRole role = 2; */ @@ -127,55 +127,55 @@ export const ProjectMemberSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_project, 1); /** - * ProjectInvite defines invite to project + * ProjectInvite defines invite to project. * * @generated from message metalstack.api.v2.ProjectInvite */ export type ProjectInvite = Message<"metalstack.api.v2.ProjectInvite"> & { /** - * Secret is the secret part of the invite, typically part of the url + * Secret is the secret part of the invite, typically part of the url. * * @generated from field: string secret = 1; */ secret: string; /** - * Project is the project id for which this invite was created + * Project is the project id for which this invite was created. * * @generated from field: string project = 2; */ project: string; /** - * Role is the role in this project the user will get after accepting the invitation + * Role is the role in this project the user will get after accepting the invitation. * * @generated from field: metalstack.api.v2.ProjectRole role = 3; */ role: ProjectRole; /** - * Joined is false as long as a user has not accepted the invite + * Joined is false as long as a user has not accepted the invite. * * @generated from field: bool joined = 4; */ joined: boolean; /** - * ProjectName is the project name for which this invite was created + * ProjectName is the project name for which this invite was created. * * @generated from field: string project_name = 5; */ projectName: string; /** - * Tenant is the login of the tenant inviting another user to join this project + * Tenant is the login of the tenant inviting another user to join this project. * * @generated from field: string tenant = 6; */ tenant: string; /** - * TenantName is the name of the tenant inviting another user to join this project + * TenantName is the name of the tenant inviting another user to join this project. * * @generated from field: string tenant_name = 7; */ @@ -204,13 +204,13 @@ export const ProjectInviteSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_project, 2); /** - * ProjectServiceListRequest is the request payload to list all projects + * ProjectServiceListRequest is the request payload to list all projects. * * @generated from message metalstack.api.v2.ProjectServiceListRequest */ export type ProjectServiceListRequest = Message<"metalstack.api.v2.ProjectServiceListRequest"> & { /** - * Query for projects + * Query for projects. * * @generated from field: metalstack.api.v2.ProjectQuery query = 1; */ @@ -225,34 +225,34 @@ export const ProjectServiceListRequestSchema: GenMessage & { /** - * Uuid lists only projects with this uuid + * Uuid lists only projects with this uuid. * * @generated from field: optional string uuid = 1; */ uuid?: string | undefined; /** - * Name lists only projects with this name + * Name lists only projects with this name. * * @generated from field: optional string name = 2; */ name?: string | undefined; /** - * Tenant lists only projects of this tenant + * Tenant lists only projects of this tenant. * * @generated from field: optional string tenant = 3; */ tenant?: string | undefined; /** - * Labels lists only projects containing the given labels + * Labels lists only projects containing the given labels. * * @generated from field: optional metalstack.api.v2.Labels labels = 4; */ @@ -267,13 +267,13 @@ export const ProjectQuerySchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_project, 4); /** - * ProjectServiceListResponse is the response payload to list all projects + * ProjectServiceListResponse is the response payload to list all projects. * * @generated from message metalstack.api.v2.ProjectServiceListResponse */ export type ProjectServiceListResponse = Message<"metalstack.api.v2.ProjectServiceListResponse"> & { /** - * Projects is a list of all your projects + * Projects is a list of all your projects. * * @generated from field: repeated metalstack.api.v2.Project projects = 1; */ @@ -288,13 +288,13 @@ export const ProjectServiceListResponseSchema: GenMessage & { /** - * Project is the uuid of the project to get + * Project is the uuid of the project to get. * * @generated from field: string project = 1; */ @@ -309,13 +309,13 @@ export const ProjectServiceGetRequestSchema: GenMessage & { /** - * Project is the project + * Project is the project. * * @generated from field: metalstack.api.v2.Project project = 1; */ @@ -337,13 +337,13 @@ export const ProjectServiceGetResponseSchema: GenMessage & { /** - * Login is the tenant of this project + * Login is the tenant of this project. * TODO: is login really a good name? * * @generated from field: string login = 1; @@ -387,13 +387,13 @@ export const ProjectServiceCreateRequestSchema: GenMessage & { /** - * Project is the project + * Project is the project. * * @generated from field: metalstack.api.v2.Project project = 1; */ @@ -408,13 +408,13 @@ export const ProjectServiceCreateResponseSchema: GenMessage & { /** - * Project is the uuid of the project to delete + * Project is the uuid of the project to delete. * * @generated from field: string project = 1; */ @@ -429,13 +429,13 @@ export const ProjectServiceDeleteRequestSchema: GenMessage & { /** - * Project is the project + * Project is the project. * * @generated from field: metalstack.api.v2.Project project = 1; */ @@ -450,20 +450,20 @@ export const ProjectServiceDeleteResponseSchema: GenMessage & { /** - * Project is the uuid of the project to get + * Project is the uuid of the project to get. * * @generated from field: string project = 1; */ project: string; /** - * 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. * * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 2; */ @@ -506,13 +506,13 @@ export const ProjectServiceUpdateRequestSchema: GenMessage & { /** - * Project is the project + * Project is the project. * * @generated from field: metalstack.api.v2.Project project = 1; */ @@ -527,13 +527,13 @@ export const ProjectServiceUpdateResponseSchema: GenMessage & { /** - * Project is the uuid of the project + * Project is the uuid of the project. * * @generated from field: string project = 1; */ @@ -555,13 +555,13 @@ export const ProjectServiceInviteRequestSchema: GenMessage & { /** - * Inviter contains a secret which can be sent to a potential user + * Inviter contains a secret which can be sent to a potential user. * can be appended to the invitation endpoint at our cloud console like * console.metalstack.cloud/invite/ * @@ -578,13 +578,13 @@ export const ProjectServiceInviteResponseSchema: GenMessage & { /** - * Project is the uuid of the project + * Project is the uuid of the project. * * @generated from field: string project = 1; */ @@ -599,7 +599,7 @@ export const ProjectServiceInvitesListRequestSchema: GenMessage & { /** - * Invite is the invite + * Invite is the invite. * * @generated from field: metalstack.api.v2.ProjectInvite invite = 1; */ @@ -662,13 +662,13 @@ export const ProjectServiceInviteGetResponseSchema: GenMessage & { /** - * Project is the uuid of the project + * Project is the uuid of the project. * * @generated from field: string project = 1; */ @@ -683,7 +683,7 @@ export const ProjectServiceLeaveRequestSchema: GenMessage & { /** - * Project is the uuid of the project + * Project is the uuid of the project. * * @generated from field: string project = 1; */ @@ -733,13 +733,13 @@ export const ProjectServiceAddMemberRequestSchema: GenMessage & { /** - * ProjectRole is the added project member + * ProjectRole is the added project member. * * @generated from field: metalstack.api.v2.ProjectRole project_member = 1; */ @@ -754,20 +754,20 @@ export const ProjectServiceAddMemberResponseSchema: GenMessage & { /** - * Project is the uuid of the project + * Project is the uuid of the project. * * @generated from field: string project = 1; */ project: string; /** - * Member is the id of the member to remove from this project + * Member is the id of the member to remove from this project. * * @generated from field: string member = 2; */ @@ -782,7 +782,7 @@ export const ProjectServiceRemoveMemberRequestSchema: GenMessage & { /** - * Project is the uuid of the project + * Project is the uuid of the project. * * @generated from field: string project = 1; */ project: string; /** - * Member is the id of the member to remove from this project + * Member is the id of the member to remove from this project. * * @generated from field: string member = 2; */ member: string; /** - * Role is the role in this project the user will get after the update + * Role is the role in this project the user will get after the update. * * @generated from field: metalstack.api.v2.ProjectRole role = 3; */ @@ -832,13 +832,13 @@ export const ProjectServiceUpdateMemberRequestSchema: GenMessage & { /** - * ProjectMember is the updated project member + * ProjectMember is the updated project member. * * @generated from field: metalstack.api.v2.ProjectMember project_member = 1; */ @@ -853,13 +853,13 @@ export const ProjectServiceUpdateMemberResponseSchema: GenMessage & { /** - * Secret is the invitation secret part of the invitation url + * Secret is the invitation secret part of the invitation url. * * @generated from field: string secret = 1; */ @@ -874,7 +874,7 @@ export const ProjectServiceInviteAcceptRequestSchema: GenMessage & { /** - * Project is the uuid of the project + * Project is the uuid of the project. * * @generated from field: string project = 1; */ @@ -930,7 +930,7 @@ export const ProjectServiceInviteDeleteRequestSchema: GenMessage; /** - * SizeImageConstraintServiceTryResponse is the response payload for a size image constraint try request + * SizeImageConstraintServiceTryResponse is the response payload for a size image constraint try request. * * @generated from message metalstack.api.v2.SizeImageConstraintServiceTryResponse */ @@ -41,7 +41,7 @@ export type SizeImageConstraintServiceTryResponse = Message<"metalstack.api.v2.S */ export declare const SizeImageConstraintServiceTryResponseSchema: GenMessage; /** - * SizeImageConstraint expresses optional restrictions for specific size to image combinations + * SizeImageConstraint expresses optional restrictions for specific size to image combinations. * this might be required if the support for a specific hardware in a given size is only supported * with a newer version of the image. * @@ -53,7 +53,7 @@ export declare const SizeImageConstraintServiceTryResponseSchema: GenMessage & { /** - * Size where this constraint should apply + * Size where this constraint should apply. * * @generated from field: string size = 1; */ @@ -89,7 +89,7 @@ export type SizeImageConstraint = Message<"metalstack.api.v2.SizeImageConstraint */ export declare const SizeImageConstraintSchema: GenMessage; /** - * ImageConstraint defines a constraint for an image + * ImageConstraint defines a constraint for an image. * examples: * images: * ubuntu: ">= 20.04.20211011" @@ -117,7 +117,7 @@ export type ImageConstraint = Message<"metalstack.api.v2.ImageConstraint"> & { */ export declare const ImageConstraintSchema: GenMessage; /** - * SizeImageConstraintQuery is used to search size image constraints + * SizeImageConstraintQuery is used to search size image constraints. * * @generated from message metalstack.api.v2.SizeImageConstraintQuery */ diff --git a/js/metalstack/api/v2/size_imageconstraint_pb.ts b/js/metalstack/api/v2/size_imageconstraint_pb.ts index cb22ab9b..6240ca0c 100644 --- a/js/metalstack/api/v2/size_imageconstraint_pb.ts +++ b/js/metalstack/api/v2/size_imageconstraint_pb.ts @@ -17,7 +17,7 @@ export const file_metalstack_api_v2_size_imageconstraint: GenFile = /*@__PURE__* fileDesc("CixtZXRhbHN0YWNrL2FwaS92Mi9zaXplX2ltYWdlY29uc3RyYWludC5wcm90bxIRbWV0YWxzdGFjay5hcGkudjIiXQokU2l6ZUltYWdlQ29uc3RyYWludFNlcnZpY2VUcnlSZXF1ZXN0EhkKBHNpemUYASABKAlCC7pICHIGwLOusQIBEhoKBWltYWdlGAIgASgJQgu6SAhyBsCzrrECASInCiVTaXplSW1hZ2VDb25zdHJhaW50U2VydmljZVRyeVJlc3BvbnNlIvYBChNTaXplSW1hZ2VDb25zdHJhaW50EhkKBHNpemUYASABKAlCC7pICHIGwLOusQIBEj0KEWltYWdlX2NvbnN0cmFpbnRzGAIgAygLMiIubWV0YWxzdGFjay5hcGkudjIuSW1hZ2VDb25zdHJhaW50EiUKBG1ldGEYAyABKAsyFy5tZXRhbHN0YWNrLmFwaS52Mi5NZXRhEh4KBG5hbWUYBCABKAlCC7pICHIGwLOusQIBSACIAQESJQoLZGVzY3JpcHRpb24YBSABKAlCC7pICHIGyLOusQIBSAGIAQFCBwoFX25hbWVCDgoMX2Rlc2NyaXB0aW9uIlAKD0ltYWdlQ29uc3RyYWludBIaCgVpbWFnZRgBIAEoCUILukgIcgbAs66xAgESIQoMc2VtdmVyX21hdGNoGAIgASgJQgu6SAhyBsizrrECASKjAQoYU2l6ZUltYWdlQ29uc3RyYWludFF1ZXJ5Eh4KBHNpemUYASABKAlCC7pICHIGwLOusQIBSACIAQESHgoEbmFtZRgCIAEoCUILukgIcgbAs66xAgFIAYgBARIlCgtkZXNjcmlwdGlvbhgDIAEoCUILukgIcgbIs66xAgFIAogBAUIHCgVfc2l6ZUIHCgVfbmFtZUIOCgxfZGVzY3JpcHRpb24yoQEKGlNpemVJbWFnZUNvbnN0cmFpbnRTZXJ2aWNlEoIBCgNUcnkSNy5tZXRhbHN0YWNrLmFwaS52Mi5TaXplSW1hZ2VDb25zdHJhaW50U2VydmljZVRyeVJlcXVlc3QaOC5tZXRhbHN0YWNrLmFwaS52Mi5TaXplSW1hZ2VDb25zdHJhaW50U2VydmljZVRyeVJlc3BvbnNlIgjY8xgC4PMYAkLOAQoVY29tLm1ldGFsc3RhY2suYXBpLnYyQhhTaXplSW1hZ2Vjb25zdHJhaW50UHJvdG9QAVo1Z2l0aHViLmNvbS9tZXRhbC1zdGFjay9hcGkvZ28vbWV0YWxzdGFjay9hcGkvdjI7YXBpdjKiAgNNQViqAhFNZXRhbHN0YWNrLkFwaS5WMsoCEU1ldGFsc3RhY2tcQXBpXFYy4gIdTWV0YWxzdGFja1xBcGlcVjJcR1BCTWV0YWRhdGHqAhNNZXRhbHN0YWNrOjpBcGk6OlYyYgZwcm90bzM", [file_buf_validate_validate, file_metalstack_api_v2_common, file_metalstack_api_v2_predefined_rules]); /** - * SizeImageConstraintServiceTryRequest is the request payload for a size image constraint try request + * SizeImageConstraintServiceTryRequest is the request payload for a size image constraint try request. * * @generated from message metalstack.api.v2.SizeImageConstraintServiceTryRequest */ @@ -45,7 +45,7 @@ export const SizeImageConstraintServiceTryRequestSchema: GenMessage & { /** - * Size where this constraint should apply + * Size where this constraint should apply. * * @generated from field: string size = 1; */ @@ -115,7 +115,7 @@ export const SizeImageConstraintSchema: GenMessage = /*@__P messageDesc(file_metalstack_api_v2_size_imageconstraint, 2); /** - * ImageConstraint defines a constraint for an image + * ImageConstraint defines a constraint for an image. * examples: * images: * ubuntu: ">= 20.04.20211011" @@ -147,7 +147,7 @@ export const ImageConstraintSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_size_imageconstraint, 3); /** - * SizeImageConstraintQuery is used to search size image constraints + * SizeImageConstraintQuery is used to search size image constraints. * * @generated from message metalstack.api.v2.SizeImageConstraintQuery */ diff --git a/js/metalstack/api/v2/size_pb.d.ts b/js/metalstack/api/v2/size_pb.d.ts index d4e9c58f..0d1cd815 100644 --- a/js/metalstack/api/v2/size_pb.d.ts +++ b/js/metalstack/api/v2/size_pb.d.ts @@ -6,7 +6,7 @@ import type { Message } from "@bufbuild/protobuf"; */ export declare const file_metalstack_api_v2_size: GenFile; /** - * SizeServiceGetRequest is the request payload for a size get request + * SizeServiceGetRequest is the request payload for a size get request. * * @generated from message metalstack.api.v2.SizeServiceGetRequest */ @@ -24,13 +24,13 @@ export type SizeServiceGetRequest = Message<"metalstack.api.v2.SizeServiceGetReq */ export declare const SizeServiceGetRequestSchema: GenMessage; /** - * SizeServiceListRequest is the request payload for a size list request + * SizeServiceListRequest is the request payload for a size list request. * * @generated from message metalstack.api.v2.SizeServiceListRequest */ export type SizeServiceListRequest = Message<"metalstack.api.v2.SizeServiceListRequest"> & { /** - * Query for sizes + * Query for sizes. * * @generated from field: metalstack.api.v2.SizeQuery query = 1; */ @@ -42,7 +42,7 @@ export type SizeServiceListRequest = Message<"metalstack.api.v2.SizeServiceListR */ export declare const SizeServiceListRequestSchema: GenMessage; /** - * SizeServiceGetResponse is the response payload for a size get request + * SizeServiceGetResponse is the response payload for a size get request. * * @generated from message metalstack.api.v2.SizeServiceGetResponse */ @@ -60,7 +60,7 @@ export type SizeServiceGetResponse = Message<"metalstack.api.v2.SizeServiceGetRe */ export declare const SizeServiceGetResponseSchema: GenMessage; /** - * SizeServiceListResponse is the response payload for a size list request + * SizeServiceListResponse is the response payload for a size list request. * * @generated from message metalstack.api.v2.SizeServiceListResponse */ @@ -144,7 +144,7 @@ export type SizeConstraint = Message<"metalstack.api.v2.SizeConstraint"> & { */ max: bigint; /** - * Identifier glob pattern which matches to the given type, for example gpu pci id + * Identifier glob pattern which matches to the given type, for example gpu pci id. * * @generated from field: optional string identifier = 4; */ @@ -156,7 +156,7 @@ export type SizeConstraint = Message<"metalstack.api.v2.SizeConstraint"> & { */ export declare const SizeConstraintSchema: GenMessage; /** - * SizeQuery is used to search sizes + * SizeQuery is used to search sizes. * * @generated from message metalstack.api.v2.SizeQuery */ @@ -180,7 +180,7 @@ export type SizeQuery = Message<"metalstack.api.v2.SizeQuery"> & { */ description?: string | undefined; /** - * Labels lists only sizes containing the given labels + * Labels lists only sizes containing the given labels. * * @generated from field: optional metalstack.api.v2.Labels labels = 4; */ @@ -192,7 +192,7 @@ export type SizeQuery = Message<"metalstack.api.v2.SizeQuery"> & { */ export declare const SizeQuerySchema: GenMessage; /** - * SizeConstraintType defines the property for which a constraint is defined + * SizeConstraintType defines the property for which a constraint is defined. * * @generated from enum metalstack.api.v2.SizeConstraintType */ @@ -204,25 +204,25 @@ export declare enum SizeConstraintType { */ UNSPECIFIED = 0, /** - * SIZE_CONSTRAINT_TYPE_CORES defines the number of cores as property + * SIZE_CONSTRAINT_TYPE_CORES defines the number of cores as property. * * @generated from enum value: SIZE_CONSTRAINT_TYPE_CORES = 1; */ CORES = 1, /** - * SIZE_CONSTRAINT_TYPE_MEMORY defines the amount of memory as property + * SIZE_CONSTRAINT_TYPE_MEMORY defines the amount of memory as property. * * @generated from enum value: SIZE_CONSTRAINT_TYPE_MEMORY = 2; */ MEMORY = 2, /** - * SIZE_CONSTRAINT_TYPE_STORAGE defines the amount of storage as property + * SIZE_CONSTRAINT_TYPE_STORAGE defines the amount of storage as property. * * @generated from enum value: SIZE_CONSTRAINT_TYPE_STORAGE = 3; */ STORAGE = 3, /** - * SIZE_CONSTRAINT_TYPE_GPU defines the number of gpus as property + * SIZE_CONSTRAINT_TYPE_GPU defines the number of gpus as property. * * @generated from enum value: SIZE_CONSTRAINT_TYPE_GPU = 4; */ diff --git a/js/metalstack/api/v2/size_pb.js b/js/metalstack/api/v2/size_pb.js index 82fcf8f9..3660a31a 100644 --- a/js/metalstack/api/v2/size_pb.js +++ b/js/metalstack/api/v2/size_pb.js @@ -45,7 +45,7 @@ export const SizeConstraintSchema = /*@__PURE__*/ messageDesc(file_metalstack_ap */ export const SizeQuerySchema = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_size, 6); /** - * SizeConstraintType defines the property for which a constraint is defined + * SizeConstraintType defines the property for which a constraint is defined. * * @generated from enum metalstack.api.v2.SizeConstraintType */ @@ -58,25 +58,25 @@ export var SizeConstraintType; */ SizeConstraintType[SizeConstraintType["UNSPECIFIED"] = 0] = "UNSPECIFIED"; /** - * SIZE_CONSTRAINT_TYPE_CORES defines the number of cores as property + * SIZE_CONSTRAINT_TYPE_CORES defines the number of cores as property. * * @generated from enum value: SIZE_CONSTRAINT_TYPE_CORES = 1; */ SizeConstraintType[SizeConstraintType["CORES"] = 1] = "CORES"; /** - * SIZE_CONSTRAINT_TYPE_MEMORY defines the amount of memory as property + * SIZE_CONSTRAINT_TYPE_MEMORY defines the amount of memory as property. * * @generated from enum value: SIZE_CONSTRAINT_TYPE_MEMORY = 2; */ SizeConstraintType[SizeConstraintType["MEMORY"] = 2] = "MEMORY"; /** - * SIZE_CONSTRAINT_TYPE_STORAGE defines the amount of storage as property + * SIZE_CONSTRAINT_TYPE_STORAGE defines the amount of storage as property. * * @generated from enum value: SIZE_CONSTRAINT_TYPE_STORAGE = 3; */ SizeConstraintType[SizeConstraintType["STORAGE"] = 3] = "STORAGE"; /** - * SIZE_CONSTRAINT_TYPE_GPU defines the number of gpus as property + * SIZE_CONSTRAINT_TYPE_GPU defines the number of gpus as property. * * @generated from enum value: SIZE_CONSTRAINT_TYPE_GPU = 4; */ diff --git a/js/metalstack/api/v2/size_pb.ts b/js/metalstack/api/v2/size_pb.ts index cff113c8..30902ad3 100644 --- a/js/metalstack/api/v2/size_pb.ts +++ b/js/metalstack/api/v2/size_pb.ts @@ -17,7 +17,7 @@ export const file_metalstack_api_v2_size: GenFile = /*@__PURE__*/ fileDesc("ChxtZXRhbHN0YWNrL2FwaS92Mi9zaXplLnByb3RvEhFtZXRhbHN0YWNrLmFwaS52MiIwChVTaXplU2VydmljZUdldFJlcXVlc3QSFwoCaWQYASABKAlCC7pICHIGwLOusQIBIkUKFlNpemVTZXJ2aWNlTGlzdFJlcXVlc3QSKwoFcXVlcnkYASABKAsyHC5tZXRhbHN0YWNrLmFwaS52Mi5TaXplUXVlcnkiPwoWU2l6ZVNlcnZpY2VHZXRSZXNwb25zZRIlCgRzaXplGAEgASgLMhcubWV0YWxzdGFjay5hcGkudjIuU2l6ZSJBChdTaXplU2VydmljZUxpc3RSZXNwb25zZRImCgVzaXplcxgBIAMoCzIXLm1ldGFsc3RhY2suYXBpLnYyLlNpemUi3gEKBFNpemUSFwoCaWQYASABKAlCC7pICHIGwLOusQIBEiUKBG1ldGEYAiABKAsyFy5tZXRhbHN0YWNrLmFwaS52Mi5NZXRhEh4KBG5hbWUYAyABKAlCC7pICHIGwLOusQIBSACIAQESJQoLZGVzY3JpcHRpb24YBCABKAlCC7pICHIGyLOusQIBSAGIAQESNgoLY29uc3RyYWludHMYBSADKAsyIS5tZXRhbHN0YWNrLmFwaS52Mi5TaXplQ29uc3RyYWludEIHCgVfbmFtZUIOCgxfZGVzY3JpcHRpb24inQEKDlNpemVDb25zdHJhaW50Ej0KBHR5cGUYASABKA4yJS5tZXRhbHN0YWNrLmFwaS52Mi5TaXplQ29uc3RyYWludFR5cGVCCLpIBYIBAhABEgsKA21pbhgCIAEoBBILCgNtYXgYAyABKAQSIwoKaWRlbnRpZmllchgEIAEoCUIKukgHcgUQABiAAUgAiAEBQg0KC19pZGVudGlmaWVyIssBCglTaXplUXVlcnkSHAoCaWQYASABKAlCC7pICHIGwLOusQIBSACIAQESHgoEbmFtZRgCIAEoCUILukgIcgbAs66xAgFIAYgBARIlCgtkZXNjcmlwdGlvbhgDIAEoCUILukgIcgbIs66xAgFIAogBARIuCgZsYWJlbHMYBCABKAsyGS5tZXRhbHN0YWNrLmFwaS52Mi5MYWJlbHNIA4gBAUIFCgNfaWRCBwoFX25hbWVCDgoMX2Rlc2NyaXB0aW9uQgkKB19sYWJlbHMq6AEKElNpemVDb25zdHJhaW50VHlwZRIkCiBTSVpFX0NPTlNUUkFJTlRfVFlQRV9VTlNQRUNJRklFRBAAEikKGlNJWkVfQ09OU1RSQUlOVF9UWVBFX0NPUkVTEAEaCYKyGQVjb3JlcxIrChtTSVpFX0NPTlNUUkFJTlRfVFlQRV9NRU1PUlkQAhoKgrIZBm1lbW9yeRItChxTSVpFX0NPTlNUUkFJTlRfVFlQRV9TVE9SQUdFEAMaC4KyGQdzdG9yYWdlEiUKGFNJWkVfQ09OU1RSQUlOVF9UWVBFX0dQVRAEGgeCshkDZ3B1MtwBCgtTaXplU2VydmljZRJkCgNHZXQSKC5tZXRhbHN0YWNrLmFwaS52Mi5TaXplU2VydmljZUdldFJlcXVlc3QaKS5tZXRhbHN0YWNrLmFwaS52Mi5TaXplU2VydmljZUdldFJlc3BvbnNlIgjY8xgC4PMYAhJnCgRMaXN0EikubWV0YWxzdGFjay5hcGkudjIuU2l6ZVNlcnZpY2VMaXN0UmVxdWVzdBoqLm1ldGFsc3RhY2suYXBpLnYyLlNpemVTZXJ2aWNlTGlzdFJlc3BvbnNlIgjY8xgC4PMYAkK/AQoVY29tLm1ldGFsc3RhY2suYXBpLnYyQglTaXplUHJvdG9QAVo1Z2l0aHViLmNvbS9tZXRhbC1zdGFjay9hcGkvZ28vbWV0YWxzdGFjay9hcGkvdjI7YXBpdjKiAgNNQViqAhFNZXRhbHN0YWNrLkFwaS5WMsoCEU1ldGFsc3RhY2tcQXBpXFYy4gIdTWV0YWxzdGFja1xBcGlcVjJcR1BCTWV0YWRhdGHqAhNNZXRhbHN0YWNrOjpBcGk6OlYyYgZwcm90bzM", [file_buf_validate_validate, file_metalstack_api_v2_common, file_metalstack_api_v2_predefined_rules]); /** - * SizeServiceGetRequest is the request payload for a size get request + * SizeServiceGetRequest is the request payload for a size get request. * * @generated from message metalstack.api.v2.SizeServiceGetRequest */ @@ -38,13 +38,13 @@ export const SizeServiceGetRequestSchema: GenMessage = /* messageDesc(file_metalstack_api_v2_size, 0); /** - * SizeServiceListRequest is the request payload for a size list request + * SizeServiceListRequest is the request payload for a size list request. * * @generated from message metalstack.api.v2.SizeServiceListRequest */ export type SizeServiceListRequest = Message<"metalstack.api.v2.SizeServiceListRequest"> & { /** - * Query for sizes + * Query for sizes. * * @generated from field: metalstack.api.v2.SizeQuery query = 1; */ @@ -59,7 +59,7 @@ export const SizeServiceListRequestSchema: GenMessage = messageDesc(file_metalstack_api_v2_size, 1); /** - * SizeServiceGetResponse is the response payload for a size get request + * SizeServiceGetResponse is the response payload for a size get request. * * @generated from message metalstack.api.v2.SizeServiceGetResponse */ @@ -80,7 +80,7 @@ export const SizeServiceGetResponseSchema: GenMessage = messageDesc(file_metalstack_api_v2_size, 2); /** - * SizeServiceListResponse is the response payload for a size list request + * SizeServiceListResponse is the response payload for a size list request. * * @generated from message metalstack.api.v2.SizeServiceListResponse */ @@ -177,7 +177,7 @@ export type SizeConstraint = Message<"metalstack.api.v2.SizeConstraint"> & { max: bigint; /** - * Identifier glob pattern which matches to the given type, for example gpu pci id + * Identifier glob pattern which matches to the given type, for example gpu pci id. * * @generated from field: optional string identifier = 4; */ @@ -192,7 +192,7 @@ export const SizeConstraintSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_size, 5); /** - * SizeQuery is used to search sizes + * SizeQuery is used to search sizes. * * @generated from message metalstack.api.v2.SizeQuery */ @@ -219,7 +219,7 @@ export type SizeQuery = Message<"metalstack.api.v2.SizeQuery"> & { description?: string | undefined; /** - * Labels lists only sizes containing the given labels + * Labels lists only sizes containing the given labels. * * @generated from field: optional metalstack.api.v2.Labels labels = 4; */ @@ -234,7 +234,7 @@ export const SizeQuerySchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_size, 6); /** - * SizeConstraintType defines the property for which a constraint is defined + * SizeConstraintType defines the property for which a constraint is defined. * * @generated from enum metalstack.api.v2.SizeConstraintType */ @@ -247,28 +247,28 @@ export enum SizeConstraintType { UNSPECIFIED = 0, /** - * SIZE_CONSTRAINT_TYPE_CORES defines the number of cores as property + * SIZE_CONSTRAINT_TYPE_CORES defines the number of cores as property. * * @generated from enum value: SIZE_CONSTRAINT_TYPE_CORES = 1; */ CORES = 1, /** - * SIZE_CONSTRAINT_TYPE_MEMORY defines the amount of memory as property + * SIZE_CONSTRAINT_TYPE_MEMORY defines the amount of memory as property. * * @generated from enum value: SIZE_CONSTRAINT_TYPE_MEMORY = 2; */ MEMORY = 2, /** - * SIZE_CONSTRAINT_TYPE_STORAGE defines the amount of storage as property + * SIZE_CONSTRAINT_TYPE_STORAGE defines the amount of storage as property. * * @generated from enum value: SIZE_CONSTRAINT_TYPE_STORAGE = 3; */ STORAGE = 3, /** - * SIZE_CONSTRAINT_TYPE_GPU defines the number of gpus as property + * SIZE_CONSTRAINT_TYPE_GPU defines the number of gpus as property. * * @generated from enum value: SIZE_CONSTRAINT_TYPE_GPU = 4; */ diff --git a/js/metalstack/api/v2/size_reservation_pb.d.ts b/js/metalstack/api/v2/size_reservation_pb.d.ts index 5a42328d..bb0a283b 100644 --- a/js/metalstack/api/v2/size_reservation_pb.d.ts +++ b/js/metalstack/api/v2/size_reservation_pb.d.ts @@ -6,7 +6,7 @@ import type { Message } from "@bufbuild/protobuf"; */ export declare const file_metalstack_api_v2_size_reservation: GenFile; /** - * SizeReservationServiceGetRequest is the request payload for a size get request + * SizeReservationServiceGetRequest is the request payload for a size get request. * * @generated from message metalstack.api.v2.SizeReservationServiceGetRequest */ @@ -30,7 +30,7 @@ export type SizeReservationServiceGetRequest = Message<"metalstack.api.v2.SizeRe */ export declare const SizeReservationServiceGetRequestSchema: GenMessage; /** - * SizeReservationServiceListRequest is the request payload for a size list request + * SizeReservationServiceListRequest is the request payload for a size list request. * * @generated from message metalstack.api.v2.SizeReservationServiceListRequest */ @@ -42,7 +42,7 @@ export type SizeReservationServiceListRequest = Message<"metalstack.api.v2.SizeR */ project: string; /** - * Query for size reservations + * Query for size reservations. * * @generated from field: metalstack.api.v2.SizeReservationQuery query = 2; */ @@ -54,7 +54,7 @@ export type SizeReservationServiceListRequest = Message<"metalstack.api.v2.SizeR */ export declare const SizeReservationServiceListRequestSchema: GenMessage; /** - * SizeReservationServiceGetResponse is the response payload for a size reservation get request + * SizeReservationServiceGetResponse is the response payload for a size reservation get request. * * @generated from message metalstack.api.v2.SizeReservationServiceGetResponse */ @@ -72,7 +72,7 @@ export type SizeReservationServiceGetResponse = Message<"metalstack.api.v2.SizeR */ export declare const SizeReservationServiceGetResponseSchema: GenMessage; /** - * SizeReservationServiceListResponse is the response payload for a size reservation list request + * SizeReservationServiceListResponse is the response payload for a size reservation list request. * * @generated from message metalstack.api.v2.SizeReservationServiceListResponse */ @@ -150,7 +150,7 @@ export type SizeReservation = Message<"metalstack.api.v2.SizeReservation"> & { */ export declare const SizeReservationSchema: GenMessage; /** - * SizeReservationQuery is used to search size reservations + * SizeReservationQuery is used to search size reservations. * * @generated from message metalstack.api.v2.SizeReservationQuery */ @@ -192,7 +192,7 @@ export type SizeReservationQuery = Message<"metalstack.api.v2.SizeReservationQue */ partition?: string | undefined; /** - * Labels lists only size reservations containing the given labels + * Labels lists only size reservations containing the given labels. * * @generated from field: optional metalstack.api.v2.Labels labels = 7; */ diff --git a/js/metalstack/api/v2/size_reservation_pb.ts b/js/metalstack/api/v2/size_reservation_pb.ts index 4cda508b..4472fe5d 100644 --- a/js/metalstack/api/v2/size_reservation_pb.ts +++ b/js/metalstack/api/v2/size_reservation_pb.ts @@ -17,7 +17,7 @@ export const file_metalstack_api_v2_size_reservation: GenFile = /*@__PURE__*/ fileDesc("CihtZXRhbHN0YWNrL2FwaS92Mi9zaXplX3Jlc2VydmF0aW9uLnByb3RvEhFtZXRhbHN0YWNrLmFwaS52MiJTCiBTaXplUmVzZXJ2YXRpb25TZXJ2aWNlR2V0UmVxdWVzdBIUCgJpZBgBIAEoCUIIukgFcgOwAQESGQoHcHJvamVjdBgCIAEoCUIIukgFcgOwAQEidgohU2l6ZVJlc2VydmF0aW9uU2VydmljZUxpc3RSZXF1ZXN0EhkKB3Byb2plY3QYASABKAlCCLpIBXIDsAEBEjYKBXF1ZXJ5GAIgASgLMicubWV0YWxzdGFjay5hcGkudjIuU2l6ZVJlc2VydmF0aW9uUXVlcnkiYQohU2l6ZVJlc2VydmF0aW9uU2VydmljZUdldFJlc3BvbnNlEjwKEHNpemVfcmVzZXJ2YXRpb24YASABKAsyIi5tZXRhbHN0YWNrLmFwaS52Mi5TaXplUmVzZXJ2YXRpb24iYwoiU2l6ZVJlc2VydmF0aW9uU2VydmljZUxpc3RSZXNwb25zZRI9ChFzaXplX3Jlc2VydmF0aW9ucxgBIAMoCzIiLm1ldGFsc3RhY2suYXBpLnYyLlNpemVSZXNlcnZhdGlvbiKHAgoPU2l6ZVJlc2VydmF0aW9uEhcKAmlkGAEgASgJQgu6SAjYAQFyA7ABARIlCgRtZXRhGAIgASgLMhcubWV0YWxzdGFjay5hcGkudjIuTWV0YRIZCgRuYW1lGAMgASgJQgu6SAhyBsCzrrECARIgCgtkZXNjcmlwdGlvbhgEIAEoCUILukgIcgbIs66xAgESGQoHcHJvamVjdBgFIAEoCUIIukgFcgOwAQESGQoEc2l6ZRgGIAEoCUILukgIcgbAs66xAgESKAoKcGFydGl0aW9ucxgHIAMoCUIUukgRkgEOCAEYASIIcgbQs66xAgESFwoGYW1vdW50GAggASgFQge6SAQaAiAAItsCChRTaXplUmVzZXJ2YXRpb25RdWVyeRIZCgJpZBgBIAEoCUIIukgFcgOwAQFIAIgBARIeCgRuYW1lGAIgASgJQgu6SAhyBsCzrrECAUgBiAEBEiUKC2Rlc2NyaXB0aW9uGAMgASgJQgu6SAhyBsizrrECAUgCiAEBEh4KBHNpemUYBCABKAlCC7pICHIGwLOusQIBSAOIAQESHgoHcHJvamVjdBgFIAEoCUIIukgFcgOwAQFIBIgBARIjCglwYXJ0aXRpb24YBiABKAlCC7pICHIG0LOusQIBSAWIAQESLgoGbGFiZWxzGAcgASgLMhkubWV0YWxzdGFjay5hcGkudjIuTGFiZWxzSAaIAQFCBQoDX2lkQgcKBV9uYW1lQg4KDF9kZXNjcmlwdGlvbkIHCgVfc2l6ZUIKCghfcHJvamVjdEIMCgpfcGFydGl0aW9uQgkKB19sYWJlbHMymgIKFlNpemVSZXNlcnZhdGlvblNlcnZpY2USfQoDR2V0EjMubWV0YWxzdGFjay5hcGkudjIuU2l6ZVJlc2VydmF0aW9uU2VydmljZUdldFJlcXVlc3QaNC5tZXRhbHN0YWNrLmFwaS52Mi5TaXplUmVzZXJ2YXRpb25TZXJ2aWNlR2V0UmVzcG9uc2UiC8rzGAMBAgPg8xgCEoABCgRMaXN0EjQubWV0YWxzdGFjay5hcGkudjIuU2l6ZVJlc2VydmF0aW9uU2VydmljZUxpc3RSZXF1ZXN0GjUubWV0YWxzdGFjay5hcGkudjIuU2l6ZVJlc2VydmF0aW9uU2VydmljZUxpc3RSZXNwb25zZSILyvMYAwECA+DzGAJCygEKFWNvbS5tZXRhbHN0YWNrLmFwaS52MkIUU2l6ZVJlc2VydmF0aW9uUHJvdG9QAVo1Z2l0aHViLmNvbS9tZXRhbC1zdGFjay9hcGkvZ28vbWV0YWxzdGFjay9hcGkvdjI7YXBpdjKiAgNNQViqAhFNZXRhbHN0YWNrLkFwaS5WMsoCEU1ldGFsc3RhY2tcQXBpXFYy4gIdTWV0YWxzdGFja1xBcGlcVjJcR1BCTWV0YWRhdGHqAhNNZXRhbHN0YWNrOjpBcGk6OlYyYgZwcm90bzM", [file_buf_validate_validate, file_metalstack_api_v2_common, file_metalstack_api_v2_predefined_rules]); /** - * SizeReservationServiceGetRequest is the request payload for a size get request + * SizeReservationServiceGetRequest is the request payload for a size get request. * * @generated from message metalstack.api.v2.SizeReservationServiceGetRequest */ @@ -45,7 +45,7 @@ export const SizeReservationServiceGetRequestSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_size_reservation, 4); /** - * SizeReservationQuery is used to search size reservations + * SizeReservationQuery is used to search size reservations. * * @generated from message metalstack.api.v2.SizeReservationQuery */ @@ -233,7 +233,7 @@ export type SizeReservationQuery = Message<"metalstack.api.v2.SizeReservationQue partition?: string | undefined; /** - * Labels lists only size reservations containing the given labels + * Labels lists only size reservations containing the given labels. * * @generated from field: optional metalstack.api.v2.Labels labels = 7; */ diff --git a/js/metalstack/api/v2/tenant_pb.d.ts b/js/metalstack/api/v2/tenant_pb.d.ts index a194604f..68ef02c1 100644 --- a/js/metalstack/api/v2/tenant_pb.d.ts +++ b/js/metalstack/api/v2/tenant_pb.d.ts @@ -7,7 +7,7 @@ import type { Message } from "@bufbuild/protobuf"; */ export declare const file_metalstack_api_v2_tenant: GenFile; /** - * Tenant is a customer of the platform + * Tenant is a customer of the platform. * * @generated from message metalstack.api.v2.Tenant */ @@ -61,19 +61,19 @@ export type Tenant = Message<"metalstack.api.v2.Tenant"> & { */ export declare const TenantSchema: GenMessage; /** - * TenantMember defines a user that participates in a tenant + * TenantMember defines a user that participates in a tenant. * * @generated from message metalstack.api.v2.TenantMember */ export type TenantMember = Message<"metalstack.api.v2.TenantMember"> & { /** - * Id is the user id of the member + * Id is the user id of the member. * * @generated from field: string id = 1; */ id: string; /** - * Role is the role of the member + * Role is the role of the member. * * @generated from field: metalstack.api.v2.TenantRole role = 2; */ @@ -103,49 +103,49 @@ export type TenantMember = Message<"metalstack.api.v2.TenantMember"> & { */ export declare const TenantMemberSchema: GenMessage; /** - * TenantInvite defines invite to tenant + * TenantInvite defines invite to tenant. * * @generated from message metalstack.api.v2.TenantInvite */ export type TenantInvite = Message<"metalstack.api.v2.TenantInvite"> & { /** - * Secret is the secret part of the invite, typically part of the url + * Secret is the secret part of the invite, typically part of the url. * * @generated from field: string secret = 1; */ secret: string; /** - * TargetTenant is the tenant id for which this invite was created + * TargetTenant is the tenant id for which this invite was created. * * @generated from field: string target_tenant = 2; */ targetTenant: string; /** - * Role is the role in this tenant the user will get after accepting the invitation + * Role is the role in this tenant the user will get after accepting the invitation. * * @generated from field: metalstack.api.v2.TenantRole role = 3; */ role: TenantRole; /** - * Joined is false as long as a user has not accepted the invite + * Joined is false as long as a user has not accepted the invite. * * @generated from field: bool joined = 4; */ joined: boolean; /** - * TargetTenantName is the tenant name for which this invite was created + * TargetTenantName is the tenant name for which this invite was created. * * @generated from field: string target_tenant_name = 5; */ targetTenantName: string; /** - * Tenant is the login of the tenant inviting another user to join this tenant + * Tenant is the login of the tenant inviting another user to join this tenant. * * @generated from field: string tenant = 6; */ tenant: string; /** - * TenantName is the name of the tenant inviting another user to join this tenant + * TenantName is the name of the tenant inviting another user to join this tenant. * * @generated from field: string tenant_name = 7; */ @@ -169,13 +169,13 @@ export type TenantInvite = Message<"metalstack.api.v2.TenantInvite"> & { */ export declare const TenantInviteSchema: GenMessage; /** - * TenantServiceListRequest is the request payload of the tenant list request + * TenantServiceListRequest is the request payload of the tenant list request. * * @generated from message metalstack.api.v2.TenantServiceListRequest */ export type TenantServiceListRequest = Message<"metalstack.api.v2.TenantServiceListRequest"> & { /** - * Query for tenants + * Query for tenants. * * @generated from field: metalstack.api.v2.TenantQuery query = 1; */ @@ -187,31 +187,31 @@ export type TenantServiceListRequest = Message<"metalstack.api.v2.TenantServiceL */ export declare const TenantServiceListRequestSchema: GenMessage; /** - * TenantQuery is used to search tenants + * TenantQuery is used to search tenants. * * @generated from message metalstack.api.v2.TenantQuery */ export type TenantQuery = Message<"metalstack.api.v2.TenantQuery"> & { /** - * Id filters tenants by login + * Id filters tenants by login. * * @generated from field: optional string login = 1; */ login?: string | undefined; /** - * Name filters tenants by name + * Name filters tenants by name. * * @generated from field: optional string name = 2; */ name?: string | undefined; /** - * Labels lists only projects containing the given labels + * Labels lists only projects containing the given labels. * * @generated from field: optional metalstack.api.v2.Labels labels = 3; */ labels?: Labels | undefined; /** - * Paging details for the list request + * Paging details for the list request. * * @generated from field: metalstack.api.v2.Paging paging = 4; */ @@ -223,7 +223,7 @@ export type TenantQuery = Message<"metalstack.api.v2.TenantQuery"> & { */ export declare const TenantQuerySchema: GenMessage; /** - * TenantServiceGetRequest is the request payload of the tenant get request + * TenantServiceGetRequest is the request payload of the tenant get request. * * @generated from message metalstack.api.v2.TenantServiceGetRequest */ @@ -241,7 +241,7 @@ export type TenantServiceGetRequest = Message<"metalstack.api.v2.TenantServiceGe */ export declare const TenantServiceGetRequestSchema: GenMessage; /** - * TenantServiceCreateRequest is the request payload of the tenant create request + * TenantServiceCreateRequest is the request payload of the tenant create request. * * @generated from message metalstack.api.v2.TenantServiceCreateRequest */ @@ -283,7 +283,7 @@ export type TenantServiceCreateRequest = Message<"metalstack.api.v2.TenantServic */ export declare const TenantServiceCreateRequestSchema: GenMessage; /** - * TenantServiceUpdateRequest is the request payload of the tenant update request + * TenantServiceUpdateRequest is the request payload of the tenant update request. * * @generated from message metalstack.api.v2.TenantServiceUpdateRequest */ @@ -295,7 +295,7 @@ export type TenantServiceUpdateRequest = Message<"metalstack.api.v2.TenantServic */ login: string; /** - * 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. * * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 2; */ @@ -337,7 +337,7 @@ export type TenantServiceUpdateRequest = Message<"metalstack.api.v2.TenantServic */ export declare const TenantServiceUpdateRequestSchema: GenMessage; /** - * TenantServiceDeleteRequest is the request payload of the tenant delete request + * TenantServiceDeleteRequest is the request payload of the tenant delete request. * * @generated from message metalstack.api.v2.TenantServiceDeleteRequest */ @@ -355,13 +355,13 @@ export type TenantServiceDeleteRequest = Message<"metalstack.api.v2.TenantServic */ export declare const TenantServiceDeleteRequestSchema: GenMessage; /** - * TenantServiceGetResponse is the response payload of the tenant get request + * TenantServiceGetResponse is the response payload of the tenant get request. * * @generated from message metalstack.api.v2.TenantServiceGetResponse */ export type TenantServiceGetResponse = Message<"metalstack.api.v2.TenantServiceGetResponse"> & { /** - * Tenant is the tenant + * Tenant is the tenant. * * @generated from field: metalstack.api.v2.Tenant tenant = 1; */ @@ -379,13 +379,13 @@ export type TenantServiceGetResponse = Message<"metalstack.api.v2.TenantServiceG */ export declare const TenantServiceGetResponseSchema: GenMessage; /** - * TenantServiceListResponse is the response payload of the tenant list request + * TenantServiceListResponse is the response payload of the tenant list request. * * @generated from message metalstack.api.v2.TenantServiceListResponse */ export type TenantServiceListResponse = Message<"metalstack.api.v2.TenantServiceListResponse"> & { /** - * Tenants is the list of tenants + * Tenants is the list of tenants. * * @generated from field: repeated metalstack.api.v2.Tenant tenants = 1; */ @@ -397,13 +397,13 @@ export type TenantServiceListResponse = Message<"metalstack.api.v2.TenantService */ export declare const TenantServiceListResponseSchema: GenMessage; /** - * TenantServiceCreateResponse is the response payload of the tenant create request + * TenantServiceCreateResponse is the response payload of the tenant create request. * * @generated from message metalstack.api.v2.TenantServiceCreateResponse */ export type TenantServiceCreateResponse = Message<"metalstack.api.v2.TenantServiceCreateResponse"> & { /** - * Tenant is the tenant + * Tenant is the tenant. * * @generated from field: metalstack.api.v2.Tenant tenant = 1; */ @@ -415,13 +415,13 @@ export type TenantServiceCreateResponse = Message<"metalstack.api.v2.TenantServi */ export declare const TenantServiceCreateResponseSchema: GenMessage; /** - * TenantServiceUpdateResponse is the response payload of the tenant update request + * TenantServiceUpdateResponse is the response payload of the tenant update request. * * @generated from message metalstack.api.v2.TenantServiceUpdateResponse */ export type TenantServiceUpdateResponse = Message<"metalstack.api.v2.TenantServiceUpdateResponse"> & { /** - * Tenant is the tenant + * Tenant is the tenant. * * @generated from field: metalstack.api.v2.Tenant tenant = 1; */ @@ -433,13 +433,13 @@ export type TenantServiceUpdateResponse = Message<"metalstack.api.v2.TenantServi */ export declare const TenantServiceUpdateResponseSchema: GenMessage; /** - * TenantServiceDeleteResponse is the response payload of the tenant delete request + * TenantServiceDeleteResponse is the response payload of the tenant delete request. * * @generated from message metalstack.api.v2.TenantServiceDeleteResponse */ export type TenantServiceDeleteResponse = Message<"metalstack.api.v2.TenantServiceDeleteResponse"> & { /** - * Tenant is the tenant + * Tenant is the tenant. * * @generated from field: metalstack.api.v2.Tenant tenant = 1; */ @@ -451,7 +451,7 @@ export type TenantServiceDeleteResponse = Message<"metalstack.api.v2.TenantServi */ export declare const TenantServiceDeleteResponseSchema: GenMessage; /** - * TenantServiceInviteRequest is used to invite a member to a tenant + * TenantServiceInviteRequest is used to invite a member to a tenant. * * @generated from message metalstack.api.v2.TenantServiceInviteRequest */ @@ -475,13 +475,13 @@ export type TenantServiceInviteRequest = Message<"metalstack.api.v2.TenantServic */ export declare const TenantServiceInviteRequestSchema: GenMessage; /** - * TenantServiceInviteRequest is the response payload to a invite member request + * TenantServiceInviteRequest is the response payload to a invite member request. * * @generated from message metalstack.api.v2.TenantServiceInviteResponse */ export type TenantServiceInviteResponse = Message<"metalstack.api.v2.TenantServiceInviteResponse"> & { /** - * Invite contains a secret which can be sent to a potential user + * Invite contains a secret which can be sent to a potential user. * can be appended to the invitation endpoint at our cloud console like * console.metalstack.cloud/invite/ * @@ -495,7 +495,7 @@ export type TenantServiceInviteResponse = Message<"metalstack.api.v2.TenantServi */ export declare const TenantServiceInviteResponseSchema: GenMessage; /** - * TenantServiceInvitesListRequest is the request payload to a list invites request + * TenantServiceInvitesListRequest is the request payload to a list invites request. * * @generated from message metalstack.api.v2.TenantServiceInvitesListRequest */ @@ -513,7 +513,7 @@ export type TenantServiceInvitesListRequest = Message<"metalstack.api.v2.TenantS */ export declare const TenantServiceInvitesListRequestSchema: GenMessage; /** - * TenantServiceInvitesListResponse is the response payload to a list invites request + * TenantServiceInvitesListResponse is the response payload to a list invites request. * * @generated from message metalstack.api.v2.TenantServiceInvitesListResponse */ @@ -531,7 +531,7 @@ export type TenantServiceInvitesListResponse = Message<"metalstack.api.v2.Tenant */ export declare const TenantServiceInvitesListResponseSchema: GenMessage; /** - * TenantServiceInviteGetRequest is the request payload to get a invite + * TenantServiceInviteGetRequest is the request payload to get a invite. * * @generated from message metalstack.api.v2.TenantServiceInviteGetRequest */ @@ -549,13 +549,13 @@ export type TenantServiceInviteGetRequest = Message<"metalstack.api.v2.TenantSer */ export declare const TenantServiceInviteGetRequestSchema: GenMessage; /** - * TenantServiceInviteGetResponse is the response payload to a get invite request + * TenantServiceInviteGetResponse is the response payload to a get invite request. * * @generated from message metalstack.api.v2.TenantServiceInviteGetResponse */ export type TenantServiceInviteGetResponse = Message<"metalstack.api.v2.TenantServiceInviteGetResponse"> & { /** - * Invite is the invite + * Invite is the invite. * * @generated from field: metalstack.api.v2.TenantInvite invite = 1; */ @@ -567,7 +567,7 @@ export type TenantServiceInviteGetResponse = Message<"metalstack.api.v2.TenantSe */ export declare const TenantServiceInviteGetResponseSchema: GenMessage; /** - * TenantServiceRemoveMemberRequest is used to remove a member from a tenant + * TenantServiceRemoveMemberRequest is used to remove a member from a tenant. * * @generated from message metalstack.api.v2.TenantServiceRemoveMemberRequest */ @@ -579,7 +579,7 @@ export type TenantServiceRemoveMemberRequest = Message<"metalstack.api.v2.Tenant */ login: string; /** - * Member is the id of the member to remove from this tenant + * Member is the id of the member to remove from this tenant. * * @generated from field: string member = 2; */ @@ -591,7 +591,7 @@ export type TenantServiceRemoveMemberRequest = Message<"metalstack.api.v2.Tenant */ export declare const TenantServiceRemoveMemberRequestSchema: GenMessage; /** - * TenantServiceLeaveTenantRequest is used to leave a tenant + * TenantServiceLeaveTenantRequest is used to leave a tenant. * * @generated from message metalstack.api.v2.TenantServiceLeaveRequest */ @@ -609,7 +609,7 @@ export type TenantServiceLeaveRequest = Message<"metalstack.api.v2.TenantService */ export declare const TenantServiceLeaveRequestSchema: GenMessage; /** - * TenantServiceLeaveTenantResponse is the response payload to a leave tenant request + * TenantServiceLeaveTenantResponse is the response payload to a leave tenant request. * * @generated from message metalstack.api.v2.TenantServiceLeaveResponse */ @@ -620,13 +620,13 @@ export type TenantServiceLeaveResponse = Message<"metalstack.api.v2.TenantServic */ export declare const TenantServiceLeaveResponseSchema: GenMessage; /** - * TenantServiceRemoveMemberResponse is the response payload to a remove member request + * TenantServiceRemoveMemberResponse is the response payload to a remove member request. * * @generated from message metalstack.api.v2.TenantServiceRemoveMemberResponse */ export type TenantServiceRemoveMemberResponse = Message<"metalstack.api.v2.TenantServiceRemoveMemberResponse"> & { /** - * TenantMember is the removed tenant member + * TenantMember is the removed tenant member. * * @generated from field: metalstack.api.v2.TenantMember tenant_member = 1; */ @@ -638,13 +638,13 @@ export type TenantServiceRemoveMemberResponse = Message<"metalstack.api.v2.Tenan */ export declare const TenantServiceRemoveMemberResponseSchema: GenMessage; /** - * TenantServiceInviteAcceptRequest is the request payload to a accept invite request + * TenantServiceInviteAcceptRequest is the request payload to a accept invite request. * * @generated from message metalstack.api.v2.TenantServiceInviteAcceptRequest */ export type TenantServiceInviteAcceptRequest = Message<"metalstack.api.v2.TenantServiceInviteAcceptRequest"> & { /** - * Secret is the invitation secret part of the invitation url + * Secret is the invitation secret part of the invitation url. * * @generated from field: string secret = 1; */ @@ -656,7 +656,7 @@ export type TenantServiceInviteAcceptRequest = Message<"metalstack.api.v2.Tenant */ export declare const TenantServiceInviteAcceptRequestSchema: GenMessage; /** - * TenantServiceInviteAcceptResponse is the response payload to a accept invite request + * TenantServiceInviteAcceptResponse is the response payload to a accept invite request. * * @generated from message metalstack.api.v2.TenantServiceInviteAcceptResponse */ @@ -680,7 +680,7 @@ export type TenantServiceInviteAcceptResponse = Message<"metalstack.api.v2.Tenan */ export declare const TenantServiceInviteAcceptResponseSchema: GenMessage; /** - * TenantServiceInviteDeleteRequest is the request payload to a delete invite + * TenantServiceInviteDeleteRequest is the request payload to a delete invite. * * @generated from message metalstack.api.v2.TenantServiceInviteDeleteRequest */ @@ -704,7 +704,7 @@ export type TenantServiceInviteDeleteRequest = Message<"metalstack.api.v2.Tenant */ export declare const TenantServiceInviteDeleteRequestSchema: GenMessage; /** - * TenantServiceInviteDeleteResponse is the response payload of a delete invite request + * TenantServiceInviteDeleteResponse is the response payload of a delete invite request. * * @generated from message metalstack.api.v2.TenantServiceInviteDeleteResponse */ @@ -715,7 +715,7 @@ export type TenantServiceInviteDeleteResponse = Message<"metalstack.api.v2.Tenan */ export declare const TenantServiceInviteDeleteResponseSchema: GenMessage; /** - * TenantServiceAddMemberRequest is the request payload for adding a member to a tenant + * TenantServiceAddMemberRequest is the request payload for adding a member to a tenant. * * @generated from message metalstack.api.v2.TenantServiceAddMemberRequest */ @@ -745,13 +745,13 @@ export type TenantServiceAddMemberRequest = Message<"metalstack.api.v2.TenantSer */ export declare const TenantServiceAddMemberRequestSchema: GenMessage; /** - * TenantServiceAddMemberResponse is the response payload for the add member request + * TenantServiceAddMemberResponse is the response payload for the add member request. * * @generated from message metalstack.api.v2.TenantServiceAddMemberResponse */ export type TenantServiceAddMemberResponse = Message<"metalstack.api.v2.TenantServiceAddMemberResponse"> & { /** - * TenantMember is the added tenant member + * TenantMember is the added tenant member. * * @generated from field: metalstack.api.v2.TenantMember tenant_member = 1; */ @@ -763,7 +763,7 @@ export type TenantServiceAddMemberResponse = Message<"metalstack.api.v2.TenantSe */ export declare const TenantServiceAddMemberResponseSchema: GenMessage; /** - * TenantServiceUpdateMemberRequest is used to update a member from a tenant + * TenantServiceUpdateMemberRequest is used to update a member from a tenant. * * @generated from message metalstack.api.v2.TenantServiceUpdateMemberRequest */ @@ -775,7 +775,7 @@ export type TenantServiceUpdateMemberRequest = Message<"metalstack.api.v2.Tenant */ login: string; /** - * Member is the id of the member to update in this tenant + * Member is the id of the member to update in this tenant. * * @generated from field: string member = 2; */ @@ -793,13 +793,13 @@ export type TenantServiceUpdateMemberRequest = Message<"metalstack.api.v2.Tenant */ export declare const TenantServiceUpdateMemberRequestSchema: GenMessage; /** - * TenantServiceUpdateMemberResponse is the response payload to a update member request + * TenantServiceUpdateMemberResponse is the response payload to a update member request. * * @generated from message metalstack.api.v2.TenantServiceUpdateMemberResponse */ export type TenantServiceUpdateMemberResponse = Message<"metalstack.api.v2.TenantServiceUpdateMemberResponse"> & { /** - * TenantMember is the updated membership + * TenantMember is the updated membership. * * @generated from field: metalstack.api.v2.TenantMember tenant_member = 1; */ @@ -837,7 +837,7 @@ export declare const TenantService: GenService<{ output: typeof TenantServiceListResponseSchema; }; /** - * Get a tenant + * Get a tenant. * * @generated from rpc metalstack.api.v2.TenantService.Get */ @@ -847,7 +847,7 @@ export declare const TenantService: GenService<{ output: typeof TenantServiceGetResponseSchema; }; /** - * Update a tenant + * Update a tenant. * * @generated from rpc metalstack.api.v2.TenantService.Update */ @@ -857,7 +857,7 @@ export declare const TenantService: GenService<{ output: typeof TenantServiceUpdateResponseSchema; }; /** - * Delete a tenant + * Delete a tenant. * * @generated from rpc metalstack.api.v2.TenantService.Delete */ @@ -867,7 +867,7 @@ export declare const TenantService: GenService<{ output: typeof TenantServiceDeleteResponseSchema; }; /** - * Leave removes a member from a tenant + * Leave removes a member from a tenant. * * @generated from rpc metalstack.api.v2.TenantService.Leave */ @@ -877,7 +877,7 @@ export declare const TenantService: GenService<{ output: typeof TenantServiceLeaveResponseSchema; }; /** - * AddMember adds a member to a tenant + * AddMember adds a member to a tenant. * * @generated from rpc metalstack.api.v2.TenantService.AddMember */ @@ -887,7 +887,7 @@ export declare const TenantService: GenService<{ output: typeof TenantServiceAddMemberResponseSchema; }; /** - * RemoveMember removes a member from a tenant + * RemoveMember removes a member from a tenant. * * @generated from rpc metalstack.api.v2.TenantService.RemoveMember */ @@ -907,7 +907,7 @@ export declare const TenantService: GenService<{ output: typeof TenantServiceUpdateMemberResponseSchema; }; /** - * Invite a user to a tenant + * Invite a user to a tenant. * * @generated from rpc metalstack.api.v2.TenantService.Invite */ @@ -917,7 +917,7 @@ export declare const TenantService: GenService<{ output: typeof TenantServiceInviteResponseSchema; }; /** - * InviteAccept is called from a user to accept an invitation + * InviteAccept is called from a user to accept an invitation. * * @generated from rpc metalstack.api.v2.TenantService.InviteAccept */ @@ -927,7 +927,7 @@ export declare const TenantService: GenService<{ output: typeof TenantServiceInviteAcceptResponseSchema; }; /** - * InviteDelete deletes a pending invitation + * InviteDelete deletes a pending invitation. * * @generated from rpc metalstack.api.v2.TenantService.InviteDelete */ @@ -937,7 +937,7 @@ export declare const TenantService: GenService<{ output: typeof TenantServiceInviteDeleteResponseSchema; }; /** - * InvitesList list all invites to a tenant + * InvitesList list all invites to a tenant. * * @generated from rpc metalstack.api.v2.TenantService.InvitesList */ diff --git a/js/metalstack/api/v2/tenant_pb.ts b/js/metalstack/api/v2/tenant_pb.ts index 37fdd8a5..01fe007f 100644 --- a/js/metalstack/api/v2/tenant_pb.ts +++ b/js/metalstack/api/v2/tenant_pb.ts @@ -19,7 +19,7 @@ export const file_metalstack_api_v2_tenant: GenFile = /*@__PURE__*/ fileDesc("Ch5tZXRhbHN0YWNrL2FwaS92Mi90ZW5hbnQucHJvdG8SEW1ldGFsc3RhY2suYXBpLnYyItUBCgZUZW5hbnQSGgoFbG9naW4YASABKAlCC7pICHIGkLSusQIBEiUKBG1ldGEYAiABKAsyFy5tZXRhbHN0YWNrLmFwaS52Mi5NZXRhEhkKBG5hbWUYAyABKAlCC7pICHIGwLOusQIBEhYKBWVtYWlsGAQgASgJQge6SARyAmABEiAKC2Rlc2NyaXB0aW9uGAUgASgJQgu6SAhyBsizrrECARIfCgphdmF0YXJfdXJsGAYgASgJQgu6SAhyBuCzrrECARISCgpjcmVhdGVkX2J5GAcgASgJIscBCgxUZW5hbnRNZW1iZXISFwoCaWQYASABKAlCC7pICHIGkLSusQIBEjUKBHJvbGUYAiABKA4yHS5tZXRhbHN0YWNrLmFwaS52Mi5UZW5hbnRSb2xlQgi6SAWCAQIQARIQCghwcm9qZWN0cxgDIAMoCRIuCgpjcmVhdGVkX2F0GAQgASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcBIlCgRtZXRhGAUgASgLMhcubWV0YWxzdGFjay5hcGkudjIuTWV0YSKcAgoMVGVuYW50SW52aXRlEg4KBnNlY3JldBgBIAEoCRIVCg10YXJnZXRfdGVuYW50GAIgASgJEjUKBHJvbGUYAyABKA4yHS5tZXRhbHN0YWNrLmFwaS52Mi5UZW5hbnRSb2xlQgi6SAWCAQIQARIOCgZqb2luZWQYBCABKAgSGgoSdGFyZ2V0X3RlbmFudF9uYW1lGAUgASgJEg4KBnRlbmFudBgGIAEoCRITCgt0ZW5hbnRfbmFtZRgHIAEoCRIuCgpleHBpcmVzX2F0GAggASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcBItCglqb2luZWRfYXQYCSABKAsyGi5nb29nbGUucHJvdG9idWYuVGltZXN0YW1wIkkKGFRlbmFudFNlcnZpY2VMaXN0UmVxdWVzdBItCgVxdWVyeRgBIAEoCzIeLm1ldGFsc3RhY2suYXBpLnYyLlRlbmFudFF1ZXJ5IscBCgtUZW5hbnRRdWVyeRIfCgVsb2dpbhgBIAEoCUILukgIcgaQtK6xAgFIAIgBARIeCgRuYW1lGAIgASgJQgu6SAhyBsCzrrECAUgBiAEBEi4KBmxhYmVscxgDIAEoCzIZLm1ldGFsc3RhY2suYXBpLnYyLkxhYmVsc0gCiAEBEikKBnBhZ2luZxgEIAEoCzIZLm1ldGFsc3RhY2suYXBpLnYyLlBhZ2luZ0IICgZfbG9naW5CBwoFX25hbWVCCQoHX2xhYmVscyIoChdUZW5hbnRTZXJ2aWNlR2V0UmVxdWVzdBINCgVsb2dpbhgBIAEoCSL1AQoaVGVuYW50U2VydmljZUNyZWF0ZVJlcXVlc3QSGQoEbmFtZRgBIAEoCUILukgIcgbAs66xAgESJQoLZGVzY3JpcHRpb24YAiABKAlCC7pICHIGyLOusQIBSACIAQESGwoFZW1haWwYAyABKAlCB7pIBHICYAFIAYgBARIkCgphdmF0YXJfdXJsGAQgASgJQgu6SAhyBuCzrrECAUgCiAEBEikKBmxhYmVscxgFIAEoCzIZLm1ldGFsc3RhY2suYXBpLnYyLkxhYmVsc0IOCgxfZGVzY3JpcHRpb25CCAoGX2VtYWlsQg0KC19hdmF0YXJfdXJsIvECChpUZW5hbnRTZXJ2aWNlVXBkYXRlUmVxdWVzdBIaCgVsb2dpbhgBIAEoCUILukgIcgaQtK6xAgESOgoLdXBkYXRlX21ldGEYAiABKAsyHS5tZXRhbHN0YWNrLmFwaS52Mi5VcGRhdGVNZXRhQga6SAPIAQESHgoEbmFtZRgDIAEoCUILukgIcgbAs66xAgFIAIgBARIbCgVlbWFpbBgEIAEoCUIHukgEcgJgAUgBiAEBEiUKC2Rlc2NyaXB0aW9uGAUgASgJQgu6SAhyBsizrrECAUgCiAEBEiQKCmF2YXRhcl91cmwYBiABKAlCC7pICHIG4LOusQIBSAOIAQESNAoGbGFiZWxzGAcgASgLMh8ubWV0YWxzdGFjay5hcGkudjIuVXBkYXRlTGFiZWxzSASIAQFCBwoFX25hbWVCCAoGX2VtYWlsQg4KDF9kZXNjcmlwdGlvbkINCgtfYXZhdGFyX3VybEIJCgdfbGFiZWxzIjgKGlRlbmFudFNlcnZpY2VEZWxldGVSZXF1ZXN0EhoKBWxvZ2luGAEgASgJQgu6SAhyBpC0rrECASJ+ChhUZW5hbnRTZXJ2aWNlR2V0UmVzcG9uc2USKQoGdGVuYW50GAEgASgLMhkubWV0YWxzdGFjay5hcGkudjIuVGVuYW50EjcKDnRlbmFudF9tZW1iZXJzGAIgAygLMh8ubWV0YWxzdGFjay5hcGkudjIuVGVuYW50TWVtYmVyIkcKGVRlbmFudFNlcnZpY2VMaXN0UmVzcG9uc2USKgoHdGVuYW50cxgBIAMoCzIZLm1ldGFsc3RhY2suYXBpLnYyLlRlbmFudCJIChtUZW5hbnRTZXJ2aWNlQ3JlYXRlUmVzcG9uc2USKQoGdGVuYW50GAEgASgLMhkubWV0YWxzdGFjay5hcGkudjIuVGVuYW50IkgKG1RlbmFudFNlcnZpY2VVcGRhdGVSZXNwb25zZRIpCgZ0ZW5hbnQYASABKAsyGS5tZXRhbHN0YWNrLmFwaS52Mi5UZW5hbnQiSAobVGVuYW50U2VydmljZURlbGV0ZVJlc3BvbnNlEikKBnRlbmFudBgBIAEoCzIZLm1ldGFsc3RhY2suYXBpLnYyLlRlbmFudCJvChpUZW5hbnRTZXJ2aWNlSW52aXRlUmVxdWVzdBIaCgVsb2dpbhgBIAEoCUILukgIcgaQtK6xAgESNQoEcm9sZRgCIAEoDjIdLm1ldGFsc3RhY2suYXBpLnYyLlRlbmFudFJvbGVCCLpIBYIBAhABIk4KG1RlbmFudFNlcnZpY2VJbnZpdGVSZXNwb25zZRIvCgZpbnZpdGUYASABKAsyHy5tZXRhbHN0YWNrLmFwaS52Mi5UZW5hbnRJbnZpdGUiPQofVGVuYW50U2VydmljZUludml0ZXNMaXN0UmVxdWVzdBIaCgVsb2dpbhgBIAEoCUILukgIcgaQtK6xAgEiVAogVGVuYW50U2VydmljZUludml0ZXNMaXN0UmVzcG9uc2USMAoHaW52aXRlcxgBIAMoCzIfLm1ldGFsc3RhY2suYXBpLnYyLlRlbmFudEludml0ZSIvCh1UZW5hbnRTZXJ2aWNlSW52aXRlR2V0UmVxdWVzdBIOCgZzZWNyZXQYASABKAkiUQoeVGVuYW50U2VydmljZUludml0ZUdldFJlc3BvbnNlEi8KBmludml0ZRgBIAEoCzIfLm1ldGFsc3RhY2suYXBpLnYyLlRlbmFudEludml0ZSJOCiBUZW5hbnRTZXJ2aWNlUmVtb3ZlTWVtYmVyUmVxdWVzdBIaCgVsb2dpbhgBIAEoCUILukgIcgaQtK6xAgESDgoGbWVtYmVyGAIgASgJIjcKGVRlbmFudFNlcnZpY2VMZWF2ZVJlcXVlc3QSGgoFbG9naW4YASABKAlCC7pICHIGkLSusQIBIhwKGlRlbmFudFNlcnZpY2VMZWF2ZVJlc3BvbnNlIlsKIVRlbmFudFNlcnZpY2VSZW1vdmVNZW1iZXJSZXNwb25zZRI2Cg10ZW5hbnRfbWVtYmVyGAEgASgLMh8ubWV0YWxzdGFjay5hcGkudjIuVGVuYW50TWVtYmVyIjIKIFRlbmFudFNlcnZpY2VJbnZpdGVBY2NlcHRSZXF1ZXN0Eg4KBnNlY3JldBgBIAEoCSJICiFUZW5hbnRTZXJ2aWNlSW52aXRlQWNjZXB0UmVzcG9uc2USDgoGdGVuYW50GAEgASgJEhMKC3RlbmFudF9uYW1lGAIgASgJIk4KIFRlbmFudFNlcnZpY2VJbnZpdGVEZWxldGVSZXF1ZXN0EhoKBWxvZ2luGAEgASgJQgu6SAhyBpC0rrECARIOCgZzZWNyZXQYAiABKAkiIwohVGVuYW50U2VydmljZUludml0ZURlbGV0ZVJlc3BvbnNlIo8BCh1UZW5hbnRTZXJ2aWNlQWRkTWVtYmVyUmVxdWVzdBIaCgVsb2dpbhgBIAEoCUILukgIcgaQtK6xAgESGwoGbWVtYmVyGAIgASgJQgu6SAhyBpC0rrECARI1CgRyb2xlGAMgASgOMh0ubWV0YWxzdGFjay5hcGkudjIuVGVuYW50Um9sZUIIukgFggECEAEiWAoeVGVuYW50U2VydmljZUFkZE1lbWJlclJlc3BvbnNlEjYKDXRlbmFudF9tZW1iZXIYASABKAsyHy5tZXRhbHN0YWNrLmFwaS52Mi5UZW5hbnRNZW1iZXIikgEKIFRlbmFudFNlcnZpY2VVcGRhdGVNZW1iZXJSZXF1ZXN0EhoKBWxvZ2luGAEgASgJQgu6SAhyBpC0rrECARIbCgZtZW1iZXIYAiABKAlCC7pICHIGkLSusQIBEjUKBHJvbGUYAyABKA4yHS5tZXRhbHN0YWNrLmFwaS52Mi5UZW5hbnRSb2xlQgi6SAWCAQIQASJbCiFUZW5hbnRTZXJ2aWNlVXBkYXRlTWVtYmVyUmVzcG9uc2USNgoNdGVuYW50X21lbWJlchgBIAEoCzIfLm1ldGFsc3RhY2suYXBpLnYyLlRlbmFudE1lbWJlcjLFDQoNVGVuYW50U2VydmljZRJxCgZDcmVhdGUSLS5tZXRhbHN0YWNrLmFwaS52Mi5UZW5hbnRTZXJ2aWNlQ3JlYXRlUmVxdWVzdBouLm1ldGFsc3RhY2suYXBpLnYyLlRlbmFudFNlcnZpY2VDcmVhdGVSZXNwb25zZSII2PMYAuDzGAESawoETGlzdBIrLm1ldGFsc3RhY2suYXBpLnYyLlRlbmFudFNlcnZpY2VMaXN0UmVxdWVzdBosLm1ldGFsc3RhY2suYXBpLnYyLlRlbmFudFNlcnZpY2VMaXN0UmVzcG9uc2UiCNjzGALg8xgCEmwKA0dldBIqLm1ldGFsc3RhY2suYXBpLnYyLlRlbmFudFNlcnZpY2VHZXRSZXF1ZXN0GisubWV0YWxzdGFjay5hcGkudjIuVGVuYW50U2VydmljZUdldFJlc3BvbnNlIgzC8xgEAQIDBODzGAIScwoGVXBkYXRlEi0ubWV0YWxzdGFjay5hcGkudjIuVGVuYW50U2VydmljZVVwZGF0ZVJlcXVlc3QaLi5tZXRhbHN0YWNrLmFwaS52Mi5UZW5hbnRTZXJ2aWNlVXBkYXRlUmVzcG9uc2UiCsLzGAIBAuDzGAEScwoGRGVsZXRlEi0ubWV0YWxzdGFjay5hcGkudjIuVGVuYW50U2VydmljZURlbGV0ZVJlcXVlc3QaLi5tZXRhbHN0YWNrLmFwaS52Mi5UZW5hbnRTZXJ2aWNlRGVsZXRlUmVzcG9uc2UiCsLzGAIBAuDzGAESbwoFTGVhdmUSLC5tZXRhbHN0YWNrLmFwaS52Mi5UZW5hbnRTZXJ2aWNlTGVhdmVSZXF1ZXN0Gi0ubWV0YWxzdGFjay5hcGkudjIuVGVuYW50U2VydmljZUxlYXZlUmVzcG9uc2UiCcLzGAED4PMYARJ8CglBZGRNZW1iZXISMC5tZXRhbHN0YWNrLmFwaS52Mi5UZW5hbnRTZXJ2aWNlQWRkTWVtYmVyUmVxdWVzdBoxLm1ldGFsc3RhY2suYXBpLnYyLlRlbmFudFNlcnZpY2VBZGRNZW1iZXJSZXNwb25zZSIKwvMYAgEC4PMYARKEAQoMUmVtb3ZlTWVtYmVyEjMubWV0YWxzdGFjay5hcGkudjIuVGVuYW50U2VydmljZVJlbW92ZU1lbWJlclJlcXVlc3QaNC5tZXRhbHN0YWNrLmFwaS52Mi5UZW5hbnRTZXJ2aWNlUmVtb3ZlTWVtYmVyUmVzcG9uc2UiCcLzGAEB4PMYARKEAQoMVXBkYXRlTWVtYmVyEjMubWV0YWxzdGFjay5hcGkudjIuVGVuYW50U2VydmljZVVwZGF0ZU1lbWJlclJlcXVlc3QaNC5tZXRhbHN0YWNrLmFwaS52Mi5UZW5hbnRTZXJ2aWNlVXBkYXRlTWVtYmVyUmVzcG9uc2UiCcLzGAEB4PMYARJyCgZJbnZpdGUSLS5tZXRhbHN0YWNrLmFwaS52Mi5UZW5hbnRTZXJ2aWNlSW52aXRlUmVxdWVzdBouLm1ldGFsc3RhY2suYXBpLnYyLlRlbmFudFNlcnZpY2VJbnZpdGVSZXNwb25zZSIJwvMYAQHg8xgBEoMBCgxJbnZpdGVBY2NlcHQSMy5tZXRhbHN0YWNrLmFwaS52Mi5UZW5hbnRTZXJ2aWNlSW52aXRlQWNjZXB0UmVxdWVzdBo0Lm1ldGFsc3RhY2suYXBpLnYyLlRlbmFudFNlcnZpY2VJbnZpdGVBY2NlcHRSZXNwb25zZSII2PMYAuDzGAEShAEKDEludml0ZURlbGV0ZRIzLm1ldGFsc3RhY2suYXBpLnYyLlRlbmFudFNlcnZpY2VJbnZpdGVEZWxldGVSZXF1ZXN0GjQubWV0YWxzdGFjay5hcGkudjIuVGVuYW50U2VydmljZUludml0ZURlbGV0ZVJlc3BvbnNlIgnC8xgBAeDzGAESgQEKC0ludml0ZXNMaXN0EjIubWV0YWxzdGFjay5hcGkudjIuVGVuYW50U2VydmljZUludml0ZXNMaXN0UmVxdWVzdBozLm1ldGFsc3RhY2suYXBpLnYyLlRlbmFudFNlcnZpY2VJbnZpdGVzTGlzdFJlc3BvbnNlIgnC8xgBAeDzGAISegoJSW52aXRlR2V0EjAubWV0YWxzdGFjay5hcGkudjIuVGVuYW50U2VydmljZUludml0ZUdldFJlcXVlc3QaMS5tZXRhbHN0YWNrLmFwaS52Mi5UZW5hbnRTZXJ2aWNlSW52aXRlR2V0UmVzcG9uc2UiCNjzGALg8xgCQsEBChVjb20ubWV0YWxzdGFjay5hcGkudjJCC1RlbmFudFByb3RvUAFaNWdpdGh1Yi5jb20vbWV0YWwtc3RhY2svYXBpL2dvL21ldGFsc3RhY2svYXBpL3YyO2FwaXYyogIDTUFYqgIRTWV0YWxzdGFjay5BcGkuVjLKAhFNZXRhbHN0YWNrXEFwaVxWMuICHU1ldGFsc3RhY2tcQXBpXFYyXEdQQk1ldGFkYXRh6gITTWV0YWxzdGFjazo6QXBpOjpWMmIGcHJvdG8z", [file_buf_validate_validate, file_google_protobuf_timestamp, file_metalstack_api_v2_common, file_metalstack_api_v2_predefined_rules]); /** - * Tenant is a customer of the platform + * Tenant is a customer of the platform. * * @generated from message metalstack.api.v2.Tenant */ @@ -82,20 +82,20 @@ export const TenantSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_tenant, 0); /** - * TenantMember defines a user that participates in a tenant + * TenantMember defines a user that participates in a tenant. * * @generated from message metalstack.api.v2.TenantMember */ export type TenantMember = Message<"metalstack.api.v2.TenantMember"> & { /** - * Id is the user id of the member + * Id is the user id of the member. * * @generated from field: string id = 1; */ id: string; /** - * Role is the role of the member + * Role is the role of the member. * * @generated from field: metalstack.api.v2.TenantRole role = 2; */ @@ -131,55 +131,55 @@ export const TenantMemberSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_tenant, 1); /** - * TenantInvite defines invite to tenant + * TenantInvite defines invite to tenant. * * @generated from message metalstack.api.v2.TenantInvite */ export type TenantInvite = Message<"metalstack.api.v2.TenantInvite"> & { /** - * Secret is the secret part of the invite, typically part of the url + * Secret is the secret part of the invite, typically part of the url. * * @generated from field: string secret = 1; */ secret: string; /** - * TargetTenant is the tenant id for which this invite was created + * TargetTenant is the tenant id for which this invite was created. * * @generated from field: string target_tenant = 2; */ targetTenant: string; /** - * Role is the role in this tenant the user will get after accepting the invitation + * Role is the role in this tenant the user will get after accepting the invitation. * * @generated from field: metalstack.api.v2.TenantRole role = 3; */ role: TenantRole; /** - * Joined is false as long as a user has not accepted the invite + * Joined is false as long as a user has not accepted the invite. * * @generated from field: bool joined = 4; */ joined: boolean; /** - * TargetTenantName is the tenant name for which this invite was created + * TargetTenantName is the tenant name for which this invite was created. * * @generated from field: string target_tenant_name = 5; */ targetTenantName: string; /** - * Tenant is the login of the tenant inviting another user to join this tenant + * Tenant is the login of the tenant inviting another user to join this tenant. * * @generated from field: string tenant = 6; */ tenant: string; /** - * TenantName is the name of the tenant inviting another user to join this tenant + * TenantName is the name of the tenant inviting another user to join this tenant. * * @generated from field: string tenant_name = 7; */ @@ -208,13 +208,13 @@ export const TenantInviteSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_tenant, 2); /** - * TenantServiceListRequest is the request payload of the tenant list request + * TenantServiceListRequest is the request payload of the tenant list request. * * @generated from message metalstack.api.v2.TenantServiceListRequest */ export type TenantServiceListRequest = Message<"metalstack.api.v2.TenantServiceListRequest"> & { /** - * Query for tenants + * Query for tenants. * * @generated from field: metalstack.api.v2.TenantQuery query = 1; */ @@ -229,34 +229,34 @@ export const TenantServiceListRequestSchema: GenMessage & { /** - * Id filters tenants by login + * Id filters tenants by login. * * @generated from field: optional string login = 1; */ login?: string | undefined; /** - * Name filters tenants by name + * Name filters tenants by name. * * @generated from field: optional string name = 2; */ name?: string | undefined; /** - * Labels lists only projects containing the given labels + * Labels lists only projects containing the given labels. * * @generated from field: optional metalstack.api.v2.Labels labels = 3; */ labels?: Labels | undefined; /** - * Paging details for the list request + * Paging details for the list request. * * @generated from field: metalstack.api.v2.Paging paging = 4; */ @@ -271,7 +271,7 @@ export const TenantQuerySchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_tenant, 4); /** - * TenantServiceGetRequest is the request payload of the tenant get request + * TenantServiceGetRequest is the request payload of the tenant get request. * * @generated from message metalstack.api.v2.TenantServiceGetRequest */ @@ -292,7 +292,7 @@ export const TenantServiceGetRequestSchema: GenMessage messageDesc(file_metalstack_api_v2_tenant, 5); /** - * TenantServiceCreateRequest is the request payload of the tenant create request + * TenantServiceCreateRequest is the request payload of the tenant create request. * * @generated from message metalstack.api.v2.TenantServiceCreateRequest */ @@ -341,7 +341,7 @@ export const TenantServiceCreateRequestSchema: GenMessage & { /** - * Tenant is the tenant + * Tenant is the tenant. * * @generated from field: metalstack.api.v2.Tenant tenant = 1; */ @@ -453,13 +453,13 @@ export const TenantServiceGetResponseSchema: GenMessage & { /** - * Tenants is the list of tenants + * Tenants is the list of tenants. * * @generated from field: repeated metalstack.api.v2.Tenant tenants = 1; */ @@ -474,13 +474,13 @@ export const TenantServiceListResponseSchema: GenMessage & { /** - * Tenant is the tenant + * Tenant is the tenant. * * @generated from field: metalstack.api.v2.Tenant tenant = 1; */ @@ -495,13 +495,13 @@ export const TenantServiceCreateResponseSchema: GenMessage & { /** - * Tenant is the tenant + * Tenant is the tenant. * * @generated from field: metalstack.api.v2.Tenant tenant = 1; */ @@ -516,13 +516,13 @@ export const TenantServiceUpdateResponseSchema: GenMessage & { /** - * Tenant is the tenant + * Tenant is the tenant. * * @generated from field: metalstack.api.v2.Tenant tenant = 1; */ @@ -537,7 +537,7 @@ export const TenantServiceDeleteResponseSchema: GenMessage & { /** - * Invite contains a secret which can be sent to a potential user + * Invite contains a secret which can be sent to a potential user. * can be appended to the invitation endpoint at our cloud console like * console.metalstack.cloud/invite/ * @@ -588,7 +588,7 @@ export const TenantServiceInviteResponseSchema: GenMessage & { /** - * Invite is the invite + * Invite is the invite. * * @generated from field: metalstack.api.v2.TenantInvite invite = 1; */ @@ -672,7 +672,7 @@ export const TenantServiceInviteGetResponseSchema: GenMessage & { /** - * TenantMember is the removed tenant member + * TenantMember is the removed tenant member. * * @generated from field: metalstack.api.v2.TenantMember tenant_member = 1; */ @@ -757,13 +757,13 @@ export const TenantServiceRemoveMemberResponseSchema: GenMessage & { /** - * Secret is the invitation secret part of the invitation url + * Secret is the invitation secret part of the invitation url. * * @generated from field: string secret = 1; */ @@ -778,7 +778,7 @@ export const TenantServiceInviteAcceptRequestSchema: GenMessage & { /** - * TenantMember is the added tenant member + * TenantMember is the added tenant member. * * @generated from field: metalstack.api.v2.TenantMember tenant_member = 1; */ @@ -905,7 +905,7 @@ export const TenantServiceAddMemberResponseSchema: GenMessage & { /** - * TenantMember is the updated membership + * TenantMember is the updated membership. * * @generated from field: metalstack.api.v2.TenantMember tenant_member = 1; */ @@ -987,7 +987,7 @@ export const TenantService: GenService<{ output: typeof TenantServiceListResponseSchema; }, /** - * Get a tenant + * Get a tenant. * * @generated from rpc metalstack.api.v2.TenantService.Get */ @@ -997,7 +997,7 @@ export const TenantService: GenService<{ output: typeof TenantServiceGetResponseSchema; }, /** - * Update a tenant + * Update a tenant. * * @generated from rpc metalstack.api.v2.TenantService.Update */ @@ -1007,7 +1007,7 @@ export const TenantService: GenService<{ output: typeof TenantServiceUpdateResponseSchema; }, /** - * Delete a tenant + * Delete a tenant. * * @generated from rpc metalstack.api.v2.TenantService.Delete */ @@ -1017,7 +1017,7 @@ export const TenantService: GenService<{ output: typeof TenantServiceDeleteResponseSchema; }, /** - * Leave removes a member from a tenant + * Leave removes a member from a tenant. * * @generated from rpc metalstack.api.v2.TenantService.Leave */ @@ -1027,7 +1027,7 @@ export const TenantService: GenService<{ output: typeof TenantServiceLeaveResponseSchema; }, /** - * AddMember adds a member to a tenant + * AddMember adds a member to a tenant. * * @generated from rpc metalstack.api.v2.TenantService.AddMember */ @@ -1037,7 +1037,7 @@ export const TenantService: GenService<{ output: typeof TenantServiceAddMemberResponseSchema; }, /** - * RemoveMember removes a member from a tenant + * RemoveMember removes a member from a tenant. * * @generated from rpc metalstack.api.v2.TenantService.RemoveMember */ @@ -1057,7 +1057,7 @@ export const TenantService: GenService<{ output: typeof TenantServiceUpdateMemberResponseSchema; }, /** - * Invite a user to a tenant + * Invite a user to a tenant. * * @generated from rpc metalstack.api.v2.TenantService.Invite */ @@ -1067,7 +1067,7 @@ export const TenantService: GenService<{ output: typeof TenantServiceInviteResponseSchema; }, /** - * InviteAccept is called from a user to accept an invitation + * InviteAccept is called from a user to accept an invitation. * * @generated from rpc metalstack.api.v2.TenantService.InviteAccept */ @@ -1077,7 +1077,7 @@ export const TenantService: GenService<{ output: typeof TenantServiceInviteAcceptResponseSchema; }, /** - * InviteDelete deletes a pending invitation + * InviteDelete deletes a pending invitation. * * @generated from rpc metalstack.api.v2.TenantService.InviteDelete */ @@ -1087,7 +1087,7 @@ export const TenantService: GenService<{ output: typeof TenantServiceInviteDeleteResponseSchema; }, /** - * InvitesList list all invites to a tenant + * InvitesList list all invites to a tenant. * * @generated from rpc metalstack.api.v2.TenantService.InvitesList */ diff --git a/js/metalstack/api/v2/token_pb.d.ts b/js/metalstack/api/v2/token_pb.d.ts index 971d567e..c5d1899f 100644 --- a/js/metalstack/api/v2/token_pb.d.ts +++ b/js/metalstack/api/v2/token_pb.d.ts @@ -7,12 +7,12 @@ import type { Message } from "@bufbuild/protobuf"; */ export declare const file_metalstack_api_v2_token: GenFile; /** - * Token generates a jwt authentication token to access the api + * Token generates a jwt authentication token to access the api. * - * There are two different types of tokens, api- and user- tokens + * There are two different types of tokens, api- and user- tokens. * * A user token is used to authenticate end user requests for example from a cli. - * The configured roles in a user token are expanded in the api server + * The configured roles in a user token are expanded in the api server. * based on the memberships in other projects and tenants based on the role granted there. * User tokens will never contain permissions. * Permissions are always derived from the tenant and project roles and memberships. @@ -50,31 +50,31 @@ export type Token = Message<"metalstack.api.v2.Token"> & { */ description: string; /** - * Permissions is a list of service methods this token can be used for + * Permissions is a list of service methods this token can be used for. * * @generated from field: repeated metalstack.api.v2.MethodPermission permissions = 5; */ permissions: MethodPermission[]; /** - * Expires gives the date in the future after which this token can not be used anymore + * Expires gives the date in the future after which this token can not be used anymore. * * @generated from field: google.protobuf.Timestamp expires = 6; */ expires?: Timestamp | undefined; /** - * IssuedAt gives the date when this token was created + * IssuedAt gives the date when this token was created. * * @generated from field: google.protobuf.Timestamp issued_at = 7; */ issuedAt?: Timestamp | undefined; /** - * TokenType describes the type of this token + * TokenType describes the type of this token. * * @generated from field: metalstack.api.v2.TokenType token_type = 8; */ tokenType: TokenType; /** - * 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. * * @generated from field: map project_roles = 9; */ @@ -82,7 +82,7 @@ export type Token = Message<"metalstack.api.v2.Token"> & { [key: string]: ProjectRole; }; /** - * TenantRoles associates a tenant id with the corresponding role of the token owner + * TenantRoles associates a tenant id with the corresponding role of the token owner. * * @generated from field: map tenant_roles = 10; */ @@ -90,20 +90,20 @@ export type Token = Message<"metalstack.api.v2.Token"> & { [key: string]: TenantRole; }; /** - * AdminRole defines the admin role of the token owner + * AdminRole defines the admin role of the token owner. * * @generated from field: optional metalstack.api.v2.AdminRole admin_role = 11; */ adminRole?: AdminRole | undefined; /** - * InfraRole defines the infrastructure role of the token owner + * InfraRole defines the infrastructure role of the token owner. * * @generated from field: optional metalstack.api.v2.InfraRole infra_role = 12; */ infraRole?: InfraRole | undefined; /** - * MachineRoles associates a machine uuid with the corresponding role of the token owner - * TODO: decide if we need this map from machine.uuid->role, we could instead use the subject in the token instead + * MachineRoles associates a machine uuid with the corresponding role of the token owner. + * TODO: decide if we need this map from machine.uuid->role, we could instead use the subject in the token instead. * * @generated from field: map machine_roles = 13; */ @@ -117,7 +117,7 @@ export type Token = Message<"metalstack.api.v2.Token"> & { */ export declare const TokenSchema: GenMessage; /** - * TokenServiceCreateRequest is the request payload to create a token + * TokenServiceCreateRequest is the request payload to create a token. * * @generated from message metalstack.api.v2.TokenServiceCreateRequest */ @@ -129,19 +129,19 @@ export type TokenServiceCreateRequest = Message<"metalstack.api.v2.TokenServiceC */ description: string; /** - * Permissions is a list of service methods this token can be used for + * Permissions is a list of service methods this token can be used for. * * @generated from field: repeated metalstack.api.v2.PermissionsByVisibility permissions = 2; */ permissions: PermissionsByVisibility[]; /** - * Expires gives the duration since now, after which this token can not be used anymore + * Expires gives the duration since now, after which this token can not be used anymore. * * @generated from field: google.protobuf.Duration expires = 3; */ expires?: Duration | undefined; /** - * 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. * * @generated from field: map project_roles = 4; */ @@ -149,7 +149,7 @@ export type TokenServiceCreateRequest = Message<"metalstack.api.v2.TokenServiceC [key: string]: ProjectRole; }; /** - * TenantRoles associates a tenant id with the corresponding role of the token owner + * TenantRoles associates a tenant id with the corresponding role of the token owner. * * @generated from field: map tenant_roles = 5; */ @@ -157,19 +157,19 @@ export type TokenServiceCreateRequest = Message<"metalstack.api.v2.TokenServiceC [key: string]: TenantRole; }; /** - * AdminRole defines the admin role of the token owner + * AdminRole defines the admin role of the token owner. * * @generated from field: optional metalstack.api.v2.AdminRole admin_role = 6; */ adminRole?: AdminRole | undefined; /** - * InfraRole defines the infrastructure role of the token owner + * InfraRole defines the infrastructure role of the token owner. * * @generated from field: optional metalstack.api.v2.InfraRole infra_role = 7; */ infraRole?: InfraRole | undefined; /** - * MachineRoles associates a machine uuid with the corresponding role of the token owner + * MachineRoles associates a machine uuid with the corresponding role of the token owner. * * @generated from field: map machine_roles = 8; */ @@ -189,7 +189,7 @@ export type TokenServiceCreateRequest = Message<"metalstack.api.v2.TokenServiceC */ export declare const TokenServiceCreateRequestSchema: GenMessage; /** - * MethodPermission is a mapping from a subject/project to a service method + * MethodPermission is a mapping from a subject/project to a service method. * * @generated from message metalstack.api.v2.MethodPermission */ @@ -218,19 +218,19 @@ export type MethodPermission = Message<"metalstack.api.v2.MethodPermission"> & { */ export declare const MethodPermissionSchema: GenMessage; /** - * PermissionsByVisibility contains method permissions by visibility + * PermissionsByVisibility contains method permissions by visibility. * * @generated from message metalstack.api.v2.PermissionsByVisibility */ export type PermissionsByVisibility = Message<"metalstack.api.v2.PermissionsByVisibility"> & { /** - * Visibility defines the visibility of the requested method permissions + * Visibility defines the visibility of the requested method permissions. * * @generated from oneof metalstack.api.v2.PermissionsByVisibility.visibility */ visibility: { /** - * PublicPermissions carries public method permissions + * PublicPermissions carries public method permissions. * * @generated from field: metalstack.api.v2.PublicPermissions public = 1; */ @@ -238,7 +238,7 @@ export type PermissionsByVisibility = Message<"metalstack.api.v2.PermissionsByVi case: "public"; } | { /** - * SelfPermissions carries self method permissions + * SelfPermissions carries self method permissions. * * @generated from field: metalstack.api.v2.SelfPermissions self = 2; */ @@ -246,7 +246,7 @@ export type PermissionsByVisibility = Message<"metalstack.api.v2.PermissionsByVi case: "self"; } | { /** - * ProjectPermissions carries project method permissions + * ProjectPermissions carries project method permissions. * * @generated from field: metalstack.api.v2.ProjectPermissions project = 3; */ @@ -254,7 +254,7 @@ export type PermissionsByVisibility = Message<"metalstack.api.v2.PermissionsByVi case: "project"; } | { /** - * TenantPermissions carries tenant method permissions + * TenantPermissions carries tenant method permissions. * * @generated from field: metalstack.api.v2.TenantPermissions tenant = 4; */ @@ -262,7 +262,7 @@ export type PermissionsByVisibility = Message<"metalstack.api.v2.PermissionsByVi case: "tenant"; } | { /** - * AdminPermissions carries admin method permissions + * AdminPermissions carries admin method permissions. * * @generated from field: metalstack.api.v2.AdminPermissions admin = 5; */ @@ -270,7 +270,7 @@ export type PermissionsByVisibility = Message<"metalstack.api.v2.PermissionsByVi case: "admin"; } | { /** - * MachinePermissions carries machine method permissions + * MachinePermissions carries machine method permissions. * * @generated from field: metalstack.api.v2.MachinePermissions machine = 6; */ @@ -278,7 +278,7 @@ export type PermissionsByVisibility = Message<"metalstack.api.v2.PermissionsByVi case: "machine"; } | { /** - * InfraPermissions carries infra method permissions + * InfraPermissions carries infra method permissions. * * @generated from field: metalstack.api.v2.InfraPermissions infra = 7; */ @@ -295,7 +295,7 @@ export type PermissionsByVisibility = Message<"metalstack.api.v2.PermissionsByVi */ export declare const PermissionsByVisibilitySchema: GenMessage; /** - * PublicPermissions carries public method permissions + * PublicPermissions carries public method permissions. * * @generated from message metalstack.api.v2.PublicPermissions */ @@ -313,7 +313,7 @@ export type PublicPermissions = Message<"metalstack.api.v2.PublicPermissions"> & */ export declare const PublicPermissionsSchema: GenMessage; /** - * SelfPermissions carries self method permissions + * SelfPermissions carries self method permissions. * * @generated from message metalstack.api.v2.SelfPermissions */ @@ -331,7 +331,7 @@ export type SelfPermissions = Message<"metalstack.api.v2.SelfPermissions"> & { */ export declare const SelfPermissionsSchema: GenMessage; /** - * ProjectPermissions carries project method permissions + * ProjectPermissions carries project method permissions. * * @generated from message metalstack.api.v2.ProjectPermissions */ @@ -355,7 +355,7 @@ export type ProjectPermissions = Message<"metalstack.api.v2.ProjectPermissions"> */ export declare const ProjectPermissionsSchema: GenMessage; /** - * TenantPermissions carries tenant method permissions + * TenantPermissions carries tenant method permissions. * * @generated from message metalstack.api.v2.TenantPermissions */ @@ -380,7 +380,7 @@ export type TenantPermissions = Message<"metalstack.api.v2.TenantPermissions"> & */ export declare const TenantPermissionsSchema: GenMessage; /** - * AdminPermissions carries admin method permissions + * AdminPermissions carries admin method permissions. * * @generated from message metalstack.api.v2.AdminPermissions */ @@ -398,7 +398,7 @@ export type AdminPermissions = Message<"metalstack.api.v2.AdminPermissions"> & { */ export declare const AdminPermissionsSchema: GenMessage; /** - * MachinePermissions carries machine method permissions + * MachinePermissions carries machine method permissions. * * @generated from message metalstack.api.v2.MachinePermissions */ @@ -423,7 +423,7 @@ export type MachinePermissions = Message<"metalstack.api.v2.MachinePermissions"> */ export declare const MachinePermissionsSchema: GenMessage; /** - * InfraPermissions carries infra method permissions + * InfraPermissions carries infra method permissions. * * @generated from message metalstack.api.v2.InfraPermissions */ @@ -441,7 +441,7 @@ export type InfraPermissions = Message<"metalstack.api.v2.InfraPermissions"> & { */ export declare const InfraPermissionsSchema: GenMessage; /** - * TokenServiceCreateResponse is the response payload of a token create request + * TokenServiceCreateResponse is the response payload of a token create request. * * @generated from message metalstack.api.v2.TokenServiceCreateResponse */ @@ -453,7 +453,7 @@ export type TokenServiceCreateResponse = Message<"metalstack.api.v2.TokenService */ token?: Token | undefined; /** - * Secret is the body of the JWT token, should be used in API requests as bearer token + * Secret is the body of the JWT token, should be used in API requests as bearer token. * * @generated from field: string secret = 2; */ @@ -465,13 +465,13 @@ export type TokenServiceCreateResponse = Message<"metalstack.api.v2.TokenService */ export declare const TokenServiceCreateResponseSchema: GenMessage; /** - * TokenServiceListRequest is the request payload to list tokens + * TokenServiceListRequest is the request payload to list tokens. * * @generated from message metalstack.api.v2.TokenServiceListRequest */ export type TokenServiceListRequest = Message<"metalstack.api.v2.TokenServiceListRequest"> & { /** - * Query for tokens + * Query for tokens. * * @generated from field: metalstack.api.v2.TokenQuery query = 1; */ @@ -483,13 +483,13 @@ export type TokenServiceListRequest = Message<"metalstack.api.v2.TokenServiceLis */ export declare const TokenServiceListRequestSchema: GenMessage; /** - * TokenServiceListResponse is the response payload of a token list request + * TokenServiceListResponse is the response payload of a token list request. * * @generated from message metalstack.api.v2.TokenServiceListResponse */ export type TokenServiceListResponse = Message<"metalstack.api.v2.TokenServiceListResponse"> & { /** - * Tokens is a list of tokens without the secrets + * Tokens is a list of tokens without the secrets. * * @generated from field: repeated metalstack.api.v2.Token tokens = 1; */ @@ -501,7 +501,7 @@ export type TokenServiceListResponse = Message<"metalstack.api.v2.TokenServiceLi */ export declare const TokenServiceListResponseSchema: GenMessage; /** - * TokenServiceRevokeRequest is the request payload of a token revoke request + * TokenServiceRevokeRequest is the request payload of a token revoke request. * * @generated from message metalstack.api.v2.TokenServiceRevokeRequest */ @@ -519,7 +519,7 @@ export type TokenServiceRevokeRequest = Message<"metalstack.api.v2.TokenServiceR */ export declare const TokenServiceRevokeRequestSchema: GenMessage; /** - * TokenServiceRevokeResponse is the response payload of a token revoke request + * TokenServiceRevokeResponse is the response payload of a token revoke request. * * @generated from message metalstack.api.v2.TokenServiceRevokeResponse */ @@ -530,7 +530,7 @@ export type TokenServiceRevokeResponse = Message<"metalstack.api.v2.TokenService */ export declare const TokenServiceRevokeResponseSchema: GenMessage; /** - * TokenServiceUpdateRequest is the request payload of a token update request + * TokenServiceUpdateRequest is the request payload of a token update request. * * @generated from message metalstack.api.v2.TokenServiceUpdateRequest */ @@ -542,8 +542,8 @@ export type TokenServiceUpdateRequest = Message<"metalstack.api.v2.TokenServiceU */ uuid: string; /** - * UpdateMeta contains the timestamp and strategy to be used in this update request - * TokenUpdate is not guarded with optlock in the backend + * UpdateMeta contains the timestamp and strategy to be used in this update request. + * TokenUpdate is not guarded with optlock in the backend. * * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 2; */ @@ -555,13 +555,13 @@ export type TokenServiceUpdateRequest = Message<"metalstack.api.v2.TokenServiceU */ description?: string | undefined; /** - * Permissions is a list of service methods this token can be used for + * Permissions is a list of service methods this token can be used for. * * @generated from field: repeated metalstack.api.v2.PermissionsByVisibility permissions = 4; */ permissions: PermissionsByVisibility[]; /** - * 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. * * @generated from field: map project_roles = 5; */ @@ -569,7 +569,7 @@ export type TokenServiceUpdateRequest = Message<"metalstack.api.v2.TokenServiceU [key: string]: ProjectRole; }; /** - * TenantRoles associates a tenant id with the corresponding role of the token owner + * TenantRoles associates a tenant id with the corresponding role of the token owner. * * @generated from field: map tenant_roles = 6; */ @@ -577,19 +577,19 @@ export type TokenServiceUpdateRequest = Message<"metalstack.api.v2.TokenServiceU [key: string]: TenantRole; }; /** - * AdminRole defines the admin role of the token owner + * AdminRole defines the admin role of the token owner. * * @generated from field: optional metalstack.api.v2.AdminRole admin_role = 7; */ adminRole?: AdminRole | undefined; /** - * InfraRole defines the infrastructure role of the token owner + * InfraRole defines the infrastructure role of the token owner. * * @generated from field: optional metalstack.api.v2.InfraRole infra_role = 8; */ infraRole?: InfraRole | undefined; /** - * MachineRoles associates a machine uuid with the corresponding role of the token owner + * MachineRoles associates a machine uuid with the corresponding role of the token owner. * * @generated from field: map machine_roles = 9; */ @@ -609,13 +609,13 @@ export type TokenServiceUpdateRequest = Message<"metalstack.api.v2.TokenServiceU */ export declare const TokenServiceUpdateRequestSchema: GenMessage; /** - * TokenServiceUpdateResponse is the response payload of a token update request + * TokenServiceUpdateResponse is the response payload of a token update request. * * @generated from message metalstack.api.v2.TokenServiceUpdateResponse */ export type TokenServiceUpdateResponse = Message<"metalstack.api.v2.TokenServiceUpdateResponse"> & { /** - * Token is the updated token + * Token is the updated token. * * @generated from field: metalstack.api.v2.Token token = 1; */ @@ -627,7 +627,7 @@ export type TokenServiceUpdateResponse = Message<"metalstack.api.v2.TokenService */ export declare const TokenServiceUpdateResponseSchema: GenMessage; /** - * TokenServiceGetRequest is the request payload of a token get request + * TokenServiceGetRequest is the request payload of a token get request. * * @generated from message metalstack.api.v2.TokenServiceGetRequest */ @@ -645,13 +645,13 @@ export type TokenServiceGetRequest = Message<"metalstack.api.v2.TokenServiceGetR */ export declare const TokenServiceGetRequestSchema: GenMessage; /** - * TokenServiceGetResponse is the response payload of a token get request + * TokenServiceGetResponse is the response payload of a token get request. * * @generated from message metalstack.api.v2.TokenServiceGetResponse */ export type TokenServiceGetResponse = Message<"metalstack.api.v2.TokenServiceGetResponse"> & { /** - * Token is the token + * Token is the token. * * @generated from field: metalstack.api.v2.Token token = 1; */ @@ -663,7 +663,7 @@ export type TokenServiceGetResponse = Message<"metalstack.api.v2.TokenServiceGet */ export declare const TokenServiceGetResponseSchema: GenMessage; /** - * TokenServiceRefreshRequest is the request payload of a token refresh request + * TokenServiceRefreshRequest is the request payload of a token refresh request. * Permissions, Roles and Expiration duration and all other properties are inherited from the calling token. * The expiration duration will be calculated from the existing token (exp - iat) * @@ -676,7 +676,7 @@ export type TokenServiceRefreshRequest = Message<"metalstack.api.v2.TokenService */ export declare const TokenServiceRefreshRequestSchema: GenMessage; /** - * TokenServiceRefreshResponse is the response payload of a token refresh request + * TokenServiceRefreshResponse is the response payload of a token refresh request. * * @generated from message metalstack.api.v2.TokenServiceRefreshResponse */ @@ -688,7 +688,7 @@ export type TokenServiceRefreshResponse = Message<"metalstack.api.v2.TokenServic */ token?: Token | undefined; /** - * Secret is the body of the JWT token, should be used in API requests as bearer token + * Secret is the body of the JWT token, should be used in API requests as bearer token. * * @generated from field: string secret = 2; */ @@ -700,7 +700,7 @@ export type TokenServiceRefreshResponse = Message<"metalstack.api.v2.TokenServic */ export declare const TokenServiceRefreshResponseSchema: GenMessage; /** - * TokenQuery is used to search tokens + * TokenQuery is used to search tokens. * * @generated from message metalstack.api.v2.TokenQuery */ @@ -725,7 +725,7 @@ export type TokenQuery = Message<"metalstack.api.v2.TokenQuery"> & { */ description?: string | undefined; /** - * Labels lists only tokens containing the given labels + * Labels lists only tokens containing the given labels. * * @generated from field: optional metalstack.api.v2.Labels labels = 4; */ @@ -743,19 +743,19 @@ export type TokenQuery = Message<"metalstack.api.v2.TokenQuery"> & { */ export declare const TokenQuerySchema: GenMessage; /** - * TokenType specifies different use cases of tokens + * TokenType specifies different use cases of tokens. * * @generated from enum metalstack.api.v2.TokenType */ export declare enum TokenType { /** - * TOKEN_TYPE_UNSPECIFIED is not specified + * TOKEN_TYPE_UNSPECIFIED is not specified. * * @generated from enum value: TOKEN_TYPE_UNSPECIFIED = 0; */ UNSPECIFIED = 0, /** - * TOKEN_TYPE_API is a token for api usage + * TOKEN_TYPE_API is a token for api usage. * * @generated from enum value: TOKEN_TYPE_API = 1; */ diff --git a/js/metalstack/api/v2/token_pb.js b/js/metalstack/api/v2/token_pb.js index 75a25155..0f66c02a 100644 --- a/js/metalstack/api/v2/token_pb.js +++ b/js/metalstack/api/v2/token_pb.js @@ -126,20 +126,20 @@ export const TokenServiceRefreshResponseSchema = /*@__PURE__*/ messageDesc(file_ */ export const TokenQuerySchema = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_token, 22); /** - * TokenType specifies different use cases of tokens + * TokenType specifies different use cases of tokens. * * @generated from enum metalstack.api.v2.TokenType */ export var TokenType; (function (TokenType) { /** - * TOKEN_TYPE_UNSPECIFIED is not specified + * TOKEN_TYPE_UNSPECIFIED is not specified. * * @generated from enum value: TOKEN_TYPE_UNSPECIFIED = 0; */ TokenType[TokenType["UNSPECIFIED"] = 0] = "UNSPECIFIED"; /** - * TOKEN_TYPE_API is a token for api usage + * TOKEN_TYPE_API is a token for api usage. * * @generated from enum value: TOKEN_TYPE_API = 1; */ diff --git a/js/metalstack/api/v2/token_pb.ts b/js/metalstack/api/v2/token_pb.ts index dfe626f7..5b6043f7 100644 --- a/js/metalstack/api/v2/token_pb.ts +++ b/js/metalstack/api/v2/token_pb.ts @@ -19,12 +19,12 @@ export const file_metalstack_api_v2_token: GenFile = /*@__PURE__*/ fileDesc("Ch1tZXRhbHN0YWNrL2FwaS92Mi90b2tlbi5wcm90bxIRbWV0YWxzdGFjay5hcGkudjIilQgKBVRva2VuEhYKBHV1aWQYASABKAlCCLpIBXIDsAEBEhkKBHVzZXIYAiABKAlCC7pICHIG+LOusQIBEiUKBG1ldGEYAyABKAsyFy5tZXRhbHN0YWNrLmFwaS52Mi5NZXRhEiAKC2Rlc2NyaXB0aW9uGAQgASgJQgu6SAhyBsizrrECARJDCgtwZXJtaXNzaW9ucxgFIAMoCzIjLm1ldGFsc3RhY2suYXBpLnYyLk1ldGhvZFBlcm1pc3Npb25CCbpIBpIBAxD0AxIrCgdleHBpcmVzGAYgASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcBItCglpc3N1ZWRfYXQYByABKAsyGi5nb29nbGUucHJvdG9idWYuVGltZXN0YW1wEjoKCnRva2VuX3R5cGUYCCABKA4yHC5tZXRhbHN0YWNrLmFwaS52Mi5Ub2tlblR5cGVCCLpIBYIBAhABElwKDXByb2plY3Rfcm9sZXMYCSADKAsyKi5tZXRhbHN0YWNrLmFwaS52Mi5Ub2tlbi5Qcm9qZWN0Um9sZXNFbnRyeUIZukgWmgETwJW4sQIByJW4sQIBKgWCAQIQARJaCgx0ZW5hbnRfcm9sZXMYCiADKAsyKS5tZXRhbHN0YWNrLmFwaS52Mi5Ub2tlbi5UZW5hbnRSb2xlc0VudHJ5Qhm6SBaaARPAlbixAgHQlbixAgEqBYIBAhABEj8KCmFkbWluX3JvbGUYCyABKA4yHC5tZXRhbHN0YWNrLmFwaS52Mi5BZG1pblJvbGVCCLpIBYIBAhABSACIAQESPwoKaW5mcmFfcm9sZRgMIAEoDjIcLm1ldGFsc3RhY2suYXBpLnYyLkluZnJhUm9sZUIIukgFggECEAFIAYgBARJcCg1tYWNoaW5lX3JvbGVzGA0gAygLMioubWV0YWxzdGFjay5hcGkudjIuVG9rZW4uTWFjaGluZVJvbGVzRW50cnlCGbpIFpoBE8CVuLECAdiVuLECASoFggECEAEaUwoRUHJvamVjdFJvbGVzRW50cnkSCwoDa2V5GAEgASgJEi0KBXZhbHVlGAIgASgOMh4ubWV0YWxzdGFjay5hcGkudjIuUHJvamVjdFJvbGU6AjgBGlEKEFRlbmFudFJvbGVzRW50cnkSCwoDa2V5GAEgASgJEiwKBXZhbHVlGAIgASgOMh0ubWV0YWxzdGFjay5hcGkudjIuVGVuYW50Um9sZToCOAEaUwoRTWFjaGluZVJvbGVzRW50cnkSCwoDa2V5GAEgASgJEi0KBXZhbHVlGAIgASgOMh4ubWV0YWxzdGFjay5hcGkudjIuTWFjaGluZVJvbGU6AjgBQg0KC19hZG1pbl9yb2xlQg0KC19pbmZyYV9yb2xlIuQHChlUb2tlblNlcnZpY2VDcmVhdGVSZXF1ZXN0EiAKC2Rlc2NyaXB0aW9uGAEgASgJQgu6SAhyBsizrrECARJJCgtwZXJtaXNzaW9ucxgCIAMoCzIqLm1ldGFsc3RhY2suYXBpLnYyLlBlcm1pc3Npb25zQnlWaXNpYmlsaXR5Qgi6SAWSAQIQZBI+CgdleHBpcmVzGAMgASgLMhkuZ29vZ2xlLnByb3RvYnVmLkR1cmF0aW9uQhK6SA+qAQwaBQiB54QPMgMI2AQScAoNcHJvamVjdF9yb2xlcxgEIAMoCzI+Lm1ldGFsc3RhY2suYXBpLnYyLlRva2VuU2VydmljZUNyZWF0ZVJlcXVlc3QuUHJvamVjdFJvbGVzRW50cnlCGbpIFpoBE8CVuLECAciVuLECASoFggECEAESbgoMdGVuYW50X3JvbGVzGAUgAygLMj0ubWV0YWxzdGFjay5hcGkudjIuVG9rZW5TZXJ2aWNlQ3JlYXRlUmVxdWVzdC5UZW5hbnRSb2xlc0VudHJ5Qhm6SBaaARPAlbixAgHQlbixAgEqBYIBAhABEj8KCmFkbWluX3JvbGUYBiABKA4yHC5tZXRhbHN0YWNrLmFwaS52Mi5BZG1pblJvbGVCCLpIBYIBAhABSACIAQESPwoKaW5mcmFfcm9sZRgHIAEoDjIcLm1ldGFsc3RhY2suYXBpLnYyLkluZnJhUm9sZUIIukgFggECEAFIAYgBARJwCg1tYWNoaW5lX3JvbGVzGAggAygLMj4ubWV0YWxzdGFjay5hcGkudjIuVG9rZW5TZXJ2aWNlQ3JlYXRlUmVxdWVzdC5NYWNoaW5lUm9sZXNFbnRyeUIZukgWmgETwJW4sQIB2JW4sQIBKgWCAQIQARIpCgZsYWJlbHMYCSABKAsyGS5tZXRhbHN0YWNrLmFwaS52Mi5MYWJlbHMaUwoRUHJvamVjdFJvbGVzRW50cnkSCwoDa2V5GAEgASgJEi0KBXZhbHVlGAIgASgOMh4ubWV0YWxzdGFjay5hcGkudjIuUHJvamVjdFJvbGU6AjgBGlEKEFRlbmFudFJvbGVzRW50cnkSCwoDa2V5GAEgASgJEiwKBXZhbHVlGAIgASgOMh0ubWV0YWxzdGFjay5hcGkudjIuVGVuYW50Um9sZToCOAEaUwoRTWFjaGluZVJvbGVzRW50cnkSCwoDa2V5GAEgASgJEi0KBXZhbHVlGAIgASgOMh4ubWV0YWxzdGFjay5hcGkudjIuTWFjaGluZVJvbGU6AjgBQg0KC19hZG1pbl9yb2xlQg0KC19pbmZyYV9yb2xlIkkKEE1ldGhvZFBlcm1pc3Npb24SGQoHc3ViamVjdBgBIAEoCUIIukgFcgMYgAISGgoHbWV0aG9kcxgCIAMoCUIJukgGkgEDEPQDIqsDChdQZXJtaXNzaW9uc0J5VmlzaWJpbGl0eRI2CgZwdWJsaWMYASABKAsyJC5tZXRhbHN0YWNrLmFwaS52Mi5QdWJsaWNQZXJtaXNzaW9uc0gAEjIKBHNlbGYYAiABKAsyIi5tZXRhbHN0YWNrLmFwaS52Mi5TZWxmUGVybWlzc2lvbnNIABI4Cgdwcm9qZWN0GAMgASgLMiUubWV0YWxzdGFjay5hcGkudjIuUHJvamVjdFBlcm1pc3Npb25zSAASNgoGdGVuYW50GAQgASgLMiQubWV0YWxzdGFjay5hcGkudjIuVGVuYW50UGVybWlzc2lvbnNIABI0CgVhZG1pbhgFIAEoCzIjLm1ldGFsc3RhY2suYXBpLnYyLkFkbWluUGVybWlzc2lvbnNIABI4CgdtYWNoaW5lGAYgASgLMiUubWV0YWxzdGFjay5hcGkudjIuTWFjaGluZVBlcm1pc3Npb25zSAASNAoFaW5mcmEYByABKAsyIy5tZXRhbHN0YWNrLmFwaS52Mi5JbmZyYVBlcm1pc3Npb25zSABCDAoKdmlzaWJpbGl0eSIvChFQdWJsaWNQZXJtaXNzaW9ucxIaCgdtZXRob2RzGAIgAygJQgm6SAaSAQMQ9AMiLQoPU2VsZlBlcm1pc3Npb25zEhoKB21ldGhvZHMYAiADKAlCCbpIBpIBAxD0AyJOChJQcm9qZWN0UGVybWlzc2lvbnMSHAoHcHJvamVjdBgBIAEoCUILukgIcgagtK6xAgESGgoHbWV0aG9kcxgCIAMoCUIJukgGkgEDEPQDIksKEVRlbmFudFBlcm1pc3Npb25zEhoKBWxvZ2luGAEgASgJQgu6SAhyBpi0rrECARIaCgdtZXRob2RzGAIgAygJQgm6SAaSAQMQ9AMiLgoQQWRtaW5QZXJtaXNzaW9ucxIaCgdtZXRob2RzGAIgAygJQgm6SAaSAQMQ9AMiSwoSTWFjaGluZVBlcm1pc3Npb25zEhkKBHV1aWQYASABKAlCC7pICHIGqLSusQIBEhoKB21ldGhvZHMYAiADKAlCCbpIBpIBAxD0AyIuChBJbmZyYVBlcm1pc3Npb25zEhoKB21ldGhvZHMYAiADKAlCCbpIBpIBAxD0AyJVChpUb2tlblNlcnZpY2VDcmVhdGVSZXNwb25zZRInCgV0b2tlbhgBIAEoCzIYLm1ldGFsc3RhY2suYXBpLnYyLlRva2VuEg4KBnNlY3JldBgCIAEoCSJHChdUb2tlblNlcnZpY2VMaXN0UmVxdWVzdBIsCgVxdWVyeRgBIAEoCzIdLm1ldGFsc3RhY2suYXBpLnYyLlRva2VuUXVlcnkiRAoYVG9rZW5TZXJ2aWNlTGlzdFJlc3BvbnNlEigKBnRva2VucxgBIAMoCzIYLm1ldGFsc3RhY2suYXBpLnYyLlRva2VuIjMKGVRva2VuU2VydmljZVJldm9rZVJlcXVlc3QSFgoEdXVpZBgBIAEoCUIIukgFcgOwAQEiHAoaVG9rZW5TZXJ2aWNlUmV2b2tlUmVzcG9uc2UiiQgKGVRva2VuU2VydmljZVVwZGF0ZVJlcXVlc3QSFgoEdXVpZBgBIAEoCUIIukgFcgOwAQESOgoLdXBkYXRlX21ldGEYAiABKAsyHS5tZXRhbHN0YWNrLmFwaS52Mi5VcGRhdGVNZXRhQga6SAPIAQASJQoLZGVzY3JpcHRpb24YAyABKAlCC7pICHIGyLOusQIBSACIAQESPwoLcGVybWlzc2lvbnMYBCADKAsyKi5tZXRhbHN0YWNrLmFwaS52Mi5QZXJtaXNzaW9uc0J5VmlzaWJpbGl0eRJwCg1wcm9qZWN0X3JvbGVzGAUgAygLMj4ubWV0YWxzdGFjay5hcGkudjIuVG9rZW5TZXJ2aWNlVXBkYXRlUmVxdWVzdC5Qcm9qZWN0Um9sZXNFbnRyeUIZukgWmgETwJW4sQIByJW4sQIBKgWCAQIQARJuCgx0ZW5hbnRfcm9sZXMYBiADKAsyPS5tZXRhbHN0YWNrLmFwaS52Mi5Ub2tlblNlcnZpY2VVcGRhdGVSZXF1ZXN0LlRlbmFudFJvbGVzRW50cnlCGbpIFpoBE8CVuLECAdCVuLECASoFggECEAESPwoKYWRtaW5fcm9sZRgHIAEoDjIcLm1ldGFsc3RhY2suYXBpLnYyLkFkbWluUm9sZUIIukgFggECEAFIAYgBARI/CgppbmZyYV9yb2xlGAggASgOMhwubWV0YWxzdGFjay5hcGkudjIuSW5mcmFSb2xlQgi6SAWCAQIQAUgCiAEBEnAKDW1hY2hpbmVfcm9sZXMYCSADKAsyPi5tZXRhbHN0YWNrLmFwaS52Mi5Ub2tlblNlcnZpY2VVcGRhdGVSZXF1ZXN0Lk1hY2hpbmVSb2xlc0VudHJ5Qhm6SBaaARPAlbixAgHYlbixAgEqBYIBAhABEi8KBmxhYmVscxgKIAEoCzIfLm1ldGFsc3RhY2suYXBpLnYyLlVwZGF0ZUxhYmVscxpTChFQcm9qZWN0Um9sZXNFbnRyeRILCgNrZXkYASABKAkSLQoFdmFsdWUYAiABKA4yHi5tZXRhbHN0YWNrLmFwaS52Mi5Qcm9qZWN0Um9sZToCOAEaUQoQVGVuYW50Um9sZXNFbnRyeRILCgNrZXkYASABKAkSLAoFdmFsdWUYAiABKA4yHS5tZXRhbHN0YWNrLmFwaS52Mi5UZW5hbnRSb2xlOgI4ARpTChFNYWNoaW5lUm9sZXNFbnRyeRILCgNrZXkYASABKAkSLQoFdmFsdWUYAiABKA4yHi5tZXRhbHN0YWNrLmFwaS52Mi5NYWNoaW5lUm9sZToCOAFCDgoMX2Rlc2NyaXB0aW9uQg0KC19hZG1pbl9yb2xlQg0KC19pbmZyYV9yb2xlIkUKGlRva2VuU2VydmljZVVwZGF0ZVJlc3BvbnNlEicKBXRva2VuGAEgASgLMhgubWV0YWxzdGFjay5hcGkudjIuVG9rZW4iMAoWVG9rZW5TZXJ2aWNlR2V0UmVxdWVzdBIWCgR1dWlkGAEgASgJQgi6SAVyA7ABASJCChdUb2tlblNlcnZpY2VHZXRSZXNwb25zZRInCgV0b2tlbhgBIAEoCzIYLm1ldGFsc3RhY2suYXBpLnYyLlRva2VuIhwKGlRva2VuU2VydmljZVJlZnJlc2hSZXF1ZXN0IlYKG1Rva2VuU2VydmljZVJlZnJlc2hSZXNwb25zZRInCgV0b2tlbhgBIAEoCzIYLm1ldGFsc3RhY2suYXBpLnYyLlRva2VuEg4KBnNlY3JldBgCIAEoCSKdAgoKVG9rZW5RdWVyeRIbCgR1dWlkGAEgASgJQgi6SAVyA7ABAUgAiAEBEh4KBHVzZXIYAiABKAlCC7pICHIG+LOusQIBSAGIAQESJQoLZGVzY3JpcHRpb24YAyABKAlCC7pICHIGyLOusQIBSAKIAQESLgoGbGFiZWxzGAQgASgLMhkubWV0YWxzdGFjay5hcGkudjIuTGFiZWxzSAOIAQESPwoKdG9rZW5fdHlwZRgFIAEoDjIcLm1ldGFsc3RhY2suYXBpLnYyLlRva2VuVHlwZUIIukgFggECEAFIBIgBAUIHCgVfdXVpZEIHCgVfdXNlckIOCgxfZGVzY3JpcHRpb25CCQoHX2xhYmVsc0INCgtfdG9rZW5fdHlwZSpQCglUb2tlblR5cGUSGgoWVE9LRU5fVFlQRV9VTlNQRUNJRklFRBAAEhIKDlRPS0VOX1RZUEVfQVBJEAESEwoPVE9LRU5fVFlQRV9VU0VSEAIyqAUKDFRva2VuU2VydmljZRJmCgNHZXQSKS5tZXRhbHN0YWNrLmFwaS52Mi5Ub2tlblNlcnZpY2VHZXRSZXF1ZXN0GioubWV0YWxzdGFjay5hcGkudjIuVG9rZW5TZXJ2aWNlR2V0UmVzcG9uc2UiCNjzGALg8xgBEm8KBkNyZWF0ZRIsLm1ldGFsc3RhY2suYXBpLnYyLlRva2VuU2VydmljZUNyZWF0ZVJlcXVlc3QaLS5tZXRhbHN0YWNrLmFwaS52Mi5Ub2tlblNlcnZpY2VDcmVhdGVSZXNwb25zZSII2PMYAuDzGAESbwoGVXBkYXRlEiwubWV0YWxzdGFjay5hcGkudjIuVG9rZW5TZXJ2aWNlVXBkYXRlUmVxdWVzdBotLm1ldGFsc3RhY2suYXBpLnYyLlRva2VuU2VydmljZVVwZGF0ZVJlc3BvbnNlIgjY8xgC4PMYARJpCgRMaXN0EioubWV0YWxzdGFjay5hcGkudjIuVG9rZW5TZXJ2aWNlTGlzdFJlcXVlc3QaKy5tZXRhbHN0YWNrLmFwaS52Mi5Ub2tlblNlcnZpY2VMaXN0UmVzcG9uc2UiCNjzGALg8xgBEm8KBlJldm9rZRIsLm1ldGFsc3RhY2suYXBpLnYyLlRva2VuU2VydmljZVJldm9rZVJlcXVlc3QaLS5tZXRhbHN0YWNrLmFwaS52Mi5Ub2tlblNlcnZpY2VSZXZva2VSZXNwb25zZSII2PMYAuDzGAEScgoHUmVmcmVzaBItLm1ldGFsc3RhY2suYXBpLnYyLlRva2VuU2VydmljZVJlZnJlc2hSZXF1ZXN0Gi4ubWV0YWxzdGFjay5hcGkudjIuVG9rZW5TZXJ2aWNlUmVmcmVzaFJlc3BvbnNlIgjY8xgC4PMYAULAAQoVY29tLm1ldGFsc3RhY2suYXBpLnYyQgpUb2tlblByb3RvUAFaNWdpdGh1Yi5jb20vbWV0YWwtc3RhY2svYXBpL2dvL21ldGFsc3RhY2svYXBpL3YyO2FwaXYyogIDTUFYqgIRTWV0YWxzdGFjay5BcGkuVjLKAhFNZXRhbHN0YWNrXEFwaVxWMuICHU1ldGFsc3RhY2tcQXBpXFYyXEdQQk1ldGFkYXRh6gITTWV0YWxzdGFjazo6QXBpOjpWMmIGcHJvdG8z", [file_buf_validate_validate, file_google_protobuf_duration, file_google_protobuf_timestamp, file_metalstack_api_v2_common, file_metalstack_api_v2_predefined_rules]); /** - * Token generates a jwt authentication token to access the api + * Token generates a jwt authentication token to access the api. * - * There are two different types of tokens, api- and user- tokens + * There are two different types of tokens, api- and user- tokens. * * A user token is used to authenticate end user requests for example from a cli. - * The configured roles in a user token are expanded in the api server + * The configured roles in a user token are expanded in the api server. * based on the memberships in other projects and tenants based on the role granted there. * User tokens will never contain permissions. * Permissions are always derived from the tenant and project roles and memberships. @@ -66,64 +66,64 @@ export type Token = Message<"metalstack.api.v2.Token"> & { description: string; /** - * Permissions is a list of service methods this token can be used for + * Permissions is a list of service methods this token can be used for. * * @generated from field: repeated metalstack.api.v2.MethodPermission permissions = 5; */ permissions: MethodPermission[]; /** - * Expires gives the date in the future after which this token can not be used anymore + * Expires gives the date in the future after which this token can not be used anymore. * * @generated from field: google.protobuf.Timestamp expires = 6; */ expires?: Timestamp | undefined; /** - * IssuedAt gives the date when this token was created + * IssuedAt gives the date when this token was created. * * @generated from field: google.protobuf.Timestamp issued_at = 7; */ issuedAt?: Timestamp | undefined; /** - * TokenType describes the type of this token + * TokenType describes the type of this token. * * @generated from field: metalstack.api.v2.TokenType token_type = 8; */ tokenType: TokenType; /** - * 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. * * @generated from field: map project_roles = 9; */ projectRoles: { [key: string]: ProjectRole }; /** - * TenantRoles associates a tenant id with the corresponding role of the token owner + * TenantRoles associates a tenant id with the corresponding role of the token owner. * * @generated from field: map tenant_roles = 10; */ tenantRoles: { [key: string]: TenantRole }; /** - * AdminRole defines the admin role of the token owner + * AdminRole defines the admin role of the token owner. * * @generated from field: optional metalstack.api.v2.AdminRole admin_role = 11; */ adminRole?: AdminRole | undefined; /** - * InfraRole defines the infrastructure role of the token owner + * InfraRole defines the infrastructure role of the token owner. * * @generated from field: optional metalstack.api.v2.InfraRole infra_role = 12; */ infraRole?: InfraRole | undefined; /** - * MachineRoles associates a machine uuid with the corresponding role of the token owner - * TODO: decide if we need this map from machine.uuid->role, we could instead use the subject in the token instead + * MachineRoles associates a machine uuid with the corresponding role of the token owner. + * TODO: decide if we need this map from machine.uuid->role, we could instead use the subject in the token instead. * * @generated from field: map machine_roles = 13; */ @@ -138,7 +138,7 @@ export const TokenSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_token, 0); /** - * TokenServiceCreateRequest is the request payload to create a token + * TokenServiceCreateRequest is the request payload to create a token. * * @generated from message metalstack.api.v2.TokenServiceCreateRequest */ @@ -151,49 +151,49 @@ export type TokenServiceCreateRequest = Message<"metalstack.api.v2.TokenServiceC description: string; /** - * Permissions is a list of service methods this token can be used for + * Permissions is a list of service methods this token can be used for. * * @generated from field: repeated metalstack.api.v2.PermissionsByVisibility permissions = 2; */ permissions: PermissionsByVisibility[]; /** - * Expires gives the duration since now, after which this token can not be used anymore + * Expires gives the duration since now, after which this token can not be used anymore. * * @generated from field: google.protobuf.Duration expires = 3; */ expires?: Duration | undefined; /** - * 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. * * @generated from field: map project_roles = 4; */ projectRoles: { [key: string]: ProjectRole }; /** - * TenantRoles associates a tenant id with the corresponding role of the token owner + * TenantRoles associates a tenant id with the corresponding role of the token owner. * * @generated from field: map tenant_roles = 5; */ tenantRoles: { [key: string]: TenantRole }; /** - * AdminRole defines the admin role of the token owner + * AdminRole defines the admin role of the token owner. * * @generated from field: optional metalstack.api.v2.AdminRole admin_role = 6; */ adminRole?: AdminRole | undefined; /** - * InfraRole defines the infrastructure role of the token owner + * InfraRole defines the infrastructure role of the token owner. * * @generated from field: optional metalstack.api.v2.InfraRole infra_role = 7; */ infraRole?: InfraRole | undefined; /** - * MachineRoles associates a machine uuid with the corresponding role of the token owner + * MachineRoles associates a machine uuid with the corresponding role of the token owner. * * @generated from field: map machine_roles = 8; */ @@ -215,7 +215,7 @@ export const TokenServiceCreateRequestSchema: GenMessage = /*@__PURE__* messageDesc(file_metalstack_api_v2_token, 2); /** - * PermissionsByVisibility contains method permissions by visibility + * PermissionsByVisibility contains method permissions by visibility. * * @generated from message metalstack.api.v2.PermissionsByVisibility */ export type PermissionsByVisibility = Message<"metalstack.api.v2.PermissionsByVisibility"> & { /** - * Visibility defines the visibility of the requested method permissions + * Visibility defines the visibility of the requested method permissions. * * @generated from oneof metalstack.api.v2.PermissionsByVisibility.visibility */ visibility: { /** - * PublicPermissions carries public method permissions + * PublicPermissions carries public method permissions. * * @generated from field: metalstack.api.v2.PublicPermissions public = 1; */ @@ -268,7 +268,7 @@ export type PermissionsByVisibility = Message<"metalstack.api.v2.PermissionsByVi case: "public"; } | { /** - * SelfPermissions carries self method permissions + * SelfPermissions carries self method permissions. * * @generated from field: metalstack.api.v2.SelfPermissions self = 2; */ @@ -276,7 +276,7 @@ export type PermissionsByVisibility = Message<"metalstack.api.v2.PermissionsByVi case: "self"; } | { /** - * ProjectPermissions carries project method permissions + * ProjectPermissions carries project method permissions. * * @generated from field: metalstack.api.v2.ProjectPermissions project = 3; */ @@ -284,7 +284,7 @@ export type PermissionsByVisibility = Message<"metalstack.api.v2.PermissionsByVi case: "project"; } | { /** - * TenantPermissions carries tenant method permissions + * TenantPermissions carries tenant method permissions. * * @generated from field: metalstack.api.v2.TenantPermissions tenant = 4; */ @@ -292,7 +292,7 @@ export type PermissionsByVisibility = Message<"metalstack.api.v2.PermissionsByVi case: "tenant"; } | { /** - * AdminPermissions carries admin method permissions + * AdminPermissions carries admin method permissions. * * @generated from field: metalstack.api.v2.AdminPermissions admin = 5; */ @@ -300,7 +300,7 @@ export type PermissionsByVisibility = Message<"metalstack.api.v2.PermissionsByVi case: "admin"; } | { /** - * MachinePermissions carries machine method permissions + * MachinePermissions carries machine method permissions. * * @generated from field: metalstack.api.v2.MachinePermissions machine = 6; */ @@ -308,7 +308,7 @@ export type PermissionsByVisibility = Message<"metalstack.api.v2.PermissionsByVi case: "machine"; } | { /** - * InfraPermissions carries infra method permissions + * InfraPermissions carries infra method permissions. * * @generated from field: metalstack.api.v2.InfraPermissions infra = 7; */ @@ -325,7 +325,7 @@ export const PermissionsByVisibilitySchema: GenMessage messageDesc(file_metalstack_api_v2_token, 3); /** - * PublicPermissions carries public method permissions + * PublicPermissions carries public method permissions. * * @generated from message metalstack.api.v2.PublicPermissions */ @@ -346,7 +346,7 @@ export const PublicPermissionsSchema: GenMessage = /*@__PURE_ messageDesc(file_metalstack_api_v2_token, 4); /** - * SelfPermissions carries self method permissions + * SelfPermissions carries self method permissions. * * @generated from message metalstack.api.v2.SelfPermissions */ @@ -367,7 +367,7 @@ export const SelfPermissionsSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_token, 5); /** - * ProjectPermissions carries project method permissions + * ProjectPermissions carries project method permissions. * * @generated from message metalstack.api.v2.ProjectPermissions */ @@ -395,7 +395,7 @@ export const ProjectPermissionsSchema: GenMessage = /*@__PUR messageDesc(file_metalstack_api_v2_token, 6); /** - * TenantPermissions carries tenant method permissions + * TenantPermissions carries tenant method permissions. * * @generated from message metalstack.api.v2.TenantPermissions */ @@ -424,7 +424,7 @@ export const TenantPermissionsSchema: GenMessage = /*@__PURE_ messageDesc(file_metalstack_api_v2_token, 7); /** - * AdminPermissions carries admin method permissions + * AdminPermissions carries admin method permissions. * * @generated from message metalstack.api.v2.AdminPermissions */ @@ -445,7 +445,7 @@ export const AdminPermissionsSchema: GenMessage = /*@__PURE__* messageDesc(file_metalstack_api_v2_token, 8); /** - * MachinePermissions carries machine method permissions + * MachinePermissions carries machine method permissions. * * @generated from message metalstack.api.v2.MachinePermissions */ @@ -474,7 +474,7 @@ export const MachinePermissionsSchema: GenMessage = /*@__PUR messageDesc(file_metalstack_api_v2_token, 9); /** - * InfraPermissions carries infra method permissions + * InfraPermissions carries infra method permissions. * * @generated from message metalstack.api.v2.InfraPermissions */ @@ -495,7 +495,7 @@ export const InfraPermissionsSchema: GenMessage = /*@__PURE__* messageDesc(file_metalstack_api_v2_token, 10); /** - * TokenServiceCreateResponse is the response payload of a token create request + * TokenServiceCreateResponse is the response payload of a token create request. * * @generated from message metalstack.api.v2.TokenServiceCreateResponse */ @@ -508,7 +508,7 @@ export type TokenServiceCreateResponse = Message<"metalstack.api.v2.TokenService token?: Token | undefined; /** - * Secret is the body of the JWT token, should be used in API requests as bearer token + * Secret is the body of the JWT token, should be used in API requests as bearer token. * * @generated from field: string secret = 2; */ @@ -523,13 +523,13 @@ export const TokenServiceCreateResponseSchema: GenMessage & { /** - * Query for tokens + * Query for tokens. * * @generated from field: metalstack.api.v2.TokenQuery query = 1; */ @@ -544,13 +544,13 @@ export const TokenServiceListRequestSchema: GenMessage messageDesc(file_metalstack_api_v2_token, 12); /** - * TokenServiceListResponse is the response payload of a token list request + * TokenServiceListResponse is the response payload of a token list request. * * @generated from message metalstack.api.v2.TokenServiceListResponse */ export type TokenServiceListResponse = Message<"metalstack.api.v2.TokenServiceListResponse"> & { /** - * Tokens is a list of tokens without the secrets + * Tokens is a list of tokens without the secrets. * * @generated from field: repeated metalstack.api.v2.Token tokens = 1; */ @@ -565,7 +565,7 @@ export const TokenServiceListResponseSchema: GenMessage project_roles = 5; */ projectRoles: { [key: string]: ProjectRole }; /** - * TenantRoles associates a tenant id with the corresponding role of the token owner + * TenantRoles associates a tenant id with the corresponding role of the token owner. * * @generated from field: map tenant_roles = 6; */ tenantRoles: { [key: string]: TenantRole }; /** - * AdminRole defines the admin role of the token owner + * AdminRole defines the admin role of the token owner. * * @generated from field: optional metalstack.api.v2.AdminRole admin_role = 7; */ adminRole?: AdminRole | undefined; /** - * InfraRole defines the infrastructure role of the token owner + * InfraRole defines the infrastructure role of the token owner. * * @generated from field: optional metalstack.api.v2.InfraRole infra_role = 8; */ infraRole?: InfraRole | undefined; /** - * MachineRoles associates a machine uuid with the corresponding role of the token owner + * MachineRoles associates a machine uuid with the corresponding role of the token owner. * * @generated from field: map machine_roles = 9; */ @@ -686,13 +686,13 @@ export const TokenServiceUpdateRequestSchema: GenMessage & { /** - * Token is the updated token + * Token is the updated token. * * @generated from field: metalstack.api.v2.Token token = 1; */ @@ -707,7 +707,7 @@ export const TokenServiceUpdateResponseSchema: GenMessage = messageDesc(file_metalstack_api_v2_token, 18); /** - * TokenServiceGetResponse is the response payload of a token get request + * TokenServiceGetResponse is the response payload of a token get request. * * @generated from message metalstack.api.v2.TokenServiceGetResponse */ export type TokenServiceGetResponse = Message<"metalstack.api.v2.TokenServiceGetResponse"> & { /** - * Token is the token + * Token is the token. * * @generated from field: metalstack.api.v2.Token token = 1; */ @@ -749,7 +749,7 @@ export const TokenServiceGetResponseSchema: GenMessage messageDesc(file_metalstack_api_v2_token, 19); /** - * TokenServiceRefreshRequest is the request payload of a token refresh request + * TokenServiceRefreshRequest is the request payload of a token refresh request. * Permissions, Roles and Expiration duration and all other properties are inherited from the calling token. * The expiration duration will be calculated from the existing token (exp - iat) * @@ -766,7 +766,7 @@ export const TokenServiceRefreshRequestSchema: GenMessage & { description?: string | undefined; /** - * Labels lists only tokens containing the given labels + * Labels lists only tokens containing the given labels. * * @generated from field: optional metalstack.api.v2.Labels labels = 4; */ @@ -844,20 +844,20 @@ export const TokenQuerySchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_token, 22); /** - * TokenType specifies different use cases of tokens + * TokenType specifies different use cases of tokens. * * @generated from enum metalstack.api.v2.TokenType */ export enum TokenType { /** - * TOKEN_TYPE_UNSPECIFIED is not specified + * TOKEN_TYPE_UNSPECIFIED is not specified. * * @generated from enum value: TOKEN_TYPE_UNSPECIFIED = 0; */ UNSPECIFIED = 0, /** - * TOKEN_TYPE_API is a token for api usage + * TOKEN_TYPE_API is a token for api usage. * * @generated from enum value: TOKEN_TYPE_API = 1; */ diff --git a/js/metalstack/api/v2/user_pb.d.ts b/js/metalstack/api/v2/user_pb.d.ts index ac82bc3e..0873ef3a 100644 --- a/js/metalstack/api/v2/user_pb.d.ts +++ b/js/metalstack/api/v2/user_pb.d.ts @@ -13,7 +13,7 @@ export declare const file_metalstack_api_v2_user: GenFile; */ export type User = Message<"metalstack.api.v2.User"> & { /** - * Login is the login at the provider + * Login is the login at the provider. * * @generated from field: string login = 1; */ @@ -78,7 +78,7 @@ export declare const UserServiceGetRequestSchema: GenMessage & { /** - * User contains the authenticated user + * User contains the authenticated user. * * @generated from field: metalstack.api.v2.User user = 1; */ diff --git a/js/metalstack/api/v2/user_pb.ts b/js/metalstack/api/v2/user_pb.ts index 0b48c4a6..7e3f262b 100644 --- a/js/metalstack/api/v2/user_pb.ts +++ b/js/metalstack/api/v2/user_pb.ts @@ -26,7 +26,7 @@ export const file_metalstack_api_v2_user: GenFile = /*@__PURE__*/ */ export type User = Message<"metalstack.api.v2.User"> & { /** - * Login is the login at the provider + * Login is the login at the provider. * * @generated from field: string login = 1; */ @@ -104,7 +104,7 @@ export const UserServiceGetRequestSchema: GenMessage = /* */ export type UserServiceGetResponse = Message<"metalstack.api.v2.UserServiceGetResponse"> & { /** - * User contains the authenticated user + * User contains the authenticated user. * * @generated from field: metalstack.api.v2.User user = 1; */ diff --git a/js/metalstack/api/v2/version_pb.d.ts b/js/metalstack/api/v2/version_pb.d.ts index fa67ec01..d2d3a60a 100644 --- a/js/metalstack/api/v2/version_pb.d.ts +++ b/js/metalstack/api/v2/version_pb.d.ts @@ -58,7 +58,7 @@ export declare const VersionServiceGetRequestSchema: GenMessage & { /** - * Version contains the version of the application + * Version contains the version of the application. * * @generated from field: metalstack.api.v2.Version version = 1; */ diff --git a/js/metalstack/api/v2/version_pb.ts b/js/metalstack/api/v2/version_pb.ts index 1b6a1b8d..84102c78 100644 --- a/js/metalstack/api/v2/version_pb.ts +++ b/js/metalstack/api/v2/version_pb.ts @@ -79,7 +79,7 @@ export const VersionServiceGetRequestSchema: GenMessage & { /** - * Version contains the version of the application + * Version contains the version of the application. * * @generated from field: metalstack.api.v2.Version version = 1; */ diff --git a/js/metalstack/api/v2/vpn_pb.d.ts b/js/metalstack/api/v2/vpn_pb.d.ts index f2d83a5b..7687adc6 100644 --- a/js/metalstack/api/v2/vpn_pb.d.ts +++ b/js/metalstack/api/v2/vpn_pb.d.ts @@ -42,7 +42,7 @@ export type VPNNode = Message<"metalstack.api.v2.VPNNode"> & { */ lastSeen?: Timestamp | undefined; /** - * Online indicates if this node is online + * Online indicates if this node is online. * * @generated from field: bool online = 6; */ diff --git a/js/metalstack/api/v2/vpn_pb.ts b/js/metalstack/api/v2/vpn_pb.ts index 93a485d9..ad35be4b 100644 --- a/js/metalstack/api/v2/vpn_pb.ts +++ b/js/metalstack/api/v2/vpn_pb.ts @@ -58,7 +58,7 @@ export type VPNNode = Message<"metalstack.api.v2.VPNNode"> & { lastSeen?: Timestamp | undefined; /** - * Online indicates if this node is online + * Online indicates if this node is online. * * @generated from field: bool online = 6; */ diff --git a/js/metalstack/infra/v2/bmc_pb.d.ts b/js/metalstack/infra/v2/bmc_pb.d.ts index 12e8ca3d..94f4d543 100644 --- a/js/metalstack/infra/v2/bmc_pb.d.ts +++ b/js/metalstack/infra/v2/bmc_pb.d.ts @@ -12,13 +12,13 @@ export declare const file_metalstack_infra_v2_bmc: GenFile; */ export type UpdateBMCInfoRequest = Message<"metalstack.infra.v2.UpdateBMCInfoRequest"> & { /** - * Partition is the partition ID where metal-bmc wants to receive events + * Partition is the partition ID where metal-bmc wants to receive events. * * @generated from field: string partition = 1; */ partition: string; /** - * BmcReports maps the BMC report per machine UUID + * BmcReports maps the BMC report per machine UUID. * * @generated from field: map bmc_reports = 2; */ @@ -38,13 +38,13 @@ export declare const UpdateBMCInfoRequestSchema: GenMessage & { /** - * UpdatedMachines is a slice of machine UUIDs which were updated + * UpdatedMachines is a slice of machine UUIDs which were updated. * * @generated from field: repeated string updated_machines = 1; */ updatedMachines: string[]; /** - * CreatedMachines is a slice of machine UUIDs which were created + * CreatedMachines is a slice of machine UUIDs which were created. * * @generated from field: repeated string created_machines = 2; */ @@ -62,7 +62,7 @@ export declare const UpdateBMCInfoResponseSchema: GenMessage & { /** - * Partition is the partition ID where metal-bmc wants to receive BMC commands + * Partition is the partition ID where metal-bmc wants to receive BMC commands. * * @generated from field: string partition = 1; */ @@ -92,14 +92,14 @@ export type WaitForBMCCommandResponse = Message<"metalstack.infra.v2.WaitForBMCC */ bmcCommand: MachineBMCCommand; /** - * MachineBmc contains connection details of the machine to issue the BMC command to + * MachineBmc contains connection details of the machine to issue the BMC command to. * * @generated from field: metalstack.api.v2.MachineBMC machine_bmc = 3; */ machineBmc?: MachineBMC | undefined; /** - * CommandId is a unique ID which must be sent back after execution - * It is usually in the form: :machine-bmc-command: + * CommandId is a unique ID which must be sent back after execution. + * It is usually in the form: :machine-bmc-command:. * * @generated from field: string command_id = 4; */ @@ -117,8 +117,8 @@ export declare const WaitForBMCCommandResponseSchema: GenMessage & { /** - * CommandId is a unique ID which must be sent back after execution - * It is usually in the form: :machine-bmc-command + * CommandId is a unique ID which must be sent back after execution. + * It is usually in the form: :machine-bmc-command. * * @generated from field: string command_id = 1; */ diff --git a/js/metalstack/infra/v2/bmc_pb.ts b/js/metalstack/infra/v2/bmc_pb.ts index 29f41fb8..afc16acd 100644 --- a/js/metalstack/infra/v2/bmc_pb.ts +++ b/js/metalstack/infra/v2/bmc_pb.ts @@ -24,14 +24,14 @@ export const file_metalstack_infra_v2_bmc: GenFile = /*@__PURE__*/ */ export type UpdateBMCInfoRequest = Message<"metalstack.infra.v2.UpdateBMCInfoRequest"> & { /** - * Partition is the partition ID where metal-bmc wants to receive events + * Partition is the partition ID where metal-bmc wants to receive events. * * @generated from field: string partition = 1; */ partition: string; /** - * BmcReports maps the BMC report per machine UUID + * BmcReports maps the BMC report per machine UUID. * * @generated from field: map bmc_reports = 2; */ @@ -52,14 +52,14 @@ export const UpdateBMCInfoRequestSchema: GenMessage = /*@_ */ export type UpdateBMCInfoResponse = Message<"metalstack.infra.v2.UpdateBMCInfoResponse"> & { /** - * UpdatedMachines is a slice of machine UUIDs which were updated + * UpdatedMachines is a slice of machine UUIDs which were updated. * * @generated from field: repeated string updated_machines = 1; */ updatedMachines: string[]; /** - * CreatedMachines is a slice of machine UUIDs which were created + * CreatedMachines is a slice of machine UUIDs which were created. * * @generated from field: repeated string created_machines = 2; */ @@ -80,7 +80,7 @@ export const UpdateBMCInfoResponseSchema: GenMessage = /* */ export type WaitForBMCCommandRequest = Message<"metalstack.infra.v2.WaitForBMCCommandRequest"> & { /** - * Partition is the partition ID where metal-bmc wants to receive BMC commands + * Partition is the partition ID where metal-bmc wants to receive BMC commands. * * @generated from field: string partition = 1; */ @@ -115,15 +115,15 @@ export type WaitForBMCCommandResponse = Message<"metalstack.infra.v2.WaitForBMCC bmcCommand: MachineBMCCommand; /** - * MachineBmc contains connection details of the machine to issue the BMC command to + * MachineBmc contains connection details of the machine to issue the BMC command to. * * @generated from field: metalstack.api.v2.MachineBMC machine_bmc = 3; */ machineBmc?: MachineBMC | undefined; /** - * CommandId is a unique ID which must be sent back after execution - * It is usually in the form: :machine-bmc-command: + * CommandId is a unique ID which must be sent back after execution. + * It is usually in the form: :machine-bmc-command:. * * @generated from field: string command_id = 4; */ @@ -144,8 +144,8 @@ export const WaitForBMCCommandResponseSchema: GenMessage & { /** - * CommandId is a unique ID which must be sent back after execution - * It is usually in the form: :machine-bmc-command + * CommandId is a unique ID which must be sent back after execution. + * It is usually in the form: :machine-bmc-command. * * @generated from field: string command_id = 1; */ diff --git a/js/metalstack/infra/v2/boot_pb.d.ts b/js/metalstack/infra/v2/boot_pb.d.ts index 0355e944..1f1af233 100644 --- a/js/metalstack/infra/v2/boot_pb.d.ts +++ b/js/metalstack/infra/v2/boot_pb.d.ts @@ -6,7 +6,7 @@ import type { Message } from "@bufbuild/protobuf"; */ export declare const file_metalstack_infra_v2_boot: GenFile; /** - * BootServiceDhcpRequest is called once a machine issues a dhcp request + * BootServiceDhcpRequest is called once a machine issues a dhcp request. * * @generated from message metalstack.infra.v2.BootServiceDhcpRequest */ @@ -18,7 +18,7 @@ export type BootServiceDhcpRequest = Message<"metalstack.infra.v2.BootServiceDhc */ uuid: string; /** - * Partition where this machine is located + * Partition where this machine is located. * * @generated from field: string partition = 2; */ @@ -30,7 +30,7 @@ export type BootServiceDhcpRequest = Message<"metalstack.infra.v2.BootServiceDhc */ export declare const BootServiceDhcpRequestSchema: GenMessage; /** - * BootServiceDhcpResponse contains the response to a dhcp request + * BootServiceDhcpResponse contains the response to a dhcp request. * * @generated from message metalstack.infra.v2.BootServiceDhcpResponse */ @@ -41,7 +41,7 @@ export type BootServiceDhcpResponse = Message<"metalstack.infra.v2.BootServiceDh */ export declare const BootServiceDhcpResponseSchema: GenMessage; /** - * BootServiceBootRequest is called to get specified parameters to boot a machine with the given mac + * BootServiceBootRequest is called to get specified parameters to boot a machine with the given mac. * * @generated from message metalstack.infra.v2.BootServiceBootRequest */ @@ -53,7 +53,7 @@ export type BootServiceBootRequest = Message<"metalstack.infra.v2.BootServiceBoo */ mac: string; /** - * Partition where this machine is located + * Partition where this machine is located. * * @generated from field: string partition = 2; */ @@ -65,25 +65,25 @@ export type BootServiceBootRequest = Message<"metalstack.infra.v2.BootServiceBoo */ export declare const BootServiceBootRequestSchema: GenMessage; /** - * BootServiceBootResponse contains additional infos which are required to boot a machine + * BootServiceBootResponse contains additional infos which are required to boot a machine. * * @generated from message metalstack.infra.v2.BootServiceBootResponse */ export type BootServiceBootResponse = Message<"metalstack.infra.v2.BootServiceBootResponse"> & { /** - * Kernel is the url to the linux kernel to boot + * Kernel is the url to the linux kernel to boot. * * @generated from field: string kernel = 1; */ kernel: string; /** - * Initial ram disk is the url to the initial ram disk to boot + * Initial ram disk is the url to the initial ram disk to boot. * * @generated from field: repeated string init_ram_disks = 2; */ initRamDisks: string[]; /** - * CMDLine contains kernel command line parameters to boot + * CMDLine contains kernel command line parameters to boot. * * @generated from field: optional string cmdline = 3; */ @@ -95,7 +95,7 @@ export type BootServiceBootResponse = Message<"metalstack.infra.v2.BootServiceBo */ export declare const BootServiceBootResponseSchema: GenMessage; /** - * BootServiceRegisterRequest is called from metal-hammer to register a machine with as much hardware details as possible + * BootServiceRegisterRequest is called from metal-hammer to register a machine with as much hardware details as possible. * * @generated from message metalstack.infra.v2.BootServiceRegisterRequest */ @@ -137,13 +137,13 @@ export type BootServiceRegisterRequest = Message<"metalstack.infra.v2.BootServic */ tags: string[]; /** - * MetalHammer version this machine was booted into + * MetalHammer version this machine was booted into. * * @generated from field: string metal_hammer_version = 7; */ metalHammerVersion: string; /** - * Partition where this machine is located + * Partition where this machine is located. * * @generated from field: string partition = 8; */ @@ -167,7 +167,7 @@ export type BootServiceRegisterResponse = Message<"metalstack.infra.v2.BootServi */ uuid: string; /** - * Size is the calculated size from given hardware details + * Size is the calculated size from given hardware details. * * @generated from field: string size = 2; */ @@ -185,7 +185,7 @@ export type BootServiceRegisterResponse = Message<"metalstack.infra.v2.BootServi */ export declare const BootServiceRegisterResponseSchema: GenMessage; /** - * BootServiceWaitRequest is called when a machine was registered and is waiting for allocation + * BootServiceWaitRequest is called when a machine was registered and is waiting for allocation. * * @generated from message metalstack.infra.v2.BootServiceWaitRequest */ @@ -209,7 +209,7 @@ export declare const BootServiceWaitRequestSchema: GenMessage & { /** - * Allocation contains the machine.allocation to actually install the machine + * Allocation contains the machine.allocation to actually install the machine. * * @generated from field: metalstack.api.v2.MachineAllocation allocation = 1; */ @@ -221,7 +221,7 @@ export type BootServiceWaitResponse = Message<"metalstack.infra.v2.BootServiceWa */ export declare const BootServiceWaitResponseSchema: GenMessage; /** - * BootServiceInstallationSucceededRequest is sent from metal-hammer to the api to report the installation succeeded + * BootServiceInstallationSucceededRequest is sent from metal-hammer to the api to report the installation succeeded. * * @generated from message metalstack.infra.v2.BootServiceInstallationSucceededRequest */ @@ -245,7 +245,7 @@ export type BootServiceInstallationSucceededRequest = Message<"metalstack.infra. */ export declare const BootServiceInstallationSucceededRequestSchema: GenMessage; /** - * BootServiceInstallationSucceededResponse is the response to a BootServiceInstallationSucceededRequest + * BootServiceInstallationSucceededResponse is the response to a BootServiceInstallationSucceededRequest. * * @generated from message metalstack.infra.v2.BootServiceInstallationSucceededResponse */ @@ -286,7 +286,7 @@ export type BootServiceSuperUserPasswordResponse = Message<"metalstack.infra.v2. */ featureDisabled: boolean; /** - * SuperUserPassword is the password of the superuser on the ipmi device + * SuperUserPassword is the password of the superuser on the ipmi device. * * @generated from field: string super_user_password = 2; */ diff --git a/js/metalstack/infra/v2/boot_pb.ts b/js/metalstack/infra/v2/boot_pb.ts index 4b44f768..21b7bf77 100644 --- a/js/metalstack/infra/v2/boot_pb.ts +++ b/js/metalstack/infra/v2/boot_pb.ts @@ -18,7 +18,7 @@ export const file_metalstack_infra_v2_boot: GenFile = /*@__PURE__*/ fileDesc("Ch5tZXRhbHN0YWNrL2luZnJhL3YyL2Jvb3QucHJvdG8SE21ldGFsc3RhY2suaW5mcmEudjIiUAoWQm9vdFNlcnZpY2VEaGNwUmVxdWVzdBIWCgR1dWlkGAEgASgJQgi6SAVyA7ABARIeCglwYXJ0aXRpb24YAiABKAlCC7pICHIG0LOusQIBIhkKF0Jvb3RTZXJ2aWNlRGhjcFJlc3BvbnNlIlIKFkJvb3RTZXJ2aWNlQm9vdFJlcXVlc3QSGAoDbWFjGAEgASgJQgu6SAhyBrizrrECARIeCglwYXJ0aXRpb24YAiABKAlCC7pICHIG0LOusQIBIn0KF0Jvb3RTZXJ2aWNlQm9vdFJlc3BvbnNlEhsKBmtlcm5lbBgBIAEoCUILukgIcgbgs66xAgESFgoOaW5pdF9yYW1fZGlza3MYAiADKAkSIQoHY21kbGluZRgDIAEoCUILukgIcgbIs66xAgFIAIgBAUIKCghfY21kbGluZSLJAgoaQm9vdFNlcnZpY2VSZWdpc3RlclJlcXVlc3QSFgoEdXVpZBgBIAEoCUIIukgFcgOwAQESNAoIaGFyZHdhcmUYAiABKAsyIi5tZXRhbHN0YWNrLmFwaS52Mi5NYWNoaW5lSGFyZHdhcmUSLAoEYmlvcxgDIAEoCzIeLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVCaW9zEioKA2JtYxgEIAEoCzIdLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVCTUMSKgoDZnJ1GAUgASgLMh0ubWV0YWxzdGFjay5hcGkudjIuTWFjaGluZUZSVRIMCgR0YWdzGAYgAygJEikKFG1ldGFsX2hhbW1lcl92ZXJzaW9uGAcgASgJQgu6SAhyBsizrrECARIeCglwYXJ0aXRpb24YCCABKAlCC7pICHIG0LOusQIBInAKG0Jvb3RTZXJ2aWNlUmVnaXN0ZXJSZXNwb25zZRIWCgR1dWlkGAEgASgJQgi6SAVyA7ABARIZCgRzaXplGAIgASgJQgu6SAhyBsizrrECARIeCglwYXJ0aXRpb24YAyABKAlCC7pICHIG0LOusQIBIjAKFkJvb3RTZXJ2aWNlV2FpdFJlcXVlc3QSFgoEdXVpZBgBIAEoCUIIukgFcgOwAQEiUwoXQm9vdFNlcnZpY2VXYWl0UmVzcG9uc2USOAoKYWxsb2NhdGlvbhgBIAEoCzIkLm1ldGFsc3RhY2suYXBpLnYyLk1hY2hpbmVBbGxvY2F0aW9uImcKJ0Jvb3RTZXJ2aWNlSW5zdGFsbGF0aW9uU3VjY2VlZGVkUmVxdWVzdBIWCgR1dWlkGAEgASgJQgi6SAVyA7ABARIkChBjb25zb2xlX3Bhc3N3b3JkGAIgASgJQgq6SAdyBRACGIABIioKKEJvb3RTZXJ2aWNlSW5zdGFsbGF0aW9uU3VjY2VlZGVkUmVzcG9uc2UiPQojQm9vdFNlcnZpY2VTdXBlclVzZXJQYXNzd29yZFJlcXVlc3QSFgoEdXVpZBgBIAEoCUIIukgFcgOwAQEiaQokQm9vdFNlcnZpY2VTdXBlclVzZXJQYXNzd29yZFJlc3BvbnNlEhgKEGZlYXR1cmVfZGlzYWJsZWQYASABKAgSJwoTc3VwZXJfdXNlcl9wYXNzd29yZBgCIAEoCUIKukgHcgUQAhiAATKLBgoLQm9vdFNlcnZpY2USbAoERGhjcBIrLm1ldGFsc3RhY2suaW5mcmEudjIuQm9vdFNlcnZpY2VEaGNwUmVxdWVzdBosLm1ldGFsc3RhY2suaW5mcmEudjIuQm9vdFNlcnZpY2VEaGNwUmVzcG9uc2UiCeDzGALq8xgBARJsCgRCb290EisubWV0YWxzdGFjay5pbmZyYS52Mi5Cb290U2VydmljZUJvb3RSZXF1ZXN0GiwubWV0YWxzdGFjay5pbmZyYS52Mi5Cb290U2VydmljZUJvb3RSZXNwb25zZSIJ4PMYAurzGAEBEpMBChFTdXBlclVzZXJQYXNzd29yZBI4Lm1ldGFsc3RhY2suaW5mcmEudjIuQm9vdFNlcnZpY2VTdXBlclVzZXJQYXNzd29yZFJlcXVlc3QaOS5tZXRhbHN0YWNrLmluZnJhLnYyLkJvb3RTZXJ2aWNlU3VwZXJVc2VyUGFzc3dvcmRSZXNwb25zZSIJ4PMYAvLzGAEBEngKCFJlZ2lzdGVyEi8ubWV0YWxzdGFjay5pbmZyYS52Mi5Cb290U2VydmljZVJlZ2lzdGVyUmVxdWVzdBowLm1ldGFsc3RhY2suaW5mcmEudjIuQm9vdFNlcnZpY2VSZWdpc3RlclJlc3BvbnNlIgng8xgC8vMYAQESbgoEV2FpdBIrLm1ldGFsc3RhY2suaW5mcmEudjIuQm9vdFNlcnZpY2VXYWl0UmVxdWVzdBosLm1ldGFsc3RhY2suaW5mcmEudjIuQm9vdFNlcnZpY2VXYWl0UmVzcG9uc2UiCeDzGALy8xgBATABEp8BChVJbnN0YWxsYXRpb25TdWNjZWVkZWQSPC5tZXRhbHN0YWNrLmluZnJhLnYyLkJvb3RTZXJ2aWNlSW5zdGFsbGF0aW9uU3VjY2VlZGVkUmVxdWVzdBo9Lm1ldGFsc3RhY2suaW5mcmEudjIuQm9vdFNlcnZpY2VJbnN0YWxsYXRpb25TdWNjZWVkZWRSZXNwb25zZSIJ4PMYAvLzGAEBQs0BChdjb20ubWV0YWxzdGFjay5pbmZyYS52MkIJQm9vdFByb3RvUAFaOWdpdGh1Yi5jb20vbWV0YWwtc3RhY2svYXBpL2dvL21ldGFsc3RhY2svaW5mcmEvdjI7aW5mcmF2MqICA01JWKoCE01ldGFsc3RhY2suSW5mcmEuVjLKAhNNZXRhbHN0YWNrXEluZnJhXFYy4gIfTWV0YWxzdGFja1xJbmZyYVxWMlxHUEJNZXRhZGF0YeoCFU1ldGFsc3RhY2s6OkluZnJhOjpWMmIGcHJvdG8z", [file_buf_validate_validate, file_metalstack_api_v2_common, file_metalstack_api_v2_machine, file_metalstack_api_v2_predefined_rules]); /** - * BootServiceDhcpRequest is called once a machine issues a dhcp request + * BootServiceDhcpRequest is called once a machine issues a dhcp request. * * @generated from message metalstack.infra.v2.BootServiceDhcpRequest */ @@ -31,7 +31,7 @@ export type BootServiceDhcpRequest = Message<"metalstack.infra.v2.BootServiceDhc uuid: string; /** - * Partition where this machine is located + * Partition where this machine is located. * * @generated from field: string partition = 2; */ @@ -46,7 +46,7 @@ export const BootServiceDhcpRequestSchema: GenMessage = messageDesc(file_metalstack_infra_v2_boot, 0); /** - * BootServiceDhcpResponse contains the response to a dhcp request + * BootServiceDhcpResponse contains the response to a dhcp request. * * @generated from message metalstack.infra.v2.BootServiceDhcpResponse */ @@ -61,7 +61,7 @@ export const BootServiceDhcpResponseSchema: GenMessage messageDesc(file_metalstack_infra_v2_boot, 1); /** - * BootServiceBootRequest is called to get specified parameters to boot a machine with the given mac + * BootServiceBootRequest is called to get specified parameters to boot a machine with the given mac. * * @generated from message metalstack.infra.v2.BootServiceBootRequest */ @@ -74,7 +74,7 @@ export type BootServiceBootRequest = Message<"metalstack.infra.v2.BootServiceBoo mac: string; /** - * Partition where this machine is located + * Partition where this machine is located. * * @generated from field: string partition = 2; */ @@ -89,27 +89,27 @@ export const BootServiceBootRequestSchema: GenMessage = messageDesc(file_metalstack_infra_v2_boot, 2); /** - * BootServiceBootResponse contains additional infos which are required to boot a machine + * BootServiceBootResponse contains additional infos which are required to boot a machine. * * @generated from message metalstack.infra.v2.BootServiceBootResponse */ export type BootServiceBootResponse = Message<"metalstack.infra.v2.BootServiceBootResponse"> & { /** - * Kernel is the url to the linux kernel to boot + * Kernel is the url to the linux kernel to boot. * * @generated from field: string kernel = 1; */ kernel: string; /** - * Initial ram disk is the url to the initial ram disk to boot + * Initial ram disk is the url to the initial ram disk to boot. * * @generated from field: repeated string init_ram_disks = 2; */ initRamDisks: string[]; /** - * CMDLine contains kernel command line parameters to boot + * CMDLine contains kernel command line parameters to boot. * * @generated from field: optional string cmdline = 3; */ @@ -124,7 +124,7 @@ export const BootServiceBootResponseSchema: GenMessage messageDesc(file_metalstack_infra_v2_boot, 3); /** - * BootServiceRegisterRequest is called from metal-hammer to register a machine with as much hardware details as possible + * BootServiceRegisterRequest is called from metal-hammer to register a machine with as much hardware details as possible. * * @generated from message metalstack.infra.v2.BootServiceRegisterRequest */ @@ -172,14 +172,14 @@ export type BootServiceRegisterRequest = Message<"metalstack.infra.v2.BootServic tags: string[]; /** - * MetalHammer version this machine was booted into + * MetalHammer version this machine was booted into. * * @generated from field: string metal_hammer_version = 7; */ metalHammerVersion: string; /** - * Partition where this machine is located + * Partition where this machine is located. * * @generated from field: string partition = 8; */ @@ -207,7 +207,7 @@ export type BootServiceRegisterResponse = Message<"metalstack.infra.v2.BootServi uuid: string; /** - * Size is the calculated size from given hardware details + * Size is the calculated size from given hardware details. * * @generated from field: string size = 2; */ @@ -229,7 +229,7 @@ export const BootServiceRegisterResponseSchema: GenMessage = */ export type BootServiceWaitResponse = Message<"metalstack.infra.v2.BootServiceWaitResponse"> & { /** - * Allocation contains the machine.allocation to actually install the machine + * Allocation contains the machine.allocation to actually install the machine. * * @generated from field: metalstack.api.v2.MachineAllocation allocation = 1; */ @@ -271,7 +271,7 @@ export const BootServiceWaitResponseSchema: GenMessage messageDesc(file_metalstack_infra_v2_boot, 7); /** - * BootServiceInstallationSucceededRequest is sent from metal-hammer to the api to report the installation succeeded + * BootServiceInstallationSucceededRequest is sent from metal-hammer to the api to report the installation succeeded. * * @generated from message metalstack.infra.v2.BootServiceInstallationSucceededRequest */ @@ -299,7 +299,7 @@ export const BootServiceInstallationSucceededRequestSchema: GenMessage & { /** - * Type defines which service is actually pinging + * Type defines which service is actually pinging. * * @generated from field: metalstack.api.v2.ComponentType type = 1; */ type: ComponentType; /** - * Identifier is a unique identifier of this service, for example if two instances are running, this might be the pod ID + * Identifier is a unique identifier of this service, for example if two instances are running, this might be the pod ID. * * @generated from field: string identifier = 2; */ identifier: string; /** - * StartedAt is the timestamp this service was started + * StartedAt is the timestamp this service was started. * * @generated from field: google.protobuf.Timestamp started_at = 3; */ diff --git a/js/metalstack/infra/v2/component_pb.ts b/js/metalstack/infra/v2/component_pb.ts index d3f4a703..f546f6d6 100644 --- a/js/metalstack/infra/v2/component_pb.ts +++ b/js/metalstack/infra/v2/component_pb.ts @@ -28,21 +28,21 @@ export const file_metalstack_infra_v2_component: GenFile = /*@__PURE__*/ */ export type ComponentServicePingRequest = Message<"metalstack.infra.v2.ComponentServicePingRequest"> & { /** - * Type defines which service is actually pinging + * Type defines which service is actually pinging. * * @generated from field: metalstack.api.v2.ComponentType type = 1; */ type: ComponentType; /** - * Identifier is a unique identifier of this service, for example if two instances are running, this might be the pod ID + * Identifier is a unique identifier of this service, for example if two instances are running, this might be the pod ID. * * @generated from field: string identifier = 2; */ identifier: string; /** - * StartedAt is the timestamp this service was started + * StartedAt is the timestamp this service was started. * * @generated from field: google.protobuf.Timestamp started_at = 3; */ diff --git a/js/metalstack/infra/v2/event_pb.d.ts b/js/metalstack/infra/v2/event_pb.d.ts index c9f16e41..35eba160 100644 --- a/js/metalstack/infra/v2/event_pb.d.ts +++ b/js/metalstack/infra/v2/event_pb.d.ts @@ -38,7 +38,7 @@ export type EventServiceSendResponse = Message<"metalstack.infra.v2.EventService */ events: bigint; /** - * 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. * * @generated from field: repeated string failed = 2; */ diff --git a/js/metalstack/infra/v2/event_pb.ts b/js/metalstack/infra/v2/event_pb.ts index 13d06db1..a3fe8436 100644 --- a/js/metalstack/infra/v2/event_pb.ts +++ b/js/metalstack/infra/v2/event_pb.ts @@ -50,7 +50,7 @@ export type EventServiceSendResponse = Message<"metalstack.infra.v2.EventService events: bigint; /** - * 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. * * @generated from field: repeated string failed = 2; */ diff --git a/js/metalstack/infra/v2/switch_pb.d.ts b/js/metalstack/infra/v2/switch_pb.d.ts index 20bf265c..c93f0a72 100644 --- a/js/metalstack/infra/v2/switch_pb.d.ts +++ b/js/metalstack/infra/v2/switch_pb.d.ts @@ -31,7 +31,7 @@ export declare const SwitchServiceGetRequestSchema: GenMessage & { /** - * Switch contains the requested switch + * Switch contains the requested switch. * * @generated from field: metalstack.api.v2.Switch switch = 1; */ @@ -67,7 +67,7 @@ export declare const SwitchServiceRegisterRequestSchema: GenMessage & { /** - * Switch contains the registered switch + * Switch contains the registered switch. * * @generated from field: metalstack.api.v2.Switch switch = 1; */ @@ -103,7 +103,7 @@ export type SwitchServiceHeartbeatRequest = Message<"metalstack.infra.v2.SwitchS */ error?: string | undefined; /** - * PortStates maps port identifiers to the respective port's operational state + * PortStates maps port identifiers to the respective port's operational state. * * @generated from field: map port_states = 4; */ @@ -111,7 +111,7 @@ export type SwitchServiceHeartbeatRequest = Message<"metalstack.infra.v2.SwitchS [key: string]: SwitchPortStatus; }; /** - * BgpPortStates maps port identifiers to the respective port's BGP state + * BgpPortStates maps port identifiers to the respective port's BGP state. * * @generated from field: map bgp_port_states = 5; */ @@ -137,13 +137,13 @@ export type SwitchServiceHeartbeatResponse = Message<"metalstack.infra.v2.Switch */ id: string; /** - * LastSync holds information about the last sync + * LastSync holds information about the last sync. * * @generated from field: metalstack.api.v2.SwitchSync last_sync = 2; */ lastSync?: SwitchSync | undefined; /** - * LastSyncError holds information about the last erroneous sync + * LastSyncError holds information about the last erroneous sync. * * @generated from field: metalstack.api.v2.SwitchSync last_sync_error = 3; */ diff --git a/js/metalstack/infra/v2/switch_pb.ts b/js/metalstack/infra/v2/switch_pb.ts index af721b8a..7425ef70 100644 --- a/js/metalstack/infra/v2/switch_pb.ts +++ b/js/metalstack/infra/v2/switch_pb.ts @@ -47,7 +47,7 @@ export const SwitchServiceGetRequestSchema: GenMessage */ export type SwitchServiceGetResponse = Message<"metalstack.infra.v2.SwitchServiceGetResponse"> & { /** - * Switch contains the requested switch + * Switch contains the requested switch. * * @generated from field: metalstack.api.v2.Switch switch = 1; */ @@ -89,7 +89,7 @@ export const SwitchServiceRegisterRequestSchema: GenMessage & { /** - * Switch contains the registered switch + * Switch contains the registered switch. * * @generated from field: metalstack.api.v2.Switch switch = 1; */ @@ -131,14 +131,14 @@ export type SwitchServiceHeartbeatRequest = Message<"metalstack.infra.v2.SwitchS error?: string | undefined; /** - * PortStates maps port identifiers to the respective port's operational state + * PortStates maps port identifiers to the respective port's operational state. * * @generated from field: map port_states = 4; */ portStates: { [key: string]: SwitchPortStatus }; /** - * BgpPortStates maps port identifiers to the respective port's BGP state + * BgpPortStates maps port identifiers to the respective port's BGP state. * * @generated from field: map bgp_port_states = 5; */ @@ -166,14 +166,14 @@ export type SwitchServiceHeartbeatResponse = Message<"metalstack.infra.v2.Switch id: string; /** - * LastSync holds information about the last sync + * LastSync holds information about the last sync. * * @generated from field: metalstack.api.v2.SwitchSync last_sync = 2; */ lastSync?: SwitchSync | undefined; /** - * LastSyncError holds information about the last erroneous sync + * LastSyncError holds information about the last erroneous sync. * * @generated from field: metalstack.api.v2.SwitchSync last_sync_error = 3; */ diff --git a/js/test-interceptor.d.ts b/js/test-interceptor.d.ts new file mode 100644 index 00000000..bf9185e3 --- /dev/null +++ b/js/test-interceptor.d.ts @@ -0,0 +1,9 @@ +import type { Interceptor, UnaryResponse } from "@connectrpc/connect"; +import type { DescMessage, MessageShape } from "@bufbuild/protobuf"; +export type ClientCall = { + wantRequest: MessageShape; + wantRequestSchema: Req; + wantResponse?: () => UnaryResponse; + wantError?: Error; +}; +export declare function newTestInterceptor(calls: ClientCall[]): Interceptor; diff --git a/js/test-interceptor.js b/js/test-interceptor.js new file mode 100644 index 00000000..0dcfac46 --- /dev/null +++ b/js/test-interceptor.js @@ -0,0 +1,33 @@ +var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) { + function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); } + return new (P || (P = Promise))(function (resolve, reject) { + function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } } + function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } } + function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); } + step((generator = generator.apply(thisArg, _arguments || [])).next()); + }); +}; +import { equals } from "@bufbuild/protobuf"; +export function newTestInterceptor(calls) { + let count = 0; + return (next) => (req) => __awaiter(this, void 0, void 0, function* () { + var _a, _b; + var _c; + const reqAny = req; + const expected = calls[count]; + if (!expected) { + throw new Error(`received an unexpected client call of type ${(_c = (_b = (_a = reqAny.method) === null || _a === void 0 ? void 0 : _a.input) === null || _b === void 0 ? void 0 : _b.typeName) !== null && _c !== void 0 ? _c : "unknown"}`); + } + count++; + if (!equals(expected.wantRequestSchema, reqAny.message, expected.wantRequest)) { + throw new Error(`request mismatch for call #${count - 1}: got ${JSON.stringify(reqAny.message)}`); + } + if (expected.wantError) { + throw expected.wantError; + } + if (expected.wantResponse) { + return expected.wantResponse(); + } + throw new Error(`no wantResponse or wantError configured for call #${count - 1}`); + }); +} diff --git a/package.json b/package.json index 404118c2..82d871d0 100644 --- a/package.json +++ b/package.json @@ -14,6 +14,7 @@ "@connectrpc/connect-web": "^2.1.2" }, "devDependencies": { + "@types/bun": "^1.3.14", "typescript": "^7.0.2" }, "files": [ diff --git a/proto/metalstack/admin/v2/audit.proto b/proto/metalstack/admin/v2/audit.proto index 8c7af842..664feabf 100644 --- a/proto/metalstack/admin/v2/audit.proto +++ b/proto/metalstack/admin/v2/audit.proto @@ -24,13 +24,13 @@ service AuditService { // AuditServiceListRequest is the request payload for listing audit traces. message AuditServiceListRequest { - // Query for audit traces + // Query for audit traces. metalstack.api.v2.AuditQuery query = 1; } // AuditServiceListResponse is the response payload for listing audit traces. message AuditServiceListResponse { - // Traces contains the list of audit traces + // Traces contains the list of audit traces. repeated metalstack.api.v2.AuditTrace traces = 1; } @@ -38,12 +38,12 @@ message AuditServiceListResponse { message AuditServiceGetRequest { // Uuid of the audit trace string uuid = 1 [(buf.validate.field).string.uuid = true]; - // Phase specifies the audit phase. Defaults to request + // Phase specifies the audit phase. Defaults to request. optional metalstack.api.v2.AuditPhase phase = 2 [(buf.validate.field).enum.defined_only = true]; } // AuditServiceGetResponse is the response payload for getting an audit trace. message AuditServiceGetResponse { - // Trace is the audit trace + // Trace is the audit trace. metalstack.api.v2.AuditTrace trace = 1; } diff --git a/proto/metalstack/admin/v2/component.proto b/proto/metalstack/admin/v2/component.proto index 26a7b2ee..e026bf2f 100644 --- a/proto/metalstack/admin/v2/component.proto +++ b/proto/metalstack/admin/v2/component.proto @@ -29,36 +29,36 @@ service ComponentService { // ComponentServiceListRequest is the request payload for listing components. message ComponentServiceListRequest { - // Query filters components + // Query filters components. metalstack.api.v2.ComponentQuery query = 1; } // ComponentServiceListResponse is the response payload for listing components. message ComponentServiceListResponse { - // Components contains the list of components + // Components contains the list of components. repeated metalstack.api.v2.Component components = 1; } // ComponentServiceGetRequest is the request payload for getting a component. message ComponentServiceGetRequest { - // UUID identifies the component to get + // UUID identifies the component to get. string uuid = 1 [(buf.validate.field).string.uuid = true]; } // ComponentServiceGetResponse is the response payload for getting a component. message ComponentServiceGetResponse { - // Component contains the retrieved component + // Component contains the retrieved component. metalstack.api.v2.Component component = 1; } // ComponentServiceDeleteRequest is the request payload for deleting a component. message ComponentServiceDeleteRequest { - // UUID identifies the component to delete + // UUID identifies the component to delete. string uuid = 1 [(buf.validate.field).string.uuid = true]; } // ComponentServiceDeleteResponse is the response payload for deleting a component. message ComponentServiceDeleteResponse { - // Component contains the deleted component + // Component contains the deleted component. metalstack.api.v2.Component component = 1; } diff --git a/proto/metalstack/admin/v2/filesystem.proto b/proto/metalstack/admin/v2/filesystem.proto index 6353bd5a..17c0a0b9 100644 --- a/proto/metalstack/admin/v2/filesystem.proto +++ b/proto/metalstack/admin/v2/filesystem.proto @@ -34,13 +34,13 @@ service FilesystemService { // FilesystemServiceCreateRequest is the request payload for creating a filesystem. message FilesystemServiceCreateRequest { - // FilesystemLayout is the filesystem layout to create + // FilesystemLayout is the filesystem layout to create. metalstack.api.v2.FilesystemLayout filesystem_layout = 1; } // FilesystemServiceCreateResponse is the response payload for creating a filesystem. message FilesystemServiceCreateResponse { - // FilesystemLayout contains the created filesystem layout + // FilesystemLayout contains the created filesystem layout. metalstack.api.v2.FilesystemLayout filesystem_layout = 1; } @@ -48,21 +48,21 @@ message FilesystemServiceCreateResponse { message FilesystemServiceUpdateRequest { // Id of this filesystemLayout string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // 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. metalstack.api.v2.UpdateMeta update_meta = 2 [(buf.validate.field).required = true]; // Name of this filesystemLayout optional string name = 3 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // Description of this filesystemLayout optional string description = 4 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Filesystems is a list of filesystems to create on a machine + // Filesystems is a list of filesystems to create on a machine. repeated metalstack.api.v2.Filesystem filesystems = 5; - // Disks list of disks that belong to this layout + // Disks list of disks that belong to this layout. repeated metalstack.api.v2.Disk disks = 6; // Raid arrays to create repeated metalstack.api.v2.Raid raid = 7; - // VolumeGroups list of volumegroups to create + // VolumeGroups list of volumegroups to create. repeated metalstack.api.v2.VolumeGroup volume_groups = 8; - // LogicalVolumes list of logicalvolumes to create + // LogicalVolumes list of logicalvolumes to create. repeated metalstack.api.v2.LogicalVolume logical_volumes = 9; // Constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts metalstack.api.v2.FilesystemLayoutConstraints constraints = 10; @@ -70,7 +70,7 @@ message FilesystemServiceUpdateRequest { // FilesystemServiceUpdateResponse is the response payload for updating a filesystem. message FilesystemServiceUpdateResponse { - // FilesystemLayout contains the updated filesystem layout + // FilesystemLayout contains the updated filesystem layout. metalstack.api.v2.FilesystemLayout filesystem_layout = 1; } @@ -82,13 +82,13 @@ message FilesystemServiceDeleteRequest { // FilesystemServiceDeleteResponse is the response payload for deleting a filesystem. message FilesystemServiceDeleteResponse { - // FilesystemLayout contains the deleted filesystem layout + // FilesystemLayout contains the deleted filesystem layout. metalstack.api.v2.FilesystemLayout filesystem_layout = 1; } // FilesystemServiceMatchRequest message FilesystemServiceMatchRequest { - // Match size and image to a filesystem layout + // Match size and image to a filesystem layout. // or match a machine to a filesystem layout oneof match { // ensure at least one match is specified diff --git a/proto/metalstack/admin/v2/image.proto b/proto/metalstack/admin/v2/image.proto index 92ded52b..5d61bfe9 100644 --- a/proto/metalstack/admin/v2/image.proto +++ b/proto/metalstack/admin/v2/image.proto @@ -35,13 +35,13 @@ service ImageService { // ImageServiceCreateRequest is the request payload for creating an image. message ImageServiceCreateRequest { - // Image is the image to create + // Image is the image to create. metalstack.api.v2.Image image = 1; } // ImageServiceCreateResponse is the response payload for creating an image. message ImageServiceCreateResponse { - // Image contains the created image + // Image contains the created image. metalstack.api.v2.Image image = 1; } @@ -49,7 +49,7 @@ message ImageServiceCreateResponse { message ImageServiceUpdateRequest { // Id of this image string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // 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. metalstack.api.v2.UpdateMeta update_meta = 2 [(buf.validate.field).required = true]; // URL where this image is located optional string url = 3 [(buf.validate.field).string.(metalstack.api.v2.is_uri) = true]; @@ -67,7 +67,7 @@ message ImageServiceUpdateRequest { // Classification of this image metalstack.api.v2.ImageClassification classification = 7 [(buf.validate.field).enum.defined_only = true]; - // ExpiresAt indicates that usage is not possible after this date + // ExpiresAt indicates that usage is not possible after this date. google.protobuf.Timestamp expires_at = 8; // Labels to update on this image optional metalstack.api.v2.UpdateLabels labels = 9; @@ -75,7 +75,7 @@ message ImageServiceUpdateRequest { // ImageServiceUpdateResponse is the response payload for updating an image. message ImageServiceUpdateResponse { - // Image contains the updated image + // Image contains the updated image. metalstack.api.v2.Image image = 1; } @@ -87,18 +87,18 @@ message ImageServiceDeleteRequest { // ImageServiceDeleteResponse is the response payload for deleting an image. message ImageServiceDeleteResponse { - // Image contains the deleted image + // Image contains the deleted image. metalstack.api.v2.Image image = 1; } // ImageServiceUsageRequest is the request payload for getting image usage. message ImageServiceUsageRequest { - // Query for which images the usage should be reported + // Query for which images the usage should be reported. metalstack.api.v2.ImageQuery query = 1; } // ImageServiceUsageResponse is the response payload for getting image usage. message ImageServiceUsageResponse { - // Images contains usage information + // Images contains usage information. repeated metalstack.api.v2.ImageUsage image_usage = 1; } diff --git a/proto/metalstack/admin/v2/ip.proto b/proto/metalstack/admin/v2/ip.proto index ab102aab..982e7881 100644 --- a/proto/metalstack/admin/v2/ip.proto +++ b/proto/metalstack/admin/v2/ip.proto @@ -17,12 +17,12 @@ service IPService { // IPServiceListRequest is the request payload for listing IP addresses. message IPServiceListRequest { - // Query to search for IP addresses + // Query to search for IP addresses. metalstack.api.v2.IPQuery query = 1; } // IPServiceListResponse is the response payload for listing IP addresses. message IPServiceListResponse { - // IPs contains the list of IP addresses + // IPs contains the list of IP addresses. repeated metalstack.api.v2.IP ips = 1; } diff --git a/proto/metalstack/admin/v2/machine.proto b/proto/metalstack/admin/v2/machine.proto index a027d4cb..0244729e 100644 --- a/proto/metalstack/admin/v2/machine.proto +++ b/proto/metalstack/admin/v2/machine.proto @@ -54,7 +54,7 @@ service MachineService { option (metalstack.api.v2.admin_roles) = ADMIN_ROLE_EDITOR; option (metalstack.api.v2.auditing) = AUDITING_INCLUDED; } - // Issues allows to query issues of machines + // Issues allows to query issues of machines. rpc Issues(MachineServiceIssuesRequest) returns (MachineServiceIssuesResponse) { option (metalstack.api.v2.admin_roles) = ADMIN_ROLE_EDITOR; option (metalstack.api.v2.admin_roles) = ADMIN_ROLE_VIEWER; @@ -64,46 +64,46 @@ service MachineService { // ------------------------ Service Messages ---------------------------------- -// MachineServiceGetRequest is the request payload for a machine get request +// MachineServiceGetRequest is the request payload for a machine get request. message MachineServiceGetRequest { // UUID of the machine to get string uuid = 1 [(buf.validate.field).string.uuid = true]; } -// MachineServiceGetResponse is the response payload for a machine get request +// MachineServiceGetResponse is the response payload for a machine get request. message MachineServiceGetResponse { - // Machine is the machine requested + // Machine is the machine requested. metalstack.api.v2.Machine machine = 1; } -// MachineServiceListRequest is the request payload for a machine list request +// MachineServiceListRequest is the request payload for a machine list request. message MachineServiceListRequest { - // Query to list one or more machines + // Query to list one or more machines. metalstack.api.v2.MachineQuery query = 1; // Partition for which machines should be listed, could be left empty if only one partition is present // otherwise an error is thrown that the partition must be specified optional string partition = 2 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; } -// MachineServiceListResponse is the response payload for a machine list request +// MachineServiceListResponse is the response payload for a machine list request. message MachineServiceListResponse { - // Machines are the machines requested by a list request + // Machines are the machines requested by a list request. repeated metalstack.api.v2.Machine machines = 1; } -// MachineServiceDeleteRequest is the request payload for a machine delete request +// MachineServiceDeleteRequest is the request payload for a machine delete request. message MachineServiceDeleteRequest { // UUID of the machine to permanently delete string uuid = 1 [(buf.validate.field).string.uuid = true]; } -// MachineServiceDeleteResponse is the response payload for a machine delete request +// MachineServiceDeleteResponse is the response payload for a machine delete request. message MachineServiceDeleteResponse { - // Machine is the machine permanently deleted + // Machine is the machine permanently deleted. metalstack.api.v2.Machine machine = 1; } -// MachineServiceBMCCommandRequest is the request payload for a machine bmc command +// MachineServiceBMCCommandRequest is the request payload for a machine bmc command. message MachineServiceBMCCommandRequest { // UUID of the machine to send the command to string uuid = 1 [(buf.validate.field).string.uuid = true]; @@ -111,32 +111,32 @@ message MachineServiceBMCCommandRequest { metalstack.api.v2.MachineBMCCommand command = 2 [(buf.validate.field).enum.defined_only = true]; } -// MachineServiceBMCCommandResponse is the response payload for a machine bmc command +// MachineServiceBMCCommandResponse is the response payload for a machine bmc command. message MachineServiceBMCCommandResponse {} -// MachineServiceGetBMCRequest is the request payload for a machine getbmc request +// MachineServiceGetBMCRequest is the request payload for a machine getbmc request. message MachineServiceGetBMCRequest { // UUID of the machine to get string uuid = 1 [(buf.validate.field).string.uuid = true]; } -// MachineServiceGetBMCResponse is the response payload for a machine getbmc request +// MachineServiceGetBMCResponse is the response payload for a machine getbmc request. message MachineServiceGetBMCResponse { // UUID of the machine string uuid = 1 [(buf.validate.field).string.uuid = true]; - // BMC contains the BMC details of this machine + // BMC contains the BMC details of this machine. metalstack.api.v2.MachineBMCReport bmc = 2; } -// MachineServiceListBMCRequest is the request payload for a machine listbmc request +// MachineServiceListBMCRequest is the request payload for a machine listbmc request. message MachineServiceListBMCRequest { - // Query to list one or more BMCs of many machines + // Query to list one or more BMCs of many machines. metalstack.api.v2.MachineBMCQuery query = 1; } -// MachineServiceListBMCResponse is the response payload for a machine listbmc request +// MachineServiceListBMCResponse is the response payload for a machine listbmc request. message MachineServiceListBMCResponse { - // BMCReports maps the bmc report per machine uuid + // BMCReports maps the bmc report per machine uuid. map bmc_reports = 1 [(buf.validate.field).map = { keys: { string: {uuid: true} @@ -148,8 +148,8 @@ message MachineServiceListBMCResponse { message MachineServiceConsolePasswordRequest { // UUID of the machine to get string uuid = 1 [(buf.validate.field).string.uuid = true]; - // Reason must be provided why access to the console is requested - // Reason is only forwarded to an audit sink + // Reason must be provided why access to the console is requested. + // Reason is only forwarded to an audit sink. string reason = 2 [ (buf.validate.field).string.min_len = 10, (buf.validate.field).string.max_len = 512 @@ -164,7 +164,7 @@ message MachineServiceConsolePasswordResponse { string password = 2; } -// MachineServiceSetStateRequest is the request payload for a machine set state request +// MachineServiceSetStateRequest is the request payload for a machine set state request. message MachineServiceSetStateRequest { // UUID of the machine to set the state to string uuid = 1 [(buf.validate.field).string.uuid = true]; @@ -175,20 +175,20 @@ message MachineServiceSetStateRequest { string description = 3 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; } -// MachineServiceSetStateResponse is the response payload for a machine set state request +// MachineServiceSetStateResponse is the response payload for a machine set state request. message MachineServiceSetStateResponse { // Machine with the changed state. metalstack.api.v2.Machine machine = 1; } -// MachineServiceIssuesRequest is the request payload for a machine issues request +// MachineServiceIssuesRequest is the request payload for a machine issues request. message MachineServiceIssuesRequest { - // Query which machine issues to include + // Query which machine issues to include. metalstack.api.v2.MachineIssuesQuery query = 1; } -// MachineServiceIssuesResponse is the response payload for a machine issues request +// MachineServiceIssuesResponse is the response payload for a machine issues request. message MachineServiceIssuesResponse { - // Issues is the result of the issues query + // Issues is the result of the issues query. repeated metalstack.api.v2.MachineIssues issues = 1; } diff --git a/proto/metalstack/admin/v2/network.proto b/proto/metalstack/admin/v2/network.proto index 9485fa0a..d82240ab 100644 --- a/proto/metalstack/admin/v2/network.proto +++ b/proto/metalstack/admin/v2/network.proto @@ -46,7 +46,7 @@ message NetworkServiceGetRequest { // NetworkServiceGetResponse is the response payload for getting a network. message NetworkServiceGetResponse { - // Network contains the requested network + // Network contains the requested network. metalstack.api.v2.Network network = 1; } @@ -58,9 +58,9 @@ message NetworkServiceCreateRequest { optional string name = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // Description of this network optional string description = 3 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Partition where this network will be created + // Partition where this network will be created. optional string partition = 4 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; - // Project where this network belongs to + // Project where this network belongs to. optional string project = 5 [(buf.validate.field).string.uuid = true]; // Type of the network to create metalstack.api.v2.NetworkType type = 6 [(buf.validate.field).enum.defined_only = true]; @@ -70,17 +70,17 @@ message NetworkServiceCreateRequest { repeated string prefixes = 8 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; // Destination Prefixes in this network repeated string destination_prefixes = 9 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; - // Default Child Prefix length defines the bitlength of a child network created per addressfamily, if not specified during the allocate request + // Default Child Prefix length defines the bitlength of a child network created per addressfamily, if not specified during the allocate request. metalstack.api.v2.ChildPrefixLength default_child_prefix_length = 10; - // Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length + // Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length. metalstack.api.v2.ChildPrefixLength min_child_prefix_length = 11; // NATType of this network optional metalstack.api.v2.NATType nat_type = 12 [(buf.validate.field).enum.defined_only = true]; // VRF of this network has this VNI optional uint32 vrf = 13; - // Parent Network points to the id of the parent network if any + // Parent Network points to the id of the parent network if any. optional string parent_network = 14 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced + // AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced. repeated string additional_announcable_cidrs = 15 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; // Length per addressfamily optional metalstack.api.v2.ChildPrefixLength length = 16; @@ -92,7 +92,7 @@ message NetworkServiceCreateRequest { message NetworkServiceUpdateRequest { // Id of this network string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // 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. metalstack.api.v2.UpdateMeta update_meta = 2 [(buf.validate.field).required = true]; // Name of this network optional string name = 3 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; @@ -104,13 +104,13 @@ message NetworkServiceUpdateRequest { repeated string prefixes = 6 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; // Destination Prefixes in this network repeated string destination_prefixes = 7 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; - // Default Child Prefix length defines the bit length of a child network created per addressfamily, if 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. optional metalstack.api.v2.ChildPrefixLength default_child_prefix_length = 8; - // Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length + // Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length. optional metalstack.api.v2.ChildPrefixLength min_child_prefix_length = 9; // NATType of this network optional metalstack.api.v2.NATType nat_type = 10 [(buf.validate.field).enum.defined_only = true]; - // AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced + // AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced. repeated string additional_announcable_cidrs = 11 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; // Force update, prevents accidental removal of additional_announcable_cidrs which will destroy your dataplane. @@ -125,30 +125,30 @@ message NetworkServiceDeleteRequest { // NetworkServiceListRequest is the request payload for listing networks. message NetworkServiceListRequest { - // Query specifies which networks to return + // Query specifies which networks to return. metalstack.api.v2.NetworkQuery query = 1; } // NetworkServiceCreateResponse is the response payload for creating a network. message NetworkServiceCreateResponse { - // Network contains the created network + // Network contains the created network. metalstack.api.v2.Network network = 1; } // NetworkServiceUpdateResponse is the response payload for updating a network. message NetworkServiceUpdateResponse { - // Network contains the updated network + // Network contains the updated network. metalstack.api.v2.Network network = 1; } // NetworkServiceDeleteResponse is the response payload for deleting a network. message NetworkServiceDeleteResponse { - // Network contains the deleted network + // Network contains the deleted network. metalstack.api.v2.Network network = 1; } // NetworkServiceListResponse is the response payload for listing networks. message NetworkServiceListResponse { - // Networks contains the list of networks + // Networks contains the list of networks. repeated metalstack.api.v2.Network networks = 1; } diff --git a/proto/metalstack/admin/v2/partition.proto b/proto/metalstack/admin/v2/partition.proto index 21025a34..c2bef06d 100644 --- a/proto/metalstack/admin/v2/partition.proto +++ b/proto/metalstack/admin/v2/partition.proto @@ -32,7 +32,7 @@ service PartitionService { } } -// PartitionServiceCreateRequest is the request payload for a partition create request +// PartitionServiceCreateRequest is the request payload for a partition create request. message PartitionServiceCreateRequest { // Partition the partition metalstack.api.v2.Partition partition = 1; @@ -42,36 +42,36 @@ message PartitionServiceCreateRequest { message PartitionServiceUpdateRequest { // ID of this partition string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; - // 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. metalstack.api.v2.UpdateMeta update_meta = 2 [(buf.validate.field).required = true]; // Description of this partition optional string description = 3 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // PartitionBootConfiguration defines how metal-hammer boots + // PartitionBootConfiguration defines how metal-hammer boots. metalstack.api.v2.PartitionBootConfiguration boot_configuration = 4; // DNSServers for this partition repeated metalstack.api.v2.DNSServer dns_servers = 5 [(buf.validate.field).repeated.max_items = 3]; // NTPServers for this partition repeated metalstack.api.v2.NTPServer ntp_servers = 6 [(buf.validate.field).repeated.max_items = 10]; - // ManagementServiceAddresses defines where the management is reachable + // ManagementServiceAddresses defines where the management is reachable. // must be in the form : repeated string mgmt_service_addresses = 7 [(buf.validate.field).repeated.(metalstack.api.v2.are_host_and_port) = true]; // Labels to update on this network optional metalstack.api.v2.UpdateLabels labels = 8; } -// PartitionServiceDeleteRequest is the request payload for a partition delete request +// PartitionServiceDeleteRequest is the request payload for a partition delete request. message PartitionServiceDeleteRequest { // ID of the partition to delete string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; } -// PartitionServiceCreateResponse is the response payload for a partition create request +// PartitionServiceCreateResponse is the response payload for a partition create request. message PartitionServiceCreateResponse { // Partition the partition metalstack.api.v2.Partition partition = 1; } -// PartitionServiceUpdateResponse is the response payload for a partition update request +// PartitionServiceUpdateResponse is the response payload for a partition update request. message PartitionServiceUpdateResponse { // Partition the partition metalstack.api.v2.Partition partition = 1; @@ -79,7 +79,7 @@ message PartitionServiceUpdateResponse { // PartitionServiceDeleteResponse is the response payload for deleting a partition. message PartitionServiceDeleteResponse { - // Partition contains the deleted partition + // Partition contains the deleted partition. metalstack.api.v2.Partition partition = 1; } @@ -93,13 +93,13 @@ message PartitionServiceCapacityRequest { optional string project = 3 [(buf.validate.field).string.uuid = true]; } -// PartitionServiceCapacityResponse is the response payload for a partition capacity request +// PartitionServiceCapacityResponse is the response payload for a partition capacity request. message PartitionServiceCapacityResponse { - // PartitionCapacity is a capacity report per partition + // PartitionCapacity is a capacity report per partition. repeated PartitionCapacity partition_capacity = 1; } -// PartitionCapacity is the capacity of one partition +// PartitionCapacity is the capacity of one partition. message PartitionCapacity { // Partition of which this capacity is reported. string partition = 1 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; @@ -107,7 +107,7 @@ message PartitionCapacity { repeated MachineSizeCapacity machine_size_capacities = 2; } -// ServerCapacity is the capacity of one server type, eg machine size +// ServerCapacity is the capacity of one server type, eg machine size. message MachineSizeCapacity { // Size is the size id correlating to all counts in this server capacity. string size = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; diff --git a/proto/metalstack/admin/v2/project.proto b/proto/metalstack/admin/v2/project.proto index e0b2292c..3300e11f 100644 --- a/proto/metalstack/admin/v2/project.proto +++ b/proto/metalstack/admin/v2/project.proto @@ -17,12 +17,12 @@ service ProjectService { // ProjectServiceListRequest is the request payload for listing projects. message ProjectServiceListRequest { - // Query for projects + // Query for projects. optional metalstack.api.v2.ProjectQuery query = 1; } // ProjectServiceListResponse is the response payload for listing projects. message ProjectServiceListResponse { - // Projects contains the list of projects + // Projects contains the list of projects. repeated metalstack.api.v2.Project projects = 1; } diff --git a/proto/metalstack/admin/v2/size.proto b/proto/metalstack/admin/v2/size.proto index a2382c53..6a889e04 100644 --- a/proto/metalstack/admin/v2/size.proto +++ b/proto/metalstack/admin/v2/size.proto @@ -28,13 +28,13 @@ service SizeService { // SizeServiceCreateRequest is the request payload for creating a size. message SizeServiceCreateRequest { - // Size is the size to create + // Size is the size to create. metalstack.api.v2.Size size = 1; } // SizeServiceCreateResponse is the response payload for creating a size. message SizeServiceCreateResponse { - // Size contains the created size + // Size contains the created size. metalstack.api.v2.Size size = 1; } @@ -42,7 +42,7 @@ message SizeServiceCreateResponse { message SizeServiceUpdateRequest { // Id of this size string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // 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. metalstack.api.v2.UpdateMeta update_meta = 2 [(buf.validate.field).required = true]; // Name of this size optional string name = 3 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; @@ -56,7 +56,7 @@ message SizeServiceUpdateRequest { // SizeServiceUpdateResponse is the response payload for updating a size. message SizeServiceUpdateResponse { - // Size contains the updated size + // Size contains the updated size. metalstack.api.v2.Size size = 1; } @@ -68,6 +68,6 @@ message SizeServiceDeleteRequest { // SizeServiceDeleteResponse is the response payload for deleting a size. message SizeServiceDeleteResponse { - // Size contains the deleted size + // Size contains the deleted size. metalstack.api.v2.Size size = 1; } diff --git a/proto/metalstack/admin/v2/size_imageconstraint.proto b/proto/metalstack/admin/v2/size_imageconstraint.proto index a0d5868e..a11da104 100644 --- a/proto/metalstack/admin/v2/size_imageconstraint.proto +++ b/proto/metalstack/admin/v2/size_imageconstraint.proto @@ -54,7 +54,7 @@ message SizeImageConstraintServiceCreateRequest { // SizeImageConstraintServiceCreateResponse is the response payload for creating a size image constraint. message SizeImageConstraintServiceCreateResponse { - // SizeImageConstraint contains the created constraint + // SizeImageConstraint contains the created constraint. metalstack.api.v2.SizeImageConstraint size_image_constraint = 1; } @@ -62,7 +62,7 @@ message SizeImageConstraintServiceCreateResponse { message SizeImageConstraintServiceUpdateRequest { // Size of the image constraint to update string size = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // 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. metalstack.api.v2.UpdateMeta update_meta = 2 [(buf.validate.field).required = true]; // ImageConstraints to apply to this size repeated metalstack.api.v2.ImageConstraint image_constraints = 3; @@ -74,7 +74,7 @@ message SizeImageConstraintServiceUpdateRequest { // SizeImageConstraintServiceUpdateResponse is the response payload for updating a size image constraint. message SizeImageConstraintServiceUpdateResponse { - // SizeImageConstraint contains the updated constraint + // SizeImageConstraint contains the updated constraint. metalstack.api.v2.SizeImageConstraint size_image_constraint = 1; } @@ -86,7 +86,7 @@ message SizeImageConstraintServiceDeleteRequest { // SizeImageConstraintServiceDeleteResponse is the response payload for deleting a size image constraint. message SizeImageConstraintServiceDeleteResponse { - // SizeImageConstraint contains the deleted constraint + // SizeImageConstraint contains the deleted constraint. metalstack.api.v2.SizeImageConstraint size_image_constraint = 1; } @@ -98,18 +98,18 @@ message SizeImageConstraintServiceGetRequest { // SizeImageConstraintServiceGetResponse is the response payload for getting a size image constraint. message SizeImageConstraintServiceGetResponse { - // SizeImageConstraint contains the retrieved constraint + // SizeImageConstraint contains the retrieved constraint. metalstack.api.v2.SizeImageConstraint size_image_constraint = 1; } // SizeImageConstraintServiceListRequest is the request payload for listing size image constraints. message SizeImageConstraintServiceListRequest { - // Query for size image constraints + // Query for size image constraints. metalstack.api.v2.SizeImageConstraintQuery query = 1; } // SizeImageConstraintServiceListResponse is the response payload for listing size image constraints. message SizeImageConstraintServiceListResponse { - // SizeImageConstraints contains the list of constraints + // SizeImageConstraints contains the list of constraints. repeated metalstack.api.v2.SizeImageConstraint size_image_constraints = 1; } diff --git a/proto/metalstack/admin/v2/size_reservation.proto b/proto/metalstack/admin/v2/size_reservation.proto index 253c3352..d0081626 100644 --- a/proto/metalstack/admin/v2/size_reservation.proto +++ b/proto/metalstack/admin/v2/size_reservation.proto @@ -34,13 +34,13 @@ service SizeReservationService { // SizeReservationServiceCreateRequest is the request payload for creating a size reservation. message SizeReservationServiceCreateRequest { - // SizeReservation is the size reservation to create + // SizeReservation is the size reservation to create. metalstack.api.v2.SizeReservation size_reservation = 1; } // SizeReservationServiceCreateResponse is the response payload for creating a size reservation. message SizeReservationServiceCreateResponse { - // SizeReservation contains the created reservation + // SizeReservation contains the created reservation. metalstack.api.v2.SizeReservation size_reservation = 1; } @@ -52,7 +52,7 @@ message SizeReservationServiceUpdateRequest { optional string name = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // Description of this size reservation optional string description = 3 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // 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. metalstack.api.v2.UpdateMeta update_meta = 4 [(buf.validate.field).required = true]; // Partition ids of this size reservation repeated string partitions = 5 [ @@ -68,7 +68,7 @@ message SizeReservationServiceUpdateRequest { // SizeReservationServiceUpdateResponse is the response payload for updating a size reservation. message SizeReservationServiceUpdateResponse { - // SizeReservation contains the updated reservation + // SizeReservation contains the updated reservation. metalstack.api.v2.SizeReservation size_reservation = 1; } @@ -80,18 +80,18 @@ message SizeReservationServiceDeleteRequest { // SizeReservationServiceDeleteResponse is the response payload for deleting a size reservation. message SizeReservationServiceDeleteResponse { - // SizeReservation contains the deleted reservation + // SizeReservation contains the deleted reservation. metalstack.api.v2.SizeReservation size_reservation = 1; } // SizeReservationServiceListRequest is the request payload for listing size reservations. message SizeReservationServiceListRequest { - // Query for size reservations + // Query for size reservations. metalstack.api.v2.SizeReservationQuery query = 1; } // SizeReservationServiceListResponse is the response payload for listing size reservations. message SizeReservationServiceListResponse { - // SizeReservations contains the list of reservations + // SizeReservations contains the list of reservations. repeated metalstack.api.v2.SizeReservation size_reservations = 1; } diff --git a/proto/metalstack/admin/v2/switch.proto b/proto/metalstack/admin/v2/switch.proto index 4812cf80..ae421c9c 100644 --- a/proto/metalstack/admin/v2/switch.proto +++ b/proto/metalstack/admin/v2/switch.proto @@ -62,13 +62,13 @@ message SwitchServiceGetRequest { // SwitchServiceGetResponse is the response payload for getting a switch. message SwitchServiceGetResponse { - // Switch contains the requested switch + // Switch contains the requested switch. metalstack.api.v2.Switch switch = 1; } // SwitchServiceListRequest is the request payload for listing switches. message SwitchServiceListRequest { - // Query to filter the results + // Query to filter the results. metalstack.api.v2.SwitchQuery query = 1; } @@ -85,30 +85,30 @@ message SwitchServiceUpdateRequest { hostname: true [metalstack.api.v2.is_name]: true }]; - // 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. metalstack.api.v2.UpdateMeta update_meta = 2 [(buf.validate.field).required = true]; - // 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. google.protobuf.Timestamp updated_at = 3; // Description of the switch optional string description = 4 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // ReplaceMode is used to mark a switch ready for replacement + // ReplaceMode is used to mark a switch ready for replacement. optional metalstack.api.v2.SwitchReplaceMode replace_mode = 5 [(buf.validate.field).enum.defined_only = true]; - // ManagementIp is the switch's IP for management access + // ManagementIp is the switch's IP for management access. optional string management_ip = 6 [(buf.validate.field).string.ip = true]; - // ManagementUser is the user name to use for management access + // ManagementUser is the user name to use for management access. optional string management_user = 7 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // ConsoleCommand is the command for accessing the switch's console + // ConsoleCommand is the command for accessing the switch's console. optional string console_command = 8 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Nics are the front panel ports of the switch + // Nics are the front panel ports of the switch. repeated metalstack.api.v2.SwitchNic nics = 9; - // SwitchOs is the OS running on the switch + // SwitchOs is the OS running on the switch. optional metalstack.api.v2.SwitchOS os = 10; } // SwitchServiceUpdateResponse is the response payload for updating a switch. message SwitchServiceUpdateResponse { - // Switch contains the updated switch + // Switch contains the updated switch. metalstack.api.v2.Switch switch = 1; } @@ -119,24 +119,24 @@ message SwitchServiceDeleteRequest { hostname: true [metalstack.api.v2.is_name]: true }]; - // Force will allow switch deletion despite existing machine connections + // Force will allow switch deletion despite existing machine connections. bool force = 2; } // SwitchServiceDeleteResponse is the response payload for deleting a switch. message SwitchServiceDeleteResponse { - // Switch contains the deleted switch + // Switch contains the deleted switch. metalstack.api.v2.Switch switch = 1; } // SwitchServiceMigrateRequest is the request payload for migrating a switch. message SwitchServiceMigrateRequest { - // OldSwitch is the switch to migrate away from + // OldSwitch is the switch to migrate away from. string old_switch = 1 [(buf.validate.field).string = { hostname: true [metalstack.api.v2.is_name]: true }]; - // NewSwitch is the switch to migrate to + // NewSwitch is the switch to migrate to. string new_switch = 2 [(buf.validate.field).string = { hostname: true [metalstack.api.v2.is_name]: true @@ -145,7 +145,7 @@ message SwitchServiceMigrateRequest { // SwitchServiceMigrateResponse is the response payload for migrating a switch. message SwitchServiceMigrateResponse { - // Switch contains the switch that was migrated to + // Switch contains the switch that was migrated to. metalstack.api.v2.Switch switch = 1; } @@ -170,7 +170,7 @@ message SwitchServicePortResponse { // SwitchServiceConnectedMachinesRequest is the request payload for listing switches with machine connections. message SwitchServiceConnectedMachinesRequest { - // Query to filter the switch results + // Query to filter the switch results. metalstack.api.v2.SwitchQuery query = 1; // MachineQuery to filter the machine results metalstack.api.v2.MachineQuery machine_query = 2; @@ -178,6 +178,6 @@ message SwitchServiceConnectedMachinesRequest { // SwitchServiceConnectedMachinesResponse is the response payload for listing switches with machine connections. message SwitchServiceConnectedMachinesResponse { - // SwitchesWithMachines contains all switches with their machine connections + // SwitchesWithMachines contains all switches with their machine connections. repeated metalstack.api.v2.SwitchWithMachines switches_with_machines = 1; } diff --git a/proto/metalstack/admin/v2/task.proto b/proto/metalstack/admin/v2/task.proto index 3e5ddb9f..86f4e717 100644 --- a/proto/metalstack/admin/v2/task.proto +++ b/proto/metalstack/admin/v2/task.proto @@ -35,23 +35,23 @@ service TaskService { // TaskServiceGetRequest is the request payload for getting a task. message TaskServiceGetRequest { - // TaskId is the identifier of the task to get + // TaskId is the identifier of the task to get. string task_id = 1; - // Queue is the queue where this task was scheduled to + // Queue is the queue where this task was scheduled to. string queue = 2; } // TaskServiceGetResponse is the response payload for getting a task. message TaskServiceGetResponse { - // Task contains the task details + // Task contains the task details. TaskInfo task = 1; } // TaskServiceDeleteRequest is the request payload for deleting a task. message TaskServiceDeleteRequest { - // TaskId is the identifier of the task to cancel + // TaskId is the identifier of the task to cancel. string task_id = 1; - // Queue is the queue where this task was scheduled to + // Queue is the queue where this task was scheduled to. string queue = 2; } @@ -69,89 +69,89 @@ message TaskServiceQueuesResponse { // TaskServiceListRequest is the request payload for listing tasks. message TaskServiceListRequest { - // Queue filters tasks by this queue - // Will return tasks from all queues if not specified + // Queue filters tasks by this queue. + // Will return tasks from all queues if not specified. optional string queue = 1; - // Count is the number of tasks to return + // Count is the number of tasks to return. optional uint32 count = 2; - // Page is the page of tasks to return + // Page is the page of tasks to return. optional uint32 page = 3; } // TaskServiceListResponse is the response payload for listing tasks. message TaskServiceListResponse { - // Tasks contains the list of requested tasks + // Tasks contains the list of requested tasks. repeated TaskInfo tasks = 1; } // TaskInfo contains details of an asynchronous task. message TaskInfo { - // ID is the identifier of the task + // ID is the identifier of the task. string id = 1; - // Queue is the name of the queue in which the task belongs + // Queue is the name of the queue in which the task belongs. string queue = 2; - // Type is the type name of the task + // Type is the type name of the task. string type = 3; - // Payload is the payload data of the task + // Payload is the payload data of the task. bytes payload = 4; - // State indicates the task state + // State indicates the task state. TaskState state = 5; - // MaxRetry is the maximum number of times the task can be retried + // MaxRetry is the maximum number of times the task can be retried. int32 max_retry = 6; - // Retried is the number of times the task has retried so far + // Retried is the number of times the task has retried so far. int32 retried = 7; - // LastError is the error message from the last failure + // LastError is the error message from the last failure. string last_error = 8; - // LastFailedAt is the time of the last failure if any + // LastFailedAt is the time of the last failure if any. // If the task has no failures, LastFailedAt is zero time (i.e. time.Time{}) google.protobuf.Timestamp last_failed_at = 9; - // 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. google.protobuf.Duration timeout = 10; - // Deadline is the deadline for the task + // Deadline is the deadline for the task. google.protobuf.Timestamp deadline = 11; - // 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 // - // 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. string group = 12; - // NextProcessAt is the time the task is scheduled to be processed + // NextProcessAt is the time the task is scheduled to be processed. // Zero if not applicable google.protobuf.Timestamp next_process_at = 13; - // 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 // - // 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. bool is_orphaned = 14; - // 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. google.protobuf.Duration retention = 15; - // 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. google.protobuf.Timestamp completed_at = 16; - // Result holds the result data associated with the task + // Result holds the result data associated with the task. // Use ResultWriter to write result data from the Handler bytes result = 17; } // TaskState defines the state of the task. enum TaskState { - // TASK_STATE_UNSPECIFIED is not specified + // TASK_STATE_UNSPECIFIED is not specified. TASK_STATE_UNSPECIFIED = 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. TASK_STATE_ACTIVE = 1 [(metalstack.api.v2.enum_string_value) = "active"]; - // 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_PENDING = 2 [(metalstack.api.v2.enum_string_value) = "pending"]; - // 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_SCHEDULED = 3 [(metalstack.api.v2.enum_string_value) = "scheduled"]; - // TASK_STATE_RETRY indicates that the task has previously failed and is 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_RETRY = 4 [(metalstack.api.v2.enum_string_value) = "retry"]; - // 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_ARCHIVED = 5 [(metalstack.api.v2.enum_string_value) = "archived"]; - // 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_COMPLETED = 6 [(metalstack.api.v2.enum_string_value) = "completed"]; - // 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. TASK_STATE_AGGREGATING = 7 [(metalstack.api.v2.enum_string_value) = "aggregating"]; } diff --git a/proto/metalstack/admin/v2/tenant.proto b/proto/metalstack/admin/v2/tenant.proto index 2716e65f..c3ee1f89 100644 --- a/proto/metalstack/admin/v2/tenant.proto +++ b/proto/metalstack/admin/v2/tenant.proto @@ -20,12 +20,12 @@ service TenantService { option (metalstack.api.v2.admin_roles) = ADMIN_ROLE_VIEWER; option (metalstack.api.v2.auditing) = AUDITING_INCLUDED; } - // Add a member to a tenant + // Add a member to a tenant. rpc AddMember(TenantServiceAddMemberRequest) returns (TenantServiceAddMemberResponse) { option (metalstack.api.v2.admin_roles) = ADMIN_ROLE_EDITOR; option (metalstack.api.v2.auditing) = AUDITING_INCLUDED; } - // RemoveMember removes a member from a tenant + // RemoveMember removes a member from a tenant. rpc RemoveMember(TenantServiceRemoveMemberRequest) returns (TenantServiceRemoveMemberResponse) { option (metalstack.api.v2.admin_roles) = ADMIN_ROLE_EDITOR; option (metalstack.api.v2.auditing) = AUDITING_INCLUDED; @@ -48,25 +48,25 @@ message TenantServiceCreateRequest { // TenantServiceCreateResponse is the response payload for creating a tenant. message TenantServiceCreateResponse { - // Tenant contains the created tenant + // Tenant contains the created tenant. metalstack.api.v2.Tenant tenant = 1; } // TenantServiceListRequest is the request payload for listing tenants. message TenantServiceListRequest { - // Query for tenants + // Query for tenants. metalstack.api.v2.TenantQuery query = 1; } // TenantServiceListResponse is the response payload for listing tenants. message TenantServiceListResponse { - // Tenants contains the list of tenants + // Tenants contains the list of tenants. repeated metalstack.api.v2.Tenant tenants = 1; - // 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. optional uint64 next_page = 2; } -// TenantServiceAddMemberRequest is the request payload for adding a member to a tenant +// TenantServiceAddMemberRequest is the request payload for adding a member to a tenant. message TenantServiceAddMemberRequest { // Login of the tenant to which the member will be added string tenant = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; @@ -76,13 +76,13 @@ message TenantServiceAddMemberRequest { metalstack.api.v2.TenantRole role = 3 [(buf.validate.field).enum.defined_only = true]; } -// TenantServiceAddMemberResponse is the response payload for the add member request +// TenantServiceAddMemberResponse is the response payload for the add member request. message TenantServiceAddMemberResponse { - // TenantMember is the added tenant member + // TenantMember is the added tenant member. metalstack.api.v2.TenantMember tenant_member = 1; } -// TenantServiceRemoveMemberRequest is the request payload for removing a member from a tenant +// TenantServiceRemoveMemberRequest is the request payload for removing a member from a tenant. message TenantServiceRemoveMemberRequest { // Login of the tenant from which the member will be removed string tenant = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; @@ -90,8 +90,8 @@ message TenantServiceRemoveMemberRequest { string member = 2 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; } -// TenantServiceRemoveMemberResponse is the response payload for the remove member request +// TenantServiceRemoveMemberResponse is the response payload for the remove member request. message TenantServiceRemoveMemberResponse { - // TenantMember is the removed tenant member + // TenantMember is the removed tenant member. metalstack.api.v2.TenantMember tenant_member = 1; } diff --git a/proto/metalstack/admin/v2/token.proto b/proto/metalstack/admin/v2/token.proto index 6538d99a..66788253 100644 --- a/proto/metalstack/admin/v2/token.proto +++ b/proto/metalstack/admin/v2/token.proto @@ -30,21 +30,21 @@ service TokenService { // TokenServiceListRequest is the request payload for listing tokens. message TokenServiceListRequest { - // Query for tokens + // Query for tokens. metalstack.api.v2.TokenQuery query = 1; } // TokenServiceListResponse is the response payload for listing tokens. message TokenServiceListResponse { - // Tokens contains the list of tokens + // Tokens contains the list of tokens. repeated metalstack.api.v2.Token tokens = 1; } // TokenServiceRevokeRequest is the request payload for revoking a token. message TokenServiceRevokeRequest { - // Uuid is the uuid of the token which should be revoked + // Uuid is the uuid of the token which should be revoked. string uuid = 1 [(buf.validate.field).string.uuid = true]; - // User is the id of the user for which the token should be revoked + // User is the id of the user for which the token should be revoked. string user = 2 [(buf.validate.field).string.(metalstack.api.v2.is_user) = true]; } @@ -61,8 +61,8 @@ message TokenServiceCreateRequest { // TokenServiceCreateResponse is the response payload for creating a token. message TokenServiceCreateResponse { - // Token contains the created token + // Token contains the created token. metalstack.api.v2.Token token = 1; - // 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. string secret = 2; } diff --git a/proto/metalstack/admin/v2/vpn.proto b/proto/metalstack/admin/v2/vpn.proto index eabc41c8..fb6970ad 100644 --- a/proto/metalstack/admin/v2/vpn.proto +++ b/proto/metalstack/admin/v2/vpn.proto @@ -29,12 +29,12 @@ service VPNService { message VPNServiceAuthKeyRequest { // Project for which a VPN authentication key should be generated string project = 1 [(buf.validate.field).string.uuid = true]; - // Ephemeral defines if the authentication key should be ephemeral + // Ephemeral defines if the authentication key should be ephemeral. bool ephemeral = 2; - // Expires defines the duration after which the authentication key expires + // Expires defines the duration after which the authentication key expires. google.protobuf.Duration expires = 3; - // Reason must be provided why access to the VPN is requested - // Reason is only forwarded to an audit sink + // Reason must be provided why access to the VPN is requested. + // Reason is only forwarded to an audit sink. string reason = 4 [ (buf.validate.field).string.min_len = 10, (buf.validate.field).string.max_len = 512 @@ -43,12 +43,12 @@ message VPNServiceAuthKeyRequest { // VPNServiceAuthKeyResponse is the response payload for generating a VPN authentication key. message VPNServiceAuthKeyResponse { - // Address is the address of the VPN control plane + // Address is the address of the VPN control plane. string address = 1; - // 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. string auth_key = 2; - // Ephemeral defines if the authentication key should be ephemeral + // Ephemeral defines if the authentication key should be ephemeral. bool ephemeral = 3; // ExpiresAt this key cannot be used after this timestamp google.protobuf.Timestamp expires_at = 4; @@ -58,7 +58,7 @@ message VPNServiceAuthKeyResponse { // VPNServiceListNodesRequest is the request payload for listing VPN nodes. message VPNServiceListNodesRequest { - // Project filters nodes by this project + // Project filters nodes by this project. optional string project = 1; } diff --git a/proto/metalstack/api/v2/audit.proto b/proto/metalstack/api/v2/audit.proto index d5062a90..790efdf3 100644 --- a/proto/metalstack/api/v2/audit.proto +++ b/proto/metalstack/api/v2/audit.proto @@ -23,11 +23,11 @@ service AuditService { // AuditPhase specifies the phase of an audit trace. enum AuditPhase { - // AUDIT_PHASE_UNSPECIFIED is not specified + // AUDIT_PHASE_UNSPECIFIED is not specified. AUDIT_PHASE_UNSPECIFIED = 0; - // AUDIT_PHASE_REQUEST defines an audit trace in the request phase + // AUDIT_PHASE_REQUEST defines an audit trace in the request phase. AUDIT_PHASE_REQUEST = 1; - // AUDIT_PHASE_RESPONSE defines an audit trace in the response phase + // AUDIT_PHASE_RESPONSE defines an audit trace in the response phase. AUDIT_PHASE_RESPONSE = 2; } @@ -35,50 +35,50 @@ enum AuditPhase { message AuditTrace { // Uuid of the audit trace string uuid = 1 [(buf.validate.field).string.uuid = true]; - // Timestamp is the timestamp when the request arrived at the API + // Timestamp is the timestamp when the request arrived at the API. google.protobuf.Timestamp timestamp = 2; - // User is the login user who called the API method + // User is the login user who called the API method. string user = 3; - // Tenant is the tenant targeted by the API call + // Tenant is the tenant targeted by the API call. string tenant = 4; - // Project is the project targeted by the API call + // Project is the project targeted by the API call. optional string project = 5; - // Method is the API method that was called + // Method is the API method that was called. string method = 6; - // 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 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. optional string body = 7; - // SourceIP contains the source IP address of the API call + // SourceIP contains the source IP address of the API call. string source_ip = 8; - // 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 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. optional int32 result_code = 9; - // Phase represents the phase of the audit trace + // Phase represents the phase of the audit trace. AuditPhase phase = 10; // Meta for this audit trace Meta meta = 11; } -// AuditQuery is the query for audit traces +// AuditQuery is the query for audit traces. message AuditQuery { // Uuid of the audit trace optional string uuid = 2 [(buf.validate.field).string.uuid = true]; - // From describes the start of the time window in which to list audit traces. Defaults to the last eight hours + // From describes the start of the time window in which to list audit traces. Defaults to the last eight hours. optional google.protobuf.Timestamp from = 3; - // To describes the end of the time window in which to list audit traces. Defaults to the time the request was issued + // To describes the end of the time window in which to list audit traces. Defaults to the time the request was issued. optional google.protobuf.Timestamp to = 4; - // User is the user who called the api method + // User is the user who called the api method. optional string user = 5 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Project is the project targeted by the api call + // Project is the project targeted by the api call. optional string project = 6 [(buf.validate.field).string.uuid = true]; - // Method is the api method that was called + // Method is the api method that was called. optional string method = 7 [(buf.validate.field).string = { min_len: 2 max_len: 256 }]; - // Source IP contains the ip address of the caller + // Source IP contains the ip address of the caller. optional string source_ip = 8 [(buf.validate.field).string.ip = true]; - // Result Code is a string describing the result of the api call + // Result Code is a string describing the result of the api call. optional int32 result_code = 9 [(buf.validate.field).int32 = {gte: 0}]; - // Body is a string providing text-search of the body field + // Body is a string providing text-search of the body field. optional string body = 10 [(buf.validate.field).string = { min_len: 2 max_len: 256 @@ -88,36 +88,36 @@ message AuditQuery { gt: 0 lte: 1000 }]; - // Phase specifies the audit phase + // Phase specifies the audit phase. optional AuditPhase phase = 12 [(buf.validate.field).enum.defined_only = true]; } -// AuditServiceListRequest is the request payload for an audit list request +// AuditServiceListRequest is the request payload for an audit list request. message AuditServiceListRequest { // Login for this tenant string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Query for audit traces + // Query for audit traces. AuditQuery query = 2; } -// AuditServiceListResponse is the response payload of a audit list request +// AuditServiceListResponse is the response payload of a audit list request. message AuditServiceListResponse { - // Traces is a list of audit traces + // Traces is a list of audit traces. repeated AuditTrace traces = 1; } -// AuditServiceGetRequest is the request payload of a audit get request +// AuditServiceGetRequest is the request payload of a audit get request. message AuditServiceGetRequest { // Login for this tenant string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // Uuid of the audit trace string uuid = 2 [(buf.validate.field).string.uuid = true]; - // Phase specifies the audit phase. Defaults to request + // Phase specifies the audit phase. Defaults to request. optional AuditPhase phase = 3 [(buf.validate.field).enum.defined_only = true]; } -// AuditServiceGetResponse is the response payload of a audit get request +// AuditServiceGetResponse is the response payload of a audit get request. message AuditServiceGetResponse { - // Trace is the audit trace + // Trace is the audit trace. AuditTrace trace = 1; } diff --git a/proto/metalstack/api/v2/common.proto b/proto/metalstack/api/v2/common.proto index ecf9c11d..b9a88910 100644 --- a/proto/metalstack/api/v2/common.proto +++ b/proto/metalstack/api/v2/common.proto @@ -7,9 +7,9 @@ import "google/protobuf/descriptor.proto"; import "google/protobuf/timestamp.proto"; import "metalstack/api/v2/predefined_rules.proto"; -// TenantRole specifies what role a logged in user needs to call this tenant scoped service +// TenantRole specifies what role a logged in user needs to call this tenant scoped service. enum TenantRole { - // TENANT_ROLE_UNSPECIFIED is not specified + // TENANT_ROLE_UNSPECIFIED is not specified. TENANT_ROLE_UNSPECIFIED = 0; // TENANT_ROLE_OWNER the logged in user needs at least owner role to call this method TENANT_ROLE_OWNER = 1; @@ -18,14 +18,14 @@ enum TenantRole { // TENANT_ROLE_VIEWER the logged in user needs at least viewer role to call this method TENANT_ROLE_VIEWER = 3; // TENANT_ROLE_GUEST the logged in user needs at least guest role to call this method - // The guest role is assumed by users who are invited to a tenant's project without them + // The guest role is assumed by users who are invited to a tenant's project without them. // having a direct membership within the tenant. TENANT_ROLE_GUEST = 4; } -// ProjectRole specifies what role a logged in user needs to call this project scoped service +// ProjectRole specifies what role a logged in user needs to call this project scoped service. enum ProjectRole { - // PROJECT_ROLE_UNSPECIFIED is not specified + // PROJECT_ROLE_UNSPECIFIED is not specified. PROJECT_ROLE_UNSPECIFIED = 0; // PROJECT_ROLE_OWNER the logged in user needs at least owner role to call this method PROJECT_ROLE_OWNER = 1; @@ -35,9 +35,9 @@ enum ProjectRole { PROJECT_ROLE_VIEWER = 3; } -// AdminRole specifies what role a logged in user needs to call this admin service +// AdminRole specifies what role a logged in user needs to call this admin service. enum AdminRole { - // ADMIN_ROLE_UNSPECIFIED is not specified + // ADMIN_ROLE_UNSPECIFIED is not specified. ADMIN_ROLE_UNSPECIFIED = 0; // ADMIN_ROLE_EDITOR the logged in user needs at least editor role to call this method ADMIN_ROLE_EDITOR = 1; @@ -45,9 +45,9 @@ enum AdminRole { ADMIN_ROLE_VIEWER = 2; } -// InfraRole specifies what role a microservice needs to call this infra service +// InfraRole specifies what role a microservice needs to call this infra service. enum InfraRole { - // INFRA_ROLE_UNSPECIFIED is not specified + // INFRA_ROLE_UNSPECIFIED is not specified. INFRA_ROLE_UNSPECIFIED = 0; // INFRA_ROLE_EDITOR a microservice needs at least editor role to call this method INFRA_ROLE_EDITOR = 1; @@ -55,9 +55,9 @@ enum InfraRole { INFRA_ROLE_VIEWER = 2; } -// MachineRole specifies what role a microservice needs to call this machine service +// MachineRole specifies what role a microservice needs to call this machine service. enum MachineRole { - // MACHINE_ROLE_UNSPECIFIED is not specified + // MACHINE_ROLE_UNSPECIFIED is not specified. MACHINE_ROLE_UNSPECIFIED = 0; // MACHINE_ROLE_EDITOR a microservice needs at least editor role to call this method MACHINE_ROLE_EDITOR = 1; @@ -67,9 +67,9 @@ enum MachineRole { // Visibility of a method enum Visibility { - // VISIBILITY_UNSPECIFIED is not defined + // VISIBILITY_UNSPECIFIED is not defined. VISIBILITY_UNSPECIFIED = 0; - // VISIBILITY_PUBLIC specifies that this service is accessible without authentication + // VISIBILITY_PUBLIC specifies that this service is accessible without authentication. VISIBILITY_PUBLIC = 1; // VISIBILITY_SELF restricts calls to the authenticated user only VISIBILITY_SELF = 2; @@ -79,7 +79,7 @@ enum Visibility { // by default all service methods are included // add the auditing option if you want to exclude a method in auditing enum Auditing { - // AUDITING_UNSPECIFIED is not specified + // AUDITING_UNSPECIFIED is not specified. AUDITING_UNSPECIFIED = 0; // AUDITING_INCLUDED if a method is annotated with this, all calls are audited AUDITING_INCLUDED = 1; @@ -89,38 +89,38 @@ enum Auditing { // MethodOptions to specify specific annotations to methods extend google.protobuf.MethodOptions { - // TenantRoles are used to define the tenant role a logged in user must provide to call this method + // TenantRoles are used to define the tenant role a logged in user must provide to call this method. repeated TenantRole tenant_roles = 51000; - // ProjectRoles are used to define the project role a logged in user must provide to call this method + // ProjectRoles are used to define the project role a logged in user must provide to call this method. repeated ProjectRole project_roles = 51001; - // AdminRoles are used to define the admin role a logged in user must provide to call this method + // AdminRoles are used to define the admin role a logged in user must provide to call this method. repeated AdminRole admin_roles = 51002; - // Visibility defines the visibility of this method, this is used to have public or self visible methods + // Visibility defines the visibility of this method, this is used to have public or self visible methods. Visibility visibility = 51003; - // Auditing defines if calls to this method should be audited or not + // Auditing defines if calls to this method should be audited or not. Auditing auditing = 51004; - // InfraRoles are used to define the infra role a microservice must provide to call this method + // InfraRoles are used to define the infra role a microservice must provide to call this method. repeated InfraRole infra_roles = 51005; - // MachineRole are used to define which machine role a microservice must provide to call this method + // MachineRole are used to define which machine role a microservice must provide to call this method. repeated MachineRole machine_roles = 51006; } -// EnumValueOptions, can be accessed with go/enum/GetFormatStringValue +// EnumValueOptions, can be accessed with go/enum/GetFormatStringValue. extend google.protobuf.EnumValueOptions { // StringValue which can be set to a enum string enum_string_value = 52000; } -// Paging defines paging for methods with a lot of results +// Paging defines paging for methods with a lot of results. message Paging { // Page is used for pagination, if unset only the first page is returned, // the list response contains then the page number for the next page. optional uint64 page = 1; - // Count is the number of results returned per page, if not given server side defaults apply + // Count is the number of results returned per page, if not given server side defaults apply. optional uint64 count = 2; } -// Labels define additional information to a entity +// Labels define additional information to a entity. message Labels { // Labels consists labels map labels = 1 [ @@ -146,9 +146,9 @@ message Labels { message Meta { // Tags on this entity optional Labels labels = 1; - // CreatedAt is the date when this entity was created + // CreatedAt is the date when this entity was created. google.protobuf.Timestamp created_at = 2; - // UpdatedAt is the date when this entity was updated + // UpdatedAt is the date when this entity was updated. // must be part of the update request to ensure optimistic locking google.protobuf.Timestamp updated_at = 3; // Generation identifies how often this entity was modified since creation. @@ -158,25 +158,25 @@ message Meta { optional string deletion_task_id = 5; } -// UpdateLabels is a message to update labels +// UpdateLabels is a message to update labels. message UpdateLabels { - // Strategy defines the label update strategy + // Strategy defines the label update strategy. oneof strategy { // ensure at least one match is specified option (buf.validate.oneof).required = true; // Replace existing labels with the given ones Labels replace = 1; - // Patch adds, updates or remove given labels without modifying others + // Patch adds, updates or remove given labels without modifying others. LabelsPatch patch = 2; } } -// LabelsPatch adds, updates or remove given labels without modifying others +// LabelsPatch adds, updates or remove given labels without modifying others. message LabelsPatch { - // Update labels. New ones will be added, existing ones overwritten + // Update labels. New ones will be added, existing ones overwritten. Labels update = 1; - // Remove labels by key + // Remove labels by key. repeated string remove = 2 [(buf.validate.field).repeated = { unique: true items: { @@ -185,9 +185,9 @@ message LabelsPatch { }]; } -// UpdateMeta must be provided with every UpdateRequest to define how optimistic locking should be handled +// UpdateMeta must be provided with every UpdateRequest to define how optimistic locking should be handled. message UpdateMeta { - // UpdatedAt is the date when this entity was updated + // UpdatedAt is the date when this entity was updated. // must be part of the update request to ensure optimistic locking google.protobuf.Timestamp updated_at = 1; diff --git a/proto/metalstack/api/v2/component.proto b/proto/metalstack/api/v2/component.proto index 94d72e51..ee7cc6ae 100644 --- a/proto/metalstack/api/v2/component.proto +++ b/proto/metalstack/api/v2/component.proto @@ -10,16 +10,16 @@ import "metalstack/api/v2/predefined_rules.proto"; import "metalstack/api/v2/token.proto"; import "metalstack/api/v2/version.proto"; -// Component represents a microservice connected to our apiserver +// Component represents a microservice connected to our apiserver. message Component { - // UUID identifies this component event + // UUID identifies this component event. string uuid = 1 [(buf.validate.field).string.uuid = true]; - // Type defines which service is actually pinging + // Type defines which service is actually pinging. ComponentType type = 2 [(buf.validate.field).enum.defined_only = true]; // 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. string identifier = 3 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // StartedAt is the timestamp this service was started + // StartedAt is the timestamp this service was started. google.protobuf.Timestamp started_at = 4; // ReportedAt is the timestamp this service sent this ping. google.protobuf.Timestamp reported_at = 5; @@ -35,29 +35,29 @@ message Component { // ComponentQuery to query components message ComponentQuery { - // UUID identifies this component + // UUID identifies this component. optional string uuid = 1 [(buf.validate.field).string.uuid = true]; - // Type defines which service is actually pinging + // Type defines which service is actually pinging. optional ComponentType type = 2 [(buf.validate.field).enum.defined_only = true]; // 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. optional string identifier = 3 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; } -// ComponentType defines which service is actually pinging +// ComponentType defines which service is actually pinging. enum ComponentType { - // COMPONENT_TYPE_UNSPECIFIED is unspecified + // COMPONENT_TYPE_UNSPECIFIED is unspecified. COMPONENT_TYPE_UNSPECIFIED = 0 [(metalstack.api.v2.enum_string_value) = "unspecified"]; - // COMPONENT_TYPE_PIXIECORE is pixiecore + // COMPONENT_TYPE_PIXIECORE is pixiecore. COMPONENT_TYPE_PIXIECORE = 1 [(metalstack.api.v2.enum_string_value) = "pixiecore"]; - // COMPONENT_TYPE_METAL_CORE is metal-core + // COMPONENT_TYPE_METAL_CORE is metal-core. COMPONENT_TYPE_METAL_CORE = 2 [(metalstack.api.v2.enum_string_value) = "metal-core"]; - // COMPONENT_TYPE_METAL_BMC is metal-bmc + // COMPONENT_TYPE_METAL_BMC is metal-bmc. COMPONENT_TYPE_METAL_BMC = 3 [(metalstack.api.v2.enum_string_value) = "metal-bmc"]; - // COMPONENT_TYPE_METAL_IMAGE_CACHE_SYNC is metal-image-cache-sync + // COMPONENT_TYPE_METAL_IMAGE_CACHE_SYNC is metal-image-cache-sync. COMPONENT_TYPE_METAL_IMAGE_CACHE_SYNC = 4 [(metalstack.api.v2.enum_string_value) = "metal-image-cache-sync"]; - // COMPONENT_TYPE_METAL_CONSOLE is metal-console + // COMPONENT_TYPE_METAL_CONSOLE is metal-console. COMPONENT_TYPE_METAL_CONSOLE = 5 [(metalstack.api.v2.enum_string_value) = "metal-console"]; - // COMPONENT_TYPE_METAL_METRICS_EXPORTER is metal-metrics-exporter + // COMPONENT_TYPE_METAL_METRICS_EXPORTER is metal-metrics-exporter. COMPONENT_TYPE_METAL_METRICS_EXPORTER = 6 [(metalstack.api.v2.enum_string_value) = "metal-metrics-exporter"]; } diff --git a/proto/metalstack/api/v2/filesystem.proto b/proto/metalstack/api/v2/filesystem.proto index 6a7c637a..3447904a 100644 --- a/proto/metalstack/api/v2/filesystem.proto +++ b/proto/metalstack/api/v2/filesystem.proto @@ -20,25 +20,25 @@ service FilesystemService { } } -// FilesystemServiceGetRequest is the request payload for a filesystem get request +// FilesystemServiceGetRequest is the request payload for a filesystem get request. message FilesystemServiceGetRequest { // ID of the filesystem to get string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; } -// FilesystemServiceListRequest is the request payload for a filesystem list request +// FilesystemServiceListRequest is the request payload for a filesystem list request. message FilesystemServiceListRequest { // ID of the filesystem to get optional string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; } -// FilesystemServiceGetResponse is the response payload for a filesystem get request +// FilesystemServiceGetResponse is the response payload for a filesystem get request. message FilesystemServiceGetResponse { // FilesystemLayout the filesystemlayout FilesystemLayout filesystem_layout = 1; } -// FilesystemServiceListResponse is the response payload for a filesystem list request +// FilesystemServiceListResponse is the response payload for a filesystem list request. message FilesystemServiceListResponse { // FilesystemLayouts the filesystemlayouts repeated FilesystemLayout filesystem_layouts = 1; @@ -54,15 +54,15 @@ message FilesystemLayout { optional string name = 3 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // Description of this filesystemLayout optional string description = 4 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Filesystems is a list of filesystems to create on a machine + // Filesystems is a list of filesystems to create on a machine. repeated Filesystem filesystems = 5; - // Disks list of disks that belong to this layout + // Disks list of disks that belong to this layout. repeated Disk disks = 6; // raid arrays to create repeated Raid raid = 7; - // VolumeGroups list of volumegroups to create + // VolumeGroups list of volumegroups to create. repeated VolumeGroup volume_groups = 8; - // LogicalVolumes list of logicalvolumes to create + // LogicalVolumes list of logicalvolumes to create. repeated LogicalVolume logical_volumes = 9; // Constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts FilesystemLayoutConstraints constraints = 10; @@ -70,10 +70,10 @@ message FilesystemLayout { // FilesystemLayoutConstraints message FilesystemLayoutConstraints { - // Sizes list of sizes this layout applies to + // Sizes list of sizes this layout applies to. // this could either be a concrete size, or a asterisk to match all sizes repeated string sizes = 1; - // Images list of images this layout applies to in the following form + // Images list of images this layout applies to in the following form. // key must be the first part of available images, e.g. the name of the image // value must be a semver match expression with the constraint and the version separated by space // this would match all debian images which are greater or equal 12.0 @@ -129,7 +129,7 @@ message Disk { (buf.validate.field).string.(metalstack.api.v2.is_name) = true, (buf.validate.field).string.(metalstack.api.v2.trimmed) = true ]; - // Partitions list of partitions to create on this disk + // Partitions list of partitions to create on this disk. repeated DiskPartition partitions = 2; } @@ -140,7 +140,7 @@ message Raid { (buf.validate.field).string.(metalstack.api.v2.is_name) = true, (buf.validate.field).string.(metalstack.api.v2.trimmed) = true ]; - // Devices list of devices to form the raid array from + // Devices list of devices to form the raid array from. repeated string devices = 2 [ (buf.validate.field).repeated = { max_items: 128 @@ -150,7 +150,7 @@ message Raid { }, (buf.validate.field).repeated.(metalstack.api.v2.all_trimmed) = true ]; - // Level raid level to create, should be 0 or 1 + // Level raid level to create, should be 0 or 1. RaidLevel level = 3 [ (buf.validate.field).enum.defined_only = true, (buf.validate.field).required = true @@ -169,7 +169,7 @@ message Raid { // DiskPartition message DiskPartition { - // Number partition number, will be appended to partitionprefix to create the final devicename + // Number partition number, will be appended to partitionprefix to create the final devicename. uint32 number = 1; // Label an optional label for this partition optional string label = 2 [ @@ -189,7 +189,7 @@ message DiskPartition { message VolumeGroup { // Name the name of the resulting volume group string name = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Devices list of devices to form the volume group from + // Devices list of devices to form the volume group from. repeated string devices = 2 [ (buf.validate.field).repeated = { max_items: 128 @@ -199,7 +199,7 @@ message VolumeGroup { }, (buf.validate.field).repeated.(metalstack.api.v2.all_trimmed) = true ]; - // Tags list of tags to add to the volume group + // Tags list of tags to add to the volume group. repeated string tags = 3 [ (buf.validate.field).repeated = { max_items: 128 @@ -225,7 +225,7 @@ message LogicalVolume { // LVMType enum LVMType { - // LVM_TYPE_UNSPECIFIED is not specified + // LVM_TYPE_UNSPECIFIED is not specified. LVM_TYPE_UNSPECIFIED = 0; // LVM_TYPE_LINEAR append across all physical volumes LVM_TYPE_LINEAR = 1 [(enum_string_value) = "linear"]; @@ -235,27 +235,27 @@ enum LVMType { LVM_TYPE_RAID1 = 3 [(enum_string_value) = "raid1"]; } -// Format specifies the filesystem to use on a volume +// Format specifies the filesystem to use on a volume. enum Format { // FORMAT_UNSPECIFIED FORMAT_UNSPECIFIED = 0; - // FORMAT_VFAT is used for the UEFI boot partition + // FORMAT_VFAT is used for the UEFI boot partition. FORMAT_VFAT = 1 [(enum_string_value) = "vfat"]; - // FORMAT_EXT3 is usually only used for /boot + // FORMAT_EXT3 is usually only used for /boot. FORMAT_EXT3 = 2 [(enum_string_value) = "ext3"]; - // FORMAT_EXT4 is the default fs + // FORMAT_EXT4 is the default fs. FORMAT_EXT4 = 3 [(enum_string_value) = "ext4"]; - // FORMAT_SWAP is for the swap partition + // FORMAT_SWAP is for the swap partition. FORMAT_SWAP = 4 [(enum_string_value) = "swap"]; - // FORMAT_TMPFS is used for a memory filesystem typically /tmp + // FORMAT_TMPFS is used for a memory filesystem typically /tmp. FORMAT_TMPFS = 5 [(enum_string_value) = "tmpfs"]; // FORMAT_NONE FORMAT_NONE = 6 [(enum_string_value) = "none"]; } -// GPTType specifies the partition type in uefi systems +// GPTType specifies the partition type in uefi systems. enum GPTType { - // GPT_TYPE_UNSPECIFIED is no specified + // GPT_TYPE_UNSPECIFIED is no specified. GPT_TYPE_UNSPECIFIED = 0; // GPT_TYPE_BOOT EFI Boot Partition GPT_TYPE_BOOT = 1 [(enum_string_value) = "ef00"]; @@ -267,12 +267,12 @@ enum GPTType { GPT_TYPE_LINUX_LVM = 4 [(enum_string_value) = "8e00"]; } -// RaidLevel defines howto mirror two or more block devices +// RaidLevel defines howto mirror two or more block devices. enum RaidLevel { - // RAID_LEVEL_UNSPECIFIED is not specified + // RAID_LEVEL_UNSPECIFIED is not specified. RAID_LEVEL_UNSPECIFIED = 0; - // RAID_LEVEL_0 is a stripe of two or more disks + // RAID_LEVEL_0 is a stripe of two or more disks. RAID_LEVEL_0 = 1 [(enum_string_value) = "0"]; - // RAID_LEVEL_1 is a mirror of two disks + // RAID_LEVEL_1 is a mirror of two disks. RAID_LEVEL_1 = 2 [(enum_string_value) = "1"]; } diff --git a/proto/metalstack/api/v2/health.proto b/proto/metalstack/api/v2/health.proto index d931bb41..930a8a3b 100644 --- a/proto/metalstack/api/v2/health.proto +++ b/proto/metalstack/api/v2/health.proto @@ -27,7 +27,7 @@ enum ServiceStatus { // Service defines the service for which the healthiness is reported. enum Service { - // SERVICE_UNSPECIFIED is a unknown service + // SERVICE_UNSPECIFIED is a unknown service. SERVICE_UNSPECIFIED = 0; // SERVICE_IPAM the IPAM service SERVICE_IPAM = 1 [(enum_string_value) = "ipam"]; @@ -49,27 +49,27 @@ enum Service { // Health reports the health status of all services. message Health { - // Services contains the health of all individual services + // Services contains the health of all individual services. repeated HealthStatus services = 1; } // HealthStatus represents the health status of one service. message HealthStatus { - // Name is the name of the service + // Name is the name of the service. Service name = 1; - // Status is the status of this service + // Status is the status of this service. ServiceStatus status = 2; - // Message describes the reason for the unhealthy status if possible + // Message describes the reason for the unhealthy status if possible. string message = 3; - // Partitions describes the health of the service by partition + // Partitions describes the health of the service by partition. map partitions = 4; } // PartitionHealth represents the status of a specific service in this partition. message PartitionHealth { - // Status is the health status of the service in this partition + // Status is the health status of the service in this partition. ServiceStatus status = 1; - // Message describes the reason for the unhealthy status if possible + // Message describes the reason for the unhealthy status if possible. string message = 2; } @@ -78,6 +78,6 @@ message HealthServiceGetRequest {} // HealthServiceGetResponse is the response payload for getting the health of the system. message HealthServiceGetResponse { - // Health contains the overall health of the system + // Health contains the overall health of the system. Health health = 1; } diff --git a/proto/metalstack/api/v2/image.proto b/proto/metalstack/api/v2/image.proto index dfed9d51..0cee8b01 100644 --- a/proto/metalstack/api/v2/image.proto +++ b/proto/metalstack/api/v2/image.proto @@ -26,19 +26,19 @@ service ImageService { } } -// ImageServiceGetRequest is the request payload for an image get request +// ImageServiceGetRequest is the request payload for an image get request. message ImageServiceGetRequest { // ID of the image to get string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; } -// ImageServiceListRequest is the request payload for an image list request +// ImageServiceListRequest is the request payload for an image list request. message ImageServiceListRequest { - // Query for images + // Query for images. ImageQuery query = 1; } -// ImageServiceLatestRequest is the request payload for an image latest request +// ImageServiceLatestRequest is the request payload for an image latest request. message ImageServiceLatestRequest { // OS for which the latest image should be fetched // should contain os and major.minor then latest patch version of this os is returned @@ -47,19 +47,19 @@ message ImageServiceLatestRequest { optional ImageClassification classification = 2 [(buf.validate.field).enum.defined_only = true]; } -// ImageServiceGetResponse is the response payload for an image get request +// ImageServiceGetResponse is the response payload for an image get request. message ImageServiceGetResponse { // Image the image Image image = 1; } -// ImageServiceListResponse is the response payload for an image list request +// ImageServiceListResponse is the response payload for an image list request. message ImageServiceListResponse { // Images the images repeated Image images = 1; } -// ImageServiceLatestResponse is the response payload for an image latest request +// ImageServiceLatestResponse is the response payload for an image latest request. message ImageServiceLatestResponse { // Image which is the latest for one os Image image = 1; @@ -87,11 +87,11 @@ message Image { // Classification of this image ImageClassification classification = 7 [(buf.validate.field).enum.defined_only = true]; - // ExpiresAt usage is not possible after this date + // ExpiresAt usage is not possible after this date. google.protobuf.Timestamp expires_at = 8; } -// ImageUsage reports which machines/firewalls actually use this image +// ImageUsage reports which machines/firewalls actually use this image. message ImageUsage { // Image with usage Image image = 1; @@ -99,7 +99,7 @@ message ImageUsage { repeated string used_by = 2; } -// ImageQuery is used to search images +// ImageQuery is used to search images. message ImageQuery { // ID of the image to get optional string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; @@ -125,28 +125,28 @@ message ImageQuery { // Classification of the image to query optional ImageClassification classification = 8 [(buf.validate.field).enum.defined_only = true]; - // Labels lists only images containing the given labels + // Labels lists only images containing the given labels. optional Labels labels = 9; } // ImageFeature enum ImageFeature { - // IMAGE_FEATURE_UNSPECIFIED is not specified + // IMAGE_FEATURE_UNSPECIFIED is not specified. IMAGE_FEATURE_UNSPECIFIED = 0; - // IMAGE_FEATURE_MACHINE indicates this image is usable for a machine + // IMAGE_FEATURE_MACHINE indicates this image is usable for a machine. IMAGE_FEATURE_MACHINE = 1 [(enum_string_value) = "machine"]; - // IMAGE_FEATURE_FIREWALL indicates this image is usable for a firewall + // IMAGE_FEATURE_FIREWALL indicates this image is usable for a firewall. IMAGE_FEATURE_FIREWALL = 2 [(enum_string_value) = "firewall"]; } // Image enum ImageClassification { - // IMAGE_CLASSIFICATION_UNSPECIFIED is not specified + // IMAGE_CLASSIFICATION_UNSPECIFIED is not specified. IMAGE_CLASSIFICATION_UNSPECIFIED = 0; - // IMAGE_CLASSIFICATION_PREVIEW indicates that this image is in preview + // IMAGE_CLASSIFICATION_PREVIEW indicates that this image is in preview. IMAGE_CLASSIFICATION_PREVIEW = 1 [(enum_string_value) = "preview"]; - // IMAGE_CLASSIFICATION_SUPPORTED indicates that this image is supported + // IMAGE_CLASSIFICATION_SUPPORTED indicates that this image is supported. IMAGE_CLASSIFICATION_SUPPORTED = 2 [(enum_string_value) = "supported"]; - // IMAGE_CLASSIFICATION_DEPRECATED indicates that this image is deprecated + // IMAGE_CLASSIFICATION_DEPRECATED indicates that this image is deprecated. IMAGE_CLASSIFICATION_DEPRECATED = 3 [(enum_string_value) = "deprecated"]; } diff --git a/proto/metalstack/api/v2/ip.proto b/proto/metalstack/api/v2/ip.proto index cf7fe208..0946c5c2 100644 --- a/proto/metalstack/api/v2/ip.proto +++ b/proto/metalstack/api/v2/ip.proto @@ -42,50 +42,50 @@ service IPService { } } -// IPType specifies different IP address types +// IPType specifies different IP address types. enum IPType { - // IP_TYPE_UNSPECIFIED is not specified + // IP_TYPE_UNSPECIFIED is not specified. IP_TYPE_UNSPECIFIED = 0; - // IP_TYPE_EPHEMERAL defines an ephemeral IP address which is freed/deleted after usage + // IP_TYPE_EPHEMERAL defines an ephemeral IP address which is freed/deleted after usage. IP_TYPE_EPHEMERAL = 1 [(enum_string_value) = "ephemeral"]; - // IP_TYPE_STATIC defines a static ip address which must be freed/deleted explicitly + // IP_TYPE_STATIC defines a static ip address which must be freed/deleted explicitly. IP_TYPE_STATIC = 2 [(enum_string_value) = "static"]; } -// IPAddressFamily defines either IPv4 or IPv6 Addressfamily +// IPAddressFamily defines either IPv4 or IPv6 Addressfamily. enum IPAddressFamily { - // IP_ADDRESS_FAMILY_UNSPECIFIED is not specified + // IP_ADDRESS_FAMILY_UNSPECIFIED is not specified. IP_ADDRESS_FAMILY_UNSPECIFIED = 0; - // IP_ADDRESS_FAMILY_V4 defines a IPv4 address + // IP_ADDRESS_FAMILY_V4 defines a IPv4 address. IP_ADDRESS_FAMILY_V4 = 1 [(enum_string_value) = "ipv4"]; - // IP_ADDRESS_FAMILY_V6 defines a IPv6 address + // IP_ADDRESS_FAMILY_V6 defines a IPv6 address. IP_ADDRESS_FAMILY_V6 = 2 [(enum_string_value) = "ipv6"]; } -// IP is an IP address which can be used as loadbalancer addresses +// IP is an IP address which can be used as loadbalancer addresses. message IP { // Uuid of this ip string uuid = 1 [(buf.validate.field).string.uuid = true]; // Meta for this ip Meta meta = 2; - // Ip is either ipv4 or ipv6 address + // Ip is either ipv4 or ipv6 address. string ip = 3 [(buf.validate.field).string.ip = true]; // Name of this ip string name = 4 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // Description of this ip string description = 5 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Network is the network this ip belongs to + // Network is the network this ip belongs to. string network = 6 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Project where this ip address belongs to + // Project where this ip address belongs to. string project = 7 [(buf.validate.field).string.uuid = true]; // Type of this ip IPType type = 8 [(buf.validate.field).enum.defined_only = true]; - // Namespace if specified this ip is from a namespaced network and can therefore overlap with others + // Namespace if specified this ip is from a namespaced network and can therefore overlap with others. // Will be equal with project most of the time optional string namespace = 9 [(buf.validate.field).string.uuid = true]; } -// IPServiceGetRequest is the request payload for an IP get request +// IPServiceGetRequest is the request payload for an IP get request. message IPServiceGetRequest { // IP of the ip to get string ip = 1 [(buf.validate.field).string.ip = true]; @@ -95,9 +95,9 @@ message IPServiceGetRequest { optional string namespace = 3 [(buf.validate.field).string.uuid = true]; } -// IPServiceCreateRequest is the request payload for an IP create request +// IPServiceCreateRequest is the request payload for an IP create request. message IPServiceCreateRequest { - // Network from which the IP should be created + // Network from which the IP should be created. string network = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // Project of the ip string project = 2 [(buf.validate.field).string.uuid = true]; @@ -117,11 +117,11 @@ message IPServiceCreateRequest { optional IPAddressFamily address_family = 9 [(buf.validate.field).enum.defined_only = true]; } -// IPServiceUpdateRequest is the request payload for an IP update request +// IPServiceUpdateRequest is the request payload for an IP update request. message IPServiceUpdateRequest { // Ip the ip address to update string ip = 1 [(buf.validate.field).string.ip = true]; - // 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 update_meta = 2 [(buf.validate.field).required = true]; // Project id of the ip string project = 3 [(buf.validate.field).string.uuid = true]; @@ -135,19 +135,19 @@ message IPServiceUpdateRequest { optional UpdateLabels labels = 7; } -// IPServiceListRequest is the request payload for an IP list request +// IPServiceListRequest is the request payload for an IP list request. message IPServiceListRequest { // Project of the ips to list string project = 1 [(buf.validate.field).string.uuid = true]; - // Query to list one or more IPs + // Query to list one or more IPs. IPQuery query = 2; } -// IPQuery can be used to query a IP or a list of IP +// IPQuery can be used to query a IP or a list of IP. message IPQuery { // Ip the ip to list optional string ip = 1 [(buf.validate.field).string.ip = true]; - // Network from which the IPs are to list + // Network from which the IPs are to list. optional string network = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // Project of the ips to list optional string project = 3 [(buf.validate.field).string.uuid = true]; @@ -161,15 +161,15 @@ message IPQuery { optional string parent_prefix_cidr = 7 [(buf.validate.field).string.ip_prefix = true]; // Labels for which these IPs should be filtered optional Labels labels = 8; - // Static if set to true, this will be a Static ip + // Static if set to true, this will be a Static ip. optional IPType type = 9 [(buf.validate.field).enum.defined_only = true]; - // Address family of the IPs to list, defaults to all address families + // Address family of the IPs to list, defaults to all address families. optional IPAddressFamily address_family = 10 [(buf.validate.field).enum.defined_only = true]; // Namespace can be specified to get the ip of a namespace. optional string namespace = 11 [(buf.validate.field).string.uuid = true]; } -// IPServiceDeleteRequest is the request payload for a ip delete request +// IPServiceDeleteRequest is the request payload for a ip delete request. message IPServiceDeleteRequest { // IP of the ip to delete string ip = 1 [(buf.validate.field).string.ip = true]; @@ -177,31 +177,31 @@ message IPServiceDeleteRequest { string project = 2 [(buf.validate.field).string.uuid = true]; } -// IPServiceGetResponse is the response payload for an IP get request +// IPServiceGetResponse is the response payload for an IP get request. message IPServiceGetResponse { // Ip the ip IP ip = 1; } -// IPServiceUpdateResponse is the response payload for a ip update request +// IPServiceUpdateResponse is the response payload for a ip update request. message IPServiceUpdateResponse { // Ip the ip IP ip = 1; } -// IPServiceCreateResponse is the response payload for an IP create request +// IPServiceCreateResponse is the response payload for an IP create request. message IPServiceCreateResponse { // Ip the ip IP ip = 1; } -// IPServiceListResponse is the response payload for an IP list request +// IPServiceListResponse is the response payload for an IP list request. message IPServiceListResponse { // Ips the ips repeated IP ips = 1; } -// IPServiceDeleteResponse is the response payload for an IP delete request +// IPServiceDeleteResponse is the response payload for an IP delete request. message IPServiceDeleteResponse { // Ip the ip IP ip = 1; diff --git a/proto/metalstack/api/v2/machine.proto b/proto/metalstack/api/v2/machine.proto index dff40722..0b95528e 100644 --- a/proto/metalstack/api/v2/machine.proto +++ b/proto/metalstack/api/v2/machine.proto @@ -63,7 +63,7 @@ service MachineService { // ------------------------ Service Messages ---------------------------------- -// MachineServiceGetRequest is the request payload for a machine get request +// MachineServiceGetRequest is the request payload for a machine get request. message MachineServiceGetRequest { // UUID of the machine to get string uuid = 1 [(buf.validate.field).string.uuid = true]; @@ -71,13 +71,13 @@ message MachineServiceGetRequest { string project = 2 [(buf.validate.field).string.uuid = true]; } -// MachineServiceGetResponse is the response payload for a machine get request +// MachineServiceGetResponse is the response payload for a machine get request. message MachineServiceGetResponse { - // Machine is the machine requested + // Machine is the machine requested. Machine machine = 1; } -// MachineServiceCreateRequest is the request payload for a machine create request +// MachineServiceCreateRequest is the request payload for a machine create request. message MachineServiceCreateRequest { // Project of the machine string project = 1 [(buf.validate.field).string.uuid = true]; @@ -96,7 +96,7 @@ message MachineServiceCreateRequest { // Size of the machine to create, must be omitted if uuid is given optional string size = 7 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // Image which should be installed on this machine - // The image can be specified either in the fully qualified form, e.g. including os, major, minor and patch + // The image can be specified either in the fully qualified form, e.g. including os, major, minor and patch. // - debian-13.0.20260402 // or in a simplified form which omits the patch version // - debian-13.0 @@ -107,7 +107,7 @@ message MachineServiceCreateRequest { // Is defaulted by a lookup at the available fsls for this size and image. // Can be specified to test new fsls during development of fsls optional string filesystem_layout = 9 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // SSHPublicKeys defines the ssh public key to be installed on the machine to access it via ssh + // SSHPublicKeys defines the ssh public key to be installed on the machine to access it via ssh. repeated string ssh_public_keys = 10 [ (buf.validate.field).repeated = { // At most 50 keys can be stored. @@ -120,7 +120,7 @@ message MachineServiceCreateRequest { }, (buf.validate.field).repeated.(metalstack.api.v2.all_trimmed) = true ]; - // Userdata contains instructions required to bootstrap the machine + // Userdata contains instructions required to bootstrap the machine. // AWS limits the max userdata size to 16k, lets allow twice as much optional string userdata = 11 [ (buf.validate.field).string = {max_len: 32768}, @@ -139,27 +139,27 @@ message MachineServiceCreateRequest { repeated NTPServer ntp_servers = 16 [(buf.validate.field).repeated.max_items = 10]; // AllocationType of this machine MachineAllocationType allocation_type = 17 [(buf.validate.field).enum.defined_only = true]; - // FirewallSpec provides firewall specific parameters if allocationType is firewall + // FirewallSpec provides firewall specific parameters if allocationType is firewall. FirewallSpec firewall_spec = 18; } -// FirewallSpec contains firewall specific firewall creation parameters +// FirewallSpec contains firewall specific firewall creation parameters. message FirewallSpec { // FirewallRules to be applied if this is a firewall FirewallRules firewall_rules = 1; } -// MachineServiceCreateResponse is the response payload for a machine create request +// MachineServiceCreateResponse is the response payload for a machine create request. message MachineServiceCreateResponse { // Machine which was created Machine machine = 1; } -// MachineServiceUpdateRequest is the request payload for a machine update request +// MachineServiceUpdateRequest is the request payload for a machine update request. message MachineServiceUpdateRequest { // UUID of the machine to modify string uuid = 1 [(buf.validate.field).string.uuid = true]; - // 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 update_meta = 2 [(buf.validate.field).required = true]; // Project of the machine string project = 3 [(buf.validate.field).string.uuid = true]; @@ -182,27 +182,27 @@ message MachineServiceUpdateRequest { ]; } -// MachineServiceUpdateResponse is the response payload for a machine update request +// MachineServiceUpdateResponse is the response payload for a machine update request. message MachineServiceUpdateResponse { // Machine which was updated Machine machine = 1; } -// MachineServiceListRequest is the request payload for a machine list request +// MachineServiceListRequest is the request payload for a machine list request. message MachineServiceListRequest { // Project of the machines to list string project = 1 [(buf.validate.field).string.uuid = true]; - // Query to list one ore more machines + // Query to list one ore more machines. MachineQuery query = 2; } -// MachineServiceListResponse is the response payload for a machine list request +// MachineServiceListResponse is the response payload for a machine list request. message MachineServiceListResponse { - // Machines are the machines requested by a list request + // Machines are the machines requested by a list request. repeated Machine machines = 1; } -// MachineServiceDeleteRequest is the request payload for a machine delete request +// MachineServiceDeleteRequest is the request payload for a machine delete request. message MachineServiceDeleteRequest { // UUID of the machine to delete string uuid = 1 [(buf.validate.field).string.uuid = true]; @@ -210,13 +210,13 @@ message MachineServiceDeleteRequest { string project = 2 [(buf.validate.field).string.uuid = true]; } -// MachineServiceDeleteResponse is the response payload for a machine delete request +// MachineServiceDeleteResponse is the response payload for a machine delete request. message MachineServiceDeleteResponse { // Machine which was deleted Machine machine = 1; } -// MachineServiceBMCCommandRequest is the request payload for a machine bmc command +// MachineServiceBMCCommandRequest is the request payload for a machine bmc command. message MachineServiceBMCCommandRequest { // UUID of the machine to send the command to string uuid = 1 [(buf.validate.field).string.uuid = true]; @@ -226,10 +226,10 @@ message MachineServiceBMCCommandRequest { MachineBMCCommand command = 3 [(buf.validate.field).enum.defined_only = true]; } -// MachineServiceBMCCommandResponse is the response payload for a machine bmc command +// MachineServiceBMCCommandResponse is the response payload for a machine bmc command. message MachineServiceBMCCommandResponse {} -// MachineServiceGetBMCRequest is the request payload for a machine getbmc request +// MachineServiceGetBMCRequest is the request payload for a machine getbmc request. message MachineServiceGetBMCRequest { // UUID of the machine to get string uuid = 1 [(buf.validate.field).string.uuid = true]; @@ -237,11 +237,11 @@ message MachineServiceGetBMCRequest { string project = 2 [(buf.validate.field).string.uuid = true]; } -// MachineServiceGetBMCResponse is the response payload for a machine getbmc request +// MachineServiceGetBMCResponse is the response payload for a machine getbmc request. message MachineServiceGetBMCResponse { // UUID of the machine string uuid = 1 [(buf.validate.field).string.uuid = true]; - // BMC contains the BMC details of this machine + // BMC contains the BMC details of this machine. MachineBMCReport bmc = 2; } @@ -255,9 +255,9 @@ message Machine { Meta meta = 2; // Partition where this machine resides Partition partition = 3; - // Rack where this machine is located + // Rack where this machine is located. string rack = 4 [(buf.validate.field).string = {max_len: 128}]; - // Room where this machine is located + // Room where this machine is located. string room = 5 [(buf.validate.field).string = {max_len: 128}]; // Size of this machine Size size = 6; @@ -265,17 +265,17 @@ message Machine { MachineHardware hardware = 7; // Allocation details MachineAllocation allocation = 8; - // Status contains several status details related to this machine + // Status contains several status details related to this machine. MachineStatus status = 9; - // MachineRecentProvisioningEvents contains the recent provisioning events + // MachineRecentProvisioningEvents contains the recent provisioning events. MachineRecentProvisioningEvents recent_provisioning_events = 10; } -// MachineStatus contains several status details related to this machine +// MachineStatus contains several status details related to this machine. message MachineStatus { - // Condition describes the availability + // Condition describes the availability. MachineCondition condition = 1; - // LEDState indicates the state of the indicator LED on this machine + // LEDState indicates the state of the indicator LED on this machine. MachineChassisIdentifyLEDState led_state = 2; // Liveliness of this machine MachineLiveliness liveliness = 3 [(buf.validate.field).enum.defined_only = true]; @@ -283,7 +283,7 @@ message MachineStatus { string metal_hammer_version = 4; } -// MachineCondition describes the availability of this machine +// MachineCondition describes the availability of this machine. message MachineCondition { // State the state of this machine. empty means available for all MachineState state = 1 [(buf.validate.field).enum.defined_only = true]; @@ -293,7 +293,7 @@ message MachineCondition { string issuer = 3 [(buf.validate.field).string = {max_len: 256}]; } -// MachineAllocation contains properties if this machine is allocated +// MachineAllocation contains properties if this machine is allocated. message MachineAllocation { // UUID of this machine allocation string uuid = 1 [(buf.validate.field).string.uuid = true]; @@ -347,25 +347,25 @@ message MachineAllocation { MachineVPN vpn = 17; } -// MachineAllocationNetwork defines which network should be attached to a machine and if ips should be autoacquired +// MachineAllocationNetwork defines which network should be attached to a machine and if ips should be autoacquired. message MachineAllocationNetwork { // Network the id of the network that this machine will be placed in string network = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // IPs to to attach to this machine additionally - // If none given, one ip address is acquired per network for the machine + // If none given, one ip address is acquired per network for the machine. // Order of ips is preserved on the loopback interface. repeated string ips = 2 [(buf.validate.field).repeated.(metalstack.api.v2.ips) = true]; } -// FirewallRules can be defined during firewall allocation +// FirewallRules can be defined during firewall allocation. message FirewallRules { - // Egress list of egress rules to be deployed during firewall allocation + // Egress list of egress rules to be deployed during firewall allocation. repeated FirewallEgressRule egress = 1; - // Ingress list of ingress rules to be deployed during firewall allocation + // Ingress list of ingress rules to be deployed during firewall allocation. repeated FirewallIngressRule ingress = 2; } -// FirewallEgressRule defines rules for outgoing traffic +// FirewallEgressRule defines rules for outgoing traffic. message FirewallEgressRule { // Protocol the protocol for the rule, defaults to tcp IPProtocol protocol = 1 [(buf.validate.field).enum.defined_only = true]; @@ -387,7 +387,7 @@ message FirewallEgressRule { }]; } -// FirewallIngressRule defines rules for incoming traffic +// FirewallIngressRule defines rules for incoming traffic. message FirewallIngressRule { // Protocol the protocol for the rule, defaults to tcp IPProtocol protocol = 1 [(buf.validate.field).enum.defined_only = true]; @@ -411,39 +411,39 @@ message FirewallIngressRule { }]; } -// IPProtocol defines tcp|udp +// IPProtocol defines tcp|udp. enum IPProtocol { - // IP_PROTOCOL_UNSPECIFIED is not specified + // IP_PROTOCOL_UNSPECIFIED is not specified. IP_PROTOCOL_UNSPECIFIED = 0; - // IP_PROTOCOL_TCP is tcp + // IP_PROTOCOL_TCP is tcp. IP_PROTOCOL_TCP = 1 [(enum_string_value) = "tcp"]; - // IP_PROTOCOL_UDP is udp + // IP_PROTOCOL_UDP is udp. IP_PROTOCOL_UDP = 2 [(enum_string_value) = "udp"]; } -// MachineNetwork contains details which network should be created on a allocated machine +// MachineNetwork contains details which network should be created on a allocated machine. message MachineNetwork { // Network the networkID of the allocated machine in this vrf string network = 1; // Prefixes the prefixes of this network repeated string prefixes = 2 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; - // DestinationPrefixes prefixes that are reachable within this network + // DestinationPrefixes prefixes that are reachable within this network. repeated string destination_prefixes = 3 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; // IPs the ip addresses of the allocated machine in this vrf repeated string ips = 4 [(buf.validate.field).repeated.(metalstack.api.v2.ips) = true]; // NetworkType the type of network of this vrf NetworkType network_type = 5 [(buf.validate.field).enum.defined_only = true]; - // NatType what type of nat if any should be used + // NatType what type of nat if any should be used. NATType nat_type = 6 [(buf.validate.field).enum.defined_only = true]; // VRF the vrf id uint64 vrf = 7; // ASN the autonomous system number for this network uint32 asn = 8; - // Project is the project uuid associated with this network + // Project is the project uuid associated with this network. optional string project = 9 [(buf.validate.field).string.uuid = true]; } -// MachineHardware contains hardware details +// MachineHardware contains hardware details. message MachineHardware { // Memory the total memory of the machine in bytes uint64 memory = 1; @@ -457,7 +457,7 @@ message MachineHardware { repeated MachineNic nics = 5; } -// MetalCPU contains details of a cpu in this machine +// MetalCPU contains details of a cpu in this machine. message MetalCPU { // Vendor of this cpu string vendor = 1 [(buf.validate.field).string = {max_len: 256}]; @@ -469,7 +469,7 @@ message MetalCPU { uint32 threads = 4; } -// MetalGPU contains details of a gpu in this machine +// MetalGPU contains details of a gpu in this machine. message MetalGPU { // Vendor of this gpu string vendor = 1 [(buf.validate.field).string = {max_len: 256}]; @@ -477,7 +477,7 @@ message MetalGPU { string model = 2 [(buf.validate.field).string = {max_len: 256}]; } -// MachineNic contains details of a network interface of this machine +// MachineNic contains details of a network interface of this machine. message MachineNic { // Mac the macaddress of this interface string mac = 1 [(buf.validate.field).string.(macaddress) = true]; @@ -497,7 +497,7 @@ message MachineNic { string hostname = 8; } -// MachineBlockDevice contains details of a block device of this machine +// MachineBlockDevice contains details of a block device of this machine. message MachineBlockDevice { // Name of this block device string name = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; @@ -505,9 +505,9 @@ message MachineBlockDevice { uint64 size = 2; } -// MachineState defines if the machine was locked or reserved from a operator +// MachineState defines if the machine was locked or reserved from a operator. enum MachineState { - // MACHINE_STATE_UNSPECIFIED is not specified + // MACHINE_STATE_UNSPECIFIED is not specified. MACHINE_STATE_UNSPECIFIED = 0 [(enum_string_value) = ""]; // MACHINE_STATE_TAINTED this machine is tainted, i.e. this machine is not considered during random machine allocation, but still by specifying the uuid MACHINE_STATE_TAINTED = 1 [(enum_string_value) = "tainted"]; @@ -517,7 +517,7 @@ enum MachineState { MACHINE_STATE_AVAILABLE = 3 [(enum_string_value) = "available"]; } -// MachineChassisIdentifyLEDState describes the identifier led state +// MachineChassisIdentifyLEDState describes the identifier led state. message MachineChassisIdentifyLEDState { // Value the state of this chassis identify LED. empty means LED-OFF string value = 1 [(buf.validate.field).string = {max_len: 128}]; @@ -525,25 +525,25 @@ message MachineChassisIdentifyLEDState { string description = 2 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; } -// MachineBMCReport is sent from the metal-bmc to update bmc and power related details +// MachineBMCReport is sent from the metal-bmc to update bmc and power related details. message MachineBMCReport { - // Bmc contains bmc details + // Bmc contains bmc details. MachineBMC bmc = 1; - // Bios contains bios details + // Bios contains bios details. MachineBios bios = 2; - // Fru contains field replaceable unit details + // Fru contains field replaceable unit details. MachineFRU fru = 3; - // PowerMetric contains the power statistics of the machine + // PowerMetric contains the power statistics of the machine. MachinePowerMetric power_metric = 4; - // PowerSupplies contains details about all power supplies and their state + // PowerSupplies contains details about all power supplies and their state. repeated MachinePowerSupply power_supplies = 5; - // LedState indicates the state of the indicator LED on this machine + // LedState indicates the state of the indicator LED on this machine. MachineChassisIdentifyLEDState led_state = 6; - // UpdatedAt contains the date when this data was last updated + // UpdatedAt contains the date when this data was last updated. google.protobuf.Timestamp updated_at = 7; } -// MachineBios contains BIOS details of this machine +// MachineBios contains BIOS details of this machine. message MachineBios { // Version the bios version string version = 1 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; @@ -553,7 +553,7 @@ message MachineBios { string date = 3 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; } -// MachineBMC describe details of the ipmi or out of band device +// MachineBMC describe details of the ipmi or out of band device. message MachineBMC { // Address of this ipmi device from outside in the form of : string address = 1 [(buf.validate.field).string.host_and_port = true]; @@ -571,27 +571,27 @@ message MachineBMC { string power_state = 7 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; } -// MachineFRU describes details to the machine which are required in case of a necessary replacement +// MachineFRU describes details to the machine which are required in case of a necessary replacement. message MachineFRU { - // ChassisPartNumber is the part number of the machine chassis + // ChassisPartNumber is the part number of the machine chassis. optional string chassis_part_number = 1 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // ChassisPartSerial is the serial number of the machine chassis + // ChassisPartSerial is the serial number of the machine chassis. optional string chassis_part_serial = 2 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // BoardMfg is the short description of the mainboard + // BoardMfg is the short description of the mainboard. optional string board_mfg = 3 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // BoardMfgSerial is the serial number of the mainboard + // BoardMfgSerial is the serial number of the mainboard. optional string board_mfg_serial = 4 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // BoardPartNumber is the part number of the mainboard + // BoardPartNumber is the part number of the mainboard. optional string board_part_number = 5 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // ProductManufacturer is the manufacturer of the machine + // ProductManufacturer is the manufacturer of the machine. optional string product_manufacturer = 6 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // ProductPartNumber is the part number of the machine + // ProductPartNumber is the part number of the machine. optional string product_part_number = 7 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // ProductSerial is the serial number of the machine + // ProductSerial is the serial number of the machine. optional string product_serial = 8 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; } -// MachinePowerMetric contains metrics of the power consumption of a machine +// MachinePowerMetric contains metrics of the power consumption of a machine. message MachinePowerMetric { // AverageConsumedWatts shall represent the // average power level that occurred averaged over the last IntervalInMin @@ -612,7 +612,7 @@ message MachinePowerMetric { float min_consumed_watts = 4; } -// MachinePowerSupply contains details of the power supply of a machine +// MachinePowerSupply contains details of the power supply of a machine. message MachinePowerSupply { // Health of the powersupply string health = 1; @@ -628,13 +628,13 @@ message MachineRecentProvisioningEvents { google.protobuf.Timestamp last_event_time = 2; // LastErrorEvent the last erroneous event received MachineProvisioningEvent last_error_event = 3; - // State can be either CrashLoop, FailedReclaim or something else + // State can be either CrashLoop, FailedReclaim or something else. MachineProvisioningEventState state = 4 [(buf.validate.field).enum.defined_only = true]; } // MachineProvisioningEventState possible event states enum MachineProvisioningEventState { - // MACHINE_PROVISIONING_EVENT_STATE_UNSPECIFIED is not specified + // MACHINE_PROVISIONING_EVENT_STATE_UNSPECIFIED is not specified. MACHINE_PROVISIONING_EVENT_STATE_UNSPECIFIED = 0 [(enum_string_value) = ""]; // MACHINE_PROVISIONING_EVENT_STATE_CRASHLOOP machine is in crash loop MACHINE_PROVISIONING_EVENT_STATE_CRASHLOOP = 1 [(enum_string_value) = "crashloop"]; @@ -642,9 +642,9 @@ enum MachineProvisioningEventState { MACHINE_PROVISIONING_EVENT_STATE_FAILED_RECLAIM = 2 [(enum_string_value) = "failed-reclaim"]; } -// MachineProvisioningEventType defines in which phase the machine actually is +// MachineProvisioningEventType defines in which phase the machine actually is. enum MachineProvisioningEventType { - // MACHINE_PROVISIONING_EVENT_TYPE_UNSPECIFIED is not specified + // MACHINE_PROVISIONING_EVENT_TYPE_UNSPECIFIED is not specified. MACHINE_PROVISIONING_EVENT_TYPE_UNSPECIFIED = 0; // MACHINE_PROVISIONING_EVENT_TYPE_ALIVE machine is alive MACHINE_PROVISIONING_EVENT_TYPE_ALIVE = 1 [(enum_string_value) = "Alive"]; @@ -670,7 +670,7 @@ enum MachineProvisioningEventType { MACHINE_PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM = 11 [(enum_string_value) = "Machine Reclaim"]; } -// MachineProvisioningEvent is an event that has occurred during provisioning +// MachineProvisioningEvent is an event that has occurred during provisioning. message MachineProvisioningEvent { // Time the time that this event was received google.protobuf.Timestamp time = 1; @@ -680,21 +680,21 @@ message MachineProvisioningEvent { string message = 3; } -// MachineVPN contains configuration data for the VPN connection +// MachineVPN contains configuration data for the VPN connection. message MachineVPN { // Address of VPN control plane string control_plane_address = 1; // Auth key used to connect to VPN string auth_key = 2; - // Connected indicate if this machine is connected to the VPN + // Connected indicate if this machine is connected to the VPN. bool connected = 3; // IPs of the machine connected to the vpn repeated string ips = 4 [(buf.validate.field).repeated.(metalstack.api.v2.ips) = true]; } -// MachineLiveliness specifies the liveliness of a machine +// MachineLiveliness specifies the liveliness of a machine. enum MachineLiveliness { - // MACHINE_LIVELINESS_UNSPECIFIED is not defined + // MACHINE_LIVELINESS_UNSPECIFIED is not defined. MACHINE_LIVELINESS_UNSPECIFIED = 0 [(enum_string_value) = ""]; // MACHINE_LIVELINESS_ALIVE liveliness is alive MACHINE_LIVELINESS_ALIVE = 1 [(enum_string_value) = "alive"]; @@ -704,27 +704,27 @@ enum MachineLiveliness { MACHINE_LIVELINESS_UNKNOWN = 3 [(enum_string_value) = "unknown"]; } -// MachineAllocationType defines if this is a machine or a firewall +// MachineAllocationType defines if this is a machine or a firewall. enum MachineAllocationType { - // MACHINE_ALLOCATION_TYPE_UNSPECIFIED is unspecified + // MACHINE_ALLOCATION_TYPE_UNSPECIFIED is unspecified. MACHINE_ALLOCATION_TYPE_UNSPECIFIED = 0 [(enum_string_value) = ""]; - // MACHINE_ALLOCATION_TYPE_MACHINE is a machine + // MACHINE_ALLOCATION_TYPE_MACHINE is a machine. MACHINE_ALLOCATION_TYPE_MACHINE = 1 [(enum_string_value) = "machine"]; - // MACHINE_ALLOCATION_TYPE_FIREWALL is a firewall + // MACHINE_ALLOCATION_TYPE_FIREWALL is a firewall. MACHINE_ALLOCATION_TYPE_FIREWALL = 2 [(enum_string_value) = "firewall"]; } -// MachineBMCCommand defines commands send to the BMC of the machine +// MachineBMCCommand defines commands send to the BMC of the machine. enum MachineBMCCommand { - // MACHINE_BMC_COMMAND_UNSPECIFIED is not defined + // MACHINE_BMC_COMMAND_UNSPECIFIED is not defined. MACHINE_BMC_COMMAND_UNSPECIFIED = 0; - // MACHINE_BMC_COMMAND_ON Power on the machine + // MACHINE_BMC_COMMAND_ON Power on the machine. MACHINE_BMC_COMMAND_ON = 1 [(enum_string_value) = "on"]; - // MACHINE_BMC_COMMAND_OFF Power off the machine + // MACHINE_BMC_COMMAND_OFF Power off the machine. MACHINE_BMC_COMMAND_OFF = 2 [(enum_string_value) = "off"]; - // MACHINE_BMC_COMMAND_RESET Power reset the machine + // MACHINE_BMC_COMMAND_RESET Power reset the machine. MACHINE_BMC_COMMAND_RESET = 3 [(enum_string_value) = "reset"]; - // MACHINE_BMC_COMMAND_CYCLE Power cycle the machine + // MACHINE_BMC_COMMAND_CYCLE Power cycle the machine. MACHINE_BMC_COMMAND_CYCLE = 4 [(enum_string_value) = "cycle"]; // MACHINE_BMC_COMMAND_BOOT_TO_BIOS boot the machine into bios MACHINE_BMC_COMMAND_BOOT_TO_BIOS = 5 [(enum_string_value) = "boot-to-bios"]; @@ -914,11 +914,11 @@ message MachineHardwareQuery { // Issues related -// MachineIssuesQuery defines which machine issues should be listed +// MachineIssuesQuery defines which machine issues should be listed. message MachineIssuesQuery { // MachineQuery to select specific machines metalstack.api.v2.MachineQuery machine_query = 1; - // Only includes the specified machine issue types + // Only includes the specified machine issue types. repeated MachineIssueType only = 2 [(buf.validate.field).repeated = { items: { enum: {defined_only: true} @@ -930,13 +930,13 @@ message MachineIssuesQuery { enum: {defined_only: true} } }]; - // Severity filters issue for given severity + // Severity filters issue for given severity. optional MachineIssueSeverity severity = 4 [(buf.validate.field).enum.defined_only = true]; - // LastErrorThreshold defines the last error threshold + // LastErrorThreshold defines the last error threshold. google.protobuf.Duration last_error_threshold = 5; } -// MachineIssues is a list of issues for a machine +// MachineIssues is a list of issues for a machine. message MachineIssues { // UUID of the machine for which the issues are listed string uuid = 1 [(buf.validate.field).string.uuid = true]; @@ -944,21 +944,21 @@ message MachineIssues { repeated MachineIssue issues = 2; } -// MachineIssue contains details of one issue +// MachineIssue contains details of one issue. message MachineIssue { // Type specifies the issue type (id) MachineIssueType type = 1 [(buf.validate.field).enum.defined_only = true]; - // Severity specifies the severity of an issue + // Severity specifies the severity of an issue. MachineIssueSeverity severity = 2 [(buf.validate.field).enum.defined_only = true]; - // Description provides an issue description + // Description provides an issue description. string description = 3 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // RefURL provides a link to a more detailed issue description in the metal-stack documentation + // RefURL provides a link to a more detailed issue description in the metal-stack documentation. string reference_url = 4 [(buf.validate.field).string.(metalstack.api.v2.is_uri) = true]; - // Details may contain additional details on an evaluated issue + // Details may contain additional details on an evaluated issue. string details = 5; } -// MachineIssueType defines which type of issue it is +// MachineIssueType defines which type of issue it is. enum MachineIssueType { // MACHINE_ISSUE_TYPE_UNSPECIFIED type is not specified MACHINE_ISSUE_TYPE_UNSPECIFIED = 0; @@ -990,7 +990,7 @@ enum MachineIssueType { MACHINE_ISSUE_TYPE_NO_PARTITION = 13 [(enum_string_value) = "no-partition"]; } -// MachineIssueSeverity defines the severity of an issue +// MachineIssueSeverity defines the severity of an issue. enum MachineIssueSeverity { // MACHINE_ISSUE_SEVERITY_UNSPECIFIED severity is not specified MACHINE_ISSUE_SEVERITY_UNSPECIFIED = 0; diff --git a/proto/metalstack/api/v2/method.proto b/proto/metalstack/api/v2/method.proto index 5152f3fd..6d031fc9 100644 --- a/proto/metalstack/api/v2/method.proto +++ b/proto/metalstack/api/v2/method.proto @@ -26,7 +26,7 @@ message MethodServiceListRequest {} // MethodServiceListResponse is the response payload for listing all public methods. message MethodServiceListResponse { - // Methods is a list of methods public callable + // Methods is a list of methods public callable. repeated string methods = 1; } @@ -35,16 +35,16 @@ message MethodServiceTokenScopedListRequest {} // MethodServiceTokenScopedListResponse is the response payload which contains all methods which are callable with the given token. message MethodServiceTokenScopedListResponse { - // Permissions contains a list of methods which can be called + // Permissions contains a list of methods which can be called. repeated MethodPermission permissions = 1; - // 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. map project_roles = 2; - // TenantRoles associates a tenant ID with the corresponding role of the token owner + // TenantRoles associates a tenant ID with the corresponding role of the token owner. map tenant_roles = 3; - // AdminRole defines the admin role of the token owner + // AdminRole defines the admin role of the token owner. optional AdminRole admin_role = 4 [(buf.validate.field).enum.defined_only = true]; - // InfraRole defines the infrastructure role of the token owner + // InfraRole defines the infrastructure role of the token owner. optional InfraRole infra_role = 5 [(buf.validate.field).enum.defined_only = true]; - // MachineRoles defines the machine roles of the token owner + // MachineRoles defines the machine roles of the token owner. map machine_roles = 6; } diff --git a/proto/metalstack/api/v2/network.proto b/proto/metalstack/api/v2/network.proto index a0be3190..a33a83dc 100644 --- a/proto/metalstack/api/v2/network.proto +++ b/proto/metalstack/api/v2/network.proto @@ -68,17 +68,17 @@ message NetworkServiceGetResponse { // NetworkServiceCreateRequest message NetworkServiceCreateRequest { - // Project where this network belongs to + // Project where this network belongs to. string project = 1 [(buf.validate.field).string.uuid = true]; // Name of this network optional string name = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // Description of this network optional string description = 3 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Partition where this network will be created + // Partition where this network will be created. optional string partition = 4 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; // Labels on this network Labels labels = 5; - // Parent Network points to the id of the parent network if any + // Parent Network points to the id of the parent network if any. optional string parent_network = 6 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // Length per addressfamily optional ChildPrefixLength length = 7; @@ -88,7 +88,7 @@ message NetworkServiceCreateRequest { // NetworkServiceCreateResponse message NetworkServiceCreateResponse { - // Network is the created network + // Network is the created network. Network network = 1; } @@ -96,7 +96,7 @@ message NetworkServiceCreateResponse { message NetworkServiceUpdateRequest { // ID of the network to get string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // 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 update_meta = 2 [(buf.validate.field).required = true]; // Project of the network string project = 3 [(buf.validate.field).string.uuid = true]; @@ -110,7 +110,7 @@ message NetworkServiceUpdateRequest { // NetworkServiceUpdateResponse message NetworkServiceUpdateResponse { - // Network is the updated network + // Network is the updated network. Network network = 1; } @@ -121,13 +121,13 @@ message NetworkServiceListRequest { (buf.validate.field).ignore = IGNORE_IF_ZERO_VALUE, (buf.validate.field).string.uuid = true ]; - // Query which specifies which networks to return + // Query which specifies which networks to return. NetworkQuery query = 2; } // NetworkServiceListResponse message NetworkServiceListResponse { - // Networks are the requested networks + // Networks are the requested networks. repeated Network networks = 1; } @@ -138,13 +138,13 @@ message NetworkServiceListBaseNetworksRequest { (buf.validate.field).ignore = IGNORE_IF_ZERO_VALUE, (buf.validate.field).string.uuid = true ]; - // Query which specifies which networks to return + // Query which specifies which networks to return. NetworkQuery query = 2; } // NetworkServiceListResponse message NetworkServiceListBaseNetworksResponse { - // Networks are the requested networks + // Networks are the requested networks. repeated Network networks = 1; } @@ -158,7 +158,7 @@ message NetworkServiceDeleteRequest { // NetworkServiceDeleteResponse message NetworkServiceDeleteResponse { - // Network is the deleted network + // Network is the deleted network. Network network = 1; } @@ -172,20 +172,20 @@ message Network { optional string name = 3 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // Description of this network optional string description = 4 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Partition where this network will be created + // Partition where this network will be created. optional string partition = 5 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; - // Project where this network belongs to + // Project where this network belongs to. optional string project = 6 [(buf.validate.field).string.uuid = true]; - // Namespace if specified, this network is namespaced and can therefore overlap with others + // Namespace if specified, this network is namespaced and can therefore overlap with others. // Will be equal with project most of the time optional string namespace = 7 [(buf.validate.field).string.uuid = true]; // Prefixes in this network repeated string prefixes = 8 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; // Destination Prefixes in this network repeated string destination_prefixes = 9 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; - // Default Child Prefix length defines the bit length of a child network created per address family, if not specified during the allocate request + // Default Child Prefix length defines the bit length of a child network created per address family, if not specified during the allocate request. ChildPrefixLength default_child_prefix_length = 10; - // Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length + // Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length. ChildPrefixLength min_child_prefix_length = 11; // Type of the network NetworkType type = 12 [(buf.validate.field).enum.defined_only = true]; @@ -193,15 +193,15 @@ message Network { NATType nat_type = 13 [(buf.validate.field).enum.defined_only = true]; // VRF of this network has this VNI. optional uint32 vrf = 14; - // Parent Network points to the id of the parent network if any + // Parent Network points to the id of the parent network if any. optional string parent_network = 15 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced + // AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced. repeated string additional_announcable_cidrs = 16 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; // Consumption of IPs and prefixes in this network NetworkConsumption consumption = 17; } -// NetworkQuery defines which networks to query +// NetworkQuery defines which networks to query. message NetworkQuery { // Id of the network to query optional string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; @@ -209,11 +209,11 @@ message NetworkQuery { optional string name = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // Description of this network optional string description = 3 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Partition where this network will be created + // Partition where this network will be created. optional string partition = 4 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; - // Project where this network belongs to + // Project where this network belongs to. optional string project = 5 [(buf.validate.field).string.uuid = true]; - // Namespace where this network belongs to + // Namespace where this network belongs to. optional string namespace = 6 [(buf.validate.field).string.uuid = true]; // Prefixes in this network repeated string prefixes = 7 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; @@ -221,7 +221,7 @@ message NetworkQuery { repeated string destination_prefixes = 8 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; // VRF of this network has this VNI. optional uint32 vrf = 9; - // Parent Network points to the id of the parent network if any + // Parent Network points to the id of the parent network if any. optional string parent_network = 10 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // Addressfamily to query optional NetworkAddressFamily address_family = 11 [(buf.validate.field).enum.defined_only = true]; @@ -247,11 +247,11 @@ message ChildPrefixLength { }]; } -// NetworkConsumption contains ip and prefix usage by addressfamily +// NetworkConsumption contains ip and prefix usage by addressfamily. message NetworkConsumption { // IPv4 network usage NetworkUsage ipv4 = 1; - // IPv6 network usage, this can be approximated for high numbers + // IPv6 network usage, this can be approximated for high numbers. NetworkUsage ipv6 = 2; } @@ -267,37 +267,37 @@ message NetworkUsage { uint64 used_prefixes = 4; } -// NATType defines how and if outgoing traffic is translated +// NATType defines how and if outgoing traffic is translated. enum NATType { - // NAT_TYPE_UNSPECIFIED indicates a unspecified nat type + // NAT_TYPE_UNSPECIFIED indicates a unspecified nat type. NAT_TYPE_UNSPECIFIED = 0; - // NAT_TYPE_NONE indicates that no nat is configured + // NAT_TYPE_NONE indicates that no nat is configured. NAT_TYPE_NONE = 1 [(enum_string_value) = "none"]; // NAT_TYPE_IPV4_MASQUERADE masquerade ipv4 behind gateway ip when traffic enters this network NAT_TYPE_IPV4_MASQUERADE = 2 [(enum_string_value) = "ipv4-masq"]; } -// NetworkType indicates the purpose of the network, it cannot be changed after creation +// NetworkType indicates the purpose of the network, it cannot be changed after creation. enum NetworkType { - // NETWORK_TYPE_UNSPECIFIED indicates a unknown network type + // NETWORK_TYPE_UNSPECIFIED indicates a unknown network type. NETWORK_TYPE_UNSPECIFIED = 0; - // NETWORK_TYPE_EXTERNAL indicates network where multiple projects can allocate ips, it offers connectivity to other external networks + // NETWORK_TYPE_EXTERNAL indicates network where multiple projects can allocate ips, it offers connectivity to other external networks. // In most cases this is the internet network or a network which offers connectivity to legacy datacenter networks. // If it is not project scoped everyone can allocate Ips in this network, otherwise only from the same project ip allocation is possible. NETWORK_TYPE_EXTERNAL = 1 [(enum_string_value) = "external"]; - // NETWORK_TYPE_UNDERLAY indicates a underlay network + // NETWORK_TYPE_UNDERLAY indicates a underlay network. // The underlay network connects all switches and the firewalls to build a EVPN dataplane // It is not project scoped. Is part of the dataplane and reserved for administrative purposes. NETWORK_TYPE_UNDERLAY = 2 [(enum_string_value) = "underlay"]; - // NETWORK_TYPE_SUPER indicates a super network which is only used to create child networks + // NETWORK_TYPE_SUPER indicates a super network which is only used to create child networks. // If the vrf id is given, child networks will inherit this vrf. // If the vrf id is nil in this network, child vrf is taken from the pool. // If the partition is given, child networks inherit the partition. // If the partition is nil, child networks also do not have a partition (i.e. requires vrf is distributed across all partitions). // If the partition is given, only one super network in that partition can be created. // If the partition is nil, multiple super networks can exist. Then, for child network creation the network id must be specified (base networks can be queried by label selector). - // For child creation destination prefixes will be inherited + // For child creation destination prefixes will be inherited. // If this is project scoped, the child project must match, otherwise can be freely specified. NETWORK_TYPE_SUPER = 3 [(enum_string_value) = "super"]; // NETWORK_TYPE_SUPER_NAMESPACED indicates a super network which is only used to create child networks. @@ -320,14 +320,14 @@ enum NetworkType { NETWORK_TYPE_CHILD_SHARED = 6 [(enum_string_value) = "child-shared"]; } -// NetworkAddressFamily defines the address family of a network +// NetworkAddressFamily defines the address family of a network. enum NetworkAddressFamily { - // NETWORK_ADDRESS_FAMILY_UNSPECIFIED is not specified + // NETWORK_ADDRESS_FAMILY_UNSPECIFIED is not specified. NETWORK_ADDRESS_FAMILY_UNSPECIFIED = 0; - // NETWORK_ADDRESS_FAMILY_V4 defines a network with IPv4 address prefixes + // NETWORK_ADDRESS_FAMILY_V4 defines a network with IPv4 address prefixes. NETWORK_ADDRESS_FAMILY_V4 = 1 [(enum_string_value) = "ipv4"]; - // NETWORK_ADDRESS_FAMILY_V6 defines a network with IPv6 address prefixes + // NETWORK_ADDRESS_FAMILY_V6 defines a network with IPv6 address prefixes. NETWORK_ADDRESS_FAMILY_V6 = 2 [(enum_string_value) = "ipv6"]; - // NETWORK_ADDRESS_FAMILY_DUAL_STACK defines a network with both IPv4 and IPv6 address prefixes + // NETWORK_ADDRESS_FAMILY_DUAL_STACK defines a network with both IPv4 and IPv6 address prefixes. NETWORK_ADDRESS_FAMILY_DUAL_STACK = 3 [(enum_string_value) = "dual-stack"]; } diff --git a/proto/metalstack/api/v2/partition.proto b/proto/metalstack/api/v2/partition.proto index 8b9eab57..7dc5534a 100644 --- a/proto/metalstack/api/v2/partition.proto +++ b/proto/metalstack/api/v2/partition.proto @@ -20,7 +20,7 @@ service PartitionService { } } -// Partition is a failure domain with machines and switches +// Partition is a failure domain with machines and switches. message Partition { // ID of this partition string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; @@ -28,26 +28,26 @@ message Partition { Meta meta = 2; // Description of this partition string description = 3 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // PartitionBootConfiguration defines how metal-hammer boots + // PartitionBootConfiguration defines how metal-hammer boots. PartitionBootConfiguration boot_configuration = 4; // DNSServers for this partition repeated DNSServer dns_servers = 5 [(buf.validate.field).repeated.max_items = 3]; // NTPServers for this partition repeated NTPServer ntp_servers = 6 [(buf.validate.field).repeated.max_items = 10]; - // ManagementServiceAddresses defines where the management is reachable + // ManagementServiceAddresses defines where the management is reachable. // should be in the form : repeated string mgmt_service_addresses = 7 [(buf.validate.field).repeated.(metalstack.api.v2.are_host_and_port) = true]; } -// PartitionQuery is used to search partitions +// PartitionQuery is used to search partitions. message PartitionQuery { // ID of the partition to get optional string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; - // Labels lists only partitions containing the given labels + // Labels lists only partitions containing the given labels. optional Labels labels = 2; } -// PartitionBootConfiguration defines how metal-hammer boots +// PartitionBootConfiguration defines how metal-hammer boots. message PartitionBootConfiguration { // ImageURL the url to download the initrd for the boot image string image_url = 1 [(buf.validate.field).string.(metalstack.api.v2.is_uri) = true]; @@ -69,26 +69,26 @@ message NTPServer { string address = 1 [(buf.validate.field).string.(metalstack.api.v2.is_ip_or_hostname) = true]; } -// PartitionServiceGetRequest is the request payload for a partition get request +// PartitionServiceGetRequest is the request payload for a partition get request. message PartitionServiceGetRequest { // ID of the partition to get string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; } -// PartitionServiceListRequest is the request payload for a partition list request +// PartitionServiceListRequest is the request payload for a partition list request. message PartitionServiceListRequest { - // Query for partitions + // Query for partitions. PartitionQuery query = 1; } -// PartitionServiceGetResponse is the response payload for a partition get request +// PartitionServiceGetResponse is the response payload for a partition get request. message PartitionServiceGetResponse { - // Partition is the partition + // Partition is the partition. Partition partition = 1; } -// PartitionServiceListResponse is the response payload for a partition list request +// PartitionServiceListResponse is the response payload for a partition list request. message PartitionServiceListResponse { - // Partitions are the partitions + // Partitions are the partitions. repeated Partition partitions = 1; } diff --git a/proto/metalstack/api/v2/predefined_rules.proto b/proto/metalstack/api/v2/predefined_rules.proto index 638ad7df..4e4514b0 100644 --- a/proto/metalstack/api/v2/predefined_rules.proto +++ b/proto/metalstack/api/v2/predefined_rules.proto @@ -8,92 +8,92 @@ import "buf/validate/validate.proto"; // See https://celbyexample.com/ for cel documentation extend buf.validate.StringRules { - // Macaddress returns true if the given string is a valid macaddress + // Macaddress returns true if the given string is a valid macaddress. optional bool macaddress = 80048951 [(buf.validate.predefined).cel = { id: "string.macaddress" message: "this string must be a valid macaddress" expression: "this.matches('^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$')" }]; - // IsName returns true if name field satisfies our requirements + // IsName returns true if name field satisfies our requirements. optional bool is_name = 80048952 [(buf.validate.predefined).cel = { id: "string.is_name" message: "must be within 2 and 128 characters" expression: "this.size() >= 2 && this.size() <= 128" }]; - // IsDescription returns true if description field satisfies our requirements + // IsDescription returns true if description field satisfies our requirements. optional bool is_description = 80048953 [(buf.validate.predefined).cel = { id: "string.is_description" message: "must be shorter than 256 characters" expression: "this.size() <= 256" }]; - // IsPartition returns true if partition field satisfies our requirements + // IsPartition returns true if partition field satisfies our requirements. optional bool is_partition = 80048954 [(buf.validate.predefined).cel = { id: "string.is_partition" message: "must be within 2 and 128 characters" expression: "this.size() >= 2 && this.size() <= 128" }]; - // IsPrefix validates if the given string is a valid prefix + // IsPrefix validates if the given string is a valid prefix. optional bool is_prefix = 80048955 [(buf.validate.predefined).cel = { id: "string.prefixes" message: "given prefixes must be valid" expression: "this.isIpPrefix()" }]; - // IsUri validates if the given string is a valid URI + // IsUri validates if the given string is a valid URI. optional bool is_uri = 80048956 [(buf.validate.predefined).cel = { id: "string.uri" message: "given uri must be valid" expression: "this.isUri()" }]; - // IsIpOrHostname validates that the given string is either a ip or a hostname + // IsIpOrHostname validates that the given string is either a ip or a hostname. optional bool is_ip_or_hostname = 80048957 [(buf.validate.predefined).cel = { id: "valid_address" message: "must be a valid IP address or hostname" expression: "this.isIp() || this.isHostname()" }]; - // 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 [(buf.validate.predefined).cel = { id: "string.trimmed" message: "value must not start or end with whitespace" expression: "this.trim().size() == this.size()" }]; - // IsUser returns true if name field satisfies our requirements + // IsUser returns true if name field satisfies our requirements. optional bool is_user = 80048959 [(buf.validate.predefined).cel = { id: "string.is_user" message: "must be within 2 and 512 characters" expression: "this.size() >= 2 && this.size() <= 512" }]; - // IsOption returns true if name field satisfies our requirements + // IsOption returns true if name field satisfies our requirements. optional bool is_option = 80048960 [(buf.validate.predefined).cel = { id: "string.is_option" message: "must be within 1 and 128 characters" expression: "this.size() >= 1 && this.size() <= 128" }]; - // IsKey returns true if name field satisfies our requirements + // IsKey returns true if name field satisfies our requirements. optional bool is_key = 80048961 [(buf.validate.predefined).cel = { id: "string.is_key" message: "must be within 1 and 8192 characters" expression: "this.size() >= 1 && this.size() <= 8192" }]; - // IsTenantLogin returns true if name field satisfies our requirements + // IsTenantLogin returns true if name field satisfies our requirements. optional bool is_tenant_login = 80048962 [(buf.validate.predefined).cel = { id: "string.is_tenant_login" message: "must be within 2 and 128 characters" expression: "this.size() >= 2 && this.size() <= 128" }]; - // IsTenantSubjectPermission returns true if name field satisfies our requirements + // IsTenantSubjectPermission returns true if name field satisfies our requirements. optional bool is_tenant_subject_permission = 80048963 [(buf.validate.predefined).cel = { id: "string.is_tenant_subject_permission" message: "must be '*' or within 2 and 128 characters" expression: "this == '*' || this.size() >= 2 && this.size() <= 128" }]; - // IsProjectSubjectPermission returns true if name field satisfies our requirements + // IsProjectSubjectPermission returns true if name field satisfies our requirements. optional bool is_project_subject_permission = 80048964 [(buf.validate.predefined).cel = { id: "string.is_project_subject_permission" message: "must be '*' or a uuid" expression: "this == '*' || this.matches('^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$')" }]; - // IsMachineSubjectPermission returns true if name field satisfies our requirements + // IsMachineSubjectPermission returns true if name field satisfies our requirements. optional bool is_machine_subject_permission = 80048965 [(buf.validate.predefined).cel = { id: "string.is_machine_subject_permission" message: "must be '*' or a uuid" @@ -102,25 +102,25 @@ extend buf.validate.StringRules { } extend buf.validate.RepeatedRules { - // Prefixes validates if a slice of prefixes in string form are valid + // Prefixes validates if a slice of prefixes in string form are valid. optional bool prefixes = 80058951 [(buf.validate.predefined).cel = { id: "repeated.prefixes" message: "given prefixes must be valid" expression: "this.all(m, m.isIpPrefix())" }]; - // Ips validates if a slice of ips in string form are valid + // Ips validates if a slice of ips in string form are valid. optional bool ips = 80058952 [(buf.validate.predefined).cel = { id: "repeated.ips" message: "given ips must be valid" expression: "this.all(m, m.isIp())" }]; - // AreHostAndPort validates if a slice of strings are all in the form of : + // AreHostAndPort validates if a slice of strings are all in the form of :. optional bool are_host_and_port = 80058953 [(buf.validate.predefined).cel = { id: "repeated.are_host_and_port" message: "given entries must all be in the form of : but port is optional" expression: "this.all(m, m.isHostAndPort(false))" }]; - // All Trimmed enforces all strings to be trimmed, e.g. no whitespaces at the begin and end + // All Trimmed enforces all strings to be trimmed, e.g. no whitespaces at the begin and end. optional bool all_trimmed = 80058954 [(buf.validate.predefined).cel = { id: "repeated.all_trimmed" message: "given values must not start or end with whitespace" @@ -129,31 +129,31 @@ extend buf.validate.RepeatedRules { } extend buf.validate.MapRules { - // Keys and Values trimmed enforces all map keys and values to be trimmed, e.g. no whitespaces at the begin and end + // Keys and Values trimmed enforces all map keys and values to be trimmed, e.g. no whitespaces at the begin and end. optional bool keys_and_values_trimmed = 80068951 [(buf.validate.predefined).cel = { id: "map.keys_and_values_trimmed" message: "keys and values must not start or end with whitespace" expression: "this.all(k, k.trim().size() == k.size()) && this.all(v, v.trim().size() == v.size())" }]; - // Keys trimmed enforces all map keys and values to be trimmed, e.g. no whitespaces at the begin and end + // Keys trimmed enforces all map keys and values to be trimmed, e.g. no whitespaces at the begin and end. optional bool keys_trimmed = 80068952 [(buf.validate.predefined).cel = { id: "map.keys_trimmed" message: "keys must not start or end with whitespace" expression: "this.all(k, k.trim().size() == k.size())" }]; - // ProjectRolesKeysValid ensures that project roles keys met our requirements + // ProjectRolesKeysValid ensures that project roles keys met our requirements. optional bool project_roles_keys_valid = 80068953 [(buf.validate.predefined).cel = { id: "project_roles.key.valid" message: "subject must be a '*', or a valid UUID" expression: "this.all(k, k == '*' || k.matches('^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'))" }]; - // TenantRolesKeysValid ensures that tenant roles keys met our requirements + // TenantRolesKeysValid ensures that tenant roles keys met our requirements. optional bool tenant_roles_keys_valid = 80068954 [(buf.validate.predefined).cel = { id: "tenant_roles.key.valid" message: "subject must be '*' or between 2 and 128 characters" expression: "this.all(k, k == '*' || this.size() >= 2 || this.size() <=128 )" }]; - // MachineRolesKeysValid ensures that machine roles keys met our requirements + // MachineRolesKeysValid ensures that machine roles keys met our requirements. optional bool machine_roles_keys_valid = 80068955 [(buf.validate.predefined).cel = { id: "machine_roles.key.valid" message: "subject must be empty string, '*', or a valid UUID" diff --git a/proto/metalstack/api/v2/project.proto b/proto/metalstack/api/v2/project.proto index cff27a64..8c9322c0 100644 --- a/proto/metalstack/api/v2/project.proto +++ b/proto/metalstack/api/v2/project.proto @@ -21,61 +21,61 @@ service ProjectService { option (project_roles) = PROJECT_ROLE_VIEWER; option (auditing) = AUDITING_EXCLUDED; } - // Create a project + // Create a project. rpc Create(ProjectServiceCreateRequest) returns (ProjectServiceCreateResponse) { option (tenant_roles) = TENANT_ROLE_OWNER; option (tenant_roles) = TENANT_ROLE_EDITOR; option (auditing) = AUDITING_INCLUDED; } - // Delete a project + // Delete a project. rpc Delete(ProjectServiceDeleteRequest) returns (ProjectServiceDeleteResponse) { option (project_roles) = PROJECT_ROLE_OWNER; option (auditing) = AUDITING_INCLUDED; } - // Update a project + // Update a project. rpc Update(ProjectServiceUpdateRequest) returns (ProjectServiceUpdateResponse) { option (project_roles) = PROJECT_ROLE_OWNER; option (project_roles) = PROJECT_ROLE_EDITOR; option (auditing) = AUDITING_INCLUDED; } - // Leave project + // Leave project. rpc Leave(ProjectServiceLeaveRequest) returns (ProjectServiceLeaveResponse) { option (project_roles) = PROJECT_ROLE_VIEWER; option (auditing) = AUDITING_INCLUDED; } - // AddMember adds a user to a project + // AddMember adds a user to a project. rpc AddMember(ProjectServiceAddMemberRequest) returns (ProjectServiceAddMemberResponse) { option (project_roles) = PROJECT_ROLE_OWNER; option (auditing) = AUDITING_INCLUDED; } - // RemoveMember removes a user from a project + // RemoveMember removes a user from a project. rpc RemoveMember(ProjectServiceRemoveMemberRequest) returns (ProjectServiceRemoveMemberResponse) { option (project_roles) = PROJECT_ROLE_OWNER; option (auditing) = AUDITING_INCLUDED; } - // UpdateMember updates a user for a project + // UpdateMember updates a user for a project. rpc UpdateMember(ProjectServiceUpdateMemberRequest) returns (ProjectServiceUpdateMemberResponse) { option (project_roles) = PROJECT_ROLE_OWNER; option (auditing) = AUDITING_INCLUDED; } - // Invite a user to a project + // Invite a user to a project. rpc Invite(ProjectServiceInviteRequest) returns (ProjectServiceInviteResponse) { option (project_roles) = PROJECT_ROLE_OWNER; option (auditing) = AUDITING_INCLUDED; } - // InviteAccept is called by a user to accept an invitation + // InviteAccept is called by a user to accept an invitation. rpc InviteAccept(ProjectServiceInviteAcceptRequest) returns (ProjectServiceInviteAcceptResponse) { option (visibility) = VISIBILITY_SELF; option (auditing) = AUDITING_INCLUDED; } - // InviteDelete deletes a pending invitation + // InviteDelete deletes a pending invitation. rpc InviteDelete(ProjectServiceInviteDeleteRequest) returns (ProjectServiceInviteDeleteResponse) { option (project_roles) = PROJECT_ROLE_OWNER; option (auditing) = AUDITING_INCLUDED; } - // InvitesList list all invites to a project + // InvitesList list all invites to a project. rpc InvitesList(ProjectServiceInvitesListRequest) returns (ProjectServiceInvitesListResponse) { option (project_roles) = PROJECT_ROLE_OWNER; option (auditing) = AUDITING_EXCLUDED; @@ -87,7 +87,7 @@ service ProjectService { } } -// Project defines a group of resources belonging to a tenant +// Project defines a group of resources belonging to a tenant. // a tenant can have multiple projects message Project { // Uuid of this project @@ -104,11 +104,11 @@ message Project { optional string avatar_url = 6 [(buf.validate.field).string.(metalstack.api.v2.is_uri) = true]; } -// ProjectMember defines a user that participates in a project +// ProjectMember defines a user that participates in a project. message ProjectMember { - // Id is the user id of the member + // Id is the user id of the member. string id = 1; - // Role is the role of the member + // Role is the role of the member. ProjectRole role = 2 [(buf.validate.field).enum.defined_only = true]; // InheritedMembership indicates that this member has implicit permissions on the project through his membership within the tenant. // This member does not have direct project membership but gains permissions on this project from the role he has in the tenant. @@ -120,21 +120,21 @@ message ProjectMember { Meta meta = 5; } -// ProjectInvite defines invite to project +// ProjectInvite defines invite to project. message ProjectInvite { - // Secret is the secret part of the invite, typically part of the url + // Secret is the secret part of the invite, typically part of the url. string secret = 1; - // Project is the project id for which this invite was created + // Project is the project id for which this invite was created. string project = 2; - // Role is the role in this project the user will get after accepting the invitation + // Role is the role in this project the user will get after accepting the invitation. ProjectRole role = 3 [(buf.validate.field).enum.defined_only = true]; - // Joined is false as long as a user has not accepted the invite + // Joined is false as long as a user has not accepted the invite. bool joined = 4; - // ProjectName is the project name for which this invite was created + // ProjectName is the project name for which this invite was created. string project_name = 5; - // Tenant is the login of the tenant inviting another user to join this project + // Tenant is the login of the tenant inviting another user to join this project. string tenant = 6; - // TenantName is the name of the tenant inviting another user to join this project + // TenantName is the name of the tenant inviting another user to join this project. string tenant_name = 7; // ExpiresAt the date when this invite expires google.protobuf.Timestamp expires_at = 8; @@ -142,47 +142,47 @@ message ProjectInvite { google.protobuf.Timestamp joined_at = 9; } -// ProjectServiceListRequest is the request payload to list all projects +// ProjectServiceListRequest is the request payload to list all projects. message ProjectServiceListRequest { - // Query for projects + // Query for projects. ProjectQuery query = 1; } -// ProjectQuery is used to search projects +// ProjectQuery is used to search projects. message ProjectQuery { - // Uuid lists only projects with this uuid + // Uuid lists only projects with this uuid. optional string uuid = 1 [(buf.validate.field).string.uuid = true]; - // Name lists only projects with this name + // Name lists only projects with this name. optional string name = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Tenant lists only projects of this tenant + // Tenant lists only projects of this tenant. optional string tenant = 3 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; - // Labels lists only projects containing the given labels + // Labels lists only projects containing the given labels. optional Labels labels = 4; } -// ProjectServiceListResponse is the response payload to list all projects +// ProjectServiceListResponse is the response payload to list all projects. message ProjectServiceListResponse { - // Projects is a list of all your projects + // Projects is a list of all your projects. repeated Project projects = 1; } -// ProjectServiceGetRequest is the request payload to get a project +// ProjectServiceGetRequest is the request payload to get a project. message ProjectServiceGetRequest { - // Project is the uuid of the project to get + // Project is the uuid of the project to get. string project = 1 [(buf.validate.field).string.uuid = true]; } -// ProjectServiceGetResponse is the response payload to get a projects +// ProjectServiceGetResponse is the response payload to get a projects. message ProjectServiceGetResponse { - // Project is the project + // Project is the project. Project project = 1; // ProjectMembers in this project, projects guests will only see direct project members and not implicit memberships from tenant permissions repeated ProjectMember project_members = 2; } -// ProjectServiceCreateRequest is the request payload to Create a project +// ProjectServiceCreateRequest is the request payload to Create a project. message ProjectServiceCreateRequest { - // Login is the tenant of this project + // Login is the tenant of this project. // TODO: is login really a good name? string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // Name of this project, unique per tenant @@ -195,29 +195,29 @@ message ProjectServiceCreateRequest { Labels labels = 5; } -// ProjectServiceCreateResponse is the response payload of creation of a project +// ProjectServiceCreateResponse is the response payload of creation of a project. message ProjectServiceCreateResponse { - // Project is the project + // Project is the project. Project project = 1; } -// ProjectServiceDeleteRequest is the request payload to delete a project +// ProjectServiceDeleteRequest is the request payload to delete a project. message ProjectServiceDeleteRequest { - // Project is the uuid of the project to delete + // Project is the uuid of the project to delete. string project = 1 [(buf.validate.field).string.uuid = true]; } -// ProjectServiceDeleteResponse is the response payload to delete a project +// ProjectServiceDeleteResponse is the response payload to delete a project. message ProjectServiceDeleteResponse { - // Project is the project + // Project is the project. Project project = 1; } -// ProjectServiceUpdateRequest is the request payload to update a project +// ProjectServiceUpdateRequest is the request payload to update a project. message ProjectServiceUpdateRequest { - // Project is the uuid of the project to get + // Project is the uuid of the project to get. string project = 1 [(buf.validate.field).string.uuid = true]; - // 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 update_meta = 2 [(buf.validate.field).required = true]; // Name of this project unique per tenant optional string name = 3 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; @@ -229,65 +229,65 @@ message ProjectServiceUpdateRequest { optional UpdateLabels labels = 6; } -// ProjectServiceUpdateResponse is the response payload to update a project +// ProjectServiceUpdateResponse is the response payload to update a project. message ProjectServiceUpdateResponse { - // Project is the project + // Project is the project. Project project = 1; } -// ProjectServiceInviteRequest is used to invite a member to a project +// ProjectServiceInviteRequest is used to invite a member to a project. message ProjectServiceInviteRequest { - // Project is the uuid of the project + // Project is the uuid of the project. string project = 1 [(buf.validate.field).string.uuid = true]; // Role of this user in this project ProjectRole role = 2 [(buf.validate.field).enum.defined_only = true]; } -// ProjectServiceInviteResponse is the response payload to a invite member request +// ProjectServiceInviteResponse is the response payload to a invite member request. message ProjectServiceInviteResponse { - // Inviter contains a secret which can be sent to a potential user + // Inviter contains a secret which can be sent to a potential user. // can be appended to the invitation endpoint at our cloud console like // console.metalstack.cloud/invite/ ProjectInvite invite = 1; } -// ProjectServiceInvitesListRequest is the request payload to a list invites request +// ProjectServiceInvitesListRequest is the request payload to a list invites request. message ProjectServiceInvitesListRequest { - // Project is the uuid of the project + // Project is the uuid of the project. string project = 1 [(buf.validate.field).string.uuid = true]; } -// ProjectServiceInvitesListResponse is the response payload to a list invites request +// ProjectServiceInvitesListResponse is the response payload to a list invites request. message ProjectServiceInvitesListResponse { // Invites not already accepted the invitation to this project repeated ProjectInvite invites = 1; } -// ProjectServiceInviteGetRequest is the request payload to get a invite +// ProjectServiceInviteGetRequest is the request payload to get a invite. message ProjectServiceInviteGetRequest { // Secret of the invite to list string secret = 1; } -// ProjectServiceInviteGetResponse is the response payload to a get invite request +// ProjectServiceInviteGetResponse is the response payload to a get invite request. message ProjectServiceInviteGetResponse { - // Invite is the invite + // Invite is the invite. ProjectInvite invite = 1; } -// ProjectServiceLeaveRequest is used to leave a project +// ProjectServiceLeaveRequest is used to leave a project. message ProjectServiceLeaveRequest { - // Project is the uuid of the project + // Project is the uuid of the project. string project = 1 [(buf.validate.field).string.uuid = true]; } -// ProjectServiceLeaveResponse is the response payload to a leave project request +// ProjectServiceLeaveResponse is the response payload to a leave project request. message ProjectServiceLeaveResponse {} -// ProjectServiceAddMemberRequest is the request payload for adding a member to a project +// ProjectServiceAddMemberRequest is the request payload for adding a member to a project. message ProjectServiceAddMemberRequest { - // Project is the uuid of the project + // Project is the uuid of the project. string project = 1 [(buf.validate.field).string.uuid = true]; // Login of the member to add string member = 2 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; @@ -295,46 +295,46 @@ message ProjectServiceAddMemberRequest { ProjectRole role = 3 [(buf.validate.field).enum.defined_only = true]; } -// ProjectServiceAddMemberResponse is the response payload for the add member request +// ProjectServiceAddMemberResponse is the response payload for the add member request. message ProjectServiceAddMemberResponse { - // ProjectRole is the added project member + // ProjectRole is the added project member. ProjectRole project_member = 1; } -// ProjectServiceRemoveMemberRequest is used to remove a member from a project +// ProjectServiceRemoveMemberRequest is used to remove a member from a project. message ProjectServiceRemoveMemberRequest { - // Project is the uuid of the project + // Project is the uuid of the project. string project = 1 [(buf.validate.field).string.uuid = true]; - // Member is the id of the member to remove from this project + // Member is the id of the member to remove from this project. string member = 2; } -// ProjectServiceRemoveMemberResponse is the response payload to a remove member request +// ProjectServiceRemoveMemberResponse is the response payload to a remove member request. message ProjectServiceRemoveMemberResponse {} -// ProjectServiceUpdateMemberRequest is used to update a member of a project +// ProjectServiceUpdateMemberRequest is used to update a member of a project. message ProjectServiceUpdateMemberRequest { - // Project is the uuid of the project + // Project is the uuid of the project. string project = 1 [(buf.validate.field).string.uuid = true]; - // Member is the id of the member to remove from this project + // Member is the id of the member to remove from this project. string member = 2; - // Role is the role in this project the user will get after the update + // Role is the role in this project the user will get after the update. ProjectRole role = 3 [(buf.validate.field).enum.defined_only = true]; } -// ProjectServiceUpdateMemberResponse is the response payload to a update member request +// ProjectServiceUpdateMemberResponse is the response payload to a update member request. message ProjectServiceUpdateMemberResponse { - // ProjectMember is the updated project member + // ProjectMember is the updated project member. ProjectMember project_member = 1; } -// ProjectServiceInviteAcceptRequest is the request payload to a accept invite request +// ProjectServiceInviteAcceptRequest is the request payload to a accept invite request. message ProjectServiceInviteAcceptRequest { - // Secret is the invitation secret part of the invitation url + // Secret is the invitation secret part of the invitation url. string secret = 1; } -// ProjectServiceInviteAcceptResponse is the response payload to a accept invite request +// ProjectServiceInviteAcceptResponse is the response payload to a accept invite request. message ProjectServiceInviteAcceptResponse { // Project ID of the project joined string project = 1; @@ -342,13 +342,13 @@ message ProjectServiceInviteAcceptResponse { string project_name = 2; } -// ProjectServiceInviteDeleteRequest is the request payload to a delete invite +// ProjectServiceInviteDeleteRequest is the request payload to a delete invite. message ProjectServiceInviteDeleteRequest { - // Project is the uuid of the project + // Project is the uuid of the project. string project = 1 [(buf.validate.field).string.uuid = true]; // Secret of the invite to delete string secret = 2; } -// ProjectServiceInviteDeleteResponse is the response payload of a delete invite request +// ProjectServiceInviteDeleteResponse is the response payload of a delete invite request. message ProjectServiceInviteDeleteResponse {} diff --git a/proto/metalstack/api/v2/size.proto b/proto/metalstack/api/v2/size.proto index 53fa05fc..b769484f 100644 --- a/proto/metalstack/api/v2/size.proto +++ b/proto/metalstack/api/v2/size.proto @@ -20,25 +20,25 @@ service SizeService { } } -// SizeServiceGetRequest is the request payload for a size get request +// SizeServiceGetRequest is the request payload for a size get request. message SizeServiceGetRequest { // ID of the size to get string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; } -// SizeServiceListRequest is the request payload for a size list request +// SizeServiceListRequest is the request payload for a size list request. message SizeServiceListRequest { - // Query for sizes + // Query for sizes. SizeQuery query = 1; } -// SizeServiceGetResponse is the response payload for a size get request +// SizeServiceGetResponse is the response payload for a size get request. message SizeServiceGetResponse { // Size the size Size size = 1; } -// SizeServiceListResponse is the response payload for a size list request +// SizeServiceListResponse is the response payload for a size list request. message SizeServiceListResponse { // Sizes the sizes repeated Size sizes = 1; @@ -66,28 +66,28 @@ message SizeConstraint { uint64 min = 2; // Max the maximum value of the constraint uint64 max = 3; - // Identifier glob pattern which matches to the given type, for example gpu pci id + // Identifier glob pattern which matches to the given type, for example gpu pci id. optional string identifier = 4 [(buf.validate.field).string = { min_len: 0 max_len: 128 }]; } -// SizeConstraintType defines the property for which a constraint is defined +// SizeConstraintType defines the property for which a constraint is defined. enum SizeConstraintType { // SIZE_CONSTRAINT_TYPE_UNSPECIFIED type is not specified SIZE_CONSTRAINT_TYPE_UNSPECIFIED = 0; - // SIZE_CONSTRAINT_TYPE_CORES defines the number of cores as property + // SIZE_CONSTRAINT_TYPE_CORES defines the number of cores as property. SIZE_CONSTRAINT_TYPE_CORES = 1 [(enum_string_value) = "cores"]; - // SIZE_CONSTRAINT_TYPE_MEMORY defines the amount of memory as property + // SIZE_CONSTRAINT_TYPE_MEMORY defines the amount of memory as property. SIZE_CONSTRAINT_TYPE_MEMORY = 2 [(enum_string_value) = "memory"]; - // SIZE_CONSTRAINT_TYPE_STORAGE defines the amount of storage as property + // SIZE_CONSTRAINT_TYPE_STORAGE defines the amount of storage as property. SIZE_CONSTRAINT_TYPE_STORAGE = 3 [(enum_string_value) = "storage"]; - // SIZE_CONSTRAINT_TYPE_GPU defines the number of gpus as property + // SIZE_CONSTRAINT_TYPE_GPU defines the number of gpus as property. SIZE_CONSTRAINT_TYPE_GPU = 4 [(enum_string_value) = "gpu"]; } -// SizeQuery is used to search sizes +// SizeQuery is used to search sizes. message SizeQuery { // ID of the size to get optional string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; @@ -95,6 +95,6 @@ message SizeQuery { optional string name = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // Description of the size to query optional string description = 3 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Labels lists only sizes containing the given labels + // Labels lists only sizes containing the given labels. optional Labels labels = 4; } diff --git a/proto/metalstack/api/v2/size_imageconstraint.proto b/proto/metalstack/api/v2/size_imageconstraint.proto index ebc7ee43..0782d673 100644 --- a/proto/metalstack/api/v2/size_imageconstraint.proto +++ b/proto/metalstack/api/v2/size_imageconstraint.proto @@ -15,7 +15,7 @@ service SizeImageConstraintService { } } -// SizeImageConstraintServiceTryRequest is the request payload for a size image constraint try request +// SizeImageConstraintServiceTryRequest is the request payload for a size image constraint try request. message SizeImageConstraintServiceTryRequest { // Size to try string size = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; @@ -23,10 +23,10 @@ message SizeImageConstraintServiceTryRequest { string image = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; } -// SizeImageConstraintServiceTryResponse is the response payload for a size image constraint try request +// SizeImageConstraintServiceTryResponse is the response payload for a size image constraint try request. message SizeImageConstraintServiceTryResponse {} -// SizeImageConstraint expresses optional restrictions for specific size to image combinations +// SizeImageConstraint expresses optional restrictions for specific size to image combinations. // this might be required if the support for a specific hardware in a given size is only supported // with a newer version of the image. // @@ -34,7 +34,7 @@ message SizeImageConstraintServiceTryResponse {} // If the image in question is not found, no restrictions apply as well. // If the image in question is found, but does not match the given expression, machine creation must be forbidden. message SizeImageConstraint { - // Size where this constraint should apply + // Size where this constraint should apply. string size = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // ImageConstraints to apply to this size repeated ImageConstraint image_constraints = 2; @@ -46,7 +46,7 @@ message SizeImageConstraint { optional string description = 5 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; } -// ImageConstraint defines a constraint for an image +// ImageConstraint defines a constraint for an image. // examples: // images: // ubuntu: ">= 20.04.20211011" @@ -58,7 +58,7 @@ message ImageConstraint { string semver_match = 2 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; } -// SizeImageConstraintQuery is used to search size image constraints +// SizeImageConstraintQuery is used to search size image constraints. message SizeImageConstraintQuery { // Size of the size image constraint optional string size = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; diff --git a/proto/metalstack/api/v2/size_reservation.proto b/proto/metalstack/api/v2/size_reservation.proto index c2d9064a..c972d331 100644 --- a/proto/metalstack/api/v2/size_reservation.proto +++ b/proto/metalstack/api/v2/size_reservation.proto @@ -24,7 +24,7 @@ service SizeReservationService { } } -// SizeReservationServiceGetRequest is the request payload for a size get request +// SizeReservationServiceGetRequest is the request payload for a size get request. message SizeReservationServiceGetRequest { // ID of the size reservation to get string id = 1 [(buf.validate.field).string.uuid = true]; @@ -32,21 +32,21 @@ message SizeReservationServiceGetRequest { string project = 2 [(buf.validate.field).string.uuid = true]; } -// SizeReservationServiceListRequest is the request payload for a size list request +// SizeReservationServiceListRequest is the request payload for a size list request. message SizeReservationServiceListRequest { // Project of the size reservation string project = 1 [(buf.validate.field).string.uuid = true]; - // Query for size reservations + // Query for size reservations. SizeReservationQuery query = 2; } -// SizeReservationServiceGetResponse is the response payload for a size reservation get request +// SizeReservationServiceGetResponse is the response payload for a size reservation get request. message SizeReservationServiceGetResponse { // Size reservation SizeReservation size_reservation = 1; } -// SizeReservationServiceListResponse is the response payload for a size reservation list request +// SizeReservationServiceListResponse is the response payload for a size reservation list request. message SizeReservationServiceListResponse { // Size reservations repeated SizeReservation size_reservations = 1; @@ -79,7 +79,7 @@ message SizeReservation { int32 amount = 8 [(buf.validate.field).int32.gt = 0]; } -// SizeReservationQuery is used to search size reservations +// SizeReservationQuery is used to search size reservations. message SizeReservationQuery { // ID of the size reservation to get optional string id = 1 [(buf.validate.field).string.uuid = true]; @@ -93,6 +93,6 @@ message SizeReservationQuery { optional string project = 5 [(buf.validate.field).string.uuid = true]; // Partition of the size reservation optional string partition = 6 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; - // Labels lists only size reservations containing the given labels + // Labels lists only size reservations containing the given labels. optional Labels labels = 7; } diff --git a/proto/metalstack/api/v2/tenant.proto b/proto/metalstack/api/v2/tenant.proto index 629edf3a..2c6ec3a8 100644 --- a/proto/metalstack/api/v2/tenant.proto +++ b/proto/metalstack/api/v2/tenant.proto @@ -19,7 +19,7 @@ service TenantService { option (visibility) = VISIBILITY_SELF; option (auditing) = AUDITING_EXCLUDED; } - // Get a tenant + // Get a tenant. rpc Get(TenantServiceGetRequest) returns (TenantServiceGetResponse) { option (tenant_roles) = TENANT_ROLE_OWNER; option (tenant_roles) = TENANT_ROLE_EDITOR; @@ -27,32 +27,32 @@ service TenantService { option (tenant_roles) = TENANT_ROLE_GUEST; option (auditing) = AUDITING_EXCLUDED; } - // Update a tenant + // Update a tenant. rpc Update(TenantServiceUpdateRequest) returns (TenantServiceUpdateResponse) { option (tenant_roles) = TENANT_ROLE_OWNER; option (tenant_roles) = TENANT_ROLE_EDITOR; option (auditing) = AUDITING_INCLUDED; } - // Delete a tenant + // Delete a tenant. rpc Delete(TenantServiceDeleteRequest) returns (TenantServiceDeleteResponse) { option (tenant_roles) = TENANT_ROLE_OWNER; option (tenant_roles) = TENANT_ROLE_EDITOR; option (auditing) = AUDITING_INCLUDED; } - // Leave removes a member from a tenant + // Leave removes a member from a tenant. rpc Leave(TenantServiceLeaveRequest) returns (TenantServiceLeaveResponse) { option (tenant_roles) = TENANT_ROLE_VIEWER; option (auditing) = AUDITING_INCLUDED; } - // AddMember adds a member to a tenant + // AddMember adds a member to a tenant. rpc AddMember(TenantServiceAddMemberRequest) returns (TenantServiceAddMemberResponse) { option (tenant_roles) = TENANT_ROLE_OWNER; option (tenant_roles) = TENANT_ROLE_EDITOR; option (auditing) = AUDITING_INCLUDED; } - // RemoveMember removes a member from a tenant + // RemoveMember removes a member from a tenant. rpc RemoveMember(TenantServiceRemoveMemberRequest) returns (TenantServiceRemoveMemberResponse) { option (tenant_roles) = TENANT_ROLE_OWNER; option (auditing) = AUDITING_INCLUDED; @@ -64,22 +64,22 @@ service TenantService { option (auditing) = AUDITING_INCLUDED; } - // Invite a user to a tenant + // Invite a user to a tenant. rpc Invite(TenantServiceInviteRequest) returns (TenantServiceInviteResponse) { option (tenant_roles) = TENANT_ROLE_OWNER; option (auditing) = AUDITING_INCLUDED; } - // InviteAccept is called from a user to accept an invitation + // InviteAccept is called from a user to accept an invitation. rpc InviteAccept(TenantServiceInviteAcceptRequest) returns (TenantServiceInviteAcceptResponse) { option (visibility) = VISIBILITY_SELF; option (auditing) = AUDITING_INCLUDED; } - // InviteDelete deletes a pending invitation + // InviteDelete deletes a pending invitation. rpc InviteDelete(TenantServiceInviteDeleteRequest) returns (TenantServiceInviteDeleteResponse) { option (tenant_roles) = TENANT_ROLE_OWNER; option (auditing) = AUDITING_INCLUDED; } - // InvitesList list all invites to a tenant + // InvitesList list all invites to a tenant. rpc InvitesList(TenantServiceInvitesListRequest) returns (TenantServiceInvitesListResponse) { option (tenant_roles) = TENANT_ROLE_OWNER; option (auditing) = AUDITING_EXCLUDED; @@ -91,7 +91,7 @@ service TenantService { } } -// Tenant is a customer of the platform +// Tenant is a customer of the platform. message Tenant { // Login of the tenant string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; @@ -109,11 +109,11 @@ message Tenant { string created_by = 7; } -// TenantMember defines a user that participates in a tenant +// TenantMember defines a user that participates in a tenant. message TenantMember { - // Id is the user id of the member + // Id is the user id of the member. string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; - // Role is the role of the member + // Role is the role of the member. TenantRole role = 2 [(buf.validate.field).enum.defined_only = true]; // Projects in which a user is a direct member repeated string projects = 3; @@ -123,21 +123,21 @@ message TenantMember { Meta meta = 5; } -// TenantInvite defines invite to tenant +// TenantInvite defines invite to tenant. message TenantInvite { - // Secret is the secret part of the invite, typically part of the url + // Secret is the secret part of the invite, typically part of the url. string secret = 1; - // TargetTenant is the tenant id for which this invite was created + // TargetTenant is the tenant id for which this invite was created. string target_tenant = 2; - // Role is the role in this tenant the user will get after accepting the invitation + // Role is the role in this tenant the user will get after accepting the invitation. TenantRole role = 3 [(buf.validate.field).enum.defined_only = true]; - // Joined is false as long as a user has not accepted the invite + // Joined is false as long as a user has not accepted the invite. bool joined = 4; - // TargetTenantName is the tenant name for which this invite was created + // TargetTenantName is the tenant name for which this invite was created. string target_tenant_name = 5; - // Tenant is the login of the tenant inviting another user to join this tenant + // Tenant is the login of the tenant inviting another user to join this tenant. string tenant = 6; - // TenantName is the name of the tenant inviting another user to join this tenant + // TenantName is the name of the tenant inviting another user to join this tenant. string tenant_name = 7; // ExpiresAt the date when this invite expires google.protobuf.Timestamp expires_at = 8; @@ -145,31 +145,31 @@ message TenantInvite { google.protobuf.Timestamp joined_at = 9; } -// TenantServiceListRequest is the request payload of the tenant list request +// TenantServiceListRequest is the request payload of the tenant list request. message TenantServiceListRequest { - // Query for tenants + // Query for tenants. TenantQuery query = 1; } -// TenantQuery is used to search tenants +// TenantQuery is used to search tenants. message TenantQuery { - // Id filters tenants by login + // Id filters tenants by login. optional string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; - // Name filters tenants by name + // Name filters tenants by name. optional string name = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Labels lists only projects containing the given labels + // Labels lists only projects containing the given labels. optional Labels labels = 3; - // Paging details for the list request + // Paging details for the list request. Paging paging = 4; } -// TenantServiceGetRequest is the request payload of the tenant get request +// TenantServiceGetRequest is the request payload of the tenant get request. message TenantServiceGetRequest { // Login of the tenant string login = 1; } -// TenantServiceCreateRequest is the request payload of the tenant create request +// TenantServiceCreateRequest is the request payload of the tenant create request. message TenantServiceCreateRequest { // Name of this tenant string name = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; @@ -183,11 +183,11 @@ message TenantServiceCreateRequest { Labels labels = 5; } -// TenantServiceUpdateRequest is the request payload of the tenant update request +// TenantServiceUpdateRequest is the request payload of the tenant update request. message TenantServiceUpdateRequest { // Login of the tenant string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; - // 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 update_meta = 2 [(buf.validate.field).required = true]; // Name of the tenant optional string name = 3 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; @@ -201,45 +201,45 @@ message TenantServiceUpdateRequest { optional UpdateLabels labels = 7; } -// TenantServiceDeleteRequest is the request payload of the tenant delete request +// TenantServiceDeleteRequest is the request payload of the tenant delete request. message TenantServiceDeleteRequest { // Login of the tenant string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; } -// TenantServiceGetResponse is the response payload of the tenant get request +// TenantServiceGetResponse is the response payload of the tenant get request. message TenantServiceGetResponse { - // Tenant is the tenant + // Tenant is the tenant. Tenant tenant = 1; // TenantMembers of this tenant repeated TenantMember tenant_members = 2; } -// TenantServiceListResponse is the response payload of the tenant list request +// TenantServiceListResponse is the response payload of the tenant list request. message TenantServiceListResponse { - // Tenants is the list of tenants + // Tenants is the list of tenants. repeated Tenant tenants = 1; } -// TenantServiceCreateResponse is the response payload of the tenant create request +// TenantServiceCreateResponse is the response payload of the tenant create request. message TenantServiceCreateResponse { - // Tenant is the tenant + // Tenant is the tenant. Tenant tenant = 1; } -// TenantServiceUpdateResponse is the response payload of the tenant update request +// TenantServiceUpdateResponse is the response payload of the tenant update request. message TenantServiceUpdateResponse { - // Tenant is the tenant + // Tenant is the tenant. Tenant tenant = 1; } -// TenantServiceDeleteResponse is the response payload of the tenant delete request +// TenantServiceDeleteResponse is the response payload of the tenant delete request. message TenantServiceDeleteResponse { - // Tenant is the tenant + // Tenant is the tenant. Tenant tenant = 1; } -// TenantServiceInviteRequest is used to invite a member to a tenant +// TenantServiceInviteRequest is used to invite a member to a tenant. message TenantServiceInviteRequest { // Login of the tenant string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; @@ -247,68 +247,68 @@ message TenantServiceInviteRequest { TenantRole role = 2 [(buf.validate.field).enum.defined_only = true]; } -// TenantServiceInviteRequest is the response payload to a invite member request +// TenantServiceInviteRequest is the response payload to a invite member request. message TenantServiceInviteResponse { - // Invite contains a secret which can be sent to a potential user + // Invite contains a secret which can be sent to a potential user. // can be appended to the invitation endpoint at our cloud console like // console.metalstack.cloud/invite/ TenantInvite invite = 1; } -// TenantServiceInvitesListRequest is the request payload to a list invites request +// TenantServiceInvitesListRequest is the request payload to a list invites request. message TenantServiceInvitesListRequest { // Login of the tenant string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; } -// TenantServiceInvitesListResponse is the response payload to a list invites request +// TenantServiceInvitesListResponse is the response payload to a list invites request. message TenantServiceInvitesListResponse { // Invites that have not yet accepted the invitation to this tenant repeated TenantInvite invites = 1; } -// TenantServiceInviteGetRequest is the request payload to get a invite +// TenantServiceInviteGetRequest is the request payload to get a invite. message TenantServiceInviteGetRequest { // Secret of the invite to get string secret = 1; } -// TenantServiceInviteGetResponse is the response payload to a get invite request +// TenantServiceInviteGetResponse is the response payload to a get invite request. message TenantServiceInviteGetResponse { - // Invite is the invite + // Invite is the invite. TenantInvite invite = 1; } -// TenantServiceRemoveMemberRequest is used to remove a member from a tenant +// TenantServiceRemoveMemberRequest is used to remove a member from a tenant. message TenantServiceRemoveMemberRequest { // Login of the tenant string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; - // Member is the id of the member to remove from this tenant + // Member is the id of the member to remove from this tenant. string member = 2; } -// TenantServiceLeaveTenantRequest is used to leave a tenant +// TenantServiceLeaveTenantRequest is used to leave a tenant. message TenantServiceLeaveRequest { // Login of the tenant string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; } -// TenantServiceLeaveTenantResponse is the response payload to a leave tenant request +// TenantServiceLeaveTenantResponse is the response payload to a leave tenant request. message TenantServiceLeaveResponse {} -// TenantServiceRemoveMemberResponse is the response payload to a remove member request +// TenantServiceRemoveMemberResponse is the response payload to a remove member request. message TenantServiceRemoveMemberResponse { - // TenantMember is the removed tenant member + // TenantMember is the removed tenant member. TenantMember tenant_member = 1; } -// TenantServiceInviteAcceptRequest is the request payload to a accept invite request +// TenantServiceInviteAcceptRequest is the request payload to a accept invite request. message TenantServiceInviteAcceptRequest { - // Secret is the invitation secret part of the invitation url + // Secret is the invitation secret part of the invitation url. string secret = 1; } -// TenantServiceInviteAcceptResponse is the response payload to a accept invite request +// TenantServiceInviteAcceptResponse is the response payload to a accept invite request. message TenantServiceInviteAcceptResponse { // Tenant ID of the joined tenant string tenant = 1; @@ -316,7 +316,7 @@ message TenantServiceInviteAcceptResponse { string tenant_name = 2; } -// TenantServiceInviteDeleteRequest is the request payload to a delete invite +// TenantServiceInviteDeleteRequest is the request payload to a delete invite. message TenantServiceInviteDeleteRequest { // Login of the tenant string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; @@ -324,10 +324,10 @@ message TenantServiceInviteDeleteRequest { string secret = 2; } -// TenantServiceInviteDeleteResponse is the response payload of a delete invite request +// TenantServiceInviteDeleteResponse is the response payload of a delete invite request. message TenantServiceInviteDeleteResponse {} -// TenantServiceAddMemberRequest is the request payload for adding a member to a tenant +// TenantServiceAddMemberRequest is the request payload for adding a member to a tenant. message TenantServiceAddMemberRequest { // Login of the tenant to which the member will be added string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; @@ -337,24 +337,24 @@ message TenantServiceAddMemberRequest { TenantRole role = 3 [(buf.validate.field).enum.defined_only = true]; } -// TenantServiceAddMemberResponse is the response payload for the add member request +// TenantServiceAddMemberResponse is the response payload for the add member request. message TenantServiceAddMemberResponse { - // TenantMember is the added tenant member + // TenantMember is the added tenant member. TenantMember tenant_member = 1; } -// TenantServiceUpdateMemberRequest is used to update a member from a tenant +// TenantServiceUpdateMemberRequest is used to update a member from a tenant. message TenantServiceUpdateMemberRequest { // Login of the tenant string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; - // Member is the id of the member to update in this tenant + // Member is the id of the member to update in this tenant. string member = 2 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; // Role of this user in this tenant TenantRole role = 3 [(buf.validate.field).enum.defined_only = true]; } -// TenantServiceUpdateMemberResponse is the response payload to a update member request +// TenantServiceUpdateMemberResponse is the response payload to a update member request. message TenantServiceUpdateMemberResponse { - // TenantMember is the updated membership + // TenantMember is the updated membership. TenantMember tenant_member = 1; } diff --git a/proto/metalstack/api/v2/token.proto b/proto/metalstack/api/v2/token.proto index db3bcb3c..b893f66a 100644 --- a/proto/metalstack/api/v2/token.proto +++ b/proto/metalstack/api/v2/token.proto @@ -42,12 +42,12 @@ service TokenService { } } -// Token generates a jwt authentication token to access the api +// Token generates a jwt authentication token to access the api. // -// There are two different types of tokens, api- and user- tokens +// There are two different types of tokens, api- and user- tokens. // // A user token is used to authenticate end user requests for example from a cli. -// The configured roles in a user token are expanded in the api server +// The configured roles in a user token are expanded in the api server. // based on the memberships in other projects and tenants based on the role granted there. // User tokens will never contain permissions. // Permissions are always derived from the tenant and project roles and memberships. @@ -65,15 +65,15 @@ message Token { Meta meta = 3; // Description is a user given description of this token. string description = 4 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Permissions is a list of service methods this token can be used for + // Permissions is a list of service methods this token can be used for. repeated MethodPermission permissions = 5 [(buf.validate.field).repeated.max_items = 500]; - // Expires gives the date in the future after which this token can not be used anymore + // Expires gives the date in the future after which this token can not be used anymore. google.protobuf.Timestamp expires = 6; - // IssuedAt gives the date when this token was created + // IssuedAt gives the date when this token was created. google.protobuf.Timestamp issued_at = 7; - // TokenType describes the type of this token + // TokenType describes the type of this token. TokenType token_type = 8 [(buf.validate.field).enum.defined_only = true]; - // 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. map project_roles = 9 [ (buf.validate.field).map.(metalstack.api.v2.project_roles_keys_valid) = true, (buf.validate.field).map.values = { @@ -81,7 +81,7 @@ message Token { }, (buf.validate.field).map.(metalstack.api.v2.keys_trimmed) = true ]; - // TenantRoles associates a tenant id with the corresponding role of the token owner + // TenantRoles associates a tenant id with the corresponding role of the token owner. map tenant_roles = 10 [ (buf.validate.field).map.(metalstack.api.v2.tenant_roles_keys_valid) = true, (buf.validate.field).map.values = { @@ -89,12 +89,12 @@ message Token { }, (buf.validate.field).map.(metalstack.api.v2.keys_trimmed) = true ]; - // AdminRole defines the admin role of the token owner + // AdminRole defines the admin role of the token owner. optional AdminRole admin_role = 11 [(buf.validate.field).enum.defined_only = true]; - // InfraRole defines the infrastructure role of the token owner + // InfraRole defines the infrastructure role of the token owner. optional InfraRole infra_role = 12 [(buf.validate.field).enum.defined_only = true]; - // MachineRoles associates a machine uuid with the corresponding role of the token owner - // TODO: decide if we need this map from machine.uuid->role, we could instead use the subject in the token instead + // MachineRoles associates a machine uuid with the corresponding role of the token owner. + // TODO: decide if we need this map from machine.uuid->role, we could instead use the subject in the token instead. map machine_roles = 13 [ (buf.validate.field).map.(metalstack.api.v2.machine_roles_keys_valid) = true, (buf.validate.field).map.values = { @@ -104,29 +104,29 @@ message Token { ]; } -// TokenType specifies different use cases of tokens +// TokenType specifies different use cases of tokens. enum TokenType { - // TOKEN_TYPE_UNSPECIFIED is not specified + // TOKEN_TYPE_UNSPECIFIED is not specified. TOKEN_TYPE_UNSPECIFIED = 0; - // TOKEN_TYPE_API is a token for api usage + // TOKEN_TYPE_API is a token for api usage. TOKEN_TYPE_API = 1; // TOKEN_TYPE_USER is a token to access the api with cli, a web application or other user induced actions. TOKEN_TYPE_USER = 2; } -// TokenServiceCreateRequest is the request payload to create a token +// TokenServiceCreateRequest is the request payload to create a token. message TokenServiceCreateRequest { // Description of the token string description = 1 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Permissions is a list of service methods this token can be used for + // Permissions is a list of service methods this token can be used for. repeated PermissionsByVisibility permissions = 2 [(buf.validate.field).repeated.max_items = 100]; - // Expires gives the duration since now, after which this token can not be used anymore + // Expires gives the duration since now, after which this token can not be used anymore. google.protobuf.Duration expires = 3 [(buf.validate.field).duration = { - // Max token lifetime is one year + // Max token lifetime is one year. lt: {seconds: 31536001} gte: {seconds: 600} }]; - // 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. map project_roles = 4 [ (buf.validate.field).map.(metalstack.api.v2.project_roles_keys_valid) = true, (buf.validate.field).map.values = { @@ -134,7 +134,7 @@ message TokenServiceCreateRequest { }, (buf.validate.field).map.(metalstack.api.v2.keys_trimmed) = true ]; - // TenantRoles associates a tenant id with the corresponding role of the token owner + // TenantRoles associates a tenant id with the corresponding role of the token owner. map tenant_roles = 5 [ (buf.validate.field).map.(metalstack.api.v2.tenant_roles_keys_valid) = true, (buf.validate.field).map.values = { @@ -142,11 +142,11 @@ message TokenServiceCreateRequest { }, (buf.validate.field).map.(metalstack.api.v2.keys_trimmed) = true ]; - // AdminRole defines the admin role of the token owner + // AdminRole defines the admin role of the token owner. optional AdminRole admin_role = 6 [(buf.validate.field).enum.defined_only = true]; - // InfraRole defines the infrastructure role of the token owner + // InfraRole defines the infrastructure role of the token owner. optional InfraRole infra_role = 7 [(buf.validate.field).enum.defined_only = true]; - // MachineRoles associates a machine uuid with the corresponding role of the token owner + // MachineRoles associates a machine uuid with the corresponding role of the token owner. map machine_roles = 8 [ (buf.validate.field).map.(metalstack.api.v2.machine_roles_keys_valid) = true, (buf.validate.field).map.values = { @@ -158,7 +158,7 @@ message TokenServiceCreateRequest { Labels labels = 9; } -// MethodPermission is a mapping from a subject/project to a service method +// MethodPermission is a mapping from a subject/project to a service method. message MethodPermission { // Subject maybe either the project or the tenant // for which the methods should be allowed @@ -171,40 +171,40 @@ message MethodPermission { repeated string methods = 2 [(buf.validate.field).repeated.max_items = 500]; } -// PermissionsByVisibility contains method permissions by visibility +// PermissionsByVisibility contains method permissions by visibility. message PermissionsByVisibility { - // Visibility defines the visibility of the requested method permissions + // Visibility defines the visibility of the requested method permissions. oneof visibility { - // PublicPermissions carries public method permissions + // PublicPermissions carries public method permissions. PublicPermissions public = 1; - // SelfPermissions carries self method permissions + // SelfPermissions carries self method permissions. SelfPermissions self = 2; - // ProjectPermissions carries project method permissions + // ProjectPermissions carries project method permissions. ProjectPermissions project = 3; - // TenantPermissions carries tenant method permissions + // TenantPermissions carries tenant method permissions. TenantPermissions tenant = 4; - // AdminPermissions carries admin method permissions + // AdminPermissions carries admin method permissions. AdminPermissions admin = 5; - // MachinePermissions carries machine method permissions + // MachinePermissions carries machine method permissions. MachinePermissions machine = 6; - // InfraPermissions carries infra method permissions + // InfraPermissions carries infra method permissions. InfraPermissions infra = 7; } } -// PublicPermissions carries public method permissions +// PublicPermissions carries public method permissions. message PublicPermissions { // Methods which should be accessible repeated string methods = 2 [(buf.validate.field).repeated.max_items = 500]; } -// SelfPermissions carries self method permissions +// SelfPermissions carries self method permissions. message SelfPermissions { // Methods which should be accessible repeated string methods = 2 [(buf.validate.field).repeated.max_items = 500]; } -// ProjectPermissions carries project method permissions +// ProjectPermissions carries project method permissions. message ProjectPermissions { // asterisk (*) can be specified to match any subject string project = 1 [(buf.validate.field).string.(metalstack.api.v2.is_project_subject_permission) = true]; @@ -212,7 +212,7 @@ message ProjectPermissions { repeated string methods = 2 [(buf.validate.field).repeated.max_items = 500]; } -// TenantPermissions carries tenant method permissions +// TenantPermissions carries tenant method permissions. message TenantPermissions { // Login of the tenant // asterisk (*) can be specified to match any subject @@ -222,13 +222,13 @@ message TenantPermissions { repeated string methods = 2 [(buf.validate.field).repeated.max_items = 500]; } -// AdminPermissions carries admin method permissions +// AdminPermissions carries admin method permissions. message AdminPermissions { // Methods which should be accessible repeated string methods = 2 [(buf.validate.field).repeated.max_items = 500]; } -// MachinePermissions carries machine method permissions +// MachinePermissions carries machine method permissions. message MachinePermissions { // UUID of this machine // asterisk (*) can be specified to match any subject @@ -237,53 +237,53 @@ message MachinePermissions { repeated string methods = 2 [(buf.validate.field).repeated.max_items = 500]; } -// InfraPermissions carries infra method permissions +// InfraPermissions carries infra method permissions. message InfraPermissions { // Methods which should be accessible repeated string methods = 2 [(buf.validate.field).repeated.max_items = 500]; } -// TokenServiceCreateResponse is the response payload of a token create request +// TokenServiceCreateResponse is the response payload of a token create request. message TokenServiceCreateResponse { // Token which was created Token token = 1; - // Secret is the body of the JWT token, should be used in API requests as bearer token + // Secret is the body of the JWT token, should be used in API requests as bearer token. string secret = 2; } -// TokenServiceListRequest is the request payload to list tokens +// TokenServiceListRequest is the request payload to list tokens. message TokenServiceListRequest { - // Query for tokens + // Query for tokens. TokenQuery query = 1; } -// TokenServiceListResponse is the response payload of a token list request +// TokenServiceListResponse is the response payload of a token list request. message TokenServiceListResponse { - // Tokens is a list of tokens without the secrets + // Tokens is a list of tokens without the secrets. repeated Token tokens = 1; } -// TokenServiceRevokeRequest is the request payload of a token revoke request +// TokenServiceRevokeRequest is the request payload of a token revoke request. message TokenServiceRevokeRequest { // Uuid of the token to revoke string uuid = 1 [(buf.validate.field).string.uuid = true]; } -// TokenServiceRevokeResponse is the response payload of a token revoke request +// TokenServiceRevokeResponse is the response payload of a token revoke request. message TokenServiceRevokeResponse {} -// TokenServiceUpdateRequest is the request payload of a token update request +// TokenServiceUpdateRequest is the request payload of a token update request. message TokenServiceUpdateRequest { // Uuid of the token to update string uuid = 1 [(buf.validate.field).string.uuid = true]; - // UpdateMeta contains the timestamp and strategy to be used in this update request - // TokenUpdate is not guarded with optlock in the backend + // UpdateMeta contains the timestamp and strategy to be used in this update request. + // TokenUpdate is not guarded with optlock in the backend. UpdateMeta update_meta = 2 [(buf.validate.field).required = false]; // Description is a user given description of this token. optional string description = 3 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Permissions is a list of service methods this token can be used for + // Permissions is a list of service methods this token can be used for. repeated PermissionsByVisibility permissions = 4; - // 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. map project_roles = 5 [ (buf.validate.field).map.(metalstack.api.v2.project_roles_keys_valid) = true, (buf.validate.field).map.values = { @@ -291,7 +291,7 @@ message TokenServiceUpdateRequest { }, (buf.validate.field).map.(metalstack.api.v2.keys_trimmed) = true ]; - // TenantRoles associates a tenant id with the corresponding role of the token owner + // TenantRoles associates a tenant id with the corresponding role of the token owner. map tenant_roles = 6 [ (buf.validate.field).map.(metalstack.api.v2.tenant_roles_keys_valid) = true, (buf.validate.field).map.values = { @@ -299,11 +299,11 @@ message TokenServiceUpdateRequest { }, (buf.validate.field).map.(metalstack.api.v2.keys_trimmed) = true ]; - // AdminRole defines the admin role of the token owner + // AdminRole defines the admin role of the token owner. optional AdminRole admin_role = 7 [(buf.validate.field).enum.defined_only = true]; - // InfraRole defines the infrastructure role of the token owner + // InfraRole defines the infrastructure role of the token owner. optional InfraRole infra_role = 8 [(buf.validate.field).enum.defined_only = true]; - // MachineRoles associates a machine uuid with the corresponding role of the token owner + // MachineRoles associates a machine uuid with the corresponding role of the token owner. map machine_roles = 9 [ (buf.validate.field).map.(metalstack.api.v2.machine_roles_keys_valid) = true, (buf.validate.field).map.values = { @@ -315,38 +315,38 @@ message TokenServiceUpdateRequest { UpdateLabels labels = 10; } -// TokenServiceUpdateResponse is the response payload of a token update request +// TokenServiceUpdateResponse is the response payload of a token update request. message TokenServiceUpdateResponse { - // Token is the updated token + // Token is the updated token. Token token = 1; } -// TokenServiceGetRequest is the request payload of a token get request +// TokenServiceGetRequest is the request payload of a token get request. message TokenServiceGetRequest { // Uuid of the token to get string uuid = 1 [(buf.validate.field).string.uuid = true]; } -// TokenServiceGetResponse is the response payload of a token get request +// TokenServiceGetResponse is the response payload of a token get request. message TokenServiceGetResponse { - // Token is the token + // Token is the token. Token token = 1; } -// TokenServiceRefreshRequest is the request payload of a token refresh request +// TokenServiceRefreshRequest is the request payload of a token refresh request. // Permissions, Roles and Expiration duration and all other properties are inherited from the calling token. // The expiration duration will be calculated from the existing token (exp - iat) message TokenServiceRefreshRequest {} -// TokenServiceRefreshResponse is the response payload of a token refresh request +// TokenServiceRefreshResponse is the response payload of a token refresh request. message TokenServiceRefreshResponse { // Token which was refreshed Token token = 1; - // Secret is the body of the JWT token, should be used in API requests as bearer token + // Secret is the body of the JWT token, should be used in API requests as bearer token. string secret = 2; } -// TokenQuery is used to search tokens +// TokenQuery is used to search tokens. message TokenQuery { // UUID of the token to get optional string uuid = 1 [(buf.validate.field).string.uuid = true]; @@ -355,7 +355,7 @@ message TokenQuery { optional string user = 2 [(buf.validate.field).string.(metalstack.api.v2.is_user) = true]; // Description of the token to query optional string description = 3 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Labels lists only tokens containing the given labels + // Labels lists only tokens containing the given labels. optional Labels labels = 4; // Token type of the token to query optional TokenType token_type = 5 [(buf.validate.field).enum.defined_only = true]; diff --git a/proto/metalstack/api/v2/user.proto b/proto/metalstack/api/v2/user.proto index 5be7159b..07d201d6 100644 --- a/proto/metalstack/api/v2/user.proto +++ b/proto/metalstack/api/v2/user.proto @@ -19,7 +19,7 @@ service UserService { // User represents an end user of the platform. message User { - // Login is the login at the provider + // Login is the login at the provider. string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; // Name of the user string name = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; @@ -40,6 +40,6 @@ message UserServiceGetRequest {} // UserServiceGetResponse is the response payload for getting the user. message UserServiceGetResponse { - // User contains the authenticated user + // User contains the authenticated user. User user = 1; } diff --git a/proto/metalstack/api/v2/version.proto b/proto/metalstack/api/v2/version.proto index beb0c2e9..bfa9f9ea 100644 --- a/proto/metalstack/api/v2/version.proto +++ b/proto/metalstack/api/v2/version.proto @@ -32,6 +32,6 @@ message VersionServiceGetRequest {} // VersionServiceGetResponse is the response payload for getting the version. message VersionServiceGetResponse { - // Version contains the version of the application + // Version contains the version of the application. Version version = 1; } diff --git a/proto/metalstack/api/v2/vpn.proto b/proto/metalstack/api/v2/vpn.proto index 46788808..5a4f645e 100644 --- a/proto/metalstack/api/v2/vpn.proto +++ b/proto/metalstack/api/v2/vpn.proto @@ -18,6 +18,6 @@ message VPNNode { repeated string ip_addresses = 4 [(buf.validate.field).repeated.(metalstack.api.v2.ips) = true]; // LastSeen timestamp when this node reached out to the control plane google.protobuf.Timestamp last_seen = 5; - // Online indicates if this node is online + // Online indicates if this node is online. bool online = 6; } diff --git a/proto/metalstack/infra/v2/bmc.proto b/proto/metalstack/infra/v2/bmc.proto index 41491259..41bbba7e 100644 --- a/proto/metalstack/infra/v2/bmc.proto +++ b/proto/metalstack/infra/v2/bmc.proto @@ -28,9 +28,9 @@ service BMCService { // UpdateBMCInfoRequest is the request payload for updating BMC information. message UpdateBMCInfoRequest { - // Partition is the partition ID where metal-bmc wants to receive events + // Partition is the partition ID where metal-bmc wants to receive events. string partition = 1 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; - // BmcReports maps the BMC report per machine UUID + // BmcReports maps the BMC report per machine UUID. map bmc_reports = 2 [(buf.validate.field).map = { keys: { string: {uuid: true} @@ -40,15 +40,15 @@ message UpdateBMCInfoRequest { // UpdateBMCInfoResponse is the response payload for updating BMC information. message UpdateBMCInfoResponse { - // UpdatedMachines is a slice of machine UUIDs which were updated + // UpdatedMachines is a slice of machine UUIDs which were updated. repeated string updated_machines = 1; - // CreatedMachines is a slice of machine UUIDs which were created + // CreatedMachines is a slice of machine UUIDs which were created. repeated string created_machines = 2; } // WaitForBMCCommandRequest is the request payload for waiting for a BMC command. message WaitForBMCCommandRequest { - // Partition is the partition ID where metal-bmc wants to receive BMC commands + // Partition is the partition ID where metal-bmc wants to receive BMC commands. string partition = 1 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; } @@ -58,17 +58,17 @@ message WaitForBMCCommandResponse { string uuid = 1 [(buf.validate.field).string.uuid = true]; // BmcCommand to execute against the BMC of the machine metalstack.api.v2.MachineBMCCommand bmc_command = 2; - // MachineBmc contains connection details of the machine to issue the BMC command to + // MachineBmc contains connection details of the machine to issue the BMC command to. metalstack.api.v2.MachineBMC machine_bmc = 3; - // CommandId is a unique ID which must be sent back after execution - // It is usually in the form: :machine-bmc-command: + // CommandId is a unique ID which must be sent back after execution. + // It is usually in the form: :machine-bmc-command:. string command_id = 4; } // BMCCommandDoneRequest must be returned after command execution. message BMCCommandDoneRequest { - // CommandId is a unique ID which must be sent back after execution - // It is usually in the form: :machine-bmc-command + // CommandId is a unique ID which must be sent back after execution. + // It is usually in the form: :machine-bmc-command. string command_id = 1; // Error of the command execution, nil if it was successful optional string error = 2; diff --git a/proto/metalstack/infra/v2/boot.proto b/proto/metalstack/infra/v2/boot.proto index 53973784..311fa2c6 100644 --- a/proto/metalstack/infra/v2/boot.proto +++ b/proto/metalstack/infra/v2/boot.proto @@ -46,36 +46,36 @@ service BootService { } } -// BootServiceDhcpRequest is called once a machine issues a dhcp request +// BootServiceDhcpRequest is called once a machine issues a dhcp request. message BootServiceDhcpRequest { // UUID of the machine string uuid = 1 [(buf.validate.field).string.uuid = true]; - // Partition where this machine is located + // Partition where this machine is located. string partition = 2 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; } -// BootServiceDhcpResponse contains the response to a dhcp request +// BootServiceDhcpResponse contains the response to a dhcp request. message BootServiceDhcpResponse {} -// BootServiceBootRequest is called to get specified parameters to boot a machine with the given mac +// BootServiceBootRequest is called to get specified parameters to boot a machine with the given mac. message BootServiceBootRequest { // Mac address of the machine string mac = 1 [(buf.validate.field).string.(metalstack.api.v2.macaddress) = true]; - // Partition where this machine is located + // Partition where this machine is located. string partition = 2 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; } -// BootServiceBootResponse contains additional infos which are required to boot a machine +// BootServiceBootResponse contains additional infos which are required to boot a machine. message BootServiceBootResponse { - // Kernel is the url to the linux kernel to boot + // Kernel is the url to the linux kernel to boot. string kernel = 1 [(buf.validate.field).string.(metalstack.api.v2.is_uri) = true]; - // Initial ram disk is the url to the initial ram disk to boot + // Initial ram disk is the url to the initial ram disk to boot. repeated string init_ram_disks = 2; - // CMDLine contains kernel command line parameters to boot + // CMDLine contains kernel command line parameters to boot. optional string cmdline = 3 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; } -// BootServiceRegisterRequest is called from metal-hammer to register a machine with as much hardware details as possible +// BootServiceRegisterRequest is called from metal-hammer to register a machine with as much hardware details as possible. message BootServiceRegisterRequest { // UUID of this machine string uuid = 1 [(buf.validate.field).string.uuid = true]; @@ -89,9 +89,9 @@ message BootServiceRegisterRequest { metalstack.api.v2.MachineFRU fru = 5; // Tags of this machine repeated string tags = 6; - // MetalHammer version this machine was booted into + // MetalHammer version this machine was booted into. string metal_hammer_version = 7 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Partition where this machine is located + // Partition where this machine is located. string partition = 8 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; } @@ -99,13 +99,13 @@ message BootServiceRegisterRequest { message BootServiceRegisterResponse { // UUID of this machine string uuid = 1 [(buf.validate.field).string.uuid = true]; - // Size is the calculated size from given hardware details + // Size is the calculated size from given hardware details. string size = 2 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; // Partition of this machine string partition = 3 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; } -// BootServiceWaitRequest is called when a machine was registered and is waiting for allocation +// BootServiceWaitRequest is called when a machine was registered and is waiting for allocation. message BootServiceWaitRequest { // UUID of this machine string uuid = 1 [(buf.validate.field).string.uuid = true]; @@ -113,11 +113,11 @@ message BootServiceWaitRequest { // BootServiceWaitResponse response to a wait request message BootServiceWaitResponse { - // Allocation contains the machine.allocation to actually install the machine + // Allocation contains the machine.allocation to actually install the machine. metalstack.api.v2.MachineAllocation allocation = 1; } -// BootServiceInstallationSucceededRequest is sent from metal-hammer to the api to report the installation succeeded +// BootServiceInstallationSucceededRequest is sent from metal-hammer to the api to report the installation succeeded. message BootServiceInstallationSucceededRequest { // UUID of the machine to boot string uuid = 1 [(buf.validate.field).string.uuid = true]; @@ -128,7 +128,7 @@ message BootServiceInstallationSucceededRequest { }]; } -// BootServiceInstallationSucceededResponse is the response to a BootServiceInstallationSucceededRequest +// BootServiceInstallationSucceededResponse is the response to a BootServiceInstallationSucceededRequest. message BootServiceInstallationSucceededResponse {} // BootServiceSuperUserPasswordRequest this call returns the password for the machine superuser @@ -141,7 +141,7 @@ message BootServiceSuperUserPasswordRequest { message BootServiceSuperUserPasswordResponse { // FeatureDisabled on set the superuserpassword in the bmc if this feature is not disabled. bool feature_disabled = 1; - // SuperUserPassword is the password of the superuser on the ipmi device + // SuperUserPassword is the password of the superuser on the ipmi device. string super_user_password = 2 [(buf.validate.field).string = { min_len: 2 max_len: 128 diff --git a/proto/metalstack/infra/v2/component.proto b/proto/metalstack/infra/v2/component.proto index 204ecad2..489ea3ee 100644 --- a/proto/metalstack/infra/v2/component.proto +++ b/proto/metalstack/infra/v2/component.proto @@ -21,11 +21,11 @@ service ComponentService { // ComponentServicePingRequest is the request payload for pinging a microservice. message ComponentServicePingRequest { - // Type defines which service is actually pinging + // Type defines which service is actually pinging. metalstack.api.v2.ComponentType type = 1 [(buf.validate.field).enum.defined_only = true]; - // Identifier is a unique identifier of this service, for example if two instances are running, this might be the pod ID + // Identifier is a unique identifier of this service, for example if two instances are running, this might be the pod ID. string identifier = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // StartedAt is the timestamp this service was started + // StartedAt is the timestamp this service was started. google.protobuf.Timestamp started_at = 3 [(buf.validate.field).timestamp.lt_now = true]; // Interval at which the ping is scheduled, must be between 5 seconds and 1 hour google.protobuf.Duration interval = 4 [(buf.validate.field).duration = { diff --git a/proto/metalstack/infra/v2/event.proto b/proto/metalstack/infra/v2/event.proto index 48fcd30b..6e558634 100644 --- a/proto/metalstack/infra/v2/event.proto +++ b/proto/metalstack/infra/v2/event.proto @@ -24,6 +24,6 @@ message EventServiceSendRequest { message EventServiceSendResponse { // Events counts the number of events successfully stored in the database uint64 events = 1; - // 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. repeated string failed = 2; } diff --git a/proto/metalstack/infra/v2/switch.proto b/proto/metalstack/infra/v2/switch.proto index c9e90481..02f99a80 100644 --- a/proto/metalstack/infra/v2/switch.proto +++ b/proto/metalstack/infra/v2/switch.proto @@ -39,7 +39,7 @@ message SwitchServiceGetRequest { // SwitchServiceGetResponse is the response payload for getting a switch. message SwitchServiceGetResponse { - // Switch contains the requested switch + // Switch contains the requested switch. metalstack.api.v2.Switch switch = 1; } @@ -51,7 +51,7 @@ message SwitchServiceRegisterRequest { // SwitchServiceRegisterResponse is the response payload for registering a switch. message SwitchServiceRegisterResponse { - // Switch contains the registered switch + // Switch contains the registered switch. metalstack.api.v2.Switch switch = 1; } @@ -66,9 +66,9 @@ message SwitchServiceHeartbeatRequest { google.protobuf.Duration duration = 2; // Error if any occurred during the sync optional string error = 3; - // PortStates maps port identifiers to the respective port's operational state + // PortStates maps port identifiers to the respective port's operational state. map port_states = 4; - // BgpPortStates maps port identifiers to the respective port's BGP state + // BgpPortStates maps port identifiers to the respective port's BGP state. map bgp_port_states = 5; } @@ -76,8 +76,8 @@ message SwitchServiceHeartbeatRequest { message SwitchServiceHeartbeatResponse { // Id of the switch string id = 1; - // LastSync holds information about the last sync + // LastSync holds information about the last sync. metalstack.api.v2.SwitchSync last_sync = 2; - // LastSyncError holds information about the last erroneous sync + // LastSyncError holds information about the last erroneous sync. metalstack.api.v2.SwitchSync last_sync_error = 3; } From fc09d74fe44df0e9e4df641b2b1ef56815b93e3e Mon Sep 17 00:00:00 2001 From: Ilja Rotar Date: Wed, 12 Aug 2026 08:48:59 +0200 Subject: [PATCH 2/3] some more fixes --- proto/metalstack/admin/v2/audit.proto | 2 +- proto/metalstack/admin/v2/filesystem.proto | 38 +- proto/metalstack/admin/v2/image.proto | 16 +- proto/metalstack/admin/v2/machine.proto | 26 +- proto/metalstack/admin/v2/network.proto | 40 +- proto/metalstack/admin/v2/partition.proto | 28 +- proto/metalstack/admin/v2/size.proto | 12 +- .../admin/v2/size_imageconstraint.proto | 22 +- .../admin/v2/size_reservation.proto | 14 +- proto/metalstack/admin/v2/switch.proto | 20 +- proto/metalstack/admin/v2/task.proto | 16 +- proto/metalstack/admin/v2/tenant.proto | 20 +- proto/metalstack/admin/v2/token.proto | 4 +- proto/metalstack/admin/v2/vpn.proto | 8 +- proto/metalstack/api/v2/audit.proto | 14 +- proto/metalstack/api/v2/common.proto | 72 +-- proto/metalstack/api/v2/component.proto | 6 +- proto/metalstack/api/v2/filesystem.proto | 108 ++-- proto/metalstack/api/v2/health.proto | 24 +- proto/metalstack/api/v2/image.proto | 54 +- proto/metalstack/api/v2/ip.proto | 74 +-- proto/metalstack/api/v2/machine.proto | 496 +++++++++--------- proto/metalstack/api/v2/network.proto | 118 ++--- proto/metalstack/api/v2/partition.proto | 30 +- proto/metalstack/api/v2/project.proto | 64 +-- proto/metalstack/api/v2/size.proto | 32 +- .../api/v2/size_imageconstraint.proto | 31 +- .../metalstack/api/v2/size_reservation.proto | 40 +- proto/metalstack/api/v2/switch.proto | 12 +- proto/metalstack/api/v2/tenant.proto | 90 ++-- proto/metalstack/api/v2/token.proto | 70 +-- proto/metalstack/api/v2/user.proto | 12 +- proto/metalstack/api/v2/version.proto | 8 +- proto/metalstack/api/v2/vpn.proto | 10 +- proto/metalstack/infra/v2/bmc.proto | 6 +- proto/metalstack/infra/v2/boot.proto | 36 +- proto/metalstack/infra/v2/component.proto | 4 +- proto/metalstack/infra/v2/event.proto | 4 +- proto/metalstack/infra/v2/switch.proto | 12 +- 39 files changed, 841 insertions(+), 852 deletions(-) diff --git a/proto/metalstack/admin/v2/audit.proto b/proto/metalstack/admin/v2/audit.proto index 664feabf..61c1669a 100644 --- a/proto/metalstack/admin/v2/audit.proto +++ b/proto/metalstack/admin/v2/audit.proto @@ -36,7 +36,7 @@ message AuditServiceListResponse { // AuditServiceGetRequest is the request payload for getting an audit trace. message AuditServiceGetRequest { - // Uuid of the audit trace + // Uuid of the audit trace. string uuid = 1 [(buf.validate.field).string.uuid = true]; // Phase specifies the audit phase. Defaults to request. optional metalstack.api.v2.AuditPhase phase = 2 [(buf.validate.field).enum.defined_only = true]; diff --git a/proto/metalstack/admin/v2/filesystem.proto b/proto/metalstack/admin/v2/filesystem.proto index 17c0a0b9..2437b4cd 100644 --- a/proto/metalstack/admin/v2/filesystem.proto +++ b/proto/metalstack/admin/v2/filesystem.proto @@ -46,25 +46,25 @@ message FilesystemServiceCreateResponse { // FilesystemServiceUpdateRequest is the request payload for updating a filesystem. message FilesystemServiceUpdateRequest { - // Id of this filesystemLayout + // Id of this filesystemLayout. string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // UpdateMeta contains the timestamp and strategy to be used in this update request. metalstack.api.v2.UpdateMeta update_meta = 2 [(buf.validate.field).required = true]; - // Name of this filesystemLayout + // Name of this filesystemLayout. optional string name = 3 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Description of this filesystemLayout + // Description of this filesystemLayout. optional string description = 4 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; // Filesystems is a list of filesystems to create on a machine. repeated metalstack.api.v2.Filesystem filesystems = 5; // Disks list of disks that belong to this layout. repeated metalstack.api.v2.Disk disks = 6; - // Raid arrays to create + // Raid arrays to create. repeated metalstack.api.v2.Raid raid = 7; // VolumeGroups list of volumegroups to create. repeated metalstack.api.v2.VolumeGroup volume_groups = 8; // LogicalVolumes list of logicalvolumes to create. repeated metalstack.api.v2.LogicalVolume logical_volumes = 9; - // Constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts + // Constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts. metalstack.api.v2.FilesystemLayoutConstraints constraints = 10; } @@ -76,7 +76,7 @@ message FilesystemServiceUpdateResponse { // FilesystemServiceDeleteRequest is the request payload for deleting a filesystem. message FilesystemServiceDeleteRequest { - // ID of the filesystem to delete + // ID of the filesystem to delete. string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; } @@ -86,38 +86,38 @@ message FilesystemServiceDeleteResponse { metalstack.api.v2.FilesystemLayout filesystem_layout = 1; } -// FilesystemServiceMatchRequest +// FilesystemServiceMatchRequest. message FilesystemServiceMatchRequest { // Match size and image to a filesystem layout. - // or match a machine to a filesystem layout + // or match a machine to a filesystem layout. oneof match { - // ensure at least one match is specified + // ensure at least one match is specified. option (buf.validate.oneof).required = true; - // SizeAndImage + // SizeAndImage. MatchImageAndSize size_and_image = 1; - // MachineAndFilesystemlayout + // MachineAndFilesystemlayout. MatchMachineAndFilesystemLayout machine_and_filesystemlayout = 2; } } -// MatchImageAndSize +// MatchImageAndSize. message MatchImageAndSize { - // Size, machine size to try + // Size, machine size to try. string size = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Image machine image to try + // Image machine image to try. string image = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; } -// MatchMachineAndFilesystemLayout +// MatchMachineAndFilesystemLayout. message MatchMachineAndFilesystemLayout { - // Machine to check + // Machine to check. string machine = 1 [(buf.validate.field).string.uuid = true]; - // FilesystemLayout to check + // FilesystemLayout to check. string filesystem_layout = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; } -// FilesystemServiceMatchResponse +// FilesystemServiceMatchResponse. message FilesystemServiceMatchResponse { - // FilesystemLayout the filesystemlayout + // FilesystemLayout the filesystemlayout. metalstack.api.v2.FilesystemLayout filesystem_layout = 1; } diff --git a/proto/metalstack/admin/v2/image.proto b/proto/metalstack/admin/v2/image.proto index 5d61bfe9..eb51283b 100644 --- a/proto/metalstack/admin/v2/image.proto +++ b/proto/metalstack/admin/v2/image.proto @@ -47,29 +47,29 @@ message ImageServiceCreateResponse { // ImageServiceUpdateRequest is the request payload for updating an image. message ImageServiceUpdateRequest { - // Id of this image + // Id of this image. string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // UpdateMeta contains the timestamp and strategy to be used in this update request. metalstack.api.v2.UpdateMeta update_meta = 2 [(buf.validate.field).required = true]; - // URL where this image is located + // URL where this image is located. optional string url = 3 [(buf.validate.field).string.(metalstack.api.v2.is_uri) = true]; - // Name of this image + // Name of this image. optional string name = 4 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Description of this image + // Description of this image. optional string description = 5 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Features of this image + // Features of this image. repeated metalstack.api.v2.ImageFeature features = 6 [(buf.validate.field).repeated = { unique: true items: { enum: {defined_only: true} } }]; - // Classification of this image + // Classification of this image. metalstack.api.v2.ImageClassification classification = 7 [(buf.validate.field).enum.defined_only = true]; // ExpiresAt indicates that usage is not possible after this date. google.protobuf.Timestamp expires_at = 8; - // Labels to update on this image + // Labels to update on this image. optional metalstack.api.v2.UpdateLabels labels = 9; } @@ -81,7 +81,7 @@ message ImageServiceUpdateResponse { // ImageServiceDeleteRequest is the request payload for deleting an image. message ImageServiceDeleteRequest { - // ID of the image to delete + // ID of the image to delete. string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; } diff --git a/proto/metalstack/admin/v2/machine.proto b/proto/metalstack/admin/v2/machine.proto index 0244729e..a74f3fac 100644 --- a/proto/metalstack/admin/v2/machine.proto +++ b/proto/metalstack/admin/v2/machine.proto @@ -66,7 +66,7 @@ service MachineService { // MachineServiceGetRequest is the request payload for a machine get request. message MachineServiceGetRequest { - // UUID of the machine to get + // UUID of the machine to get. string uuid = 1 [(buf.validate.field).string.uuid = true]; } @@ -80,8 +80,8 @@ message MachineServiceGetResponse { message MachineServiceListRequest { // Query to list one or more machines. metalstack.api.v2.MachineQuery query = 1; - // Partition for which machines should be listed, could be left empty if only one partition is present - // otherwise an error is thrown that the partition must be specified + // Partition for which machines should be listed, could be left empty if only one partition is present. + // otherwise an error is thrown that the partition must be specified. optional string partition = 2 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; } @@ -93,7 +93,7 @@ message MachineServiceListResponse { // MachineServiceDeleteRequest is the request payload for a machine delete request. message MachineServiceDeleteRequest { - // UUID of the machine to permanently delete + // UUID of the machine to permanently delete. string uuid = 1 [(buf.validate.field).string.uuid = true]; } @@ -105,9 +105,9 @@ message MachineServiceDeleteResponse { // MachineServiceBMCCommandRequest is the request payload for a machine bmc command. message MachineServiceBMCCommandRequest { - // UUID of the machine to send the command to + // UUID of the machine to send the command to. string uuid = 1 [(buf.validate.field).string.uuid = true]; - // Command to send to the bmc of the machine + // Command to send to the bmc of the machine. metalstack.api.v2.MachineBMCCommand command = 2 [(buf.validate.field).enum.defined_only = true]; } @@ -116,13 +116,13 @@ message MachineServiceBMCCommandResponse {} // MachineServiceGetBMCRequest is the request payload for a machine getbmc request. message MachineServiceGetBMCRequest { - // UUID of the machine to get + // UUID of the machine to get. string uuid = 1 [(buf.validate.field).string.uuid = true]; } // MachineServiceGetBMCResponse is the response payload for a machine getbmc request. message MachineServiceGetBMCResponse { - // UUID of the machine + // UUID of the machine. string uuid = 1 [(buf.validate.field).string.uuid = true]; // BMC contains the BMC details of this machine. metalstack.api.v2.MachineBMCReport bmc = 2; @@ -146,7 +146,7 @@ message MachineServiceListBMCResponse { // MachineServiceConsolePasswordRequest is the request payload for getting the console password. message MachineServiceConsolePasswordRequest { - // UUID of the machine to get + // UUID of the machine to get. string uuid = 1 [(buf.validate.field).string.uuid = true]; // Reason must be provided why access to the console is requested. // Reason is only forwarded to an audit sink. @@ -158,20 +158,20 @@ message MachineServiceConsolePasswordRequest { // MachineServiceConsolePasswordResponse is the response payload for getting the console password. message MachineServiceConsolePasswordResponse { - // UUID of the machine to get + // UUID of the machine to get. string uuid = 1 [(buf.validate.field).string.uuid = true]; - // Password to access the console + // Password to access the console. string password = 2; } // MachineServiceSetStateRequest is the request payload for a machine set state request. message MachineServiceSetStateRequest { - // UUID of the machine to set the state to + // UUID of the machine to set the state to. string uuid = 1 [(buf.validate.field).string.uuid = true]; // State the state of this machine. // If State set to available, description is also cleared. metalstack.api.v2.MachineState state = 2 [(buf.validate.field).enum.defined_only = true]; - // Description a description why this machine is in the given state + // Description a description why this machine is in the given state. string description = 3 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; } diff --git a/proto/metalstack/admin/v2/network.proto b/proto/metalstack/admin/v2/network.proto index d82240ab..c79bd313 100644 --- a/proto/metalstack/admin/v2/network.proto +++ b/proto/metalstack/admin/v2/network.proto @@ -40,7 +40,7 @@ service NetworkService { // NetworkServiceGetRequest is the request payload for getting a network. message NetworkServiceGetRequest { - // ID of the network to get + // ID of the network to get. string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; } @@ -52,63 +52,63 @@ message NetworkServiceGetResponse { // NetworkServiceCreateRequest is the request payload for creating a network. message NetworkServiceCreateRequest { - // Id of this network + // Id of this network. optional string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Name of this network + // Name of this network. optional string name = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Description of this network + // Description of this network. optional string description = 3 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; // Partition where this network will be created. optional string partition = 4 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; // Project where this network belongs to. optional string project = 5 [(buf.validate.field).string.uuid = true]; - // Type of the network to create + // Type of the network to create. metalstack.api.v2.NetworkType type = 6 [(buf.validate.field).enum.defined_only = true]; - // Labels on this network + // Labels on this network. optional metalstack.api.v2.Labels labels = 7; - // Prefixes in this network + // Prefixes in this network. repeated string prefixes = 8 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; - // Destination Prefixes in this network + // Destination Prefixes in this network. repeated string destination_prefixes = 9 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; // Default Child Prefix length defines the bitlength of a child network created per addressfamily, if not specified during the allocate request. metalstack.api.v2.ChildPrefixLength default_child_prefix_length = 10; // Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length. metalstack.api.v2.ChildPrefixLength min_child_prefix_length = 11; - // NATType of this network + // NATType of this network. optional metalstack.api.v2.NATType nat_type = 12 [(buf.validate.field).enum.defined_only = true]; - // VRF of this network has this VNI + // VRF of this network has this VNI. optional uint32 vrf = 13; // Parent Network points to the id of the parent network if any. optional string parent_network = 14 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced. repeated string additional_announcable_cidrs = 15 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; - // Length per addressfamily + // Length per addressfamily. optional metalstack.api.v2.ChildPrefixLength length = 16; - // AddressFamily to create, defaults to the same as the parent + // AddressFamily to create, defaults to the same as the parent. optional metalstack.api.v2.NetworkAddressFamily address_family = 17 [(buf.validate.field).enum.defined_only = true]; } // NetworkServiceUpdateRequest is the request payload for updating a network. message NetworkServiceUpdateRequest { - // Id of this network + // Id of this network. string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // UpdateMeta contains the timestamp and strategy to be used in this update request. metalstack.api.v2.UpdateMeta update_meta = 2 [(buf.validate.field).required = true]; - // Name of this network + // Name of this network. optional string name = 3 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Description of this network + // Description of this network. optional string description = 4 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Labels to update on this network + // Labels to update on this network. optional metalstack.api.v2.UpdateLabels labels = 5; - // Prefixes in this network + // Prefixes in this network. repeated string prefixes = 6 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; - // Destination Prefixes in this network + // Destination Prefixes in this network. repeated string destination_prefixes = 7 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; // Default Child Prefix length defines the bit length of a child network created per addressfamily, if not specified during the allocate request. optional metalstack.api.v2.ChildPrefixLength default_child_prefix_length = 8; // Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length. optional metalstack.api.v2.ChildPrefixLength min_child_prefix_length = 9; - // NATType of this network + // NATType of this network. optional metalstack.api.v2.NATType nat_type = 10 [(buf.validate.field).enum.defined_only = true]; // AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced. repeated string additional_announcable_cidrs = 11 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; @@ -119,7 +119,7 @@ message NetworkServiceUpdateRequest { // NetworkServiceDeleteRequest is the request payload for deleting a network. message NetworkServiceDeleteRequest { - // ID of the network to get + // ID of the network to get. string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; } diff --git a/proto/metalstack/admin/v2/partition.proto b/proto/metalstack/admin/v2/partition.proto index c2bef06d..2ff8028e 100644 --- a/proto/metalstack/admin/v2/partition.proto +++ b/proto/metalstack/admin/v2/partition.proto @@ -34,46 +34,46 @@ service PartitionService { // PartitionServiceCreateRequest is the request payload for a partition create request. message PartitionServiceCreateRequest { - // Partition the partition + // Partition the partition. metalstack.api.v2.Partition partition = 1; } // PartitionServiceUpdateRequest is the request payload for updating a partition. message PartitionServiceUpdateRequest { - // ID of this partition + // ID of this partition. string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; // UpdateMeta contains the timestamp and strategy to be used in this update request. metalstack.api.v2.UpdateMeta update_meta = 2 [(buf.validate.field).required = true]; - // Description of this partition + // Description of this partition. optional string description = 3 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; // PartitionBootConfiguration defines how metal-hammer boots. metalstack.api.v2.PartitionBootConfiguration boot_configuration = 4; - // DNSServers for this partition + // DNSServers for this partition. repeated metalstack.api.v2.DNSServer dns_servers = 5 [(buf.validate.field).repeated.max_items = 3]; - // NTPServers for this partition + // NTPServers for this partition. repeated metalstack.api.v2.NTPServer ntp_servers = 6 [(buf.validate.field).repeated.max_items = 10]; // ManagementServiceAddresses defines where the management is reachable. - // must be in the form : + // must be in the form :. repeated string mgmt_service_addresses = 7 [(buf.validate.field).repeated.(metalstack.api.v2.are_host_and_port) = true]; - // Labels to update on this network + // Labels to update on this network. optional metalstack.api.v2.UpdateLabels labels = 8; } // PartitionServiceDeleteRequest is the request payload for a partition delete request. message PartitionServiceDeleteRequest { - // ID of the partition to delete + // ID of the partition to delete. string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; } // PartitionServiceCreateResponse is the response payload for a partition create request. message PartitionServiceCreateResponse { - // Partition the partition + // Partition the partition. metalstack.api.v2.Partition partition = 1; } // PartitionServiceUpdateResponse is the response payload for a partition update request. message PartitionServiceUpdateResponse { - // Partition the partition + // Partition the partition. metalstack.api.v2.Partition partition = 1; } @@ -85,11 +85,11 @@ message PartitionServiceDeleteResponse { // PartitionServiceCapacityRequest is the request payload for getting partition capacity. message PartitionServiceCapacityRequest { - // ID of the partition to get + // ID of the partition to get. optional string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; - // Size of machines to show the capacity + // Size of machines to show the capacity. optional string size = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Project of machines to show the capacity + // Project of machines to show the capacity. optional string project = 3 [(buf.validate.field).string.uuid = true]; } @@ -131,7 +131,7 @@ message MachineSizeCapacity { // Free is the amount of machines in a partition that can be freely allocated at any given moment by a project. // Effectively this is the amount of waiting machines minus the machines that are unavailable due to machine state or un-allocatable due to size reservations. int64 free = 10; - // Unavailable is the amount of machine in a partition that are currently not allocatable because they are not waiting or + // Unavailable is the amount of machine in a partition that are currently not allocatable because they are not waiting or. // not in the machine state "available", e.g. locked or reserved. int64 unavailable = 11; diff --git a/proto/metalstack/admin/v2/size.proto b/proto/metalstack/admin/v2/size.proto index 6a889e04..cd3c9a5a 100644 --- a/proto/metalstack/admin/v2/size.proto +++ b/proto/metalstack/admin/v2/size.proto @@ -40,17 +40,17 @@ message SizeServiceCreateResponse { // SizeServiceUpdateRequest is the request payload for updating a size. message SizeServiceUpdateRequest { - // Id of this size + // Id of this size. string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // UpdateMeta contains the timestamp and strategy to be used in this update request. metalstack.api.v2.UpdateMeta update_meta = 2 [(buf.validate.field).required = true]; - // Name of this size + // Name of this size. optional string name = 3 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Description of this size + // Description of this size. optional string description = 4 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Constraints which must match that a specific machine is considered of this size + // Constraints which must match that a specific machine is considered of this size. repeated metalstack.api.v2.SizeConstraint constraints = 5; - // Labels to update on this size + // Labels to update on this size. optional metalstack.api.v2.UpdateLabels labels = 6; } @@ -62,7 +62,7 @@ message SizeServiceUpdateResponse { // SizeServiceDeleteRequest is the request payload for deleting a size. message SizeServiceDeleteRequest { - // ID of the size to delete + // ID of the size to delete. string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; } diff --git a/proto/metalstack/admin/v2/size_imageconstraint.proto b/proto/metalstack/admin/v2/size_imageconstraint.proto index a11da104..3dfaca1f 100644 --- a/proto/metalstack/admin/v2/size_imageconstraint.proto +++ b/proto/metalstack/admin/v2/size_imageconstraint.proto @@ -40,15 +40,15 @@ service SizeImageConstraintService { // SizeImageConstraintServiceCreateRequest is the request payload for creating a size image constraint. message SizeImageConstraintServiceCreateRequest { - // Size of the constraint + // Size of the constraint. string size = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // ImageConstraints to apply to this size + // ImageConstraints to apply to this size. repeated metalstack.api.v2.ImageConstraint image_constraints = 2; - // Meta for this size image constraint + // Meta for this size image constraint. metalstack.api.v2.Meta meta = 3; - // Name of this size image constraint + // Name of this size image constraint. optional string name = 4 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Description of this size image constraint + // Description of this size image constraint. optional string description = 5 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; } @@ -60,15 +60,15 @@ message SizeImageConstraintServiceCreateResponse { // SizeImageConstraintServiceUpdateRequest is the request payload for updating a size image constraint. message SizeImageConstraintServiceUpdateRequest { - // Size of the image constraint to update + // Size of the image constraint to update. string size = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // UpdateMeta contains the timestamp and strategy to be used in this update request. metalstack.api.v2.UpdateMeta update_meta = 2 [(buf.validate.field).required = true]; - // ImageConstraints to apply to this size + // ImageConstraints to apply to this size. repeated metalstack.api.v2.ImageConstraint image_constraints = 3; - // Name of this size image constraint + // Name of this size image constraint. optional string name = 4 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Description of this size image constraint + // Description of this size image constraint. optional string description = 5 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; } @@ -80,7 +80,7 @@ message SizeImageConstraintServiceUpdateResponse { // SizeImageConstraintServiceDeleteRequest is the request payload for deleting a size image constraint. message SizeImageConstraintServiceDeleteRequest { - // Size of the constraint + // Size of the constraint. string size = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; } @@ -92,7 +92,7 @@ message SizeImageConstraintServiceDeleteResponse { // SizeImageConstraintServiceGetRequest is the request payload for getting a size image constraint. message SizeImageConstraintServiceGetRequest { - // Size of the constraint + // Size of the constraint. string size = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; } diff --git a/proto/metalstack/admin/v2/size_reservation.proto b/proto/metalstack/admin/v2/size_reservation.proto index d0081626..bc968e54 100644 --- a/proto/metalstack/admin/v2/size_reservation.proto +++ b/proto/metalstack/admin/v2/size_reservation.proto @@ -46,23 +46,23 @@ message SizeReservationServiceCreateResponse { // SizeReservationServiceUpdateRequest is the request payload for updating a size reservation. message SizeReservationServiceUpdateRequest { - // Id of this size reservation + // Id of this size reservation. string id = 1 [(buf.validate.field).string.uuid = true]; - // Name of this size reservation + // Name of this size reservation. optional string name = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Description of this size reservation + // Description of this size reservation. optional string description = 3 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; // UpdateMeta contains the timestamp and strategy to be used in this update request. metalstack.api.v2.UpdateMeta update_meta = 4 [(buf.validate.field).required = true]; - // Partition ids of this size reservation + // Partition ids of this size reservation. repeated string partitions = 5 [ (buf.validate.field).repeated.min_items = 1, (buf.validate.field).repeated.unique = true, (buf.validate.field).repeated.items.string.(metalstack.api.v2.is_partition) = true ]; - // Amount of reservations of this size reservation + // Amount of reservations of this size reservation. optional int32 amount = 6 [(buf.validate.field).int32.gt = 0]; - // Labels to update of this size reservation + // Labels to update of this size reservation. optional metalstack.api.v2.UpdateLabels labels = 7; } @@ -74,7 +74,7 @@ message SizeReservationServiceUpdateResponse { // SizeReservationServiceDeleteRequest is the request payload for deleting a size reservation. message SizeReservationServiceDeleteRequest { - // ID of the size reservation to delete + // ID of the size reservation to delete. string id = 1 [(buf.validate.field).string.uuid = true]; } diff --git a/proto/metalstack/admin/v2/switch.proto b/proto/metalstack/admin/v2/switch.proto index ae421c9c..4d8edd63 100644 --- a/proto/metalstack/admin/v2/switch.proto +++ b/proto/metalstack/admin/v2/switch.proto @@ -53,7 +53,7 @@ service SwitchService { // SwitchServiceGetRequest is the request payload for getting a switch. message SwitchServiceGetRequest { - // Id of the switch to get + // Id of the switch to get. string id = 1 [(buf.validate.field).string = { hostname: true [metalstack.api.v2.is_name]: true @@ -74,13 +74,13 @@ message SwitchServiceListRequest { // SwitchServiceListResponse is the response payload for listing switches. message SwitchServiceListResponse { - // Switches that match the request query + // Switches that match the request query. repeated metalstack.api.v2.Switch switches = 1; } // SwitchServiceUpdateRequest is the request payload for updating a switch. message SwitchServiceUpdateRequest { - // ID of the switch + // ID of the switch. string id = 1 [(buf.validate.field).string = { hostname: true [metalstack.api.v2.is_name]: true @@ -90,7 +90,7 @@ message SwitchServiceUpdateRequest { // UpdatedAt is the date when this entity was updated. // Must be part of the update request to ensure optimistic locking. google.protobuf.Timestamp updated_at = 3; - // Description of the switch + // Description of the switch. optional string description = 4 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; // ReplaceMode is used to mark a switch ready for replacement. optional metalstack.api.v2.SwitchReplaceMode replace_mode = 5 [(buf.validate.field).enum.defined_only = true]; @@ -114,7 +114,7 @@ message SwitchServiceUpdateResponse { // SwitchServiceDeleteRequest is the request payload for deleting a switch. message SwitchServiceDeleteRequest { - // Id of the switch + // Id of the switch. string id = 1 [(buf.validate.field).string = { hostname: true [metalstack.api.v2.is_name]: true @@ -151,20 +151,20 @@ message SwitchServiceMigrateResponse { // SwitchServicePortRequest is the request payload for setting the port status of a switch port. message SwitchServicePortRequest { - // Id of the switch + // Id of the switch. string id = 1 [(buf.validate.field).string = { hostname: true [metalstack.api.v2.is_name]: true }]; - // NicName of the port whose status should be changed + // NicName of the port whose status should be changed. string nic_name = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Status that the port should have + // Status that the port should have. metalstack.api.v2.SwitchPortStatus status = 3 [(buf.validate.field).enum.defined_only = true]; } // SwitchServicePortResponse is the response payload for setting the port status of a switch port. message SwitchServicePortResponse { - // Switch after the port status toggle + // Switch after the port status toggle. metalstack.api.v2.Switch switch = 1; } @@ -172,7 +172,7 @@ message SwitchServicePortResponse { message SwitchServiceConnectedMachinesRequest { // Query to filter the switch results. metalstack.api.v2.SwitchQuery query = 1; - // MachineQuery to filter the machine results + // MachineQuery to filter the machine results. metalstack.api.v2.MachineQuery machine_query = 2; } diff --git a/proto/metalstack/admin/v2/task.proto b/proto/metalstack/admin/v2/task.proto index 86f4e717..66659d33 100644 --- a/proto/metalstack/admin/v2/task.proto +++ b/proto/metalstack/admin/v2/task.proto @@ -63,7 +63,7 @@ message TaskServiceQueuesRequest {} // TaskServiceQueuesResponse is the response payload for getting all queues. message TaskServiceQueuesResponse { - // Queues configured for the async system + // Queues configured for the async system. repeated string queues = 1; } @@ -103,7 +103,7 @@ message TaskInfo { // LastError is the error message from the last failure. string last_error = 8; // LastFailedAt is the time of the last failure if any. - // If the task has no failures, LastFailedAt is zero time (i.e. time.Time{}) + // If the task has no failures, LastFailedAt is zero time (i.e. time.Time{}). google.protobuf.Timestamp last_failed_at = 9; // Timeout is the duration the task can be processed by Handler before being retried. google.protobuf.Duration timeout = 10; @@ -111,17 +111,17 @@ message TaskInfo { google.protobuf.Timestamp deadline = 11; // 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 + // 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. // // Empty string (default) indicates task does not belong to any groups, and no aggregation will be applied to the task. string group = 12; // NextProcessAt is the time the task is scheduled to be processed. - // Zero if not applicable + // Zero if not applicable. google.protobuf.Timestamp next_process_at = 13; // 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 + // An orphaned task indicates that the worker has crashed or experienced network failures and was not able to. + // 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. @@ -132,7 +132,7 @@ message TaskInfo { // Zero value (i.e. time.Time{}) indicates no value. google.protobuf.Timestamp completed_at = 16; // Result holds the result data associated with the task. - // Use ResultWriter to write result data from the Handler + // Use ResultWriter to write result data from the Handler. bytes result = 17; } diff --git a/proto/metalstack/admin/v2/tenant.proto b/proto/metalstack/admin/v2/tenant.proto index c3ee1f89..417f4821 100644 --- a/proto/metalstack/admin/v2/tenant.proto +++ b/proto/metalstack/admin/v2/tenant.proto @@ -34,15 +34,15 @@ service TenantService { // TenantServiceCreateRequest is the request payload for creating a tenant. message TenantServiceCreateRequest { - // Name of the tenant + // Name of the tenant. string name = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; - // Description of the tenant + // Description of the tenant. optional string description = 2 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Email of the tenant, if not set will be inherited from the creator + // Email of the tenant, if not set will be inherited from the creator. optional string email = 3 [(buf.validate.field).string.email = true]; - // AvatarUrl of the tenant + // AvatarUrl of the tenant. optional string avatar_url = 4 [(buf.validate.field).string.(metalstack.api.v2.is_uri) = true]; - // Labels on the tenant + // Labels on the tenant. metalstack.api.v2.Labels labels = 5; } @@ -68,11 +68,11 @@ message TenantServiceListResponse { // TenantServiceAddMemberRequest is the request payload for adding a member to a tenant. message TenantServiceAddMemberRequest { - // Login of the tenant to which the member will be added + // Login of the tenant to which the member will be added. string tenant = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; - // Login of the member to add + // Login of the member to add. string member = 2 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; - // Role to assign to the new member + // Role to assign to the new member. metalstack.api.v2.TenantRole role = 3 [(buf.validate.field).enum.defined_only = true]; } @@ -84,9 +84,9 @@ message TenantServiceAddMemberResponse { // TenantServiceRemoveMemberRequest is the request payload for removing a member from a tenant. message TenantServiceRemoveMemberRequest { - // Login of the tenant from which the member will be removed + // Login of the tenant from which the member will be removed. string tenant = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; - // Login of the member to remove + // Login of the member to remove. string member = 2 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; } diff --git a/proto/metalstack/admin/v2/token.proto b/proto/metalstack/admin/v2/token.proto index 66788253..512fff7d 100644 --- a/proto/metalstack/admin/v2/token.proto +++ b/proto/metalstack/admin/v2/token.proto @@ -53,9 +53,9 @@ message TokenServiceRevokeResponse {} // TokenServiceCreateRequest is the request payload for creating a token. message TokenServiceCreateRequest { - // User this token should be created for, if omitted, user is derived from caller + // User this token should be created for, if omitted, user is derived from caller. optional string user = 1 [(buf.validate.field).string.(metalstack.api.v2.is_user) = true]; - // TokenCreateRequest which should be created + // TokenCreateRequest which should be created. metalstack.api.v2.TokenServiceCreateRequest token_create_request = 2; } diff --git a/proto/metalstack/admin/v2/vpn.proto b/proto/metalstack/admin/v2/vpn.proto index fb6970ad..632570ac 100644 --- a/proto/metalstack/admin/v2/vpn.proto +++ b/proto/metalstack/admin/v2/vpn.proto @@ -27,7 +27,7 @@ service VPNService { // VPNServiceAuthKeyRequest is the request payload for generating a VPN authentication key. message VPNServiceAuthKeyRequest { - // Project for which a VPN authentication key should be generated + // Project for which a VPN authentication key should be generated. string project = 1 [(buf.validate.field).string.uuid = true]; // Ephemeral defines if the authentication key should be ephemeral. bool ephemeral = 2; @@ -50,9 +50,9 @@ message VPNServiceAuthKeyResponse { string auth_key = 2; // Ephemeral defines if the authentication key should be ephemeral. bool ephemeral = 3; - // ExpiresAt this key cannot be used after this timestamp + // ExpiresAt this key cannot be used after this timestamp. google.protobuf.Timestamp expires_at = 4; - // CreatedAt this key was created at this timestamp + // CreatedAt this key was created at this timestamp. google.protobuf.Timestamp created_at = 5; } @@ -64,6 +64,6 @@ message VPNServiceListNodesRequest { // VPNServiceListNodesResponse is the response payload for listing VPN nodes. message VPNServiceListNodesResponse { - // Nodes connected to the VPN + // Nodes connected to the VPN. repeated metalstack.api.v2.VPNNode nodes = 1; } diff --git a/proto/metalstack/api/v2/audit.proto b/proto/metalstack/api/v2/audit.proto index 790efdf3..8f9c2175 100644 --- a/proto/metalstack/api/v2/audit.proto +++ b/proto/metalstack/api/v2/audit.proto @@ -33,7 +33,7 @@ enum AuditPhase { // AuditTrace is an audit trace. message AuditTrace { - // Uuid of the audit trace + // Uuid of the audit trace. string uuid = 1 [(buf.validate.field).string.uuid = true]; // Timestamp is the timestamp when the request arrived at the API. google.protobuf.Timestamp timestamp = 2; @@ -53,13 +53,13 @@ message AuditTrace { optional int32 result_code = 9; // Phase represents the phase of the audit trace. AuditPhase phase = 10; - // Meta for this audit trace + // Meta for this audit trace. Meta meta = 11; } // AuditQuery is the query for audit traces. message AuditQuery { - // Uuid of the audit trace + // Uuid of the audit trace. optional string uuid = 2 [(buf.validate.field).string.uuid = true]; // From describes the start of the time window in which to list audit traces. Defaults to the last eight hours. optional google.protobuf.Timestamp from = 3; @@ -83,7 +83,7 @@ message AuditQuery { min_len: 2 max_len: 256 }]; - // Limit is a number limiting the length of the response (min: 1, max: 1000, defaults to 200) + // Limit is a number limiting the length of the response (min: 1, max: 1000, defaults to 200). optional int32 limit = 11 [(buf.validate.field).int32 = { gt: 0 lte: 1000 @@ -94,7 +94,7 @@ message AuditQuery { // AuditServiceListRequest is the request payload for an audit list request. message AuditServiceListRequest { - // Login for this tenant + // Login for this tenant. string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // Query for audit traces. AuditQuery query = 2; @@ -108,9 +108,9 @@ message AuditServiceListResponse { // AuditServiceGetRequest is the request payload of a audit get request. message AuditServiceGetRequest { - // Login for this tenant + // Login for this tenant. string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Uuid of the audit trace + // Uuid of the audit trace. string uuid = 2 [(buf.validate.field).string.uuid = true]; // Phase specifies the audit phase. Defaults to request. optional AuditPhase phase = 3 [(buf.validate.field).enum.defined_only = true]; diff --git a/proto/metalstack/api/v2/common.proto b/proto/metalstack/api/v2/common.proto index b9a88910..79b1a2aa 100644 --- a/proto/metalstack/api/v2/common.proto +++ b/proto/metalstack/api/v2/common.proto @@ -11,13 +11,13 @@ import "metalstack/api/v2/predefined_rules.proto"; enum TenantRole { // TENANT_ROLE_UNSPECIFIED is not specified. TENANT_ROLE_UNSPECIFIED = 0; - // TENANT_ROLE_OWNER the logged in user needs at least owner role to call this method + // TENANT_ROLE_OWNER the logged in user needs at least owner role to call this method. TENANT_ROLE_OWNER = 1; - // TENANT_ROLE_EDITOR the logged in user needs at least editor role to call this method + // TENANT_ROLE_EDITOR the logged in user needs at least editor role to call this method. TENANT_ROLE_EDITOR = 2; - // TENANT_ROLE_VIEWER the logged in user needs at least viewer role to call this method + // TENANT_ROLE_VIEWER the logged in user needs at least viewer role to call this method. TENANT_ROLE_VIEWER = 3; - // TENANT_ROLE_GUEST the logged in user needs at least guest role to call this method + // TENANT_ROLE_GUEST the logged in user needs at least guest role to call this method. // The guest role is assumed by users who are invited to a tenant's project without them. // having a direct membership within the tenant. TENANT_ROLE_GUEST = 4; @@ -27,11 +27,11 @@ enum TenantRole { enum ProjectRole { // PROJECT_ROLE_UNSPECIFIED is not specified. PROJECT_ROLE_UNSPECIFIED = 0; - // PROJECT_ROLE_OWNER the logged in user needs at least owner role to call this method + // PROJECT_ROLE_OWNER the logged in user needs at least owner role to call this method. PROJECT_ROLE_OWNER = 1; - // PROJECT_ROLE_EDITOR the logged in user needs at least editor role to call this method + // PROJECT_ROLE_EDITOR the logged in user needs at least editor role to call this method. PROJECT_ROLE_EDITOR = 2; - // PROJECT_ROLE_VIEWER the logged in user needs at least viewer role to call this method + // PROJECT_ROLE_VIEWER the logged in user needs at least viewer role to call this method. PROJECT_ROLE_VIEWER = 3; } @@ -39,9 +39,9 @@ enum ProjectRole { enum AdminRole { // ADMIN_ROLE_UNSPECIFIED is not specified. ADMIN_ROLE_UNSPECIFIED = 0; - // ADMIN_ROLE_EDITOR the logged in user needs at least editor role to call this method + // ADMIN_ROLE_EDITOR the logged in user needs at least editor role to call this method. ADMIN_ROLE_EDITOR = 1; - // ADMIN_ROLE_VIEWER the logged in user needs at least viewer role to call this method + // ADMIN_ROLE_VIEWER the logged in user needs at least viewer role to call this method. ADMIN_ROLE_VIEWER = 2; } @@ -49,9 +49,9 @@ enum AdminRole { enum InfraRole { // INFRA_ROLE_UNSPECIFIED is not specified. INFRA_ROLE_UNSPECIFIED = 0; - // INFRA_ROLE_EDITOR a microservice needs at least editor role to call this method + // INFRA_ROLE_EDITOR a microservice needs at least editor role to call this method. INFRA_ROLE_EDITOR = 1; - // INFRA_ROLE_VIEWER a microservice needs at least viewer role to call this method + // INFRA_ROLE_VIEWER a microservice needs at least viewer role to call this method. INFRA_ROLE_VIEWER = 2; } @@ -59,35 +59,35 @@ enum InfraRole { enum MachineRole { // MACHINE_ROLE_UNSPECIFIED is not specified. MACHINE_ROLE_UNSPECIFIED = 0; - // MACHINE_ROLE_EDITOR a microservice needs at least editor role to call this method + // MACHINE_ROLE_EDITOR a microservice needs at least editor role to call this method. MACHINE_ROLE_EDITOR = 1; - // MACHINE_ROLE_VIEWER a microservice needs at least viewer role to call this method + // MACHINE_ROLE_VIEWER a microservice needs at least viewer role to call this method. MACHINE_ROLE_VIEWER = 2; } -// Visibility of a method +// Visibility of a method. enum Visibility { // VISIBILITY_UNSPECIFIED is not defined. VISIBILITY_UNSPECIFIED = 0; // VISIBILITY_PUBLIC specifies that this service is accessible without authentication. VISIBILITY_PUBLIC = 1; - // VISIBILITY_SELF restricts calls to the authenticated user only + // VISIBILITY_SELF restricts calls to the authenticated user only. VISIBILITY_SELF = 2; } -// Auditing option specified per service method -// by default all service methods are included -// add the auditing option if you want to exclude a method in auditing +// Auditing option specified per service method. +// By default all service methods are included. +// Add the auditing option if you want to exclude a method in auditing. enum Auditing { // AUDITING_UNSPECIFIED is not specified. AUDITING_UNSPECIFIED = 0; - // AUDITING_INCLUDED if a method is annotated with this, all calls are audited + // AUDITING_INCLUDED if a method is annotated with this, all calls are audited. AUDITING_INCLUDED = 1; - // AUDITING_EXCLUDED if a method is annotated with this, no calls are audited + // AUDITING_EXCLUDED if a method is annotated with this, no calls are audited. AUDITING_EXCLUDED = 2; } -// MethodOptions to specify specific annotations to methods +// MethodOptions to specify specific annotations to methods. extend google.protobuf.MethodOptions { // TenantRoles are used to define the tenant role a logged in user must provide to call this method. repeated TenantRole tenant_roles = 51000; @@ -107,13 +107,13 @@ extend google.protobuf.MethodOptions { // EnumValueOptions, can be accessed with go/enum/GetFormatStringValue. extend google.protobuf.EnumValueOptions { - // StringValue which can be set to a enum + // StringValue which can be set to a enum. string enum_string_value = 52000; } // Paging defines paging for methods with a lot of results. message Paging { - // Page is used for pagination, if unset only the first page is returned, + // Page is used for pagination, if unset only the first page is returned,. // the list response contains then the page number for the next page. optional uint64 page = 1; // Count is the number of results returned per page, if not given server side defaults apply. @@ -122,7 +122,7 @@ message Paging { // Labels define additional information to a entity. message Labels { - // Labels consists labels + // Labels consists labels. map labels = 1 [ (buf.validate.field).map = { keys: { @@ -142,14 +142,14 @@ message Labels { ]; } -// Meta of a message +// Meta of a message. message Meta { - // Tags on this entity + // Tags on this entity. optional Labels labels = 1; // CreatedAt is the date when this entity was created. google.protobuf.Timestamp created_at = 2; // UpdatedAt is the date when this entity was updated. - // must be part of the update request to ensure optimistic locking + // must be part of the update request to ensure optimistic locking. google.protobuf.Timestamp updated_at = 3; // Generation identifies how often this entity was modified since creation. uint64 generation = 4; @@ -162,10 +162,10 @@ message Meta { message UpdateLabels { // Strategy defines the label update strategy. oneof strategy { - // ensure at least one match is specified + // ensure at least one match is specified. option (buf.validate.oneof).required = true; - // Replace existing labels with the given ones + // Replace existing labels with the given ones. Labels replace = 1; // Patch adds, updates or remove given labels without modifying others. LabelsPatch patch = 2; @@ -188,21 +188,21 @@ message LabelsPatch { // UpdateMeta must be provided with every UpdateRequest to define how optimistic locking should be handled. message UpdateMeta { // UpdatedAt is the date when this entity was updated. - // must be part of the update request to ensure optimistic locking + // Must be part of the update request to ensure optimistic locking. google.protobuf.Timestamp updated_at = 1; - // LockingStrategy to be used for this update request + // LockingStrategy to be used for this update request. OptimisticLockingStrategy locking_strategy = 2 [(buf.validate.field).enum.defined_only = true]; } // OptimisticLockingStrategy defines how optimistic locking should be handled. -// It defaults to client side, which requires the UpdatedAt timestamp to be provided +// It defaults to client side, which requires the UpdatedAt timestamp to be provided. enum OptimisticLockingStrategy { - // OPTIMISTIC_LOCKING_STRATEGY_UNSPECIFIED same as client side + // OPTIMISTIC_LOCKING_STRATEGY_UNSPECIFIED same as client side. OPTIMISTIC_LOCKING_STRATEGY_UNSPECIFIED = 0; - // OPTIMISTIC_LOCKING_STRATEGY_CLIENT requires UpdatedAt to be specified + // OPTIMISTIC_LOCKING_STRATEGY_CLIENT requires UpdatedAt to be specified. OPTIMISTIC_LOCKING_STRATEGY_CLIENT = 1; - // OPTIMISTIC_LOCKING_STRATEGY_SERVER allows to omit UpdatedAt - // and fetches the most recent entity before updating with the given values with the update request + // OPTIMISTIC_LOCKING_STRATEGY_SERVER allows to omit UpdatedAt. + // and fetches the most recent entity before updating with the given values with the update request. OPTIMISTIC_LOCKING_STRATEGY_SERVER = 2; } diff --git a/proto/metalstack/api/v2/component.proto b/proto/metalstack/api/v2/component.proto index ee7cc6ae..07f48373 100644 --- a/proto/metalstack/api/v2/component.proto +++ b/proto/metalstack/api/v2/component.proto @@ -25,15 +25,15 @@ message Component { google.protobuf.Timestamp reported_at = 5; // Interval at which the ping is scheduled. google.protobuf.Duration interval = 6; - // Version of this service + // Version of this service. metalstack.api.v2.Version version = 7; // Token is the token which is actually used by this microservice. Token token = 8; - // Meta for this component + // Meta for this component. Meta meta = 9; } -// ComponentQuery to query components +// ComponentQuery to query components. message ComponentQuery { // UUID identifies this component. optional string uuid = 1 [(buf.validate.field).string.uuid = true]; diff --git a/proto/metalstack/api/v2/filesystem.proto b/proto/metalstack/api/v2/filesystem.proto index 3447904a..9f4b2d26 100644 --- a/proto/metalstack/api/v2/filesystem.proto +++ b/proto/metalstack/api/v2/filesystem.proto @@ -22,89 +22,89 @@ service FilesystemService { // FilesystemServiceGetRequest is the request payload for a filesystem get request. message FilesystemServiceGetRequest { - // ID of the filesystem to get + // ID of the filesystem to get. string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; } // FilesystemServiceListRequest is the request payload for a filesystem list request. message FilesystemServiceListRequest { - // ID of the filesystem to get + // ID of the filesystem to get. optional string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; } // FilesystemServiceGetResponse is the response payload for a filesystem get request. message FilesystemServiceGetResponse { - // FilesystemLayout the filesystemlayout + // FilesystemLayout the filesystemlayout. FilesystemLayout filesystem_layout = 1; } // FilesystemServiceListResponse is the response payload for a filesystem list request. message FilesystemServiceListResponse { - // FilesystemLayouts the filesystemlayouts + // FilesystemLayouts the filesystemlayouts. repeated FilesystemLayout filesystem_layouts = 1; } -// FilesystemLayout +// FilesystemLayout. message FilesystemLayout { - // Id of this filesystemLayout + // Id of this filesystemLayout. string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Meta for this filesystemLayout + // Meta for this filesystemLayout. Meta meta = 2; - // Name of this filesystemLayout + // Name of this filesystemLayout. optional string name = 3 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Description of this filesystemLayout + // Description of this filesystemLayout. optional string description = 4 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; // Filesystems is a list of filesystems to create on a machine. repeated Filesystem filesystems = 5; // Disks list of disks that belong to this layout. repeated Disk disks = 6; - // raid arrays to create + // Raid arrays to create. repeated Raid raid = 7; // VolumeGroups list of volumegroups to create. repeated VolumeGroup volume_groups = 8; // LogicalVolumes list of logicalvolumes to create. repeated LogicalVolume logical_volumes = 9; - // Constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts + // Constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts. FilesystemLayoutConstraints constraints = 10; } -// FilesystemLayoutConstraints +// FilesystemLayoutConstraints. message FilesystemLayoutConstraints { // Sizes list of sizes this layout applies to. - // this could either be a concrete size, or a asterisk to match all sizes + // This could either be a concrete size, or a asterisk to match all sizes. repeated string sizes = 1; - // Images list of images this layout applies to in the following form. - // key must be the first part of available images, e.g. the name of the image - // value must be a semver match expression with the constraint and the version separated by space - // this would match all debian images which are greater or equal 12.0 - // "debian":">= 12.0" + // Images list of images this layout applies to in the following form: + // Key must be the first part of available images, e.g. the name of the imag. + // Value must be a semver match expression with the constraint and the version separated by space. + // This would match all debian images which are greater or equal 12: + // "debian": >= 12.0. map images = 2; } -// Filesystem +// Filesystem. message Filesystem { - // Device the underlying device where this filesystem should be created + // Device the underlying device where this filesystem should be created. string device = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Format of the filesystem format + // Format of the filesystem format. Format format = 2 [ (buf.validate.field).enum.defined_only = true, (buf.validate.field).required = true ]; - // Name of this filesystem + // Name of this filesystem. optional string name = 3 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Description of this filesystem + // Description of this filesystem. optional string description = 4 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Path the mountpoint where this filesystem should be mounted on + // Path the mountpoint where this filesystem should be mounted on. optional string path = 5 [(buf.validate.field).string = { min_len: 1 max_len: 4096 }]; - // Label an optional label for this filesystem + // Label an optional label for this filesystem. optional string label = 6 [ (buf.validate.field).string.(metalstack.api.v2.is_name) = true, (buf.validate.field).string.(metalstack.api.v2.trimmed) = true ]; - // MountOptions the options to use to mount this filesystem + // MountOptions the options to use to mount this filesystem. repeated string mount_options = 7 [(buf.validate.field).repeated = { unique: true max_items: 32 @@ -112,7 +112,7 @@ message Filesystem { string: {[metalstack.api.v2.is_option]: true} } }]; - // CreateOptions the options to use to create (mkfs) this filesystem + // CreateOptions the options to use to create (mkfs) this filesystem. repeated string create_options = 8 [(buf.validate.field).repeated = { unique: true max_items: 32 @@ -122,9 +122,9 @@ message Filesystem { }]; } -// Disk +// Disk. message Disk { - // Device the device to create the partitions + // Device the device to create the partitions. string device = 1 [ (buf.validate.field).string.(metalstack.api.v2.is_name) = true, (buf.validate.field).string.(metalstack.api.v2.trimmed) = true @@ -133,9 +133,9 @@ message Disk { repeated DiskPartition partitions = 2; } -// Raid +// Raid. message Raid { - // ArrayName the name of the resulting array device + // ArrayName the name of the resulting array device. string array_name = 1 [ (buf.validate.field).string.(metalstack.api.v2.is_name) = true, (buf.validate.field).string.(metalstack.api.v2.trimmed) = true @@ -155,7 +155,7 @@ message Raid { (buf.validate.field).enum.defined_only = true, (buf.validate.field).required = true ]; - // CreateOptions the options to use to create the raid array + // CreateOptions the options to use to create the raid array. repeated string create_options = 4 [(buf.validate.field).repeated = { unique: true max_items: 32 @@ -163,31 +163,31 @@ message Raid { string: {[metalstack.api.v2.is_option]: true} } }]; - // Spares number of spares for the raid array + // Spares number of spares for the raid array. int32 spares = 5; } -// DiskPartition +// DiskPartition. message DiskPartition { // Number partition number, will be appended to partitionprefix to create the final devicename. uint32 number = 1; - // Label an optional label for this partition + // Label an optional label for this partition. optional string label = 2 [ (buf.validate.field).string.(metalstack.api.v2.is_name) = true, (buf.validate.field).string.(metalstack.api.v2.trimmed) = true ]; - // Size in mebibytes (MiB) of this partition + // Size in mebibytes (MiB) of this partition. uint64 size = 3; - // GPTType the gpt partition table type of this partition + // GPTType the gpt partition table type of this partition. optional GPTType gpt_type = 4 [ (buf.validate.field).enum.defined_only = true, (buf.validate.field).required = true ]; } -// VolumeGroup +// VolumeGroup. message VolumeGroup { - // Name the name of the resulting volume group + // Name the name of the resulting volume group. string name = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // Devices list of devices to form the volume group from. repeated string devices = 2 [ @@ -211,33 +211,33 @@ message VolumeGroup { ]; } -// LogicalVolume +// LogicalVolume. message LogicalVolume { - // Name the name of the logical volume + // Name the name of the logical volume. string name = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // VolumeGroup the name of the volume group where to create the logical volume onto + // VolumeGroup the name of the volume group where to create the logical volume onto. string volume_group = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Size size in mebibytes (MiB) of this volume + // Size size in mebibytes (MiB) of this volume. uint64 size = 3; - // LVMType the type of this logical volume can be either linear|striped|raid1 + // LVMType the type of this logical volume can be either linear|striped|raid1. LVMType lvm_type = 4 [(buf.validate.field).enum.defined_only = true]; } -// LVMType +// LVMType. enum LVMType { // LVM_TYPE_UNSPECIFIED is not specified. LVM_TYPE_UNSPECIFIED = 0; - // LVM_TYPE_LINEAR append across all physical volumes + // LVM_TYPE_LINEAR append across all physical volumes. LVM_TYPE_LINEAR = 1 [(enum_string_value) = "linear"]; - // LVM_TYPE_STRIPED stripe across all physical volumes + // LVM_TYPE_STRIPED stripe across all physical volumes. LVM_TYPE_STRIPED = 2 [(enum_string_value) = "striped"]; - // LVM_TYPE_RAID1 mirror with raid across all physical volumes + // LVM_TYPE_RAID1 mirror with raid across all physical volumes. LVM_TYPE_RAID1 = 3 [(enum_string_value) = "raid1"]; } // Format specifies the filesystem to use on a volume. enum Format { - // FORMAT_UNSPECIFIED + // FORMAT_UNSPECIFIED. FORMAT_UNSPECIFIED = 0; // FORMAT_VFAT is used for the UEFI boot partition. FORMAT_VFAT = 1 [(enum_string_value) = "vfat"]; @@ -249,7 +249,7 @@ enum Format { FORMAT_SWAP = 4 [(enum_string_value) = "swap"]; // FORMAT_TMPFS is used for a memory filesystem typically /tmp. FORMAT_TMPFS = 5 [(enum_string_value) = "tmpfs"]; - // FORMAT_NONE + // FORMAT_NONE. FORMAT_NONE = 6 [(enum_string_value) = "none"]; } @@ -257,13 +257,13 @@ enum Format { enum GPTType { // GPT_TYPE_UNSPECIFIED is no specified. GPT_TYPE_UNSPECIFIED = 0; - // GPT_TYPE_BOOT EFI Boot Partition + // GPT_TYPE_BOOT EFI Boot Partition. GPT_TYPE_BOOT = 1 [(enum_string_value) = "ef00"]; - // GPT_TYPE_LINUX Linux Partition + // GPT_TYPE_LINUX Linux Partition. GPT_TYPE_LINUX = 2 [(enum_string_value) = "8300"]; - // GPT_TYPE_LINUX_RAID Linux Raid Partition + // GPT_TYPE_LINUX_RAID Linux Raid Partition. GPT_TYPE_LINUX_RAID = 3 [(enum_string_value) = "fd00"]; - // GPT_TYPE_LINUX_LVM Linux LVM Partition + // GPT_TYPE_LINUX_LVM Linux LVM Partition. GPT_TYPE_LINUX_LVM = 4 [(enum_string_value) = "8e00"]; } diff --git a/proto/metalstack/api/v2/health.proto b/proto/metalstack/api/v2/health.proto index 930a8a3b..8c6a5e8d 100644 --- a/proto/metalstack/api/v2/health.proto +++ b/proto/metalstack/api/v2/health.proto @@ -15,13 +15,13 @@ service HealthService { // ServiceStatus defines the status of a service. enum ServiceStatus { - // SERVICE_STATUS_UNSPECIFIED service status is not known or unspecified + // SERVICE_STATUS_UNSPECIFIED service status is not known or unspecified. SERVICE_STATUS_UNSPECIFIED = 0; - // SERVICE_STATUS_DEGRADED the service is in degraded status, not the whole functionality is available + // SERVICE_STATUS_DEGRADED the service is in degraded status, not the whole functionality is available. SERVICE_STATUS_DEGRADED = 1; - // SERVICE_STATUS_UNHEALTHY the service is in unhealthy status, serious impact is expected + // SERVICE_STATUS_UNHEALTHY the service is in unhealthy status, serious impact is expected. SERVICE_STATUS_UNHEALTHY = 2; - // SERVICE_STATUS_HEALTHY the service is in healthy status, for example fully functional + // SERVICE_STATUS_HEALTHY the service is in healthy status, for example fully functional. SERVICE_STATUS_HEALTHY = 3; } @@ -29,21 +29,21 @@ enum ServiceStatus { enum Service { // SERVICE_UNSPECIFIED is a unknown service. SERVICE_UNSPECIFIED = 0; - // SERVICE_IPAM the IPAM service + // SERVICE_IPAM the IPAM service. SERVICE_IPAM = 1 [(enum_string_value) = "ipam"]; - // SERVICE_RETHINK the RethinkDB + // SERVICE_RETHINK the RethinkDB. SERVICE_RETHINK = 2 [(enum_string_value) = "rethinkdb"]; - // SERVICE_TENANT_APISERVER the tenant-apiserver + // SERVICE_TENANT_APISERVER the tenant-apiserver. SERVICE_TENANT_APISERVER = 3 [(enum_string_value) = "tenant-apiserver"]; - // SERVICE_MACHINES the machine service + // SERVICE_MACHINES the machine service. SERVICE_MACHINES = 4 [(enum_string_value) = "machines"]; - // SERVICE_AUDIT the auditing + // SERVICE_AUDIT the auditing. SERVICE_AUDIT = 5 [(enum_string_value) = "audit"]; - // SERVICE_VPN the VPN service + // SERVICE_VPN the VPN service. SERVICE_VPN = 6 [(enum_string_value) = "vpn"]; - // SERVICE_REDIS the Redis service + // SERVICE_REDIS the Redis service. SERVICE_REDIS = 7 [(enum_string_value) = "redis"]; - // SERVICE_TASKS the tasks service + // SERVICE_TASKS the tasks service. SERVICE_TASKS = 8 [(enum_string_value) = "tasks"]; } diff --git a/proto/metalstack/api/v2/image.proto b/proto/metalstack/api/v2/image.proto index 0cee8b01..394957e2 100644 --- a/proto/metalstack/api/v2/image.proto +++ b/proto/metalstack/api/v2/image.proto @@ -28,7 +28,7 @@ service ImageService { // ImageServiceGetRequest is the request payload for an image get request. message ImageServiceGetRequest { - // ID of the image to get + // ID of the image to get. string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; } @@ -40,51 +40,51 @@ message ImageServiceListRequest { // ImageServiceLatestRequest is the request payload for an image latest request. message ImageServiceLatestRequest { - // OS for which the latest image should be fetched - // should contain os and major.minor then latest patch version of this os is returned + // OS for which the latest image should be fetched. + // Should contain os and major.minor then latest patch version of this os is returned. string os = 1; - // Classification of the image latest image + // Classification of the image latest image. optional ImageClassification classification = 2 [(buf.validate.field).enum.defined_only = true]; } // ImageServiceGetResponse is the response payload for an image get request. message ImageServiceGetResponse { - // Image the image + // Image the image. Image image = 1; } // ImageServiceListResponse is the response payload for an image list request. message ImageServiceListResponse { - // Images the images + // Images the images. repeated Image images = 1; } // ImageServiceLatestResponse is the response payload for an image latest request. message ImageServiceLatestResponse { - // Image which is the latest for one os + // Image which is the latest for one os. Image image = 1; } -// Image +// Image. message Image { - // Id of this image + // Id of this image. string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Meta for this image + // Meta for this image. Meta meta = 2; - // URL where this image is located + // URL where this image is located. string url = 3 [(buf.validate.field).string.(metalstack.api.v2.is_uri) = true]; - // Name of this image + // Name of this image. optional string name = 4 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Description of this image + // Description of this image. optional string description = 5 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Features of this image + // Features of this image. repeated ImageFeature features = 6 [(buf.validate.field).repeated = { unique: true items: { enum: {defined_only: true} } }]; - // Classification of this image + // Classification of this image. ImageClassification classification = 7 [(buf.validate.field).enum.defined_only = true]; // ExpiresAt usage is not possible after this date. @@ -93,43 +93,43 @@ message Image { // ImageUsage reports which machines/firewalls actually use this image. message ImageUsage { - // Image with usage + // Image with usage. Image image = 1; - // UsedBy the following machines/firewalls + // UsedBy the following machines/firewalls. repeated string used_by = 2; } // ImageQuery is used to search images. message ImageQuery { - // ID of the image to get + // ID of the image to get. optional string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // OS of the image + // OS of the image. optional string os = 2 [(buf.validate.field).string = { min_len: 2 max_len: 128 }]; - // Version of the Image + // Version of the Image. optional string version = 3 [(buf.validate.field).string = { min_len: 1 max_len: 128 }]; - // Name of the image to query + // Name of the image to query. optional string name = 4 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Description of the image to query + // Description of the image to query. optional string description = 5 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Url of the image to query + // Url of the image to query. optional string url = 6 [(buf.validate.field).string.(metalstack.api.v2.is_uri) = true]; - // Feature of the image to query + // Feature of the image to query. optional ImageFeature feature = 7 [(buf.validate.field).enum.defined_only = true]; - // Classification of the image to query + // Classification of the image to query. optional ImageClassification classification = 8 [(buf.validate.field).enum.defined_only = true]; // Labels lists only images containing the given labels. optional Labels labels = 9; } -// ImageFeature +// ImageFeature. enum ImageFeature { // IMAGE_FEATURE_UNSPECIFIED is not specified. IMAGE_FEATURE_UNSPECIFIED = 0; @@ -139,7 +139,7 @@ enum ImageFeature { IMAGE_FEATURE_FIREWALL = 2 [(enum_string_value) = "firewall"]; } -// Image +// Image. enum ImageClassification { // IMAGE_CLASSIFICATION_UNSPECIFIED is not specified. IMAGE_CLASSIFICATION_UNSPECIFIED = 0; diff --git a/proto/metalstack/api/v2/ip.proto b/proto/metalstack/api/v2/ip.proto index 0946c5c2..fe487698 100644 --- a/proto/metalstack/api/v2/ip.proto +++ b/proto/metalstack/api/v2/ip.proto @@ -64,32 +64,32 @@ enum IPAddressFamily { // IP is an IP address which can be used as loadbalancer addresses. message IP { - // Uuid of this ip + // Uuid of this ip. string uuid = 1 [(buf.validate.field).string.uuid = true]; - // Meta for this ip + // Meta for this ip. Meta meta = 2; // Ip is either ipv4 or ipv6 address. string ip = 3 [(buf.validate.field).string.ip = true]; - // Name of this ip + // Name of this ip. string name = 4 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Description of this ip + // Description of this ip. string description = 5 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; // Network is the network this ip belongs to. string network = 6 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // Project where this ip address belongs to. string project = 7 [(buf.validate.field).string.uuid = true]; - // Type of this ip + // Type of this ip. IPType type = 8 [(buf.validate.field).enum.defined_only = true]; // Namespace if specified this ip is from a namespaced network and can therefore overlap with others. - // Will be equal with project most of the time + // Will be equal with project most of the time. optional string namespace = 9 [(buf.validate.field).string.uuid = true]; } // IPServiceGetRequest is the request payload for an IP get request. message IPServiceGetRequest { - // IP of the ip to get + // IP of the ip to get. string ip = 1 [(buf.validate.field).string.ip = true]; - // Project of the ip + // Project of the ip. string project = 2 [(buf.validate.field).string.uuid = true]; // Namespace can be specified to get the ip of a namespace. optional string namespace = 3 [(buf.validate.field).string.uuid = true]; @@ -99,45 +99,45 @@ message IPServiceGetRequest { message IPServiceCreateRequest { // Network from which the IP should be created. string network = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Project of the ip + // Project of the ip. string project = 2 [(buf.validate.field).string.uuid = true]; - // Name of the ip + // Name of the ip. optional string name = 3 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Description of the ip + // Description of the ip. optional string description = 4 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // IP if given try to create this ip if still available + // IP if given try to create this ip if still available. optional string ip = 5 [(buf.validate.field).string.ip = true]; - // Machine for which this ip should get created + // Machine for which this ip should get created. optional string machine = 6 [(buf.validate.field).string.uuid = true]; - // Labels to put onto the ip + // Labels to put onto the ip. optional Labels labels = 7; - // Type of the IP, ether ephemeral (default), or static + // Type of the IP, ether ephemeral (default), or static. optional IPType type = 8 [(buf.validate.field).enum.defined_only = true]; - // Addressfamily of the IP to create, defaults to ipv4 + // Addressfamily of the IP to create, defaults to ipv4. optional IPAddressFamily address_family = 9 [(buf.validate.field).enum.defined_only = true]; } // IPServiceUpdateRequest is the request payload for an IP update request. message IPServiceUpdateRequest { - // Ip the ip address to update + // Ip the ip address to update. string ip = 1 [(buf.validate.field).string.ip = true]; // UpdateMeta contains the timestamp and strategy to be used in this update request. UpdateMeta update_meta = 2 [(buf.validate.field).required = true]; - // Project id of the ip + // Project id of the ip. string project = 3 [(buf.validate.field).string.uuid = true]; - // Name of this ip + // Name of this ip. optional string name = 4 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Description of this ip + // Description of this ip. optional string description = 5 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Type of this ip + // Type of this ip. optional IPType type = 6 [(buf.validate.field).enum.defined_only = true]; - // Labels on this ip + // Labels on this ip. optional UpdateLabels labels = 7; } // IPServiceListRequest is the request payload for an IP list request. message IPServiceListRequest { - // Project of the ips to list + // Project of the ips to list. string project = 1 [(buf.validate.field).string.uuid = true]; // Query to list one or more IPs. IPQuery query = 2; @@ -145,21 +145,21 @@ message IPServiceListRequest { // IPQuery can be used to query a IP or a list of IP. message IPQuery { - // Ip the ip to list + // Ip the ip to list. optional string ip = 1 [(buf.validate.field).string.ip = true]; // Network from which the IPs are to list. optional string network = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Project of the ips to list + // Project of the ips to list. optional string project = 3 [(buf.validate.field).string.uuid = true]; - // Name of this ip + // Name of this ip. optional string name = 4 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // UUID for which these IPs should be filtered + // UUID for which these IPs should be filtered. optional string uuid = 5 [(buf.validate.field).string.uuid = true]; - // Machine for which these IPs should be filtered + // Machine for which these IPs should be filtered. optional string machine = 6 [(buf.validate.field).string.uuid = true]; - // ParentPrefixCidr for which this ips should get filtered + // ParentPrefixCidr for which this ips should get filtered. optional string parent_prefix_cidr = 7 [(buf.validate.field).string.ip_prefix = true]; - // Labels for which these IPs should be filtered + // Labels for which these IPs should be filtered. optional Labels labels = 8; // Static if set to true, this will be a Static ip. optional IPType type = 9 [(buf.validate.field).enum.defined_only = true]; @@ -171,38 +171,38 @@ message IPQuery { // IPServiceDeleteRequest is the request payload for a ip delete request. message IPServiceDeleteRequest { - // IP of the ip to delete + // IP of the ip to delete. string ip = 1 [(buf.validate.field).string.ip = true]; - // Project of the ip + // Project of the ip. string project = 2 [(buf.validate.field).string.uuid = true]; } // IPServiceGetResponse is the response payload for an IP get request. message IPServiceGetResponse { - // Ip the ip + // Ip the ip. IP ip = 1; } // IPServiceUpdateResponse is the response payload for a ip update request. message IPServiceUpdateResponse { - // Ip the ip + // Ip the ip. IP ip = 1; } // IPServiceCreateResponse is the response payload for an IP create request. message IPServiceCreateResponse { - // Ip the ip + // Ip the ip. IP ip = 1; } // IPServiceListResponse is the response payload for an IP list request. message IPServiceListResponse { - // Ips the ips + // Ips the ips. repeated IP ips = 1; } // IPServiceDeleteResponse is the response payload for an IP delete request. message IPServiceDeleteResponse { - // Ip the ip + // Ip the ip. IP ip = 1; } diff --git a/proto/metalstack/api/v2/machine.proto b/proto/metalstack/api/v2/machine.proto index 0b95528e..c35d8381 100644 --- a/proto/metalstack/api/v2/machine.proto +++ b/proto/metalstack/api/v2/machine.proto @@ -65,9 +65,9 @@ service MachineService { // MachineServiceGetRequest is the request payload for a machine get request. message MachineServiceGetRequest { - // UUID of the machine to get + // UUID of the machine to get. string uuid = 1 [(buf.validate.field).string.uuid = true]; - // Project of the machine + // Project of the machine. string project = 2 [(buf.validate.field).string.uuid = true]; } @@ -79,33 +79,33 @@ message MachineServiceGetResponse { // MachineServiceCreateRequest is the request payload for a machine create request. message MachineServiceCreateRequest { - // Project of the machine + // Project of the machine. string project = 1 [(buf.validate.field).string.uuid = true]; // UUID if this field is set, this specific machine will be allocated if it is not in available state and not currently allocated. // this field takes precedence over size and partition. - // Can only be used with ADMIN_ROLE_EDITOR + // Can only be used with ADMIN_ROLE_EDITOR. optional string uuid = 2 [(buf.validate.field).string.uuid = true]; - // Name of this machine + // Name of this machine. string name = 3 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Description for this machine + // Description for this machine. optional string description = 4 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Hostname the hostname for the allocated machine (defaults to metal) + // Hostname the hostname for the allocated machine (defaults to metal). optional string hostname = 5 [(buf.validate.field).string.hostname = true]; - // Partition the partition id to assign this machine to, must be omitted if uuid is given + // Partition the partition id to assign this machine to, must be omitted if uuid is given. optional string partition = 6 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; - // Size of the machine to create, must be omitted if uuid is given + // Size of the machine to create, must be omitted if uuid is given. optional string size = 7 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Image which should be installed on this machine - // The image can be specified either in the fully qualified form, e.g. including os, major, minor and patch. - // - debian-13.0.20260402 - // or in a simplified form which omits the patch version - // - debian-13.0 - // If the fully qualified form is specified, exactly this image is taken regardless of the image classification - // if the short form is given, only the most recent images which has image classification supported is used. + // Image which should be installed on this machine. + // The image can be specified either in the fully qualified form, e.g. including os, major, minor and patch + // - debian-13.0.2026040 + // - or in a simplified form which omits the patch version. + // - debian-13. + // If the fully qualified form is specified, exactly this image is taken regardless of the image classification. + // If the short form is given, only the most recent images which has image classification supported is used. string image = 8 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // FilesystemLayout which should be applied for the operating system installation + // FilesystemLayout which should be applied for the operating system installation. // Is defaulted by a lookup at the available fsls for this size and image. - // Can be specified to test new fsls during development of fsls + // Can be specified to test new fsls during development of fsls. optional string filesystem_layout = 9 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // SSHPublicKeys defines the ssh public key to be installed on the machine to access it via ssh. repeated string ssh_public_keys = 10 [ @@ -121,23 +121,23 @@ message MachineServiceCreateRequest { (buf.validate.field).repeated.(metalstack.api.v2.all_trimmed) = true ]; // Userdata contains instructions required to bootstrap the machine. - // AWS limits the max userdata size to 16k, lets allow twice as much + // AWS limits the max userdata size to 16k, lets allow twice as much. optional string userdata = 11 [ (buf.validate.field).string = {max_len: 32768}, (buf.validate.field).string.(metalstack.api.v2.trimmed) = true ]; - // Labels to be attached to this machine allocation + // Labels to be attached to this machine allocation. Labels labels = 12; // Networks the networks that this machine will be placed in. repeated MachineAllocationNetwork networks = 13 [(buf.validate.field).repeated.min_items = 1]; // PlacementTags by default machines are spread across the racks inside a partition for every project. - // if placement tags are provided, the machine candidate has an additional anti-affinity to other machines having the same tags + // if placement tags are provided, the machine candidate has an additional anti-affinity to other machines having the same tags. repeated string placement_tags = 14 [(buf.validate.field).repeated.max_items = 64]; - // DNSServer the dns servers used for the machine + // DNSServer the dns servers used for the machine. repeated DNSServer dns_servers = 15 [(buf.validate.field).repeated.max_items = 3]; - // NTPServer the ntp servers used for the machine + // NTPServer the ntp servers used for the machine. repeated NTPServer ntp_servers = 16 [(buf.validate.field).repeated.max_items = 10]; - // AllocationType of this machine + // AllocationType of this machine. MachineAllocationType allocation_type = 17 [(buf.validate.field).enum.defined_only = true]; // FirewallSpec provides firewall specific parameters if allocationType is firewall. FirewallSpec firewall_spec = 18; @@ -145,29 +145,29 @@ message MachineServiceCreateRequest { // FirewallSpec contains firewall specific firewall creation parameters. message FirewallSpec { - // FirewallRules to be applied if this is a firewall + // FirewallRules to be applied if this is a firewall. FirewallRules firewall_rules = 1; } // MachineServiceCreateResponse is the response payload for a machine create request. message MachineServiceCreateResponse { - // Machine which was created + // Machine which was created. Machine machine = 1; } // MachineServiceUpdateRequest is the request payload for a machine update request. message MachineServiceUpdateRequest { - // UUID of the machine to modify + // UUID of the machine to modify. string uuid = 1 [(buf.validate.field).string.uuid = true]; // UpdateMeta contains the timestamp and strategy to be used in this update request. UpdateMeta update_meta = 2 [(buf.validate.field).required = true]; - // Project of the machine + // Project of the machine. string project = 3 [(buf.validate.field).string.uuid = true]; - // Description of this machine allocation + // Description of this machine allocation. optional string description = 4 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Labels to update on this machine allocation + // Labels to update on this machine allocation. optional UpdateLabels labels = 5; - // SSHPublicKeys which should be update of this machine allocation + // SSHPublicKeys which should be update of this machine allocation. repeated string ssh_public_keys = 6 [ (buf.validate.field).repeated = { // At most 50 keys can be stored. @@ -184,13 +184,13 @@ message MachineServiceUpdateRequest { // MachineServiceUpdateResponse is the response payload for a machine update request. message MachineServiceUpdateResponse { - // Machine which was updated + // Machine which was updated. Machine machine = 1; } // MachineServiceListRequest is the request payload for a machine list request. message MachineServiceListRequest { - // Project of the machines to list + // Project of the machines to list. string project = 1 [(buf.validate.field).string.uuid = true]; // Query to list one ore more machines. MachineQuery query = 2; @@ -204,25 +204,25 @@ message MachineServiceListResponse { // MachineServiceDeleteRequest is the request payload for a machine delete request. message MachineServiceDeleteRequest { - // UUID of the machine to delete + // UUID of the machine to delete. string uuid = 1 [(buf.validate.field).string.uuid = true]; - // Project of the machine + // Project of the machine. string project = 2 [(buf.validate.field).string.uuid = true]; } // MachineServiceDeleteResponse is the response payload for a machine delete request. message MachineServiceDeleteResponse { - // Machine which was deleted + // Machine which was deleted. Machine machine = 1; } // MachineServiceBMCCommandRequest is the request payload for a machine bmc command. message MachineServiceBMCCommandRequest { - // UUID of the machine to send the command to + // UUID of the machine to send the command to. string uuid = 1 [(buf.validate.field).string.uuid = true]; - // Project of the machine + // Project of the machine. string project = 2 [(buf.validate.field).string.uuid = true]; - // Command to send to the bmc of the machine + // Command to send to the bmc of the machine. MachineBMCCommand command = 3 [(buf.validate.field).enum.defined_only = true]; } @@ -231,15 +231,15 @@ message MachineServiceBMCCommandResponse {} // MachineServiceGetBMCRequest is the request payload for a machine getbmc request. message MachineServiceGetBMCRequest { - // UUID of the machine to get + // UUID of the machine to get. string uuid = 1 [(buf.validate.field).string.uuid = true]; - // Project of the machine + // Project of the machine. string project = 2 [(buf.validate.field).string.uuid = true]; } // MachineServiceGetBMCResponse is the response payload for a machine getbmc request. message MachineServiceGetBMCResponse { - // UUID of the machine + // UUID of the machine. string uuid = 1 [(buf.validate.field).string.uuid = true]; // BMC contains the BMC details of this machine. MachineBMCReport bmc = 2; @@ -249,21 +249,21 @@ message MachineServiceGetBMCResponse { // Machine represents a physical bare metal machine. message Machine { - // UUID of this machine + // UUID of this machine. string uuid = 1 [(buf.validate.field).string.uuid = true]; - // Meta for this machine + // Meta for this machine. Meta meta = 2; - // Partition where this machine resides + // Partition where this machine resides. Partition partition = 3; // Rack where this machine is located. string rack = 4 [(buf.validate.field).string = {max_len: 128}]; // Room where this machine is located. string room = 5 [(buf.validate.field).string = {max_len: 128}]; - // Size of this machine + // Size of this machine. Size size = 6; - // Hardware specs of this machine + // Hardware specs of this machine. MachineHardware hardware = 7; - // Allocation details + // Allocation details. MachineAllocation allocation = 8; // Status contains several status details related to this machine. MachineStatus status = 9; @@ -277,46 +277,46 @@ message MachineStatus { MachineCondition condition = 1; // LEDState indicates the state of the indicator LED on this machine. MachineChassisIdentifyLEDState led_state = 2; - // Liveliness of this machine + // Liveliness of this machine. MachineLiveliness liveliness = 3 [(buf.validate.field).enum.defined_only = true]; - // MetalHammerVersion the version of metal hammer which put the machine in waiting state + // MetalHammerVersion the version of metal hammer which put the machine in waiting state. string metal_hammer_version = 4; } // MachineCondition describes the availability of this machine. message MachineCondition { - // State the state of this machine. empty means available for all + // State the state of this machine. empty means available for al. MachineState state = 1 [(buf.validate.field).enum.defined_only = true]; - // Description a description why this machine is in the given state + // Description a description why this machine is in the given state. string description = 2 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Issuer the user that changed the state + // Issuer the user that changed the state. string issuer = 3 [(buf.validate.field).string = {max_len: 256}]; } // MachineAllocation contains properties if this machine is allocated. message MachineAllocation { - // UUID of this machine allocation + // UUID of this machine allocation. string uuid = 1 [(buf.validate.field).string.uuid = true]; - // Meta for this machine allocation + // Meta for this machine allocation. Meta meta = 2; - // Name of this allocation + // Name of this allocation. string name = 3 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Description of this allocation + // Description of this allocation. string description = 4 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Created By indicates who created this machine allocation + // Created By indicates who created this machine allocation. string created_by = 5 [(buf.validate.field).string = {max_len: 128}]; - // Project of the allocation + // Project of the allocation. string project = 6 [(buf.validate.field).string.uuid = true]; - // Image to be used to install on this machine + // Image to be used to install on this machine. Image image = 7; - // FilesystemLayout to create on the disks + // FilesystemLayout to create on the disks. FilesystemLayout filesystem_layout = 8; - // Networks this machine should be attached to + // Networks this machine should be attached to. // Order of ips of external networks will be preserved. repeated MachineNetwork networks = 9; - // Hostname of the allocated machine + // Hostname of the allocated machine. string hostname = 10 [(buf.validate.field).string.hostname = true]; - // SSHPublicKeys which should be installed on this machine + // SSHPublicKeys which should be installed on this machine. repeated string ssh_public_keys = 11 [ (buf.validate.field).repeated = { // At most 50 keys can be stored. @@ -330,28 +330,28 @@ message MachineAllocation { (buf.validate.field).repeated.(metalstack.api.v2.all_trimmed) = true ]; // Userdata contains instructions required to bootstrap the machine. - // AWS limits the max userdata size to 16k, lets allow twice as much + // AWS limits the max userdata size to 16k, lets allow twice as much. string userdata = 12 [ (buf.validate.field).string = {max_len: 32768}, (buf.validate.field).string.(metalstack.api.v2.trimmed) = true ]; - // AllocationType of this machine + // AllocationType of this machine. MachineAllocationType allocation_type = 13 [(buf.validate.field).enum.defined_only = true]; - // FirewallRules to be applied if this is a firewall + // FirewallRules to be applied if this is a firewall. FirewallRules firewall_rules = 14; - // DNSServers for this machine + // DNSServers for this machine. repeated DNSServer dns_servers = 15 [(buf.validate.field).repeated.max_items = 3]; - // NTPServers for this machine + // NTPServers for this machine. repeated NTPServer ntp_servers = 16 [(buf.validate.field).repeated.max_items = 10]; - // VPN connection configuration + // VPN connection configuration. MachineVPN vpn = 17; } // MachineAllocationNetwork defines which network should be attached to a machine and if ips should be autoacquired. message MachineAllocationNetwork { - // Network the id of the network that this machine will be placed in + // Network the id of the network that this machine will be placed in. string network = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // IPs to to attach to this machine additionally + // IPs to to attach to this machine additionally. // If none given, one ip address is acquired per network for the machine. // Order of ips is preserved on the loopback interface. repeated string ips = 2 [(buf.validate.field).repeated.(metalstack.api.v2.ips) = true]; @@ -367,17 +367,17 @@ message FirewallRules { // FirewallEgressRule defines rules for outgoing traffic. message FirewallEgressRule { - // Protocol the protocol for the rule, defaults to tcp + // Protocol the protocol for the rule, defaults to tcp. IPProtocol protocol = 1 [(buf.validate.field).enum.defined_only = true]; - // Ports the ports affected by this rule + // Ports the ports affected by this rule. repeated uint32 ports = 2 [(buf.validate.field).repeated = { items: { uint32: {lte: 65532} } }]; - // To the destination cidrs affected by this rule + // To the destination cidrs affected by this rule. repeated string to = 3 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; - // Comment for this rule + // Comment for this rule. string comment = 4 [(buf.validate.field) = { string: { pattern: "^[a-z_ -]*$" @@ -389,19 +389,19 @@ message FirewallEgressRule { // FirewallIngressRule defines rules for incoming traffic. message FirewallIngressRule { - // Protocol the protocol for the rule, defaults to tcp + // Protocol the protocol for the rule, defaults to tcp. IPProtocol protocol = 1 [(buf.validate.field).enum.defined_only = true]; - // Ports the ports affected by this rule + // Ports the ports affected by this rule. repeated uint32 ports = 2 [(buf.validate.field).repeated = { items: { uint32: {lte: 65532} } }]; - // To the destination cidrs affected by this rule + // To the destination cidrs affected by this rule. repeated string to = 3 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; - // From the source cidrs affected by this rule + // From the source cidrs affected by this rule. repeated string from = 4 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; - // Comment for this rule + // Comment for this rule. string comment = 5 [(buf.validate.field) = { string: { pattern: "^[a-z_ -]*$" @@ -423,21 +423,21 @@ enum IPProtocol { // MachineNetwork contains details which network should be created on a allocated machine. message MachineNetwork { - // Network the networkID of the allocated machine in this vrf + // Network the networkID of the allocated machine in this vrf. string network = 1; - // Prefixes the prefixes of this network + // Prefixes the prefixes of this network. repeated string prefixes = 2 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; // DestinationPrefixes prefixes that are reachable within this network. repeated string destination_prefixes = 3 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; - // IPs the ip addresses of the allocated machine in this vrf + // IPs the ip addresses of the allocated machine in this vrf. repeated string ips = 4 [(buf.validate.field).repeated.(metalstack.api.v2.ips) = true]; - // NetworkType the type of network of this vrf + // NetworkType the type of network of this vrf. NetworkType network_type = 5 [(buf.validate.field).enum.defined_only = true]; // NatType what type of nat if any should be used. NATType nat_type = 6 [(buf.validate.field).enum.defined_only = true]; - // VRF the vrf id + // VRF the vrf id. uint64 vrf = 7; - // ASN the autonomous system number for this network + // ASN the autonomous system number for this network. uint32 asn = 8; // Project is the project uuid associated with this network. optional string project = 9 [(buf.validate.field).string.uuid = true]; @@ -445,63 +445,63 @@ message MachineNetwork { // MachineHardware contains hardware details. message MachineHardware { - // Memory the total memory of the machine in bytes + // Memory the total memory of the machine in bytes. uint64 memory = 1; - // Disks the list of block devices of this machine + // Disks the list of block devices of this machine. repeated MachineBlockDevice disks = 2; - // CPUs the cpu details + // CPUs the cpu details. repeated MetalCPU cpus = 3; - // GPUs the gpu details + // GPUs the gpu details. repeated MetalGPU gpus = 4; - // Nics the list of network interfaces of this machine + // Nics the list of network interfaces of this machine. repeated MachineNic nics = 5; } // MetalCPU contains details of a cpu in this machine. message MetalCPU { - // Vendor of this cpu + // Vendor of this cpu. string vendor = 1 [(buf.validate.field).string = {max_len: 256}]; - // Model of this cpu + // Model of this cpu. string model = 2 [(buf.validate.field).string = {max_len: 256}]; - // Cores of this cpu + // Cores of this cpu. uint32 cores = 3; - // Threads of this cpu + // Threads of this cpu. uint32 threads = 4; } // MetalGPU contains details of a gpu in this machine. message MetalGPU { - // Vendor of this gpu + // Vendor of this gpu. string vendor = 1 [(buf.validate.field).string = {max_len: 256}]; - // Model of this gpu + // Model of this gpu. string model = 2 [(buf.validate.field).string = {max_len: 256}]; } // MachineNic contains details of a network interface of this machine. message MachineNic { - // Mac the macaddress of this interface + // Mac the macaddress of this interface. string mac = 1 [(buf.validate.field).string.(macaddress) = true]; - // Name of this interface + // Name of this interface. string name = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Identifier the unique identifier of this network interface + // Identifier the unique identifier of this network interface. string identifier = 3 [(buf.validate.field).string = {max_len: 128}]; - // Vendor of this network card + // Vendor of this network card. string vendor = 4 [(buf.validate.field).string = {max_len: 128}]; - // Model of this network card + // Model of this network card. string model = 5 [(buf.validate.field).string = {max_len: 128}]; - // Speed in bits/second of this network card + // Speed in bits/second of this network card. uint64 speed = 6; - // Neighbors the neighbors visible to this network interface + // Neighbors the neighbors visible to this network interface. repeated MachineNic neighbors = 7; - // Hostname the nic belongs to + // Hostname the nic belongs to. string hostname = 8; } // MachineBlockDevice contains details of a block device of this machine. message MachineBlockDevice { - // Name of this block device + // Name of this block device. string name = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Size of this block device in bytes + // Size of this block device in bytes. uint64 size = 2; } @@ -509,19 +509,19 @@ message MachineBlockDevice { enum MachineState { // MACHINE_STATE_UNSPECIFIED is not specified. MACHINE_STATE_UNSPECIFIED = 0 [(enum_string_value) = ""]; - // MACHINE_STATE_TAINTED this machine is tainted, i.e. this machine is not considered during random machine allocation, but still by specifying the uuid + // MACHINE_STATE_TAINTED this machine is tainted, i.e. this machine is not considered during random machine allocation, but still by specifying the uui. MACHINE_STATE_TAINTED = 1 [(enum_string_value) = "tainted"]; - // MACHINE_STATE_LOCKED this machine is locked, i.e. this machine cannot be allocated or deleted + // MACHINE_STATE_LOCKED this machine is locked, i.e. this machine cannot be allocated or delete. MACHINE_STATE_LOCKED = 2 [(enum_string_value) = "locked"]; - // MACHINE_STATE_AVAILABLE this machine is available for all + // MACHINE_STATE_AVAILABLE this machine is available for all. MACHINE_STATE_AVAILABLE = 3 [(enum_string_value) = "available"]; } // MachineChassisIdentifyLEDState describes the identifier led state. message MachineChassisIdentifyLEDState { - // Value the state of this chassis identify LED. empty means LED-OFF + // Value the state of this chassis identify LED. empty means LED-OF. string value = 1 [(buf.validate.field).string = {max_len: 128}]; - // Description a description why this chassis identify LED is in the given state + // Description a description why this chassis identify LED is in the given state. string description = 2 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; } @@ -545,29 +545,29 @@ message MachineBMCReport { // MachineBios contains BIOS details of this machine. message MachineBios { - // Version the bios version + // Version the bios version. string version = 1 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Vendor the bios vendor + // Vendor the bios vendor. string vendor = 2 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Date the bios date as string because every vendor has different ideas how to describe the date + // Date the bios date as string because every vendor has different ideas how to describe the date. string date = 3 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; } // MachineBMC describe details of the ipmi or out of band device. message MachineBMC { - // Address of this ipmi device from outside in the form of : + // Address of this ipmi device from outside in the form of :. string address = 1 [(buf.validate.field).string.host_and_port = true]; - // Mac address of the network interface of this ipmi device + // Mac address of the network interface of this ipmi device. string mac = 2 [(buf.validate.field).string.(macaddress) = true]; - // User of this ipmi device + // User of this ipmi device. string user = 3 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Password of this ipmi device + // Password of this ipmi device. string password = 4 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Interface of this ipmi device + // Interface of this ipmi device. string interface = 5 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Version of this bmc device + // Version of this bmc device. string version = 6 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // PowerState of this machine + // PowerState of this machine. string power_state = 7 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; } @@ -593,52 +593,44 @@ message MachineFRU { // MachinePowerMetric contains metrics of the power consumption of a machine. message MachinePowerMetric { - // AverageConsumedWatts shall represent the - // average power level that occurred averaged over the last IntervalInMin - // minutes. + // AverageConsumedWatts shall represent the average power level that occurred averaged over the last IntervalInMin minutes. float average_consumed_watts = 1; - // IntervalInMin shall represent the time - // interval (or window), in minutes, in which the PowerMetrics properties - // are measured over. + // IntervalInMin shall represent the time interval (or window), in minutes, in which the PowerMetrics properties are measured over. // Should be an integer, but some Dell implementations return as a float. float interval_in_min = 2; - // MaxConsumedWatts shall represent the - // maximum power level in watts that occurred within the last - // IntervalInMin minutes. + // MaxConsumedWatts shall represent the maximum power level in watts that occurred within the last IntervalInMin minutes. float max_consumed_watts = 3; - // MinConsumedWatts shall represent the - // minimum power level in watts that occurred within the last - // IntervalInMin minutes. + // MinConsumedWatts shall represent the minimum power level in watts that occurred within the last IntervalInMin minutes. float min_consumed_watts = 4; } // MachinePowerSupply contains details of the power supply of a machine. message MachinePowerSupply { - // Health of the powersupply + // Health of the powersupply. string health = 1; - // State of the powersupply + // State of the powersupply. string state = 2; } -// MachineRecentProvisioningEvents the recent provisioning events for this machine +// MachineRecentProvisioningEvents the recent provisioning events for this machine. message MachineRecentProvisioningEvents { - // Events the log of recent machine provisioning events + // Events the log of recent machine provisioning events. repeated MachineProvisioningEvent events = 1; - // LastEventTime the time where the last event was received + // LastEventTime the time where the last event was received. google.protobuf.Timestamp last_event_time = 2; - // LastErrorEvent the last erroneous event received + // LastErrorEvent the last erroneous event received. MachineProvisioningEvent last_error_event = 3; // State can be either CrashLoop, FailedReclaim or something else. MachineProvisioningEventState state = 4 [(buf.validate.field).enum.defined_only = true]; } -// MachineProvisioningEventState possible event states +// MachineProvisioningEventState possible event states. enum MachineProvisioningEventState { // MACHINE_PROVISIONING_EVENT_STATE_UNSPECIFIED is not specified. MACHINE_PROVISIONING_EVENT_STATE_UNSPECIFIED = 0 [(enum_string_value) = ""]; - // MACHINE_PROVISIONING_EVENT_STATE_CRASHLOOP machine is in crash loop + // MACHINE_PROVISIONING_EVENT_STATE_CRASHLOOP machine is in crash loop. MACHINE_PROVISIONING_EVENT_STATE_CRASHLOOP = 1 [(enum_string_value) = "crashloop"]; - // MACHINE_PROVISIONING_EVENT_STATE_FAILED_RECLAIM machine is in failed reclaim + // MACHINE_PROVISIONING_EVENT_STATE_FAILED_RECLAIM machine is in failed reclaim. MACHINE_PROVISIONING_EVENT_STATE_FAILED_RECLAIM = 2 [(enum_string_value) = "failed-reclaim"]; } @@ -646,49 +638,49 @@ enum MachineProvisioningEventState { enum MachineProvisioningEventType { // MACHINE_PROVISIONING_EVENT_TYPE_UNSPECIFIED is not specified. MACHINE_PROVISIONING_EVENT_TYPE_UNSPECIFIED = 0; - // MACHINE_PROVISIONING_EVENT_TYPE_ALIVE machine is alive + // MACHINE_PROVISIONING_EVENT_TYPE_ALIVE machine is alive. MACHINE_PROVISIONING_EVENT_TYPE_ALIVE = 1 [(enum_string_value) = "Alive"]; - // MACHINE_PROVISIONING_EVENT_TYPE_CRASHED machine crashed + // MACHINE_PROVISIONING_EVENT_TYPE_CRASHED machine crashed. MACHINE_PROVISIONING_EVENT_TYPE_CRASHED = 2 [(enum_string_value) = "Crashed"]; - // MACHINE_PROVISIONING_EVENT_TYPE_PXE_BOOTING machine is pxe booting into metal-hammer + // MACHINE_PROVISIONING_EVENT_TYPE_PXE_BOOTING machine is pxe booting into metal-hammer. MACHINE_PROVISIONING_EVENT_TYPE_PXE_BOOTING = 3 [(enum_string_value) = "PXE Booting"]; - // MACHINE_PROVISIONING_EVENT_TYPE_PLANNED_REBOOT machine got a reboot instruction + // MACHINE_PROVISIONING_EVENT_TYPE_PLANNED_REBOOT machine got a reboot instruction. MACHINE_PROVISIONING_EVENT_TYPE_PLANNED_REBOOT = 4 [(enum_string_value) = "Planned Reboot"]; - // MACHINE_PROVISIONING_EVENT_TYPE_PREPARING metal-hammer is preparing the machine + // MACHINE_PROVISIONING_EVENT_TYPE_PREPARING metal-hammer is preparing the machine. MACHINE_PROVISIONING_EVENT_TYPE_PREPARING = 5 [(enum_string_value) = "Preparing"]; - // MACHINE_PROVISIONING_EVENT_TYPE_REGISTERING metal-hammer registers machine at the apiserver + // MACHINE_PROVISIONING_EVENT_TYPE_REGISTERING metal-hammer registers machine at the apiserver. MACHINE_PROVISIONING_EVENT_TYPE_REGISTERING = 6 [(enum_string_value) = "Registering"]; - // MACHINE_PROVISIONING_EVENT_TYPE_WAITING machine is waiting for installation + // MACHINE_PROVISIONING_EVENT_TYPE_WAITING machine is waiting for installation. MACHINE_PROVISIONING_EVENT_TYPE_WAITING = 7 [(enum_string_value) = "Waiting"]; - // MACHINE_PROVISIONING_EVENT_TYPE_INSTALLING metal-hammer is installing the desired os + // MACHINE_PROVISIONING_EVENT_TYPE_INSTALLING metal-hammer is installing the desired os. MACHINE_PROVISIONING_EVENT_TYPE_INSTALLING = 8 [(enum_string_value) = "Installing"]; - // MACHINE_PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL metal-hammer completed installation and boots into target os + // MACHINE_PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL metal-hammer completed installation and boots into target os. MACHINE_PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL = 9 [(enum_string_value) = "Booting New Kernel"]; - // MACHINE_PROVISIONING_EVENT_TYPE_PHONED_HOME machine is installed and phones home + // MACHINE_PROVISIONING_EVENT_TYPE_PHONED_HOME machine is installed and phones home. MACHINE_PROVISIONING_EVENT_TYPE_PHONED_HOME = 10 [(enum_string_value) = "Phoned Home"]; - // MACHINE_PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM machine is not allocated, but phones home + // MACHINE_PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM machine is not allocated, but phones home. MACHINE_PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM = 11 [(enum_string_value) = "Machine Reclaim"]; } // MachineProvisioningEvent is an event that has occurred during provisioning. message MachineProvisioningEvent { - // Time the time that this event was received + // Time the time that this event was received. google.protobuf.Timestamp time = 1; - // Event the event emitted by the machine + // Event the event emitted by the machine. MachineProvisioningEventType event = 2 [(buf.validate.field).enum.defined_only = true]; - // Message an additional message to add to the event + // Message an additional message to add to the event. string message = 3; } // MachineVPN contains configuration data for the VPN connection. message MachineVPN { - // Address of VPN control plane + // Address of VPN control plane. string control_plane_address = 1; - // Auth key used to connect to VPN + // Auth key used to connect to VPN. string auth_key = 2; // Connected indicate if this machine is connected to the VPN. bool connected = 3; - // IPs of the machine connected to the vpn + // IPs of the machine connected to the vpn. repeated string ips = 4 [(buf.validate.field).repeated.(metalstack.api.v2.ips) = true]; } @@ -696,11 +688,11 @@ message MachineVPN { enum MachineLiveliness { // MACHINE_LIVELINESS_UNSPECIFIED is not defined. MACHINE_LIVELINESS_UNSPECIFIED = 0 [(enum_string_value) = ""]; - // MACHINE_LIVELINESS_ALIVE liveliness is alive + // MACHINE_LIVELINESS_ALIVE liveliness is alive. MACHINE_LIVELINESS_ALIVE = 1 [(enum_string_value) = "alive"]; - // MACHINE_LIVELINESS_DEAD liveliness is dead + // MACHINE_LIVELINESS_DEAD liveliness is dead. MACHINE_LIVELINESS_DEAD = 2 [(enum_string_value) = "dead"]; - // MACHINE_LIVELINESS_UNKNOWN liveliness is unknown + // MACHINE_LIVELINESS_UNKNOWN liveliness is unknown. MACHINE_LIVELINESS_UNKNOWN = 3 [(enum_string_value) = "unknown"]; } @@ -726,53 +718,53 @@ enum MachineBMCCommand { MACHINE_BMC_COMMAND_RESET = 3 [(enum_string_value) = "reset"]; // MACHINE_BMC_COMMAND_CYCLE Power cycle the machine. MACHINE_BMC_COMMAND_CYCLE = 4 [(enum_string_value) = "cycle"]; - // MACHINE_BMC_COMMAND_BOOT_TO_BIOS boot the machine into bios + // MACHINE_BMC_COMMAND_BOOT_TO_BIOS boot the machine into bios. MACHINE_BMC_COMMAND_BOOT_TO_BIOS = 5 [(enum_string_value) = "boot-to-bios"]; - // MACHINE_BMC_COMMAND_BOOT_FROM_DISK boot the machine from hard disk + // MACHINE_BMC_COMMAND_BOOT_FROM_DISK boot the machine from hard disk. MACHINE_BMC_COMMAND_BOOT_FROM_DISK = 6 [(enum_string_value) = "boot-from-disk"]; - // MACHINE_BMC_COMMAND_BOOT_FROM_PXE boot the machine from pxe + // MACHINE_BMC_COMMAND_BOOT_FROM_PXE boot the machine from pxe. MACHINE_BMC_COMMAND_BOOT_FROM_PXE = 7 [(enum_string_value) = "boot-from-pxe"]; - // MACHINE_BMC_COMMAND_IDENTIFY_LED_ON set identify led of the machine chassis to on + // MACHINE_BMC_COMMAND_IDENTIFY_LED_ON set identify led of the machine chassis to on. MACHINE_BMC_COMMAND_IDENTIFY_LED_ON = 8 [(enum_string_value) = "identify-led-on"]; - // MACHINE_BMC_COMMAND_IDENTIFY_LED_OFF set identify led of the machine chassis to off + // MACHINE_BMC_COMMAND_IDENTIFY_LED_OFF set identify led of the machine chassis to off. MACHINE_BMC_COMMAND_IDENTIFY_LED_OFF = 9 [(enum_string_value) = "identify-led-off"]; - // MACHINE_BMC_COMMAND_MACHINE_DELETED should be called if the machine was deleted to power cycle and boot into pxe + // MACHINE_BMC_COMMAND_MACHINE_DELETED should be called if the machine was deleted to power cycle and boot into pxe. MACHINE_BMC_COMMAND_MACHINE_DELETED = 10 [(enum_string_value) = "machine-deleted"]; - // MACHINE_BMC_COMMAND_MACHINE_CREATED should be called if the machine was created to set the boot order to boot from disk + // MACHINE_BMC_COMMAND_MACHINE_CREATED should be called if the machine was created to set the boot order to boot from disk. MACHINE_BMC_COMMAND_MACHINE_CREATED = 11 [(enum_string_value) = "machine-created"]; } // MachineQuery contains fields which can be specified to list specific machines. message MachineQuery { - // UUID of the machine to get + // UUID of the machine to get. optional string uuid = 1 [(buf.validate.field).string.uuid = true]; - // Name of the machine to get + // Name of the machine to get. optional string name = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Partition of the machine to get + // Partition of the machine to get. optional string partition = 3 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; - // Size of the machine to get + // Size of the machine to get. optional string size = 4 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Rack of the machine to get + // Rack of the machine to get. optional string rack = 5 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Room of the machine to get + // Room of the machine to get. optional string room = 6 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Labels for which this machine should get filtered + // Labels for which this machine should get filtered. optional Labels labels = 7; - // Allocation specific machine queries + // Allocation specific machine queries. optional MachineAllocationQuery allocation = 8; - // Network specific machine queries + // Network specific machine queries. optional MachineNetworkQuery network = 9; - // Nic specific machine queries + // Nic specific machine queries. optional MachineNicQuery nic = 10; - // Disk specific machine queries + // Disk specific machine queries. optional MachineDiskQuery disk = 11; - // Bmc specific machine queries + // Bmc specific machine queries. optional MachineBMCQuery bmc = 12; - // Fru specific machine queries + // Fru specific machine queries. optional MachineFRUQuery fru = 13; - // Hardware specific machine query + // Hardware specific machine query. optional MachineHardwareQuery hardware = 14; - // State this machine has + // State this machine has. optional MachineState state = 15; // Waiting if set to true, only waiting machines are returned. // Only useful for admins. @@ -785,47 +777,47 @@ message MachineQuery { optional bool not_allocated = 18; } -// MachineAllocationQuery allocation specific query parameters +// MachineAllocationQuery allocation specific query parameters. message MachineAllocationQuery { - // UUID of the allocation of the machine to get + // UUID of the allocation of the machine to get. optional string uuid = 1 [(buf.validate.field).string.uuid = true]; - // Name of the machine to get + // Name of the machine to get. optional string name = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Project of the machine to get + // Project of the machine to get. optional string project = 3 [(buf.validate.field).string.uuid = true]; - // Image of the machine to get + // Image of the machine to get. optional string image = 4 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // FilesystemLayout of the machine to get + // FilesystemLayout of the machine to get. optional string filesystem_layout = 5 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Hostname of the machine to get + // Hostname of the machine to get. optional string hostname = 6 [(buf.validate.field).string.hostname = true]; - // AllocationType of this machine + // AllocationType of this machine. optional MachineAllocationType allocation_type = 7 [(buf.validate.field).enum.defined_only = true]; - // Labels for which this machine allocation should get filtered + // Labels for which this machine allocation should get filtered. optional Labels labels = 8; - // VPN query if this machine has a vpn configuration + // VPN query if this machine has a vpn configuration. optional MachineVPN vpn = 9; } -// MachineNetworkQuery network specific machine queries +// MachineNetworkQuery network specific machine queries. message MachineNetworkQuery { - // Networks this machine is connected to + // Networks this machine is connected to. repeated string networks = 1; - // Prefixes this machine is connected to + // Prefixes this machine is connected to. repeated string prefixes = 2 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; - // DestinationPrefixes this machine is connected to + // DestinationPrefixes this machine is connected to. repeated string destination_prefixes = 3 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; - // IPs this machine has + // IPs this machine has. repeated string ips = 4 [(buf.validate.field).repeated.(metalstack.api.v2.ips) = true]; - // VRFs this machine is connected to + // VRFs this machine is connected to. repeated uint64 vrfs = 5; - // ASNs this machine is connected to + // ASNs this machine is connected to. repeated uint32 asns = 6; } -// MachineNicQuery nic specific machine queries +// MachineNicQuery nic specific machine queries. message MachineNicQuery { - // Macs this machine nic has + // Macs this machine nic has. repeated string macs = 1 [(buf.validate.field).repeated = { max_items: 100 unique: true @@ -833,7 +825,7 @@ message MachineNicQuery { string: {[metalstack.api.v2.macaddress]: true} } }]; - // Names this machine nic has + // Names this machine nic has. repeated string names = 2 [(buf.validate.field).repeated = { max_items: 100 unique: true @@ -841,7 +833,7 @@ message MachineNicQuery { string: {max_len: 128} } }]; - // NeighborMacs this machine nic has + // NeighborMacs this machine nic has. repeated string neighbor_macs = 3 [(buf.validate.field).repeated = { max_items: 100 unique: true @@ -849,7 +841,7 @@ message MachineNicQuery { string: {[metalstack.api.v2.macaddress]: true} } }]; - // NeighborNames this machine nic has + // NeighborNames this machine nic has. repeated string neighbor_names = 4 [(buf.validate.field).repeated = { max_items: 100 unique: true @@ -859,64 +851,64 @@ message MachineNicQuery { }]; } -// MachineDiskQuery disk specific machine queries +// MachineDiskQuery disk specific machine queries. message MachineDiskQuery { - // Names of disks in this machine + // Names of disks in this machine. repeated string names = 1 [(buf.validate.field).repeated = { max_items: 100 items: { string: {max_len: 128} } }]; - // Sizes of disks in this machine + // Sizes of disks in this machine. repeated uint64 sizes = 2 [(buf.validate.field).repeated = {max_items: 100}]; } -// MachineBMCQuery machine ipmi or bmc specific machine queries +// MachineBMCQuery machine ipmi or bmc specific machine queries. message MachineBMCQuery { - // Address of the ipmi system of this machine + // Address of the ipmi system of this machine. optional string address = 1 [(buf.validate.field).string.ip = true]; - // Mac of the ipmi system of this machine + // Mac of the ipmi system of this machine. optional string mac = 2 [(buf.validate.field).string.(macaddress) = true]; - // User of the ipmi system of this machine + // User of the ipmi system of this machine. optional string user = 3 [(buf.validate.field).string = {max_len: 128}]; - // Interface of the ipmi system of this machine + // Interface of the ipmi system of this machine. optional string interface = 4 [(buf.validate.field).string = {max_len: 128}]; } -// MachineFRUQuery machine fru specific machine queries +// MachineFRUQuery machine fru specific machine queries. message MachineFRUQuery { - // ChassisPartNumber of this machine + // ChassisPartNumber of this machine. optional string chassis_part_number = 1 [(buf.validate.field).string = {max_len: 128}]; - // ChassisPartSerial of this machine + // ChassisPartSerial of this machine. optional string chassis_part_serial = 2 [(buf.validate.field).string = {max_len: 128}]; - // BoardMFG of this machine + // BoardMFG of this machine. optional string board_mfg = 3 [(buf.validate.field).string = {max_len: 128}]; - // BoardSerial of this machine + // BoardSerial of this machine. optional string board_serial = 4 [(buf.validate.field).string = {max_len: 128}]; - // BoardPartNumber of this machine + // BoardPartNumber of this machine. optional string board_part_number = 5 [(buf.validate.field).string = {max_len: 128}]; - // ProductManufacturer of this machine + // ProductManufacturer of this machine. optional string product_manufacturer = 6 [(buf.validate.field).string = {max_len: 128}]; - // ProductPartNumber of this machine + // ProductPartNumber of this machine. optional string product_part_number = 7 [(buf.validate.field).string = {max_len: 128}]; - // ProductSerial of this machine + // ProductSerial of this machine. optional string product_serial = 8 [(buf.validate.field).string = {max_len: 128}]; } -// MachineHardwareQuery machine hardware specific machine queries +// MachineHardwareQuery machine hardware specific machine queries. message MachineHardwareQuery { - // Memory the total memory of the machine in bytes + // Memory the total memory of the machine in bytes. optional uint64 memory = 1; - // CPUCores the number of cpu cores + // CPUCores the number of cpu cores. optional uint32 cpu_cores = 2; } -// Issues related +// Issues related. // MachineIssuesQuery defines which machine issues should be listed. message MachineIssuesQuery { - // MachineQuery to select specific machines + // MachineQuery to select specific machines. metalstack.api.v2.MachineQuery machine_query = 1; // Only includes the specified machine issue types. repeated MachineIssueType only = 2 [(buf.validate.field).repeated = { @@ -924,7 +916,7 @@ message MachineIssuesQuery { enum: {defined_only: true} } }]; - // Omits the specified machine issues + // Omits the specified machine issues. repeated MachineIssueType omit = 3 [(buf.validate.field).repeated = { items: { enum: {defined_only: true} @@ -938,15 +930,15 @@ message MachineIssuesQuery { // MachineIssues is a list of issues for a machine. message MachineIssues { - // UUID of the machine for which the issues are listed + // UUID of the machine for which the issues are listed. string uuid = 1 [(buf.validate.field).string.uuid = true]; - // Issues of this machine + // Issues of this machine. repeated MachineIssue issues = 2; } // MachineIssue contains details of one issue. message MachineIssue { - // Type specifies the issue type (id) + // Type specifies the issue type (id). MachineIssueType type = 1 [(buf.validate.field).enum.defined_only = true]; // Severity specifies the severity of an issue. MachineIssueSeverity severity = 2 [(buf.validate.field).enum.defined_only = true]; @@ -960,44 +952,44 @@ message MachineIssue { // MachineIssueType defines which type of issue it is. enum MachineIssueType { - // MACHINE_ISSUE_TYPE_UNSPECIFIED type is not specified + // MACHINE_ISSUE_TYPE_UNSPECIFIED type is not specified. MACHINE_ISSUE_TYPE_UNSPECIFIED = 0; - // MACHINE_ISSUE_TYPE_ASN_UNIQUENESS machine asn is not unique + // MACHINE_ISSUE_TYPE_ASN_UNIQUENESS machine asn is not unique. MACHINE_ISSUE_TYPE_ASN_UNIQUENESS = 1 [(enum_string_value) = "asn-not-unique"]; - // MACHINE_ISSUE_TYPE_BMC_INFO_OUTDATED machine bmc info out of date + // MACHINE_ISSUE_TYPE_BMC_INFO_OUTDATED machine bmc info out of date. MACHINE_ISSUE_TYPE_BMC_INFO_OUTDATED = 2 [(enum_string_value) = "bmc-info-outdated"]; - // MACHINE_ISSUE_TYPE_BMC_NON_DISTINCT_IP machine bmc ip is not distinct + // MACHINE_ISSUE_TYPE_BMC_NON_DISTINCT_IP machine bmc ip is not distinct. MACHINE_ISSUE_TYPE_BMC_NON_DISTINCT_IP = 3 [(enum_string_value) = "bmc-no-distinct-ip"]; - // MACHINE_ISSUE_TYPE_BMC_WITHOUT_IP machine bmc without ip + // MACHINE_ISSUE_TYPE_BMC_WITHOUT_IP machine bmc without ip. MACHINE_ISSUE_TYPE_BMC_WITHOUT_IP = 4 [(enum_string_value) = "bmc-without-ip"]; - // MACHINE_ISSUE_TYPE_BMC_WITHOUT_MAC machine bmc without mac address + // MACHINE_ISSUE_TYPE_BMC_WITHOUT_MAC machine bmc without mac address. MACHINE_ISSUE_TYPE_BMC_WITHOUT_MAC = 5 [(enum_string_value) = "bmc-without-mac"]; - // MACHINE_ISSUE_TYPE_CRASH_LOOP machine is in crashloop + // MACHINE_ISSUE_TYPE_CRASH_LOOP machine is in crashloop. MACHINE_ISSUE_TYPE_CRASH_LOOP = 6 [(enum_string_value) = "crashloop"]; - // MACHINE_ISSUE_TYPE_FAILED_MACHINE_RECLAIM machine was not freed after delete + // MACHINE_ISSUE_TYPE_FAILED_MACHINE_RECLAIM machine was not freed after delete. MACHINE_ISSUE_TYPE_FAILED_MACHINE_RECLAIM = 7 [(enum_string_value) = "failed-machine-reclaim"]; - // MACHINE_ISSUE_TYPE_LAST_EVENT_ERROR machine last event error + // MACHINE_ISSUE_TYPE_LAST_EVENT_ERROR machine last event error. MACHINE_ISSUE_TYPE_LAST_EVENT_ERROR = 8 [(enum_string_value) = "last-event-error"]; - // MACHINE_ISSUE_TYPE_LIVELINESS_DEAD machine is dead + // MACHINE_ISSUE_TYPE_LIVELINESS_DEAD machine is dead. MACHINE_ISSUE_TYPE_LIVELINESS_DEAD = 9 [(enum_string_value) = "liveliness-dead"]; - // MACHINE_ISSUE_TYPE_LIVELINESS_NOT_AVAILABLE machine liveliness is not available + // MACHINE_ISSUE_TYPE_LIVELINESS_NOT_AVAILABLE machine liveliness is not available. MACHINE_ISSUE_TYPE_LIVELINESS_NOT_AVAILABLE = 10 [(enum_string_value) = "liveliness-not-available"]; - // MACHINE_ISSUE_TYPE_LIVELINESS_UNKNOWN machine liveliness is unknown + // MACHINE_ISSUE_TYPE_LIVELINESS_UNKNOWN machine liveliness is unknown. MACHINE_ISSUE_TYPE_LIVELINESS_UNKNOWN = 11 [(enum_string_value) = "liveliness-unknown"]; - // MACHINE_ISSUE_TYPE_NO_EVENT_CONTAINER machine does not have a event container + // MACHINE_ISSUE_TYPE_NO_EVENT_CONTAINER machine does not have a event container. MACHINE_ISSUE_TYPE_NO_EVENT_CONTAINER = 12 [(enum_string_value) = "no-event-container"]; - // MACHINE_ISSUE_TYPE_NO_PARTITION no partition set + // MACHINE_ISSUE_TYPE_NO_PARTITION no partition set. MACHINE_ISSUE_TYPE_NO_PARTITION = 13 [(enum_string_value) = "no-partition"]; } // MachineIssueSeverity defines the severity of an issue. enum MachineIssueSeverity { - // MACHINE_ISSUE_SEVERITY_UNSPECIFIED severity is not specified + // MACHINE_ISSUE_SEVERITY_UNSPECIFIED severity is not specified. MACHINE_ISSUE_SEVERITY_UNSPECIFIED = 0; - // MACHINE_ISSUE_SEVERITY_MINOR machine issues is of severity minor + // MACHINE_ISSUE_SEVERITY_MINOR machine issues is of severity minor. MACHINE_ISSUE_SEVERITY_MINOR = 1 [(enum_string_value) = "minor"]; - // MACHINE_ISSUE_SEVERITY_MAJOR machine issues is of severity major + // MACHINE_ISSUE_SEVERITY_MAJOR machine issues is of severity major. MACHINE_ISSUE_SEVERITY_MAJOR = 2 [(enum_string_value) = "major"]; - // MACHINE_ISSUE_SEVERITY_CRITICAL machine issues is of severity critical + // MACHINE_ISSUE_SEVERITY_CRITICAL machine issues is of severity critical. MACHINE_ISSUE_SEVERITY_CRITICAL = 3 [(enum_string_value) = "critical"]; } diff --git a/proto/metalstack/api/v2/network.proto b/proto/metalstack/api/v2/network.proto index a33a83dc..80edf6b8 100644 --- a/proto/metalstack/api/v2/network.proto +++ b/proto/metalstack/api/v2/network.proto @@ -49,74 +49,74 @@ service NetworkService { } } -// NetworkServiceGetRequest +// NetworkServiceGetRequest. message NetworkServiceGetRequest { - // ID of the network to get + // ID of the network to get. string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Project of the network + // Project of the network. string project = 2 [ (buf.validate.field).ignore = IGNORE_IF_ZERO_VALUE, (buf.validate.field).string.uuid = true ]; } -// NetworkServiceGetResponse +// NetworkServiceGetResponse. message NetworkServiceGetResponse { - // Network which was requested to get + // Network which was requested to get. Network network = 1; } -// NetworkServiceCreateRequest +// NetworkServiceCreateRequest. message NetworkServiceCreateRequest { // Project where this network belongs to. string project = 1 [(buf.validate.field).string.uuid = true]; - // Name of this network + // Name of this network. optional string name = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Description of this network + // Description of this network. optional string description = 3 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; // Partition where this network will be created. optional string partition = 4 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; - // Labels on this network + // Labels on this network. Labels labels = 5; // Parent Network points to the id of the parent network if any. optional string parent_network = 6 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Length per addressfamily + // Length per addressfamily. optional ChildPrefixLength length = 7; - // AddressFamily to create, defaults to the same as the parent + // AddressFamily to create, defaults to the same as the parent. optional NetworkAddressFamily address_family = 8 [(buf.validate.field).enum.defined_only = true]; } -// NetworkServiceCreateResponse +// NetworkServiceCreateResponse. message NetworkServiceCreateResponse { // Network is the created network. Network network = 1; } -// NetworkServiceUpdateRequest +// NetworkServiceUpdateRequest. message NetworkServiceUpdateRequest { - // ID of the network to get + // ID of the network to get. string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // UpdateMeta contains the timestamp and strategy to be used in this update request. UpdateMeta update_meta = 2 [(buf.validate.field).required = true]; - // Project of the network + // Project of the network. string project = 3 [(buf.validate.field).string.uuid = true]; - // Name of this network + // Name of this network. optional string name = 4 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Description of this network + // Description of this network. optional string description = 5 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Labels on this network + // Labels on this network. optional UpdateLabels labels = 6; } -// NetworkServiceUpdateResponse +// NetworkServiceUpdateResponse. message NetworkServiceUpdateResponse { // Network is the updated network. Network network = 1; } -// NetworkServiceListRequest +// NetworkServiceListRequest. message NetworkServiceListRequest { - // Project of the networks to list + // Project of the networks to list. string project = 1 [ (buf.validate.field).ignore = IGNORE_IF_ZERO_VALUE, (buf.validate.field).string.uuid = true @@ -125,15 +125,15 @@ message NetworkServiceListRequest { NetworkQuery query = 2; } -// NetworkServiceListResponse +// NetworkServiceListResponse. message NetworkServiceListResponse { // Networks are the requested networks. repeated Network networks = 1; } -// NetworkServiceListRequest +// NetworkServiceListRequest. message NetworkServiceListBaseNetworksRequest { - // Project of the base networks to list + // Project of the base networks to list. string project = 1 [ (buf.validate.field).ignore = IGNORE_IF_ZERO_VALUE, (buf.validate.field).string.uuid = true @@ -142,54 +142,54 @@ message NetworkServiceListBaseNetworksRequest { NetworkQuery query = 2; } -// NetworkServiceListResponse +// NetworkServiceListResponse. message NetworkServiceListBaseNetworksResponse { // Networks are the requested networks. repeated Network networks = 1; } -// NetworkServiceDeleteRequest +// NetworkServiceDeleteRequest. message NetworkServiceDeleteRequest { - // ID of the network to get + // ID of the network to get. string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Project of the network + // Project of the network. string project = 2 [(buf.validate.field).string.uuid = true]; } -// NetworkServiceDeleteResponse +// NetworkServiceDeleteResponse. message NetworkServiceDeleteResponse { // Network is the deleted network. Network network = 1; } -// Network +// Network. message Network { - // Id of this network + // Id of this network. string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Meta for this network + // Meta for this network. Meta meta = 2; - // Name of this network + // Name of this network. optional string name = 3 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Description of this network + // Description of this network. optional string description = 4 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; // Partition where this network will be created. optional string partition = 5 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; // Project where this network belongs to. optional string project = 6 [(buf.validate.field).string.uuid = true]; // Namespace if specified, this network is namespaced and can therefore overlap with others. - // Will be equal with project most of the time + // Will be equal with project most of the time. optional string namespace = 7 [(buf.validate.field).string.uuid = true]; - // Prefixes in this network + // Prefixes in this network. repeated string prefixes = 8 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; - // Destination Prefixes in this network + // Destination Prefixes in this network. repeated string destination_prefixes = 9 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; // Default Child Prefix length defines the bit length of a child network created per address family, if not specified during the allocate request. ChildPrefixLength default_child_prefix_length = 10; // Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length. ChildPrefixLength min_child_prefix_length = 11; - // Type of the network + // Type of the network. NetworkType type = 12 [(buf.validate.field).enum.defined_only = true]; - // NATType of this network + // NATType of this network. NATType nat_type = 13 [(buf.validate.field).enum.defined_only = true]; // VRF of this network has this VNI. optional uint32 vrf = 14; @@ -197,17 +197,17 @@ message Network { optional string parent_network = 15 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced. repeated string additional_announcable_cidrs = 16 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; - // Consumption of IPs and prefixes in this network + // Consumption of IPs and prefixes in this network. NetworkConsumption consumption = 17; } // NetworkQuery defines which networks to query. message NetworkQuery { - // Id of the network to query + // Id of the network to query. optional string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Name of this network + // Name of this network. optional string name = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Description of this network + // Description of this network. optional string description = 3 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; // Partition where this network will be created. optional string partition = 4 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; @@ -215,32 +215,32 @@ message NetworkQuery { optional string project = 5 [(buf.validate.field).string.uuid = true]; // Namespace where this network belongs to. optional string namespace = 6 [(buf.validate.field).string.uuid = true]; - // Prefixes in this network + // Prefixes in this network. repeated string prefixes = 7 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; - // Destination Prefixes in this network + // Destination Prefixes in this network. repeated string destination_prefixes = 8 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; // VRF of this network has this VNI. optional uint32 vrf = 9; // Parent Network points to the id of the parent network if any. optional string parent_network = 10 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Addressfamily to query + // Addressfamily to query. optional NetworkAddressFamily address_family = 11 [(buf.validate.field).enum.defined_only = true]; - // Type of the network to query for + // Type of the network to query for. optional NetworkType type = 12 [(buf.validate.field).enum.defined_only = true]; - // NATType configured + // NATType configured. optional NATType nat_type = 13 [(buf.validate.field).enum.defined_only = true]; - // Labels on this network + // Labels on this network. optional Labels labels = 14; } -// ChildPrefixLength +// ChildPrefixLength. message ChildPrefixLength { - // IPv4 bit length of this network in this addressfamily + // IPv4 bit length of this network in this addressfamily. optional uint32 ipv4 = 1 [(buf.validate.field).uint32 = { gt: 0 lte: 32 }]; - // IPv6 bit length of this network in this addressfamily + // IPv6 bit length of this network in this addressfamily. optional uint32 ipv6 = 2 [(buf.validate.field).uint32 = { gt: 0 lte: 128 @@ -249,7 +249,7 @@ message ChildPrefixLength { // NetworkConsumption contains ip and prefix usage by addressfamily. message NetworkConsumption { - // IPv4 network usage + // IPv4 network usage. NetworkUsage ipv4 = 1; // IPv6 network usage, this can be approximated for high numbers. NetworkUsage ipv6 = 2; @@ -257,13 +257,13 @@ message NetworkConsumption { // NetworkUsage reports core metrics about available and used IPs or Prefixes in a Network. message NetworkUsage { - // the total available IPs + // the total available IPs. uint64 available_ips = 1; - // the total used IPs + // the total used IPs. uint64 used_ips = 2; - // the total available 2-bit prefixes + // the total available 2-bit prefixes. uint64 available_prefixes = 3; - // the total used Prefixes + // the total used Prefixes. uint64 used_prefixes = 4; } @@ -273,7 +273,7 @@ enum NATType { NAT_TYPE_UNSPECIFIED = 0; // NAT_TYPE_NONE indicates that no nat is configured. NAT_TYPE_NONE = 1 [(enum_string_value) = "none"]; - // NAT_TYPE_IPV4_MASQUERADE masquerade ipv4 behind gateway ip when traffic enters this network + // NAT_TYPE_IPV4_MASQUERADE masquerade ipv4 behind gateway ip when traffic enters this network. NAT_TYPE_IPV4_MASQUERADE = 2 [(enum_string_value) = "ipv4-masq"]; } @@ -286,7 +286,7 @@ enum NetworkType { // If it is not project scoped everyone can allocate Ips in this network, otherwise only from the same project ip allocation is possible. NETWORK_TYPE_EXTERNAL = 1 [(enum_string_value) = "external"]; // NETWORK_TYPE_UNDERLAY indicates a underlay network. - // The underlay network connects all switches and the firewalls to build a EVPN dataplane + // The underlay network connects all switches and the firewalls to build a EVPN dataplane. // It is not project scoped. Is part of the dataplane and reserved for administrative purposes. NETWORK_TYPE_UNDERLAY = 2 [(enum_string_value) = "underlay"]; diff --git a/proto/metalstack/api/v2/partition.proto b/proto/metalstack/api/v2/partition.proto index 7dc5534a..de9307e2 100644 --- a/proto/metalstack/api/v2/partition.proto +++ b/proto/metalstack/api/v2/partition.proto @@ -22,26 +22,26 @@ service PartitionService { // Partition is a failure domain with machines and switches. message Partition { - // ID of this partition + // ID of this partition. string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; - // Meta for this partition + // Meta for this partition. Meta meta = 2; - // Description of this partition + // Description of this partition. string description = 3 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; // PartitionBootConfiguration defines how metal-hammer boots. PartitionBootConfiguration boot_configuration = 4; - // DNSServers for this partition + // DNSServers for this partition. repeated DNSServer dns_servers = 5 [(buf.validate.field).repeated.max_items = 3]; - // NTPServers for this partition + // NTPServers for this partition. repeated NTPServer ntp_servers = 6 [(buf.validate.field).repeated.max_items = 10]; // ManagementServiceAddresses defines where the management is reachable. - // should be in the form : + // should be in the form :. repeated string mgmt_service_addresses = 7 [(buf.validate.field).repeated.(metalstack.api.v2.are_host_and_port) = true]; } // PartitionQuery is used to search partitions. message PartitionQuery { - // ID of the partition to get + // ID of the partition to get. optional string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; // Labels lists only partitions containing the given labels. optional Labels labels = 2; @@ -49,29 +49,29 @@ message PartitionQuery { // PartitionBootConfiguration defines how metal-hammer boots. message PartitionBootConfiguration { - // ImageURL the url to download the initrd for the boot image + // ImageURL the url to download the initrd for the boot image. string image_url = 1 [(buf.validate.field).string.(metalstack.api.v2.is_uri) = true]; - // KernelURL the url to download the kernel for the boot image + // KernelURL the url to download the kernel for the boot image. string kernel_url = 2 [(buf.validate.field).string.(metalstack.api.v2.is_uri) = true]; - // Commandline the kernel command line for the boot image + // Commandline the kernel command line for the boot image. string commandline = 3 [(buf.validate.field).string.max_len = 4096]; } -// DNSServer +// DNSServer. message DNSServer { - // IP address of this dns server + // IP address of this dns server. string ip = 1 [(buf.validate.field).string.ip = true]; } -// NTPServer +// NTPServer. message NTPServer { - // Address either as ip or hostname + // Address either as ip or hostname. string address = 1 [(buf.validate.field).string.(metalstack.api.v2.is_ip_or_hostname) = true]; } // PartitionServiceGetRequest is the request payload for a partition get request. message PartitionServiceGetRequest { - // ID of the partition to get + // ID of the partition to get. string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; } diff --git a/proto/metalstack/api/v2/project.proto b/proto/metalstack/api/v2/project.proto index 8c9322c0..bdd425f1 100644 --- a/proto/metalstack/api/v2/project.proto +++ b/proto/metalstack/api/v2/project.proto @@ -80,7 +80,7 @@ service ProjectService { option (project_roles) = PROJECT_ROLE_OWNER; option (auditing) = AUDITING_EXCLUDED; } - // InviteGet get an invite + // InviteGet get an invite. rpc InviteGet(ProjectServiceInviteGetRequest) returns (ProjectServiceInviteGetResponse) { option (visibility) = VISIBILITY_SELF; option (auditing) = AUDITING_EXCLUDED; @@ -88,19 +88,19 @@ service ProjectService { } // Project defines a group of resources belonging to a tenant. -// a tenant can have multiple projects +// a tenant can have multiple projects. message Project { - // Uuid of this project + // Uuid of this project. string uuid = 1; - // Meta for this project + // Meta for this project. Meta meta = 2; - // Name of this project must be unique per tenant + // Name of this project must be unique per tenant. string name = 3 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Description of this project + // Description of this project. string description = 4 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Tenant this project belongs to + // Tenant this project belongs to. string tenant = 5; - // AvatarUrl of the Project + // AvatarUrl of the Project. optional string avatar_url = 6 [(buf.validate.field).string.(metalstack.api.v2.is_uri) = true]; } @@ -114,9 +114,9 @@ message ProjectMember { // This member does not have direct project membership but gains permissions on this project from the role he has in the tenant. // Inherited memberships are not included in member lists for users with guest permission but only for direct tenant members. bool inherited_membership = 3; - // CreatedAt the date when the member was added to the project + // CreatedAt the date when the member was added to the project. google.protobuf.Timestamp created_at = 4; - // Meta for this project member + // Meta for this project member. Meta meta = 5; } @@ -136,9 +136,9 @@ message ProjectInvite { string tenant = 6; // TenantName is the name of the tenant inviting another user to join this project. string tenant_name = 7; - // ExpiresAt the date when this invite expires + // ExpiresAt the date when this invite expires. google.protobuf.Timestamp expires_at = 8; - // JoinedAt the date when the member accepted this invite + // JoinedAt the date when the member accepted this invite. google.protobuf.Timestamp joined_at = 9; } @@ -176,22 +176,22 @@ message ProjectServiceGetRequest { message ProjectServiceGetResponse { // Project is the project. Project project = 1; - // ProjectMembers in this project, projects guests will only see direct project members and not implicit memberships from tenant permissions + // ProjectMembers in this project, projects guests will only see direct project members and not implicit memberships from tenant permissions. repeated ProjectMember project_members = 2; } // ProjectServiceCreateRequest is the request payload to Create a project. message ProjectServiceCreateRequest { // Login is the tenant of this project. - // TODO: is login really a good name? + // TODO: is login really a good name?. string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Name of this project, unique per tenant + // Name of this project, unique per tenant. string name = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Description of this project + // Description of this project. string description = 3 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Avatar URL of the project + // Avatar URL of the project. optional string avatar_url = 4 [(buf.validate.field).string.(metalstack.api.v2.is_uri) = true]; - // Labels on the project + // Labels on the project. Labels labels = 5; } @@ -219,13 +219,13 @@ message ProjectServiceUpdateRequest { string project = 1 [(buf.validate.field).string.uuid = true]; // UpdateMeta contains the timestamp and strategy to be used in this update request. UpdateMeta update_meta = 2 [(buf.validate.field).required = true]; - // Name of this project unique per tenant + // Name of this project unique per tenant. optional string name = 3 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Description of this project + // Description of this project. optional string description = 4 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Avatar URL of the project + // Avatar URL of the project. optional string avatar_url = 5 [(buf.validate.field).string.(metalstack.api.v2.is_uri) = true]; - // Labels on this project + // Labels on this project. optional UpdateLabels labels = 6; } @@ -240,15 +240,15 @@ message ProjectServiceInviteRequest { // Project is the uuid of the project. string project = 1 [(buf.validate.field).string.uuid = true]; - // Role of this user in this project + // Role of this user in this project. ProjectRole role = 2 [(buf.validate.field).enum.defined_only = true]; } // ProjectServiceInviteResponse is the response payload to a invite member request. message ProjectServiceInviteResponse { // Inviter contains a secret which can be sent to a potential user. - // can be appended to the invitation endpoint at our cloud console like - // console.metalstack.cloud/invite/ + // can be appended to the invitation endpoint at our cloud console like. + // console.metalstack.cloud/invite/= 20.04.20211011" -// debian: ">= 10.0.20210101" +// ubuntu: ">= 20.04.20211011 +// debian: ">= 10.0.20210101 message ImageConstraint { - // Image of the constraint + // Image of the constraint. string image = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // SemverMatch which defines in semver match format which image version should apply + // SemverMatch which defines in semver match format which image version should apply. string semver_match = 2 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; } // SizeImageConstraintQuery is used to search size image constraints. message SizeImageConstraintQuery { - // Size of the size image constraint + // Size of the size image constraint. optional string size = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Name of the size image constraint to query + // Name of the size image constraint to query. optional string name = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Description of the size image constraint to query + // Description of the size image constraint to query. optional string description = 3 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; } diff --git a/proto/metalstack/api/v2/size_reservation.proto b/proto/metalstack/api/v2/size_reservation.proto index c972d331..e990bb39 100644 --- a/proto/metalstack/api/v2/size_reservation.proto +++ b/proto/metalstack/api/v2/size_reservation.proto @@ -26,15 +26,15 @@ service SizeReservationService { // SizeReservationServiceGetRequest is the request payload for a size get request. message SizeReservationServiceGetRequest { - // ID of the size reservation to get + // ID of the size reservation to get. string id = 1 [(buf.validate.field).string.uuid = true]; - // Project of the size reservation + // Project of the size reservation. string project = 2 [(buf.validate.field).string.uuid = true]; } // SizeReservationServiceListRequest is the request payload for a size list request. message SizeReservationServiceListRequest { - // Project of the size reservation + // Project of the size reservation. string project = 1 [(buf.validate.field).string.uuid = true]; // Query for size reservations. SizeReservationQuery query = 2; @@ -42,56 +42,56 @@ message SizeReservationServiceListRequest { // SizeReservationServiceGetResponse is the response payload for a size reservation get request. message SizeReservationServiceGetResponse { - // Size reservation + // Size reservation. SizeReservation size_reservation = 1; } // SizeReservationServiceListResponse is the response payload for a size reservation list request. message SizeReservationServiceListResponse { - // Size reservations + // Size reservations. repeated SizeReservation size_reservations = 1; } -// SizeReservation +// SizeReservation. message SizeReservation { - // Id of this size reservation, is generated on creation + // Id of this size reservation, is generated on creation. string id = 1 [ (buf.validate.field).string.uuid = true, (buf.validate.field).ignore = IGNORE_IF_ZERO_VALUE ]; - // Meta for this size reservation + // Meta for this size reservation. Meta meta = 2; - // Name of this size reservation + // Name of this size reservation. string name = 3 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Description of this size reservation + // Description of this size reservation. string description = 4 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Project of the size reservation + // Project of the size reservation. string project = 5 [(buf.validate.field).string.uuid = true]; - // Size id of this size reservation + // Size id of this size reservation. string size = 6 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Partition ids of this size reservation + // Partition ids of this size reservation. repeated string partitions = 7 [ (buf.validate.field).repeated.min_items = 1, (buf.validate.field).repeated.unique = true, (buf.validate.field).repeated.items.string.(metalstack.api.v2.is_partition) = true ]; - // Amount of reservations of this size reservation + // Amount of reservations of this size reservation. int32 amount = 8 [(buf.validate.field).int32.gt = 0]; } // SizeReservationQuery is used to search size reservations. message SizeReservationQuery { - // ID of the size reservation to get + // ID of the size reservation to get. optional string id = 1 [(buf.validate.field).string.uuid = true]; - // Name of this size reservation + // Name of this size reservation. optional string name = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Description of this size reservation + // Description of this size reservation. optional string description = 3 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Size id of this size reservation + // Size id of this size reservation. optional string size = 4 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Project of the size reservation + // Project of the size reservation. optional string project = 5 [(buf.validate.field).string.uuid = true]; - // Partition of the size reservation + // Partition of the size reservation. optional string partition = 6 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; // Labels lists only size reservations containing the given labels. optional Labels labels = 7; diff --git a/proto/metalstack/api/v2/switch.proto b/proto/metalstack/api/v2/switch.proto index 9d7239a7..a8b09fb0 100644 --- a/proto/metalstack/api/v2/switch.proto +++ b/proto/metalstack/api/v2/switch.proto @@ -64,13 +64,13 @@ message SwitchOS { // SwitchNic represents a front panel port and its configuration. message SwitchNic { - // Name of the switch port + // Name of the switch port. string name = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Identifier of the port + // Identifier of the port. string identifier = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // MAC address of the port + // MAC address of the port. string mac = 3 [(buf.validate.field).string.(macaddress) = true]; - // VRF name if the port is bound in one + // VRF name if the port is bound in one. optional string vrf = 4 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // NicState describes the current state of the switch port. optional NicState state = 5; @@ -82,9 +82,9 @@ message SwitchNic { // BGPFilter can be used to restrict BGP based on CIDRs and VNIs. message BGPFilter { - // CIDRs for which to allow BGP + // CIDRs for which to allow BGP. repeated string cidrs = 1 [(buf.validate.field).repeated.(metalstack.api.v2.prefixes) = true]; - // VNIs for which to allow BGP + // VNIs for which to allow BGP. repeated string vnis = 2 [(buf.validate.field).repeated.items.string = { min_len: 2 max_len: 128 diff --git a/proto/metalstack/api/v2/tenant.proto b/proto/metalstack/api/v2/tenant.proto index 2c6ec3a8..35f325b9 100644 --- a/proto/metalstack/api/v2/tenant.proto +++ b/proto/metalstack/api/v2/tenant.proto @@ -58,7 +58,7 @@ service TenantService { option (auditing) = AUDITING_INCLUDED; } - // UpdateMember update a member of a tenant + // UpdateMember update a member of a tenant. rpc UpdateMember(TenantServiceUpdateMemberRequest) returns (TenantServiceUpdateMemberResponse) { option (tenant_roles) = TENANT_ROLE_OWNER; option (auditing) = AUDITING_INCLUDED; @@ -84,7 +84,7 @@ service TenantService { option (tenant_roles) = TENANT_ROLE_OWNER; option (auditing) = AUDITING_EXCLUDED; } - // InviteGet get an invite + // InviteGet get an invite. rpc InviteGet(TenantServiceInviteGetRequest) returns (TenantServiceInviteGetResponse) { option (visibility) = VISIBILITY_SELF; option (auditing) = AUDITING_EXCLUDED; @@ -93,19 +93,19 @@ service TenantService { // Tenant is a customer of the platform. message Tenant { - // Login of the tenant + // Login of the tenant. string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; - // Meta for this tenant + // Meta for this tenant. Meta meta = 2; - // Name of the tenant + // Name of the tenant. string name = 3 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Email of the tenant + // Email of the tenant. string email = 4 [(buf.validate.field).string.email = true]; - // Description of this tenant + // Description of this tenant. string description = 5 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // AvatarUrl of the tenant + // AvatarUrl of the tenant. string avatar_url = 6 [(buf.validate.field).string.(metalstack.api.v2.is_uri) = true]; - // CreatedBy stores who created this tenant + // CreatedBy stores who created this tenant. string created_by = 7; } @@ -115,11 +115,11 @@ message TenantMember { string id = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; // Role is the role of the member. TenantRole role = 2 [(buf.validate.field).enum.defined_only = true]; - // Projects in which a user is a direct member + // Projects in which a user is a direct member. repeated string projects = 3; - // CreatedAt the date when the member was added to the tenant + // CreatedAt the date when the member was added to the tenant. google.protobuf.Timestamp created_at = 4; - // Meta for this tenant member + // Meta for this tenant member. Meta meta = 5; } @@ -139,9 +139,9 @@ message TenantInvite { string tenant = 6; // TenantName is the name of the tenant inviting another user to join this tenant. string tenant_name = 7; - // ExpiresAt the date when this invite expires + // ExpiresAt the date when this invite expires. google.protobuf.Timestamp expires_at = 8; - // JoinedAt the date when the member accepted this invite + // JoinedAt the date when the member accepted this invite. google.protobuf.Timestamp joined_at = 9; } @@ -165,45 +165,45 @@ message TenantQuery { // TenantServiceGetRequest is the request payload of the tenant get request. message TenantServiceGetRequest { - // Login of the tenant + // Login of the tenant. string login = 1; } // TenantServiceCreateRequest is the request payload of the tenant create request. message TenantServiceCreateRequest { - // Name of this tenant + // Name of this tenant. string name = 1 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Description of this tenant + // Description of this tenant. optional string description = 2 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Email of the tenant, if not set will be inherited from the creator + // Email of the tenant, if not set will be inherited from the creator. optional string email = 3 [(buf.validate.field).string.email = true]; - // AvatarUrl of the tenant + // AvatarUrl of the tenant. optional string avatar_url = 4 [(buf.validate.field).string.(metalstack.api.v2.is_uri) = true]; - // Labels on the tenant + // Labels on the tenant. Labels labels = 5; } // TenantServiceUpdateRequest is the request payload of the tenant update request. message TenantServiceUpdateRequest { - // Login of the tenant + // Login of the tenant. string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; // UpdateMeta contains the timestamp and strategy to be used in this update request. UpdateMeta update_meta = 2 [(buf.validate.field).required = true]; - // Name of the tenant + // Name of the tenant. optional string name = 3 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Email of the tenant + // Email of the tenant. optional string email = 4 [(buf.validate.field).string.email = true]; - // Description of this tenant + // Description of this tenant. optional string description = 5 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // AvatarUrl of the tenant + // AvatarUrl of the tenant. optional string avatar_url = 6 [(buf.validate.field).string.(metalstack.api.v2.is_uri) = true]; - // Labels on the tenant + // Labels on the tenant. optional UpdateLabels labels = 7; } // TenantServiceDeleteRequest is the request payload of the tenant delete request. message TenantServiceDeleteRequest { - // Login of the tenant + // Login of the tenant. string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; } @@ -211,7 +211,7 @@ message TenantServiceDeleteRequest { message TenantServiceGetResponse { // Tenant is the tenant. Tenant tenant = 1; - // TenantMembers of this tenant + // TenantMembers of this tenant. repeated TenantMember tenant_members = 2; } @@ -241,35 +241,33 @@ message TenantServiceDeleteResponse { // TenantServiceInviteRequest is used to invite a member to a tenant. message TenantServiceInviteRequest { - // Login of the tenant + // Login of the tenant. string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; - // Role of this user in this tenant + // Role of this user in this tenant. TenantRole role = 2 [(buf.validate.field).enum.defined_only = true]; } // TenantServiceInviteRequest is the response payload to a invite member request. message TenantServiceInviteResponse { // Invite contains a secret which can be sent to a potential user. - // can be appended to the invitation endpoint at our cloud console like - // console.metalstack.cloud/invite/ TenantInvite invite = 1; } // TenantServiceInvitesListRequest is the request payload to a list invites request. message TenantServiceInvitesListRequest { - // Login of the tenant + // Login of the tenant. string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; } // TenantServiceInvitesListResponse is the response payload to a list invites request. message TenantServiceInvitesListResponse { - // Invites that have not yet accepted the invitation to this tenant + // Invites that have not yet accepted the invitation to this tenant. repeated TenantInvite invites = 1; } // TenantServiceInviteGetRequest is the request payload to get a invite. message TenantServiceInviteGetRequest { - // Secret of the invite to get + // Secret of the invite to get. string secret = 1; } @@ -281,7 +279,7 @@ message TenantServiceInviteGetResponse { // TenantServiceRemoveMemberRequest is used to remove a member from a tenant. message TenantServiceRemoveMemberRequest { - // Login of the tenant + // Login of the tenant. string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; // Member is the id of the member to remove from this tenant. string member = 2; @@ -289,7 +287,7 @@ message TenantServiceRemoveMemberRequest { // TenantServiceLeaveTenantRequest is used to leave a tenant. message TenantServiceLeaveRequest { - // Login of the tenant + // Login of the tenant. string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; } @@ -310,17 +308,17 @@ message TenantServiceInviteAcceptRequest { // TenantServiceInviteAcceptResponse is the response payload to a accept invite request. message TenantServiceInviteAcceptResponse { - // Tenant ID of the joined tenant + // Tenant ID of the joined tenant. string tenant = 1; - // TenantName of the joined tenant + // TenantName of the joined tenant. string tenant_name = 2; } // TenantServiceInviteDeleteRequest is the request payload to a delete invite. message TenantServiceInviteDeleteRequest { - // Login of the tenant + // Login of the tenant. string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; - // Secret of the invite to delete + // Secret of the invite to delete. string secret = 2; } @@ -329,11 +327,11 @@ message TenantServiceInviteDeleteResponse {} // TenantServiceAddMemberRequest is the request payload for adding a member to a tenant. message TenantServiceAddMemberRequest { - // Login of the tenant to which the member will be added + // Login of the tenant to which the member will be added. string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; - // Login of the member to add + // Login of the member to add. string member = 2 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; - // Role to assign to the new member + // Role to assign to the new member. TenantRole role = 3 [(buf.validate.field).enum.defined_only = true]; } @@ -345,11 +343,11 @@ message TenantServiceAddMemberResponse { // TenantServiceUpdateMemberRequest is used to update a member from a tenant. message TenantServiceUpdateMemberRequest { - // Login of the tenant + // Login of the tenant. string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; // Member is the id of the member to update in this tenant. string member = 2 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; - // Role of this user in this tenant + // Role of this user in this tenant. TenantRole role = 3 [(buf.validate.field).enum.defined_only = true]; } diff --git a/proto/metalstack/api/v2/token.proto b/proto/metalstack/api/v2/token.proto index b893f66a..950f2a28 100644 --- a/proto/metalstack/api/v2/token.proto +++ b/proto/metalstack/api/v2/token.proto @@ -55,13 +55,13 @@ service TokenService { // The api token should be used to authenticate services. // In contrast to a user token, the api token permissions and roles apply as configured during the token create process. message Token { - // Message level validation, can be developed using https://protovalidate.com/playground + // Message level validation, can be developed using https://protovalidate.com/playground. - // Uuid of the jwt token, used to reference it by revoke + // Uuid of the jwt token, used to reference it by revoke. string uuid = 1 [(buf.validate.field).string.uuid = true]; - // User who created this token + // User who created this token. string user = 2 [(buf.validate.field).string.(metalstack.api.v2.is_user) = true]; - // Meta for this token + // Meta for this token. Meta meta = 3; // Description is a user given description of this token. string description = 4 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; @@ -116,7 +116,7 @@ enum TokenType { // TokenServiceCreateRequest is the request payload to create a token. message TokenServiceCreateRequest { - // Description of the token + // Description of the token. string description = 1 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; // Permissions is a list of service methods this token can be used for. repeated PermissionsByVisibility permissions = 2 [(buf.validate.field).repeated.max_items = 100]; @@ -154,20 +154,19 @@ message TokenServiceCreateRequest { }, (buf.validate.field).map.(metalstack.api.v2.keys_trimmed) = true ]; - // Labels on this token + // Labels on this token. Labels labels = 9; } // MethodPermission is a mapping from a subject/project to a service method. message MethodPermission { - // Subject maybe either the project or the tenant - // for which the methods should be allowed + // Subject may be either the project or the tenant for which the methods should be allowed. // - // asterisk (*) can be specified to match any subject - // empty string ("") can be specified for requests that do not require a subject, e.g. partition list - // otherwise either a projectid or a tenant login should be specified + // Asterisk (*) can be specified to match any subject. + // Empty string ("") can be specified for requests that do not require a subject, e.g. partition list. + // Otherwise either a projectid or a tenant login should be specified. string subject = 1 [(buf.validate.field).string = {max_len: 256}]; - // Methods which should be accessible + // Methods which should be accessible. repeated string methods = 2 [(buf.validate.field).repeated.max_items = 500]; } @@ -194,58 +193,59 @@ message PermissionsByVisibility { // PublicPermissions carries public method permissions. message PublicPermissions { - // Methods which should be accessible + // Methods which should be accessible. repeated string methods = 2 [(buf.validate.field).repeated.max_items = 500]; } // SelfPermissions carries self method permissions. message SelfPermissions { - // Methods which should be accessible + // Methods which should be accessible. repeated string methods = 2 [(buf.validate.field).repeated.max_items = 500]; } // ProjectPermissions carries project method permissions. message ProjectPermissions { - // asterisk (*) can be specified to match any subject + // Project scope for the permissions. + // Asterisk (*) can be specified to match any subject. string project = 1 [(buf.validate.field).string.(metalstack.api.v2.is_project_subject_permission) = true]; - // Methods which should be accessible + // Methods which should be accessible. repeated string methods = 2 [(buf.validate.field).repeated.max_items = 500]; } // TenantPermissions carries tenant method permissions. message TenantPermissions { - // Login of the tenant - // asterisk (*) can be specified to match any subject + // Login of the tenant. + // Asterisk (*) can be specified to match any subject. string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_subject_permission) = true]; - // Methods which should be accessible + // Methods which should be accessible. repeated string methods = 2 [(buf.validate.field).repeated.max_items = 500]; } // AdminPermissions carries admin method permissions. message AdminPermissions { - // Methods which should be accessible + // Methods which should be accessible. repeated string methods = 2 [(buf.validate.field).repeated.max_items = 500]; } // MachinePermissions carries machine method permissions. message MachinePermissions { - // UUID of this machine - // asterisk (*) can be specified to match any subject + // UUID of this machine. + // Asterisk (*) can be specified to match any subject. string uuid = 1 [(buf.validate.field).string.(metalstack.api.v2.is_machine_subject_permission) = true]; - // Methods which should be accessible + // Methods which should be accessible. repeated string methods = 2 [(buf.validate.field).repeated.max_items = 500]; } // InfraPermissions carries infra method permissions. message InfraPermissions { - // Methods which should be accessible + // Methods which should be accessible. repeated string methods = 2 [(buf.validate.field).repeated.max_items = 500]; } // TokenServiceCreateResponse is the response payload of a token create request. message TokenServiceCreateResponse { - // Token which was created + // Token which was created. Token token = 1; // Secret is the body of the JWT token, should be used in API requests as bearer token. string secret = 2; @@ -265,7 +265,7 @@ message TokenServiceListResponse { // TokenServiceRevokeRequest is the request payload of a token revoke request. message TokenServiceRevokeRequest { - // Uuid of the token to revoke + // Uuid of the token to revoke. string uuid = 1 [(buf.validate.field).string.uuid = true]; } @@ -274,7 +274,7 @@ message TokenServiceRevokeResponse {} // TokenServiceUpdateRequest is the request payload of a token update request. message TokenServiceUpdateRequest { - // Uuid of the token to update + // Uuid of the token to update. string uuid = 1 [(buf.validate.field).string.uuid = true]; // UpdateMeta contains the timestamp and strategy to be used in this update request. // TokenUpdate is not guarded with optlock in the backend. @@ -311,7 +311,7 @@ message TokenServiceUpdateRequest { }, (buf.validate.field).map.(metalstack.api.v2.keys_trimmed) = true ]; - // Labels on this token + // Labels on this token. UpdateLabels labels = 10; } @@ -323,7 +323,7 @@ message TokenServiceUpdateResponse { // TokenServiceGetRequest is the request payload of a token get request. message TokenServiceGetRequest { - // Uuid of the token to get + // Uuid of the token to get. string uuid = 1 [(buf.validate.field).string.uuid = true]; } @@ -335,12 +335,12 @@ message TokenServiceGetResponse { // TokenServiceRefreshRequest is the request payload of a token refresh request. // Permissions, Roles and Expiration duration and all other properties are inherited from the calling token. -// The expiration duration will be calculated from the existing token (exp - iat) +// The expiration duration will be calculated from the existing token (exp - iat). message TokenServiceRefreshRequest {} // TokenServiceRefreshResponse is the response payload of a token refresh request. message TokenServiceRefreshResponse { - // Token which was refreshed + // Token which was refreshed. Token token = 1; // Secret is the body of the JWT token, should be used in API requests as bearer token. string secret = 2; @@ -348,15 +348,15 @@ message TokenServiceRefreshResponse { // TokenQuery is used to search tokens. message TokenQuery { - // UUID of the token to get + // UUID of the token to get. optional string uuid = 1 [(buf.validate.field).string.uuid = true]; - // Name of the token user to query + // Name of the token user to query. // Only useful for admins. optional string user = 2 [(buf.validate.field).string.(metalstack.api.v2.is_user) = true]; - // Description of the token to query + // Description of the token to query. optional string description = 3 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; // Labels lists only tokens containing the given labels. optional Labels labels = 4; - // Token type of the token to query + // Token type of the token to query. optional TokenType token_type = 5 [(buf.validate.field).enum.defined_only = true]; } diff --git a/proto/metalstack/api/v2/user.proto b/proto/metalstack/api/v2/user.proto index 07d201d6..5b15947f 100644 --- a/proto/metalstack/api/v2/user.proto +++ b/proto/metalstack/api/v2/user.proto @@ -21,17 +21,17 @@ service UserService { message User { // Login is the login at the provider. string login = 1 [(buf.validate.field).string.(metalstack.api.v2.is_tenant_login) = true]; - // Name of the user + // Name of the user. string name = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Email of the user + // Email of the user. string email = 3 [(buf.validate.field).string.email = true]; - // AvatarUrl of the user + // AvatarUrl of the user. string avatar_url = 4 [(buf.validate.field).string.(metalstack.api.v2.is_uri) = true]; - // Tenants the user belongs to + // Tenants the user belongs to. repeated Tenant tenants = 5; - // Projects the user belongs to + // Projects the user belongs to. repeated Project projects = 6; - // DefaultTenant the default tenant that this user belongs to + // DefaultTenant the default tenant that this user belongs to. Tenant default_tenant = 7; } diff --git a/proto/metalstack/api/v2/version.proto b/proto/metalstack/api/v2/version.proto index bfa9f9ea..8b695604 100644 --- a/proto/metalstack/api/v2/version.proto +++ b/proto/metalstack/api/v2/version.proto @@ -17,13 +17,13 @@ service VersionService { // Version represents the version of the application. message Version { - // Version of the application + // Version of the application. string version = 1 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Revision of the application + // Revision of the application. string revision = 2 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // GitSHA1 of the application + // GitSHA1 of the application. string git_sha1 = 3 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // BuildDate of the application + // BuildDate of the application. string build_date = 4 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; } diff --git a/proto/metalstack/api/v2/vpn.proto b/proto/metalstack/api/v2/vpn.proto index 5a4f645e..85f2ef8a 100644 --- a/proto/metalstack/api/v2/vpn.proto +++ b/proto/metalstack/api/v2/vpn.proto @@ -8,15 +8,15 @@ import "metalstack/api/v2/predefined_rules.proto"; // VPNNode represents a machine connected to the VPN. message VPNNode { - // ID of this node + // ID of this node. uint64 id = 1; - // Name of this node + // Name of this node. string name = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // Project of this node, maps to a project + // Project of this node, maps to a project. string project = 3 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; - // IPAddresses of this node in the VPN + // IPAddresses of this node in the VPN. repeated string ip_addresses = 4 [(buf.validate.field).repeated.(metalstack.api.v2.ips) = true]; - // LastSeen timestamp when this node reached out to the control plane + // LastSeen timestamp when this node reached out to the control plane. google.protobuf.Timestamp last_seen = 5; // Online indicates if this node is online. bool online = 6; diff --git a/proto/metalstack/infra/v2/bmc.proto b/proto/metalstack/infra/v2/bmc.proto index 41bbba7e..16464fe2 100644 --- a/proto/metalstack/infra/v2/bmc.proto +++ b/proto/metalstack/infra/v2/bmc.proto @@ -54,9 +54,9 @@ message WaitForBMCCommandRequest { // WaitForBMCCommandResponse is the response payload for waiting for a BMC command. message WaitForBMCCommandResponse { - // UUID of the machine to send the command to + // UUID of the machine to send the command to. string uuid = 1 [(buf.validate.field).string.uuid = true]; - // BmcCommand to execute against the BMC of the machine + // BmcCommand to execute against the BMC of the machine. metalstack.api.v2.MachineBMCCommand bmc_command = 2; // MachineBmc contains connection details of the machine to issue the BMC command to. metalstack.api.v2.MachineBMC machine_bmc = 3; @@ -70,7 +70,7 @@ message BMCCommandDoneRequest { // CommandId is a unique ID which must be sent back after execution. // It is usually in the form: :machine-bmc-command. string command_id = 1; - // Error of the command execution, nil if it was successful + // Error of the command execution, nil if it was successful. optional string error = 2; } diff --git a/proto/metalstack/infra/v2/boot.proto b/proto/metalstack/infra/v2/boot.proto index 311fa2c6..7e183517 100644 --- a/proto/metalstack/infra/v2/boot.proto +++ b/proto/metalstack/infra/v2/boot.proto @@ -48,7 +48,7 @@ service BootService { // BootServiceDhcpRequest is called once a machine issues a dhcp request. message BootServiceDhcpRequest { - // UUID of the machine + // UUID of the machine. string uuid = 1 [(buf.validate.field).string.uuid = true]; // Partition where this machine is located. string partition = 2 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; @@ -59,7 +59,7 @@ message BootServiceDhcpResponse {} // BootServiceBootRequest is called to get specified parameters to boot a machine with the given mac. message BootServiceBootRequest { - // Mac address of the machine + // Mac address of the machine. string mac = 1 [(buf.validate.field).string.(metalstack.api.v2.macaddress) = true]; // Partition where this machine is located. string partition = 2 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; @@ -77,17 +77,17 @@ message BootServiceBootResponse { // BootServiceRegisterRequest is called from metal-hammer to register a machine with as much hardware details as possible. message BootServiceRegisterRequest { - // UUID of this machine + // UUID of this machine. string uuid = 1 [(buf.validate.field).string.uuid = true]; - // Hardware details of this machine + // Hardware details of this machine. metalstack.api.v2.MachineHardware hardware = 2; - // Bios details of this machine + // Bios details of this machine. metalstack.api.v2.MachineBios bios = 3; - // BMC details of this machine + // BMC details of this machine. metalstack.api.v2.MachineBMC bmc = 4; - // FRU details of this machine + // FRU details of this machine. metalstack.api.v2.MachineFRU fru = 5; - // Tags of this machine + // Tags of this machine. repeated string tags = 6; // MetalHammer version this machine was booted into. string metal_hammer_version = 7 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; @@ -95,23 +95,23 @@ message BootServiceRegisterRequest { string partition = 8 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; } -// BootServiceRegisterResponse response to a BootServiceRegisterResponse request +// BootServiceRegisterResponse response to a BootServiceRegisterResponse request. message BootServiceRegisterResponse { - // UUID of this machine + // UUID of this machine. string uuid = 1 [(buf.validate.field).string.uuid = true]; // Size is the calculated size from given hardware details. string size = 2 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true]; - // Partition of this machine + // Partition of this machine. string partition = 3 [(buf.validate.field).string.(metalstack.api.v2.is_partition) = true]; } // BootServiceWaitRequest is called when a machine was registered and is waiting for allocation. message BootServiceWaitRequest { - // UUID of this machine + // UUID of this machine. string uuid = 1 [(buf.validate.field).string.uuid = true]; } -// BootServiceWaitResponse response to a wait request +// BootServiceWaitResponse response to a wait request. message BootServiceWaitResponse { // Allocation contains the machine.allocation to actually install the machine. metalstack.api.v2.MachineAllocation allocation = 1; @@ -119,9 +119,9 @@ message BootServiceWaitResponse { // BootServiceInstallationSucceededRequest is sent from metal-hammer to the api to report the installation succeeded. message BootServiceInstallationSucceededRequest { - // UUID of the machine to boot + // UUID of the machine to boot. string uuid = 1 [(buf.validate.field).string.uuid = true]; - // ConsolePassword + // ConsolePassword. string console_password = 2 [(buf.validate.field).string = { min_len: 2 max_len: 128 @@ -131,13 +131,13 @@ message BootServiceInstallationSucceededRequest { // BootServiceInstallationSucceededResponse is the response to a BootServiceInstallationSucceededRequest. message BootServiceInstallationSucceededResponse {} -// BootServiceSuperUserPasswordRequest this call returns the password for the machine superuser +// BootServiceSuperUserPasswordRequest this call returns the password for the machine superuser. message BootServiceSuperUserPasswordRequest { - // UUID of this machine + // UUID of this machine. string uuid = 1 [(buf.validate.field).string.uuid = true]; } -// BootServiceSuperUserPasswordResponse the super user password is returned +// BootServiceSuperUserPasswordResponse the super user password is returned. message BootServiceSuperUserPasswordResponse { // FeatureDisabled on set the superuserpassword in the bmc if this feature is not disabled. bool feature_disabled = 1; diff --git a/proto/metalstack/infra/v2/component.proto b/proto/metalstack/infra/v2/component.proto index 489ea3ee..48164975 100644 --- a/proto/metalstack/infra/v2/component.proto +++ b/proto/metalstack/infra/v2/component.proto @@ -27,12 +27,12 @@ message ComponentServicePingRequest { string identifier = 2 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true]; // StartedAt is the timestamp this service was started. google.protobuf.Timestamp started_at = 3 [(buf.validate.field).timestamp.lt_now = true]; - // Interval at which the ping is scheduled, must be between 5 seconds and 1 hour + // Interval at which the ping is scheduled, must be between 5 seconds and 1 hour. google.protobuf.Duration interval = 4 [(buf.validate.field).duration = { gte: {seconds: 5} lte: {seconds: 3600} }]; - // Version of this service + // Version of this service. metalstack.api.v2.Version version = 5; } diff --git a/proto/metalstack/infra/v2/event.proto b/proto/metalstack/infra/v2/event.proto index 6e558634..07741c77 100644 --- a/proto/metalstack/infra/v2/event.proto +++ b/proto/metalstack/infra/v2/event.proto @@ -16,13 +16,13 @@ service EventService { // EventServiceSendRequest is the request payload for sending provisioning events. message EventServiceSendRequest { - // Events grouped by machine IDs + // Events grouped by machine IDs. map events = 1; } // EventServiceSendResponse is the response payload for sending provisioning events. message EventServiceSendResponse { - // Events counts the number of events successfully stored in the database + // Events counts the number of events successfully stored in the database. uint64 events = 1; // Failed contains IDs of all machines whose events could not be stored in the database. repeated string failed = 2; diff --git a/proto/metalstack/infra/v2/switch.proto b/proto/metalstack/infra/v2/switch.proto index 02f99a80..cfa30660 100644 --- a/proto/metalstack/infra/v2/switch.proto +++ b/proto/metalstack/infra/v2/switch.proto @@ -30,7 +30,7 @@ service SwitchService { // SwitchServiceGetRequest is the request payload for getting a switch. message SwitchServiceGetRequest { - // Id of the switch + // Id of the switch. string id = 1 [(buf.validate.field).string = { hostname: true [metalstack.api.v2.is_name]: true @@ -45,7 +45,7 @@ message SwitchServiceGetResponse { // SwitchServiceRegisterRequest is the request payload for registering a switch. message SwitchServiceRegisterRequest { - // Switch to register + // Switch to register. metalstack.api.v2.Switch switch = 1; } @@ -57,14 +57,14 @@ message SwitchServiceRegisterResponse { // SwitchServiceHeartbeatRequest is the request payload for sending a switch heartbeat. message SwitchServiceHeartbeatRequest { - // Id of the switch + // Id of the switch. string id = 1 [(buf.validate.field).string = { hostname: true [metalstack.api.v2.is_name]: true }]; - // Duration of the sync + // Duration of the sync. google.protobuf.Duration duration = 2; - // Error if any occurred during the sync + // Error if any occurred during the sync. optional string error = 3; // PortStates maps port identifiers to the respective port's operational state. map port_states = 4; @@ -74,7 +74,7 @@ message SwitchServiceHeartbeatRequest { // SwitchServiceHeartbeatResponse is the response payload for sending a switch heartbeat. message SwitchServiceHeartbeatResponse { - // Id of the switch + // Id of the switch. string id = 1; // LastSync holds information about the last sync. metalstack.api.v2.SwitchSync last_sync = 2; From 550e3bf8c4b3a2ee75c1223daebc08638a4bc54d Mon Sep 17 00:00:00 2001 From: Stefan Majer Date: Wed, 12 Aug 2026 08:54:37 +0200 Subject: [PATCH 3/3] Run make --- doc/index.html | 1676 ++++++++--------- go/metalstack/admin/v2/audit.pb.go | 2 +- go/metalstack/admin/v2/filesystem.pb.go | 36 +- go/metalstack/admin/v2/image.pb.go | 16 +- go/metalstack/admin/v2/machine.pb.go | 26 +- go/metalstack/admin/v2/network.pb.go | 40 +- go/metalstack/admin/v2/partition.pb.go | 28 +- go/metalstack/admin/v2/size.pb.go | 12 +- .../admin/v2/size_imageconstraint.pb.go | 22 +- go/metalstack/admin/v2/size_reservation.pb.go | 14 +- go/metalstack/admin/v2/switch.pb.go | 20 +- go/metalstack/admin/v2/task.pb.go | 16 +- go/metalstack/admin/v2/tenant.pb.go | 20 +- go/metalstack/admin/v2/token.pb.go | 4 +- go/metalstack/admin/v2/vpn.pb.go | 8 +- .../api/v2/apiv2connect/project.connect.go | 4 +- .../api/v2/apiv2connect/tenant.connect.go | 8 +- go/metalstack/api/v2/audit.pb.go | 14 +- go/metalstack/api/v2/common.pb.go | 68 +- go/metalstack/api/v2/component.pb.go | 6 +- go/metalstack/api/v2/filesystem.pb.go | 108 +- go/metalstack/api/v2/health.pb.go | 24 +- go/metalstack/api/v2/image.pb.go | 54 +- go/metalstack/api/v2/ip.pb.go | 74 +- go/metalstack/api/v2/machine.pb.go | 494 +++-- go/metalstack/api/v2/network.pb.go | 118 +- go/metalstack/api/v2/partition.pb.go | 30 +- go/metalstack/api/v2/project.pb.go | 62 +- go/metalstack/api/v2/size.pb.go | 32 +- .../api/v2/size_imageconstraint.pb.go | 31 +- go/metalstack/api/v2/size_reservation.pb.go | 40 +- go/metalstack/api/v2/switch.pb.go | 12 +- go/metalstack/api/v2/tenant.pb.go | 86 +- go/metalstack/api/v2/token.pb.go | 68 +- go/metalstack/api/v2/user.pb.go | 12 +- go/metalstack/api/v2/version.pb.go | 8 +- go/metalstack/api/v2/vpn.pb.go | 10 +- go/metalstack/infra/v2/bmc.pb.go | 6 +- go/metalstack/infra/v2/boot.pb.go | 36 +- go/metalstack/infra/v2/component.pb.go | 4 +- go/metalstack/infra/v2/event.pb.go | 4 +- go/metalstack/infra/v2/switch.pb.go | 12 +- js/metalstack/admin/v2/audit_pb.d.ts | 2 +- js/metalstack/admin/v2/audit_pb.ts | 2 +- js/metalstack/admin/v2/filesystem_pb.d.ts | 36 +- js/metalstack/admin/v2/filesystem_pb.ts | 36 +- js/metalstack/admin/v2/image_pb.d.ts | 16 +- js/metalstack/admin/v2/image_pb.ts | 16 +- js/metalstack/admin/v2/machine_pb.d.ts | 26 +- js/metalstack/admin/v2/machine_pb.ts | 26 +- js/metalstack/admin/v2/network_pb.d.ts | 40 +- js/metalstack/admin/v2/network_pb.ts | 40 +- js/metalstack/admin/v2/partition_pb.d.ts | 28 +- js/metalstack/admin/v2/partition_pb.ts | 28 +- .../admin/v2/size_imageconstraint_pb.d.ts | 22 +- .../admin/v2/size_imageconstraint_pb.ts | 22 +- js/metalstack/admin/v2/size_pb.d.ts | 12 +- js/metalstack/admin/v2/size_pb.ts | 12 +- .../admin/v2/size_reservation_pb.d.ts | 14 +- js/metalstack/admin/v2/size_reservation_pb.ts | 14 +- js/metalstack/admin/v2/switch_pb.d.ts | 20 +- js/metalstack/admin/v2/switch_pb.ts | 20 +- js/metalstack/admin/v2/task_pb.d.ts | 16 +- js/metalstack/admin/v2/task_pb.ts | 16 +- js/metalstack/admin/v2/tenant_pb.d.ts | 20 +- js/metalstack/admin/v2/tenant_pb.ts | 20 +- js/metalstack/admin/v2/token_pb.d.ts | 4 +- js/metalstack/admin/v2/token_pb.ts | 4 +- js/metalstack/admin/v2/vpn_pb.d.ts | 8 +- js/metalstack/admin/v2/vpn_pb.ts | 8 +- js/metalstack/api/v2/audit_pb.d.ts | 14 +- js/metalstack/api/v2/audit_pb.ts | 14 +- js/metalstack/api/v2/common_pb.d.ts | 68 +- js/metalstack/api/v2/common_pb.js | 52 +- js/metalstack/api/v2/common_pb.ts | 68 +- js/metalstack/api/v2/component_pb.d.ts | 6 +- js/metalstack/api/v2/component_pb.ts | 6 +- js/metalstack/api/v2/filesystem_pb.d.ts | 108 +- js/metalstack/api/v2/filesystem_pb.js | 20 +- js/metalstack/api/v2/filesystem_pb.ts | 108 +- js/metalstack/api/v2/health_pb.d.ts | 24 +- js/metalstack/api/v2/health_pb.js | 24 +- js/metalstack/api/v2/health_pb.ts | 24 +- js/metalstack/api/v2/image_pb.d.ts | 54 +- js/metalstack/api/v2/image_pb.js | 4 +- js/metalstack/api/v2/image_pb.ts | 54 +- js/metalstack/api/v2/ip_pb.d.ts | 74 +- js/metalstack/api/v2/ip_pb.ts | 74 +- js/metalstack/api/v2/machine_pb.d.ts | 494 +++-- js/metalstack/api/v2/machine_pb.js | 90 +- js/metalstack/api/v2/machine_pb.ts | 494 +++-- js/metalstack/api/v2/network_pb.d.ts | 118 +- js/metalstack/api/v2/network_pb.js | 4 +- js/metalstack/api/v2/network_pb.ts | 118 +- js/metalstack/api/v2/partition_pb.d.ts | 30 +- js/metalstack/api/v2/partition_pb.ts | 30 +- js/metalstack/api/v2/project_pb.d.ts | 64 +- js/metalstack/api/v2/project_pb.ts | 64 +- .../api/v2/size_imageconstraint_pb.d.ts | 31 +- .../api/v2/size_imageconstraint_pb.ts | 31 +- js/metalstack/api/v2/size_pb.d.ts | 32 +- js/metalstack/api/v2/size_pb.js | 2 +- js/metalstack/api/v2/size_pb.ts | 32 +- js/metalstack/api/v2/size_reservation_pb.d.ts | 40 +- js/metalstack/api/v2/size_reservation_pb.ts | 40 +- js/metalstack/api/v2/switch_pb.d.ts | 12 +- js/metalstack/api/v2/switch_pb.ts | 12 +- js/metalstack/api/v2/tenant_pb.d.ts | 90 +- js/metalstack/api/v2/tenant_pb.ts | 90 +- js/metalstack/api/v2/token_pb.d.ts | 70 +- js/metalstack/api/v2/token_pb.ts | 70 +- js/metalstack/api/v2/user_pb.d.ts | 12 +- js/metalstack/api/v2/user_pb.ts | 12 +- js/metalstack/api/v2/version_pb.d.ts | 8 +- js/metalstack/api/v2/version_pb.ts | 8 +- js/metalstack/api/v2/vpn_pb.d.ts | 10 +- js/metalstack/api/v2/vpn_pb.ts | 10 +- js/metalstack/infra/v2/bmc_pb.d.ts | 6 +- js/metalstack/infra/v2/bmc_pb.ts | 6 +- js/metalstack/infra/v2/boot_pb.d.ts | 36 +- js/metalstack/infra/v2/boot_pb.ts | 36 +- js/metalstack/infra/v2/component_pb.d.ts | 4 +- js/metalstack/infra/v2/component_pb.ts | 4 +- js/metalstack/infra/v2/event_pb.d.ts | 4 +- js/metalstack/infra/v2/event_pb.ts | 4 +- js/metalstack/infra/v2/switch_pb.d.ts | 12 +- js/metalstack/infra/v2/switch_pb.ts | 12 +- 127 files changed, 3444 insertions(+), 3487 deletions(-) diff --git a/doc/index.html b/doc/index.html index 260ff818..179deb09 100644 --- a/doc/index.html +++ b/doc/index.html @@ -3095,7 +3095,7 @@

Labels

 - + @@ -3168,7 +3168,7 @@

LabelsPatch

Meta

-

Meta of a message

+

Meta of a message.

metalstack.api.v2.MachineAllocation

Allocation contains the machine.allocation to actually install the machine

Allocation contains the machine.allocation to actually install the machine.

type metalstack.api.v2.ComponentType

Type defines which service is actually pinging

Type defines which service is actually pinging.

identifier string

Identifier is a unique identifier of this service, for example if two instances are running, this might be the pod ID

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.

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.

metalstack.api.v2.Switch

Switch contains the requested switch

Switch contains the requested switch.

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.

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.

switch metalstack.api.v2.Switch

Switch contains the registered switch

Switch contains the registered switch.

labels Labels.LabelsEntry repeated

Labels consists labels

Labels consists labels.

@@ -3181,7 +3181,7 @@

Meta

 - + @@ -3196,7 +3196,7 @@

Meta

 +must be part of the update request to ensure optimistic locking.

@@ -3235,7 +3235,7 @@

Paging

 - @@ -3267,7 +3267,7 @@

UpdateLabels

 - + @@ -3299,14 +3299,14 @@

UpdateMeta

 +Must be part of the update request to ensure optimistic locking.

- + @@ -3335,20 +3335,20 @@

AdminRole

 - + - +
labels Labels optional

Tags on this entity

Tags on this entity.

google.protobuf.Timestamp

UpdatedAt is the date when this entity was updated. -must be part of the update request to ensure optimistic locking

page uint64 optional

Page is used for pagination, if unset only the first page is returned, +

Page is used for pagination, if unset only the first page is returned,. the list response contains then the page number for the next page.

replace Labels

Replace existing labels with the given ones

Replace existing labels with the given ones.

google.protobuf.Timestamp

UpdatedAt is the date when this entity was updated. -must be part of the update request to ensure optimistic locking

locking_strategy OptimisticLockingStrategy

LockingStrategy to be used for this update request

LockingStrategy to be used for this update request.

ADMIN_ROLE_EDITOR 1

ADMIN_ROLE_EDITOR the logged in user needs at least editor role to call this method

ADMIN_ROLE_EDITOR the logged in user needs at least editor role to call this method.
ADMIN_ROLE_VIEWER 2

ADMIN_ROLE_VIEWER the logged in user needs at least viewer role to call this method

ADMIN_ROLE_VIEWER the logged in user needs at least viewer role to call this method.

Auditing

-

Auditing option specified per service method

by default all service methods are included

add the auditing option if you want to exclude a method in auditing

+

Auditing option specified per service method.

By default all service methods are included.

Add the auditing option if you want to exclude a method in auditing.

@@ -3364,13 +3364,13 @@

Auditing

- + - + @@ -3393,13 +3393,13 @@

InfraRole

- + - + @@ -3422,20 +3422,20 @@

MachineRole

- + - +
NameNumberDescription
AUDITING_INCLUDED 1

AUDITING_INCLUDED if a method is annotated with this, all calls are audited

AUDITING_INCLUDED if a method is annotated with this, all calls are audited.
AUDITING_EXCLUDED 2

AUDITING_EXCLUDED if a method is annotated with this, no calls are audited

AUDITING_EXCLUDED if a method is annotated with this, no calls are audited.
INFRA_ROLE_EDITOR 1

INFRA_ROLE_EDITOR a microservice needs at least editor role to call this method

INFRA_ROLE_EDITOR a microservice needs at least editor role to call this method.
INFRA_ROLE_VIEWER 2

INFRA_ROLE_VIEWER a microservice needs at least viewer role to call this method

INFRA_ROLE_VIEWER a microservice needs at least viewer role to call this method.
MACHINE_ROLE_EDITOR 1

MACHINE_ROLE_EDITOR a microservice needs at least editor role to call this method

MACHINE_ROLE_EDITOR a microservice needs at least editor role to call this method.
MACHINE_ROLE_VIEWER 2

MACHINE_ROLE_VIEWER a microservice needs at least viewer role to call this method

MACHINE_ROLE_VIEWER a microservice needs at least viewer role to call this method.

OptimisticLockingStrategy

-

OptimisticLockingStrategy defines how optimistic locking should be handled.

It defaults to client side, which requires the UpdatedAt timestamp to be provided

+

OptimisticLockingStrategy defines how optimistic locking should be handled.

It defaults to client side, which requires the UpdatedAt timestamp to be provided.

@@ -3445,20 +3445,20 @@

OptimisticLockingStrategy

- + - + - + @@ -3481,19 +3481,19 @@

ProjectRole

- + - + - + @@ -3516,25 +3516,25 @@

TenantRole

- + - + - + - @@ -3543,7 +3543,7 @@

TenantRole

NameNumberDescription
OPTIMISTIC_LOCKING_STRATEGY_UNSPECIFIED 0

OPTIMISTIC_LOCKING_STRATEGY_UNSPECIFIED same as client side

OPTIMISTIC_LOCKING_STRATEGY_UNSPECIFIED same as client side.
OPTIMISTIC_LOCKING_STRATEGY_CLIENT 1

OPTIMISTIC_LOCKING_STRATEGY_CLIENT requires UpdatedAt to be specified

OPTIMISTIC_LOCKING_STRATEGY_CLIENT requires UpdatedAt to be specified.
OPTIMISTIC_LOCKING_STRATEGY_SERVER 2

OPTIMISTIC_LOCKING_STRATEGY_SERVER allows to omit UpdatedAt -and fetches the most recent entity before updating with the given values with the update request

OPTIMISTIC_LOCKING_STRATEGY_SERVER allows to omit UpdatedAt. +and fetches the most recent entity before updating with the given values with the update request.
PROJECT_ROLE_OWNER 1

PROJECT_ROLE_OWNER the logged in user needs at least owner role to call this method

PROJECT_ROLE_OWNER the logged in user needs at least owner role to call this method.
PROJECT_ROLE_EDITOR 2

PROJECT_ROLE_EDITOR the logged in user needs at least editor role to call this method

PROJECT_ROLE_EDITOR the logged in user needs at least editor role to call this method.
PROJECT_ROLE_VIEWER 3

PROJECT_ROLE_VIEWER the logged in user needs at least viewer role to call this method

PROJECT_ROLE_VIEWER the logged in user needs at least viewer role to call this method.
TENANT_ROLE_OWNER 1

TENANT_ROLE_OWNER the logged in user needs at least owner role to call this method

TENANT_ROLE_OWNER the logged in user needs at least owner role to call this method.
TENANT_ROLE_EDITOR 2

TENANT_ROLE_EDITOR the logged in user needs at least editor role to call this method

TENANT_ROLE_EDITOR the logged in user needs at least editor role to call this method.
TENANT_ROLE_VIEWER 3

TENANT_ROLE_VIEWER the logged in user needs at least viewer role to call this method

TENANT_ROLE_VIEWER the logged in user needs at least viewer role to call this method.
TENANT_ROLE_GUEST 4

TENANT_ROLE_GUEST the logged in user needs at least guest role to call this method +

TENANT_ROLE_GUEST the logged in user needs at least guest role to call this method. The guest role is assumed by users who are invited to a tenant's project without them. having a direct membership within the tenant.

Visibility

-

Visibility of a method

+

Visibility of a method.

@@ -3565,7 +3565,7 @@

Visibility

- + @@ -3585,7 +3585,7 @@

File-level Extensions

- + @@ -3671,7 +3671,7 @@

AuditQuery

- + @@ -3734,7 +3734,7 @@

AuditQuery

- + @@ -3765,14 +3765,14 @@

AuditServiceGetRequest

- + - + @@ -3827,7 +3827,7 @@

AuditServiceListRequest

- + @@ -3882,7 +3882,7 @@

AuditTrace

- + @@ -3952,7 +3952,7 @@

AuditTrace

- + @@ -4045,7 +4045,7 @@

AuditServiceGetRequest

- + @@ -4188,7 +4188,7 @@

AdminPermissions

- + @@ -4212,7 +4212,7 @@

InfraPermissions

- + @@ -4236,15 +4236,15 @@

MachinePermissions

- + - + @@ -4268,19 +4268,18 @@

MethodPermission

- +Asterisk (*) can be specified to match any subject. +Empty string ("") can be specified for requests that do not require a subject, e.g. partition list. +Otherwise either a projectid or a tenant login should be specified.

- + @@ -4370,14 +4369,15 @@

ProjectPermissions

- + - + @@ -4401,7 +4401,7 @@

PublicPermissions

- + @@ -4425,7 +4425,7 @@

SelfPermissions

- + @@ -4449,15 +4449,15 @@

TenantPermissions

- + - + @@ -4468,7 +4468,7 @@

TenantPermissions

Token

-

Token generates a jwt authentication token to access the api.

There are two different types of tokens, api- and user- tokens.

A user token is used to authenticate end user requests for example from a cli.

The configured roles in a user token are expanded in the api server.

based on the memberships in other projects and tenants based on the role granted there.

User tokens will never contain permissions.

Permissions are always derived from the tenant and project roles and memberships.

The api token should be used to authenticate services.

In contrast to a user token, the api token permissions and roles apply as configured during the token create process.

Message level validation, can be developed using https://protovalidate.com/playground

+

Token generates a jwt authentication token to access the api.

There are two different types of tokens, api- and user- tokens.

A user token is used to authenticate end user requests for example from a cli.

The configured roles in a user token are expanded in the api server.

based on the memberships in other projects and tenants based on the role granted there.

User tokens will never contain permissions.

Permissions are always derived from the tenant and project roles and memberships.

The api token should be used to authenticate services.

In contrast to a user token, the api token permissions and roles apply as configured during the token create process.

Message level validation, can be developed using https://protovalidate.com/playground.

NameNumberDescription
VISIBILITY_SELF 2

VISIBILITY_SELF restricts calls to the authenticated user only

VISIBILITY_SELF restricts calls to the authenticated user only.
string .google.protobuf.EnumValueOptions 52000

StringValue which can be set to a enum

StringValue which can be set to a enum.
uuid string optional

Uuid of the audit trace

Uuid of the audit trace.

limit int32 optional

Limit is a number limiting the length of the response (min: 1, max: 1000, defaults to 200)

Limit is a number limiting the length of the response (min: 1, max: 1000, defaults to 200).

login string

Login for this tenant

Login for this tenant.

uuid string

Uuid of the audit trace

Uuid of the audit trace.

login string

Login for this tenant

Login for this tenant.

uuid string

Uuid of the audit trace

Uuid of the audit trace.

meta Meta

Meta for this audit trace

Meta for this audit trace.

uuid string

Uuid of the audit trace

Uuid of the audit trace.

methods string repeated

Methods which should be accessible

Methods which should be accessible.

methods string repeated

Methods which should be accessible

Methods which should be accessible.

uuid string

UUID of this machine -asterisk (*) can be specified to match any subject

UUID of this machine. +Asterisk (*) can be specified to match any subject.

methods string repeated

Methods which should be accessible

Methods which should be accessible.

subject string

Subject maybe either the project or the tenant -for which the methods should be allowed +

Subject may be either the project or the tenant for which the methods should be allowed. -asterisk (*) can be specified to match any subject -empty string ("") can be specified for requests that do not require a subject, e.g. partition list -otherwise either a projectid or a tenant login should be specified

methods string repeated

Methods which should be accessible

Methods which should be accessible.

project string

asterisk (*) can be specified to match any subject

Project scope for the permissions. +Asterisk (*) can be specified to match any subject.

methods string repeated

Methods which should be accessible

Methods which should be accessible.

methods string repeated

Methods which should be accessible

Methods which should be accessible.

methods string repeated

Methods which should be accessible

Methods which should be accessible.

login string

Login of the tenant -asterisk (*) can be specified to match any subject

Login of the tenant. +Asterisk (*) can be specified to match any subject.

methods string repeated

Methods which should be accessible

Methods which should be accessible.

@@ -4481,21 +4481,21 @@

Token

- + - + - + @@ -4683,14 +4683,14 @@

TokenQuery

- + - @@ -4698,7 +4698,7 @@

TokenQuery

- + @@ -4712,7 +4712,7 @@

TokenQuery

- + @@ -4736,7 +4736,7 @@

TokenServiceCreateRequestdescription

- + @@ -4792,7 +4792,7 @@

TokenServiceCreateRequestlabels

- + @@ -4909,7 +4909,7 @@

TokenServiceCreateResponse

- + @@ -4940,7 +4940,7 @@

TokenServiceGetRequest

- + @@ -5023,7 +5023,7 @@

TokenServiceListResponse

TokenServiceRefreshRequest -

TokenServiceRefreshRequest is the request payload of a token refresh request.

Permissions, Roles and Expiration duration and all other properties are inherited from the calling token.

The expiration duration will be calculated from the existing token (exp - iat)

+

TokenServiceRefreshRequest is the request payload of a token refresh request.

Permissions, Roles and Expiration duration and all other properties are inherited from the calling token.

The expiration duration will be calculated from the existing token (exp - iat).

@@ -5043,7 +5043,7 @@

TokenServiceRefreshRespon

- + @@ -5074,7 +5074,7 @@

TokenServiceRevokeRequestuuid

- + @@ -5105,7 +5105,7 @@

TokenServiceUpdateRequestuuid

- + @@ -5169,7 +5169,7 @@

TokenServiceUpdateRequestlabels

- + @@ -5407,28 +5407,28 @@

Version

- + - + - + - + @@ -5559,7 +5559,7 @@

Component

- + @@ -5573,7 +5573,7 @@

Component

- + @@ -5584,7 +5584,7 @@

Component

ComponentQuery

-

ComponentQuery to query components

+

ComponentQuery to query components.

uuid string

Uuid of the jwt token, used to reference it by revoke

Uuid of the jwt token, used to reference it by revoke.

user string

User who created this token

User who created this token.

meta Meta

Meta for this token

Meta for this token.

uuid string optional

UUID of the token to get

UUID of the token to get.

user string optional

Name of the token user to query +

Name of the token user to query. Only useful for admins.

description string optional

Description of the token to query

Description of the token to query.

token_type TokenType optional

Token type of the token to query

Token type of the token to query.

string

Description of the token

Description of the token.

Labels

Labels on this token

Labels on this token.

token Token

Token which was created

Token which was created.

uuid string

Uuid of the token to get

Uuid of the token to get.

token Token

Token which was refreshed

Token which was refreshed.

string

Uuid of the token to revoke

Uuid of the token to revoke.

string

Uuid of the token to update

Uuid of the token to update.

UpdateLabels

Labels on this token

Labels on this token.

version string

Version of the application

Version of the application.

revision string

Revision of the application

Revision of the application.

git_sha1 string

GitSHA1 of the application

GitSHA1 of the application.

build_date string

BuildDate of the application

BuildDate of the application.

version Version

Version of this service

Version of this service.

meta Meta

Meta for this component

Meta for this component.

@@ -5881,7 +5881,7 @@

metalstack/api/v2/filesystem.protoDisk

-

Disk

+

Disk.

@@ -5894,7 +5894,7 @@

Disk

- + @@ -5912,7 +5912,7 @@

Disk

DiskPartition

-

DiskPartition

+

DiskPartition.

device string

Device the device to create the partitions

Device the device to create the partitions.

@@ -5932,21 +5932,21 @@

DiskPartition

- + - + - + @@ -5957,7 +5957,7 @@

DiskPartition

Filesystem

-

Filesystem

+

Filesystem.

label string optional

Label an optional label for this partition

Label an optional label for this partition.

size uint64

Size in mebibytes (MiB) of this partition

Size in mebibytes (MiB) of this partition.

gpt_type GPTType optional

GPTType the gpt partition table type of this partition

GPTType the gpt partition table type of this partition.

@@ -5970,56 +5970,56 @@

Filesystem

- + - + - + - + - + - + - + - + @@ -6030,7 +6030,7 @@

Filesystem

FilesystemLayout

-

FilesystemLayout

+

FilesystemLayout.

device string

Device the underlying device where this filesystem should be created

Device the underlying device where this filesystem should be created.

format Format

Format of the filesystem format

Format of the filesystem format.

name string optional

Name of this filesystem

Name of this filesystem.

description string optional

Description of this filesystem

Description of this filesystem.

path string optional

Path the mountpoint where this filesystem should be mounted on

Path the mountpoint where this filesystem should be mounted on.

label string optional

Label an optional label for this filesystem

Label an optional label for this filesystem.

mount_options string repeated

MountOptions the options to use to mount this filesystem

MountOptions the options to use to mount this filesystem.

create_options string repeated

CreateOptions the options to use to create (mkfs) this filesystem

CreateOptions the options to use to create (mkfs) this filesystem.

@@ -6043,28 +6043,28 @@

FilesystemLayout

- + - + - + - + @@ -6085,7 +6085,7 @@

FilesystemLayout

- + @@ -6106,7 +6106,7 @@

FilesystemLayout

- + @@ -6117,7 +6117,7 @@

FilesystemLayout

FilesystemLayoutConstraints

-

FilesystemLayoutConstraints

+

FilesystemLayoutConstraints.

id string

Id of this filesystemLayout

Id of this filesystemLayout.

meta Meta

Meta for this filesystemLayout

Meta for this filesystemLayout.

name string optional

Name of this filesystemLayout

Name of this filesystemLayout.

description string optional

Description of this filesystemLayout

Description of this filesystemLayout.

raid Raid repeated

raid arrays to create

Raid arrays to create.

constraints FilesystemLayoutConstraints

Constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts

Constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts.

@@ -6131,18 +6131,18 @@

FilesystemLayoutConstrain

+This could either be a concrete size, or a asterisk to match all sizes.

- + @@ -6197,7 +6197,7 @@

FilesystemServiceGetReque

- + @@ -6221,7 +6221,7 @@

FilesystemServiceGetResp

- + @@ -6245,7 +6245,7 @@

FilesystemServiceListReq

- + @@ -6269,7 +6269,7 @@

FilesystemServiceListRe

- + @@ -6280,7 +6280,7 @@

FilesystemServiceListRe

LogicalVolume

-

LogicalVolume

+

LogicalVolume.

string repeated

Sizes list of sizes this layout applies to. -this could either be a concrete size, or a asterisk to match all sizes

images FilesystemLayoutConstraints.ImagesEntry repeated

Images list of images this layout applies to in the following form. -key must be the first part of available images, e.g. the name of the image -value must be a semver match expression with the constraint and the version separated by space -this would match all debian images which are greater or equal 12.0 -"debian":">= 12.0"

Images list of images this layout applies to in the following form: +Key must be the first part of available images, e.g. the name of the imag. +Value must be a semver match expression with the constraint and the version separated by space. +This would match all debian images which are greater or equal 12: +"debian": >= 12.0.

id string

ID of the filesystem to get

ID of the filesystem to get.

filesystem_layout FilesystemLayout

FilesystemLayout the filesystemlayout

FilesystemLayout the filesystemlayout.

id string optional

ID of the filesystem to get

ID of the filesystem to get.

filesystem_layouts FilesystemLayout repeated

FilesystemLayouts the filesystemlayouts

FilesystemLayouts the filesystemlayouts.

@@ -6293,28 +6293,28 @@

LogicalVolume

- + - + - + - + @@ -6325,7 +6325,7 @@

LogicalVolume

Raid

-

Raid

+

Raid.

name string

Name the name of the logical volume

Name the name of the logical volume.

volume_group string

VolumeGroup the name of the volume group where to create the logical volume onto

VolumeGroup the name of the volume group where to create the logical volume onto.

size uint64

Size size in mebibytes (MiB) of this volume

Size size in mebibytes (MiB) of this volume.

lvm_type LVMType

LVMType the type of this logical volume can be either linear|striped|raid1

LVMType the type of this logical volume can be either linear|striped|raid1.

@@ -6338,7 +6338,7 @@

Raid

- + @@ -6359,14 +6359,14 @@

Raid

- + - + @@ -6377,7 +6377,7 @@

Raid

VolumeGroup

-

VolumeGroup

+

VolumeGroup.

array_name string

ArrayName the name of the resulting array device

ArrayName the name of the resulting array device.

create_options string repeated

CreateOptions the options to use to create the raid array

CreateOptions the options to use to create the raid array.

spares int32

Spares number of spares for the raid array

Spares number of spares for the raid array.

@@ -6390,7 +6390,7 @@

VolumeGroup

- + @@ -6427,7 +6427,7 @@

Format

- + @@ -6463,7 +6463,7 @@

Format

- + @@ -6486,32 +6486,32 @@

GPTType

- + - + - + - +
name string

Name the name of the resulting volume group

Name the name of the resulting volume group.

FORMAT_UNSPECIFIED 0

FORMAT_UNSPECIFIED

FORMAT_UNSPECIFIED.
FORMAT_NONE 6

FORMAT_NONE

FORMAT_NONE.
GPT_TYPE_BOOT 1

GPT_TYPE_BOOT EFI Boot Partition

GPT_TYPE_BOOT EFI Boot Partition.
GPT_TYPE_LINUX 2

GPT_TYPE_LINUX Linux Partition

GPT_TYPE_LINUX Linux Partition.
GPT_TYPE_LINUX_RAID 3

GPT_TYPE_LINUX_RAID Linux Raid Partition

GPT_TYPE_LINUX_RAID Linux Raid Partition.
GPT_TYPE_LINUX_LVM 4

GPT_TYPE_LINUX_LVM Linux LVM Partition

GPT_TYPE_LINUX_LVM Linux LVM Partition.

LVMType

-

LVMType

+

LVMType.

@@ -6527,19 +6527,19 @@

LVMType

- + - + - + @@ -6674,7 +6674,7 @@

FilesystemServiceDel

- + @@ -6709,7 +6709,7 @@

FilesystemServiceDe

FilesystemServiceMatchRequest

-

FilesystemServiceMatchRequest

+

FilesystemServiceMatchRequest.

NameNumberDescription
LVM_TYPE_LINEAR 1

LVM_TYPE_LINEAR append across all physical volumes

LVM_TYPE_LINEAR append across all physical volumes.
LVM_TYPE_STRIPED 2

LVM_TYPE_STRIPED stripe across all physical volumes

LVM_TYPE_STRIPED stripe across all physical volumes.
LVM_TYPE_RAID1 3

LVM_TYPE_RAID1 mirror with raid across all physical volumes

LVM_TYPE_RAID1 mirror with raid across all physical volumes.
id string

ID of the filesystem to delete

ID of the filesystem to delete.

@@ -6722,14 +6722,14 @@

FilesystemServiceMatc

- + - + @@ -6740,7 +6740,7 @@

FilesystemServiceMatc

FilesystemServiceMatchResponse

-

FilesystemServiceMatchResponse

+

FilesystemServiceMatchResponse.

size_and_image MatchImageAndSize

SizeAndImage

SizeAndImage.

machine_and_filesystemlayout MatchMachineAndFilesystemLayout

MachineAndFilesystemlayout

MachineAndFilesystemlayout.

@@ -6753,7 +6753,7 @@

FilesystemServiceMat

- + @@ -6777,7 +6777,7 @@

FilesystemServiceUpd

- + @@ -6791,14 +6791,14 @@

FilesystemServiceUpd

- + - + @@ -6819,7 +6819,7 @@

FilesystemServiceUpd

- + @@ -6840,7 +6840,7 @@

FilesystemServiceUpd

- + @@ -6875,7 +6875,7 @@

FilesystemServiceUp

MatchImageAndSize

-

MatchImageAndSize

+

MatchImageAndSize.

filesystem_layout metalstack.api.v2.FilesystemLayout

FilesystemLayout the filesystemlayout

FilesystemLayout the filesystemlayout.

id string

Id of this filesystemLayout

Id of this filesystemLayout.

name string optional

Name of this filesystemLayout

Name of this filesystemLayout.

description string optional

Description of this filesystemLayout

Description of this filesystemLayout.

raid metalstack.api.v2.Raid repeated

Raid arrays to create

Raid arrays to create.

constraints metalstack.api.v2.FilesystemLayoutConstraints

Constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts

Constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts.

@@ -6888,14 +6888,14 @@

MatchImageAndSize

- + - + @@ -6906,7 +6906,7 @@

MatchImageAndSize

MatchMachineAndFilesystemLayout

-

MatchMachineAndFilesystemLayout

+

MatchMachineAndFilesystemLayout.

size string

Size, machine size to try

Size, machine size to try.

image string

Image machine image to try

Image machine image to try.

@@ -6919,14 +6919,14 @@

MatchMachineAndFile

- + - + @@ -6991,7 +6991,7 @@

metalstack/api/v2/image.proto

Image -

Image

+

Image.

machine string

Machine to check

Machine to check.

filesystem_layout string

FilesystemLayout to check

FilesystemLayout to check.

@@ -7004,49 +7004,49 @@

Image

 - + - + - + - + - + - + - + @@ -7077,56 +7077,56 @@

ImageQuery

 - + - + - + - + - + - + - + - + @@ -7157,7 +7157,7 @@

ImageServiceGetRequest

 - + @@ -7181,7 +7181,7 @@

ImageServiceGetResponse

 - + @@ -7205,15 +7205,15 @@

ImageServiceLatestRequestos

- + - + @@ -7237,7 +7237,7 @@

ImageServiceLatestResponse

- + @@ -7285,7 +7285,7 @@

ImageServiceListResponse

images - + @@ -7309,14 +7309,14 @@

ImageUsage

 - + - + @@ -7329,7 +7329,7 @@

ImageUsage

ImageClassification

-

Image

+

Image.

id string

Id of this image

Id of this image.

meta Meta

Meta for this image

Meta for this image.

url string

URL where this image is located

URL where this image is located.

name string optional

Name of this image

Name of this image.

description string optional

Description of this image

Description of this image.

features ImageFeature repeated

Features of this image

Features of this image.

classification ImageClassification

Classification of this image

Classification of this image.

id string optional

ID of the image to get

ID of the image to get.

os string optional

OS of the image

OS of the image.

version string optional

Version of the Image

Version of the Image.

name string optional

Name of the image to query

Name of the image to query.

description string optional

Description of the image to query

Description of the image to query.

url string optional

Url of the image to query

Url of the image to query.

feature ImageFeature optional

Feature of the image to query

Feature of the image to query.

classification ImageClassification optional

Classification of the image to query

Classification of the image to query.

id string

ID of the image to get

ID of the image to get.

image Image

Image the image

Image the image.

string

OS for which the latest image should be fetched -should contain os and major.minor then latest patch version of this os is returned

OS for which the latest image should be fetched. +Should contain os and major.minor then latest patch version of this os is returned.

classification ImageClassification optional

Classification of the image latest image

Classification of the image latest image.

image Image

Image which is the latest for one os

Image which is the latest for one os.

Image repeated

Images the images

Images the images.

image Image

Image with usage

Image with usage.

used_by string repeated

UsedBy the following machines/firewalls

UsedBy the following machines/firewalls.

@@ -7364,7 +7364,7 @@

ImageClassification

NameNumberDescription

ImageFeature

-

ImageFeature

+

ImageFeature.

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

ImageServiceDeleteRequest

- + @@ -7547,7 +7547,7 @@

ImageServiceUpdateRequest

- + @@ -7561,35 +7561,35 @@

ImageServiceUpdateRequest

- + - + - + - + - + @@ -7603,7 +7603,7 @@

ImageServiceUpdateRequest

- + @@ -7753,14 +7753,14 @@

IP

- + - + @@ -7774,14 +7774,14 @@

IP

- + - + @@ -7802,7 +7802,7 @@

IP

- + @@ -7810,7 +7810,7 @@

IP

+Will be equal with project most of the time.

@@ -7834,7 +7834,7 @@

IPQuery

- + @@ -7848,42 +7848,42 @@

IPQuery

- + - + - + - + - + - + @@ -7935,56 +7935,56 @@

IPServiceCreateRequest

- + - + - + - + - + - + - + - + @@ -8008,7 +8008,7 @@

IPServiceCreateResponse

- + @@ -8032,14 +8032,14 @@

IPServiceDeleteRequest

- + - + @@ -8063,7 +8063,7 @@

IPServiceDeleteResponse

- + @@ -8087,14 +8087,14 @@

IPServiceGetRequest

- + - + @@ -8125,7 +8125,7 @@

IPServiceGetResponse

- + @@ -8149,7 +8149,7 @@

IPServiceListRequest

- + @@ -8180,7 +8180,7 @@

IPServiceListResponse

- + @@ -8204,7 +8204,7 @@

IPServiceUpdateRequest

- + @@ -8218,35 +8218,35 @@

IPServiceUpdateRequest

- + - + - + - + - + @@ -8270,7 +8270,7 @@

IPServiceUpdateResponse

- + @@ -8481,7 +8481,7 @@

metalstack/api/v2/network.proto

ChildPrefixLength -

ChildPrefixLength

+

ChildPrefixLength.

NameNumberDescription
id string

ID of the image to delete

ID of the image to delete.

id string

Id of this image

Id of this image.

url string optional

URL where this image is located

URL where this image is located.

name string optional

Name of this image

Name of this image.

description string optional

Description of this image

Description of this image.

features metalstack.api.v2.ImageFeature repeated

Features of this image

Features of this image.

classification metalstack.api.v2.ImageClassification

Classification of this image

Classification of this image.

labels metalstack.api.v2.UpdateLabels optional

Labels to update on this image

Labels to update on this image.

uuid string

Uuid of this ip

Uuid of this ip.

meta Meta

Meta for this ip

Meta for this ip.

name string

Name of this ip

Name of this ip.

description string

Description of this ip

Description of this ip.

type IPType

Type of this ip

Type of this ip.

string optional

Namespace if specified this ip is from a namespaced network and can therefore overlap with others. -Will be equal with project most of the time

ip string optional

Ip the ip to list

Ip the ip to list.

project string optional

Project of the ips to list

Project of the ips to list.

name string optional

Name of this ip

Name of this ip.

uuid string optional

UUID for which these IPs should be filtered

UUID for which these IPs should be filtered.

machine string optional

Machine for which these IPs should be filtered

Machine for which these IPs should be filtered.

parent_prefix_cidr string optional

ParentPrefixCidr for which this ips should get filtered

ParentPrefixCidr for which this ips should get filtered.

labels Labels optional

Labels for which these IPs should be filtered

Labels for which these IPs should be filtered.

project string

Project of the ip

Project of the ip.

name string optional

Name of the ip

Name of the ip.

description string optional

Description of the ip

Description of the ip.

ip string optional

IP if given try to create this ip if still available

IP if given try to create this ip if still available.

machine string optional

Machine for which this ip should get created

Machine for which this ip should get created.

labels Labels optional

Labels to put onto the ip

Labels to put onto the ip.

type IPType optional

Type of the IP, ether ephemeral (default), or static

Type of the IP, ether ephemeral (default), or static.

address_family IPAddressFamily optional

Addressfamily of the IP to create, defaults to ipv4

Addressfamily of the IP to create, defaults to ipv4.

ip IP

Ip the ip

Ip the ip.

ip string

IP of the ip to delete

IP of the ip to delete.

project string

Project of the ip

Project of the ip.

ip IP

Ip the ip

Ip the ip.

ip string

IP of the ip to get

IP of the ip to get.

project string

Project of the ip

Project of the ip.

ip IP

Ip the ip

Ip the ip.

project string

Project of the ips to list

Project of the ips to list.

ips IP repeated

Ips the ips

Ips the ips.

ip string

Ip the ip address to update

Ip the ip address to update.

project string

Project id of the ip

Project id of the ip.

name string optional

Name of this ip

Name of this ip.

description string optional

Description of this ip

Description of this ip.

type IPType optional

Type of this ip

Type of this ip.

labels UpdateLabels optional

Labels on this ip

Labels on this ip.

ip IP

Ip the ip

Ip the ip.

@@ -8494,14 +8494,14 @@

ChildPrefixLength

 - + - + @@ -8512,7 +8512,7 @@

ChildPrefixLength

Network

-

Network

+

Network.

ipv4 uint32 optional

IPv4 bit length of this network in this addressfamily

IPv4 bit length of this network in this addressfamily.

ipv6 uint32 optional

IPv6 bit length of this network in this addressfamily

IPv6 bit length of this network in this addressfamily.

@@ -8525,28 +8525,28 @@

Network

 - + - + - + - + @@ -8568,21 +8568,21 @@

Network

 +Will be equal with project most of the time.

- + - + @@ -8603,14 +8603,14 @@

Network

 - + - + @@ -8638,7 +8638,7 @@

Network

 - + @@ -8662,7 +8662,7 @@

NetworkConsumption

 - + @@ -8693,21 +8693,21 @@

NetworkQuery

 - + - + - + @@ -8735,14 +8735,14 @@

NetworkQuery

 - + - + @@ -8763,28 +8763,28 @@

NetworkQuery

 - + - + - + - + @@ -8795,7 +8795,7 @@

NetworkQuery

NetworkServiceCreateRequest

-

NetworkServiceCreateRequest

+

NetworkServiceCreateRequest.

id string

Id of this network

Id of this network.

meta Meta

Meta for this network

Meta for this network.

name string optional

Name of this network

Name of this network.

description string optional

Description of this network

Description of this network.

string optional

Namespace if specified, this network is namespaced and can therefore overlap with others. -Will be equal with project most of the time

prefixes string repeated

Prefixes in this network

Prefixes in this network.

destination_prefixes string repeated

Destination Prefixes in this network

Destination Prefixes in this network.

type NetworkType

Type of the network

Type of the network.

nat_type NATType

NATType of this network

NATType of this network.

consumption NetworkConsumption

Consumption of IPs and prefixes in this network

Consumption of IPs and prefixes in this network.

ipv4 NetworkUsage

IPv4 network usage

IPv4 network usage.

id string optional

Id of the network to query

Id of the network to query.

name string optional

Name of this network

Name of this network.

description string optional

Description of this network

Description of this network.

prefixes string repeated

Prefixes in this network

Prefixes in this network.

destination_prefixes string repeated

Destination Prefixes in this network

Destination Prefixes in this network.

address_family NetworkAddressFamily optional

Addressfamily to query

Addressfamily to query.

type NetworkType optional

Type of the network to query for

Type of the network to query for.

nat_type NATType optional

NATType configured

NATType configured.

labels Labels optional

Labels on this network

Labels on this network.

@@ -8815,14 +8815,14 @@

NetworkServiceCreateReque

- + - + @@ -8836,7 +8836,7 @@

NetworkServiceCreateReque

- + @@ -8850,14 +8850,14 @@

NetworkServiceCreateReque

- + - + @@ -8868,7 +8868,7 @@

NetworkServiceCreateReque

NetworkServiceCreateResponse

-

NetworkServiceCreateResponse

+

NetworkServiceCreateResponse.

name string optional

Name of this network

Name of this network.

description string optional

Description of this network

Description of this network.

labels Labels

Labels on this network

Labels on this network.

length ChildPrefixLength optional

Length per addressfamily

Length per addressfamily.

address_family NetworkAddressFamily optional

AddressFamily to create, defaults to the same as the parent

AddressFamily to create, defaults to the same as the parent.

@@ -8892,7 +8892,7 @@

NetworkServiceCreateResp

NetworkServiceDeleteRequest

-

NetworkServiceDeleteRequest

+

NetworkServiceDeleteRequest.

@@ -8905,14 +8905,14 @@

NetworkServiceDeleteReque

- + - + @@ -8923,7 +8923,7 @@

NetworkServiceDeleteReque

NetworkServiceDeleteResponse

-

NetworkServiceDeleteResponse

+

NetworkServiceDeleteResponse.

id string

ID of the network to get

ID of the network to get.

project string

Project of the network

Project of the network.

@@ -8947,7 +8947,7 @@

NetworkServiceDeleteResp

NetworkServiceGetRequest

-

NetworkServiceGetRequest

+

NetworkServiceGetRequest.

@@ -8960,14 +8960,14 @@

NetworkServiceGetRequest

id - + - + @@ -8978,7 +8978,7 @@

NetworkServiceGetRequest

NetworkServiceGetResponse -

NetworkServiceGetResponse

+

NetworkServiceGetResponse.

string

ID of the network to get

ID of the network to get.

project string

Project of the network

Project of the network.

@@ -8991,7 +8991,7 @@

NetworkServiceGetResponsenetwork

- + @@ -9002,7 +9002,7 @@

NetworkServiceGetResponseNetworkServiceListBaseNetworksRequest

-

NetworkServiceListRequest

+

NetworkServiceListRequest.

Network

Network which was requested to get

Network which was requested to get.

@@ -9015,7 +9015,7 @@

NetworkServiceL

- + @@ -9033,7 +9033,7 @@

NetworkServiceL

NetworkServiceListBaseNetworksResponse

-

NetworkServiceListResponse

+

NetworkServiceListResponse.

project string

Project of the base networks to list

Project of the base networks to list.

@@ -9057,7 +9057,7 @@

NetworkService

NetworkServiceListRequest

-

NetworkServiceListRequest

+

NetworkServiceListRequest.

@@ -9070,7 +9070,7 @@

NetworkServiceListRequestproject

- + @@ -9088,7 +9088,7 @@

NetworkServiceListRequestNetworkServiceListResponse

-

NetworkServiceListResponse

+

NetworkServiceListResponse.

string

Project of the networks to list

Project of the networks to list.

@@ -9112,7 +9112,7 @@

NetworkServiceListResponse

NetworkServiceUpdateRequest

-

NetworkServiceUpdateRequest

+

NetworkServiceUpdateRequest.

@@ -9125,7 +9125,7 @@

NetworkServiceUpdateReque

- + @@ -9139,28 +9139,28 @@

NetworkServiceUpdateReque

- + - + - + - + @@ -9171,7 +9171,7 @@

NetworkServiceUpdateReque

NetworkServiceUpdateResponse

-

NetworkServiceUpdateResponse

+

NetworkServiceUpdateResponse.

id string

ID of the network to get

ID of the network to get.

project string

Project of the network

Project of the network.

name string optional

Name of this network

Name of this network.

description string optional

Description of this network

Description of this network.

labels UpdateLabels optional

Labels on this network

Labels on this network.

@@ -9208,28 +9208,28 @@

NetworkUsage

 - + - + - + - + @@ -9264,7 +9264,7 @@

NATType

 - + @@ -9331,7 +9331,7 @@

NetworkType

 @@ -9448,7 +9448,7 @@

metalstack/api/v2/partition.proto

DNSServer -

DNSServer

+

DNSServer.

available_ips uint64

the total available IPs

the total available IPs.

used_ips uint64

the total used IPs

the total used IPs.

available_prefixes uint64

the total available 2-bit prefixes

the total available 2-bit prefixes.

used_prefixes uint64

the total used Prefixes

the total used Prefixes.

NAT_TYPE_IPV4_MASQUERADE 2

NAT_TYPE_IPV4_MASQUERADE masquerade ipv4 behind gateway ip when traffic enters this network

NAT_TYPE_IPV4_MASQUERADE masquerade ipv4 behind gateway ip when traffic enters this network.
NETWORK_TYPE_UNDERLAY 2

NETWORK_TYPE_UNDERLAY indicates a underlay network. -The underlay network connects all switches and the firewalls to build a EVPN dataplane +The underlay network connects all switches and the firewalls to build a EVPN dataplane. It is not project scoped. Is part of the dataplane and reserved for administrative purposes.
@@ -9461,7 +9461,7 @@

DNSServer

 - + @@ -9472,7 +9472,7 @@

DNSServer

NTPServer

-

NTPServer

+

NTPServer.

ip string

IP address of this dns server

IP address of this dns server.

@@ -9485,7 +9485,7 @@

NTPServer

 - + @@ -9509,21 +9509,21 @@

Partition

 - + - + - + @@ -9537,14 +9537,14 @@

Partition

 - + - + @@ -9552,7 +9552,7 @@

Partition

 +should be in the form <ip|host>:<port>.

@@ -9576,21 +9576,21 @@

PartitionBootConfiguration

- + - + - + @@ -9614,7 +9614,7 @@

PartitionQuery

 - + @@ -9645,7 +9645,7 @@

PartitionServiceGetRequest

- + @@ -9768,7 +9768,7 @@

metalstack/api/v2/size.proto

Size -

Size

+

Size.

address string

Address either as ip or hostname

Address either as ip or hostname.

id string

ID of this partition

ID of this partition.

meta Meta

Meta for this partition

Meta for this partition.

description string

Description of this partition

Description of this partition.

dns_servers DNSServer repeated

DNSServers for this partition

DNSServers for this partition.

ntp_servers NTPServer repeated

NTPServers for this partition

NTPServers for this partition.

string repeated

ManagementServiceAddresses defines where the management is reachable. -should be in the form <ip|host>:<port>

image_url string

ImageURL the url to download the initrd for the boot image

ImageURL the url to download the initrd for the boot image.

kernel_url string

KernelURL the url to download the kernel for the boot image

KernelURL the url to download the kernel for the boot image.

commandline string

Commandline the kernel command line for the boot image

Commandline the kernel command line for the boot image.

id string optional

ID of the partition to get

ID of the partition to get.

id string

ID of the partition to get

ID of the partition to get.

@@ -9781,35 +9781,35 @@

Size

 - + - + - + - + - + @@ -9833,21 +9833,21 @@

SizeConstraint

 - + - + - + @@ -9878,21 +9878,21 @@

SizeQuery

 - + - + - + @@ -9923,7 +9923,7 @@

SizeServiceGetRequest

 - + @@ -9947,7 +9947,7 @@

SizeServiceGetResponse

 - + @@ -9995,7 +9995,7 @@

SizeServiceListResponse

 - + @@ -10018,7 +10018,7 @@

SizeConstraintType

 - + @@ -10100,28 +10100,28 @@

FirewallEgressRule

 - + - + - + - + @@ -10145,35 +10145,35 @@

FirewallIngressRule

 - + - + - + - + - + @@ -10228,7 +10228,7 @@

FirewallSpec

 - + @@ -10252,21 +10252,21 @@

Machine

 - + - + - + @@ -10287,21 +10287,21 @@

Machine

 - + - + - + @@ -10339,63 +10339,63 @@

MachineAllocation

 - + - + - + - + - + - + - + - + - @@ -10403,14 +10403,14 @@

MachineAllocation

 - + - + @@ -10418,42 +10418,42 @@

MachineAllocation

 +AWS limits the max userdata size to 16k, lets allow twice as much.

- + - + - + - + - + @@ -10477,14 +10477,14 @@

MachineAllocationNetwork

network - + - @@ -10497,7 +10497,7 @@

MachineAllocationNetwork

MachineAllocationQuery -

MachineAllocationQuery allocation specific query parameters

+

MachineAllocationQuery allocation specific query parameters.

id string

Id of this size

Id of this size.

meta Meta

Meta for this size

Meta for this size.

name string optional

Name of this size

Name of this size.

description string optional

Description of this size

Description of this size.

constraints SizeConstraint repeated

Constraints which must match that a specific machine is considered of this size

Constraints which must match that a specific machine is considered of this size.

type SizeConstraintType

Type a machine matches to a size in order to make them easier to categorize

Type a machine matches to a size in order to make them easier to categorize.

min uint64

Min the minimum value of the constraint

Min the minimum value of the constraint.

max uint64

Max the maximum value of the constraint

Max the maximum value of the constraint.

id string optional

ID of the size to get

ID of the size to get.

name string optional

Name of the size to query

Name of the size to query.

description string optional

Description of the size to query

Description of the size to query.

id string

ID of the size to get

ID of the size to get.

size Size

Size the size

Size the size.

sizes Size repeated

Sizes the sizes

Sizes the sizes.

SIZE_CONSTRAINT_TYPE_UNSPECIFIED 0

SIZE_CONSTRAINT_TYPE_UNSPECIFIED type is not specified

SIZE_CONSTRAINT_TYPE_UNSPECIFIED type is not specified.
protocol IPProtocol

Protocol the protocol for the rule, defaults to tcp

Protocol the protocol for the rule, defaults to tcp.

ports uint32 repeated

Ports the ports affected by this rule

Ports the ports affected by this rule.

to string repeated

To the destination cidrs affected by this rule

To the destination cidrs affected by this rule.

comment string

Comment for this rule

Comment for this rule.

protocol IPProtocol

Protocol the protocol for the rule, defaults to tcp

Protocol the protocol for the rule, defaults to tcp.

ports uint32 repeated

Ports the ports affected by this rule

Ports the ports affected by this rule.

to string repeated

To the destination cidrs affected by this rule

To the destination cidrs affected by this rule.

from string repeated

From the source cidrs affected by this rule

From the source cidrs affected by this rule.

comment string

Comment for this rule

Comment for this rule.

firewall_rules FirewallRules

FirewallRules to be applied if this is a firewall

FirewallRules to be applied if this is a firewall.

uuid string

UUID of this machine

UUID of this machine.

meta Meta

Meta for this machine

Meta for this machine.

partition Partition

Partition where this machine resides

Partition where this machine resides.

size Size

Size of this machine

Size of this machine.

hardware MachineHardware

Hardware specs of this machine

Hardware specs of this machine.

allocation MachineAllocation

Allocation details

Allocation details.

uuid string

UUID of this machine allocation

UUID of this machine allocation.

meta Meta

Meta for this machine allocation

Meta for this machine allocation.

name string

Name of this allocation

Name of this allocation.

description string

Description of this allocation

Description of this allocation.

created_by string

Created By indicates who created this machine allocation

Created By indicates who created this machine allocation.

project string

Project of the allocation

Project of the allocation.

image Image

Image to be used to install on this machine

Image to be used to install on this machine.

filesystem_layout FilesystemLayout

FilesystemLayout to create on the disks

FilesystemLayout to create on the disks.

networks MachineNetwork repeated

Networks this machine should be attached to +

Networks this machine should be attached to. Order of ips of external networks will be preserved.

hostname string

Hostname of the allocated machine

Hostname of the allocated machine.

ssh_public_keys string repeated

SSHPublicKeys which should be installed on this machine

SSHPublicKeys which should be installed on this machine.

string

Userdata contains instructions required to bootstrap the machine. -AWS limits the max userdata size to 16k, lets allow twice as much

allocation_type MachineAllocationType

AllocationType of this machine

AllocationType of this machine.

firewall_rules FirewallRules

FirewallRules to be applied if this is a firewall

FirewallRules to be applied if this is a firewall.

dns_servers DNSServer repeated

DNSServers for this machine

DNSServers for this machine.

ntp_servers NTPServer repeated

NTPServers for this machine

NTPServers for this machine.

vpn MachineVPN

VPN connection configuration

VPN connection configuration.

string

Network the id of the network that this machine will be placed in

Network the id of the network that this machine will be placed in.

ips string repeated

IPs to to attach to this machine additionally +

IPs to to attach to this machine additionally. If none given, one ip address is acquired per network for the machine. Order of ips is preserved on the loopback interface.

@@ -10510,63 +10510,63 @@

MachineAllocationQuery

 - + - + - + - + - + - + - + - + - + @@ -10590,49 +10590,49 @@

MachineBMC

 - + - + - + - + - + - + - + @@ -10643,7 +10643,7 @@

MachineBMC

MachineBMCQuery

-

MachineBMCQuery machine ipmi or bmc specific machine queries

+

MachineBMCQuery machine ipmi or bmc specific machine queries.

uuid string optional

UUID of the allocation of the machine to get

UUID of the allocation of the machine to get.

name string optional

Name of the machine to get

Name of the machine to get.

project string optional

Project of the machine to get

Project of the machine to get.

image string optional

Image of the machine to get

Image of the machine to get.

filesystem_layout string optional

FilesystemLayout of the machine to get

FilesystemLayout of the machine to get.

hostname string optional

Hostname of the machine to get

Hostname of the machine to get.

allocation_type MachineAllocationType optional

AllocationType of this machine

AllocationType of this machine.

labels Labels optional

Labels for which this machine allocation should get filtered

Labels for which this machine allocation should get filtered.

vpn MachineVPN optional

VPN query if this machine has a vpn configuration

VPN query if this machine has a vpn configuration.

address string

Address of this ipmi device from outside in the form of <ip or hostname>:<port>

Address of this ipmi device from outside in the form of <ip or hostname>:<port>.

mac string

Mac address of the network interface of this ipmi device

Mac address of the network interface of this ipmi device.

user string

User of this ipmi device

User of this ipmi device.

password string

Password of this ipmi device

Password of this ipmi device.

interface string

Interface of this ipmi device

Interface of this ipmi device.

version string

Version of this bmc device

Version of this bmc device.

power_state string

PowerState of this machine

PowerState of this machine.

@@ -10656,28 +10656,28 @@

MachineBMCQuery

 - + - + - + - + @@ -10767,21 +10767,21 @@

MachineBios

 - + - + - + @@ -10805,14 +10805,14 @@

MachineBlockDevice

 - + - + @@ -10836,14 +10836,14 @@

MachineChassisIdentify

- + - + @@ -10867,21 +10867,21 @@

MachineCondition

 - + - + - + @@ -10892,7 +10892,7 @@

MachineCondition

MachineDiskQuery

-

MachineDiskQuery disk specific machine queries

+

MachineDiskQuery disk specific machine queries.

address string optional

Address of the ipmi system of this machine

Address of the ipmi system of this machine.

mac string optional

Mac of the ipmi system of this machine

Mac of the ipmi system of this machine.

user string optional

User of the ipmi system of this machine

User of the ipmi system of this machine.

interface string optional

Interface of the ipmi system of this machine

Interface of the ipmi system of this machine.

version string

Version the bios version

Version the bios version.

vendor string

Vendor the bios vendor

Vendor the bios vendor.

date string

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

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

name string

Name of this block device

Name of this block device.

size uint64

Size of this block device in bytes

Size of this block device in bytes.

value string

Value the state of this chassis identify LED. empty means LED-OFF

Value the state of this chassis identify LED. empty means LED-OF.

description string

Description a description why this chassis identify LED is in the given state

Description a description why this chassis identify LED is in the given state.

state MachineState

State the state of this machine. empty means available for all

State the state of this machine. empty means available for al.

description string

Description a description why this machine is in the given state

Description a description why this machine is in the given state.

issuer string

Issuer the user that changed the state

Issuer the user that changed the state.

@@ -10905,14 +10905,14 @@

MachineDiskQuery

 - + - + @@ -10996,7 +10996,7 @@

MachineFRU

MachineFRUQuery

-

MachineFRUQuery machine fru specific machine queries

+

MachineFRUQuery machine fru specific machine queries.

names string repeated

Names of disks in this machine

Names of disks in this machine.

sizes uint64 repeated

Sizes of disks in this machine

Sizes of disks in this machine.

@@ -11009,56 +11009,56 @@

MachineFRUQuery

 - + - + - + - + - + - + - + - + @@ -11082,35 +11082,35 @@

MachineHardware

 - + - + - + - + - + @@ -11121,7 +11121,7 @@

MachineHardware

MachineHardwareQuery

-

MachineHardwareQuery machine hardware specific machine queries

+

MachineHardwareQuery machine hardware specific machine queries.

chassis_part_number string optional

ChassisPartNumber of this machine

ChassisPartNumber of this machine.

chassis_part_serial string optional

ChassisPartSerial of this machine

ChassisPartSerial of this machine.

board_mfg string optional

BoardMFG of this machine

BoardMFG of this machine.

board_serial string optional

BoardSerial of this machine

BoardSerial of this machine.

board_part_number string optional

BoardPartNumber of this machine

BoardPartNumber of this machine.

product_manufacturer string optional

ProductManufacturer of this machine

ProductManufacturer of this machine.

product_part_number string optional

ProductPartNumber of this machine

ProductPartNumber of this machine.

product_serial string optional

ProductSerial of this machine

ProductSerial of this machine.

memory uint64

Memory the total memory of the machine in bytes

Memory the total memory of the machine in bytes.

disks MachineBlockDevice repeated

Disks the list of block devices of this machine

Disks the list of block devices of this machine.

cpus MetalCPU repeated

CPUs the cpu details

CPUs the cpu details.

gpus MetalGPU repeated

GPUs the gpu details

GPUs the gpu details.

nics MachineNic repeated

Nics the list of network interfaces of this machine

Nics the list of network interfaces of this machine.

@@ -11134,14 +11134,14 @@

MachineHardwareQuery

 - + - + @@ -11165,7 +11165,7 @@

MachineIssue

 - + @@ -11217,14 +11217,14 @@

MachineIssues

 - + - + @@ -11248,7 +11248,7 @@

MachineIssuesQuery

 - + @@ -11262,7 +11262,7 @@

MachineIssuesQuery

 - + @@ -11300,14 +11300,14 @@

MachineNetwork

 - + - + @@ -11321,14 +11321,14 @@

MachineNetwork

 - + - + @@ -11342,14 +11342,14 @@

MachineNetwork

 - + - + @@ -11367,7 +11367,7 @@

MachineNetwork

MachineNetworkQuery

-

MachineNetworkQuery network specific machine queries

+

MachineNetworkQuery network specific machine queries.

memory uint64 optional

Memory the total memory of the machine in bytes

Memory the total memory of the machine in bytes.

cpu_cores uint32 optional

CPUCores the number of cpu cores

CPUCores the number of cpu cores.

type MachineIssueType

Type specifies the issue type (id)

Type specifies the issue type (id).

uuid string

UUID of the machine for which the issues are listed

UUID of the machine for which the issues are listed.

issues MachineIssue repeated

Issues of this machine

Issues of this machine.

machine_query MachineQuery

MachineQuery to select specific machines

MachineQuery to select specific machines.

omit MachineIssueType repeated

Omits the specified machine issues

Omits the specified machine issues.

network string

Network the networkID of the allocated machine in this vrf

Network the networkID of the allocated machine in this vrf.

prefixes string repeated

Prefixes the prefixes of this network

Prefixes the prefixes of this network.

ips string repeated

IPs the ip addresses of the allocated machine in this vrf

IPs the ip addresses of the allocated machine in this vrf.

network_type NetworkType

NetworkType the type of network of this vrf

NetworkType the type of network of this vrf.

vrf uint64

VRF the vrf id

VRF the vrf id.

asn uint32

ASN the autonomous system number for this network

ASN the autonomous system number for this network.

@@ -11380,42 +11380,42 @@

MachineNetworkQuery

 - + - + - + - + - + - + @@ -11439,56 +11439,56 @@

MachineNic

 - + - + - + - + - + - + - + - + @@ -11499,7 +11499,7 @@

MachineNic

MachineNicQuery

-

MachineNicQuery nic specific machine queries

+

MachineNicQuery nic specific machine queries.

networks string repeated

Networks this machine is connected to

Networks this machine is connected to.

prefixes string repeated

Prefixes this machine is connected to

Prefixes this machine is connected to.

destination_prefixes string repeated

DestinationPrefixes this machine is connected to

DestinationPrefixes this machine is connected to.

ips string repeated

IPs this machine has

IPs this machine has.

vrfs uint64 repeated

VRFs this machine is connected to

VRFs this machine is connected to.

asns uint32 repeated

ASNs this machine is connected to

ASNs this machine is connected to.

mac string

Mac the macaddress of this interface

Mac the macaddress of this interface.

name string

Name of this interface

Name of this interface.

identifier string

Identifier the unique identifier of this network interface

Identifier the unique identifier of this network interface.

vendor string

Vendor of this network card

Vendor of this network card.

model string

Model of this network card

Model of this network card.

speed uint64

Speed in bits/second of this network card

Speed in bits/second of this network card.

neighbors MachineNic repeated

Neighbors the neighbors visible to this network interface

Neighbors the neighbors visible to this network interface.

hostname string

Hostname the nic belongs to

Hostname the nic belongs to.

@@ -11512,28 +11512,28 @@

MachineNicQuery

 - + - + - + - + @@ -11557,18 +11557,14 @@

MachinePowerMetric

 - + - @@ -11576,18 +11572,14 @@

MachinePowerMetric

 - + - + @@ -11611,14 +11603,14 @@

MachinePowerSupply

 - + - + @@ -11642,21 +11634,21 @@

MachineProvisioningEvent

time - + - + - + @@ -11680,105 +11672,105 @@

MachineQuery

 - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -11813,7 +11805,7 @@

MachineQuery

MachineRecentProvisioningEvents

-

MachineRecentProvisioningEvents the recent provisioning events for this machine

+

MachineRecentProvisioningEvents the recent provisioning events for this machine.

macs string repeated

Macs this machine nic has

Macs this machine nic has.

names string repeated

Names this machine nic has

Names this machine nic has.

neighbor_macs string repeated

NeighborMacs this machine nic has

NeighborMacs this machine nic has.

neighbor_names string repeated

NeighborNames this machine nic has

NeighborNames this machine nic has.

average_consumed_watts float

AverageConsumedWatts shall represent the -average power level that occurred averaged over the last IntervalInMin -minutes.

AverageConsumedWatts shall represent the average power level that occurred averaged over the last IntervalInMin minutes.

interval_in_min float

IntervalInMin shall represent the time -interval (or window), in minutes, in which the PowerMetrics properties -are measured over. +

IntervalInMin shall represent the time interval (or window), in minutes, in which the PowerMetrics properties are measured over. Should be an integer, but some Dell implementations return as a float.

max_consumed_watts float

MaxConsumedWatts shall represent the -maximum power level in watts that occurred within the last -IntervalInMin minutes.

MaxConsumedWatts shall represent the maximum power level in watts that occurred within the last IntervalInMin minutes.

min_consumed_watts float

MinConsumedWatts shall represent the -minimum power level in watts that occurred within the last -IntervalInMin minutes.

MinConsumedWatts shall represent the minimum power level in watts that occurred within the last IntervalInMin minutes.

health string

Health of the powersupply

Health of the powersupply.

state string

State of the powersupply

State of the powersupply.

google.protobuf.Timestamp

Time the time that this event was received

Time the time that this event was received.

event MachineProvisioningEventType

Event the event emitted by the machine

Event the event emitted by the machine.

message string

Message an additional message to add to the event

Message an additional message to add to the event.

uuid string optional

UUID of the machine to get

UUID of the machine to get.

name string optional

Name of the machine to get

Name of the machine to get.

partition string optional

Partition of the machine to get

Partition of the machine to get.

size string optional

Size of the machine to get

Size of the machine to get.

rack string optional

Rack of the machine to get

Rack of the machine to get.

room string optional

Room of the machine to get

Room of the machine to get.

labels Labels optional

Labels for which this machine should get filtered

Labels for which this machine should get filtered.

allocation MachineAllocationQuery optional

Allocation specific machine queries

Allocation specific machine queries.

network MachineNetworkQuery optional

Network specific machine queries

Network specific machine queries.

nic MachineNicQuery optional

Nic specific machine queries

Nic specific machine queries.

disk MachineDiskQuery optional

Disk specific machine queries

Disk specific machine queries.

bmc MachineBMCQuery optional

Bmc specific machine queries

Bmc specific machine queries.

fru MachineFRUQuery optional

Fru specific machine queries

Fru specific machine queries.

hardware MachineHardwareQuery optional

Hardware specific machine query

Hardware specific machine query.

state MachineState optional

State this machine has

State this machine has.

@@ -11826,21 +11818,21 @@

MachineRecentProvisio

- + - + - + @@ -11871,21 +11863,21 @@

MachineServiceBMCComm

- + - + - + @@ -11916,7 +11908,7 @@

MachineServiceCreateReque

- + @@ -11925,64 +11917,64 @@

MachineServiceCreateReque

+Can only be used with ADMIN_ROLE_EDITOR.

- + - + - + - + - + - + - +Can be specified to test new fsls during development of fsls.

@@ -11997,14 +11989,14 @@

MachineServiceCreateReque

+AWS limits the max userdata size to 16k, lets allow twice as much.

- + @@ -12019,28 +12011,28 @@

MachineServiceCreateReque

+if placement tags are provided, the machine candidate has an additional anti-affinity to other machines having the same tags.

- + - + - + @@ -12071,7 +12063,7 @@

MachineServiceCreateResp

- + @@ -12095,14 +12087,14 @@

MachineServiceDeleteReque

- + - + @@ -12126,7 +12118,7 @@

MachineServiceDeleteResp

- + @@ -12150,14 +12142,14 @@

MachineServiceGetBMCReque

- + - + @@ -12181,7 +12173,7 @@

MachineServiceGetBMCResp

- + @@ -12212,14 +12204,14 @@

MachineServiceGetRequest

uuid - + - + @@ -12267,7 +12259,7 @@

MachineServiceListRequestproject

- + @@ -12322,7 +12314,7 @@

MachineServiceUpdateReque

- + @@ -12336,28 +12328,28 @@

MachineServiceUpdateReque

- + - + - + - + @@ -12381,7 +12373,7 @@

MachineServiceUpdateResp

- + @@ -12419,14 +12411,14 @@

MachineStatus

 - + - + @@ -12450,14 +12442,14 @@

MachineVPN

 - + - + @@ -12471,7 +12463,7 @@

MachineVPN

 - + @@ -12495,28 +12487,28 @@

MetalCPU

 - + - + - + - + @@ -12540,14 +12532,14 @@

MetalGPU

 - + - + @@ -12658,43 +12650,43 @@

MachineBMCCommand

 - + - + - + - + - + - + - + @@ -12711,25 +12703,25 @@

MachineIssueSeverity

 - + - + - + - + @@ -12746,85 +12738,85 @@

MachineIssueType

 - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -12847,26 +12839,26 @@

MachineLiveliness

 - + - + - +
events MachineProvisioningEvent repeated

Events the log of recent machine provisioning events

Events the log of recent machine provisioning events.

last_event_time google.protobuf.Timestamp

LastEventTime the time where the last event was received

LastEventTime the time where the last event was received.

last_error_event MachineProvisioningEvent

LastErrorEvent the last erroneous event received

LastErrorEvent the last erroneous event received.

uuid string

UUID of the machine to send the command to

UUID of the machine to send the command to.

project string

Project of the machine

Project of the machine.

command MachineBMCCommand

Command to send to the bmc of the machine

Command to send to the bmc of the machine.

project string

Project of the machine

Project of the machine.

optional

UUID if this field is set, this specific machine will be allocated if it is not in available state and not currently allocated. this field takes precedence over size and partition. -Can only be used with ADMIN_ROLE_EDITOR

name string

Name of this machine

Name of this machine.

description string optional

Description for this machine

Description for this machine.

hostname string optional

Hostname the hostname for the allocated machine (defaults to metal)

Hostname the hostname for the allocated machine (defaults to metal).

partition string optional

Partition the partition id to assign this machine to, must be omitted if uuid is given

Partition the partition id to assign this machine to, must be omitted if uuid is given.

size string optional

Size of the machine to create, must be omitted if uuid is given

Size of the machine to create, must be omitted if uuid is given.

image string

Image which should be installed on this machine -The image can be specified either in the fully qualified form, e.g. including os, major, minor and patch. -- debian-13.0.20260402 -or in a simplified form which omits the patch version -- debian-13.0 -If the fully qualified form is specified, exactly this image is taken regardless of the image classification -if the short form is given, only the most recent images which has image classification supported is used.

Image which should be installed on this machine. +The image can be specified either in the fully qualified form, e.g. including os, major, minor and patch +- debian-13.0.2026040 +- or in a simplified form which omits the patch version. +- debian-13. +If the fully qualified form is specified, exactly this image is taken regardless of the image classification. +If the short form is given, only the most recent images which has image classification supported is used.

filesystem_layout string optional

FilesystemLayout which should be applied for the operating system installation +

FilesystemLayout which should be applied for the operating system installation. Is defaulted by a lookup at the available fsls for this size and image. -Can be specified to test new fsls during development of fsls

string optional

Userdata contains instructions required to bootstrap the machine. -AWS limits the max userdata size to 16k, lets allow twice as much

labels Labels

Labels to be attached to this machine allocation

Labels to be attached to this machine allocation.

string repeated

PlacementTags by default machines are spread across the racks inside a partition for every project. -if placement tags are provided, the machine candidate has an additional anti-affinity to other machines having the same tags

dns_servers DNSServer repeated

DNSServer the dns servers used for the machine

DNSServer the dns servers used for the machine.

ntp_servers NTPServer repeated

NTPServer the ntp servers used for the machine

NTPServer the ntp servers used for the machine.

allocation_type MachineAllocationType

AllocationType of this machine

AllocationType of this machine.

machine Machine

Machine which was created

Machine which was created.

uuid string

UUID of the machine to delete

UUID of the machine to delete.

project string

Project of the machine

Project of the machine.

machine Machine

Machine which was deleted

Machine which was deleted.

uuid string

UUID of the machine to get

UUID of the machine to get.

project string

Project of the machine

Project of the machine.

uuid string

UUID of the machine

UUID of the machine.

string

UUID of the machine to get

UUID of the machine to get.

project string

Project of the machine

Project of the machine.

string

Project of the machines to list

Project of the machines to list.

uuid string

UUID of the machine to modify

UUID of the machine to modify.

project string

Project of the machine

Project of the machine.

description string optional

Description of this machine allocation

Description of this machine allocation.

labels UpdateLabels optional

Labels to update on this machine allocation

Labels to update on this machine allocation.

ssh_public_keys string repeated

SSHPublicKeys which should be update of this machine allocation

SSHPublicKeys which should be update of this machine allocation.

machine Machine

Machine which was updated

Machine which was updated.

liveliness MachineLiveliness

Liveliness of this machine

Liveliness of this machine.

metal_hammer_version string

MetalHammerVersion the version of metal hammer which put the machine in waiting state

MetalHammerVersion the version of metal hammer which put the machine in waiting state.

control_plane_address string

Address of VPN control plane

Address of VPN control plane.

auth_key string

Auth key used to connect to VPN

Auth key used to connect to VPN.

ips string repeated

IPs of the machine connected to the vpn

IPs of the machine connected to the vpn.

vendor string

Vendor of this cpu

Vendor of this cpu.

model string

Model of this cpu

Model of this cpu.

cores uint32

Cores of this cpu

Cores of this cpu.

threads uint32

Threads of this cpu

Threads of this cpu.

vendor string

Vendor of this gpu

Vendor of this gpu.

model string

Model of this gpu

Model of this gpu.

MACHINE_BMC_COMMAND_BOOT_TO_BIOS 5

MACHINE_BMC_COMMAND_BOOT_TO_BIOS boot the machine into bios

MACHINE_BMC_COMMAND_BOOT_TO_BIOS boot the machine into bios.
MACHINE_BMC_COMMAND_BOOT_FROM_DISK 6

MACHINE_BMC_COMMAND_BOOT_FROM_DISK boot the machine from hard disk

MACHINE_BMC_COMMAND_BOOT_FROM_DISK boot the machine from hard disk.
MACHINE_BMC_COMMAND_BOOT_FROM_PXE 7

MACHINE_BMC_COMMAND_BOOT_FROM_PXE boot the machine from pxe

MACHINE_BMC_COMMAND_BOOT_FROM_PXE boot the machine from pxe.
MACHINE_BMC_COMMAND_IDENTIFY_LED_ON 8

MACHINE_BMC_COMMAND_IDENTIFY_LED_ON set identify led of the machine chassis to on

MACHINE_BMC_COMMAND_IDENTIFY_LED_ON set identify led of the machine chassis to on.
MACHINE_BMC_COMMAND_IDENTIFY_LED_OFF 9

MACHINE_BMC_COMMAND_IDENTIFY_LED_OFF set identify led of the machine chassis to off

MACHINE_BMC_COMMAND_IDENTIFY_LED_OFF set identify led of the machine chassis to off.
MACHINE_BMC_COMMAND_MACHINE_DELETED 10

MACHINE_BMC_COMMAND_MACHINE_DELETED should be called if the machine was deleted to power cycle and boot into pxe

MACHINE_BMC_COMMAND_MACHINE_DELETED should be called if the machine was deleted to power cycle and boot into pxe.
MACHINE_BMC_COMMAND_MACHINE_CREATED 11

MACHINE_BMC_COMMAND_MACHINE_CREATED should be called if the machine was created to set the boot order to boot from disk

MACHINE_BMC_COMMAND_MACHINE_CREATED should be called if the machine was created to set the boot order to boot from disk.
MACHINE_ISSUE_SEVERITY_UNSPECIFIED 0

MACHINE_ISSUE_SEVERITY_UNSPECIFIED severity is not specified

MACHINE_ISSUE_SEVERITY_UNSPECIFIED severity is not specified.
MACHINE_ISSUE_SEVERITY_MINOR 1

MACHINE_ISSUE_SEVERITY_MINOR machine issues is of severity minor

MACHINE_ISSUE_SEVERITY_MINOR machine issues is of severity minor.
MACHINE_ISSUE_SEVERITY_MAJOR 2

MACHINE_ISSUE_SEVERITY_MAJOR machine issues is of severity major

MACHINE_ISSUE_SEVERITY_MAJOR machine issues is of severity major.
MACHINE_ISSUE_SEVERITY_CRITICAL 3

MACHINE_ISSUE_SEVERITY_CRITICAL machine issues is of severity critical

MACHINE_ISSUE_SEVERITY_CRITICAL machine issues is of severity critical.
MACHINE_ISSUE_TYPE_UNSPECIFIED 0

MACHINE_ISSUE_TYPE_UNSPECIFIED type is not specified

MACHINE_ISSUE_TYPE_UNSPECIFIED type is not specified.
MACHINE_ISSUE_TYPE_ASN_UNIQUENESS 1

MACHINE_ISSUE_TYPE_ASN_UNIQUENESS machine asn is not unique

MACHINE_ISSUE_TYPE_ASN_UNIQUENESS machine asn is not unique.
MACHINE_ISSUE_TYPE_BMC_INFO_OUTDATED 2

MACHINE_ISSUE_TYPE_BMC_INFO_OUTDATED machine bmc info out of date

MACHINE_ISSUE_TYPE_BMC_INFO_OUTDATED machine bmc info out of date.
MACHINE_ISSUE_TYPE_BMC_NON_DISTINCT_IP 3

MACHINE_ISSUE_TYPE_BMC_NON_DISTINCT_IP machine bmc ip is not distinct

MACHINE_ISSUE_TYPE_BMC_NON_DISTINCT_IP machine bmc ip is not distinct.
MACHINE_ISSUE_TYPE_BMC_WITHOUT_IP 4

MACHINE_ISSUE_TYPE_BMC_WITHOUT_IP machine bmc without ip

MACHINE_ISSUE_TYPE_BMC_WITHOUT_IP machine bmc without ip.
MACHINE_ISSUE_TYPE_BMC_WITHOUT_MAC 5

MACHINE_ISSUE_TYPE_BMC_WITHOUT_MAC machine bmc without mac address

MACHINE_ISSUE_TYPE_BMC_WITHOUT_MAC machine bmc without mac address.
MACHINE_ISSUE_TYPE_CRASH_LOOP 6

MACHINE_ISSUE_TYPE_CRASH_LOOP machine is in crashloop

MACHINE_ISSUE_TYPE_CRASH_LOOP machine is in crashloop.
MACHINE_ISSUE_TYPE_FAILED_MACHINE_RECLAIM 7

MACHINE_ISSUE_TYPE_FAILED_MACHINE_RECLAIM machine was not freed after delete

MACHINE_ISSUE_TYPE_FAILED_MACHINE_RECLAIM machine was not freed after delete.
MACHINE_ISSUE_TYPE_LAST_EVENT_ERROR 8

MACHINE_ISSUE_TYPE_LAST_EVENT_ERROR machine last event error

MACHINE_ISSUE_TYPE_LAST_EVENT_ERROR machine last event error.
MACHINE_ISSUE_TYPE_LIVELINESS_DEAD 9

MACHINE_ISSUE_TYPE_LIVELINESS_DEAD machine is dead

MACHINE_ISSUE_TYPE_LIVELINESS_DEAD machine is dead.
MACHINE_ISSUE_TYPE_LIVELINESS_NOT_AVAILABLE 10

MACHINE_ISSUE_TYPE_LIVELINESS_NOT_AVAILABLE machine liveliness is not available

MACHINE_ISSUE_TYPE_LIVELINESS_NOT_AVAILABLE machine liveliness is not available.
MACHINE_ISSUE_TYPE_LIVELINESS_UNKNOWN 11

MACHINE_ISSUE_TYPE_LIVELINESS_UNKNOWN machine liveliness is unknown

MACHINE_ISSUE_TYPE_LIVELINESS_UNKNOWN machine liveliness is unknown.
MACHINE_ISSUE_TYPE_NO_EVENT_CONTAINER 12

MACHINE_ISSUE_TYPE_NO_EVENT_CONTAINER machine does not have a event container

MACHINE_ISSUE_TYPE_NO_EVENT_CONTAINER machine does not have a event container.
MACHINE_ISSUE_TYPE_NO_PARTITION 13

MACHINE_ISSUE_TYPE_NO_PARTITION no partition set

MACHINE_ISSUE_TYPE_NO_PARTITION no partition set.
MACHINE_LIVELINESS_ALIVE 1

MACHINE_LIVELINESS_ALIVE liveliness is alive

MACHINE_LIVELINESS_ALIVE liveliness is alive.
MACHINE_LIVELINESS_DEAD 2

MACHINE_LIVELINESS_DEAD liveliness is dead

MACHINE_LIVELINESS_DEAD liveliness is dead.
MACHINE_LIVELINESS_UNKNOWN 3

MACHINE_LIVELINESS_UNKNOWN liveliness is unknown

MACHINE_LIVELINESS_UNKNOWN liveliness is unknown.

MachineProvisioningEventState

-

MachineProvisioningEventState possible event states

+

MachineProvisioningEventState possible event states.

@@ -12882,13 +12874,13 @@

MachineProvisioningEven

- + - + @@ -12911,67 +12903,67 @@

MachineProvisioningEvent

- + - + - + - + - + - + - + - + - + - + - + @@ -12994,19 +12986,19 @@

MachineState

- + - + - + @@ -13099,14 +13091,14 @@

MachineServiceBMCCo

- + - + @@ -13137,7 +13129,7 @@

MachineService

- + @@ -13169,14 +13161,14 @@

MachineServic

- + - + @@ -13200,7 +13192,7 @@

MachineServiceDeleteReq

- + @@ -13248,7 +13240,7 @@

MachineServiceGetBMCReq

- + @@ -13272,7 +13264,7 @@

MachineServiceGetBMCRe

- + @@ -13303,7 +13295,7 @@

MachineServiceGetRequestuuid

- + @@ -13485,8 +13477,8 @@

MachineServiceListRequest

- + @@ -13534,7 +13526,7 @@

MachineServiceSetStat

- + @@ -13549,7 +13541,7 @@

MachineServiceSetStat

- + @@ -13686,21 +13678,21 @@

NetworkServiceCreateReq

- + - + - + @@ -13721,28 +13713,28 @@

NetworkServiceCreateReq

- + - + - + - + @@ -13763,14 +13755,14 @@

NetworkServiceCreateReq

- + - + @@ -13791,14 +13783,14 @@

NetworkServiceCreateReq

- + - + @@ -13846,7 +13838,7 @@

NetworkServiceDeleteReq

- + @@ -13894,7 +13886,7 @@

NetworkServiceGetRequestid

- + @@ -13990,7 +13982,7 @@

NetworkServiceUpdateReq

- + @@ -14004,35 +13996,35 @@

NetworkServiceUpdateReq

- + - + - + - + - + @@ -14053,7 +14045,7 @@

NetworkServiceUpdateReq

- + @@ -14241,7 +14233,7 @@

MachineSizeCapacity

- @@ -14332,21 +14324,21 @@

PartitionServiceCap

- + - + - + @@ -14394,7 +14386,7 @@

PartitionServiceCreat

- + @@ -14418,7 +14410,7 @@

PartitionServiceCrea

- + @@ -14442,7 +14434,7 @@

PartitionServiceDelet

- + @@ -14490,7 +14482,7 @@

PartitionServiceUpdat

- + @@ -14504,7 +14496,7 @@

PartitionServiceUpdat

- + @@ -14518,14 +14510,14 @@

PartitionServiceUpdat

- + - + @@ -14533,14 +14525,14 @@

PartitionServiceUpdat

+must be in the form <ip|host>:<port>.

- + @@ -14564,7 +14556,7 @@

PartitionServiceUpda

- + @@ -14629,7 +14621,7 @@

metalstack/api/v2/project.proto

Project -

Project defines a group of resources belonging to a tenant.

a tenant can have multiple projects

+

Project defines a group of resources belonging to a tenant.

a tenant can have multiple projects.

NameNumberDescription
MACHINE_PROVISIONING_EVENT_STATE_CRASHLOOP 1

MACHINE_PROVISIONING_EVENT_STATE_CRASHLOOP machine is in crash loop

MACHINE_PROVISIONING_EVENT_STATE_CRASHLOOP machine is in crash loop.
MACHINE_PROVISIONING_EVENT_STATE_FAILED_RECLAIM 2

MACHINE_PROVISIONING_EVENT_STATE_FAILED_RECLAIM machine is in failed reclaim

MACHINE_PROVISIONING_EVENT_STATE_FAILED_RECLAIM machine is in failed reclaim.
MACHINE_PROVISIONING_EVENT_TYPE_ALIVE 1

MACHINE_PROVISIONING_EVENT_TYPE_ALIVE machine is alive

MACHINE_PROVISIONING_EVENT_TYPE_ALIVE machine is alive.
MACHINE_PROVISIONING_EVENT_TYPE_CRASHED 2

MACHINE_PROVISIONING_EVENT_TYPE_CRASHED machine crashed

MACHINE_PROVISIONING_EVENT_TYPE_CRASHED machine crashed.
MACHINE_PROVISIONING_EVENT_TYPE_PXE_BOOTING 3

MACHINE_PROVISIONING_EVENT_TYPE_PXE_BOOTING machine is pxe booting into metal-hammer

MACHINE_PROVISIONING_EVENT_TYPE_PXE_BOOTING machine is pxe booting into metal-hammer.
MACHINE_PROVISIONING_EVENT_TYPE_PLANNED_REBOOT 4

MACHINE_PROVISIONING_EVENT_TYPE_PLANNED_REBOOT machine got a reboot instruction

MACHINE_PROVISIONING_EVENT_TYPE_PLANNED_REBOOT machine got a reboot instruction.
MACHINE_PROVISIONING_EVENT_TYPE_PREPARING 5

MACHINE_PROVISIONING_EVENT_TYPE_PREPARING metal-hammer is preparing the machine

MACHINE_PROVISIONING_EVENT_TYPE_PREPARING metal-hammer is preparing the machine.
MACHINE_PROVISIONING_EVENT_TYPE_REGISTERING 6

MACHINE_PROVISIONING_EVENT_TYPE_REGISTERING metal-hammer registers machine at the apiserver

MACHINE_PROVISIONING_EVENT_TYPE_REGISTERING metal-hammer registers machine at the apiserver.
MACHINE_PROVISIONING_EVENT_TYPE_WAITING 7

MACHINE_PROVISIONING_EVENT_TYPE_WAITING machine is waiting for installation

MACHINE_PROVISIONING_EVENT_TYPE_WAITING machine is waiting for installation.
MACHINE_PROVISIONING_EVENT_TYPE_INSTALLING 8

MACHINE_PROVISIONING_EVENT_TYPE_INSTALLING metal-hammer is installing the desired os

MACHINE_PROVISIONING_EVENT_TYPE_INSTALLING metal-hammer is installing the desired os.
MACHINE_PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL 9

MACHINE_PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL metal-hammer completed installation and boots into target os

MACHINE_PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL metal-hammer completed installation and boots into target os.
MACHINE_PROVISIONING_EVENT_TYPE_PHONED_HOME 10

MACHINE_PROVISIONING_EVENT_TYPE_PHONED_HOME machine is installed and phones home

MACHINE_PROVISIONING_EVENT_TYPE_PHONED_HOME machine is installed and phones home.
MACHINE_PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM 11

MACHINE_PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM machine is not allocated, but phones home

MACHINE_PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM machine is not allocated, but phones home.
MACHINE_STATE_TAINTED 1

MACHINE_STATE_TAINTED this machine is tainted, i.e. this machine is not considered during random machine allocation, but still by specifying the uuid

MACHINE_STATE_TAINTED this machine is tainted, i.e. this machine is not considered during random machine allocation, but still by specifying the uui.
MACHINE_STATE_LOCKED 2

MACHINE_STATE_LOCKED this machine is locked, i.e. this machine cannot be allocated or deleted

MACHINE_STATE_LOCKED this machine is locked, i.e. this machine cannot be allocated or delete.
MACHINE_STATE_AVAILABLE 3

MACHINE_STATE_AVAILABLE this machine is available for all

MACHINE_STATE_AVAILABLE this machine is available for all.
uuid string

UUID of the machine to send the command to

UUID of the machine to send the command to.

command metalstack.api.v2.MachineBMCCommand

Command to send to the bmc of the machine

Command to send to the bmc of the machine.

uuid string

UUID of the machine to get

UUID of the machine to get.

uuid string

UUID of the machine to get

UUID of the machine to get.

password string

Password to access the console

Password to access the console.

uuid string

UUID of the machine to permanently delete

UUID of the machine to permanently delete.

uuid string

UUID of the machine to get

UUID of the machine to get.

uuid string

UUID of the machine

UUID of the machine.

string

UUID of the machine to get

UUID of the machine to get.

partition string optional

Partition for which machines should be listed, could be left empty if only one partition is present -otherwise an error is thrown that the partition must be specified

Partition for which machines should be listed, could be left empty if only one partition is present. +otherwise an error is thrown that the partition must be specified.

uuid string

UUID of the machine to set the state to

UUID of the machine to set the state to.

description string

Description a description why this machine is in the given state

Description a description why this machine is in the given state.

id string optional

Id of this network

Id of this network.

name string optional

Name of this network

Name of this network.

description string optional

Description of this network

Description of this network.

type metalstack.api.v2.NetworkType

Type of the network to create

Type of the network to create.

labels metalstack.api.v2.Labels optional

Labels on this network

Labels on this network.

prefixes string repeated

Prefixes in this network

Prefixes in this network.

destination_prefixes string repeated

Destination Prefixes in this network

Destination Prefixes in this network.

nat_type metalstack.api.v2.NATType optional

NATType of this network

NATType of this network.

vrf uint32 optional

VRF of this network has this VNI

VRF of this network has this VNI.

length metalstack.api.v2.ChildPrefixLength optional

Length per addressfamily

Length per addressfamily.

address_family metalstack.api.v2.NetworkAddressFamily optional

AddressFamily to create, defaults to the same as the parent

AddressFamily to create, defaults to the same as the parent.

id string

ID of the network to get

ID of the network to get.

string

ID of the network to get

ID of the network to get.

id string

Id of this network

Id of this network.

name string optional

Name of this network

Name of this network.

description string optional

Description of this network

Description of this network.

labels metalstack.api.v2.UpdateLabels optional

Labels to update on this network

Labels to update on this network.

prefixes string repeated

Prefixes in this network

Prefixes in this network.

destination_prefixes string repeated

Destination Prefixes in this network

Destination Prefixes in this network.

nat_type metalstack.api.v2.NATType optional

NATType of this network

NATType of this network.

unavailable int64

Unavailable is the amount of machine in a partition that are currently not allocatable because they are not waiting or +

Unavailable is the amount of machine in a partition that are currently not allocatable because they are not waiting or. not in the machine state "available", e.g. locked or reserved.

id string optional

ID of the partition to get

ID of the partition to get.

size string optional

Size of machines to show the capacity

Size of machines to show the capacity.

project string optional

Project of machines to show the capacity

Project of machines to show the capacity.

partition metalstack.api.v2.Partition

Partition the partition

Partition the partition.

partition metalstack.api.v2.Partition

Partition the partition

Partition the partition.

id string

ID of the partition to delete

ID of the partition to delete.

id string

ID of this partition

ID of this partition.

description string optional

Description of this partition

Description of this partition.

dns_servers metalstack.api.v2.DNSServer repeated

DNSServers for this partition

DNSServers for this partition.

ntp_servers metalstack.api.v2.NTPServer repeated

NTPServers for this partition

NTPServers for this partition.

string repeated

ManagementServiceAddresses defines where the management is reachable. -must be in the form <ip|host>:<port>

labels metalstack.api.v2.UpdateLabels optional

Labels to update on this network

Labels to update on this network.

partition metalstack.api.v2.Partition

Partition the partition

Partition the partition.

@@ -14642,42 +14634,42 @@

Project

 - + - + - + - + - + - + @@ -14750,14 +14742,14 @@

ProjectInvite

 - + - + @@ -14804,14 +14796,14 @@

ProjectMember

 - + - + @@ -14887,14 +14879,14 @@

ProjectServiceAddMembe

- + - + @@ -14943,35 +14935,35 @@

ProjectServiceCreateReque

+TODO: is login really a good name?.

- + - + - + - + @@ -15098,7 +15090,7 @@

ProjectServiceGetResponseproject_members

- + @@ -15146,14 +15138,14 @@

ProjectServiceInvi

- + - + @@ -15184,7 +15176,7 @@

ProjectServiceInvit

- + @@ -15215,7 +15207,7 @@

ProjectServiceInviteGe

- + @@ -15270,7 +15262,7 @@

ProjectServiceInviteReque

- + @@ -15295,8 +15287,8 @@

ProjectServiceInviteResp

+can be appended to the invitation endpoint at our cloud console like. +console.metalstack.cloud/invite/<secret.

@@ -15344,7 +15336,7 @@

ProjectServiceInvit

- + @@ -15561,28 +15553,28 @@

ProjectServiceUpdateReque

- + - + - + - + @@ -15725,7 +15717,7 @@

ProjectService

 - + @@ -15883,7 +15875,7 @@

SizeServiceDeleteRequestid

- + @@ -15931,7 +15923,7 @@

SizeServiceUpdateRequestid

- + @@ -15945,28 +15937,28 @@

SizeServiceUpdateRequestname

- + - + - + - + @@ -16048,7 +16040,7 @@

metalstack/api/v2/size_ima

ImageConstraint

-

ImageConstraint defines a constraint for an image.

examples:

images:

ubuntu: ">= 20.04.20211011"

debian: ">= 10.0.20210101"

+

ImageConstraint defines a constraint for an image.

Examples:

images:

ubuntu: ">= 20.04.20211011

debian: ">= 10.0.20210101

uuid string

Uuid of this project

Uuid of this project.

meta Meta

Meta for this project

Meta for this project.

name string

Name of this project must be unique per tenant

Name of this project must be unique per tenant.

description string

Description of this project

Description of this project.

tenant string

Tenant this project belongs to

Tenant this project belongs to.

avatar_url string optional

AvatarUrl of the Project

AvatarUrl of the Project.

expires_at google.protobuf.Timestamp

ExpiresAt the date when this invite expires

ExpiresAt the date when this invite expires.

joined_at google.protobuf.Timestamp

JoinedAt the date when the member accepted this invite

JoinedAt the date when the member accepted this invite.

created_at google.protobuf.Timestamp

CreatedAt the date when the member was added to the project

CreatedAt the date when the member was added to the project.

meta Meta

Meta for this project member

Meta for this project member.

member string

Login of the member to add

Login of the member to add.

role ProjectRole

Role to assign to the new member

Role to assign to the new member.

string

Login is the tenant of this project. -TODO: is login really a good name?

name string

Name of this project, unique per tenant

Name of this project, unique per tenant.

description string

Description of this project

Description of this project.

avatar_url string optional

Avatar URL of the project

Avatar URL of the project.

labels Labels

Labels on the project

Labels on the project.

ProjectMember repeated

ProjectMembers in this project, projects guests will only see direct project members and not implicit memberships from tenant permissions

ProjectMembers in this project, projects guests will only see direct project members and not implicit memberships from tenant permissions.

project string

Project ID of the project joined

Project ID of the project joined.

project_name string

ProjectName of the project joined

ProjectName of the project joined.

secret string

Secret of the invite to delete

Secret of the invite to delete.

secret string

Secret of the invite to list

Secret of the invite to list.

role ProjectRole

Role of this user in this project

Role of this user in this project.

ProjectInvite

Inviter contains a secret which can be sent to a potential user. -can be appended to the invitation endpoint at our cloud console like -console.metalstack.cloud/invite/<secret>

invites ProjectInvite repeated

Invites not already accepted the invitation to this project

Invites not already accepted the invitation to this project.

name string optional

Name of this project unique per tenant

Name of this project unique per tenant.

description string optional

Description of this project

Description of this project.

avatar_url string optional

Avatar URL of the project

Avatar URL of the project.

labels UpdateLabels optional

Labels on this project

Labels on this project.

InviteGet ProjectServiceInviteGetRequest ProjectServiceInviteGetResponse

InviteGet get an invite

InviteGet get an invite.
string

ID of the size to delete

ID of the size to delete.

string

Id of this size

Id of this size.

string optional

Name of this size

Name of this size.

description string optional

Description of this size

Description of this size.

constraints metalstack.api.v2.SizeConstraint repeated

Constraints which must match that a specific machine is considered of this size

Constraints which must match that a specific machine is considered of this size.

labels metalstack.api.v2.UpdateLabels optional

Labels to update on this size

Labels to update on this size.

@@ -16061,14 +16053,14 @@

ImageConstraint

 - + - + @@ -16079,7 +16071,7 @@

ImageConstraint

SizeImageConstraint

-

SizeImageConstraint expresses optional restrictions for specific size to image combinations.

this might be required if the support for a specific hardware in a given size is only supported

with a newer version of the image.

If the size in question is not found, no restrictions apply.

If the image in question is not found, no restrictions apply as well.

If the image in question is found, but does not match the given expression, machine creation must be forbidden.

+

SizeImageConstraint expresses optional restrictions for specific size to image combinations.

This might be required if the support for a specific hardware in a given size is only supported with a newer version of the image.

If the size in question is not found, no restrictions apply.

If the image in question is not found, no restrictions apply as well.

If the image in question is found, but does not match the given expression, machine creation must be forbidden.

image string

Image of the constraint

Image of the constraint.

semver_match string

SemverMatch which defines in semver match format which image version should apply

SemverMatch which defines in semver match format which image version should apply.

@@ -16099,28 +16091,28 @@

SizeImageConstraint

 - + - + - + - + @@ -16144,21 +16136,21 @@

SizeImageConstraintQuery

size - + - + - + @@ -16182,14 +16174,14 @@

SizeImageConstra

- + - + @@ -16253,35 +16245,35 @@

SizeImageCo

- + - + - + - + - + @@ -16329,7 +16321,7 @@

SizeImageCo

- + @@ -16377,7 +16369,7 @@

SizeImageConst

- + @@ -16473,7 +16465,7 @@

SizeImageCo

- + @@ -16487,21 +16479,21 @@

SizeImageCo

- + - + - + @@ -16597,7 +16589,7 @@

metalstack/api/v2/size_reserva

SizeReservation

-

SizeReservation

+

SizeReservation.

image_constraints ImageConstraint repeated

ImageConstraints to apply to this size

ImageConstraints to apply to this size.

meta Meta

Meta for this size image constraint

Meta for this size image constraint.

name string optional

Name of this size image constraint

Name of this size image constraint.

description string optional

Description of this size image constraint

Description of this size image constraint.

string optional

Size of the size image constraint

Size of the size image constraint.

name string optional

Name of the size image constraint to query

Name of the size image constraint to query.

description string optional

Description of the size image constraint to query

Description of the size image constraint to query.

size string

Size to try

Size to try.

image string

Image to try

Image to try.

size string

Size of the constraint

Size of the constraint.

image_constraints metalstack.api.v2.ImageConstraint repeated

ImageConstraints to apply to this size

ImageConstraints to apply to this size.

meta metalstack.api.v2.Meta

Meta for this size image constraint

Meta for this size image constraint.

name string optional

Name of this size image constraint

Name of this size image constraint.

description string optional

Description of this size image constraint

Description of this size image constraint.

size string

Size of the constraint

Size of the constraint.

size string

Size of the constraint

Size of the constraint.

size string

Size of the image constraint to update

Size of the image constraint to update.

image_constraints metalstack.api.v2.ImageConstraint repeated

ImageConstraints to apply to this size

ImageConstraints to apply to this size.

name string optional

Name of this size image constraint

Name of this size image constraint.

description string optional

Description of this size image constraint

Description of this size image constraint.

@@ -16610,56 +16602,56 @@

SizeReservation

 - + - + - + - + - + - + - + - + @@ -16683,42 +16675,42 @@

SizeReservationQuery

 - + - + - + - + - + - + @@ -16749,14 +16741,14 @@

SizeReservationServi

- + - + @@ -16780,7 +16772,7 @@

SizeReservationServ

- + @@ -16804,7 +16796,7 @@

SizeReservationServ

- + @@ -16835,7 +16827,7 @@

SizeReservationSer

- + @@ -16947,7 +16939,7 @@

SizeReservation

- + @@ -17043,21 +17035,21 @@

SizeReservation

- + - + - + @@ -17071,21 +17063,21 @@

SizeReservation

- + - + - + @@ -17187,14 +17179,14 @@

BGPFilter

 - + - + @@ -17468,28 +17460,28 @@

SwitchNic

 - + - + - + - + @@ -17950,7 +17942,7 @@

SwitchService

- + @@ -17998,7 +17990,7 @@

SwitchServiceDeleteReque

- + @@ -18053,7 +18045,7 @@

SwitchServiceGetRequest

id - + @@ -18125,7 +18117,7 @@

SwitchServiceListResponse

- + @@ -18204,21 +18196,21 @@

SwitchServicePortRequestid

- + - + - + @@ -18242,7 +18234,7 @@

SwitchServicePortResponse

- + @@ -18266,7 +18258,7 @@

SwitchServiceUpdateReque

- + @@ -18288,7 +18280,7 @@

SwitchServiceUpdateReque

- + @@ -18510,7 +18502,7 @@

TaskInfo

 +If the task has no failures, LastFailedAt is zero time (i.e. time.Time{}).

@@ -18533,8 +18525,8 @@

TaskInfo

 @@ -18544,7 +18536,7 @@

TaskInfo

 +Zero if not applicable.

@@ -18552,8 +18544,8 @@

TaskInfo

 @@ -18579,7 +18571,7 @@

TaskInfo

 +Use ResultWriter to write result data from the Handler.

@@ -18766,7 +18758,7 @@

TaskServiceQueuesResponse

- + @@ -18903,49 +18895,49 @@

Tenant

 - + - + - + - + - + - + - + @@ -19018,14 +19010,14 @@

TenantInvite

 - + - + @@ -19063,21 +19055,21 @@

TenantMember

 - + - + - + @@ -19146,21 +19138,21 @@

TenantServiceAddMemberR

- + - + - + @@ -19208,35 +19200,35 @@

TenantServiceCreateRequest

- + - + - + - + - + @@ -19284,7 +19276,7 @@

TenantServiceDeleteRequest

- + @@ -19332,7 +19324,7 @@

TenantServiceGetRequest

 - + @@ -19363,7 +19355,7 @@

TenantServiceGetResponse

tenant_members - + @@ -19411,14 +19403,14 @@

TenantServiceInvite

- + - + @@ -19442,14 +19434,14 @@

TenantServiceInviteD

- + - + @@ -19480,7 +19472,7 @@

TenantServiceInviteGetR

- + @@ -19528,14 +19520,14 @@

TenantServiceInviteRequest

- + - + @@ -19559,9 +19551,7 @@

TenantServiceInviteRespon

- + @@ -19585,7 +19575,7 @@

TenantServiceInvitesL

- + @@ -19609,7 +19599,7 @@

TenantServiceInvites

- + @@ -19633,7 +19623,7 @@

TenantServiceLeaveRequestlogin

- + @@ -19712,7 +19702,7 @@

TenantServiceRemoveM

- + @@ -19767,7 +19757,7 @@

TenantServiceUpdateM

- + @@ -19781,7 +19771,7 @@

TenantServiceUpdateM

- + @@ -19829,7 +19819,7 @@

TenantServiceUpdateRequest

- + @@ -19843,35 +19833,35 @@

TenantServiceUpdateRequest

- + - + - + - + - + @@ -19979,7 +19969,7 @@

TenantService

 - + @@ -20014,7 +20004,7 @@

TenantService

 - + @@ -20043,21 +20033,21 @@

TenantServiceAddMembe

- + - + - + @@ -20105,35 +20095,35 @@

TenantServiceCreateReque

- + - + - + - + - + @@ -20236,14 +20226,14 @@

TenantServiceRemov

- + - + @@ -20345,14 +20335,14 @@

TokenServiceCreateRequest

- + - + @@ -20541,35 +20531,35 @@

VPNNode

 - + - + - + - + - + @@ -20614,7 +20604,7 @@

VPNServiceAuthKeyRequestproject

- + @@ -20682,14 +20672,14 @@

VPNServiceAuthKeyResponse

- + - + @@ -20737,7 +20727,7 @@

VPNServiceListNodesResp

- + @@ -20968,49 +20958,49 @@

Service

 - + - + - + - + - + - + - + - + @@ -21027,25 +21017,25 @@

ServiceStatus

 - + - + - + - + @@ -21333,42 +21323,42 @@

User

 - + - + - + - + - + - + @@ -21464,7 +21454,7 @@

BMCCommandDoneRequest

 - + @@ -21612,14 +21602,14 @@

WaitForBMCCommandResponse

- + - + @@ -21705,7 +21695,7 @@

BootServiceBootRequest

 - + @@ -21774,7 +21764,7 @@

BootServiceDhcpRequest

 - + @@ -21812,14 +21802,14 @@

BootService

- + - + @@ -21850,42 +21840,42 @@

BootServiceRegisterReque

- + - + - + - + - + - + @@ -21910,7 +21900,7 @@

BootServiceRegisterReque

BootServiceRegisterResponse

-

BootServiceRegisterResponse response to a BootServiceRegisterResponse request

+

BootServiceRegisterResponse response to a BootServiceRegisterResponse request.

id string

Id of this size reservation, is generated on creation

Id of this size reservation, is generated on creation.

meta Meta

Meta for this size reservation

Meta for this size reservation.

name string

Name of this size reservation

Name of this size reservation.

description string

Description of this size reservation

Description of this size reservation.

project string

Project of the size reservation

Project of the size reservation.

size string

Size id of this size reservation

Size id of this size reservation.

partitions string repeated

Partition ids of this size reservation

Partition ids of this size reservation.

amount int32

Amount of reservations of this size reservation

Amount of reservations of this size reservation.

id string optional

ID of the size reservation to get

ID of the size reservation to get.

name string optional

Name of this size reservation

Name of this size reservation.

description string optional

Description of this size reservation

Description of this size reservation.

size string optional

Size id of this size reservation

Size id of this size reservation.

project string optional

Project of the size reservation

Project of the size reservation.

partition string optional

Partition of the size reservation

Partition of the size reservation.

id string

ID of the size reservation to get

ID of the size reservation to get.

project string

Project of the size reservation

Project of the size reservation.

size_reservation SizeReservation

Size reservation

Size reservation.

project string

Project of the size reservation

Project of the size reservation.

size_reservations SizeReservation repeated

Size reservations

Size reservations.

id string

ID of the size reservation to delete

ID of the size reservation to delete.

id string

Id of this size reservation

Id of this size reservation.

name string optional

Name of this size reservation

Name of this size reservation.

description string optional

Description of this size reservation

Description of this size reservation.

partitions string repeated

Partition ids of this size reservation

Partition ids of this size reservation.

amount int32 optional

Amount of reservations of this size reservation

Amount of reservations of this size reservation.

labels metalstack.api.v2.UpdateLabels optional

Labels to update of this size reservation

Labels to update of this size reservation.

cidrs string repeated

CIDRs for which to allow BGP

CIDRs for which to allow BGP.

vnis string repeated

VNIs for which to allow BGP

VNIs for which to allow BGP.

name string

Name of the switch port

Name of the switch port.

identifier string

Identifier of the port

Identifier of the port.

mac string

MAC address of the port

MAC address of the port.

vrf string optional

VRF name if the port is bound in one

VRF name if the port is bound in one.

machine_query metalstack.api.v2.MachineQuery

MachineQuery to filter the machine results

MachineQuery to filter the machine results.

id string

Id of the switch

Id of the switch.

string

Id of the switch to get

Id of the switch to get.

switches metalstack.api.v2.Switch repeated

Switches that match the request query

Switches that match the request query.

string

Id of the switch

Id of the switch.

nic_name string

NicName of the port whose status should be changed

NicName of the port whose status should be changed.

status metalstack.api.v2.SwitchPortStatus

Status that the port should have

Status that the port should have.

switch metalstack.api.v2.Switch

Switch after the port status toggle

Switch after the port status toggle.

id string

ID of the switch

ID of the switch.

description string optional

Description of the switch

Description of the switch.

google.protobuf.Timestamp

LastFailedAt is the time of the last failure if any. -If the task has no failures, LastFailedAt is zero time (i.e. time.Time{})

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 +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. Empty string (default) indicates task does not belong to any groups, and no aggregation will be applied to the task.

google.protobuf.Timestamp

NextProcessAt is the time the task is scheduled to be processed. -Zero if not applicable

bool

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 +An orphaned task indicates that the worker has crashed or experienced network failures and was not able to. +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.

bytes

Result holds the result data associated with the task. -Use ResultWriter to write result data from the Handler

queues string repeated

Queues configured for the async system

Queues configured for the async system.

login string

Login of the tenant

Login of the tenant.

meta Meta

Meta for this tenant

Meta for this tenant.

name string

Name of the tenant

Name of the tenant.

email string

Email of the tenant

Email of the tenant.

description string

Description of this tenant

Description of this tenant.

avatar_url string

AvatarUrl of the tenant

AvatarUrl of the tenant.

created_by string

CreatedBy stores who created this tenant

CreatedBy stores who created this tenant.

expires_at google.protobuf.Timestamp

ExpiresAt the date when this invite expires

ExpiresAt the date when this invite expires.

joined_at google.protobuf.Timestamp

JoinedAt the date when the member accepted this invite

JoinedAt the date when the member accepted this invite.

projects string repeated

Projects in which a user is a direct member

Projects in which a user is a direct member.

created_at google.protobuf.Timestamp

CreatedAt the date when the member was added to the tenant

CreatedAt the date when the member was added to the tenant.

meta Meta

Meta for this tenant member

Meta for this tenant member.

login string

Login of the tenant to which the member will be added

Login of the tenant to which the member will be added.

member string

Login of the member to add

Login of the member to add.

role TenantRole

Role to assign to the new member

Role to assign to the new member.

name string

Name of this tenant

Name of this tenant.

description string optional

Description of this tenant

Description of this tenant.

email string optional

Email of the tenant, if not set will be inherited from the creator

Email of the tenant, if not set will be inherited from the creator.

avatar_url string optional

AvatarUrl of the tenant

AvatarUrl of the tenant.

labels Labels

Labels on the tenant

Labels on the tenant.

login string

Login of the tenant

Login of the tenant.

login string

Login of the tenant

Login of the tenant.

TenantMember repeated

TenantMembers of this tenant

TenantMembers of this tenant.

tenant string

Tenant ID of the joined tenant

Tenant ID of the joined tenant.

tenant_name string

TenantName of the joined tenant

TenantName of the joined tenant.

login string

Login of the tenant

Login of the tenant.

secret string

Secret of the invite to delete

Secret of the invite to delete.

secret string

Secret of the invite to get

Secret of the invite to get.

login string

Login of the tenant

Login of the tenant.

role TenantRole

Role of this user in this tenant

Role of this user in this tenant.

invite TenantInvite

Invite contains a secret which can be sent to a potential user. -can be appended to the invitation endpoint at our cloud console like -console.metalstack.cloud/invite/<secret>

Invite contains a secret which can be sent to a potential user.

login string

Login of the tenant

Login of the tenant.

invites TenantInvite repeated

Invites that have not yet accepted the invitation to this tenant

Invites that have not yet accepted the invitation to this tenant.

string

Login of the tenant

Login of the tenant.

login string

Login of the tenant

Login of the tenant.

login string

Login of the tenant

Login of the tenant.

role TenantRole

Role of this user in this tenant

Role of this user in this tenant.

login string

Login of the tenant

Login of the tenant.

name string optional

Name of the tenant

Name of the tenant.

email string optional

Email of the tenant

Email of the tenant.

description string optional

Description of this tenant

Description of this tenant.

avatar_url string optional

AvatarUrl of the tenant

AvatarUrl of the tenant.

labels UpdateLabels optional

Labels on the tenant

Labels on the tenant.

UpdateMember TenantServiceUpdateMemberRequest TenantServiceUpdateMemberResponse

UpdateMember update a member of a tenant

UpdateMember update a member of a tenant.
InviteGet TenantServiceInviteGetRequest TenantServiceInviteGetResponse

InviteGet get an invite

InviteGet get an invite.
tenant string

Login of the tenant to which the member will be added

Login of the tenant to which the member will be added.

member string

Login of the member to add

Login of the member to add.

role metalstack.api.v2.TenantRole

Role to assign to the new member

Role to assign to the new member.

name string

Name of the tenant

Name of the tenant.

description string optional

Description of the tenant

Description of the tenant.

email string optional

Email of the tenant, if not set will be inherited from the creator

Email of the tenant, if not set will be inherited from the creator.

avatar_url string optional

AvatarUrl of the tenant

AvatarUrl of the tenant.

labels metalstack.api.v2.Labels

Labels on the tenant

Labels on the tenant.

tenant string

Login of the tenant from which the member will be removed

Login of the tenant from which the member will be removed.

member string

Login of the member to remove

Login of the member to remove.

user string optional

User this token should be created for, if omitted, user is derived from caller

User this token should be created for, if omitted, user is derived from caller.

token_create_request metalstack.api.v2.TokenServiceCreateRequest

TokenCreateRequest which should be created

TokenCreateRequest which should be created.

id uint64

ID of this node

ID of this node.

name string

Name of this node

Name of this node.

project string

Project of this node, maps to a project

Project of this node, maps to a project.

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 to the control plane

LastSeen timestamp when this node reached out to the control plane.

string

Project for which a VPN authentication key should be generated

Project for which a VPN authentication key should be generated.

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.

nodes metalstack.api.v2.VPNNode repeated

Nodes connected to the VPN

Nodes connected to the VPN.

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_TENANT_APISERVER 3

SERVICE_TENANT_APISERVER the tenant-apiserver

SERVICE_TENANT_APISERVER the tenant-apiserver.
SERVICE_MACHINES 4

SERVICE_MACHINES the machine service

SERVICE_MACHINES the machine service.
SERVICE_AUDIT 5

SERVICE_AUDIT the auditing

SERVICE_AUDIT the auditing.
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.
SERVICE_TASKS 8

SERVICE_TASKS the tasks service

SERVICE_TASKS the tasks service.
SERVICE_STATUS_UNSPECIFIED 0

SERVICE_STATUS_UNSPECIFIED service status is not known or unspecified

SERVICE_STATUS_UNSPECIFIED service status is not known or unspecified.
SERVICE_STATUS_DEGRADED 1

SERVICE_STATUS_DEGRADED the service is in degraded status, not the whole functionality is available

SERVICE_STATUS_DEGRADED the service is in degraded status, not the whole functionality is available.
SERVICE_STATUS_UNHEALTHY 2

SERVICE_STATUS_UNHEALTHY the service is in unhealthy status, serious impact is expected

SERVICE_STATUS_UNHEALTHY the service is in unhealthy status, serious impact is expected.
SERVICE_STATUS_HEALTHY 3

SERVICE_STATUS_HEALTHY the service is in healthy status, for example fully functional

SERVICE_STATUS_HEALTHY the service is in healthy status, for example fully functional.
name string

Name of the user

Name of the user.

email string

Email of the user

Email of the user.

avatar_url string

AvatarUrl of the user

AvatarUrl of the user.

tenants Tenant repeated

Tenants the user belongs to

Tenants the user belongs to.

projects Project repeated

Projects the user belongs to

Projects the user belongs to.

default_tenant Tenant

DefaultTenant the default tenant that this user belongs to

DefaultTenant the default tenant that this user belongs to.

error string optional

Error of the command execution, nil if it was successful

Error of the command execution, nil if it was successful.

uuid string

UUID of the machine to send the command to

UUID of the machine to send the command to.

bmc_command metalstack.api.v2.MachineBMCCommand

BmcCommand to execute against the BMC of the machine

BmcCommand to execute against the BMC of the machine.

mac string

Mac address of the machine

Mac address of the machine.

uuid string

UUID of the machine

UUID of the machine.

uuid string

UUID of the machine to boot

UUID of the machine to boot.

console_password string

ConsolePassword

ConsolePassword.

uuid string

UUID of this machine

UUID of this machine.

hardware metalstack.api.v2.MachineHardware

Hardware details of this machine

Hardware details of this machine.

bios metalstack.api.v2.MachineBios

Bios details of this machine

Bios details of this machine.

bmc metalstack.api.v2.MachineBMC

BMC details of this machine

BMC details of this machine.

fru metalstack.api.v2.MachineFRU

FRU details of this machine

FRU details of this machine.

tags string repeated

Tags of this machine

Tags of this machine.

@@ -21923,7 +21913,7 @@

BootServiceRegisterResp

- + @@ -21937,7 +21927,7 @@

BootServiceRegisterResp

- + @@ -21948,7 +21938,7 @@

BootServiceRegisterResp

BootServiceSuperUserPasswordRequest

-

BootServiceSuperUserPasswordRequest this call returns the password for the machine superuser

+

BootServiceSuperUserPasswordRequest this call returns the password for the machine superuser.

uuid string

UUID of this machine

UUID of this machine.

partition string

Partition of this machine

Partition of this machine.

@@ -21961,7 +21951,7 @@

BootServiceSupe

- + @@ -21972,7 +21962,7 @@

BootServiceSupe

BootServiceSuperUserPasswordResponse

-

BootServiceSuperUserPasswordResponse the super user password is returned

+

BootServiceSuperUserPasswordResponse the super user password is returned.

uuid string

UUID of this machine

UUID of this machine.

@@ -22016,7 +22006,7 @@

BootServiceWaitRequest

 - + @@ -22027,7 +22017,7 @@

BootServiceWaitRequest

BootServiceWaitResponse

-

BootServiceWaitResponse response to a wait request

+

BootServiceWaitResponse response to a wait request.

uuid string

UUID of this machine

UUID of this machine.

@@ -22153,14 +22143,14 @@

ComponentServicePingReq

- + - + @@ -22224,7 +22214,7 @@

EventServiceSendRequest

events - + @@ -22279,7 +22269,7 @@

EventServiceSendResponseevents

- + @@ -22343,7 +22333,7 @@

SwitchServiceGetRequest

id - + @@ -22391,21 +22381,21 @@

SwitchServiceHeartbea

- + - + - + @@ -22505,7 +22495,7 @@

SwitchServiceHeartbe

- + @@ -22543,7 +22533,7 @@

SwitchServiceRegisterR

- + diff --git a/go/metalstack/admin/v2/audit.pb.go b/go/metalstack/admin/v2/audit.pb.go index 6e8a2b9e..892cffc4 100644 --- a/go/metalstack/admin/v2/audit.pb.go +++ b/go/metalstack/admin/v2/audit.pb.go @@ -118,7 +118,7 @@ func (x *AuditServiceListResponse) GetTraces() []*v2.AuditTrace { // AuditServiceGetRequest is the request payload for getting an audit trace. type AuditServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Uuid of the audit trace + // Uuid of the audit trace. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` // Phase specifies the audit phase. Defaults to request. Phase *v2.AuditPhase `protobuf:"varint,2,opt,name=phase,proto3,enum=metalstack.api.v2.AuditPhase,oneof" json:"phase,omitempty"` diff --git a/go/metalstack/admin/v2/filesystem.pb.go b/go/metalstack/admin/v2/filesystem.pb.go index c791c696..989cf5a1 100644 --- a/go/metalstack/admin/v2/filesystem.pb.go +++ b/go/metalstack/admin/v2/filesystem.pb.go @@ -118,25 +118,25 @@ func (x *FilesystemServiceCreateResponse) GetFilesystemLayout() *v2.FilesystemLa // FilesystemServiceUpdateRequest is the request payload for updating a filesystem. type FilesystemServiceUpdateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Id of this filesystemLayout + // Id of this filesystemLayout. 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 *v2.UpdateMeta `protobuf:"bytes,2,opt,name=update_meta,json=updateMeta,proto3" json:"update_meta,omitempty"` - // Name of this filesystemLayout + // Name of this filesystemLayout. Name *string `protobuf:"bytes,3,opt,name=name,proto3,oneof" json:"name,omitempty"` - // Description of this filesystemLayout + // Description of this filesystemLayout. Description *string `protobuf:"bytes,4,opt,name=description,proto3,oneof" json:"description,omitempty"` // Filesystems is a list of filesystems to create on a machine. 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"` // LogicalVolumes list of logicalvolumes to create. LogicalVolumes []*v2.LogicalVolume `protobuf:"bytes,9,rep,name=logical_volumes,json=logicalVolumes,proto3" json:"logical_volumes,omitempty"` - // Constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts + // Constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts. Constraints *v2.FilesystemLayoutConstraints `protobuf:"bytes,10,opt,name=constraints,proto3" json:"constraints,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -291,7 +291,7 @@ func (x *FilesystemServiceUpdateResponse) GetFilesystemLayout() *v2.FilesystemLa // FilesystemServiceDeleteRequest is the request payload for deleting a filesystem. type FilesystemServiceDeleteRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // ID of the filesystem to delete + // ID of the filesystem to delete. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -380,11 +380,11 @@ func (x *FilesystemServiceDeleteResponse) GetFilesystemLayout() *v2.FilesystemLa return nil } -// FilesystemServiceMatchRequest +// FilesystemServiceMatchRequest. type FilesystemServiceMatchRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Match size and image to a filesystem layout. - // or match a machine to a filesystem layout + // or match a machine to a filesystem layout. // // Types that are valid to be assigned to Match: // @@ -455,12 +455,12 @@ type isFilesystemServiceMatchRequest_Match interface { } type FilesystemServiceMatchRequest_SizeAndImage struct { - // SizeAndImage + // SizeAndImage. SizeAndImage *MatchImageAndSize `protobuf:"bytes,1,opt,name=size_and_image,json=sizeAndImage,proto3,oneof"` } type FilesystemServiceMatchRequest_MachineAndFilesystemlayout struct { - // MachineAndFilesystemlayout + // MachineAndFilesystemlayout. MachineAndFilesystemlayout *MatchMachineAndFilesystemLayout `protobuf:"bytes,2,opt,name=machine_and_filesystemlayout,json=machineAndFilesystemlayout,proto3,oneof"` } @@ -469,12 +469,12 @@ func (*FilesystemServiceMatchRequest_SizeAndImage) isFilesystemServiceMatchReque func (*FilesystemServiceMatchRequest_MachineAndFilesystemlayout) isFilesystemServiceMatchRequest_Match() { } -// MatchImageAndSize +// MatchImageAndSize. type MatchImageAndSize struct { state protoimpl.MessageState `protogen:"open.v1"` - // Size, machine size to try + // Size, machine size to try. Size string `protobuf:"bytes,1,opt,name=size,proto3" json:"size,omitempty"` - // Image machine image to try + // Image machine image to try. Image string `protobuf:"bytes,2,opt,name=image,proto3" json:"image,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -524,12 +524,12 @@ func (x *MatchImageAndSize) GetImage() string { return "" } -// MatchMachineAndFilesystemLayout +// MatchMachineAndFilesystemLayout. type MatchMachineAndFilesystemLayout struct { state protoimpl.MessageState `protogen:"open.v1"` - // Machine to check + // Machine to check. Machine string `protobuf:"bytes,1,opt,name=machine,proto3" json:"machine,omitempty"` - // FilesystemLayout to check + // FilesystemLayout to check. FilesystemLayout string `protobuf:"bytes,2,opt,name=filesystem_layout,json=filesystemLayout,proto3" json:"filesystem_layout,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -579,10 +579,10 @@ func (x *MatchMachineAndFilesystemLayout) GetFilesystemLayout() string { return "" } -// FilesystemServiceMatchResponse +// FilesystemServiceMatchResponse. type FilesystemServiceMatchResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // FilesystemLayout the filesystemlayout + // FilesystemLayout the filesystemlayout. 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 33465139..9947cf31 100644 --- a/go/metalstack/admin/v2/image.pb.go +++ b/go/metalstack/admin/v2/image.pb.go @@ -119,23 +119,23 @@ func (x *ImageServiceCreateResponse) GetImage() *v2.Image { // ImageServiceUpdateRequest is the request payload for updating an image. type ImageServiceUpdateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Id of this image + // Id of this image. 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 *v2.UpdateMeta `protobuf:"bytes,2,opt,name=update_meta,json=updateMeta,proto3" json:"update_meta,omitempty"` - // URL where this image is located + // URL where this image is located. Url *string `protobuf:"bytes,3,opt,name=url,proto3,oneof" json:"url,omitempty"` - // Name of this image + // Name of this image. Name *string `protobuf:"bytes,4,opt,name=name,proto3,oneof" json:"name,omitempty"` - // Description of this image + // Description of this image. Description *string `protobuf:"bytes,5,opt,name=description,proto3,oneof" json:"description,omitempty"` - // Features of this image + // Features of this image. Features []v2.ImageFeature `protobuf:"varint,6,rep,packed,name=features,proto3,enum=metalstack.api.v2.ImageFeature" json:"features,omitempty"` - // Classification of this image + // Classification of this image. Classification v2.ImageClassification `protobuf:"varint,7,opt,name=classification,proto3,enum=metalstack.api.v2.ImageClassification" json:"classification,omitempty"` // ExpiresAt indicates that usage is not possible after this date. ExpiresAt *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"` - // Labels to update on this image + // Labels to update on this image. Labels *v2.UpdateLabels `protobuf:"bytes,9,opt,name=labels,proto3,oneof" json:"labels,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -283,7 +283,7 @@ func (x *ImageServiceUpdateResponse) GetImage() *v2.Image { // ImageServiceDeleteRequest is the request payload for deleting an image. type ImageServiceDeleteRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // ID of the image to delete + // ID of the image to delete. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/admin/v2/machine.pb.go b/go/metalstack/admin/v2/machine.pb.go index ebc14bca..e7447c63 100644 --- a/go/metalstack/admin/v2/machine.pb.go +++ b/go/metalstack/admin/v2/machine.pb.go @@ -26,7 +26,7 @@ const ( // MachineServiceGetRequest is the request payload for a machine get request. type MachineServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // UUID of the machine to get + // UUID of the machine to get. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -120,8 +120,8 @@ type MachineServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Query to list one or more machines. Query *v2.MachineQuery `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"` - // Partition for which machines should be listed, could be left empty if only one partition is present - // otherwise an error is thrown that the partition must be specified + // Partition for which machines should be listed, could be left empty if only one partition is present. + // otherwise an error is thrown that the partition must be specified. Partition *string `protobuf:"bytes,2,opt,name=partition,proto3,oneof" json:"partition,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -220,7 +220,7 @@ func (x *MachineServiceListResponse) GetMachines() []*v2.Machine { // MachineServiceDeleteRequest is the request payload for a machine delete request. type MachineServiceDeleteRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // UUID of the machine to permanently delete + // UUID of the machine to permanently delete. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -312,9 +312,9 @@ func (x *MachineServiceDeleteResponse) GetMachine() *v2.Machine { // MachineServiceBMCCommandRequest is the request payload for a machine bmc command. type MachineServiceBMCCommandRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // UUID of the machine to send the command to + // UUID of the machine to send the command to. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` - // Command to send to the bmc of the machine + // Command to send to the bmc of the machine. Command v2.MachineBMCCommand `protobuf:"varint,2,opt,name=command,proto3,enum=metalstack.api.v2.MachineBMCCommand" json:"command,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -404,7 +404,7 @@ func (*MachineServiceBMCCommandResponse) Descriptor() ([]byte, []int) { // MachineServiceGetBMCRequest is the request payload for a machine getbmc request. type MachineServiceGetBMCRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // UUID of the machine to get + // UUID of the machine to get. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -450,7 +450,7 @@ func (x *MachineServiceGetBMCRequest) GetUuid() string { // MachineServiceGetBMCResponse is the response payload for a machine getbmc request. type MachineServiceGetBMCResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // UUID of the machine + // UUID of the machine. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` // BMC contains the BMC details of this machine. Bmc *v2.MachineBMCReport `protobuf:"bytes,2,opt,name=bmc,proto3" json:"bmc,omitempty"` @@ -597,7 +597,7 @@ func (x *MachineServiceListBMCResponse) GetBmcReports() map[string]*v2.MachineBM // 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 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 is only forwarded to an audit sink. @@ -653,9 +653,9 @@ func (x *MachineServiceConsolePasswordRequest) GetReason() string { // 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 + // UUID of the machine to get. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` - // Password to access the console + // Password to access the console. Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -708,12 +708,12 @@ func (x *MachineServiceConsolePasswordResponse) GetPassword() string { // MachineServiceSetStateRequest is the request payload for a machine set state request. type MachineServiceSetStateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // UUID of the machine to set the state to + // UUID of the machine to set the state to. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` // State the state of this machine. // If State set to available, description is also cleared. State v2.MachineState `protobuf:"varint,2,opt,name=state,proto3,enum=metalstack.api.v2.MachineState" json:"state,omitempty"` - // Description a description why this machine is in the given state + // Description a description why this machine is in the given state. Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/admin/v2/network.pb.go b/go/metalstack/admin/v2/network.pb.go index 4a4d0112..47ca1969 100644 --- a/go/metalstack/admin/v2/network.pb.go +++ b/go/metalstack/admin/v2/network.pb.go @@ -26,7 +26,7 @@ const ( // NetworkServiceGetRequest is the request payload for getting a network. type NetworkServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // ID of the network to get + // ID of the network to get. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -118,39 +118,39 @@ func (x *NetworkServiceGetResponse) GetNetwork() *v2.Network { // NetworkServiceCreateRequest is the request payload for creating a network. type NetworkServiceCreateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Id of this network + // Id of this network. Id *string `protobuf:"bytes,1,opt,name=id,proto3,oneof" json:"id,omitempty"` - // Name of this network + // Name of this network. Name *string `protobuf:"bytes,2,opt,name=name,proto3,oneof" json:"name,omitempty"` - // Description of this network + // Description of this network. Description *string `protobuf:"bytes,3,opt,name=description,proto3,oneof" json:"description,omitempty"` // Partition where this network will be created. Partition *string `protobuf:"bytes,4,opt,name=partition,proto3,oneof" json:"partition,omitempty"` // Project where this network belongs to. Project *string `protobuf:"bytes,5,opt,name=project,proto3,oneof" json:"project,omitempty"` - // Type of the network to create + // Type of the network to create. Type v2.NetworkType `protobuf:"varint,6,opt,name=type,proto3,enum=metalstack.api.v2.NetworkType" json:"type,omitempty"` - // Labels on this network + // Labels on this network. Labels *v2.Labels `protobuf:"bytes,7,opt,name=labels,proto3,oneof" json:"labels,omitempty"` - // Prefixes in this network + // Prefixes in this network. Prefixes []string `protobuf:"bytes,8,rep,name=prefixes,proto3" json:"prefixes,omitempty"` - // Destination Prefixes in this network + // Destination Prefixes in this network. DestinationPrefixes []string `protobuf:"bytes,9,rep,name=destination_prefixes,json=destinationPrefixes,proto3" json:"destination_prefixes,omitempty"` // Default Child Prefix length defines the bitlength of a child network created per addressfamily, if not specified during the allocate request. DefaultChildPrefixLength *v2.ChildPrefixLength `protobuf:"bytes,10,opt,name=default_child_prefix_length,json=defaultChildPrefixLength,proto3" json:"default_child_prefix_length,omitempty"` // Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length. MinChildPrefixLength *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 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"` // AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced. AdditionalAnnouncableCidrs []string `protobuf:"bytes,15,rep,name=additional_announcable_cidrs,json=additionalAnnouncableCidrs,proto3" json:"additional_announcable_cidrs,omitempty"` - // Length per addressfamily + // Length per addressfamily. Length *v2.ChildPrefixLength `protobuf:"bytes,16,opt,name=length,proto3,oneof" json:"length,omitempty"` - // AddressFamily to create, defaults to the same as the parent + // AddressFamily to create, defaults to the same as the parent. AddressFamily *v2.NetworkAddressFamily `protobuf:"varint,17,opt,name=address_family,json=addressFamily,proto3,enum=metalstack.api.v2.NetworkAddressFamily,oneof" json:"address_family,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -308,25 +308,25 @@ func (x *NetworkServiceCreateRequest) GetAddressFamily() v2.NetworkAddressFamily // NetworkServiceUpdateRequest is the request payload for updating a network. type NetworkServiceUpdateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Id of this network + // Id of this network. 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 *v2.UpdateMeta `protobuf:"bytes,2,opt,name=update_meta,json=updateMeta,proto3" json:"update_meta,omitempty"` - // Name of this network + // Name of this network. Name *string `protobuf:"bytes,3,opt,name=name,proto3,oneof" json:"name,omitempty"` - // Description of this network + // Description of this network. Description *string `protobuf:"bytes,4,opt,name=description,proto3,oneof" json:"description,omitempty"` - // Labels to update on this network + // Labels to update on this network. Labels *v2.UpdateLabels `protobuf:"bytes,5,opt,name=labels,proto3,oneof" json:"labels,omitempty"` - // Prefixes in this network + // Prefixes in this network. Prefixes []string `protobuf:"bytes,6,rep,name=prefixes,proto3" json:"prefixes,omitempty"` - // Destination Prefixes in this network + // 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, 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"` - // NATType of this network + // NATType of this network. 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"` @@ -453,7 +453,7 @@ func (x *NetworkServiceUpdateRequest) GetForce() bool { // NetworkServiceDeleteRequest is the request payload for deleting a network. type NetworkServiceDeleteRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // ID of the network to get + // ID of the network to get. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/admin/v2/partition.pb.go b/go/metalstack/admin/v2/partition.pb.go index 1c0ef82f..cb7a817d 100644 --- a/go/metalstack/admin/v2/partition.pb.go +++ b/go/metalstack/admin/v2/partition.pb.go @@ -26,7 +26,7 @@ const ( // PartitionServiceCreateRequest is the request payload for a partition create request. type PartitionServiceCreateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Partition the partition + // Partition the partition. Partition *v2.Partition `protobuf:"bytes,1,opt,name=partition,proto3" json:"partition,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -72,22 +72,22 @@ func (x *PartitionServiceCreateRequest) GetPartition() *v2.Partition { // PartitionServiceUpdateRequest is the request payload for updating a partition. type PartitionServiceUpdateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // ID of this partition + // ID of this partition. 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 *v2.UpdateMeta `protobuf:"bytes,2,opt,name=update_meta,json=updateMeta,proto3" json:"update_meta,omitempty"` - // Description of this partition + // Description of this partition. Description *string `protobuf:"bytes,3,opt,name=description,proto3,oneof" json:"description,omitempty"` // PartitionBootConfiguration defines how metal-hammer boots. BootConfiguration *v2.PartitionBootConfiguration `protobuf:"bytes,4,opt,name=boot_configuration,json=bootConfiguration,proto3" json:"boot_configuration,omitempty"` - // DNSServers for this partition + // DNSServers for this partition. DnsServers []*v2.DNSServer `protobuf:"bytes,5,rep,name=dns_servers,json=dnsServers,proto3" json:"dns_servers,omitempty"` - // NTPServers for this partition + // 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. - // must be in the form : + // 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 to update on this network. Labels *v2.UpdateLabels `protobuf:"bytes,8,opt,name=labels,proto3,oneof" json:"labels,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -182,7 +182,7 @@ func (x *PartitionServiceUpdateRequest) GetLabels() *v2.UpdateLabels { // PartitionServiceDeleteRequest is the request payload for a partition delete request. type PartitionServiceDeleteRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // ID of the partition to delete + // ID of the partition to delete. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -228,7 +228,7 @@ func (x *PartitionServiceDeleteRequest) GetId() string { // PartitionServiceCreateResponse is the response payload for a partition create request. type PartitionServiceCreateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Partition the partition + // Partition the partition. Partition *v2.Partition `protobuf:"bytes,1,opt,name=partition,proto3" json:"partition,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -274,7 +274,7 @@ func (x *PartitionServiceCreateResponse) GetPartition() *v2.Partition { // PartitionServiceUpdateResponse is the response payload for a partition update request. type PartitionServiceUpdateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Partition the partition + // Partition the partition. Partition *v2.Partition `protobuf:"bytes,1,opt,name=partition,proto3" json:"partition,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -366,11 +366,11 @@ func (x *PartitionServiceDeleteResponse) GetPartition() *v2.Partition { // PartitionServiceCapacityRequest is the request payload for getting partition capacity. type PartitionServiceCapacityRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // ID of the partition to get + // ID of the partition to get. Id *string `protobuf:"bytes,1,opt,name=id,proto3,oneof" json:"id,omitempty"` - // Size of machines to show the capacity + // Size of machines to show the capacity. Size *string `protobuf:"bytes,2,opt,name=size,proto3,oneof" json:"size,omitempty"` - // Project of machines to show the capacity + // Project of machines to show the capacity. Project *string `protobuf:"bytes,3,opt,name=project,proto3,oneof" json:"project,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -551,7 +551,7 @@ type MachineSizeCapacity struct { // Free is the amount of machines in a partition that can be freely allocated at any given moment by a project. // Effectively this is the amount of waiting machines minus the machines that are unavailable due to machine state or un-allocatable due to size reservations. Free int64 `protobuf:"varint,10,opt,name=free,proto3" json:"free,omitempty"` - // Unavailable is the amount of machine in a partition that are currently not allocatable because they are not waiting or + // Unavailable is the amount of machine in a partition that are currently not allocatable because they are not waiting or. // not in the machine state "available", e.g. locked or reserved. Unavailable int64 `protobuf:"varint,11,opt,name=unavailable,proto3" json:"unavailable,omitempty"` // Faulty is the amount of machines that are neither allocated nor in the pool of available machines because they report an error. diff --git a/go/metalstack/admin/v2/size.pb.go b/go/metalstack/admin/v2/size.pb.go index c8fe7ea3..a1c115b9 100644 --- a/go/metalstack/admin/v2/size.pb.go +++ b/go/metalstack/admin/v2/size.pb.go @@ -118,17 +118,17 @@ func (x *SizeServiceCreateResponse) GetSize() *v2.Size { // SizeServiceUpdateRequest is the request payload for updating a size. type SizeServiceUpdateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Id of this size + // Id of this size. 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 *v2.UpdateMeta `protobuf:"bytes,2,opt,name=update_meta,json=updateMeta,proto3" json:"update_meta,omitempty"` - // Name of this size + // Name of this size. Name *string `protobuf:"bytes,3,opt,name=name,proto3,oneof" json:"name,omitempty"` - // Description of this size + // Description of this size. Description *string `protobuf:"bytes,4,opt,name=description,proto3,oneof" json:"description,omitempty"` - // Constraints which must match that a specific machine is considered of this size + // Constraints which must match that a specific machine is considered of this size. Constraints []*v2.SizeConstraint `protobuf:"bytes,5,rep,name=constraints,proto3" json:"constraints,omitempty"` - // Labels to update on this size + // Labels to update on this size. Labels *v2.UpdateLabels `protobuf:"bytes,6,opt,name=labels,proto3,oneof" json:"labels,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -255,7 +255,7 @@ func (x *SizeServiceUpdateResponse) GetSize() *v2.Size { // SizeServiceDeleteRequest is the request payload for deleting a size. type SizeServiceDeleteRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // ID of the size to delete + // ID of the size to delete. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/admin/v2/size_imageconstraint.pb.go b/go/metalstack/admin/v2/size_imageconstraint.pb.go index f21ed3cd..7e30547d 100644 --- a/go/metalstack/admin/v2/size_imageconstraint.pb.go +++ b/go/metalstack/admin/v2/size_imageconstraint.pb.go @@ -26,15 +26,15 @@ const ( // SizeImageConstraintServiceCreateRequest is the request payload for creating a size image constraint. type SizeImageConstraintServiceCreateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Size of the constraint + // Size of the constraint. Size string `protobuf:"bytes,1,opt,name=size,proto3" json:"size,omitempty"` - // ImageConstraints to apply to this size + // ImageConstraints to apply to this size. ImageConstraints []*v2.ImageConstraint `protobuf:"bytes,2,rep,name=image_constraints,json=imageConstraints,proto3" json:"image_constraints,omitempty"` - // Meta for this size image constraint + // Meta for this size image constraint. Meta *v2.Meta `protobuf:"bytes,3,opt,name=meta,proto3" json:"meta,omitempty"` - // Name of this size image constraint + // Name of this size image constraint. Name *string `protobuf:"bytes,4,opt,name=name,proto3,oneof" json:"name,omitempty"` - // Description of this size image constraint + // Description of this size image constraint. Description *string `protobuf:"bytes,5,opt,name=description,proto3,oneof" json:"description,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -154,15 +154,15 @@ func (x *SizeImageConstraintServiceCreateResponse) GetSizeImageConstraint() *v2. // 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 + // Size of the image constraint to update. Size string `protobuf:"bytes,1,opt,name=size,proto3" json:"size,omitempty"` // 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"` - // ImageConstraints to apply to this size + // ImageConstraints to apply to this size. ImageConstraints []*v2.ImageConstraint `protobuf:"bytes,3,rep,name=image_constraints,json=imageConstraints,proto3" json:"image_constraints,omitempty"` - // Name of this size image constraint + // Name of this size image constraint. Name *string `protobuf:"bytes,4,opt,name=name,proto3,oneof" json:"name,omitempty"` - // Description of this size image constraint + // Description of this size image constraint. Description *string `protobuf:"bytes,5,opt,name=description,proto3,oneof" json:"description,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -282,7 +282,7 @@ func (x *SizeImageConstraintServiceUpdateResponse) GetSizeImageConstraint() *v2. // SizeImageConstraintServiceDeleteRequest is the request payload for deleting a size image constraint. type SizeImageConstraintServiceDeleteRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Size of the constraint + // Size of the constraint. Size string `protobuf:"bytes,1,opt,name=size,proto3" json:"size,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -374,7 +374,7 @@ func (x *SizeImageConstraintServiceDeleteResponse) GetSizeImageConstraint() *v2. // SizeImageConstraintServiceGetRequest is the request payload for getting a size image constraint. type SizeImageConstraintServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Size of the constraint + // Size of the constraint. Size string `protobuf:"bytes,1,opt,name=size,proto3" json:"size,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 da94b127..4cec4992 100644 --- a/go/metalstack/admin/v2/size_reservation.pb.go +++ b/go/metalstack/admin/v2/size_reservation.pb.go @@ -118,19 +118,19 @@ func (x *SizeReservationServiceCreateResponse) GetSizeReservation() *v2.SizeRese // SizeReservationServiceUpdateRequest is the request payload for updating a size reservation. type SizeReservationServiceUpdateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Id of this size reservation + // Id of this size reservation. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` - // Name of this size reservation + // Name of this size reservation. Name *string `protobuf:"bytes,2,opt,name=name,proto3,oneof" json:"name,omitempty"` - // Description of this size reservation + // Description of this size reservation. Description *string `protobuf:"bytes,3,opt,name=description,proto3,oneof" json:"description,omitempty"` // UpdateMeta contains the timestamp and strategy to be used in this update request. UpdateMeta *v2.UpdateMeta `protobuf:"bytes,4,opt,name=update_meta,json=updateMeta,proto3" json:"update_meta,omitempty"` - // Partition ids of this size reservation + // Partition ids of this size reservation. Partitions []string `protobuf:"bytes,5,rep,name=partitions,proto3" json:"partitions,omitempty"` - // Amount of reservations of this size reservation + // Amount of reservations of this size reservation. Amount *int32 `protobuf:"varint,6,opt,name=amount,proto3,oneof" json:"amount,omitempty"` - // Labels to update of this size reservation + // Labels to update of this size reservation. Labels *v2.UpdateLabels `protobuf:"bytes,7,opt,name=labels,proto3,oneof" json:"labels,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -264,7 +264,7 @@ func (x *SizeReservationServiceUpdateResponse) GetSizeReservation() *v2.SizeRese // 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 + // ID of the size reservation to delete. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/admin/v2/switch.pb.go b/go/metalstack/admin/v2/switch.pb.go index ba9527e2..cd479674 100644 --- a/go/metalstack/admin/v2/switch.pb.go +++ b/go/metalstack/admin/v2/switch.pb.go @@ -27,7 +27,7 @@ const ( // 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 @@ -165,7 +165,7 @@ func (x *SwitchServiceListRequest) GetQuery() *v2.SwitchQuery { // 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 @@ -211,14 +211,14 @@ func (x *SwitchServiceListResponse) GetSwitches() []*v2.Switch { // 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 *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 *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"` // 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"` @@ -385,7 +385,7 @@ func (x *SwitchServiceUpdateResponse) GetSwitch() *v2.Switch { // 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 bool `protobuf:"varint,2,opt,name=force,proto3" json:"force,omitempty"` @@ -587,11 +587,11 @@ func (x *SwitchServiceMigrateResponse) GetSwitch() *v2.Switch { // 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 @@ -651,7 +651,7 @@ func (x *SwitchServicePortRequest) GetStatus() v2.SwitchPortStatus { // 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 @@ -699,7 +699,7 @@ type SwitchServiceConnectedMachinesRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // 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 diff --git a/go/metalstack/admin/v2/task.pb.go b/go/metalstack/admin/v2/task.pb.go index 0a668254..8ff67698 100644 --- a/go/metalstack/admin/v2/task.pb.go +++ b/go/metalstack/admin/v2/task.pb.go @@ -330,7 +330,7 @@ func (*TaskServiceQueuesRequest) Descriptor() ([]byte, []int) { // TaskServiceQueuesResponse is the response payload for getting all queues. type TaskServiceQueuesResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Queues configured for the async system + // Queues configured for the async system. Queues []string `protobuf:"bytes,1,rep,name=queues,proto3" json:"queues,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -504,7 +504,7 @@ type TaskInfo struct { // 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 of the last failure if any. - // If the task has no failures, LastFailedAt is zero time (i.e. time.Time{}) + // 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 *durationpb.Duration `protobuf:"bytes,10,opt,name=timeout,proto3" json:"timeout,omitempty"` @@ -512,17 +512,17 @@ type TaskInfo struct { 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. // - // 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 + // 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. // // 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 + // 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. - // An orphaned task indicates that the worker has crashed or experienced network failures and was not able to - // extend its lease on the task + // An orphaned task indicates that the worker has crashed or experienced network failures and was not able to. + // 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. @@ -533,7 +533,7 @@ type TaskInfo struct { // 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 + // 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 ad0db648..933042b5 100644 --- a/go/metalstack/admin/v2/tenant.pb.go +++ b/go/metalstack/admin/v2/tenant.pb.go @@ -26,15 +26,15 @@ const ( // TenantServiceCreateRequest is the request payload for creating a tenant. type TenantServiceCreateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Name of the tenant + // Name of the tenant. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` - // Description of the 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 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"` - // AvatarUrl of the tenant + // AvatarUrl of the tenant. AvatarUrl *string `protobuf:"bytes,4,opt,name=avatar_url,json=avatarUrl,proto3,oneof" json:"avatar_url,omitempty"` - // Labels on the tenant + // Labels on the tenant. Labels *v2.Labels `protobuf:"bytes,5,opt,name=labels,proto3" json:"labels,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -255,11 +255,11 @@ func (x *TenantServiceListResponse) GetNextPage() uint64 { // TenantServiceAddMemberRequest is the request payload for adding a member to a tenant. type TenantServiceAddMemberRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Login of the tenant to which the member will be added + // Login of the tenant to which the member will be added. Tenant string `protobuf:"bytes,1,opt,name=tenant,proto3" json:"tenant,omitempty"` - // Login of the member to add + // Login of the member to add. Member string `protobuf:"bytes,2,opt,name=member,proto3" json:"member,omitempty"` - // Role to assign to the new member + // Role to assign to the new member. Role v2.TenantRole `protobuf:"varint,3,opt,name=role,proto3,enum=metalstack.api.v2.TenantRole" json:"role,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -365,9 +365,9 @@ func (x *TenantServiceAddMemberResponse) GetTenantMember() *v2.TenantMember { // TenantServiceRemoveMemberRequest is the request payload for removing a member from a tenant. type TenantServiceRemoveMemberRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Login of the tenant from which the member will be removed + // Login of the tenant from which the member will be removed. Tenant string `protobuf:"bytes,1,opt,name=tenant,proto3" json:"tenant,omitempty"` - // Login of the member to remove + // Login of the member to remove. Member string `protobuf:"bytes,2,opt,name=member,proto3" json:"member,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 7eb08e1e..53fcc91f 100644 --- a/go/metalstack/admin/v2/token.pb.go +++ b/go/metalstack/admin/v2/token.pb.go @@ -210,9 +210,9 @@ func (*TokenServiceRevokeResponse) Descriptor() ([]byte, []int) { // 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 + // User this token should be created for, if omitted, user is derived from caller. User *string `protobuf:"bytes,1,opt,name=user,proto3,oneof" json:"user,omitempty"` - // TokenCreateRequest which should be created + // TokenCreateRequest which should be created. TokenCreateRequest *v2.TokenServiceCreateRequest `protobuf:"bytes,2,opt,name=token_create_request,json=tokenCreateRequest,proto3" json:"token_create_request,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 c396f97b..e3ed9ce8 100644 --- a/go/metalstack/admin/v2/vpn.pb.go +++ b/go/metalstack/admin/v2/vpn.pb.go @@ -28,7 +28,7 @@ const ( // 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 authentication key 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 authentication key should be ephemeral. Ephemeral bool `protobuf:"varint,2,opt,name=ephemeral,proto3" json:"ephemeral,omitempty"` @@ -109,9 +109,9 @@ type VPNServiceAuthKeyResponse struct { AuthKey string `protobuf:"bytes,2,opt,name=auth_key,json=authKey,proto3" json:"auth_key,omitempty"` // 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 @@ -231,7 +231,7 @@ func (x *VPNServiceListNodesRequest) GetProject() string { // 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/project.connect.go b/go/metalstack/api/v2/apiv2connect/project.connect.go index 0f428fc2..74e16577 100644 --- a/go/metalstack/api/v2/apiv2connect/project.connect.go +++ b/go/metalstack/api/v2/apiv2connect/project.connect.go @@ -98,7 +98,7 @@ type ProjectServiceClient interface { InviteDelete(context.Context, *v2.ProjectServiceInviteDeleteRequest) (*v2.ProjectServiceInviteDeleteResponse, error) // InvitesList list all invites to a project. InvitesList(context.Context, *v2.ProjectServiceInvitesListRequest) (*v2.ProjectServiceInvitesListResponse, error) - // InviteGet get an invite + // InviteGet get an invite. InviteGet(context.Context, *v2.ProjectServiceInviteGetRequest) (*v2.ProjectServiceInviteGetResponse, error) } @@ -372,7 +372,7 @@ type ProjectServiceHandler interface { InviteDelete(context.Context, *v2.ProjectServiceInviteDeleteRequest) (*v2.ProjectServiceInviteDeleteResponse, error) // InvitesList list all invites to a project. InvitesList(context.Context, *v2.ProjectServiceInvitesListRequest) (*v2.ProjectServiceInvitesListResponse, error) - // InviteGet get an invite + // InviteGet get an invite. InviteGet(context.Context, *v2.ProjectServiceInviteGetRequest) (*v2.ProjectServiceInviteGetResponse, error) } diff --git a/go/metalstack/api/v2/apiv2connect/tenant.connect.go b/go/metalstack/api/v2/apiv2connect/tenant.connect.go index bb135439..9b99279a 100644 --- a/go/metalstack/api/v2/apiv2connect/tenant.connect.go +++ b/go/metalstack/api/v2/apiv2connect/tenant.connect.go @@ -86,7 +86,7 @@ type TenantServiceClient interface { AddMember(context.Context, *v2.TenantServiceAddMemberRequest) (*v2.TenantServiceAddMemberResponse, error) // RemoveMember removes a member from a tenant. RemoveMember(context.Context, *v2.TenantServiceRemoveMemberRequest) (*v2.TenantServiceRemoveMemberResponse, error) - // UpdateMember update a member of a tenant + // UpdateMember update a member of a tenant. UpdateMember(context.Context, *v2.TenantServiceUpdateMemberRequest) (*v2.TenantServiceUpdateMemberResponse, error) // Invite a user to a tenant. Invite(context.Context, *v2.TenantServiceInviteRequest) (*v2.TenantServiceInviteResponse, error) @@ -96,7 +96,7 @@ type TenantServiceClient interface { InviteDelete(context.Context, *v2.TenantServiceInviteDeleteRequest) (*v2.TenantServiceInviteDeleteResponse, error) // InvitesList list all invites to a tenant. InvitesList(context.Context, *v2.TenantServiceInvitesListRequest) (*v2.TenantServiceInvitesListResponse, error) - // InviteGet get an invite + // InviteGet get an invite. InviteGet(context.Context, *v2.TenantServiceInviteGetRequest) (*v2.TenantServiceInviteGetResponse, error) } @@ -360,7 +360,7 @@ type TenantServiceHandler interface { AddMember(context.Context, *v2.TenantServiceAddMemberRequest) (*v2.TenantServiceAddMemberResponse, error) // RemoveMember removes a member from a tenant. RemoveMember(context.Context, *v2.TenantServiceRemoveMemberRequest) (*v2.TenantServiceRemoveMemberResponse, error) - // UpdateMember update a member of a tenant + // UpdateMember update a member of a tenant. UpdateMember(context.Context, *v2.TenantServiceUpdateMemberRequest) (*v2.TenantServiceUpdateMemberResponse, error) // Invite a user to a tenant. Invite(context.Context, *v2.TenantServiceInviteRequest) (*v2.TenantServiceInviteResponse, error) @@ -370,7 +370,7 @@ type TenantServiceHandler interface { InviteDelete(context.Context, *v2.TenantServiceInviteDeleteRequest) (*v2.TenantServiceInviteDeleteResponse, error) // InvitesList list all invites to a tenant. InvitesList(context.Context, *v2.TenantServiceInvitesListRequest) (*v2.TenantServiceInvitesListResponse, error) - // InviteGet get an invite + // InviteGet get an invite. InviteGet(context.Context, *v2.TenantServiceInviteGetRequest) (*v2.TenantServiceInviteGetResponse, error) } diff --git a/go/metalstack/api/v2/audit.pb.go b/go/metalstack/api/v2/audit.pb.go index 88630a67..ce62f389 100644 --- a/go/metalstack/api/v2/audit.pb.go +++ b/go/metalstack/api/v2/audit.pb.go @@ -79,7 +79,7 @@ func (AuditPhase) EnumDescriptor() ([]byte, []int) { // AuditTrace is an audit trace. type AuditTrace struct { state protoimpl.MessageState `protogen:"open.v1"` - // Uuid of the audit trace + // 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 *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=timestamp,proto3" json:"timestamp,omitempty"` @@ -99,7 +99,7 @@ type AuditTrace struct { 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"` - // Meta for this audit trace + // Meta for this audit trace. Meta *Meta `protobuf:"bytes,11,opt,name=meta,proto3" json:"meta,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -215,7 +215,7 @@ func (x *AuditTrace) GetMeta() *Meta { // AuditQuery is the query for audit traces. type AuditQuery struct { state protoimpl.MessageState `protogen:"open.v1"` - // Uuid of the audit trace + // Uuid of the audit trace. Uuid *string `protobuf:"bytes,2,opt,name=uuid,proto3,oneof" json:"uuid,omitempty"` // From describes the start of the time window in which to list audit traces. Defaults to the last eight hours. From *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=from,proto3,oneof" json:"from,omitempty"` @@ -233,7 +233,7 @@ type AuditQuery struct { ResultCode *int32 `protobuf:"varint,9,opt,name=result_code,json=resultCode,proto3,oneof" json:"result_code,omitempty"` // Body is a string providing text-search of the body field. Body *string `protobuf:"bytes,10,opt,name=body,proto3,oneof" json:"body,omitempty"` - // Limit is a number limiting the length of the response (min: 1, max: 1000, defaults to 200) + // Limit is a number limiting the length of the response (min: 1, max: 1000, defaults to 200). Limit *int32 `protobuf:"varint,11,opt,name=limit,proto3,oneof" json:"limit,omitempty"` // Phase specifies the audit phase. Phase *AuditPhase `protobuf:"varint,12,opt,name=phase,proto3,enum=metalstack.api.v2.AuditPhase,oneof" json:"phase,omitempty"` @@ -351,7 +351,7 @@ func (x *AuditQuery) GetPhase() AuditPhase { // AuditServiceListRequest is the request payload for an audit list request. type AuditServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Login for this tenant + // Login for this tenant. Login string `protobuf:"bytes,1,opt,name=login,proto3" json:"login,omitempty"` // Query for audit traces. Query *AuditQuery `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"` @@ -452,9 +452,9 @@ func (x *AuditServiceListResponse) GetTraces() []*AuditTrace { // AuditServiceGetRequest is the request payload of a audit get request. type AuditServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Login for this tenant + // Login for this tenant. Login string `protobuf:"bytes,1,opt,name=login,proto3" json:"login,omitempty"` - // Uuid of the audit trace + // Uuid of the audit trace. Uuid string `protobuf:"bytes,2,opt,name=uuid,proto3" json:"uuid,omitempty"` // Phase specifies the audit phase. Defaults to request. Phase *AuditPhase `protobuf:"varint,3,opt,name=phase,proto3,enum=metalstack.api.v2.AuditPhase,oneof" json:"phase,omitempty"` diff --git a/go/metalstack/api/v2/common.pb.go b/go/metalstack/api/v2/common.pb.go index e9c5230b..8fb95c7f 100644 --- a/go/metalstack/api/v2/common.pb.go +++ b/go/metalstack/api/v2/common.pb.go @@ -30,13 +30,13 @@ type TenantRole int32 const ( // TENANT_ROLE_UNSPECIFIED is not specified. TenantRole_TENANT_ROLE_UNSPECIFIED TenantRole = 0 - // TENANT_ROLE_OWNER the logged in user needs at least owner role to call this method + // TENANT_ROLE_OWNER the logged in user needs at least owner role to call this method. TenantRole_TENANT_ROLE_OWNER TenantRole = 1 - // TENANT_ROLE_EDITOR the logged in user needs at least editor role to call this method + // TENANT_ROLE_EDITOR the logged in user needs at least editor role to call this method. TenantRole_TENANT_ROLE_EDITOR TenantRole = 2 - // TENANT_ROLE_VIEWER the logged in user needs at least viewer role to call this method + // TENANT_ROLE_VIEWER the logged in user needs at least viewer role to call this method. TenantRole_TENANT_ROLE_VIEWER TenantRole = 3 - // TENANT_ROLE_GUEST the logged in user needs at least guest role to call this method + // TENANT_ROLE_GUEST the logged in user needs at least guest role to call this method. // The guest role is assumed by users who are invited to a tenant's project without them. // having a direct membership within the tenant. TenantRole_TENANT_ROLE_GUEST TenantRole = 4 @@ -93,11 +93,11 @@ type ProjectRole int32 const ( // PROJECT_ROLE_UNSPECIFIED is not specified. ProjectRole_PROJECT_ROLE_UNSPECIFIED ProjectRole = 0 - // PROJECT_ROLE_OWNER the logged in user needs at least owner role to call this method + // PROJECT_ROLE_OWNER the logged in user needs at least owner role to call this method. ProjectRole_PROJECT_ROLE_OWNER ProjectRole = 1 - // PROJECT_ROLE_EDITOR the logged in user needs at least editor role to call this method + // PROJECT_ROLE_EDITOR the logged in user needs at least editor role to call this method. ProjectRole_PROJECT_ROLE_EDITOR ProjectRole = 2 - // PROJECT_ROLE_VIEWER the logged in user needs at least viewer role to call this method + // PROJECT_ROLE_VIEWER the logged in user needs at least viewer role to call this method. ProjectRole_PROJECT_ROLE_VIEWER ProjectRole = 3 ) @@ -150,9 +150,9 @@ type AdminRole int32 const ( // ADMIN_ROLE_UNSPECIFIED is not specified. AdminRole_ADMIN_ROLE_UNSPECIFIED AdminRole = 0 - // ADMIN_ROLE_EDITOR the logged in user needs at least editor role to call this method + // ADMIN_ROLE_EDITOR the logged in user needs at least editor role to call this method. AdminRole_ADMIN_ROLE_EDITOR AdminRole = 1 - // ADMIN_ROLE_VIEWER the logged in user needs at least viewer role to call this method + // ADMIN_ROLE_VIEWER the logged in user needs at least viewer role to call this method. AdminRole_ADMIN_ROLE_VIEWER AdminRole = 2 ) @@ -203,9 +203,9 @@ type InfraRole int32 const ( // INFRA_ROLE_UNSPECIFIED is not specified. InfraRole_INFRA_ROLE_UNSPECIFIED InfraRole = 0 - // INFRA_ROLE_EDITOR a microservice needs at least editor role to call this method + // INFRA_ROLE_EDITOR a microservice needs at least editor role to call this method. InfraRole_INFRA_ROLE_EDITOR InfraRole = 1 - // INFRA_ROLE_VIEWER a microservice needs at least viewer role to call this method + // INFRA_ROLE_VIEWER a microservice needs at least viewer role to call this method. InfraRole_INFRA_ROLE_VIEWER InfraRole = 2 ) @@ -256,9 +256,9 @@ type MachineRole int32 const ( // MACHINE_ROLE_UNSPECIFIED is not specified. MachineRole_MACHINE_ROLE_UNSPECIFIED MachineRole = 0 - // MACHINE_ROLE_EDITOR a microservice needs at least editor role to call this method + // MACHINE_ROLE_EDITOR a microservice needs at least editor role to call this method. MachineRole_MACHINE_ROLE_EDITOR MachineRole = 1 - // MACHINE_ROLE_VIEWER a microservice needs at least viewer role to call this method + // MACHINE_ROLE_VIEWER a microservice needs at least viewer role to call this method. MachineRole_MACHINE_ROLE_VIEWER MachineRole = 2 ) @@ -303,7 +303,7 @@ func (MachineRole) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_common_proto_rawDescGZIP(), []int{4} } -// Visibility of a method +// Visibility of a method. type Visibility int32 const ( @@ -311,7 +311,7 @@ const ( Visibility_VISIBILITY_UNSPECIFIED Visibility = 0 // VISIBILITY_PUBLIC specifies that this service is accessible without authentication. Visibility_VISIBILITY_PUBLIC Visibility = 1 - // VISIBILITY_SELF restricts calls to the authenticated user only + // VISIBILITY_SELF restricts calls to the authenticated user only. Visibility_VISIBILITY_SELF Visibility = 2 ) @@ -356,17 +356,17 @@ func (Visibility) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_common_proto_rawDescGZIP(), []int{5} } -// Auditing option specified per service method -// by default all service methods are included -// add the auditing option if you want to exclude a method in auditing +// Auditing option specified per service method. +// By default all service methods are included. +// Add the auditing option if you want to exclude a method in auditing. type Auditing int32 const ( // AUDITING_UNSPECIFIED is not specified. Auditing_AUDITING_UNSPECIFIED Auditing = 0 - // AUDITING_INCLUDED if a method is annotated with this, all calls are audited + // AUDITING_INCLUDED if a method is annotated with this, all calls are audited. Auditing_AUDITING_INCLUDED Auditing = 1 - // AUDITING_EXCLUDED if a method is annotated with this, no calls are audited + // AUDITING_EXCLUDED if a method is annotated with this, no calls are audited. Auditing_AUDITING_EXCLUDED Auditing = 2 ) @@ -412,16 +412,16 @@ func (Auditing) EnumDescriptor() ([]byte, []int) { } // OptimisticLockingStrategy defines how optimistic locking should be handled. -// It defaults to client side, which requires the UpdatedAt timestamp to be provided +// It defaults to client side, which requires the UpdatedAt timestamp to be provided. type OptimisticLockingStrategy int32 const ( - // OPTIMISTIC_LOCKING_STRATEGY_UNSPECIFIED same as client side + // OPTIMISTIC_LOCKING_STRATEGY_UNSPECIFIED same as client side. OptimisticLockingStrategy_OPTIMISTIC_LOCKING_STRATEGY_UNSPECIFIED OptimisticLockingStrategy = 0 - // OPTIMISTIC_LOCKING_STRATEGY_CLIENT requires UpdatedAt to be specified + // OPTIMISTIC_LOCKING_STRATEGY_CLIENT requires UpdatedAt to be specified. OptimisticLockingStrategy_OPTIMISTIC_LOCKING_STRATEGY_CLIENT OptimisticLockingStrategy = 1 - // OPTIMISTIC_LOCKING_STRATEGY_SERVER allows to omit UpdatedAt - // and fetches the most recent entity before updating with the given values with the update request + // OPTIMISTIC_LOCKING_STRATEGY_SERVER allows to omit UpdatedAt. + // and fetches the most recent entity before updating with the given values with the update request. OptimisticLockingStrategy_OPTIMISTIC_LOCKING_STRATEGY_SERVER OptimisticLockingStrategy = 2 ) @@ -469,7 +469,7 @@ func (OptimisticLockingStrategy) EnumDescriptor() ([]byte, []int) { // Paging defines paging for methods with a lot of results. type Paging struct { state protoimpl.MessageState `protogen:"open.v1"` - // Page is used for pagination, if unset only the first page is returned, + // Page is used for pagination, if unset only the first page is returned,. // the list response contains then the page number for the next page. Page *uint64 `protobuf:"varint,1,opt,name=page,proto3,oneof" json:"page,omitempty"` // Count is the number of results returned per page, if not given server side defaults apply. @@ -525,7 +525,7 @@ func (x *Paging) GetCount() uint64 { // Labels define additional information to a entity. type Labels struct { state protoimpl.MessageState `protogen:"open.v1"` - // Labels consists labels + // Labels consists labels. Labels map[string]string `protobuf:"bytes,1,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -568,15 +568,15 @@ func (x *Labels) GetLabels() map[string]string { return nil } -// Meta of a message +// Meta of a message. type Meta struct { state protoimpl.MessageState `protogen:"open.v1"` - // Tags on this entity + // Tags on this entity. Labels *Labels `protobuf:"bytes,1,opt,name=labels,proto3,oneof" json:"labels,omitempty"` // CreatedAt is the date when this entity was created. CreatedAt *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"` // UpdatedAt is the date when this entity was updated. - // must be part of the update request to ensure optimistic locking + // 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"` // Generation identifies how often this entity was modified since creation. Generation uint64 `protobuf:"varint,4,opt,name=generation,proto3" json:"generation,omitempty"` @@ -726,7 +726,7 @@ type isUpdateLabels_Strategy interface { } type UpdateLabels_Replace struct { - // Replace existing labels with the given ones + // Replace existing labels with the given ones. Replace *Labels `protobuf:"bytes,1,opt,name=replace,proto3,oneof"` } @@ -798,9 +798,9 @@ func (x *LabelsPatch) GetRemove() []string { type UpdateMeta struct { state protoimpl.MessageState `protogen:"open.v1"` // UpdatedAt is the date when this entity was updated. - // must be part of the update request to ensure optimistic locking + // Must be part of the update request to ensure optimistic locking. UpdatedAt *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"` - // LockingStrategy to be used for this update request + // LockingStrategy to be used for this update request. LockingStrategy OptimisticLockingStrategy `protobuf:"varint,2,opt,name=locking_strategy,json=lockingStrategy,proto3,enum=metalstack.api.v2.OptimisticLockingStrategy" json:"locking_strategy,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -951,7 +951,7 @@ var ( // Extension fields to descriptorpb.EnumValueOptions. var ( - // StringValue which can be set to a enum + // StringValue which can be set to a enum. // // optional string enum_string_value = 52000; E_EnumStringValue = &file_metalstack_api_v2_common_proto_extTypes[7] diff --git a/go/metalstack/api/v2/component.pb.go b/go/metalstack/api/v2/component.pb.go index ae66afc6..ab37ffdf 100644 --- a/go/metalstack/api/v2/component.pb.go +++ b/go/metalstack/api/v2/component.pb.go @@ -109,11 +109,11 @@ type Component struct { ReportedAt *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=reported_at,json=reportedAt,proto3" json:"reported_at,omitempty"` // Interval at which the ping is scheduled. Interval *durationpb.Duration `protobuf:"bytes,6,opt,name=interval,proto3" json:"interval,omitempty"` - // Version of this service + // Version of this service. Version *Version `protobuf:"bytes,7,opt,name=version,proto3" json:"version,omitempty"` // Token is the token which is actually used by this microservice. Token *Token `protobuf:"bytes,8,opt,name=token,proto3" json:"token,omitempty"` - // Meta for this component + // Meta for this component. Meta *Meta `protobuf:"bytes,9,opt,name=meta,proto3" json:"meta,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -212,7 +212,7 @@ func (x *Component) GetMeta() *Meta { return nil } -// ComponentQuery to query components +// ComponentQuery to query components. type ComponentQuery struct { state protoimpl.MessageState `protogen:"open.v1"` // UUID identifies this component. diff --git a/go/metalstack/api/v2/filesystem.pb.go b/go/metalstack/api/v2/filesystem.pb.go index a2552191..98db6d8a 100644 --- a/go/metalstack/api/v2/filesystem.pb.go +++ b/go/metalstack/api/v2/filesystem.pb.go @@ -22,17 +22,17 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) -// LVMType +// LVMType. type LVMType int32 const ( // LVM_TYPE_UNSPECIFIED is not specified. LVMType_LVM_TYPE_UNSPECIFIED LVMType = 0 - // LVM_TYPE_LINEAR append across all physical volumes + // LVM_TYPE_LINEAR append across all physical volumes. LVMType_LVM_TYPE_LINEAR LVMType = 1 - // LVM_TYPE_STRIPED stripe across all physical volumes + // LVM_TYPE_STRIPED stripe across all physical volumes. LVMType_LVM_TYPE_STRIPED LVMType = 2 - // LVM_TYPE_RAID1 mirror with raid across all physical volumes + // LVM_TYPE_RAID1 mirror with raid across all physical volumes. LVMType_LVM_TYPE_RAID1 LVMType = 3 ) @@ -83,7 +83,7 @@ func (LVMType) EnumDescriptor() ([]byte, []int) { type Format int32 const ( - // FORMAT_UNSPECIFIED + // FORMAT_UNSPECIFIED. Format_FORMAT_UNSPECIFIED Format = 0 // FORMAT_VFAT is used for the UEFI boot partition. Format_FORMAT_VFAT Format = 1 @@ -95,7 +95,7 @@ const ( Format_FORMAT_SWAP Format = 4 // FORMAT_TMPFS is used for a memory filesystem typically /tmp. Format_FORMAT_TMPFS Format = 5 - // FORMAT_NONE + // FORMAT_NONE. Format_FORMAT_NONE Format = 6 ) @@ -154,13 +154,13 @@ type GPTType int32 const ( // GPT_TYPE_UNSPECIFIED is no specified. GPTType_GPT_TYPE_UNSPECIFIED GPTType = 0 - // GPT_TYPE_BOOT EFI Boot Partition + // GPT_TYPE_BOOT EFI Boot Partition. GPTType_GPT_TYPE_BOOT GPTType = 1 - // GPT_TYPE_LINUX Linux Partition + // GPT_TYPE_LINUX Linux Partition. GPTType_GPT_TYPE_LINUX GPTType = 2 - // GPT_TYPE_LINUX_RAID Linux Raid Partition + // GPT_TYPE_LINUX_RAID Linux Raid Partition. GPTType_GPT_TYPE_LINUX_RAID GPTType = 3 - // GPT_TYPE_LINUX_LVM Linux LVM Partition + // GPT_TYPE_LINUX_LVM Linux LVM Partition. GPTType_GPT_TYPE_LINUX_LVM GPTType = 4 ) @@ -265,7 +265,7 @@ func (RaidLevel) EnumDescriptor() ([]byte, []int) { // FilesystemServiceGetRequest is the request payload for a filesystem get request. type FilesystemServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // ID of the filesystem to get + // ID of the filesystem to get. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -311,7 +311,7 @@ func (x *FilesystemServiceGetRequest) GetId() string { // FilesystemServiceListRequest is the request payload for a filesystem list request. type FilesystemServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // ID of the filesystem to get + // ID of the filesystem to get. Id *string `protobuf:"bytes,1,opt,name=id,proto3,oneof" json:"id,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -357,7 +357,7 @@ func (x *FilesystemServiceListRequest) GetId() string { // FilesystemServiceGetResponse is the response payload for a filesystem get request. type FilesystemServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // FilesystemLayout the filesystemlayout + // FilesystemLayout the filesystemlayout. FilesystemLayout *FilesystemLayout `protobuf:"bytes,1,opt,name=filesystem_layout,json=filesystemLayout,proto3" json:"filesystem_layout,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -403,7 +403,7 @@ func (x *FilesystemServiceGetResponse) GetFilesystemLayout() *FilesystemLayout { // FilesystemServiceListResponse is the response payload for a filesystem list request. type FilesystemServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // FilesystemLayouts the filesystemlayouts + // FilesystemLayouts the filesystemlayouts. FilesystemLayouts []*FilesystemLayout `protobuf:"bytes,1,rep,name=filesystem_layouts,json=filesystemLayouts,proto3" json:"filesystem_layouts,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -446,28 +446,28 @@ func (x *FilesystemServiceListResponse) GetFilesystemLayouts() []*FilesystemLayo return nil } -// FilesystemLayout +// FilesystemLayout. type FilesystemLayout struct { state protoimpl.MessageState `protogen:"open.v1"` - // Id of this filesystemLayout + // Id of this filesystemLayout. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` - // Meta for this filesystemLayout + // Meta for this filesystemLayout. Meta *Meta `protobuf:"bytes,2,opt,name=meta,proto3" json:"meta,omitempty"` - // Name of this filesystemLayout + // Name of this filesystemLayout. Name *string `protobuf:"bytes,3,opt,name=name,proto3,oneof" json:"name,omitempty"` - // Description of this filesystemLayout + // Description of this filesystemLayout. Description *string `protobuf:"bytes,4,opt,name=description,proto3,oneof" json:"description,omitempty"` // Filesystems is a list of filesystems to create on a machine. Filesystems []*Filesystem `protobuf:"bytes,5,rep,name=filesystems,proto3" json:"filesystems,omitempty"` // Disks list of disks that belong to this layout. Disks []*Disk `protobuf:"bytes,6,rep,name=disks,proto3" json:"disks,omitempty"` - // raid arrays to create + // Raid arrays to create. Raid []*Raid `protobuf:"bytes,7,rep,name=raid,proto3" json:"raid,omitempty"` // VolumeGroups list of volumegroups to create. VolumeGroups []*VolumeGroup `protobuf:"bytes,8,rep,name=volume_groups,json=volumeGroups,proto3" json:"volume_groups,omitempty"` // LogicalVolumes list of logicalvolumes to create. LogicalVolumes []*LogicalVolume `protobuf:"bytes,9,rep,name=logical_volumes,json=logicalVolumes,proto3" json:"logical_volumes,omitempty"` - // Constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts + // Constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts. Constraints *FilesystemLayoutConstraints `protobuf:"bytes,10,opt,name=constraints,proto3" json:"constraints,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -573,17 +573,17 @@ func (x *FilesystemLayout) GetConstraints() *FilesystemLayoutConstraints { return nil } -// FilesystemLayoutConstraints +// FilesystemLayoutConstraints. type FilesystemLayoutConstraints struct { state protoimpl.MessageState `protogen:"open.v1"` // Sizes list of sizes this layout applies to. - // this could either be a concrete size, or a asterisk to match all sizes + // This could either be a concrete size, or a asterisk to match all sizes. Sizes []string `protobuf:"bytes,1,rep,name=sizes,proto3" json:"sizes,omitempty"` - // Images list of images this layout applies to in the following form. - // key must be the first part of available images, e.g. the name of the image - // value must be a semver match expression with the constraint and the version separated by space - // this would match all debian images which are greater or equal 12.0 - // "debian":">= 12.0" + // Images list of images this layout applies to in the following form: + // Key must be the first part of available images, e.g. the name of the imag. + // Value must be a semver match expression with the constraint and the version separated by space. + // This would match all debian images which are greater or equal 12: + // "debian": >= 12.0. Images map[string]string `protobuf:"bytes,2,rep,name=images,proto3" json:"images,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"bytes,2,opt,name=value"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -633,24 +633,24 @@ func (x *FilesystemLayoutConstraints) GetImages() map[string]string { return nil } -// Filesystem +// Filesystem. type Filesystem struct { state protoimpl.MessageState `protogen:"open.v1"` - // Device the underlying device where this filesystem should be created + // Device the underlying device where this filesystem should be created. Device string `protobuf:"bytes,1,opt,name=device,proto3" json:"device,omitempty"` - // Format of the filesystem format + // Format of the filesystem format. Format Format `protobuf:"varint,2,opt,name=format,proto3,enum=metalstack.api.v2.Format" json:"format,omitempty"` - // Name of this filesystem + // Name of this filesystem. Name *string `protobuf:"bytes,3,opt,name=name,proto3,oneof" json:"name,omitempty"` - // Description of this filesystem + // Description of this filesystem. Description *string `protobuf:"bytes,4,opt,name=description,proto3,oneof" json:"description,omitempty"` - // Path the mountpoint where this filesystem should be mounted on + // Path the mountpoint where this filesystem should be mounted on. Path *string `protobuf:"bytes,5,opt,name=path,proto3,oneof" json:"path,omitempty"` - // Label an optional label for this filesystem + // Label an optional label for this filesystem. Label *string `protobuf:"bytes,6,opt,name=label,proto3,oneof" json:"label,omitempty"` - // MountOptions the options to use to mount this filesystem + // MountOptions the options to use to mount this filesystem. MountOptions []string `protobuf:"bytes,7,rep,name=mount_options,json=mountOptions,proto3" json:"mount_options,omitempty"` - // CreateOptions the options to use to create (mkfs) this filesystem + // CreateOptions the options to use to create (mkfs) this filesystem. CreateOptions []string `protobuf:"bytes,8,rep,name=create_options,json=createOptions,proto3" json:"create_options,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -742,10 +742,10 @@ func (x *Filesystem) GetCreateOptions() []string { return nil } -// Disk +// Disk. type Disk struct { state protoimpl.MessageState `protogen:"open.v1"` - // Device the device to create the partitions + // Device the device to create the partitions. Device string `protobuf:"bytes,1,opt,name=device,proto3" json:"device,omitempty"` // Partitions list of partitions to create on this disk. Partitions []*DiskPartition `protobuf:"bytes,2,rep,name=partitions,proto3" json:"partitions,omitempty"` @@ -797,18 +797,18 @@ func (x *Disk) GetPartitions() []*DiskPartition { return nil } -// Raid +// Raid. type Raid struct { state protoimpl.MessageState `protogen:"open.v1"` - // ArrayName the name of the resulting array device + // ArrayName the name of the resulting array device. ArrayName string `protobuf:"bytes,1,opt,name=array_name,json=arrayName,proto3" json:"array_name,omitempty"` // Devices list of devices to form the raid array from. Devices []string `protobuf:"bytes,2,rep,name=devices,proto3" json:"devices,omitempty"` // Level raid level to create, should be 0 or 1. Level RaidLevel `protobuf:"varint,3,opt,name=level,proto3,enum=metalstack.api.v2.RaidLevel" json:"level,omitempty"` - // CreateOptions the options to use to create the raid array + // CreateOptions the options to use to create the raid array. CreateOptions []string `protobuf:"bytes,4,rep,name=create_options,json=createOptions,proto3" json:"create_options,omitempty"` - // Spares number of spares for the raid array + // Spares number of spares for the raid array. Spares int32 `protobuf:"varint,5,opt,name=spares,proto3" json:"spares,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -879,16 +879,16 @@ func (x *Raid) GetSpares() int32 { return 0 } -// DiskPartition +// DiskPartition. type DiskPartition struct { state protoimpl.MessageState `protogen:"open.v1"` // Number partition number, will be appended to partitionprefix to create the final devicename. Number uint32 `protobuf:"varint,1,opt,name=number,proto3" json:"number,omitempty"` - // Label an optional label for this partition + // Label an optional label for this partition. Label *string `protobuf:"bytes,2,opt,name=label,proto3,oneof" json:"label,omitempty"` - // Size in mebibytes (MiB) of this partition + // Size in mebibytes (MiB) of this partition. Size uint64 `protobuf:"varint,3,opt,name=size,proto3" json:"size,omitempty"` - // GPTType the gpt partition table type of this partition + // GPTType the gpt partition table type of this partition. GptType *GPTType `protobuf:"varint,4,opt,name=gpt_type,json=gptType,proto3,enum=metalstack.api.v2.GPTType,oneof" json:"gpt_type,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -952,10 +952,10 @@ func (x *DiskPartition) GetGptType() GPTType { return GPTType_GPT_TYPE_UNSPECIFIED } -// VolumeGroup +// VolumeGroup. type VolumeGroup struct { state protoimpl.MessageState `protogen:"open.v1"` - // Name the name of the resulting volume group + // Name the name of the resulting volume group. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Devices list of devices to form the volume group from. Devices []string `protobuf:"bytes,2,rep,name=devices,proto3" json:"devices,omitempty"` @@ -1016,16 +1016,16 @@ func (x *VolumeGroup) GetTags() []string { return nil } -// LogicalVolume +// LogicalVolume. type LogicalVolume struct { state protoimpl.MessageState `protogen:"open.v1"` - // Name the name of the logical volume + // Name the name of the logical volume. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` - // VolumeGroup the name of the volume group where to create the logical volume onto + // VolumeGroup the name of the volume group where to create the logical volume onto. VolumeGroup string `protobuf:"bytes,2,opt,name=volume_group,json=volumeGroup,proto3" json:"volume_group,omitempty"` - // Size size in mebibytes (MiB) of this volume + // Size size in mebibytes (MiB) of this volume. Size uint64 `protobuf:"varint,3,opt,name=size,proto3" json:"size,omitempty"` - // LVMType the type of this logical volume can be either linear|striped|raid1 + // LVMType the type of this logical volume can be either linear|striped|raid1. LvmType LVMType `protobuf:"varint,4,opt,name=lvm_type,json=lvmType,proto3,enum=metalstack.api.v2.LVMType" json:"lvm_type,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/api/v2/health.pb.go b/go/metalstack/api/v2/health.pb.go index fd8322b8..294107cc 100644 --- a/go/metalstack/api/v2/health.pb.go +++ b/go/metalstack/api/v2/health.pb.go @@ -25,13 +25,13 @@ const ( type ServiceStatus int32 const ( - // SERVICE_STATUS_UNSPECIFIED service status is not known or unspecified + // SERVICE_STATUS_UNSPECIFIED service status is not known or unspecified. ServiceStatus_SERVICE_STATUS_UNSPECIFIED ServiceStatus = 0 - // SERVICE_STATUS_DEGRADED the service is in degraded status, not the whole functionality is available + // SERVICE_STATUS_DEGRADED the service is in degraded status, not the whole functionality is available. ServiceStatus_SERVICE_STATUS_DEGRADED ServiceStatus = 1 - // SERVICE_STATUS_UNHEALTHY the service is in unhealthy status, serious impact is expected + // 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, for example fully functional + // SERVICE_STATUS_HEALTHY the service is in healthy status, for example fully functional. ServiceStatus_SERVICE_STATUS_HEALTHY ServiceStatus = 3 ) @@ -84,21 +84,21 @@ 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_TENANT_APISERVER the tenant-apiserver + // SERVICE_TENANT_APISERVER the tenant-apiserver. Service_SERVICE_TENANT_APISERVER Service = 3 - // SERVICE_MACHINES the machine service + // SERVICE_MACHINES the machine service. Service_SERVICE_MACHINES Service = 4 - // SERVICE_AUDIT the auditing + // 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_TASKS the tasks service. Service_SERVICE_TASKS Service = 8 ) diff --git a/go/metalstack/api/v2/image.pb.go b/go/metalstack/api/v2/image.pb.go index 22ecdc3f..42a1370d 100644 --- a/go/metalstack/api/v2/image.pb.go +++ b/go/metalstack/api/v2/image.pb.go @@ -23,7 +23,7 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) -// ImageFeature +// ImageFeature. type ImageFeature int32 const ( @@ -76,7 +76,7 @@ func (ImageFeature) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_image_proto_rawDescGZIP(), []int{0} } -// Image +// Image. type ImageClassification int32 const ( @@ -136,7 +136,7 @@ func (ImageClassification) EnumDescriptor() ([]byte, []int) { // ImageServiceGetRequest is the request payload for an image get request. type ImageServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // ID of the image to get + // ID of the image to get. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -228,10 +228,10 @@ func (x *ImageServiceListRequest) GetQuery() *ImageQuery { // ImageServiceLatestRequest is the request payload for an image latest request. type ImageServiceLatestRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // OS for which the latest image should be fetched - // should contain os and major.minor then latest patch version of this os is returned + // OS for which the latest image should be fetched. + // Should contain os and major.minor then latest patch version of this os is returned. Os string `protobuf:"bytes,1,opt,name=os,proto3" json:"os,omitempty"` - // Classification of the image latest image + // Classification of the image latest image. Classification *ImageClassification `protobuf:"varint,2,opt,name=classification,proto3,enum=metalstack.api.v2.ImageClassification,oneof" json:"classification,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -284,7 +284,7 @@ func (x *ImageServiceLatestRequest) GetClassification() ImageClassification { // ImageServiceGetResponse is the response payload for an image get request. type ImageServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Image the image + // Image the image. Image *Image `protobuf:"bytes,1,opt,name=image,proto3" json:"image,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -330,7 +330,7 @@ func (x *ImageServiceGetResponse) GetImage() *Image { // ImageServiceListResponse is the response payload for an image list request. type ImageServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Images the images + // Images the images. Images []*Image `protobuf:"bytes,1,rep,name=images,proto3" json:"images,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -376,7 +376,7 @@ func (x *ImageServiceListResponse) GetImages() []*Image { // ImageServiceLatestResponse is the response payload for an image latest request. type ImageServiceLatestResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Image which is the latest for one os + // Image which is the latest for one os. Image *Image `protobuf:"bytes,1,opt,name=image,proto3" json:"image,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -419,22 +419,22 @@ func (x *ImageServiceLatestResponse) GetImage() *Image { return nil } -// Image +// Image. type Image struct { state protoimpl.MessageState `protogen:"open.v1"` - // Id of this image + // Id of this image. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` - // Meta for this image + // Meta for this image. Meta *Meta `protobuf:"bytes,2,opt,name=meta,proto3" json:"meta,omitempty"` - // URL where this image is located + // URL where this image is located. Url string `protobuf:"bytes,3,opt,name=url,proto3" json:"url,omitempty"` - // Name of this image + // Name of this image. Name *string `protobuf:"bytes,4,opt,name=name,proto3,oneof" json:"name,omitempty"` - // Description of this image + // Description of this image. Description *string `protobuf:"bytes,5,opt,name=description,proto3,oneof" json:"description,omitempty"` - // Features of this image + // Features of this image. Features []ImageFeature `protobuf:"varint,6,rep,packed,name=features,proto3,enum=metalstack.api.v2.ImageFeature" json:"features,omitempty"` - // Classification of this image + // Classification of this image. Classification ImageClassification `protobuf:"varint,7,opt,name=classification,proto3,enum=metalstack.api.v2.ImageClassification" json:"classification,omitempty"` // ExpiresAt usage is not possible after this date. ExpiresAt *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"` @@ -531,9 +531,9 @@ func (x *Image) GetExpiresAt() *timestamppb.Timestamp { // ImageUsage reports which machines/firewalls actually use this image. type ImageUsage struct { state protoimpl.MessageState `protogen:"open.v1"` - // Image with usage + // Image with usage. Image *Image `protobuf:"bytes,1,opt,name=image,proto3" json:"image,omitempty"` - // UsedBy the following machines/firewalls + // UsedBy the following machines/firewalls. UsedBy []string `protobuf:"bytes,2,rep,name=used_by,json=usedBy,proto3" json:"used_by,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -586,21 +586,21 @@ func (x *ImageUsage) GetUsedBy() []string { // ImageQuery is used to search images. type ImageQuery struct { state protoimpl.MessageState `protogen:"open.v1"` - // ID of the image to get + // ID of the image to get. Id *string `protobuf:"bytes,1,opt,name=id,proto3,oneof" json:"id,omitempty"` - // OS of the image + // OS of the image. Os *string `protobuf:"bytes,2,opt,name=os,proto3,oneof" json:"os,omitempty"` - // Version of the Image + // Version of the Image. Version *string `protobuf:"bytes,3,opt,name=version,proto3,oneof" json:"version,omitempty"` - // Name of the image to query + // Name of the image to query. Name *string `protobuf:"bytes,4,opt,name=name,proto3,oneof" json:"name,omitempty"` - // Description of the image to query + // Description of the image to query. Description *string `protobuf:"bytes,5,opt,name=description,proto3,oneof" json:"description,omitempty"` - // Url of the image to query + // Url of the image to query. Url *string `protobuf:"bytes,6,opt,name=url,proto3,oneof" json:"url,omitempty"` - // Feature of the image to query + // Feature of the image to query. Feature *ImageFeature `protobuf:"varint,7,opt,name=feature,proto3,enum=metalstack.api.v2.ImageFeature,oneof" json:"feature,omitempty"` - // Classification of the image to query + // Classification of the image to query. Classification *ImageClassification `protobuf:"varint,8,opt,name=classification,proto3,enum=metalstack.api.v2.ImageClassification,oneof" json:"classification,omitempty"` // Labels lists only images containing the given labels. Labels *Labels `protobuf:"bytes,9,opt,name=labels,proto3,oneof" json:"labels,omitempty"` diff --git a/go/metalstack/api/v2/ip.pb.go b/go/metalstack/api/v2/ip.pb.go index 60d599ff..bebfd88a 100644 --- a/go/metalstack/api/v2/ip.pb.go +++ b/go/metalstack/api/v2/ip.pb.go @@ -131,24 +131,24 @@ func (IPAddressFamily) EnumDescriptor() ([]byte, []int) { // IP is an IP address which can be used as loadbalancer addresses. type IP struct { state protoimpl.MessageState `protogen:"open.v1"` - // Uuid of this ip + // Uuid of this ip. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` - // Meta for this ip + // Meta for this ip. Meta *Meta `protobuf:"bytes,2,opt,name=meta,proto3" json:"meta,omitempty"` // Ip is either ipv4 or ipv6 address. Ip string `protobuf:"bytes,3,opt,name=ip,proto3" json:"ip,omitempty"` - // Name of this ip + // Name of this ip. Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"` - // Description of this ip + // Description of this ip. Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"` // Network is the network this ip belongs to. Network string `protobuf:"bytes,6,opt,name=network,proto3" json:"network,omitempty"` // Project where this ip address belongs to. Project string `protobuf:"bytes,7,opt,name=project,proto3" json:"project,omitempty"` - // Type of this ip + // Type of this ip. Type IPType `protobuf:"varint,8,opt,name=type,proto3,enum=metalstack.api.v2.IPType" json:"type,omitempty"` // Namespace if specified this ip is from a namespaced network and can therefore overlap with others. - // Will be equal with project most of the time + // Will be equal with project most of the time. Namespace *string `protobuf:"bytes,9,opt,name=namespace,proto3,oneof" json:"namespace,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -250,9 +250,9 @@ func (x *IP) GetNamespace() string { // IPServiceGetRequest is the request payload for an IP get request. type IPServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // IP of the ip to get + // IP of the ip to get. Ip string `protobuf:"bytes,1,opt,name=ip,proto3" json:"ip,omitempty"` - // Project of the ip + // Project of the ip. Project string `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"` // Namespace can be specified to get the ip of a namespace. Namespace *string `protobuf:"bytes,3,opt,name=namespace,proto3,oneof" json:"namespace,omitempty"` @@ -316,21 +316,21 @@ type IPServiceCreateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Network from which the IP should be created. Network string `protobuf:"bytes,1,opt,name=network,proto3" json:"network,omitempty"` - // Project of the ip + // Project of the ip. Project string `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"` - // Name of the ip + // Name of the ip. Name *string `protobuf:"bytes,3,opt,name=name,proto3,oneof" json:"name,omitempty"` - // Description of the ip + // Description of the ip. Description *string `protobuf:"bytes,4,opt,name=description,proto3,oneof" json:"description,omitempty"` - // IP if given try to create this ip if still available + // IP if given try to create this ip if still available. Ip *string `protobuf:"bytes,5,opt,name=ip,proto3,oneof" json:"ip,omitempty"` - // Machine for which this ip should get created + // Machine for which this ip should get created. Machine *string `protobuf:"bytes,6,opt,name=machine,proto3,oneof" json:"machine,omitempty"` - // Labels to put onto the ip + // Labels to put onto the ip. Labels *Labels `protobuf:"bytes,7,opt,name=labels,proto3,oneof" json:"labels,omitempty"` - // Type of the IP, ether ephemeral (default), or static + // Type of the IP, ether ephemeral (default), or static. Type *IPType `protobuf:"varint,8,opt,name=type,proto3,enum=metalstack.api.v2.IPType,oneof" json:"type,omitempty"` - // Addressfamily of the IP to create, defaults to ipv4 + // Addressfamily of the IP to create, defaults to ipv4. AddressFamily *IPAddressFamily `protobuf:"varint,9,opt,name=address_family,json=addressFamily,proto3,enum=metalstack.api.v2.IPAddressFamily,oneof" json:"address_family,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -432,19 +432,19 @@ func (x *IPServiceCreateRequest) GetAddressFamily() IPAddressFamily { // IPServiceUpdateRequest is the request payload for an IP update request. type IPServiceUpdateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Ip the ip address to update + // Ip the ip address to update. Ip string `protobuf:"bytes,1,opt,name=ip,proto3" json:"ip,omitempty"` // UpdateMeta contains the timestamp and strategy to be used in this update request. UpdateMeta *UpdateMeta `protobuf:"bytes,2,opt,name=update_meta,json=updateMeta,proto3" json:"update_meta,omitempty"` - // Project id of the ip + // Project id of the ip. Project string `protobuf:"bytes,3,opt,name=project,proto3" json:"project,omitempty"` - // Name of this ip + // Name of this ip. Name *string `protobuf:"bytes,4,opt,name=name,proto3,oneof" json:"name,omitempty"` - // Description of this ip + // Description of this ip. Description *string `protobuf:"bytes,5,opt,name=description,proto3,oneof" json:"description,omitempty"` - // Type of this ip + // Type of this ip. Type *IPType `protobuf:"varint,6,opt,name=type,proto3,enum=metalstack.api.v2.IPType,oneof" json:"type,omitempty"` - // Labels on this ip + // Labels on this ip. Labels *UpdateLabels `protobuf:"bytes,7,opt,name=labels,proto3,oneof" json:"labels,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -532,7 +532,7 @@ func (x *IPServiceUpdateRequest) GetLabels() *UpdateLabels { // IPServiceListRequest is the request payload for an IP list request. type IPServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Project of the ips to list + // Project of the ips to list. Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` // Query to list one or more IPs. Query *IPQuery `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"` @@ -587,21 +587,21 @@ func (x *IPServiceListRequest) GetQuery() *IPQuery { // IPQuery can be used to query a IP or a list of IP. type IPQuery struct { state protoimpl.MessageState `protogen:"open.v1"` - // Ip the ip to list + // Ip the ip to list. Ip *string `protobuf:"bytes,1,opt,name=ip,proto3,oneof" json:"ip,omitempty"` // Network from which the IPs are to list. Network *string `protobuf:"bytes,2,opt,name=network,proto3,oneof" json:"network,omitempty"` - // Project of the ips to list + // Project of the ips to list. Project *string `protobuf:"bytes,3,opt,name=project,proto3,oneof" json:"project,omitempty"` - // Name of this ip + // Name of this ip. Name *string `protobuf:"bytes,4,opt,name=name,proto3,oneof" json:"name,omitempty"` - // UUID for which these IPs should be filtered + // UUID for which these IPs should be filtered. Uuid *string `protobuf:"bytes,5,opt,name=uuid,proto3,oneof" json:"uuid,omitempty"` - // Machine for which these IPs should be filtered + // Machine for which these IPs should be filtered. Machine *string `protobuf:"bytes,6,opt,name=machine,proto3,oneof" json:"machine,omitempty"` - // ParentPrefixCidr for which this ips should get filtered + // ParentPrefixCidr for which this ips should get filtered. ParentPrefixCidr *string `protobuf:"bytes,7,opt,name=parent_prefix_cidr,json=parentPrefixCidr,proto3,oneof" json:"parent_prefix_cidr,omitempty"` - // Labels for which these IPs should be filtered + // Labels for which these IPs should be filtered. Labels *Labels `protobuf:"bytes,8,opt,name=labels,proto3,oneof" json:"labels,omitempty"` // Static if set to true, this will be a Static ip. Type *IPType `protobuf:"varint,9,opt,name=type,proto3,enum=metalstack.api.v2.IPType,oneof" json:"type,omitempty"` @@ -723,9 +723,9 @@ func (x *IPQuery) GetNamespace() string { // IPServiceDeleteRequest is the request payload for a ip delete request. type IPServiceDeleteRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // IP of the ip to delete + // IP of the ip to delete. Ip string `protobuf:"bytes,1,opt,name=ip,proto3" json:"ip,omitempty"` - // Project of the ip + // Project of the ip. Project string `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -778,7 +778,7 @@ func (x *IPServiceDeleteRequest) GetProject() string { // IPServiceGetResponse is the response payload for an IP get request. type IPServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Ip the ip + // Ip the ip. Ip *IP `protobuf:"bytes,1,opt,name=ip,proto3" json:"ip,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -824,7 +824,7 @@ func (x *IPServiceGetResponse) GetIp() *IP { // IPServiceUpdateResponse is the response payload for a ip update request. type IPServiceUpdateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Ip the ip + // Ip the ip. Ip *IP `protobuf:"bytes,1,opt,name=ip,proto3" json:"ip,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -870,7 +870,7 @@ func (x *IPServiceUpdateResponse) GetIp() *IP { // IPServiceCreateResponse is the response payload for an IP create request. type IPServiceCreateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Ip the ip + // Ip the ip. Ip *IP `protobuf:"bytes,1,opt,name=ip,proto3" json:"ip,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -916,7 +916,7 @@ func (x *IPServiceCreateResponse) GetIp() *IP { // IPServiceListResponse is the response payload for an IP list request. type IPServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Ips the ips + // Ips the ips. Ips []*IP `protobuf:"bytes,1,rep,name=ips,proto3" json:"ips,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -962,7 +962,7 @@ func (x *IPServiceListResponse) GetIps() []*IP { // IPServiceDeleteResponse is the response payload for an IP delete request. type IPServiceDeleteResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Ip the ip + // Ip the ip. Ip *IP `protobuf:"bytes,1,opt,name=ip,proto3" json:"ip,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 e110e679..fb94926b 100644 --- a/go/metalstack/api/v2/machine.pb.go +++ b/go/metalstack/api/v2/machine.pb.go @@ -83,11 +83,11 @@ type MachineState int32 const ( // MACHINE_STATE_UNSPECIFIED is not specified. MachineState_MACHINE_STATE_UNSPECIFIED MachineState = 0 - // MACHINE_STATE_TAINTED this machine is tainted, i.e. this machine is not considered during random machine allocation, but still by specifying the uuid + // MACHINE_STATE_TAINTED this machine is tainted, i.e. this machine is not considered during random machine allocation, but still by specifying the uui. MachineState_MACHINE_STATE_TAINTED MachineState = 1 - // MACHINE_STATE_LOCKED this machine is locked, i.e. this machine cannot be allocated or deleted + // MACHINE_STATE_LOCKED this machine is locked, i.e. this machine cannot be allocated or delete. MachineState_MACHINE_STATE_LOCKED MachineState = 2 - // MACHINE_STATE_AVAILABLE this machine is available for all + // MACHINE_STATE_AVAILABLE this machine is available for all. MachineState_MACHINE_STATE_AVAILABLE MachineState = 3 ) @@ -134,15 +134,15 @@ func (MachineState) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_machine_proto_rawDescGZIP(), []int{1} } -// MachineProvisioningEventState possible event states +// MachineProvisioningEventState possible event states. type MachineProvisioningEventState int32 const ( // MACHINE_PROVISIONING_EVENT_STATE_UNSPECIFIED is not specified. MachineProvisioningEventState_MACHINE_PROVISIONING_EVENT_STATE_UNSPECIFIED MachineProvisioningEventState = 0 - // MACHINE_PROVISIONING_EVENT_STATE_CRASHLOOP machine is in crash loop + // MACHINE_PROVISIONING_EVENT_STATE_CRASHLOOP machine is in crash loop. MachineProvisioningEventState_MACHINE_PROVISIONING_EVENT_STATE_CRASHLOOP MachineProvisioningEventState = 1 - // MACHINE_PROVISIONING_EVENT_STATE_FAILED_RECLAIM machine is in failed reclaim + // MACHINE_PROVISIONING_EVENT_STATE_FAILED_RECLAIM machine is in failed reclaim. MachineProvisioningEventState_MACHINE_PROVISIONING_EVENT_STATE_FAILED_RECLAIM MachineProvisioningEventState = 2 ) @@ -193,27 +193,27 @@ type MachineProvisioningEventType int32 const ( // MACHINE_PROVISIONING_EVENT_TYPE_UNSPECIFIED is not specified. MachineProvisioningEventType_MACHINE_PROVISIONING_EVENT_TYPE_UNSPECIFIED MachineProvisioningEventType = 0 - // MACHINE_PROVISIONING_EVENT_TYPE_ALIVE machine is alive + // MACHINE_PROVISIONING_EVENT_TYPE_ALIVE machine is alive. MachineProvisioningEventType_MACHINE_PROVISIONING_EVENT_TYPE_ALIVE MachineProvisioningEventType = 1 - // MACHINE_PROVISIONING_EVENT_TYPE_CRASHED machine crashed + // MACHINE_PROVISIONING_EVENT_TYPE_CRASHED machine crashed. MachineProvisioningEventType_MACHINE_PROVISIONING_EVENT_TYPE_CRASHED MachineProvisioningEventType = 2 - // MACHINE_PROVISIONING_EVENT_TYPE_PXE_BOOTING machine is pxe booting into metal-hammer + // MACHINE_PROVISIONING_EVENT_TYPE_PXE_BOOTING machine is pxe booting into metal-hammer. MachineProvisioningEventType_MACHINE_PROVISIONING_EVENT_TYPE_PXE_BOOTING MachineProvisioningEventType = 3 - // MACHINE_PROVISIONING_EVENT_TYPE_PLANNED_REBOOT machine got a reboot instruction + // MACHINE_PROVISIONING_EVENT_TYPE_PLANNED_REBOOT machine got a reboot instruction. MachineProvisioningEventType_MACHINE_PROVISIONING_EVENT_TYPE_PLANNED_REBOOT MachineProvisioningEventType = 4 - // MACHINE_PROVISIONING_EVENT_TYPE_PREPARING metal-hammer is preparing the machine + // MACHINE_PROVISIONING_EVENT_TYPE_PREPARING metal-hammer is preparing the machine. MachineProvisioningEventType_MACHINE_PROVISIONING_EVENT_TYPE_PREPARING MachineProvisioningEventType = 5 - // MACHINE_PROVISIONING_EVENT_TYPE_REGISTERING metal-hammer registers machine at the apiserver + // MACHINE_PROVISIONING_EVENT_TYPE_REGISTERING metal-hammer registers machine at the apiserver. MachineProvisioningEventType_MACHINE_PROVISIONING_EVENT_TYPE_REGISTERING MachineProvisioningEventType = 6 - // MACHINE_PROVISIONING_EVENT_TYPE_WAITING machine is waiting for installation + // MACHINE_PROVISIONING_EVENT_TYPE_WAITING machine is waiting for installation. MachineProvisioningEventType_MACHINE_PROVISIONING_EVENT_TYPE_WAITING MachineProvisioningEventType = 7 - // MACHINE_PROVISIONING_EVENT_TYPE_INSTALLING metal-hammer is installing the desired os + // MACHINE_PROVISIONING_EVENT_TYPE_INSTALLING metal-hammer is installing the desired os. MachineProvisioningEventType_MACHINE_PROVISIONING_EVENT_TYPE_INSTALLING MachineProvisioningEventType = 8 - // MACHINE_PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL metal-hammer completed installation and boots into target os + // MACHINE_PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL metal-hammer completed installation and boots into target os. MachineProvisioningEventType_MACHINE_PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL MachineProvisioningEventType = 9 - // MACHINE_PROVISIONING_EVENT_TYPE_PHONED_HOME machine is installed and phones home + // MACHINE_PROVISIONING_EVENT_TYPE_PHONED_HOME machine is installed and phones home. MachineProvisioningEventType_MACHINE_PROVISIONING_EVENT_TYPE_PHONED_HOME MachineProvisioningEventType = 10 - // MACHINE_PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM machine is not allocated, but phones home + // MACHINE_PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM machine is not allocated, but phones home. MachineProvisioningEventType_MACHINE_PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM MachineProvisioningEventType = 11 ) @@ -282,11 +282,11 @@ type MachineLiveliness int32 const ( // MACHINE_LIVELINESS_UNSPECIFIED is not defined. MachineLiveliness_MACHINE_LIVELINESS_UNSPECIFIED MachineLiveliness = 0 - // MACHINE_LIVELINESS_ALIVE liveliness is alive + // MACHINE_LIVELINESS_ALIVE liveliness is alive. MachineLiveliness_MACHINE_LIVELINESS_ALIVE MachineLiveliness = 1 - // MACHINE_LIVELINESS_DEAD liveliness is dead + // MACHINE_LIVELINESS_DEAD liveliness is dead. MachineLiveliness_MACHINE_LIVELINESS_DEAD MachineLiveliness = 2 - // MACHINE_LIVELINESS_UNKNOWN liveliness is unknown + // MACHINE_LIVELINESS_UNKNOWN liveliness is unknown. MachineLiveliness_MACHINE_LIVELINESS_UNKNOWN MachineLiveliness = 3 ) @@ -400,19 +400,19 @@ const ( MachineBMCCommand_MACHINE_BMC_COMMAND_RESET MachineBMCCommand = 3 // MACHINE_BMC_COMMAND_CYCLE Power cycle the machine. MachineBMCCommand_MACHINE_BMC_COMMAND_CYCLE MachineBMCCommand = 4 - // MACHINE_BMC_COMMAND_BOOT_TO_BIOS boot the machine into bios + // MACHINE_BMC_COMMAND_BOOT_TO_BIOS boot the machine into bios. MachineBMCCommand_MACHINE_BMC_COMMAND_BOOT_TO_BIOS MachineBMCCommand = 5 - // MACHINE_BMC_COMMAND_BOOT_FROM_DISK boot the machine from hard disk + // MACHINE_BMC_COMMAND_BOOT_FROM_DISK boot the machine from hard disk. MachineBMCCommand_MACHINE_BMC_COMMAND_BOOT_FROM_DISK MachineBMCCommand = 6 - // MACHINE_BMC_COMMAND_BOOT_FROM_PXE boot the machine from pxe + // MACHINE_BMC_COMMAND_BOOT_FROM_PXE boot the machine from pxe. MachineBMCCommand_MACHINE_BMC_COMMAND_BOOT_FROM_PXE MachineBMCCommand = 7 - // MACHINE_BMC_COMMAND_IDENTIFY_LED_ON set identify led of the machine chassis to on + // MACHINE_BMC_COMMAND_IDENTIFY_LED_ON set identify led of the machine chassis to on. MachineBMCCommand_MACHINE_BMC_COMMAND_IDENTIFY_LED_ON MachineBMCCommand = 8 - // MACHINE_BMC_COMMAND_IDENTIFY_LED_OFF set identify led of the machine chassis to off + // MACHINE_BMC_COMMAND_IDENTIFY_LED_OFF set identify led of the machine chassis to off. MachineBMCCommand_MACHINE_BMC_COMMAND_IDENTIFY_LED_OFF MachineBMCCommand = 9 - // MACHINE_BMC_COMMAND_MACHINE_DELETED should be called if the machine was deleted to power cycle and boot into pxe + // MACHINE_BMC_COMMAND_MACHINE_DELETED should be called if the machine was deleted to power cycle and boot into pxe. MachineBMCCommand_MACHINE_BMC_COMMAND_MACHINE_DELETED MachineBMCCommand = 10 - // MACHINE_BMC_COMMAND_MACHINE_CREATED should be called if the machine was created to set the boot order to boot from disk + // MACHINE_BMC_COMMAND_MACHINE_CREATED should be called if the machine was created to set the boot order to boot from disk. MachineBMCCommand_MACHINE_BMC_COMMAND_MACHINE_CREATED MachineBMCCommand = 11 ) @@ -479,33 +479,33 @@ func (MachineBMCCommand) EnumDescriptor() ([]byte, []int) { type MachineIssueType int32 const ( - // MACHINE_ISSUE_TYPE_UNSPECIFIED type is not specified + // MACHINE_ISSUE_TYPE_UNSPECIFIED type is not specified. MachineIssueType_MACHINE_ISSUE_TYPE_UNSPECIFIED MachineIssueType = 0 - // MACHINE_ISSUE_TYPE_ASN_UNIQUENESS machine asn is not unique + // MACHINE_ISSUE_TYPE_ASN_UNIQUENESS machine asn is not unique. MachineIssueType_MACHINE_ISSUE_TYPE_ASN_UNIQUENESS MachineIssueType = 1 - // MACHINE_ISSUE_TYPE_BMC_INFO_OUTDATED machine bmc info out of date + // MACHINE_ISSUE_TYPE_BMC_INFO_OUTDATED machine bmc info out of date. MachineIssueType_MACHINE_ISSUE_TYPE_BMC_INFO_OUTDATED MachineIssueType = 2 - // MACHINE_ISSUE_TYPE_BMC_NON_DISTINCT_IP machine bmc ip is not distinct + // MACHINE_ISSUE_TYPE_BMC_NON_DISTINCT_IP machine bmc ip is not distinct. MachineIssueType_MACHINE_ISSUE_TYPE_BMC_NON_DISTINCT_IP MachineIssueType = 3 - // MACHINE_ISSUE_TYPE_BMC_WITHOUT_IP machine bmc without ip + // MACHINE_ISSUE_TYPE_BMC_WITHOUT_IP machine bmc without ip. MachineIssueType_MACHINE_ISSUE_TYPE_BMC_WITHOUT_IP MachineIssueType = 4 - // MACHINE_ISSUE_TYPE_BMC_WITHOUT_MAC machine bmc without mac address + // MACHINE_ISSUE_TYPE_BMC_WITHOUT_MAC machine bmc without mac address. MachineIssueType_MACHINE_ISSUE_TYPE_BMC_WITHOUT_MAC MachineIssueType = 5 - // MACHINE_ISSUE_TYPE_CRASH_LOOP machine is in crashloop + // MACHINE_ISSUE_TYPE_CRASH_LOOP machine is in crashloop. MachineIssueType_MACHINE_ISSUE_TYPE_CRASH_LOOP MachineIssueType = 6 - // MACHINE_ISSUE_TYPE_FAILED_MACHINE_RECLAIM machine was not freed after delete + // MACHINE_ISSUE_TYPE_FAILED_MACHINE_RECLAIM machine was not freed after delete. MachineIssueType_MACHINE_ISSUE_TYPE_FAILED_MACHINE_RECLAIM MachineIssueType = 7 - // MACHINE_ISSUE_TYPE_LAST_EVENT_ERROR machine last event error + // MACHINE_ISSUE_TYPE_LAST_EVENT_ERROR machine last event error. MachineIssueType_MACHINE_ISSUE_TYPE_LAST_EVENT_ERROR MachineIssueType = 8 - // MACHINE_ISSUE_TYPE_LIVELINESS_DEAD machine is dead + // MACHINE_ISSUE_TYPE_LIVELINESS_DEAD machine is dead. MachineIssueType_MACHINE_ISSUE_TYPE_LIVELINESS_DEAD MachineIssueType = 9 - // MACHINE_ISSUE_TYPE_LIVELINESS_NOT_AVAILABLE machine liveliness is not available + // MACHINE_ISSUE_TYPE_LIVELINESS_NOT_AVAILABLE machine liveliness is not available. MachineIssueType_MACHINE_ISSUE_TYPE_LIVELINESS_NOT_AVAILABLE MachineIssueType = 10 - // MACHINE_ISSUE_TYPE_LIVELINESS_UNKNOWN machine liveliness is unknown + // MACHINE_ISSUE_TYPE_LIVELINESS_UNKNOWN machine liveliness is unknown. MachineIssueType_MACHINE_ISSUE_TYPE_LIVELINESS_UNKNOWN MachineIssueType = 11 - // MACHINE_ISSUE_TYPE_NO_EVENT_CONTAINER machine does not have a event container + // MACHINE_ISSUE_TYPE_NO_EVENT_CONTAINER machine does not have a event container. MachineIssueType_MACHINE_ISSUE_TYPE_NO_EVENT_CONTAINER MachineIssueType = 12 - // MACHINE_ISSUE_TYPE_NO_PARTITION no partition set + // MACHINE_ISSUE_TYPE_NO_PARTITION no partition set. MachineIssueType_MACHINE_ISSUE_TYPE_NO_PARTITION MachineIssueType = 13 ) @@ -576,13 +576,13 @@ func (MachineIssueType) EnumDescriptor() ([]byte, []int) { type MachineIssueSeverity int32 const ( - // MACHINE_ISSUE_SEVERITY_UNSPECIFIED severity is not specified + // MACHINE_ISSUE_SEVERITY_UNSPECIFIED severity is not specified. MachineIssueSeverity_MACHINE_ISSUE_SEVERITY_UNSPECIFIED MachineIssueSeverity = 0 - // MACHINE_ISSUE_SEVERITY_MINOR machine issues is of severity minor + // MACHINE_ISSUE_SEVERITY_MINOR machine issues is of severity minor. MachineIssueSeverity_MACHINE_ISSUE_SEVERITY_MINOR MachineIssueSeverity = 1 - // MACHINE_ISSUE_SEVERITY_MAJOR machine issues is of severity major + // MACHINE_ISSUE_SEVERITY_MAJOR machine issues is of severity major. MachineIssueSeverity_MACHINE_ISSUE_SEVERITY_MAJOR MachineIssueSeverity = 2 - // MACHINE_ISSUE_SEVERITY_CRITICAL machine issues is of severity critical + // MACHINE_ISSUE_SEVERITY_CRITICAL machine issues is of severity critical. MachineIssueSeverity_MACHINE_ISSUE_SEVERITY_CRITICAL MachineIssueSeverity = 3 ) @@ -632,9 +632,9 @@ func (MachineIssueSeverity) EnumDescriptor() ([]byte, []int) { // MachineServiceGetRequest is the request payload for a machine get request. type MachineServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // UUID of the machine to get + // UUID of the machine to get. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` - // Project of the machine + // Project of the machine. Project string `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -733,51 +733,51 @@ func (x *MachineServiceGetResponse) GetMachine() *Machine { // MachineServiceCreateRequest is the request payload for a machine create request. type MachineServiceCreateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Project of the machine + // Project of the machine. Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` // UUID if this field is set, this specific machine will be allocated if it is not in available state and not currently allocated. // this field takes precedence over size and partition. - // Can only be used with ADMIN_ROLE_EDITOR + // Can only be used with ADMIN_ROLE_EDITOR. Uuid *string `protobuf:"bytes,2,opt,name=uuid,proto3,oneof" json:"uuid,omitempty"` - // Name of this machine + // Name of this machine. Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"` - // Description for this machine + // Description for this machine. Description *string `protobuf:"bytes,4,opt,name=description,proto3,oneof" json:"description,omitempty"` - // Hostname the hostname for the allocated machine (defaults to metal) + // Hostname the hostname for the allocated machine (defaults to metal). Hostname *string `protobuf:"bytes,5,opt,name=hostname,proto3,oneof" json:"hostname,omitempty"` - // Partition the partition id to assign this machine to, must be omitted if uuid is given + // Partition the partition id to assign this machine to, must be omitted if uuid is given. Partition *string `protobuf:"bytes,6,opt,name=partition,proto3,oneof" json:"partition,omitempty"` - // Size of the machine to create, must be omitted if uuid is given + // Size of the machine to create, must be omitted if uuid is given. Size *string `protobuf:"bytes,7,opt,name=size,proto3,oneof" json:"size,omitempty"` - // Image which should be installed on this machine - // The image can be specified either in the fully qualified form, e.g. including os, major, minor and patch. - // - debian-13.0.20260402 - // or in a simplified form which omits the patch version - // - debian-13.0 - // If the fully qualified form is specified, exactly this image is taken regardless of the image classification - // if the short form is given, only the most recent images which has image classification supported is used. + // Image which should be installed on this machine. + // The image can be specified either in the fully qualified form, e.g. including os, major, minor and patch + // - debian-13.0.2026040 + // - or in a simplified form which omits the patch version. + // - debian-13. + // If the fully qualified form is specified, exactly this image is taken regardless of the image classification. + // If the short form is given, only the most recent images which has image classification supported is used. Image string `protobuf:"bytes,8,opt,name=image,proto3" json:"image,omitempty"` - // FilesystemLayout which should be applied for the operating system installation + // FilesystemLayout which should be applied for the operating system installation. // Is defaulted by a lookup at the available fsls for this size and image. - // Can be specified to test new fsls during development of fsls + // Can be specified to test new fsls during development of fsls. FilesystemLayout *string `protobuf:"bytes,9,opt,name=filesystem_layout,json=filesystemLayout,proto3,oneof" json:"filesystem_layout,omitempty"` // SSHPublicKeys defines the ssh public key to be installed on the machine to access it via ssh. SshPublicKeys []string `protobuf:"bytes,10,rep,name=ssh_public_keys,json=sshPublicKeys,proto3" json:"ssh_public_keys,omitempty"` // Userdata contains instructions required to bootstrap the machine. - // AWS limits the max userdata size to 16k, lets allow twice as much + // AWS limits the max userdata size to 16k, lets allow twice as much. Userdata *string `protobuf:"bytes,11,opt,name=userdata,proto3,oneof" json:"userdata,omitempty"` - // Labels to be attached to this machine allocation + // Labels to be attached to this machine allocation. Labels *Labels `protobuf:"bytes,12,opt,name=labels,proto3" json:"labels,omitempty"` // Networks the networks that this machine will be placed in. Networks []*MachineAllocationNetwork `protobuf:"bytes,13,rep,name=networks,proto3" json:"networks,omitempty"` // PlacementTags by default machines are spread across the racks inside a partition for every project. - // if placement tags are provided, the machine candidate has an additional anti-affinity to other machines having the same tags + // if placement tags are provided, the machine candidate has an additional anti-affinity to other machines having the same tags. PlacementTags []string `protobuf:"bytes,14,rep,name=placement_tags,json=placementTags,proto3" json:"placement_tags,omitempty"` - // DNSServer the dns servers used for the machine + // DNSServer the dns servers used for the machine. DnsServers []*DNSServer `protobuf:"bytes,15,rep,name=dns_servers,json=dnsServers,proto3" json:"dns_servers,omitempty"` - // NTPServer the ntp servers used for the machine + // NTPServer the ntp servers used for the machine. NtpServers []*NTPServer `protobuf:"bytes,16,rep,name=ntp_servers,json=ntpServers,proto3" json:"ntp_servers,omitempty"` - // AllocationType of this machine + // AllocationType of this machine. AllocationType MachineAllocationType `protobuf:"varint,17,opt,name=allocation_type,json=allocationType,proto3,enum=metalstack.api.v2.MachineAllocationType" json:"allocation_type,omitempty"` // FirewallSpec provides firewall specific parameters if allocationType is firewall. FirewallSpec *FirewallSpec `protobuf:"bytes,18,opt,name=firewall_spec,json=firewallSpec,proto3" json:"firewall_spec,omitempty"` @@ -944,7 +944,7 @@ func (x *MachineServiceCreateRequest) GetFirewallSpec() *FirewallSpec { // FirewallSpec contains firewall specific firewall creation parameters. type FirewallSpec struct { state protoimpl.MessageState `protogen:"open.v1"` - // FirewallRules to be applied if this is a firewall + // FirewallRules to be applied if this is a firewall. FirewallRules *FirewallRules `protobuf:"bytes,1,opt,name=firewall_rules,json=firewallRules,proto3" json:"firewall_rules,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -990,7 +990,7 @@ func (x *FirewallSpec) GetFirewallRules() *FirewallRules { // MachineServiceCreateResponse is the response payload for a machine create request. type MachineServiceCreateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Machine which was created + // Machine which was created. Machine *Machine `protobuf:"bytes,1,opt,name=machine,proto3" json:"machine,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1036,17 +1036,17 @@ func (x *MachineServiceCreateResponse) GetMachine() *Machine { // MachineServiceUpdateRequest is the request payload for a machine update request. type MachineServiceUpdateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // UUID of the machine to modify + // UUID of the machine to modify. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` // UpdateMeta contains the timestamp and strategy to be used in this update request. UpdateMeta *UpdateMeta `protobuf:"bytes,2,opt,name=update_meta,json=updateMeta,proto3" json:"update_meta,omitempty"` - // Project of the machine + // Project of the machine. Project string `protobuf:"bytes,3,opt,name=project,proto3" json:"project,omitempty"` - // Description of this machine allocation + // Description of this machine allocation. Description *string `protobuf:"bytes,4,opt,name=description,proto3,oneof" json:"description,omitempty"` - // Labels to update on this machine allocation + // Labels to update on this machine allocation. Labels *UpdateLabels `protobuf:"bytes,5,opt,name=labels,proto3,oneof" json:"labels,omitempty"` - // SSHPublicKeys which should be update of this machine allocation + // SSHPublicKeys which should be update of this machine allocation. SshPublicKeys []string `protobuf:"bytes,6,rep,name=ssh_public_keys,json=sshPublicKeys,proto3" json:"ssh_public_keys,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1127,7 +1127,7 @@ func (x *MachineServiceUpdateRequest) GetSshPublicKeys() []string { // MachineServiceUpdateResponse is the response payload for a machine update request. type MachineServiceUpdateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Machine which was updated + // Machine which was updated. Machine *Machine `protobuf:"bytes,1,opt,name=machine,proto3" json:"machine,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1173,7 +1173,7 @@ func (x *MachineServiceUpdateResponse) GetMachine() *Machine { // MachineServiceListRequest is the request payload for a machine list request. type MachineServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Project of the machines to list + // Project of the machines to list. Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` // Query to list one ore more machines. Query *MachineQuery `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"` @@ -1274,9 +1274,9 @@ func (x *MachineServiceListResponse) GetMachines() []*Machine { // MachineServiceDeleteRequest is the request payload for a machine delete request. type MachineServiceDeleteRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // UUID of the machine to delete + // UUID of the machine to delete. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` - // Project of the machine + // Project of the machine. Project string `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1329,7 +1329,7 @@ func (x *MachineServiceDeleteRequest) GetProject() string { // MachineServiceDeleteResponse is the response payload for a machine delete request. type MachineServiceDeleteResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Machine which was deleted + // Machine which was deleted. Machine *Machine `protobuf:"bytes,1,opt,name=machine,proto3" json:"machine,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1375,11 +1375,11 @@ func (x *MachineServiceDeleteResponse) GetMachine() *Machine { // MachineServiceBMCCommandRequest is the request payload for a machine bmc command. type MachineServiceBMCCommandRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // UUID of the machine to send the command to + // UUID of the machine to send the command to. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` - // Project of the machine + // Project of the machine. Project string `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"` - // Command to send to the bmc of the machine + // Command to send to the bmc of the machine. Command MachineBMCCommand `protobuf:"varint,3,opt,name=command,proto3,enum=metalstack.api.v2.MachineBMCCommand" json:"command,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1476,9 +1476,9 @@ func (*MachineServiceBMCCommandResponse) Descriptor() ([]byte, []int) { // MachineServiceGetBMCRequest is the request payload for a machine getbmc request. type MachineServiceGetBMCRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // UUID of the machine to get + // UUID of the machine to get. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` - // Project of the machine + // Project of the machine. Project string `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1531,7 +1531,7 @@ func (x *MachineServiceGetBMCRequest) GetProject() string { // MachineServiceGetBMCResponse is the response payload for a machine getbmc request. type MachineServiceGetBMCResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // UUID of the machine + // UUID of the machine. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` // BMC contains the BMC details of this machine. Bmc *MachineBMCReport `protobuf:"bytes,2,opt,name=bmc,proto3" json:"bmc,omitempty"` @@ -1586,21 +1586,21 @@ func (x *MachineServiceGetBMCResponse) GetBmc() *MachineBMCReport { // Machine represents a physical bare metal machine. type Machine struct { state protoimpl.MessageState `protogen:"open.v1"` - // UUID of this machine + // UUID of this machine. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` - // Meta for this machine + // Meta for this machine. Meta *Meta `protobuf:"bytes,2,opt,name=meta,proto3" json:"meta,omitempty"` - // Partition where this machine resides + // Partition where this machine resides. Partition *Partition `protobuf:"bytes,3,opt,name=partition,proto3" json:"partition,omitempty"` // Rack where this machine is located. Rack string `protobuf:"bytes,4,opt,name=rack,proto3" json:"rack,omitempty"` // Room where this machine is located. Room string `protobuf:"bytes,5,opt,name=room,proto3" json:"room,omitempty"` - // Size of this machine + // Size of this machine. Size *Size `protobuf:"bytes,6,opt,name=size,proto3" json:"size,omitempty"` - // Hardware specs of this machine + // Hardware specs of this machine. Hardware *MachineHardware `protobuf:"bytes,7,opt,name=hardware,proto3" json:"hardware,omitempty"` - // Allocation details + // Allocation details. Allocation *MachineAllocation `protobuf:"bytes,8,opt,name=allocation,proto3" json:"allocation,omitempty"` // Status contains several status details related to this machine. Status *MachineStatus `protobuf:"bytes,9,opt,name=status,proto3" json:"status,omitempty"` @@ -1717,9 +1717,9 @@ type MachineStatus struct { Condition *MachineCondition `protobuf:"bytes,1,opt,name=condition,proto3" json:"condition,omitempty"` // LEDState indicates the state of the indicator LED on this machine. LedState *MachineChassisIdentifyLEDState `protobuf:"bytes,2,opt,name=led_state,json=ledState,proto3" json:"led_state,omitempty"` - // Liveliness of this machine + // Liveliness of this machine. Liveliness MachineLiveliness `protobuf:"varint,3,opt,name=liveliness,proto3,enum=metalstack.api.v2.MachineLiveliness" json:"liveliness,omitempty"` - // MetalHammerVersion the version of metal hammer which put the machine in waiting state + // MetalHammerVersion the version of metal hammer which put the machine in waiting state. MetalHammerVersion string `protobuf:"bytes,4,opt,name=metal_hammer_version,json=metalHammerVersion,proto3" json:"metal_hammer_version,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1786,11 +1786,11 @@ func (x *MachineStatus) GetMetalHammerVersion() string { // MachineCondition describes the availability of this machine. type MachineCondition struct { state protoimpl.MessageState `protogen:"open.v1"` - // State the state of this machine. empty means available for all + // State the state of this machine. empty means available for al. State MachineState `protobuf:"varint,1,opt,name=state,proto3,enum=metalstack.api.v2.MachineState" json:"state,omitempty"` - // Description a description why this machine is in the given state + // Description a description why this machine is in the given state. Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"` - // Issuer the user that changed the state + // Issuer the user that changed the state. Issuer string `protobuf:"bytes,3,opt,name=issuer,proto3" json:"issuer,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1850,41 +1850,41 @@ func (x *MachineCondition) GetIssuer() string { // MachineAllocation contains properties if this machine is allocated. type MachineAllocation struct { state protoimpl.MessageState `protogen:"open.v1"` - // UUID of this machine allocation + // UUID of this machine allocation. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` - // Meta for this machine allocation + // Meta for this machine allocation. Meta *Meta `protobuf:"bytes,2,opt,name=meta,proto3" json:"meta,omitempty"` - // Name of this allocation + // Name of this allocation. Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"` - // Description of this allocation + // Description of this allocation. Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"` - // Created By indicates who created this machine allocation + // Created By indicates who created this machine allocation. CreatedBy string `protobuf:"bytes,5,opt,name=created_by,json=createdBy,proto3" json:"created_by,omitempty"` - // Project of the allocation + // Project of the allocation. Project string `protobuf:"bytes,6,opt,name=project,proto3" json:"project,omitempty"` - // Image to be used to install on this machine + // Image to be used to install on this machine. Image *Image `protobuf:"bytes,7,opt,name=image,proto3" json:"image,omitempty"` - // FilesystemLayout to create on the disks + // FilesystemLayout to create on the disks. FilesystemLayout *FilesystemLayout `protobuf:"bytes,8,opt,name=filesystem_layout,json=filesystemLayout,proto3" json:"filesystem_layout,omitempty"` - // Networks this machine should be attached to + // Networks this machine should be attached to. // Order of ips of external networks will be preserved. Networks []*MachineNetwork `protobuf:"bytes,9,rep,name=networks,proto3" json:"networks,omitempty"` - // Hostname of the allocated machine + // Hostname of the allocated machine. Hostname string `protobuf:"bytes,10,opt,name=hostname,proto3" json:"hostname,omitempty"` - // SSHPublicKeys which should be installed on this machine + // SSHPublicKeys which should be installed on this machine. SshPublicKeys []string `protobuf:"bytes,11,rep,name=ssh_public_keys,json=sshPublicKeys,proto3" json:"ssh_public_keys,omitempty"` // Userdata contains instructions required to bootstrap the machine. - // AWS limits the max userdata size to 16k, lets allow twice as much + // AWS limits the max userdata size to 16k, lets allow twice as much. Userdata string `protobuf:"bytes,12,opt,name=userdata,proto3" json:"userdata,omitempty"` - // AllocationType of this machine + // AllocationType of this machine. AllocationType MachineAllocationType `protobuf:"varint,13,opt,name=allocation_type,json=allocationType,proto3,enum=metalstack.api.v2.MachineAllocationType" json:"allocation_type,omitempty"` - // FirewallRules to be applied if this is a firewall + // FirewallRules to be applied if this is a firewall. FirewallRules *FirewallRules `protobuf:"bytes,14,opt,name=firewall_rules,json=firewallRules,proto3" json:"firewall_rules,omitempty"` - // DNSServers for this machine + // DNSServers for this machine. DnsServers []*DNSServer `protobuf:"bytes,15,rep,name=dns_servers,json=dnsServers,proto3" json:"dns_servers,omitempty"` - // NTPServers for this machine + // NTPServers for this machine. NtpServers []*NTPServer `protobuf:"bytes,16,rep,name=ntp_servers,json=ntpServers,proto3" json:"ntp_servers,omitempty"` - // VPN connection configuration + // VPN connection configuration. Vpn *MachineVPN `protobuf:"bytes,17,opt,name=vpn,proto3" json:"vpn,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -2042,9 +2042,9 @@ func (x *MachineAllocation) GetVpn() *MachineVPN { // MachineAllocationNetwork defines which network should be attached to a machine and if ips should be autoacquired. type MachineAllocationNetwork struct { state protoimpl.MessageState `protogen:"open.v1"` - // Network the id of the network that this machine will be placed in + // Network the id of the network that this machine will be placed in. Network string `protobuf:"bytes,1,opt,name=network,proto3" json:"network,omitempty"` - // IPs to to attach to this machine additionally + // IPs to to attach to this machine additionally. // If none given, one ip address is acquired per network for the machine. // Order of ips is preserved on the loopback interface. Ips []string `protobuf:"bytes,2,rep,name=ips,proto3" json:"ips,omitempty"` @@ -2154,13 +2154,13 @@ func (x *FirewallRules) GetIngress() []*FirewallIngressRule { // FirewallEgressRule defines rules for outgoing traffic. type FirewallEgressRule struct { state protoimpl.MessageState `protogen:"open.v1"` - // Protocol the protocol for the rule, defaults to tcp + // Protocol the protocol for the rule, defaults to tcp. Protocol IPProtocol `protobuf:"varint,1,opt,name=protocol,proto3,enum=metalstack.api.v2.IPProtocol" json:"protocol,omitempty"` - // Ports the ports affected by this rule + // Ports the ports affected by this rule. Ports []uint32 `protobuf:"varint,2,rep,packed,name=ports,proto3" json:"ports,omitempty"` - // To the destination cidrs affected by this rule + // To the destination cidrs affected by this rule. To []string `protobuf:"bytes,3,rep,name=to,proto3" json:"to,omitempty"` - // Comment for this rule + // Comment for this rule. Comment string `protobuf:"bytes,4,opt,name=comment,proto3" json:"comment,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -2227,15 +2227,15 @@ func (x *FirewallEgressRule) GetComment() string { // FirewallIngressRule defines rules for incoming traffic. type FirewallIngressRule struct { state protoimpl.MessageState `protogen:"open.v1"` - // Protocol the protocol for the rule, defaults to tcp + // Protocol the protocol for the rule, defaults to tcp. Protocol IPProtocol `protobuf:"varint,1,opt,name=protocol,proto3,enum=metalstack.api.v2.IPProtocol" json:"protocol,omitempty"` - // Ports the ports affected by this rule + // Ports the ports affected by this rule. Ports []uint32 `protobuf:"varint,2,rep,packed,name=ports,proto3" json:"ports,omitempty"` - // To the destination cidrs affected by this rule + // To the destination cidrs affected by this rule. To []string `protobuf:"bytes,3,rep,name=to,proto3" json:"to,omitempty"` - // From the source cidrs affected by this rule + // From the source cidrs affected by this rule. From []string `protobuf:"bytes,4,rep,name=from,proto3" json:"from,omitempty"` - // Comment for this rule + // Comment for this rule. Comment string `protobuf:"bytes,5,opt,name=comment,proto3" json:"comment,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -2309,21 +2309,21 @@ func (x *FirewallIngressRule) GetComment() string { // MachineNetwork contains details which network should be created on a allocated machine. type MachineNetwork struct { state protoimpl.MessageState `protogen:"open.v1"` - // Network the networkID of the allocated machine in this vrf + // Network the networkID of the allocated machine in this vrf. Network string `protobuf:"bytes,1,opt,name=network,proto3" json:"network,omitempty"` - // Prefixes the prefixes of this network + // Prefixes the prefixes of this network. Prefixes []string `protobuf:"bytes,2,rep,name=prefixes,proto3" json:"prefixes,omitempty"` // DestinationPrefixes prefixes that are reachable within this network. DestinationPrefixes []string `protobuf:"bytes,3,rep,name=destination_prefixes,json=destinationPrefixes,proto3" json:"destination_prefixes,omitempty"` - // IPs the ip addresses of the allocated machine in this vrf + // IPs the ip addresses of the allocated machine in this vrf. Ips []string `protobuf:"bytes,4,rep,name=ips,proto3" json:"ips,omitempty"` - // NetworkType the type of network of this vrf + // NetworkType the type of network of this vrf. NetworkType NetworkType `protobuf:"varint,5,opt,name=network_type,json=networkType,proto3,enum=metalstack.api.v2.NetworkType" json:"network_type,omitempty"` // NatType what type of nat if any should be used. NatType NATType `protobuf:"varint,6,opt,name=nat_type,json=natType,proto3,enum=metalstack.api.v2.NATType" json:"nat_type,omitempty"` - // VRF the vrf id + // VRF the vrf id. Vrf uint64 `protobuf:"varint,7,opt,name=vrf,proto3" json:"vrf,omitempty"` - // ASN the autonomous system number for this network + // ASN the autonomous system number for this network. Asn uint32 `protobuf:"varint,8,opt,name=asn,proto3" json:"asn,omitempty"` // Project is the project uuid associated with this network. Project *string `protobuf:"bytes,9,opt,name=project,proto3,oneof" json:"project,omitempty"` @@ -2427,15 +2427,15 @@ func (x *MachineNetwork) GetProject() string { // MachineHardware contains hardware details. type MachineHardware struct { state protoimpl.MessageState `protogen:"open.v1"` - // Memory the total memory of the machine in bytes + // Memory the total memory of the machine in bytes. Memory uint64 `protobuf:"varint,1,opt,name=memory,proto3" json:"memory,omitempty"` - // Disks the list of block devices of this machine + // Disks the list of block devices of this machine. Disks []*MachineBlockDevice `protobuf:"bytes,2,rep,name=disks,proto3" json:"disks,omitempty"` - // CPUs the cpu details + // CPUs the cpu details. Cpus []*MetalCPU `protobuf:"bytes,3,rep,name=cpus,proto3" json:"cpus,omitempty"` - // GPUs the gpu details + // GPUs the gpu details. Gpus []*MetalGPU `protobuf:"bytes,4,rep,name=gpus,proto3" json:"gpus,omitempty"` - // Nics the list of network interfaces of this machine + // Nics the list of network interfaces of this machine. Nics []*MachineNic `protobuf:"bytes,5,rep,name=nics,proto3" json:"nics,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -2509,13 +2509,13 @@ func (x *MachineHardware) GetNics() []*MachineNic { // MetalCPU contains details of a cpu in this machine. type MetalCPU struct { state protoimpl.MessageState `protogen:"open.v1"` - // Vendor of this cpu + // Vendor of this cpu. Vendor string `protobuf:"bytes,1,opt,name=vendor,proto3" json:"vendor,omitempty"` - // Model of this cpu + // Model of this cpu. Model string `protobuf:"bytes,2,opt,name=model,proto3" json:"model,omitempty"` - // Cores of this cpu + // Cores of this cpu. Cores uint32 `protobuf:"varint,3,opt,name=cores,proto3" json:"cores,omitempty"` - // Threads of this cpu + // Threads of this cpu. Threads uint32 `protobuf:"varint,4,opt,name=threads,proto3" json:"threads,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -2582,9 +2582,9 @@ func (x *MetalCPU) GetThreads() uint32 { // MetalGPU contains details of a gpu in this machine. type MetalGPU struct { state protoimpl.MessageState `protogen:"open.v1"` - // Vendor of this gpu + // Vendor of this gpu. Vendor string `protobuf:"bytes,1,opt,name=vendor,proto3" json:"vendor,omitempty"` - // Model of this gpu + // Model of this gpu. Model string `protobuf:"bytes,2,opt,name=model,proto3" json:"model,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -2637,21 +2637,21 @@ func (x *MetalGPU) GetModel() string { // MachineNic contains details of a network interface of this machine. type MachineNic struct { state protoimpl.MessageState `protogen:"open.v1"` - // Mac the macaddress of this interface + // Mac the macaddress of this interface. Mac string `protobuf:"bytes,1,opt,name=mac,proto3" json:"mac,omitempty"` - // Name of this interface + // Name of this interface. Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` - // Identifier the unique identifier of this network interface + // Identifier the unique identifier of this network interface. Identifier string `protobuf:"bytes,3,opt,name=identifier,proto3" json:"identifier,omitempty"` - // Vendor of this network card + // Vendor of this network card. Vendor string `protobuf:"bytes,4,opt,name=vendor,proto3" json:"vendor,omitempty"` - // Model of this network card + // Model of this network card. Model string `protobuf:"bytes,5,opt,name=model,proto3" json:"model,omitempty"` - // Speed in bits/second of this network card + // Speed in bits/second of this network card. Speed uint64 `protobuf:"varint,6,opt,name=speed,proto3" json:"speed,omitempty"` - // Neighbors the neighbors visible to this network interface + // Neighbors the neighbors visible to this network interface. Neighbors []*MachineNic `protobuf:"bytes,7,rep,name=neighbors,proto3" json:"neighbors,omitempty"` - // Hostname the nic belongs to + // Hostname the nic belongs to. Hostname string `protobuf:"bytes,8,opt,name=hostname,proto3" json:"hostname,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -2746,9 +2746,9 @@ func (x *MachineNic) GetHostname() string { // MachineBlockDevice contains details of a block device of this machine. type MachineBlockDevice struct { state protoimpl.MessageState `protogen:"open.v1"` - // Name of this block device + // Name of this block device. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` - // Size of this block device in bytes + // Size of this block device in bytes. Size uint64 `protobuf:"varint,2,opt,name=size,proto3" json:"size,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -2801,9 +2801,9 @@ func (x *MachineBlockDevice) GetSize() uint64 { // MachineChassisIdentifyLEDState describes the identifier led state. type MachineChassisIdentifyLEDState struct { state protoimpl.MessageState `protogen:"open.v1"` - // Value the state of this chassis identify LED. empty means LED-OFF + // Value the state of this chassis identify LED. empty means LED-OF. Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"` - // Description a description why this chassis identify LED is in the given state + // Description a description why this chassis identify LED is in the given state. Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -2956,11 +2956,11 @@ func (x *MachineBMCReport) GetUpdatedAt() *timestamppb.Timestamp { // MachineBios contains BIOS details of this machine. type MachineBios struct { state protoimpl.MessageState `protogen:"open.v1"` - // Version the bios version + // Version the bios version. Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"` - // Vendor the bios vendor + // Vendor the bios vendor. Vendor string `protobuf:"bytes,2,opt,name=vendor,proto3" json:"vendor,omitempty"` - // Date the bios date as string because every vendor has different ideas how to describe the date + // Date the bios date as string because every vendor has different ideas how to describe the date. Date string `protobuf:"bytes,3,opt,name=date,proto3" json:"date,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -3020,19 +3020,19 @@ func (x *MachineBios) GetDate() string { // MachineBMC describe details of the ipmi or out of band device. type MachineBMC struct { state protoimpl.MessageState `protogen:"open.v1"` - // Address of this ipmi device from outside in the form of : + // Address of this ipmi device from outside in the form of :. Address string `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"` - // Mac address of the network interface of this ipmi device + // Mac address of the network interface of this ipmi device. Mac string `protobuf:"bytes,2,opt,name=mac,proto3" json:"mac,omitempty"` - // User of this ipmi device + // User of this ipmi device. User string `protobuf:"bytes,3,opt,name=user,proto3" json:"user,omitempty"` - // Password of this ipmi device + // Password of this ipmi device. Password string `protobuf:"bytes,4,opt,name=password,proto3" json:"password,omitempty"` - // Interface of this ipmi device + // Interface of this ipmi device. Interface string `protobuf:"bytes,5,opt,name=interface,proto3" json:"interface,omitempty"` - // Version of this bmc device + // Version of this bmc device. Version string `protobuf:"bytes,6,opt,name=version,proto3" json:"version,omitempty"` - // PowerState of this machine + // PowerState of this machine. PowerState string `protobuf:"bytes,7,opt,name=power_state,json=powerState,proto3" json:"power_state,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -3229,22 +3229,14 @@ func (x *MachineFRU) GetProductSerial() string { // MachinePowerMetric contains metrics of the power consumption of a machine. type MachinePowerMetric struct { state protoimpl.MessageState `protogen:"open.v1"` - // AverageConsumedWatts shall represent the - // average power level that occurred averaged over the last IntervalInMin - // minutes. + // AverageConsumedWatts shall represent the average power level that occurred averaged over the last IntervalInMin minutes. AverageConsumedWatts float32 `protobuf:"fixed32,1,opt,name=average_consumed_watts,json=averageConsumedWatts,proto3" json:"average_consumed_watts,omitempty"` - // IntervalInMin shall represent the time - // interval (or window), in minutes, in which the PowerMetrics properties - // are measured over. + // IntervalInMin shall represent the time interval (or window), in minutes, in which the PowerMetrics properties are measured over. // Should be an integer, but some Dell implementations return as a float. IntervalInMin float32 `protobuf:"fixed32,2,opt,name=interval_in_min,json=intervalInMin,proto3" json:"interval_in_min,omitempty"` - // MaxConsumedWatts shall represent the - // maximum power level in watts that occurred within the last - // IntervalInMin minutes. + // MaxConsumedWatts shall represent the maximum power level in watts that occurred within the last IntervalInMin minutes. MaxConsumedWatts float32 `protobuf:"fixed32,3,opt,name=max_consumed_watts,json=maxConsumedWatts,proto3" json:"max_consumed_watts,omitempty"` - // MinConsumedWatts shall represent the - // minimum power level in watts that occurred within the last - // IntervalInMin minutes. + // MinConsumedWatts shall represent the minimum power level in watts that occurred within the last IntervalInMin minutes. MinConsumedWatts float32 `protobuf:"fixed32,4,opt,name=min_consumed_watts,json=minConsumedWatts,proto3" json:"min_consumed_watts,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -3311,9 +3303,9 @@ func (x *MachinePowerMetric) GetMinConsumedWatts() float32 { // MachinePowerSupply contains details of the power supply of a machine. type MachinePowerSupply struct { state protoimpl.MessageState `protogen:"open.v1"` - // Health of the powersupply + // Health of the powersupply. Health string `protobuf:"bytes,1,opt,name=health,proto3" json:"health,omitempty"` - // State of the powersupply + // State of the powersupply. State string `protobuf:"bytes,2,opt,name=state,proto3" json:"state,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -3363,14 +3355,14 @@ func (x *MachinePowerSupply) GetState() string { return "" } -// MachineRecentProvisioningEvents the recent provisioning events for this machine +// MachineRecentProvisioningEvents the recent provisioning events for this machine. type MachineRecentProvisioningEvents struct { state protoimpl.MessageState `protogen:"open.v1"` - // Events the log of recent machine provisioning events + // Events the log of recent machine provisioning events. Events []*MachineProvisioningEvent `protobuf:"bytes,1,rep,name=events,proto3" json:"events,omitempty"` - // LastEventTime the time where the last event was received + // LastEventTime the time where the last event was received. LastEventTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=last_event_time,json=lastEventTime,proto3" json:"last_event_time,omitempty"` - // LastErrorEvent the last erroneous event received + // LastErrorEvent the last erroneous event received. LastErrorEvent *MachineProvisioningEvent `protobuf:"bytes,3,opt,name=last_error_event,json=lastErrorEvent,proto3" json:"last_error_event,omitempty"` // State can be either CrashLoop, FailedReclaim or something else. State MachineProvisioningEventState `protobuf:"varint,4,opt,name=state,proto3,enum=metalstack.api.v2.MachineProvisioningEventState" json:"state,omitempty"` @@ -3439,11 +3431,11 @@ func (x *MachineRecentProvisioningEvents) GetState() MachineProvisioningEventSta // MachineProvisioningEvent is an event that has occurred during provisioning. type MachineProvisioningEvent struct { state protoimpl.MessageState `protogen:"open.v1"` - // Time the time that this event was received + // Time the time that this event was received. Time *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=time,proto3" json:"time,omitempty"` - // Event the event emitted by the machine + // Event the event emitted by the machine. Event MachineProvisioningEventType `protobuf:"varint,2,opt,name=event,proto3,enum=metalstack.api.v2.MachineProvisioningEventType" json:"event,omitempty"` - // Message an additional message to add to the event + // Message an additional message to add to the event. Message string `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -3503,13 +3495,13 @@ func (x *MachineProvisioningEvent) GetMessage() string { // MachineVPN contains configuration data for the VPN connection. type MachineVPN struct { state protoimpl.MessageState `protogen:"open.v1"` - // Address of VPN control plane + // Address of VPN control plane. ControlPlaneAddress string `protobuf:"bytes,1,opt,name=control_plane_address,json=controlPlaneAddress,proto3" json:"control_plane_address,omitempty"` - // Auth key used to connect to VPN + // Auth key used to connect to VPN. AuthKey string `protobuf:"bytes,2,opt,name=auth_key,json=authKey,proto3" json:"auth_key,omitempty"` // Connected indicate if this machine is connected to the VPN. Connected bool `protobuf:"varint,3,opt,name=connected,proto3" json:"connected,omitempty"` - // IPs of the machine connected to the vpn + // IPs of the machine connected to the vpn. Ips []string `protobuf:"bytes,4,rep,name=ips,proto3" json:"ips,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -3576,35 +3568,35 @@ func (x *MachineVPN) GetIps() []string { // MachineQuery contains fields which can be specified to list specific machines. type MachineQuery struct { state protoimpl.MessageState `protogen:"open.v1"` - // UUID of the machine to get + // UUID of the machine to get. Uuid *string `protobuf:"bytes,1,opt,name=uuid,proto3,oneof" json:"uuid,omitempty"` - // Name of the machine to get + // Name of the machine to get. Name *string `protobuf:"bytes,2,opt,name=name,proto3,oneof" json:"name,omitempty"` - // Partition of the machine to get + // Partition of the machine to get. Partition *string `protobuf:"bytes,3,opt,name=partition,proto3,oneof" json:"partition,omitempty"` - // Size of the machine to get + // Size of the machine to get. Size *string `protobuf:"bytes,4,opt,name=size,proto3,oneof" json:"size,omitempty"` - // Rack of the machine to get + // Rack of the machine to get. Rack *string `protobuf:"bytes,5,opt,name=rack,proto3,oneof" json:"rack,omitempty"` - // Room of the machine to get + // Room of the machine to get. Room *string `protobuf:"bytes,6,opt,name=room,proto3,oneof" json:"room,omitempty"` - // Labels for which this machine should get filtered + // Labels for which this machine should get filtered. Labels *Labels `protobuf:"bytes,7,opt,name=labels,proto3,oneof" json:"labels,omitempty"` - // Allocation specific machine queries + // Allocation specific machine queries. Allocation *MachineAllocationQuery `protobuf:"bytes,8,opt,name=allocation,proto3,oneof" json:"allocation,omitempty"` - // Network specific machine queries + // Network specific machine queries. Network *MachineNetworkQuery `protobuf:"bytes,9,opt,name=network,proto3,oneof" json:"network,omitempty"` - // Nic specific machine queries + // Nic specific machine queries. Nic *MachineNicQuery `protobuf:"bytes,10,opt,name=nic,proto3,oneof" json:"nic,omitempty"` - // Disk specific machine queries + // Disk specific machine queries. Disk *MachineDiskQuery `protobuf:"bytes,11,opt,name=disk,proto3,oneof" json:"disk,omitempty"` - // Bmc specific machine queries + // Bmc specific machine queries. Bmc *MachineBMCQuery `protobuf:"bytes,12,opt,name=bmc,proto3,oneof" json:"bmc,omitempty"` - // Fru specific machine queries + // Fru specific machine queries. Fru *MachineFRUQuery `protobuf:"bytes,13,opt,name=fru,proto3,oneof" json:"fru,omitempty"` - // Hardware specific machine query + // Hardware specific machine query. Hardware *MachineHardwareQuery `protobuf:"bytes,14,opt,name=hardware,proto3,oneof" json:"hardware,omitempty"` - // State this machine has + // State this machine has. State *MachineState `protobuf:"varint,15,opt,name=state,proto3,enum=metalstack.api.v2.MachineState,oneof" json:"state,omitempty"` // Waiting if set to true, only waiting machines are returned. // Only useful for admins. @@ -3775,26 +3767,26 @@ func (x *MachineQuery) GetNotAllocated() bool { return false } -// MachineAllocationQuery allocation specific query parameters +// MachineAllocationQuery allocation specific query parameters. type MachineAllocationQuery struct { state protoimpl.MessageState `protogen:"open.v1"` - // UUID of the allocation of the machine to get + // UUID of the allocation of the machine to get. Uuid *string `protobuf:"bytes,1,opt,name=uuid,proto3,oneof" json:"uuid,omitempty"` - // Name of the machine to get + // Name of the machine to get. Name *string `protobuf:"bytes,2,opt,name=name,proto3,oneof" json:"name,omitempty"` - // Project of the machine to get + // Project of the machine to get. Project *string `protobuf:"bytes,3,opt,name=project,proto3,oneof" json:"project,omitempty"` - // Image of the machine to get + // Image of the machine to get. Image *string `protobuf:"bytes,4,opt,name=image,proto3,oneof" json:"image,omitempty"` - // FilesystemLayout of the machine to get + // FilesystemLayout of the machine to get. FilesystemLayout *string `protobuf:"bytes,5,opt,name=filesystem_layout,json=filesystemLayout,proto3,oneof" json:"filesystem_layout,omitempty"` - // Hostname of the machine to get + // Hostname of the machine to get. Hostname *string `protobuf:"bytes,6,opt,name=hostname,proto3,oneof" json:"hostname,omitempty"` - // AllocationType of this machine + // AllocationType of this machine. AllocationType *MachineAllocationType `protobuf:"varint,7,opt,name=allocation_type,json=allocationType,proto3,enum=metalstack.api.v2.MachineAllocationType,oneof" json:"allocation_type,omitempty"` - // Labels for which this machine allocation should get filtered + // Labels for which this machine allocation should get filtered. Labels *Labels `protobuf:"bytes,8,opt,name=labels,proto3,oneof" json:"labels,omitempty"` - // VPN query if this machine has a vpn configuration + // VPN query if this machine has a vpn configuration. Vpn *MachineVPN `protobuf:"bytes,9,opt,name=vpn,proto3,oneof" json:"vpn,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -3893,20 +3885,20 @@ func (x *MachineAllocationQuery) GetVpn() *MachineVPN { return nil } -// MachineNetworkQuery network specific machine queries +// MachineNetworkQuery network specific machine queries. type MachineNetworkQuery struct { state protoimpl.MessageState `protogen:"open.v1"` - // Networks this machine is connected to + // Networks this machine is connected to. Networks []string `protobuf:"bytes,1,rep,name=networks,proto3" json:"networks,omitempty"` - // Prefixes this machine is connected to + // Prefixes this machine is connected to. Prefixes []string `protobuf:"bytes,2,rep,name=prefixes,proto3" json:"prefixes,omitempty"` - // DestinationPrefixes this machine is connected to + // DestinationPrefixes this machine is connected to. DestinationPrefixes []string `protobuf:"bytes,3,rep,name=destination_prefixes,json=destinationPrefixes,proto3" json:"destination_prefixes,omitempty"` - // IPs this machine has + // IPs this machine has. Ips []string `protobuf:"bytes,4,rep,name=ips,proto3" json:"ips,omitempty"` - // VRFs this machine is connected to + // VRFs this machine is connected to. Vrfs []uint64 `protobuf:"varint,5,rep,packed,name=vrfs,proto3" json:"vrfs,omitempty"` - // ASNs this machine is connected to + // ASNs this machine is connected to. Asns []uint32 `protobuf:"varint,6,rep,packed,name=asns,proto3" json:"asns,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -3984,16 +3976,16 @@ func (x *MachineNetworkQuery) GetAsns() []uint32 { return nil } -// MachineNicQuery nic specific machine queries +// MachineNicQuery nic specific machine queries. type MachineNicQuery struct { state protoimpl.MessageState `protogen:"open.v1"` - // Macs this machine nic has + // Macs this machine nic has. Macs []string `protobuf:"bytes,1,rep,name=macs,proto3" json:"macs,omitempty"` - // Names this machine nic has + // Names this machine nic has. Names []string `protobuf:"bytes,2,rep,name=names,proto3" json:"names,omitempty"` - // NeighborMacs this machine nic has + // NeighborMacs this machine nic has. NeighborMacs []string `protobuf:"bytes,3,rep,name=neighbor_macs,json=neighborMacs,proto3" json:"neighbor_macs,omitempty"` - // NeighborNames this machine nic has + // NeighborNames this machine nic has. NeighborNames []string `protobuf:"bytes,4,rep,name=neighbor_names,json=neighborNames,proto3" json:"neighbor_names,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -4057,12 +4049,12 @@ func (x *MachineNicQuery) GetNeighborNames() []string { return nil } -// MachineDiskQuery disk specific machine queries +// MachineDiskQuery disk specific machine queries. type MachineDiskQuery struct { state protoimpl.MessageState `protogen:"open.v1"` - // Names of disks in this machine + // Names of disks in this machine. Names []string `protobuf:"bytes,1,rep,name=names,proto3" json:"names,omitempty"` - // Sizes of disks in this machine + // Sizes of disks in this machine. Sizes []uint64 `protobuf:"varint,2,rep,packed,name=sizes,proto3" json:"sizes,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -4112,16 +4104,16 @@ func (x *MachineDiskQuery) GetSizes() []uint64 { return nil } -// MachineBMCQuery machine ipmi or bmc specific machine queries +// MachineBMCQuery machine ipmi or bmc specific machine queries. type MachineBMCQuery struct { state protoimpl.MessageState `protogen:"open.v1"` - // Address of the ipmi system of this machine + // Address of the ipmi system of this machine. Address *string `protobuf:"bytes,1,opt,name=address,proto3,oneof" json:"address,omitempty"` - // Mac of the ipmi system of this machine + // Mac of the ipmi system of this machine. Mac *string `protobuf:"bytes,2,opt,name=mac,proto3,oneof" json:"mac,omitempty"` - // User of the ipmi system of this machine + // User of the ipmi system of this machine. User *string `protobuf:"bytes,3,opt,name=user,proto3,oneof" json:"user,omitempty"` - // Interface of the ipmi system of this machine + // Interface of the ipmi system of this machine. Interface *string `protobuf:"bytes,4,opt,name=interface,proto3,oneof" json:"interface,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -4185,24 +4177,24 @@ func (x *MachineBMCQuery) GetInterface() string { return "" } -// MachineFRUQuery machine fru specific machine queries +// MachineFRUQuery machine fru specific machine queries. type MachineFRUQuery struct { state protoimpl.MessageState `protogen:"open.v1"` - // ChassisPartNumber of this machine + // ChassisPartNumber of this machine. ChassisPartNumber *string `protobuf:"bytes,1,opt,name=chassis_part_number,json=chassisPartNumber,proto3,oneof" json:"chassis_part_number,omitempty"` - // ChassisPartSerial of this machine + // ChassisPartSerial of this machine. ChassisPartSerial *string `protobuf:"bytes,2,opt,name=chassis_part_serial,json=chassisPartSerial,proto3,oneof" json:"chassis_part_serial,omitempty"` - // BoardMFG of this machine + // BoardMFG of this machine. BoardMfg *string `protobuf:"bytes,3,opt,name=board_mfg,json=boardMfg,proto3,oneof" json:"board_mfg,omitempty"` - // BoardSerial of this machine + // BoardSerial of this machine. BoardSerial *string `protobuf:"bytes,4,opt,name=board_serial,json=boardSerial,proto3,oneof" json:"board_serial,omitempty"` - // BoardPartNumber of this machine + // BoardPartNumber of this machine. BoardPartNumber *string `protobuf:"bytes,5,opt,name=board_part_number,json=boardPartNumber,proto3,oneof" json:"board_part_number,omitempty"` - // ProductManufacturer of this machine + // ProductManufacturer of this machine. ProductManufacturer *string `protobuf:"bytes,6,opt,name=product_manufacturer,json=productManufacturer,proto3,oneof" json:"product_manufacturer,omitempty"` - // ProductPartNumber of this machine + // ProductPartNumber of this machine. ProductPartNumber *string `protobuf:"bytes,7,opt,name=product_part_number,json=productPartNumber,proto3,oneof" json:"product_part_number,omitempty"` - // ProductSerial of this machine + // ProductSerial of this machine. ProductSerial *string `protobuf:"bytes,8,opt,name=product_serial,json=productSerial,proto3,oneof" json:"product_serial,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -4294,12 +4286,12 @@ func (x *MachineFRUQuery) GetProductSerial() string { return "" } -// MachineHardwareQuery machine hardware specific machine queries +// MachineHardwareQuery machine hardware specific machine queries. type MachineHardwareQuery struct { state protoimpl.MessageState `protogen:"open.v1"` - // Memory the total memory of the machine in bytes + // Memory the total memory of the machine in bytes. Memory *uint64 `protobuf:"varint,1,opt,name=memory,proto3,oneof" json:"memory,omitempty"` - // CPUCores the number of cpu cores + // CPUCores the number of cpu cores. CpuCores *uint32 `protobuf:"varint,2,opt,name=cpu_cores,json=cpuCores,proto3,oneof" json:"cpu_cores,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -4352,11 +4344,11 @@ func (x *MachineHardwareQuery) GetCpuCores() uint32 { // MachineIssuesQuery defines which machine issues should be listed. type MachineIssuesQuery struct { state protoimpl.MessageState `protogen:"open.v1"` - // MachineQuery to select specific machines + // MachineQuery to select specific machines. MachineQuery *MachineQuery `protobuf:"bytes,1,opt,name=machine_query,json=machineQuery,proto3" json:"machine_query,omitempty"` // Only includes the specified machine issue types. Only []MachineIssueType `protobuf:"varint,2,rep,packed,name=only,proto3,enum=metalstack.api.v2.MachineIssueType" json:"only,omitempty"` - // Omits the specified machine issues + // Omits the specified machine issues. Omit []MachineIssueType `protobuf:"varint,3,rep,packed,name=omit,proto3,enum=metalstack.api.v2.MachineIssueType" json:"omit,omitempty"` // Severity filters issue for given severity. Severity *MachineIssueSeverity `protobuf:"varint,4,opt,name=severity,proto3,enum=metalstack.api.v2.MachineIssueSeverity,oneof" json:"severity,omitempty"` @@ -4434,9 +4426,9 @@ func (x *MachineIssuesQuery) GetLastErrorThreshold() *durationpb.Duration { // MachineIssues is a list of issues for a machine. type MachineIssues struct { state protoimpl.MessageState `protogen:"open.v1"` - // UUID of the machine for which the issues are listed + // UUID of the machine for which the issues are listed. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` - // Issues of this machine + // Issues of this machine. Issues []*MachineIssue `protobuf:"bytes,2,rep,name=issues,proto3" json:"issues,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -4489,7 +4481,7 @@ func (x *MachineIssues) GetIssues() []*MachineIssue { // MachineIssue contains details of one issue. type MachineIssue struct { state protoimpl.MessageState `protogen:"open.v1"` - // Type specifies the issue type (id) + // Type specifies the issue type (id). Type MachineIssueType `protobuf:"varint,1,opt,name=type,proto3,enum=metalstack.api.v2.MachineIssueType" json:"type,omitempty"` // Severity specifies the severity of an issue. Severity MachineIssueSeverity `protobuf:"varint,2,opt,name=severity,proto3,enum=metalstack.api.v2.MachineIssueSeverity" json:"severity,omitempty"` diff --git a/go/metalstack/api/v2/network.pb.go b/go/metalstack/api/v2/network.pb.go index be833aea..3485903f 100644 --- a/go/metalstack/api/v2/network.pb.go +++ b/go/metalstack/api/v2/network.pb.go @@ -30,7 +30,7 @@ const ( NATType_NAT_TYPE_UNSPECIFIED NATType = 0 // NAT_TYPE_NONE indicates that no nat is configured. NATType_NAT_TYPE_NONE NATType = 1 - // NAT_TYPE_IPV4_MASQUERADE masquerade ipv4 behind gateway ip when traffic enters this network + // NAT_TYPE_IPV4_MASQUERADE masquerade ipv4 behind gateway ip when traffic enters this network. NATType_NAT_TYPE_IPV4_MASQUERADE NATType = 2 ) @@ -86,7 +86,7 @@ const ( // If it is not project scoped everyone can allocate Ips in this network, otherwise only from the same project ip allocation is possible. NetworkType_NETWORK_TYPE_EXTERNAL NetworkType = 1 // NETWORK_TYPE_UNDERLAY indicates a underlay network. - // The underlay network connects all switches and the firewalls to build a EVPN dataplane + // The underlay network connects all switches and the firewalls to build a EVPN dataplane. // It is not project scoped. Is part of the dataplane and reserved for administrative purposes. NetworkType_NETWORK_TYPE_UNDERLAY NetworkType = 2 // NETWORK_TYPE_SUPER indicates a super network which is only used to create child networks. @@ -224,12 +224,12 @@ func (NetworkAddressFamily) EnumDescriptor() ([]byte, []int) { return file_metalstack_api_v2_network_proto_rawDescGZIP(), []int{2} } -// NetworkServiceGetRequest +// NetworkServiceGetRequest. type NetworkServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // ID of the network to get + // ID of the network to get. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` - // Project of the network + // Project of the network. Project string `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -279,10 +279,10 @@ func (x *NetworkServiceGetRequest) GetProject() string { return "" } -// NetworkServiceGetResponse +// NetworkServiceGetResponse. type NetworkServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Network which was requested to get + // Network which was requested to get. Network *Network `protobuf:"bytes,1,opt,name=network,proto3" json:"network,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -325,24 +325,24 @@ func (x *NetworkServiceGetResponse) GetNetwork() *Network { return nil } -// NetworkServiceCreateRequest +// NetworkServiceCreateRequest. type NetworkServiceCreateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Project where this network belongs to. Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` - // Name of this network + // Name of this network. Name *string `protobuf:"bytes,2,opt,name=name,proto3,oneof" json:"name,omitempty"` - // Description of this network + // Description of this network. Description *string `protobuf:"bytes,3,opt,name=description,proto3,oneof" json:"description,omitempty"` // Partition where this network will be created. Partition *string `protobuf:"bytes,4,opt,name=partition,proto3,oneof" json:"partition,omitempty"` - // Labels on this network + // Labels on this network. Labels *Labels `protobuf:"bytes,5,opt,name=labels,proto3" json:"labels,omitempty"` // Parent Network points to the id of the parent network if any. ParentNetwork *string `protobuf:"bytes,6,opt,name=parent_network,json=parentNetwork,proto3,oneof" json:"parent_network,omitempty"` - // Length per addressfamily + // Length per addressfamily. Length *ChildPrefixLength `protobuf:"bytes,7,opt,name=length,proto3,oneof" json:"length,omitempty"` - // AddressFamily to create, defaults to the same as the parent + // AddressFamily to create, defaults to the same as the parent. AddressFamily *NetworkAddressFamily `protobuf:"varint,8,opt,name=address_family,json=addressFamily,proto3,enum=metalstack.api.v2.NetworkAddressFamily,oneof" json:"address_family,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -434,7 +434,7 @@ func (x *NetworkServiceCreateRequest) GetAddressFamily() NetworkAddressFamily { return NetworkAddressFamily_NETWORK_ADDRESS_FAMILY_UNSPECIFIED } -// NetworkServiceCreateResponse +// NetworkServiceCreateResponse. type NetworkServiceCreateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Network is the created network. @@ -480,20 +480,20 @@ func (x *NetworkServiceCreateResponse) GetNetwork() *Network { return nil } -// NetworkServiceUpdateRequest +// NetworkServiceUpdateRequest. type NetworkServiceUpdateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // ID of the network to get + // ID of the network to get. 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 *UpdateMeta `protobuf:"bytes,2,opt,name=update_meta,json=updateMeta,proto3" json:"update_meta,omitempty"` - // Project of the network + // Project of the network. Project string `protobuf:"bytes,3,opt,name=project,proto3" json:"project,omitempty"` - // Name of this network + // Name of this network. Name *string `protobuf:"bytes,4,opt,name=name,proto3,oneof" json:"name,omitempty"` - // Description of this network + // Description of this network. Description *string `protobuf:"bytes,5,opt,name=description,proto3,oneof" json:"description,omitempty"` - // Labels on this network + // Labels on this network. Labels *UpdateLabels `protobuf:"bytes,6,opt,name=labels,proto3,oneof" json:"labels,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -571,7 +571,7 @@ func (x *NetworkServiceUpdateRequest) GetLabels() *UpdateLabels { return nil } -// NetworkServiceUpdateResponse +// NetworkServiceUpdateResponse. type NetworkServiceUpdateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Network is the updated network. @@ -617,10 +617,10 @@ func (x *NetworkServiceUpdateResponse) GetNetwork() *Network { return nil } -// NetworkServiceListRequest +// NetworkServiceListRequest. type NetworkServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Project of the networks to list + // Project of the networks to list. Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` // Query which specifies which networks to return. Query *NetworkQuery `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"` @@ -672,7 +672,7 @@ func (x *NetworkServiceListRequest) GetQuery() *NetworkQuery { return nil } -// NetworkServiceListResponse +// NetworkServiceListResponse. type NetworkServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Networks are the requested networks. @@ -718,10 +718,10 @@ func (x *NetworkServiceListResponse) GetNetworks() []*Network { return nil } -// NetworkServiceListRequest +// NetworkServiceListRequest. type NetworkServiceListBaseNetworksRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Project of the base networks to list + // Project of the base networks to list. Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` // Query which specifies which networks to return. Query *NetworkQuery `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"` @@ -773,7 +773,7 @@ func (x *NetworkServiceListBaseNetworksRequest) GetQuery() *NetworkQuery { return nil } -// NetworkServiceListResponse +// NetworkServiceListResponse. type NetworkServiceListBaseNetworksResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Networks are the requested networks. @@ -819,12 +819,12 @@ func (x *NetworkServiceListBaseNetworksResponse) GetNetworks() []*Network { return nil } -// NetworkServiceDeleteRequest +// NetworkServiceDeleteRequest. type NetworkServiceDeleteRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // ID of the network to get + // ID of the network to get. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` - // Project of the network + // Project of the network. Project string `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -874,7 +874,7 @@ func (x *NetworkServiceDeleteRequest) GetProject() string { return "" } -// NetworkServiceDeleteResponse +// NetworkServiceDeleteResponse. type NetworkServiceDeleteResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Network is the deleted network. @@ -920,35 +920,35 @@ func (x *NetworkServiceDeleteResponse) GetNetwork() *Network { return nil } -// Network +// Network. type Network struct { state protoimpl.MessageState `protogen:"open.v1"` - // Id of this network + // Id of this network. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` - // Meta for this network + // Meta for this network. Meta *Meta `protobuf:"bytes,2,opt,name=meta,proto3" json:"meta,omitempty"` - // Name of this network + // Name of this network. Name *string `protobuf:"bytes,3,opt,name=name,proto3,oneof" json:"name,omitempty"` - // Description of this network + // Description of this network. Description *string `protobuf:"bytes,4,opt,name=description,proto3,oneof" json:"description,omitempty"` // Partition where this network will be created. Partition *string `protobuf:"bytes,5,opt,name=partition,proto3,oneof" json:"partition,omitempty"` // Project where this network belongs to. Project *string `protobuf:"bytes,6,opt,name=project,proto3,oneof" json:"project,omitempty"` // Namespace if specified, this network is namespaced and can therefore overlap with others. - // Will be equal with project most of the time + // Will be equal with project most of the time. Namespace *string `protobuf:"bytes,7,opt,name=namespace,proto3,oneof" json:"namespace,omitempty"` - // Prefixes in this network + // Prefixes in this network. Prefixes []string `protobuf:"bytes,8,rep,name=prefixes,proto3" json:"prefixes,omitempty"` - // Destination Prefixes in this network + // Destination Prefixes in this network. DestinationPrefixes []string `protobuf:"bytes,9,rep,name=destination_prefixes,json=destinationPrefixes,proto3" json:"destination_prefixes,omitempty"` // Default Child Prefix length defines the bit length of a child network created per address family, if not specified during the allocate request. DefaultChildPrefixLength *ChildPrefixLength `protobuf:"bytes,10,opt,name=default_child_prefix_length,json=defaultChildPrefixLength,proto3" json:"default_child_prefix_length,omitempty"` // Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length. MinChildPrefixLength *ChildPrefixLength `protobuf:"bytes,11,opt,name=min_child_prefix_length,json=minChildPrefixLength,proto3" json:"min_child_prefix_length,omitempty"` - // Type of the network + // Type of the network. Type NetworkType `protobuf:"varint,12,opt,name=type,proto3,enum=metalstack.api.v2.NetworkType" json:"type,omitempty"` - // NATType of this network + // NATType of this network. NatType NATType `protobuf:"varint,13,opt,name=nat_type,json=natType,proto3,enum=metalstack.api.v2.NATType" json:"nat_type,omitempty"` // VRF of this network has this VNI. Vrf *uint32 `protobuf:"varint,14,opt,name=vrf,proto3,oneof" json:"vrf,omitempty"` @@ -956,7 +956,7 @@ type Network struct { ParentNetwork *string `protobuf:"bytes,15,opt,name=parent_network,json=parentNetwork,proto3,oneof" json:"parent_network,omitempty"` // AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced. AdditionalAnnouncableCidrs []string `protobuf:"bytes,16,rep,name=additional_announcable_cidrs,json=additionalAnnouncableCidrs,proto3" json:"additional_announcable_cidrs,omitempty"` - // Consumption of IPs and prefixes in this network + // Consumption of IPs and prefixes in this network. Consumption *NetworkConsumption `protobuf:"bytes,17,opt,name=consumption,proto3" json:"consumption,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1114,11 +1114,11 @@ func (x *Network) GetConsumption() *NetworkConsumption { // NetworkQuery defines which networks to query. type NetworkQuery struct { state protoimpl.MessageState `protogen:"open.v1"` - // Id of the network to query + // Id of the network to query. Id *string `protobuf:"bytes,1,opt,name=id,proto3,oneof" json:"id,omitempty"` - // Name of this network + // Name of this network. Name *string `protobuf:"bytes,2,opt,name=name,proto3,oneof" json:"name,omitempty"` - // Description of this network + // Description of this network. Description *string `protobuf:"bytes,3,opt,name=description,proto3,oneof" json:"description,omitempty"` // Partition where this network will be created. Partition *string `protobuf:"bytes,4,opt,name=partition,proto3,oneof" json:"partition,omitempty"` @@ -1126,21 +1126,21 @@ type NetworkQuery struct { Project *string `protobuf:"bytes,5,opt,name=project,proto3,oneof" json:"project,omitempty"` // Namespace where this network belongs to. Namespace *string `protobuf:"bytes,6,opt,name=namespace,proto3,oneof" json:"namespace,omitempty"` - // Prefixes in this network + // Prefixes in this network. Prefixes []string `protobuf:"bytes,7,rep,name=prefixes,proto3" json:"prefixes,omitempty"` - // Destination Prefixes in this network + // Destination Prefixes in this network. DestinationPrefixes []string `protobuf:"bytes,8,rep,name=destination_prefixes,json=destinationPrefixes,proto3" json:"destination_prefixes,omitempty"` // VRF of this network has this VNI. Vrf *uint32 `protobuf:"varint,9,opt,name=vrf,proto3,oneof" json:"vrf,omitempty"` // Parent Network points to the id of the parent network if any. ParentNetwork *string `protobuf:"bytes,10,opt,name=parent_network,json=parentNetwork,proto3,oneof" json:"parent_network,omitempty"` - // Addressfamily to query + // Addressfamily to query. AddressFamily *NetworkAddressFamily `protobuf:"varint,11,opt,name=address_family,json=addressFamily,proto3,enum=metalstack.api.v2.NetworkAddressFamily,oneof" json:"address_family,omitempty"` - // Type of the network to query for + // Type of the network to query for. Type *NetworkType `protobuf:"varint,12,opt,name=type,proto3,enum=metalstack.api.v2.NetworkType,oneof" json:"type,omitempty"` - // NATType configured + // NATType configured. NatType *NATType `protobuf:"varint,13,opt,name=nat_type,json=natType,proto3,enum=metalstack.api.v2.NATType,oneof" json:"nat_type,omitempty"` - // Labels on this network + // Labels on this network. Labels *Labels `protobuf:"bytes,14,opt,name=labels,proto3,oneof" json:"labels,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1274,12 +1274,12 @@ func (x *NetworkQuery) GetLabels() *Labels { return nil } -// ChildPrefixLength +// ChildPrefixLength. type ChildPrefixLength struct { state protoimpl.MessageState `protogen:"open.v1"` - // IPv4 bit length of this network in this addressfamily + // IPv4 bit length of this network in this addressfamily. Ipv4 *uint32 `protobuf:"varint,1,opt,name=ipv4,proto3,oneof" json:"ipv4,omitempty"` - // IPv6 bit length of this network in this addressfamily + // IPv6 bit length of this network in this addressfamily. Ipv6 *uint32 `protobuf:"varint,2,opt,name=ipv6,proto3,oneof" json:"ipv6,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1332,7 +1332,7 @@ func (x *ChildPrefixLength) GetIpv6() uint32 { // NetworkConsumption contains ip and prefix usage by addressfamily. type NetworkConsumption struct { state protoimpl.MessageState `protogen:"open.v1"` - // IPv4 network usage + // IPv4 network usage. Ipv4 *NetworkUsage `protobuf:"bytes,1,opt,name=ipv4,proto3" json:"ipv4,omitempty"` // IPv6 network usage, this can be approximated for high numbers. Ipv6 *NetworkUsage `protobuf:"bytes,2,opt,name=ipv6,proto3" json:"ipv6,omitempty"` @@ -1387,13 +1387,13 @@ func (x *NetworkConsumption) GetIpv6() *NetworkUsage { // NetworkUsage reports core metrics about available and used IPs or Prefixes in a Network. type NetworkUsage struct { state protoimpl.MessageState `protogen:"open.v1"` - // the total available IPs + // the total available IPs. AvailableIps uint64 `protobuf:"varint,1,opt,name=available_ips,json=availableIps,proto3" json:"available_ips,omitempty"` - // the total used IPs + // the total used IPs. UsedIps uint64 `protobuf:"varint,2,opt,name=used_ips,json=usedIps,proto3" json:"used_ips,omitempty"` - // the total available 2-bit prefixes + // the total available 2-bit prefixes. AvailablePrefixes uint64 `protobuf:"varint,3,opt,name=available_prefixes,json=availablePrefixes,proto3" json:"available_prefixes,omitempty"` - // the total used Prefixes + // the total used Prefixes. UsedPrefixes uint64 `protobuf:"varint,4,opt,name=used_prefixes,json=usedPrefixes,proto3" json:"used_prefixes,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/api/v2/partition.pb.go b/go/metalstack/api/v2/partition.pb.go index 0ff98594..57203238 100644 --- a/go/metalstack/api/v2/partition.pb.go +++ b/go/metalstack/api/v2/partition.pb.go @@ -25,20 +25,20 @@ const ( // Partition is a failure domain with machines and switches. type Partition struct { state protoimpl.MessageState `protogen:"open.v1"` - // ID of this partition + // ID of this partition. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` - // Meta for this partition + // Meta for this partition. Meta *Meta `protobuf:"bytes,2,opt,name=meta,proto3" json:"meta,omitempty"` - // Description of this partition + // Description of this partition. Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"` // PartitionBootConfiguration defines how metal-hammer boots. BootConfiguration *PartitionBootConfiguration `protobuf:"bytes,4,opt,name=boot_configuration,json=bootConfiguration,proto3" json:"boot_configuration,omitempty"` - // DNSServers for this partition + // DNSServers for this partition. DnsServers []*DNSServer `protobuf:"bytes,5,rep,name=dns_servers,json=dnsServers,proto3" json:"dns_servers,omitempty"` - // NTPServers for this partition + // NTPServers for this partition. NtpServers []*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 : + // should be in the form :. MgmtServiceAddresses []string `protobuf:"bytes,7,rep,name=mgmt_service_addresses,json=mgmtServiceAddresses,proto3" json:"mgmt_service_addresses,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -126,7 +126,7 @@ func (x *Partition) GetMgmtServiceAddresses() []string { // PartitionQuery is used to search partitions. type PartitionQuery struct { state protoimpl.MessageState `protogen:"open.v1"` - // ID of the partition to get + // ID of the partition to get. Id *string `protobuf:"bytes,1,opt,name=id,proto3,oneof" json:"id,omitempty"` // Labels lists only partitions containing the given labels. Labels *Labels `protobuf:"bytes,2,opt,name=labels,proto3,oneof" json:"labels,omitempty"` @@ -181,11 +181,11 @@ func (x *PartitionQuery) GetLabels() *Labels { // PartitionBootConfiguration defines how metal-hammer boots. type PartitionBootConfiguration struct { state protoimpl.MessageState `protogen:"open.v1"` - // ImageURL the url to download the initrd for the boot image + // ImageURL the url to download the initrd for the boot image. ImageUrl string `protobuf:"bytes,1,opt,name=image_url,json=imageUrl,proto3" json:"image_url,omitempty"` - // KernelURL the url to download the kernel for the boot image + // KernelURL the url to download the kernel for the boot image. KernelUrl string `protobuf:"bytes,2,opt,name=kernel_url,json=kernelUrl,proto3" json:"kernel_url,omitempty"` - // Commandline the kernel command line for the boot image + // Commandline the kernel command line for the boot image. Commandline string `protobuf:"bytes,3,opt,name=commandline,proto3" json:"commandline,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -242,10 +242,10 @@ func (x *PartitionBootConfiguration) GetCommandline() string { return "" } -// DNSServer +// DNSServer. type DNSServer struct { state protoimpl.MessageState `protogen:"open.v1"` - // IP address of this dns server + // IP address of this dns server. Ip string `protobuf:"bytes,1,opt,name=ip,proto3" json:"ip,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -288,10 +288,10 @@ func (x *DNSServer) GetIp() string { return "" } -// NTPServer +// NTPServer. type NTPServer struct { state protoimpl.MessageState `protogen:"open.v1"` - // Address either as ip or hostname + // Address either as ip or hostname. Address string `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -337,7 +337,7 @@ func (x *NTPServer) GetAddress() string { // PartitionServiceGetRequest is the request payload for a partition get request. type PartitionServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // ID of the partition to get + // ID of the partition to get. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/api/v2/project.pb.go b/go/metalstack/api/v2/project.pb.go index 226aaba4..4822b63f 100644 --- a/go/metalstack/api/v2/project.pb.go +++ b/go/metalstack/api/v2/project.pb.go @@ -24,20 +24,20 @@ const ( ) // Project defines a group of resources belonging to a tenant. -// a tenant can have multiple projects +// a tenant can have multiple projects. type Project struct { state protoimpl.MessageState `protogen:"open.v1"` - // Uuid of this project + // Uuid of this project. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` - // Meta for this project + // Meta for this project. Meta *Meta `protobuf:"bytes,2,opt,name=meta,proto3" json:"meta,omitempty"` - // Name of this project must be unique per tenant + // Name of this project must be unique per tenant. Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"` - // Description of this project + // Description of this project. Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"` - // Tenant this project belongs to + // Tenant this project belongs to. Tenant string `protobuf:"bytes,5,opt,name=tenant,proto3" json:"tenant,omitempty"` - // AvatarUrl of the Project + // AvatarUrl of the Project. AvatarUrl *string `protobuf:"bytes,6,opt,name=avatar_url,json=avatarUrl,proto3,oneof" json:"avatar_url,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -126,9 +126,9 @@ type ProjectMember struct { // This member does not have direct project membership but gains permissions on this project from the role he has in the tenant. // Inherited memberships are not included in member lists for users with guest permission but only for direct tenant members. InheritedMembership bool `protobuf:"varint,3,opt,name=inherited_membership,json=inheritedMembership,proto3" json:"inherited_membership,omitempty"` - // CreatedAt the date when the member was added to the project + // CreatedAt the date when the member was added to the project. CreatedAt *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"` - // Meta for this project member + // Meta for this project member. Meta *Meta `protobuf:"bytes,5,opt,name=meta,proto3" json:"meta,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -216,9 +216,9 @@ type ProjectInvite struct { Tenant string `protobuf:"bytes,6,opt,name=tenant,proto3" json:"tenant,omitempty"` // TenantName is the name of the tenant inviting another user to join this project. TenantName string `protobuf:"bytes,7,opt,name=tenant_name,json=tenantName,proto3" json:"tenant_name,omitempty"` - // ExpiresAt the date when this invite expires + // ExpiresAt the date when this invite expires. ExpiresAt *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"` - // JoinedAt the date when the member accepted this invite + // JoinedAt the date when the member accepted this invite. JoinedAt *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=joined_at,json=joinedAt,proto3" json:"joined_at,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -533,7 +533,7 @@ type ProjectServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Project is the project. Project *Project `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` - // ProjectMembers in this project, projects guests will only see direct project members and not implicit memberships from tenant permissions + // ProjectMembers in this project, projects guests will only see direct project members and not implicit memberships from tenant permissions. ProjectMembers []*ProjectMember `protobuf:"bytes,2,rep,name=project_members,json=projectMembers,proto3" json:"project_members,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -587,15 +587,15 @@ func (x *ProjectServiceGetResponse) GetProjectMembers() []*ProjectMember { type ProjectServiceCreateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Login is the tenant of this project. - // TODO: is login really a good name? + // TODO: is login really a good name?. Login string `protobuf:"bytes,1,opt,name=login,proto3" json:"login,omitempty"` - // Name of this project, unique per tenant + // Name of this project, unique per tenant. Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` - // Description of this project + // Description of this project. Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"` - // Avatar URL of the project + // Avatar URL of the project. AvatarUrl *string `protobuf:"bytes,4,opt,name=avatar_url,json=avatarUrl,proto3,oneof" json:"avatar_url,omitempty"` - // Labels on the project + // Labels on the project. Labels *Labels `protobuf:"bytes,5,opt,name=labels,proto3" json:"labels,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -811,13 +811,13 @@ type ProjectServiceUpdateRequest struct { Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` // UpdateMeta contains the timestamp and strategy to be used in this update request. UpdateMeta *UpdateMeta `protobuf:"bytes,2,opt,name=update_meta,json=updateMeta,proto3" json:"update_meta,omitempty"` - // Name of this project unique per tenant + // Name of this project unique per tenant. Name *string `protobuf:"bytes,3,opt,name=name,proto3,oneof" json:"name,omitempty"` - // Description of this project + // Description of this project. Description *string `protobuf:"bytes,4,opt,name=description,proto3,oneof" json:"description,omitempty"` - // Avatar URL of the project + // Avatar URL of the project. AvatarUrl *string `protobuf:"bytes,5,opt,name=avatar_url,json=avatarUrl,proto3,oneof" json:"avatar_url,omitempty"` - // Labels on this project + // Labels on this project. Labels *UpdateLabels `protobuf:"bytes,6,opt,name=labels,proto3,oneof" json:"labels,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -946,7 +946,7 @@ type ProjectServiceInviteRequest struct { state protoimpl.MessageState `protogen:"open.v1"` // Project is the uuid of the project. Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` - // Role of this user in this project + // Role of this user in this project. Role ProjectRole `protobuf:"varint,2,opt,name=role,proto3,enum=metalstack.api.v2.ProjectRole" json:"role,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1000,8 +1000,8 @@ func (x *ProjectServiceInviteRequest) GetRole() ProjectRole { type ProjectServiceInviteResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Inviter contains a secret which can be sent to a potential user. - // can be appended to the invitation endpoint at our cloud console like - // console.metalstack.cloud/invite/ + // can be appended to the invitation endpoint at our cloud console like. + // console.metalstack.cloud/invite/= 20.04.20211011" -// debian: ">= 10.0.20210101" +// ubuntu: ">= 20.04.20211011 +// debian: ">= 10.0.20210101 type ImageConstraint struct { state protoimpl.MessageState `protogen:"open.v1"` - // Image of the constraint + // Image of the constraint. Image string `protobuf:"bytes,1,opt,name=image,proto3" json:"image,omitempty"` - // SemverMatch which defines in semver match format which image version should apply + // SemverMatch which defines in semver match format which image version should apply. SemverMatch string `protobuf:"bytes,2,opt,name=semver_match,json=semverMatch,proto3" json:"semver_match,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -265,11 +264,11 @@ func (x *ImageConstraint) GetSemverMatch() string { // SizeImageConstraintQuery is used to search size image constraints. type SizeImageConstraintQuery struct { state protoimpl.MessageState `protogen:"open.v1"` - // Size of the size image constraint + // Size of the size image constraint. Size *string `protobuf:"bytes,1,opt,name=size,proto3,oneof" json:"size,omitempty"` - // Name of the size image constraint to query + // Name of the size image constraint to query. Name *string `protobuf:"bytes,2,opt,name=name,proto3,oneof" json:"name,omitempty"` - // Description of the size image constraint to query + // Description of the size image constraint to query. Description *string `protobuf:"bytes,3,opt,name=description,proto3,oneof" json:"description,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/api/v2/size_reservation.pb.go b/go/metalstack/api/v2/size_reservation.pb.go index ad01b759..ee5aac30 100644 --- a/go/metalstack/api/v2/size_reservation.pb.go +++ b/go/metalstack/api/v2/size_reservation.pb.go @@ -25,9 +25,9 @@ const ( // SizeReservationServiceGetRequest is the request payload for a size get request. type SizeReservationServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // ID of the size reservation to get + // ID of the size reservation to get. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` - // Project of the size reservation + // Project of the size reservation. Project string `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -80,7 +80,7 @@ func (x *SizeReservationServiceGetRequest) GetProject() string { // SizeReservationServiceListRequest is the request payload for a size list request. type SizeReservationServiceListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Project of the size reservation + // Project of the size reservation. Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` // Query for size reservations. Query *SizeReservationQuery `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"` @@ -135,7 +135,7 @@ func (x *SizeReservationServiceListRequest) GetQuery() *SizeReservationQuery { // SizeReservationServiceGetResponse is the response payload for a size reservation get request. type SizeReservationServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Size reservation + // Size reservation. SizeReservation *SizeReservation `protobuf:"bytes,1,opt,name=size_reservation,json=sizeReservation,proto3" json:"size_reservation,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -181,7 +181,7 @@ func (x *SizeReservationServiceGetResponse) GetSizeReservation() *SizeReservatio // SizeReservationServiceListResponse is the response payload for a size reservation list request. type SizeReservationServiceListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Size reservations + // Size reservations. SizeReservations []*SizeReservation `protobuf:"bytes,1,rep,name=size_reservations,json=sizeReservations,proto3" json:"size_reservations,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -224,24 +224,24 @@ func (x *SizeReservationServiceListResponse) GetSizeReservations() []*SizeReserv return nil } -// SizeReservation +// SizeReservation. type SizeReservation struct { state protoimpl.MessageState `protogen:"open.v1"` - // Id of this size reservation, is generated on creation + // Id of this size reservation, is generated on creation. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` - // Meta for this size reservation + // Meta for this size reservation. Meta *Meta `protobuf:"bytes,2,opt,name=meta,proto3" json:"meta,omitempty"` - // Name of this size reservation + // Name of this size reservation. Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"` - // Description of this size reservation + // Description of this size reservation. Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"` - // Project of the size reservation + // Project of the size reservation. Project string `protobuf:"bytes,5,opt,name=project,proto3" json:"project,omitempty"` - // Size id of this size reservation + // Size id of this size reservation. Size string `protobuf:"bytes,6,opt,name=size,proto3" json:"size,omitempty"` - // Partition ids of this size reservation + // Partition ids of this size reservation. Partitions []string `protobuf:"bytes,7,rep,name=partitions,proto3" json:"partitions,omitempty"` - // Amount of reservations of this size reservation + // Amount of reservations of this size reservation. Amount int32 `protobuf:"varint,8,opt,name=amount,proto3" json:"amount,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -336,17 +336,17 @@ func (x *SizeReservation) GetAmount() int32 { // SizeReservationQuery is used to search size reservations. type SizeReservationQuery struct { state protoimpl.MessageState `protogen:"open.v1"` - // ID of the size reservation to get + // ID of the size reservation to get. Id *string `protobuf:"bytes,1,opt,name=id,proto3,oneof" json:"id,omitempty"` - // Name of this size reservation + // Name of this size reservation. Name *string `protobuf:"bytes,2,opt,name=name,proto3,oneof" json:"name,omitempty"` - // Description of this size reservation + // Description of this size reservation. Description *string `protobuf:"bytes,3,opt,name=description,proto3,oneof" json:"description,omitempty"` - // Size id of this size reservation + // Size id of this size reservation. Size *string `protobuf:"bytes,4,opt,name=size,proto3,oneof" json:"size,omitempty"` - // Project of the size reservation + // Project of the size reservation. Project *string `protobuf:"bytes,5,opt,name=project,proto3,oneof" json:"project,omitempty"` - // Partition of the size reservation + // Partition of the size reservation. Partition *string `protobuf:"bytes,6,opt,name=partition,proto3,oneof" json:"partition,omitempty"` // Labels lists only size reservations containing the given labels. Labels *Labels `protobuf:"bytes,7,opt,name=labels,proto3,oneof" json:"labels,omitempty"` diff --git a/go/metalstack/api/v2/switch.pb.go b/go/metalstack/api/v2/switch.pb.go index 6587aebe..a7f2562f 100644 --- a/go/metalstack/api/v2/switch.pb.go +++ b/go/metalstack/api/v2/switch.pb.go @@ -495,13 +495,13 @@ func (x *SwitchOS) GetMetalCoreVersion() string { // SwitchNic represents a front panel port and its configuration. type SwitchNic struct { state protoimpl.MessageState `protogen:"open.v1"` - // Name of the switch port + // Name of the switch port. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` - // Identifier of the port + // Identifier of the port. Identifier string `protobuf:"bytes,2,opt,name=identifier,proto3" json:"identifier,omitempty"` - // MAC address of the port + // MAC address of the port. Mac string `protobuf:"bytes,3,opt,name=mac,proto3" json:"mac,omitempty"` - // VRF name if the port is bound in one + // VRF name if the port is bound in one. Vrf *string `protobuf:"bytes,4,opt,name=vrf,proto3,oneof" json:"vrf,omitempty"` // NicState describes the current state of the switch port. State *NicState `protobuf:"bytes,5,opt,name=state,proto3,oneof" json:"state,omitempty"` @@ -595,9 +595,9 @@ func (x *SwitchNic) GetBgpPortState() *SwitchBGPPortState { // BGPFilter can be used to restrict BGP based on CIDRs and VNIs. type BGPFilter struct { state protoimpl.MessageState `protogen:"open.v1"` - // CIDRs for which to allow BGP + // CIDRs for which to allow BGP. Cidrs []string `protobuf:"bytes,1,rep,name=cidrs,proto3" json:"cidrs,omitempty"` - // VNIs for which to allow BGP + // VNIs for which to allow BGP. Vnis []string `protobuf:"bytes,2,rep,name=vnis,proto3" json:"vnis,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/api/v2/tenant.pb.go b/go/metalstack/api/v2/tenant.pb.go index 2d170058..c4042a88 100644 --- a/go/metalstack/api/v2/tenant.pb.go +++ b/go/metalstack/api/v2/tenant.pb.go @@ -26,19 +26,19 @@ const ( // Tenant is a customer of the platform. type Tenant struct { state protoimpl.MessageState `protogen:"open.v1"` - // Login of the tenant + // Login of the tenant. Login string `protobuf:"bytes,1,opt,name=login,proto3" json:"login,omitempty"` - // Meta for this tenant + // Meta for this tenant. Meta *Meta `protobuf:"bytes,2,opt,name=meta,proto3" json:"meta,omitempty"` - // Name of the tenant + // Name of the tenant. Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"` - // Email of the tenant + // Email of the tenant. Email string `protobuf:"bytes,4,opt,name=email,proto3" json:"email,omitempty"` - // Description of this tenant + // Description of this tenant. Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"` - // AvatarUrl of the tenant + // AvatarUrl of the tenant. AvatarUrl string `protobuf:"bytes,6,opt,name=avatar_url,json=avatarUrl,proto3" json:"avatar_url,omitempty"` - // CreatedBy stores who created this tenant + // CreatedBy stores who created this tenant. CreatedBy string `protobuf:"bytes,7,opt,name=created_by,json=createdBy,proto3" json:"created_by,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -130,11 +130,11 @@ type TenantMember struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // Role is the role of the member. Role TenantRole `protobuf:"varint,2,opt,name=role,proto3,enum=metalstack.api.v2.TenantRole" json:"role,omitempty"` - // Projects in which a user is a direct member + // Projects in which a user is a direct member. Projects []string `protobuf:"bytes,3,rep,name=projects,proto3" json:"projects,omitempty"` - // CreatedAt the date when the member was added to the tenant + // CreatedAt the date when the member was added to the tenant. CreatedAt *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"` - // Meta for this tenant member + // Meta for this tenant member. Meta *Meta `protobuf:"bytes,5,opt,name=meta,proto3" json:"meta,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -222,9 +222,9 @@ type TenantInvite struct { Tenant string `protobuf:"bytes,6,opt,name=tenant,proto3" json:"tenant,omitempty"` // TenantName is the name of the tenant inviting another user to join this tenant. TenantName string `protobuf:"bytes,7,opt,name=tenant_name,json=tenantName,proto3" json:"tenant_name,omitempty"` - // ExpiresAt the date when this invite expires + // ExpiresAt the date when this invite expires. ExpiresAt *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"` - // JoinedAt the date when the member accepted this invite + // JoinedAt the date when the member accepted this invite. JoinedAt *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=joined_at,json=joinedAt,proto3" json:"joined_at,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -445,7 +445,7 @@ func (x *TenantQuery) GetPaging() *Paging { // TenantServiceGetRequest is the request payload of the tenant get request. type TenantServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Login of the tenant + // Login of the tenant. Login string `protobuf:"bytes,1,opt,name=login,proto3" json:"login,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -491,15 +491,15 @@ func (x *TenantServiceGetRequest) GetLogin() string { // TenantServiceCreateRequest is the request payload of the tenant create request. type TenantServiceCreateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Name of this tenant + // Name of this tenant. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` - // Description of this tenant + // Description of this 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 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"` - // AvatarUrl of the tenant + // AvatarUrl of the tenant. AvatarUrl *string `protobuf:"bytes,4,opt,name=avatar_url,json=avatarUrl,proto3,oneof" json:"avatar_url,omitempty"` - // Labels on the tenant + // Labels on the tenant. Labels *Labels `protobuf:"bytes,5,opt,name=labels,proto3" json:"labels,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -573,19 +573,19 @@ func (x *TenantServiceCreateRequest) GetLabels() *Labels { // TenantServiceUpdateRequest is the request payload of the tenant update request. type TenantServiceUpdateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Login of the tenant + // Login of the tenant. Login string `protobuf:"bytes,1,opt,name=login,proto3" json:"login,omitempty"` // UpdateMeta contains the timestamp and strategy to be used in this update request. UpdateMeta *UpdateMeta `protobuf:"bytes,2,opt,name=update_meta,json=updateMeta,proto3" json:"update_meta,omitempty"` - // Name of the tenant + // Name of the tenant. Name *string `protobuf:"bytes,3,opt,name=name,proto3,oneof" json:"name,omitempty"` - // Email of the tenant + // Email of the tenant. Email *string `protobuf:"bytes,4,opt,name=email,proto3,oneof" json:"email,omitempty"` - // Description of this tenant + // Description of this tenant. Description *string `protobuf:"bytes,5,opt,name=description,proto3,oneof" json:"description,omitempty"` - // AvatarUrl of the tenant + // AvatarUrl of the tenant. AvatarUrl *string `protobuf:"bytes,6,opt,name=avatar_url,json=avatarUrl,proto3,oneof" json:"avatar_url,omitempty"` - // Labels on the tenant + // Labels on the tenant. Labels *UpdateLabels `protobuf:"bytes,7,opt,name=labels,proto3,oneof" json:"labels,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -673,7 +673,7 @@ func (x *TenantServiceUpdateRequest) GetLabels() *UpdateLabels { // TenantServiceDeleteRequest is the request payload of the tenant delete request. type TenantServiceDeleteRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Login of the tenant + // Login of the tenant. Login string `protobuf:"bytes,1,opt,name=login,proto3" json:"login,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -721,7 +721,7 @@ type TenantServiceGetResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Tenant is the tenant. Tenant *Tenant `protobuf:"bytes,1,opt,name=tenant,proto3" json:"tenant,omitempty"` - // TenantMembers of this tenant + // TenantMembers of this tenant. TenantMembers []*TenantMember `protobuf:"bytes,2,rep,name=tenant_members,json=tenantMembers,proto3" json:"tenant_members,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -958,9 +958,9 @@ func (x *TenantServiceDeleteResponse) GetTenant() *Tenant { // TenantServiceInviteRequest is used to invite a member to a tenant. type TenantServiceInviteRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Login of the tenant + // Login of the tenant. Login string `protobuf:"bytes,1,opt,name=login,proto3" json:"login,omitempty"` - // Role of this user in this tenant + // Role of this user in this tenant. Role TenantRole `protobuf:"varint,2,opt,name=role,proto3,enum=metalstack.api.v2.TenantRole" json:"role,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1014,8 +1014,6 @@ func (x *TenantServiceInviteRequest) GetRole() TenantRole { type TenantServiceInviteResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Invite contains a secret which can be sent to a potential user. - // can be appended to the invitation endpoint at our cloud console like - // console.metalstack.cloud/invite/ Invite *TenantInvite `protobuf:"bytes,1,opt,name=invite,proto3" json:"invite,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1061,7 +1059,7 @@ func (x *TenantServiceInviteResponse) GetInvite() *TenantInvite { // TenantServiceInvitesListRequest is the request payload to a list invites request. type TenantServiceInvitesListRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Login of the tenant + // Login of the tenant. Login string `protobuf:"bytes,1,opt,name=login,proto3" json:"login,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1107,7 +1105,7 @@ func (x *TenantServiceInvitesListRequest) GetLogin() string { // TenantServiceInvitesListResponse is the response payload to a list invites request. type TenantServiceInvitesListResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Invites that have not yet accepted the invitation to this tenant + // Invites that have not yet accepted the invitation to this tenant. Invites []*TenantInvite `protobuf:"bytes,1,rep,name=invites,proto3" json:"invites,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1153,7 +1151,7 @@ func (x *TenantServiceInvitesListResponse) GetInvites() []*TenantInvite { // TenantServiceInviteGetRequest is the request payload to get a invite. type TenantServiceInviteGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Secret of the invite to get + // Secret of the invite to get. Secret string `protobuf:"bytes,1,opt,name=secret,proto3" json:"secret,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1245,7 +1243,7 @@ func (x *TenantServiceInviteGetResponse) GetInvite() *TenantInvite { // TenantServiceRemoveMemberRequest is used to remove a member from a tenant. type TenantServiceRemoveMemberRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Login of the tenant + // Login of the tenant. Login string `protobuf:"bytes,1,opt,name=login,proto3" json:"login,omitempty"` // Member is the id of the member to remove from this tenant. Member string `protobuf:"bytes,2,opt,name=member,proto3" json:"member,omitempty"` @@ -1300,7 +1298,7 @@ func (x *TenantServiceRemoveMemberRequest) GetMember() string { // TenantServiceLeaveTenantRequest is used to leave a tenant. type TenantServiceLeaveRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Login of the tenant + // Login of the tenant. Login string `protobuf:"bytes,1,opt,name=login,proto3" json:"login,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1475,9 +1473,9 @@ func (x *TenantServiceInviteAcceptRequest) GetSecret() string { // TenantServiceInviteAcceptResponse is the response payload to a accept invite request. type TenantServiceInviteAcceptResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Tenant ID of the joined tenant + // Tenant ID of the joined tenant. Tenant string `protobuf:"bytes,1,opt,name=tenant,proto3" json:"tenant,omitempty"` - // TenantName of the joined tenant + // TenantName of the joined tenant. TenantName string `protobuf:"bytes,2,opt,name=tenant_name,json=tenantName,proto3" json:"tenant_name,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1530,9 +1528,9 @@ func (x *TenantServiceInviteAcceptResponse) GetTenantName() string { // TenantServiceInviteDeleteRequest is the request payload to a delete invite. type TenantServiceInviteDeleteRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Login of the tenant + // Login of the tenant. Login string `protobuf:"bytes,1,opt,name=login,proto3" json:"login,omitempty"` - // Secret of the invite to delete + // Secret of the invite to delete. Secret string `protobuf:"bytes,2,opt,name=secret,proto3" json:"secret,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1622,11 +1620,11 @@ func (*TenantServiceInviteDeleteResponse) Descriptor() ([]byte, []int) { // TenantServiceAddMemberRequest is the request payload for adding a member to a tenant. type TenantServiceAddMemberRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Login of the tenant to which the member will be added + // Login of the tenant to which the member will be added. Login string `protobuf:"bytes,1,opt,name=login,proto3" json:"login,omitempty"` - // Login of the member to add + // Login of the member to add. Member string `protobuf:"bytes,2,opt,name=member,proto3" json:"member,omitempty"` - // Role to assign to the new member + // Role to assign to the new member. Role TenantRole `protobuf:"varint,3,opt,name=role,proto3,enum=metalstack.api.v2.TenantRole" json:"role,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1732,11 +1730,11 @@ func (x *TenantServiceAddMemberResponse) GetTenantMember() *TenantMember { // TenantServiceUpdateMemberRequest is used to update a member from a tenant. type TenantServiceUpdateMemberRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Login of the tenant + // Login of the tenant. Login string `protobuf:"bytes,1,opt,name=login,proto3" json:"login,omitempty"` // Member is the id of the member to update in this tenant. Member string `protobuf:"bytes,2,opt,name=member,proto3" json:"member,omitempty"` - // Role of this user in this tenant + // Role of this user in this tenant. Role TenantRole `protobuf:"varint,3,opt,name=role,proto3,enum=metalstack.api.v2.TenantRole" json:"role,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/api/v2/token.pb.go b/go/metalstack/api/v2/token.pb.go index d72c07cb..e27ada89 100644 --- a/go/metalstack/api/v2/token.pb.go +++ b/go/metalstack/api/v2/token.pb.go @@ -91,11 +91,11 @@ func (TokenType) EnumDescriptor() ([]byte, []int) { // In contrast to a user token, the api token permissions and roles apply as configured during the token create process. type Token struct { state protoimpl.MessageState `protogen:"open.v1"` - // Uuid of the jwt token, used to reference it by revoke + // Uuid of the jwt token, used to reference it by revoke. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` - // User who created this token + // User who created this token. User string `protobuf:"bytes,2,opt,name=user,proto3" json:"user,omitempty"` - // Meta for this token + // Meta for this token. Meta *Meta `protobuf:"bytes,3,opt,name=meta,proto3" json:"meta,omitempty"` // Description is a user given description of this token. Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"` @@ -246,7 +246,7 @@ func (x *Token) GetMachineRoles() map[string]MachineRole { // TokenServiceCreateRequest is the request payload to create a token. type TokenServiceCreateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Description of the token + // Description of the token. Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"` // Permissions is a list of service methods this token can be used for. Permissions []*PermissionsByVisibility `protobuf:"bytes,2,rep,name=permissions,proto3" json:"permissions,omitempty"` @@ -262,7 +262,7 @@ type TokenServiceCreateRequest struct { InfraRole *InfraRole `protobuf:"varint,7,opt,name=infra_role,json=infraRole,proto3,enum=metalstack.api.v2.InfraRole,oneof" json:"infra_role,omitempty"` // MachineRoles associates a machine uuid with the corresponding role of the token owner. MachineRoles map[string]MachineRole `protobuf:"bytes,8,rep,name=machine_roles,json=machineRoles,proto3" json:"machine_roles,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"varint,2,opt,name=value,enum=metalstack.api.v2.MachineRole"` - // Labels on this token + // Labels on this token. Labels *Labels `protobuf:"bytes,9,opt,name=labels,proto3" json:"labels,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -364,14 +364,13 @@ func (x *TokenServiceCreateRequest) GetLabels() *Labels { // MethodPermission is a mapping from a subject/project to a service method. type MethodPermission struct { state protoimpl.MessageState `protogen:"open.v1"` - // Subject maybe either the project or the tenant - // for which the methods should be allowed + // Subject may be either the project or the tenant for which the methods should be allowed. // - // asterisk (*) can be specified to match any subject - // empty string ("") can be specified for requests that do not require a subject, e.g. partition list - // otherwise either a projectid or a tenant login should be specified + // Asterisk (*) can be specified to match any subject. + // Empty string ("") can be specified for requests that do not require a subject, e.g. partition list. + // Otherwise either a projectid or a tenant login should be specified. Subject string `protobuf:"bytes,1,opt,name=subject,proto3" json:"subject,omitempty"` - // Methods which should be accessible + // Methods which should be accessible. Methods []string `protobuf:"bytes,2,rep,name=methods,proto3" json:"methods,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -596,7 +595,7 @@ func (*PermissionsByVisibility_Infra) isPermissionsByVisibility_Visibility() {} // PublicPermissions carries public method permissions. type PublicPermissions struct { state protoimpl.MessageState `protogen:"open.v1"` - // Methods which should be accessible + // Methods which should be accessible. Methods []string `protobuf:"bytes,2,rep,name=methods,proto3" json:"methods,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -642,7 +641,7 @@ func (x *PublicPermissions) GetMethods() []string { // SelfPermissions carries self method permissions. type SelfPermissions struct { state protoimpl.MessageState `protogen:"open.v1"` - // Methods which should be accessible + // Methods which should be accessible. Methods []string `protobuf:"bytes,2,rep,name=methods,proto3" json:"methods,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -688,9 +687,10 @@ func (x *SelfPermissions) GetMethods() []string { // ProjectPermissions carries project method permissions. type ProjectPermissions struct { state protoimpl.MessageState `protogen:"open.v1"` - // asterisk (*) can be specified to match any subject + // Project scope for the permissions. + // Asterisk (*) can be specified to match any subject. Project string `protobuf:"bytes,1,opt,name=project,proto3" json:"project,omitempty"` - // Methods which should be accessible + // Methods which should be accessible. Methods []string `protobuf:"bytes,2,rep,name=methods,proto3" json:"methods,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -743,10 +743,10 @@ func (x *ProjectPermissions) GetMethods() []string { // TenantPermissions carries tenant method permissions. type TenantPermissions struct { state protoimpl.MessageState `protogen:"open.v1"` - // Login of the tenant - // asterisk (*) can be specified to match any subject + // Login of the tenant. + // Asterisk (*) can be specified to match any subject. Login string `protobuf:"bytes,1,opt,name=login,proto3" json:"login,omitempty"` - // Methods which should be accessible + // Methods which should be accessible. Methods []string `protobuf:"bytes,2,rep,name=methods,proto3" json:"methods,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -799,7 +799,7 @@ func (x *TenantPermissions) GetMethods() []string { // AdminPermissions carries admin method permissions. type AdminPermissions struct { state protoimpl.MessageState `protogen:"open.v1"` - // Methods which should be accessible + // Methods which should be accessible. Methods []string `protobuf:"bytes,2,rep,name=methods,proto3" json:"methods,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -845,10 +845,10 @@ func (x *AdminPermissions) GetMethods() []string { // MachinePermissions carries machine method permissions. type MachinePermissions struct { state protoimpl.MessageState `protogen:"open.v1"` - // UUID of this machine - // asterisk (*) can be specified to match any subject + // UUID of this machine. + // Asterisk (*) can be specified to match any subject. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` - // Methods which should be accessible + // Methods which should be accessible. Methods []string `protobuf:"bytes,2,rep,name=methods,proto3" json:"methods,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -901,7 +901,7 @@ func (x *MachinePermissions) GetMethods() []string { // InfraPermissions carries infra method permissions. type InfraPermissions struct { state protoimpl.MessageState `protogen:"open.v1"` - // Methods which should be accessible + // Methods which should be accessible. Methods []string `protobuf:"bytes,2,rep,name=methods,proto3" json:"methods,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -947,7 +947,7 @@ func (x *InfraPermissions) GetMethods() []string { // TokenServiceCreateResponse is the response payload of a token create request. type TokenServiceCreateResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Token which was created + // Token which was created. Token *Token `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"` // Secret is the body of the JWT token, should be used in API requests as bearer token. Secret string `protobuf:"bytes,2,opt,name=secret,proto3" json:"secret,omitempty"` @@ -1094,7 +1094,7 @@ func (x *TokenServiceListResponse) GetTokens() []*Token { // TokenServiceRevokeRequest is the request payload of a token revoke request. type TokenServiceRevokeRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Uuid of the token to revoke + // Uuid of the token to revoke. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1177,7 +1177,7 @@ func (*TokenServiceRevokeResponse) Descriptor() ([]byte, []int) { // TokenServiceUpdateRequest is the request payload of a token update request. type TokenServiceUpdateRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Uuid of the token to update + // Uuid of the token to update. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` // UpdateMeta contains the timestamp and strategy to be used in this update request. // TokenUpdate is not guarded with optlock in the backend. @@ -1196,7 +1196,7 @@ type TokenServiceUpdateRequest struct { InfraRole *InfraRole `protobuf:"varint,8,opt,name=infra_role,json=infraRole,proto3,enum=metalstack.api.v2.InfraRole,oneof" json:"infra_role,omitempty"` // MachineRoles associates a machine uuid with the corresponding role of the token owner. MachineRoles map[string]MachineRole `protobuf:"bytes,9,rep,name=machine_roles,json=machineRoles,proto3" json:"machine_roles,omitempty" protobuf_key:"bytes,1,opt,name=key" protobuf_val:"varint,2,opt,name=value,enum=metalstack.api.v2.MachineRole"` - // Labels on this token + // Labels on this token. Labels *UpdateLabels `protobuf:"bytes,10,opt,name=labels,proto3" json:"labels,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1351,7 +1351,7 @@ func (x *TokenServiceUpdateResponse) GetToken() *Token { // TokenServiceGetRequest is the request payload of a token get request. type TokenServiceGetRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Uuid of the token to get + // Uuid of the token to get. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -1442,7 +1442,7 @@ func (x *TokenServiceGetResponse) GetToken() *Token { // TokenServiceRefreshRequest is the request payload of a token refresh request. // Permissions, Roles and Expiration duration and all other properties are inherited from the calling token. -// The expiration duration will be calculated from the existing token (exp - iat) +// The expiration duration will be calculated from the existing token (exp - iat). type TokenServiceRefreshRequest struct { state protoimpl.MessageState `protogen:"open.v1"` unknownFields protoimpl.UnknownFields @@ -1482,7 +1482,7 @@ func (*TokenServiceRefreshRequest) Descriptor() ([]byte, []int) { // TokenServiceRefreshResponse is the response payload of a token refresh request. type TokenServiceRefreshResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // Token which was refreshed + // Token which was refreshed. Token *Token `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"` // Secret is the body of the JWT token, should be used in API requests as bearer token. Secret string `protobuf:"bytes,2,opt,name=secret,proto3" json:"secret,omitempty"` @@ -1537,16 +1537,16 @@ func (x *TokenServiceRefreshResponse) GetSecret() string { // TokenQuery is used to search tokens. type TokenQuery struct { state protoimpl.MessageState `protogen:"open.v1"` - // UUID of the token to get + // UUID of the token to get. Uuid *string `protobuf:"bytes,1,opt,name=uuid,proto3,oneof" json:"uuid,omitempty"` - // Name of the token user to query + // Name of the token user to query. // Only useful for admins. User *string `protobuf:"bytes,2,opt,name=user,proto3,oneof" json:"user,omitempty"` - // Description of the token to query + // Description of the token to query. Description *string `protobuf:"bytes,3,opt,name=description,proto3,oneof" json:"description,omitempty"` // Labels lists only tokens containing the given labels. Labels *Labels `protobuf:"bytes,4,opt,name=labels,proto3,oneof" json:"labels,omitempty"` - // Token type of the token to query + // Token type of the token to query. TokenType *TokenType `protobuf:"varint,5,opt,name=token_type,json=tokenType,proto3,enum=metalstack.api.v2.TokenType,oneof" json:"token_type,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/api/v2/user.pb.go b/go/metalstack/api/v2/user.pb.go index f4b057ad..700263f4 100644 --- a/go/metalstack/api/v2/user.pb.go +++ b/go/metalstack/api/v2/user.pb.go @@ -27,17 +27,17 @@ type User struct { state protoimpl.MessageState `protogen:"open.v1"` // Login is the login at the provider. Login string `protobuf:"bytes,1,opt,name=login,proto3" json:"login,omitempty"` - // Name of the user + // Name of the user. Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` - // Email of the user + // Email of the user. Email string `protobuf:"bytes,3,opt,name=email,proto3" json:"email,omitempty"` - // AvatarUrl of the user + // AvatarUrl of the user. AvatarUrl string `protobuf:"bytes,4,opt,name=avatar_url,json=avatarUrl,proto3" json:"avatar_url,omitempty"` - // Tenants the user belongs to + // Tenants the user belongs to. Tenants []*Tenant `protobuf:"bytes,5,rep,name=tenants,proto3" json:"tenants,omitempty"` - // Projects the user belongs to + // Projects the user belongs to. Projects []*Project `protobuf:"bytes,6,rep,name=projects,proto3" json:"projects,omitempty"` - // DefaultTenant the default tenant that this user belongs to + // DefaultTenant the default tenant that this user belongs to. DefaultTenant *Tenant `protobuf:"bytes,7,opt,name=default_tenant,json=defaultTenant,proto3" json:"default_tenant,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/api/v2/version.pb.go b/go/metalstack/api/v2/version.pb.go index b3481dbb..c2f64d8b 100644 --- a/go/metalstack/api/v2/version.pb.go +++ b/go/metalstack/api/v2/version.pb.go @@ -25,13 +25,13 @@ const ( // Version represents the version of the application. type Version struct { state protoimpl.MessageState `protogen:"open.v1"` - // Version of the application + // Version of the application. Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"` - // Revision of the application + // Revision of the application. Revision string `protobuf:"bytes,2,opt,name=revision,proto3" json:"revision,omitempty"` - // GitSHA1 of the application + // GitSHA1 of the application. GitSha1 string `protobuf:"bytes,3,opt,name=git_sha1,json=gitSha1,proto3" json:"git_sha1,omitempty"` - // BuildDate of the application + // BuildDate of the application. BuildDate string `protobuf:"bytes,4,opt,name=build_date,json=buildDate,proto3" json:"build_date,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 f4802eb9..0428ff88 100644 --- a/go/metalstack/api/v2/vpn.pb.go +++ b/go/metalstack/api/v2/vpn.pb.go @@ -26,15 +26,15 @@ const ( // 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 of this node. Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` - // Project of this node, maps to a project + // 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 to 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 bf3be9cf..d05c3d00 100644 --- a/go/metalstack/infra/v2/bmc.pb.go +++ b/go/metalstack/infra/v2/bmc.pb.go @@ -182,9 +182,9 @@ func (x *WaitForBMCCommandRequest) GetPartition() string { // 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 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 BMC command to. MachineBmc *v2.MachineBMC `protobuf:"bytes,3,opt,name=machine_bmc,json=machineBmc,proto3" json:"machine_bmc,omitempty"` @@ -259,7 +259,7 @@ type BMCCommandDoneRequest struct { // CommandId is a unique ID which must be sent back after execution. // 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 of the command execution, nil if it was successful. Error *string `protobuf:"bytes,2,opt,name=error,proto3,oneof" json:"error,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/infra/v2/boot.pb.go b/go/metalstack/infra/v2/boot.pb.go index 2295c47d..0f20aa42 100644 --- a/go/metalstack/infra/v2/boot.pb.go +++ b/go/metalstack/infra/v2/boot.pb.go @@ -26,7 +26,7 @@ const ( // BootServiceDhcpRequest is called once a machine issues a dhcp request. type BootServiceDhcpRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // UUID of the machine + // UUID of the machine. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` // Partition where this machine is located. Partition string `protobuf:"bytes,2,opt,name=partition,proto3" json:"partition,omitempty"` @@ -118,7 +118,7 @@ func (*BootServiceDhcpResponse) Descriptor() ([]byte, []int) { // BootServiceBootRequest is called to get specified parameters to boot a machine with the given mac. type BootServiceBootRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // Mac address of the machine + // Mac address of the machine. Mac string `protobuf:"bytes,1,opt,name=mac,proto3" json:"mac,omitempty"` // Partition where this machine is located. Partition string `protobuf:"bytes,2,opt,name=partition,proto3" json:"partition,omitempty"` @@ -237,17 +237,17 @@ func (x *BootServiceBootResponse) GetCmdline() string { // BootServiceRegisterRequest is called from metal-hammer to register a machine with as much hardware details as possible. type BootServiceRegisterRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // UUID of this machine + // UUID of this machine. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` - // Hardware details of this machine + // Hardware details of this machine. Hardware *v2.MachineHardware `protobuf:"bytes,2,opt,name=hardware,proto3" json:"hardware,omitempty"` - // Bios details of this machine + // Bios details of this machine. Bios *v2.MachineBios `protobuf:"bytes,3,opt,name=bios,proto3" json:"bios,omitempty"` - // BMC details of this machine + // BMC details of this machine. Bmc *v2.MachineBMC `protobuf:"bytes,4,opt,name=bmc,proto3" json:"bmc,omitempty"` - // FRU details of this machine + // FRU details of this machine. Fru *v2.MachineFRU `protobuf:"bytes,5,opt,name=fru,proto3" json:"fru,omitempty"` - // Tags of this machine + // Tags of this machine. Tags []string `protobuf:"bytes,6,rep,name=tags,proto3" json:"tags,omitempty"` // MetalHammer version this machine was booted into. MetalHammerVersion string `protobuf:"bytes,7,opt,name=metal_hammer_version,json=metalHammerVersion,proto3" json:"metal_hammer_version,omitempty"` @@ -343,14 +343,14 @@ func (x *BootServiceRegisterRequest) GetPartition() string { return "" } -// BootServiceRegisterResponse response to a BootServiceRegisterResponse request +// BootServiceRegisterResponse response to a BootServiceRegisterResponse request. type BootServiceRegisterResponse struct { state protoimpl.MessageState `protogen:"open.v1"` - // UUID of this machine + // UUID of this machine. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` // Size is the calculated size from given hardware details. Size string `protobuf:"bytes,2,opt,name=size,proto3" json:"size,omitempty"` - // Partition of this machine + // Partition of this machine. Partition string `protobuf:"bytes,3,opt,name=partition,proto3" json:"partition,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -410,7 +410,7 @@ func (x *BootServiceRegisterResponse) GetPartition() string { // BootServiceWaitRequest is called when a machine was registered and is waiting for allocation. type BootServiceWaitRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // UUID of this machine + // UUID of this machine. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -453,7 +453,7 @@ func (x *BootServiceWaitRequest) GetUuid() string { return "" } -// BootServiceWaitResponse response to a wait request +// BootServiceWaitResponse response to a wait request. type BootServiceWaitResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // Allocation contains the machine.allocation to actually install the machine. @@ -502,9 +502,9 @@ func (x *BootServiceWaitResponse) GetAllocation() *v2.MachineAllocation { // BootServiceInstallationSucceededRequest is sent from metal-hammer to the api to report the installation succeeded. type BootServiceInstallationSucceededRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // UUID of the machine to boot + // UUID of the machine to boot. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` - // ConsolePassword + // ConsolePassword. ConsolePassword string `protobuf:"bytes,2,opt,name=console_password,json=consolePassword,proto3" json:"console_password,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -591,10 +591,10 @@ func (*BootServiceInstallationSucceededResponse) Descriptor() ([]byte, []int) { return file_metalstack_infra_v2_boot_proto_rawDescGZIP(), []int{9} } -// BootServiceSuperUserPasswordRequest this call returns the password for the machine superuser +// BootServiceSuperUserPasswordRequest this call returns the password for the machine superuser. type BootServiceSuperUserPasswordRequest struct { state protoimpl.MessageState `protogen:"open.v1"` - // UUID of this machine + // UUID of this machine. Uuid string `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache @@ -637,7 +637,7 @@ func (x *BootServiceSuperUserPasswordRequest) GetUuid() string { return "" } -// BootServiceSuperUserPasswordResponse the super user password is returned +// BootServiceSuperUserPasswordResponse the super user password is returned. type BootServiceSuperUserPasswordResponse struct { state protoimpl.MessageState `protogen:"open.v1"` // FeatureDisabled on set the superuserpassword in the bmc if this feature is not disabled. diff --git a/go/metalstack/infra/v2/component.pb.go b/go/metalstack/infra/v2/component.pb.go index e84f8132..ed265348 100644 --- a/go/metalstack/infra/v2/component.pb.go +++ b/go/metalstack/infra/v2/component.pb.go @@ -34,9 +34,9 @@ type ComponentServicePingRequest struct { Identifier string `protobuf:"bytes,2,opt,name=identifier,proto3" json:"identifier,omitempty"` // 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 + // 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 of this service. Version *v2.Version `protobuf:"bytes,5,opt,name=version,proto3" json:"version,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache diff --git a/go/metalstack/infra/v2/event.pb.go b/go/metalstack/infra/v2/event.pb.go index bd1774b8..31df15b4 100644 --- a/go/metalstack/infra/v2/event.pb.go +++ b/go/metalstack/infra/v2/event.pb.go @@ -25,7 +25,7 @@ const ( // 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]*v2.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 @@ -71,7 +71,7 @@ func (x *EventServiceSendRequest) GetEvents() map[string]*v2.MachineProvisioning // 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 []string `protobuf:"bytes,2,rep,name=failed,proto3" json:"failed,omitempty"` diff --git a/go/metalstack/infra/v2/switch.pb.go b/go/metalstack/infra/v2/switch.pb.go index 802db807..47f0aa22 100644 --- a/go/metalstack/infra/v2/switch.pb.go +++ b/go/metalstack/infra/v2/switch.pb.go @@ -27,7 +27,7 @@ const ( // 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 @@ -119,7 +119,7 @@ func (x *SwitchServiceGetResponse) GetSwitch() *v2.Switch { // 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 @@ -211,11 +211,11 @@ func (x *SwitchServiceRegisterResponse) GetSwitch() *v2.Switch { // 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 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"` @@ -293,7 +293,7 @@ func (x *SwitchServiceHeartbeatRequest) GetBgpPortStates() map[string]*v2.Switch // 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 *v2.SwitchSync `protobuf:"bytes,2,opt,name=last_sync,json=lastSync,proto3" json:"last_sync,omitempty"` diff --git a/js/metalstack/admin/v2/audit_pb.d.ts b/js/metalstack/admin/v2/audit_pb.d.ts index 537c49b5..8fb5643e 100644 --- a/js/metalstack/admin/v2/audit_pb.d.ts +++ b/js/metalstack/admin/v2/audit_pb.d.ts @@ -48,7 +48,7 @@ export declare const AuditServiceListResponseSchema: GenMessage & { /** - * Uuid of the audit trace + * Uuid of the audit trace. * * @generated from field: string uuid = 1; */ diff --git a/js/metalstack/admin/v2/audit_pb.ts b/js/metalstack/admin/v2/audit_pb.ts index dd4b8fbb..87f384e6 100644 --- a/js/metalstack/admin/v2/audit_pb.ts +++ b/js/metalstack/admin/v2/audit_pb.ts @@ -65,7 +65,7 @@ export const AuditServiceListResponseSchema: GenMessage & { /** - * Uuid of the audit trace + * Uuid of the audit trace. * * @generated from field: string uuid = 1; */ diff --git a/js/metalstack/admin/v2/filesystem_pb.d.ts b/js/metalstack/admin/v2/filesystem_pb.d.ts index 504518f2..b7b1dbb9 100644 --- a/js/metalstack/admin/v2/filesystem_pb.d.ts +++ b/js/metalstack/admin/v2/filesystem_pb.d.ts @@ -49,7 +49,7 @@ export declare const FilesystemServiceCreateResponseSchema: GenMessage & { /** - * Id of this filesystemLayout + * Id of this filesystemLayout. * * @generated from field: string id = 1; */ @@ -61,13 +61,13 @@ export type FilesystemServiceUpdateRequest = Message<"metalstack.admin.v2.Filesy */ updateMeta?: UpdateMeta | undefined; /** - * Name of this filesystemLayout + * Name of this filesystemLayout. * * @generated from field: optional string name = 3; */ name?: string | undefined; /** - * Description of this filesystemLayout + * Description of this filesystemLayout. * * @generated from field: optional string description = 4; */ @@ -85,7 +85,7 @@ export type FilesystemServiceUpdateRequest = Message<"metalstack.admin.v2.Filesy */ disks: Disk[]; /** - * Raid arrays to create + * Raid arrays to create. * * @generated from field: repeated metalstack.api.v2.Raid raid = 7; */ @@ -103,7 +103,7 @@ export type FilesystemServiceUpdateRequest = Message<"metalstack.admin.v2.Filesy */ logicalVolumes: LogicalVolume[]; /** - * Constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts + * Constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts. * * @generated from field: metalstack.api.v2.FilesystemLayoutConstraints constraints = 10; */ @@ -139,7 +139,7 @@ export declare const FilesystemServiceUpdateResponseSchema: GenMessage & { /** - * ID of the filesystem to delete + * ID of the filesystem to delete. * * @generated from field: string id = 1; */ @@ -169,20 +169,20 @@ export type FilesystemServiceDeleteResponse = Message<"metalstack.admin.v2.Files */ export declare const FilesystemServiceDeleteResponseSchema: GenMessage; /** - * FilesystemServiceMatchRequest + * FilesystemServiceMatchRequest. * * @generated from message metalstack.admin.v2.FilesystemServiceMatchRequest */ export type FilesystemServiceMatchRequest = Message<"metalstack.admin.v2.FilesystemServiceMatchRequest"> & { /** * Match size and image to a filesystem layout. - * or match a machine to a filesystem layout + * or match a machine to a filesystem layout. * * @generated from oneof metalstack.admin.v2.FilesystemServiceMatchRequest.match */ match: { /** - * SizeAndImage + * SizeAndImage. * * @generated from field: metalstack.admin.v2.MatchImageAndSize size_and_image = 1; */ @@ -190,7 +190,7 @@ export type FilesystemServiceMatchRequest = Message<"metalstack.admin.v2.Filesys case: "sizeAndImage"; } | { /** - * MachineAndFilesystemlayout + * MachineAndFilesystemlayout. * * @generated from field: metalstack.admin.v2.MatchMachineAndFilesystemLayout machine_and_filesystemlayout = 2; */ @@ -207,19 +207,19 @@ export type FilesystemServiceMatchRequest = Message<"metalstack.admin.v2.Filesys */ export declare const FilesystemServiceMatchRequestSchema: GenMessage; /** - * MatchImageAndSize + * MatchImageAndSize. * * @generated from message metalstack.admin.v2.MatchImageAndSize */ export type MatchImageAndSize = Message<"metalstack.admin.v2.MatchImageAndSize"> & { /** - * Size, machine size to try + * Size, machine size to try. * * @generated from field: string size = 1; */ size: string; /** - * Image machine image to try + * Image machine image to try. * * @generated from field: string image = 2; */ @@ -231,19 +231,19 @@ export type MatchImageAndSize = Message<"metalstack.admin.v2.MatchImageAndSize"> */ export declare const MatchImageAndSizeSchema: GenMessage; /** - * MatchMachineAndFilesystemLayout + * MatchMachineAndFilesystemLayout. * * @generated from message metalstack.admin.v2.MatchMachineAndFilesystemLayout */ export type MatchMachineAndFilesystemLayout = Message<"metalstack.admin.v2.MatchMachineAndFilesystemLayout"> & { /** - * Machine to check + * Machine to check. * * @generated from field: string machine = 1; */ machine: string; /** - * FilesystemLayout to check + * FilesystemLayout to check. * * @generated from field: string filesystem_layout = 2; */ @@ -255,13 +255,13 @@ export type MatchMachineAndFilesystemLayout = Message<"metalstack.admin.v2.Match */ export declare const MatchMachineAndFilesystemLayoutSchema: GenMessage; /** - * FilesystemServiceMatchResponse + * FilesystemServiceMatchResponse. * * @generated from message metalstack.admin.v2.FilesystemServiceMatchResponse */ export type FilesystemServiceMatchResponse = Message<"metalstack.admin.v2.FilesystemServiceMatchResponse"> & { /** - * FilesystemLayout the filesystemlayout + * FilesystemLayout the filesystemlayout. * * @generated from field: metalstack.api.v2.FilesystemLayout filesystem_layout = 1; */ diff --git a/js/metalstack/admin/v2/filesystem_pb.ts b/js/metalstack/admin/v2/filesystem_pb.ts index 35778380..31dd6eef 100644 --- a/js/metalstack/admin/v2/filesystem_pb.ts +++ b/js/metalstack/admin/v2/filesystem_pb.ts @@ -67,7 +67,7 @@ export const FilesystemServiceCreateResponseSchema: GenMessage & { /** - * Id of this filesystemLayout + * Id of this filesystemLayout. * * @generated from field: string id = 1; */ @@ -81,14 +81,14 @@ export type FilesystemServiceUpdateRequest = Message<"metalstack.admin.v2.Filesy updateMeta?: UpdateMeta | undefined; /** - * Name of this filesystemLayout + * Name of this filesystemLayout. * * @generated from field: optional string name = 3; */ name?: string | undefined; /** - * Description of this filesystemLayout + * Description of this filesystemLayout. * * @generated from field: optional string description = 4; */ @@ -109,7 +109,7 @@ export type FilesystemServiceUpdateRequest = Message<"metalstack.admin.v2.Filesy disks: Disk[]; /** - * Raid arrays to create + * Raid arrays to create. * * @generated from field: repeated metalstack.api.v2.Raid raid = 7; */ @@ -130,7 +130,7 @@ export type FilesystemServiceUpdateRequest = Message<"metalstack.admin.v2.Filesy logicalVolumes: LogicalVolume[]; /** - * Constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts + * Constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts. * * @generated from field: metalstack.api.v2.FilesystemLayoutConstraints constraints = 10; */ @@ -172,7 +172,7 @@ export const FilesystemServiceUpdateResponseSchema: GenMessage & { /** - * ID of the filesystem to delete + * ID of the filesystem to delete. * * @generated from field: string id = 1; */ @@ -208,20 +208,20 @@ export const FilesystemServiceDeleteResponseSchema: GenMessage & { /** * Match size and image to a filesystem layout. - * or match a machine to a filesystem layout + * or match a machine to a filesystem layout. * * @generated from oneof metalstack.admin.v2.FilesystemServiceMatchRequest.match */ match: { /** - * SizeAndImage + * SizeAndImage. * * @generated from field: metalstack.admin.v2.MatchImageAndSize size_and_image = 1; */ @@ -229,7 +229,7 @@ export type FilesystemServiceMatchRequest = Message<"metalstack.admin.v2.Filesys case: "sizeAndImage"; } | { /** - * MachineAndFilesystemlayout + * MachineAndFilesystemlayout. * * @generated from field: metalstack.admin.v2.MatchMachineAndFilesystemLayout machine_and_filesystemlayout = 2; */ @@ -246,20 +246,20 @@ export const FilesystemServiceMatchRequestSchema: GenMessage & { /** - * Size, machine size to try + * Size, machine size to try. * * @generated from field: string size = 1; */ size: string; /** - * Image machine image to try + * Image machine image to try. * * @generated from field: string image = 2; */ @@ -274,20 +274,20 @@ export const MatchImageAndSizeSchema: GenMessage = /*@__PURE_ messageDesc(file_metalstack_admin_v2_filesystem, 7); /** - * MatchMachineAndFilesystemLayout + * MatchMachineAndFilesystemLayout. * * @generated from message metalstack.admin.v2.MatchMachineAndFilesystemLayout */ export type MatchMachineAndFilesystemLayout = Message<"metalstack.admin.v2.MatchMachineAndFilesystemLayout"> & { /** - * Machine to check + * Machine to check. * * @generated from field: string machine = 1; */ machine: string; /** - * FilesystemLayout to check + * FilesystemLayout to check. * * @generated from field: string filesystem_layout = 2; */ @@ -302,13 +302,13 @@ export const MatchMachineAndFilesystemLayoutSchema: GenMessage & { /** - * FilesystemLayout the filesystemlayout + * FilesystemLayout the filesystemlayout. * * @generated from field: metalstack.api.v2.FilesystemLayout filesystem_layout = 1; */ diff --git a/js/metalstack/admin/v2/image_pb.d.ts b/js/metalstack/admin/v2/image_pb.d.ts index f096eda3..8ff00972 100644 --- a/js/metalstack/admin/v2/image_pb.d.ts +++ b/js/metalstack/admin/v2/image_pb.d.ts @@ -50,7 +50,7 @@ export declare const ImageServiceCreateResponseSchema: GenMessage & { /** - * Id of this image + * Id of this image. * * @generated from field: string id = 1; */ @@ -62,31 +62,31 @@ export type ImageServiceUpdateRequest = Message<"metalstack.admin.v2.ImageServic */ updateMeta?: UpdateMeta | undefined; /** - * URL where this image is located + * URL where this image is located. * * @generated from field: optional string url = 3; */ url?: string | undefined; /** - * Name of this image + * Name of this image. * * @generated from field: optional string name = 4; */ name?: string | undefined; /** - * Description of this image + * Description of this image. * * @generated from field: optional string description = 5; */ description?: string | undefined; /** - * Features of this image + * Features of this image. * * @generated from field: repeated metalstack.api.v2.ImageFeature features = 6; */ features: ImageFeature[]; /** - * Classification of this image + * Classification of this image. * * @generated from field: metalstack.api.v2.ImageClassification classification = 7; */ @@ -98,7 +98,7 @@ export type ImageServiceUpdateRequest = Message<"metalstack.admin.v2.ImageServic */ expiresAt?: Timestamp | undefined; /** - * Labels to update on this image + * Labels to update on this image. * * @generated from field: optional metalstack.api.v2.UpdateLabels labels = 9; */ @@ -134,7 +134,7 @@ export declare const ImageServiceUpdateResponseSchema: GenMessage & { /** - * ID of the image to delete + * ID of the image to delete. * * @generated from field: string id = 1; */ diff --git a/js/metalstack/admin/v2/image_pb.ts b/js/metalstack/admin/v2/image_pb.ts index 884bf1ef..c0169876 100644 --- a/js/metalstack/admin/v2/image_pb.ts +++ b/js/metalstack/admin/v2/image_pb.ts @@ -69,7 +69,7 @@ export const ImageServiceCreateResponseSchema: GenMessage & { /** - * Id of this image + * Id of this image. * * @generated from field: string id = 1; */ @@ -83,35 +83,35 @@ export type ImageServiceUpdateRequest = Message<"metalstack.admin.v2.ImageServic updateMeta?: UpdateMeta | undefined; /** - * URL where this image is located + * URL where this image is located. * * @generated from field: optional string url = 3; */ url?: string | undefined; /** - * Name of this image + * Name of this image. * * @generated from field: optional string name = 4; */ name?: string | undefined; /** - * Description of this image + * Description of this image. * * @generated from field: optional string description = 5; */ description?: string | undefined; /** - * Features of this image + * Features of this image. * * @generated from field: repeated metalstack.api.v2.ImageFeature features = 6; */ features: ImageFeature[]; /** - * Classification of this image + * Classification of this image. * * @generated from field: metalstack.api.v2.ImageClassification classification = 7; */ @@ -125,7 +125,7 @@ export type ImageServiceUpdateRequest = Message<"metalstack.admin.v2.ImageServic expiresAt?: Timestamp | undefined; /** - * Labels to update on this image + * Labels to update on this image. * * @generated from field: optional metalstack.api.v2.UpdateLabels labels = 9; */ @@ -167,7 +167,7 @@ export const ImageServiceUpdateResponseSchema: GenMessage & { /** - * ID of the image to delete + * ID of the image to delete. * * @generated from field: string id = 1; */ diff --git a/js/metalstack/admin/v2/machine_pb.d.ts b/js/metalstack/admin/v2/machine_pb.d.ts index 44b3990f..b5ccfcb0 100644 --- a/js/metalstack/admin/v2/machine_pb.d.ts +++ b/js/metalstack/admin/v2/machine_pb.d.ts @@ -12,7 +12,7 @@ export declare const file_metalstack_admin_v2_machine: GenFile; */ export type MachineServiceGetRequest = Message<"metalstack.admin.v2.MachineServiceGetRequest"> & { /** - * UUID of the machine to get + * UUID of the machine to get. * * @generated from field: string uuid = 1; */ @@ -54,8 +54,8 @@ export type MachineServiceListRequest = Message<"metalstack.admin.v2.MachineServ */ query?: MachineQuery | undefined; /** - * Partition for which machines should be listed, could be left empty if only one partition is present - * otherwise an error is thrown that the partition must be specified + * Partition for which machines should be listed, could be left empty if only one partition is present. + * otherwise an error is thrown that the partition must be specified. * * @generated from field: optional string partition = 2; */ @@ -91,7 +91,7 @@ export declare const MachineServiceListResponseSchema: GenMessage & { /** - * UUID of the machine to permanently delete + * UUID of the machine to permanently delete. * * @generated from field: string uuid = 1; */ @@ -127,13 +127,13 @@ export declare const MachineServiceDeleteResponseSchema: GenMessage & { /** - * UUID of the machine to send the command to + * UUID of the machine to send the command to. * * @generated from field: string uuid = 1; */ uuid: string; /** - * Command to send to the bmc of the machine + * Command to send to the bmc of the machine. * * @generated from field: metalstack.api.v2.MachineBMCCommand command = 2; */ @@ -162,7 +162,7 @@ export declare const MachineServiceBMCCommandResponseSchema: GenMessage & { /** - * UUID of the machine to get + * UUID of the machine to get. * * @generated from field: string uuid = 1; */ @@ -180,7 +180,7 @@ export declare const MachineServiceGetBMCRequestSchema: GenMessage & { /** - * UUID of the machine + * UUID of the machine. * * @generated from field: string uuid = 1; */ @@ -242,7 +242,7 @@ export declare const MachineServiceListBMCResponseSchema: GenMessage & { /** - * UUID of the machine to get + * UUID of the machine to get. * * @generated from field: string uuid = 1; */ @@ -267,13 +267,13 @@ export declare const MachineServiceConsolePasswordRequestSchema: GenMessage & { /** - * UUID of the machine to get + * UUID of the machine to get. * * @generated from field: string uuid = 1; */ uuid: string; /** - * Password to access the console + * Password to access the console. * * @generated from field: string password = 2; */ @@ -291,7 +291,7 @@ export declare const MachineServiceConsolePasswordResponseSchema: GenMessage & { /** - * UUID of the machine to set the state to + * UUID of the machine to set the state to. * * @generated from field: string uuid = 1; */ @@ -304,7 +304,7 @@ export type MachineServiceSetStateRequest = Message<"metalstack.admin.v2.Machine */ state: MachineState; /** - * Description a description why this machine is in the given state + * Description a description why this machine is in the given state. * * @generated from field: string description = 3; */ diff --git a/js/metalstack/admin/v2/machine_pb.ts b/js/metalstack/admin/v2/machine_pb.ts index ac23e1bf..c8dcbcba 100644 --- a/js/metalstack/admin/v2/machine_pb.ts +++ b/js/metalstack/admin/v2/machine_pb.ts @@ -24,7 +24,7 @@ export const file_metalstack_admin_v2_machine: GenFile = /*@__PURE__*/ */ export type MachineServiceGetRequest = Message<"metalstack.admin.v2.MachineServiceGetRequest"> & { /** - * UUID of the machine to get + * UUID of the machine to get. * * @generated from field: string uuid = 1; */ @@ -73,8 +73,8 @@ export type MachineServiceListRequest = Message<"metalstack.admin.v2.MachineServ query?: MachineQuery | undefined; /** - * Partition for which machines should be listed, could be left empty if only one partition is present - * otherwise an error is thrown that the partition must be specified + * Partition for which machines should be listed, could be left empty if only one partition is present. + * otherwise an error is thrown that the partition must be specified. * * @generated from field: optional string partition = 2; */ @@ -116,7 +116,7 @@ export const MachineServiceListResponseSchema: GenMessage & { /** - * UUID of the machine to permanently delete + * UUID of the machine to permanently delete. * * @generated from field: string uuid = 1; */ @@ -158,14 +158,14 @@ export const MachineServiceDeleteResponseSchema: GenMessage & { /** - * UUID of the machine to send the command to + * UUID of the machine to send the command to. * * @generated from field: string uuid = 1; */ uuid: string; /** - * Command to send to the bmc of the machine + * Command to send to the bmc of the machine. * * @generated from field: metalstack.api.v2.MachineBMCCommand command = 2; */ @@ -201,7 +201,7 @@ export const MachineServiceBMCCommandResponseSchema: GenMessage & { /** - * UUID of the machine to get + * UUID of the machine to get. * * @generated from field: string uuid = 1; */ @@ -222,7 +222,7 @@ export const MachineServiceGetBMCRequestSchema: GenMessage & { /** - * UUID of the machine + * UUID of the machine. * * @generated from field: string uuid = 1; */ @@ -292,7 +292,7 @@ export const MachineServiceListBMCResponseSchema: GenMessage & { /** - * UUID of the machine to get + * UUID of the machine to get. * * @generated from field: string uuid = 1; */ @@ -321,14 +321,14 @@ export const MachineServiceConsolePasswordRequestSchema: GenMessage & { /** - * UUID of the machine to get + * UUID of the machine to get. * * @generated from field: string uuid = 1; */ uuid: string; /** - * Password to access the console + * Password to access the console. * * @generated from field: string password = 2; */ @@ -349,7 +349,7 @@ export const MachineServiceConsolePasswordResponseSchema: GenMessage & { /** - * UUID of the machine to set the state to + * UUID of the machine to set the state to. * * @generated from field: string uuid = 1; */ @@ -364,7 +364,7 @@ export type MachineServiceSetStateRequest = Message<"metalstack.admin.v2.Machine state: MachineState; /** - * Description a description why this machine is in the given state + * Description a description why this machine is in the given state. * * @generated from field: string description = 3; */ diff --git a/js/metalstack/admin/v2/network_pb.d.ts b/js/metalstack/admin/v2/network_pb.d.ts index 603d5dad..39031fbf 100644 --- a/js/metalstack/admin/v2/network_pb.d.ts +++ b/js/metalstack/admin/v2/network_pb.d.ts @@ -13,7 +13,7 @@ export declare const file_metalstack_admin_v2_network: GenFile; */ export type NetworkServiceGetRequest = Message<"metalstack.admin.v2.NetworkServiceGetRequest"> & { /** - * ID of the network to get + * ID of the network to get. * * @generated from field: string id = 1; */ @@ -49,19 +49,19 @@ export declare const NetworkServiceGetResponseSchema: GenMessage & { /** - * Id of this network + * Id of this network. * * @generated from field: optional string id = 1; */ id?: string | undefined; /** - * Name of this network + * Name of this network. * * @generated from field: optional string name = 2; */ name?: string | undefined; /** - * Description of this network + * Description of this network. * * @generated from field: optional string description = 3; */ @@ -79,25 +79,25 @@ export type NetworkServiceCreateRequest = Message<"metalstack.admin.v2.NetworkSe */ project?: string | undefined; /** - * Type of the network to create + * Type of the network to create. * * @generated from field: metalstack.api.v2.NetworkType type = 6; */ type: NetworkType; /** - * Labels on this network + * Labels on this network. * * @generated from field: optional metalstack.api.v2.Labels labels = 7; */ labels?: Labels | undefined; /** - * Prefixes in this network + * Prefixes in this network. * * @generated from field: repeated string prefixes = 8; */ prefixes: string[]; /** - * Destination Prefixes in this network + * Destination Prefixes in this network. * * @generated from field: repeated string destination_prefixes = 9; */ @@ -115,13 +115,13 @@ export type NetworkServiceCreateRequest = Message<"metalstack.admin.v2.NetworkSe */ minChildPrefixLength?: ChildPrefixLength | undefined; /** - * NATType of this network + * NATType of this network. * * @generated from field: optional metalstack.api.v2.NATType nat_type = 12; */ natType?: NATType | undefined; /** - * VRF of this network has this VNI + * VRF of this network has this VNI. * * @generated from field: optional uint32 vrf = 13; */ @@ -139,13 +139,13 @@ export type NetworkServiceCreateRequest = Message<"metalstack.admin.v2.NetworkSe */ additionalAnnouncableCidrs: string[]; /** - * Length per addressfamily + * Length per addressfamily. * * @generated from field: optional metalstack.api.v2.ChildPrefixLength length = 16; */ length?: ChildPrefixLength | undefined; /** - * AddressFamily to create, defaults to the same as the parent + * AddressFamily to create, defaults to the same as the parent. * * @generated from field: optional metalstack.api.v2.NetworkAddressFamily address_family = 17; */ @@ -163,7 +163,7 @@ export declare const NetworkServiceCreateRequestSchema: GenMessage & { /** - * Id of this network + * Id of this network. * * @generated from field: string id = 1; */ @@ -175,31 +175,31 @@ export type NetworkServiceUpdateRequest = Message<"metalstack.admin.v2.NetworkSe */ updateMeta?: UpdateMeta | undefined; /** - * Name of this network + * Name of this network. * * @generated from field: optional string name = 3; */ name?: string | undefined; /** - * Description of this network + * Description of this network. * * @generated from field: optional string description = 4; */ description?: string | undefined; /** - * Labels to update on this network + * Labels to update on this network. * * @generated from field: optional metalstack.api.v2.UpdateLabels labels = 5; */ labels?: UpdateLabels | undefined; /** - * Prefixes in this network + * Prefixes in this network. * * @generated from field: repeated string prefixes = 6; */ prefixes: string[]; /** - * Destination Prefixes in this network + * Destination Prefixes in this network. * * @generated from field: repeated string destination_prefixes = 7; */ @@ -217,7 +217,7 @@ export type NetworkServiceUpdateRequest = Message<"metalstack.admin.v2.NetworkSe */ minChildPrefixLength?: ChildPrefixLength | undefined; /** - * NATType of this network + * NATType of this network. * * @generated from field: optional metalstack.api.v2.NATType nat_type = 10; */ @@ -247,7 +247,7 @@ export declare const NetworkServiceUpdateRequestSchema: GenMessage & { /** - * ID of the network to get + * ID of the network to get. * * @generated from field: string id = 1; */ diff --git a/js/metalstack/admin/v2/network_pb.ts b/js/metalstack/admin/v2/network_pb.ts index eb3b36ec..11d2dff3 100644 --- a/js/metalstack/admin/v2/network_pb.ts +++ b/js/metalstack/admin/v2/network_pb.ts @@ -25,7 +25,7 @@ export const file_metalstack_admin_v2_network: GenFile = /*@__PURE__*/ */ export type NetworkServiceGetRequest = Message<"metalstack.admin.v2.NetworkServiceGetRequest"> & { /** - * ID of the network to get + * ID of the network to get. * * @generated from field: string id = 1; */ @@ -67,21 +67,21 @@ export const NetworkServiceGetResponseSchema: GenMessage & { /** - * Id of this network + * Id of this network. * * @generated from field: optional string id = 1; */ id?: string | undefined; /** - * Name of this network + * Name of this network. * * @generated from field: optional string name = 2; */ name?: string | undefined; /** - * Description of this network + * Description of this network. * * @generated from field: optional string description = 3; */ @@ -102,28 +102,28 @@ export type NetworkServiceCreateRequest = Message<"metalstack.admin.v2.NetworkSe project?: string | undefined; /** - * Type of the network to create + * Type of the network to create. * * @generated from field: metalstack.api.v2.NetworkType type = 6; */ type: NetworkType; /** - * Labels on this network + * Labels on this network. * * @generated from field: optional metalstack.api.v2.Labels labels = 7; */ labels?: Labels | undefined; /** - * Prefixes in this network + * Prefixes in this network. * * @generated from field: repeated string prefixes = 8; */ prefixes: string[]; /** - * Destination Prefixes in this network + * Destination Prefixes in this network. * * @generated from field: repeated string destination_prefixes = 9; */ @@ -144,14 +144,14 @@ export type NetworkServiceCreateRequest = Message<"metalstack.admin.v2.NetworkSe minChildPrefixLength?: ChildPrefixLength | undefined; /** - * NATType of this network + * NATType of this network. * * @generated from field: optional metalstack.api.v2.NATType nat_type = 12; */ natType?: NATType | undefined; /** - * VRF of this network has this VNI + * VRF of this network has this VNI. * * @generated from field: optional uint32 vrf = 13; */ @@ -172,14 +172,14 @@ export type NetworkServiceCreateRequest = Message<"metalstack.admin.v2.NetworkSe additionalAnnouncableCidrs: string[]; /** - * Length per addressfamily + * Length per addressfamily. * * @generated from field: optional metalstack.api.v2.ChildPrefixLength length = 16; */ length?: ChildPrefixLength | undefined; /** - * AddressFamily to create, defaults to the same as the parent + * AddressFamily to create, defaults to the same as the parent. * * @generated from field: optional metalstack.api.v2.NetworkAddressFamily address_family = 17; */ @@ -200,7 +200,7 @@ export const NetworkServiceCreateRequestSchema: GenMessage & { /** - * Id of this network + * Id of this network. * * @generated from field: string id = 1; */ @@ -214,35 +214,35 @@ export type NetworkServiceUpdateRequest = Message<"metalstack.admin.v2.NetworkSe updateMeta?: UpdateMeta | undefined; /** - * Name of this network + * Name of this network. * * @generated from field: optional string name = 3; */ name?: string | undefined; /** - * Description of this network + * Description of this network. * * @generated from field: optional string description = 4; */ description?: string | undefined; /** - * Labels to update on this network + * Labels to update on this network. * * @generated from field: optional metalstack.api.v2.UpdateLabels labels = 5; */ labels?: UpdateLabels | undefined; /** - * Prefixes in this network + * Prefixes in this network. * * @generated from field: repeated string prefixes = 6; */ prefixes: string[]; /** - * Destination Prefixes in this network + * Destination Prefixes in this network. * * @generated from field: repeated string destination_prefixes = 7; */ @@ -263,7 +263,7 @@ export type NetworkServiceUpdateRequest = Message<"metalstack.admin.v2.NetworkSe minChildPrefixLength?: ChildPrefixLength | undefined; /** - * NATType of this network + * NATType of this network. * * @generated from field: optional metalstack.api.v2.NATType nat_type = 10; */ @@ -298,7 +298,7 @@ export const NetworkServiceUpdateRequestSchema: GenMessage & { /** - * ID of the network to get + * ID of the network to get. * * @generated from field: string id = 1; */ diff --git a/js/metalstack/admin/v2/partition_pb.d.ts b/js/metalstack/admin/v2/partition_pb.d.ts index 95c2af1b..670d1dc4 100644 --- a/js/metalstack/admin/v2/partition_pb.d.ts +++ b/js/metalstack/admin/v2/partition_pb.d.ts @@ -13,7 +13,7 @@ export declare const file_metalstack_admin_v2_partition: GenFile; */ export type PartitionServiceCreateRequest = Message<"metalstack.admin.v2.PartitionServiceCreateRequest"> & { /** - * Partition the partition + * Partition the partition. * * @generated from field: metalstack.api.v2.Partition partition = 1; */ @@ -31,7 +31,7 @@ export declare const PartitionServiceCreateRequestSchema: GenMessage & { /** - * ID of this partition + * ID of this partition. * * @generated from field: string id = 1; */ @@ -43,7 +43,7 @@ export type PartitionServiceUpdateRequest = Message<"metalstack.admin.v2.Partiti */ updateMeta?: UpdateMeta | undefined; /** - * Description of this partition + * Description of this partition. * * @generated from field: optional string description = 3; */ @@ -55,26 +55,26 @@ export type PartitionServiceUpdateRequest = Message<"metalstack.admin.v2.Partiti */ bootConfiguration?: PartitionBootConfiguration | undefined; /** - * DNSServers for this partition + * DNSServers for this partition. * * @generated from field: repeated metalstack.api.v2.DNSServer dns_servers = 5; */ dnsServers: DNSServer[]; /** - * NTPServers for this partition + * NTPServers for this partition. * * @generated from field: repeated metalstack.api.v2.NTPServer ntp_servers = 6; */ ntpServers: NTPServer[]; /** * ManagementServiceAddresses defines where the management is reachable. - * must be in the form : + * must be in the form :. * * @generated from field: repeated string mgmt_service_addresses = 7; */ mgmtServiceAddresses: string[]; /** - * Labels to update on this network + * Labels to update on this network. * * @generated from field: optional metalstack.api.v2.UpdateLabels labels = 8; */ @@ -92,7 +92,7 @@ export declare const PartitionServiceUpdateRequestSchema: GenMessage & { /** - * ID of the partition to delete + * ID of the partition to delete. * * @generated from field: string id = 1; */ @@ -110,7 +110,7 @@ export declare const PartitionServiceDeleteRequestSchema: GenMessage & { /** - * Partition the partition + * Partition the partition. * * @generated from field: metalstack.api.v2.Partition partition = 1; */ @@ -128,7 +128,7 @@ export declare const PartitionServiceCreateResponseSchema: GenMessage & { /** - * Partition the partition + * Partition the partition. * * @generated from field: metalstack.api.v2.Partition partition = 1; */ @@ -164,19 +164,19 @@ export declare const PartitionServiceDeleteResponseSchema: GenMessage & { /** - * ID of the partition to get + * ID of the partition to get. * * @generated from field: optional string id = 1; */ id?: string | undefined; /** - * Size of machines to show the capacity + * Size of machines to show the capacity. * * @generated from field: optional string size = 2; */ size?: string | undefined; /** - * Project of machines to show the capacity + * Project of machines to show the capacity. * * @generated from field: optional string project = 3; */ @@ -292,7 +292,7 @@ export type MachineSizeCapacity = Message<"metalstack.admin.v2.MachineSizeCapaci */ free: bigint; /** - * Unavailable is the amount of machine in a partition that are currently not allocatable because they are not waiting or + * Unavailable is the amount of machine in a partition that are currently not allocatable because they are not waiting or. * not in the machine state "available", e.g. locked or reserved. * * @generated from field: int64 unavailable = 11; diff --git a/js/metalstack/admin/v2/partition_pb.ts b/js/metalstack/admin/v2/partition_pb.ts index 4242f918..cf9149e8 100644 --- a/js/metalstack/admin/v2/partition_pb.ts +++ b/js/metalstack/admin/v2/partition_pb.ts @@ -25,7 +25,7 @@ export const file_metalstack_admin_v2_partition: GenFile = /*@__PURE__*/ */ export type PartitionServiceCreateRequest = Message<"metalstack.admin.v2.PartitionServiceCreateRequest"> & { /** - * Partition the partition + * Partition the partition. * * @generated from field: metalstack.api.v2.Partition partition = 1; */ @@ -46,7 +46,7 @@ export const PartitionServiceCreateRequestSchema: GenMessage & { /** - * ID of this partition + * ID of this partition. * * @generated from field: string id = 1; */ @@ -60,7 +60,7 @@ export type PartitionServiceUpdateRequest = Message<"metalstack.admin.v2.Partiti updateMeta?: UpdateMeta | undefined; /** - * Description of this partition + * Description of this partition. * * @generated from field: optional string description = 3; */ @@ -74,14 +74,14 @@ export type PartitionServiceUpdateRequest = Message<"metalstack.admin.v2.Partiti bootConfiguration?: PartitionBootConfiguration | undefined; /** - * DNSServers for this partition + * DNSServers for this partition. * * @generated from field: repeated metalstack.api.v2.DNSServer dns_servers = 5; */ dnsServers: DNSServer[]; /** - * NTPServers for this partition + * NTPServers for this partition. * * @generated from field: repeated metalstack.api.v2.NTPServer ntp_servers = 6; */ @@ -89,14 +89,14 @@ export type PartitionServiceUpdateRequest = Message<"metalstack.admin.v2.Partiti /** * ManagementServiceAddresses defines where the management is reachable. - * must be in the form : + * must be in the form :. * * @generated from field: repeated string mgmt_service_addresses = 7; */ mgmtServiceAddresses: string[]; /** - * Labels to update on this network + * Labels to update on this network. * * @generated from field: optional metalstack.api.v2.UpdateLabels labels = 8; */ @@ -117,7 +117,7 @@ export const PartitionServiceUpdateRequestSchema: GenMessage & { /** - * ID of the partition to delete + * ID of the partition to delete. * * @generated from field: string id = 1; */ @@ -138,7 +138,7 @@ export const PartitionServiceDeleteRequestSchema: GenMessage & { /** - * Partition the partition + * Partition the partition. * * @generated from field: metalstack.api.v2.Partition partition = 1; */ @@ -159,7 +159,7 @@ export const PartitionServiceCreateResponseSchema: GenMessage & { /** - * Partition the partition + * Partition the partition. * * @generated from field: metalstack.api.v2.Partition partition = 1; */ @@ -201,21 +201,21 @@ export const PartitionServiceDeleteResponseSchema: GenMessage & { /** - * ID of the partition to get + * ID of the partition to get. * * @generated from field: optional string id = 1; */ id?: string | undefined; /** - * Size of machines to show the capacity + * Size of machines to show the capacity. * * @generated from field: optional string size = 2; */ size?: string | undefined; /** - * Project of machines to show the capacity + * Project of machines to show the capacity. * * @generated from field: optional string project = 3; */ @@ -350,7 +350,7 @@ export type MachineSizeCapacity = Message<"metalstack.admin.v2.MachineSizeCapaci free: bigint; /** - * Unavailable is the amount of machine in a partition that are currently not allocatable because they are not waiting or + * Unavailable is the amount of machine in a partition that are currently not allocatable because they are not waiting or. * not in the machine state "available", e.g. locked or reserved. * * @generated from field: int64 unavailable = 11; diff --git a/js/metalstack/admin/v2/size_imageconstraint_pb.d.ts b/js/metalstack/admin/v2/size_imageconstraint_pb.d.ts index a15cd637..02aab6b2 100644 --- a/js/metalstack/admin/v2/size_imageconstraint_pb.d.ts +++ b/js/metalstack/admin/v2/size_imageconstraint_pb.d.ts @@ -13,31 +13,31 @@ export declare const file_metalstack_admin_v2_size_imageconstraint: GenFile; */ export type SizeImageConstraintServiceCreateRequest = Message<"metalstack.admin.v2.SizeImageConstraintServiceCreateRequest"> & { /** - * Size of the constraint + * Size of the constraint. * * @generated from field: string size = 1; */ size: string; /** - * ImageConstraints to apply to this size + * ImageConstraints to apply to this size. * * @generated from field: repeated metalstack.api.v2.ImageConstraint image_constraints = 2; */ imageConstraints: ImageConstraint[]; /** - * Meta for this size image constraint + * Meta for this size image constraint. * * @generated from field: metalstack.api.v2.Meta meta = 3; */ meta?: Meta | undefined; /** - * Name of this size image constraint + * Name of this size image constraint. * * @generated from field: optional string name = 4; */ name?: string | undefined; /** - * Description of this size image constraint + * Description of this size image constraint. * * @generated from field: optional string description = 5; */ @@ -73,7 +73,7 @@ export declare const SizeImageConstraintServiceCreateResponseSchema: GenMessage< */ export type SizeImageConstraintServiceUpdateRequest = Message<"metalstack.admin.v2.SizeImageConstraintServiceUpdateRequest"> & { /** - * Size of the image constraint to update + * Size of the image constraint to update. * * @generated from field: string size = 1; */ @@ -85,19 +85,19 @@ export type SizeImageConstraintServiceUpdateRequest = Message<"metalstack.admin. */ updateMeta?: UpdateMeta | undefined; /** - * ImageConstraints to apply to this size + * ImageConstraints to apply to this size. * * @generated from field: repeated metalstack.api.v2.ImageConstraint image_constraints = 3; */ imageConstraints: ImageConstraint[]; /** - * Name of this size image constraint + * Name of this size image constraint. * * @generated from field: optional string name = 4; */ name?: string | undefined; /** - * Description of this size image constraint + * Description of this size image constraint. * * @generated from field: optional string description = 5; */ @@ -133,7 +133,7 @@ export declare const SizeImageConstraintServiceUpdateResponseSchema: GenMessage< */ export type SizeImageConstraintServiceDeleteRequest = Message<"metalstack.admin.v2.SizeImageConstraintServiceDeleteRequest"> & { /** - * Size of the constraint + * Size of the constraint. * * @generated from field: string size = 1; */ @@ -169,7 +169,7 @@ export declare const SizeImageConstraintServiceDeleteResponseSchema: GenMessage< */ export type SizeImageConstraintServiceGetRequest = Message<"metalstack.admin.v2.SizeImageConstraintServiceGetRequest"> & { /** - * Size of the constraint + * Size of the constraint. * * @generated from field: string size = 1; */ diff --git a/js/metalstack/admin/v2/size_imageconstraint_pb.ts b/js/metalstack/admin/v2/size_imageconstraint_pb.ts index 5240d17b..0a68ea09 100644 --- a/js/metalstack/admin/v2/size_imageconstraint_pb.ts +++ b/js/metalstack/admin/v2/size_imageconstraint_pb.ts @@ -25,35 +25,35 @@ export const file_metalstack_admin_v2_size_imageconstraint: GenFile = /*@__PURE_ */ export type SizeImageConstraintServiceCreateRequest = Message<"metalstack.admin.v2.SizeImageConstraintServiceCreateRequest"> & { /** - * Size of the constraint + * Size of the constraint. * * @generated from field: string size = 1; */ size: string; /** - * ImageConstraints to apply to this size + * ImageConstraints to apply to this size. * * @generated from field: repeated metalstack.api.v2.ImageConstraint image_constraints = 2; */ imageConstraints: ImageConstraint[]; /** - * Meta for this size image constraint + * Meta for this size image constraint. * * @generated from field: metalstack.api.v2.Meta meta = 3; */ meta?: Meta | undefined; /** - * Name of this size image constraint + * Name of this size image constraint. * * @generated from field: optional string name = 4; */ name?: string | undefined; /** - * Description of this size image constraint + * Description of this size image constraint. * * @generated from field: optional string description = 5; */ @@ -95,7 +95,7 @@ export const SizeImageConstraintServiceCreateResponseSchema: GenMessage & { /** - * Size of the image constraint to update + * Size of the image constraint to update. * * @generated from field: string size = 1; */ @@ -109,21 +109,21 @@ export type SizeImageConstraintServiceUpdateRequest = Message<"metalstack.admin. updateMeta?: UpdateMeta | undefined; /** - * ImageConstraints to apply to this size + * ImageConstraints to apply to this size. * * @generated from field: repeated metalstack.api.v2.ImageConstraint image_constraints = 3; */ imageConstraints: ImageConstraint[]; /** - * Name of this size image constraint + * Name of this size image constraint. * * @generated from field: optional string name = 4; */ name?: string | undefined; /** - * Description of this size image constraint + * Description of this size image constraint. * * @generated from field: optional string description = 5; */ @@ -165,7 +165,7 @@ export const SizeImageConstraintServiceUpdateResponseSchema: GenMessage & { /** - * Size of the constraint + * Size of the constraint. * * @generated from field: string size = 1; */ @@ -207,7 +207,7 @@ export const SizeImageConstraintServiceDeleteResponseSchema: GenMessage & { /** - * Size of the constraint + * Size of the constraint. * * @generated from field: string size = 1; */ diff --git a/js/metalstack/admin/v2/size_pb.d.ts b/js/metalstack/admin/v2/size_pb.d.ts index bc21fa37..e17ef863 100644 --- a/js/metalstack/admin/v2/size_pb.d.ts +++ b/js/metalstack/admin/v2/size_pb.d.ts @@ -49,7 +49,7 @@ export declare const SizeServiceCreateResponseSchema: GenMessage & { /** - * Id of this size + * Id of this size. * * @generated from field: string id = 1; */ @@ -61,25 +61,25 @@ export type SizeServiceUpdateRequest = Message<"metalstack.admin.v2.SizeServiceU */ updateMeta?: UpdateMeta | undefined; /** - * Name of this size + * Name of this size. * * @generated from field: optional string name = 3; */ name?: string | undefined; /** - * Description of this size + * Description of this size. * * @generated from field: optional string description = 4; */ description?: string | undefined; /** - * Constraints which must match that a specific machine is considered of this size + * Constraints which must match that a specific machine is considered of this size. * * @generated from field: repeated metalstack.api.v2.SizeConstraint constraints = 5; */ constraints: SizeConstraint[]; /** - * Labels to update on this size + * Labels to update on this size. * * @generated from field: optional metalstack.api.v2.UpdateLabels labels = 6; */ @@ -115,7 +115,7 @@ export declare const SizeServiceUpdateResponseSchema: GenMessage & { /** - * ID of the size to delete + * ID of the size to delete. * * @generated from field: string id = 1; */ diff --git a/js/metalstack/admin/v2/size_pb.ts b/js/metalstack/admin/v2/size_pb.ts index 1e6590d0..a0ad50b4 100644 --- a/js/metalstack/admin/v2/size_pb.ts +++ b/js/metalstack/admin/v2/size_pb.ts @@ -67,7 +67,7 @@ export const SizeServiceCreateResponseSchema: GenMessage & { /** - * Id of this size + * Id of this size. * * @generated from field: string id = 1; */ @@ -81,28 +81,28 @@ export type SizeServiceUpdateRequest = Message<"metalstack.admin.v2.SizeServiceU updateMeta?: UpdateMeta | undefined; /** - * Name of this size + * Name of this size. * * @generated from field: optional string name = 3; */ name?: string | undefined; /** - * Description of this size + * Description of this size. * * @generated from field: optional string description = 4; */ description?: string | undefined; /** - * Constraints which must match that a specific machine is considered of this size + * Constraints which must match that a specific machine is considered of this size. * * @generated from field: repeated metalstack.api.v2.SizeConstraint constraints = 5; */ constraints: SizeConstraint[]; /** - * Labels to update on this size + * Labels to update on this size. * * @generated from field: optional metalstack.api.v2.UpdateLabels labels = 6; */ @@ -144,7 +144,7 @@ export const SizeServiceUpdateResponseSchema: GenMessage & { /** - * ID of the size to delete + * ID of the size to delete. * * @generated from field: string id = 1; */ diff --git a/js/metalstack/admin/v2/size_reservation_pb.d.ts b/js/metalstack/admin/v2/size_reservation_pb.d.ts index 9b505e4b..473b57e6 100644 --- a/js/metalstack/admin/v2/size_reservation_pb.d.ts +++ b/js/metalstack/admin/v2/size_reservation_pb.d.ts @@ -49,19 +49,19 @@ export declare const SizeReservationServiceCreateResponseSchema: GenMessage & { /** - * Id of this size reservation + * Id of this size reservation. * * @generated from field: string id = 1; */ id: string; /** - * Name of this size reservation + * Name of this size reservation. * * @generated from field: optional string name = 2; */ name?: string | undefined; /** - * Description of this size reservation + * Description of this size reservation. * * @generated from field: optional string description = 3; */ @@ -73,19 +73,19 @@ export type SizeReservationServiceUpdateRequest = Message<"metalstack.admin.v2.S */ updateMeta?: UpdateMeta | undefined; /** - * Partition ids of this size reservation + * Partition ids of this size reservation. * * @generated from field: repeated string partitions = 5; */ partitions: string[]; /** - * Amount of reservations of this size reservation + * Amount of reservations of this size reservation. * * @generated from field: optional int32 amount = 6; */ amount?: number | undefined; /** - * Labels to update of this size reservation + * Labels to update of this size reservation. * * @generated from field: optional metalstack.api.v2.UpdateLabels labels = 7; */ @@ -121,7 +121,7 @@ export declare const SizeReservationServiceUpdateResponseSchema: GenMessage & { /** - * ID of the size reservation to delete + * ID of the size reservation to delete. * * @generated from field: string id = 1; */ diff --git a/js/metalstack/admin/v2/size_reservation_pb.ts b/js/metalstack/admin/v2/size_reservation_pb.ts index 6d4d0143..d3006d17 100644 --- a/js/metalstack/admin/v2/size_reservation_pb.ts +++ b/js/metalstack/admin/v2/size_reservation_pb.ts @@ -67,21 +67,21 @@ export const SizeReservationServiceCreateResponseSchema: GenMessage & { /** - * Id of this size reservation + * Id of this size reservation. * * @generated from field: string id = 1; */ id: string; /** - * Name of this size reservation + * Name of this size reservation. * * @generated from field: optional string name = 2; */ name?: string | undefined; /** - * Description of this size reservation + * Description of this size reservation. * * @generated from field: optional string description = 3; */ @@ -95,21 +95,21 @@ export type SizeReservationServiceUpdateRequest = Message<"metalstack.admin.v2.S updateMeta?: UpdateMeta | undefined; /** - * Partition ids of this size reservation + * Partition ids of this size reservation. * * @generated from field: repeated string partitions = 5; */ partitions: string[]; /** - * Amount of reservations of this size reservation + * Amount of reservations of this size reservation. * * @generated from field: optional int32 amount = 6; */ amount?: number | undefined; /** - * Labels to update of this size reservation + * Labels to update of this size reservation. * * @generated from field: optional metalstack.api.v2.UpdateLabels labels = 7; */ @@ -151,7 +151,7 @@ export const SizeReservationServiceUpdateResponseSchema: GenMessage & { /** - * ID of the size reservation to delete + * ID of the size reservation to delete. * * @generated from field: string id = 1; */ diff --git a/js/metalstack/admin/v2/switch_pb.d.ts b/js/metalstack/admin/v2/switch_pb.d.ts index fec1f391..34306cf1 100644 --- a/js/metalstack/admin/v2/switch_pb.d.ts +++ b/js/metalstack/admin/v2/switch_pb.d.ts @@ -15,7 +15,7 @@ export declare const file_metalstack_admin_v2_switch: GenFile; */ export type SwitchServiceGetRequest = Message<"metalstack.admin.v2.SwitchServiceGetRequest"> & { /** - * Id of the switch to get + * Id of the switch to get. * * @generated from field: string id = 1; */ @@ -69,7 +69,7 @@ export declare const SwitchServiceListRequestSchema: GenMessage & { /** - * Switches that match the request query + * Switches that match the request query. * * @generated from field: repeated metalstack.api.v2.Switch switches = 1; */ @@ -87,7 +87,7 @@ export declare const SwitchServiceListResponseSchema: GenMessage & { /** - * ID of the switch + * ID of the switch. * * @generated from field: string id = 1; */ @@ -106,7 +106,7 @@ export type SwitchServiceUpdateRequest = Message<"metalstack.admin.v2.SwitchServ */ updatedAt?: Timestamp | undefined; /** - * Description of the switch + * Description of the switch. * * @generated from field: optional string description = 4; */ @@ -178,7 +178,7 @@ export declare const SwitchServiceUpdateResponseSchema: GenMessage & { /** - * Id of the switch + * Id of the switch. * * @generated from field: string id = 1; */ @@ -262,19 +262,19 @@ export declare const SwitchServiceMigrateResponseSchema: GenMessage & { /** - * Id of the switch + * Id of the switch. * * @generated from field: string id = 1; */ id: string; /** - * NicName of the port whose status should be changed + * NicName of the port whose status should be changed. * * @generated from field: string nic_name = 2; */ nicName: string; /** - * Status that the port should have + * Status that the port should have. * * @generated from field: metalstack.api.v2.SwitchPortStatus status = 3; */ @@ -292,7 +292,7 @@ export declare const SwitchServicePortRequestSchema: GenMessage & { /** - * Switch after the port status toggle + * Switch after the port status toggle. * * @generated from field: metalstack.api.v2.Switch switch = 1; */ @@ -316,7 +316,7 @@ export type SwitchServiceConnectedMachinesRequest = Message<"metalstack.admin.v2 */ query?: SwitchQuery | undefined; /** - * MachineQuery to filter the machine results + * MachineQuery to filter the machine results. * * @generated from field: metalstack.api.v2.MachineQuery machine_query = 2; */ diff --git a/js/metalstack/admin/v2/switch_pb.ts b/js/metalstack/admin/v2/switch_pb.ts index 021cdf4c..161db199 100644 --- a/js/metalstack/admin/v2/switch_pb.ts +++ b/js/metalstack/admin/v2/switch_pb.ts @@ -29,7 +29,7 @@ export const file_metalstack_admin_v2_switch: GenFile = /*@__PURE__*/ */ export type SwitchServiceGetRequest = Message<"metalstack.admin.v2.SwitchServiceGetRequest"> & { /** - * Id of the switch to get + * Id of the switch to get. * * @generated from field: string id = 1; */ @@ -92,7 +92,7 @@ export const SwitchServiceListRequestSchema: GenMessage & { /** - * Switches that match the request query + * Switches that match the request query. * * @generated from field: repeated metalstack.api.v2.Switch switches = 1; */ @@ -113,7 +113,7 @@ export const SwitchServiceListResponseSchema: GenMessage & { /** - * ID of the switch + * ID of the switch. * * @generated from field: string id = 1; */ @@ -135,7 +135,7 @@ export type SwitchServiceUpdateRequest = Message<"metalstack.admin.v2.SwitchServ updatedAt?: Timestamp | undefined; /** - * Description of the switch + * Description of the switch. * * @generated from field: optional string description = 4; */ @@ -219,7 +219,7 @@ export const SwitchServiceUpdateResponseSchema: GenMessage & { /** - * Id of the switch + * Id of the switch. * * @generated from field: string id = 1; */ @@ -317,21 +317,21 @@ export const SwitchServiceMigrateResponseSchema: GenMessage & { /** - * Id of the switch + * Id of the switch. * * @generated from field: string id = 1; */ id: string; /** - * NicName of the port whose status should be changed + * NicName of the port whose status should be changed. * * @generated from field: string nic_name = 2; */ nicName: string; /** - * Status that the port should have + * Status that the port should have. * * @generated from field: metalstack.api.v2.SwitchPortStatus status = 3; */ @@ -352,7 +352,7 @@ export const SwitchServicePortRequestSchema: GenMessage & { /** - * Switch after the port status toggle + * Switch after the port status toggle. * * @generated from field: metalstack.api.v2.Switch switch = 1; */ @@ -380,7 +380,7 @@ export type SwitchServiceConnectedMachinesRequest = Message<"metalstack.admin.v2 query?: SwitchQuery | undefined; /** - * MachineQuery to filter the machine results + * MachineQuery to filter the machine results. * * @generated from field: metalstack.api.v2.MachineQuery machine_query = 2; */ diff --git a/js/metalstack/admin/v2/task_pb.d.ts b/js/metalstack/admin/v2/task_pb.d.ts index f3807990..3f690d64 100644 --- a/js/metalstack/admin/v2/task_pb.d.ts +++ b/js/metalstack/admin/v2/task_pb.d.ts @@ -100,7 +100,7 @@ export declare const TaskServiceQueuesRequestSchema: GenMessage & { /** - * Queues configured for the async system + * Queues configured for the async system. * * @generated from field: repeated string queues = 1; */ @@ -216,7 +216,7 @@ export type TaskInfo = Message<"metalstack.admin.v2.TaskInfo"> & { lastError: string; /** * LastFailedAt is the time of the last failure if any. - * If the task has no failures, LastFailedAt is zero time (i.e. time.Time{}) + * If the task has no failures, LastFailedAt is zero time (i.e. time.Time{}). * * @generated from field: google.protobuf.Timestamp last_failed_at = 9; */ @@ -236,8 +236,8 @@ export type TaskInfo = Message<"metalstack.admin.v2.TaskInfo"> & { /** * 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 + * 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. * * Empty string (default) indicates task does not belong to any groups, and no aggregation will be applied to the task. * @@ -246,15 +246,15 @@ export type TaskInfo = Message<"metalstack.admin.v2.TaskInfo"> & { group: string; /** * NextProcessAt is the time the task is scheduled to be processed. - * Zero if not applicable + * Zero if not applicable. * * @generated from field: google.protobuf.Timestamp next_process_at = 13; */ nextProcessAt?: Timestamp | undefined; /** * 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 + * An orphaned task indicates that the worker has crashed or experienced network failures and was not able to. + * 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. @@ -277,7 +277,7 @@ export type TaskInfo = Message<"metalstack.admin.v2.TaskInfo"> & { completedAt?: Timestamp | undefined; /** * Result holds the result data associated with the task. - * Use ResultWriter to write result data from the Handler + * Use ResultWriter to write result data from the Handler. * * @generated from field: bytes result = 17; */ diff --git a/js/metalstack/admin/v2/task_pb.ts b/js/metalstack/admin/v2/task_pb.ts index b4db81f3..f7f6cd9b 100644 --- a/js/metalstack/admin/v2/task_pb.ts +++ b/js/metalstack/admin/v2/task_pb.ts @@ -129,7 +129,7 @@ export const TaskServiceQueuesRequestSchema: GenMessage & { /** - * Queues configured for the async system + * Queues configured for the async system. * * @generated from field: repeated string queues = 1; */ @@ -264,7 +264,7 @@ export type TaskInfo = Message<"metalstack.admin.v2.TaskInfo"> & { /** * LastFailedAt is the time of the last failure if any. - * If the task has no failures, LastFailedAt is zero time (i.e. time.Time{}) + * If the task has no failures, LastFailedAt is zero time (i.e. time.Time{}). * * @generated from field: google.protobuf.Timestamp last_failed_at = 9; */ @@ -287,8 +287,8 @@ export type TaskInfo = Message<"metalstack.admin.v2.TaskInfo"> & { /** * 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 + * 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. * * Empty string (default) indicates task does not belong to any groups, and no aggregation will be applied to the task. * @@ -298,7 +298,7 @@ export type TaskInfo = Message<"metalstack.admin.v2.TaskInfo"> & { /** * NextProcessAt is the time the task is scheduled to be processed. - * Zero if not applicable + * Zero if not applicable. * * @generated from field: google.protobuf.Timestamp next_process_at = 13; */ @@ -306,8 +306,8 @@ export type TaskInfo = Message<"metalstack.admin.v2.TaskInfo"> & { /** * 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 + * An orphaned task indicates that the worker has crashed or experienced network failures and was not able to. + * 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. @@ -333,7 +333,7 @@ export type TaskInfo = Message<"metalstack.admin.v2.TaskInfo"> & { /** * Result holds the result data associated with the task. - * Use ResultWriter to write result data from the Handler + * Use ResultWriter to write result data from the Handler. * * @generated from field: bytes result = 17; */ diff --git a/js/metalstack/admin/v2/tenant_pb.d.ts b/js/metalstack/admin/v2/tenant_pb.d.ts index 3213929d..e6eefd20 100644 --- a/js/metalstack/admin/v2/tenant_pb.d.ts +++ b/js/metalstack/admin/v2/tenant_pb.d.ts @@ -13,31 +13,31 @@ export declare const file_metalstack_admin_v2_tenant: GenFile; */ export type TenantServiceCreateRequest = Message<"metalstack.admin.v2.TenantServiceCreateRequest"> & { /** - * Name of the tenant + * Name of the tenant. * * @generated from field: string name = 1; */ name: string; /** - * Description of the tenant + * Description of the tenant. * * @generated from field: optional string description = 2; */ description?: string | undefined; /** - * Email of the tenant, if not set will be inherited from the creator + * Email of the tenant, if not set will be inherited from the creator. * * @generated from field: optional string email = 3; */ email?: string | undefined; /** - * AvatarUrl of the tenant + * AvatarUrl of the tenant. * * @generated from field: optional string avatar_url = 4; */ avatarUrl?: string | undefined; /** - * Labels on the tenant + * Labels on the tenant. * * @generated from field: metalstack.api.v2.Labels labels = 5; */ @@ -115,19 +115,19 @@ export declare const TenantServiceListResponseSchema: GenMessage & { /** - * Login of the tenant to which the member will be added + * Login of the tenant to which the member will be added. * * @generated from field: string tenant = 1; */ tenant: string; /** - * Login of the member to add + * Login of the member to add. * * @generated from field: string member = 2; */ member: string; /** - * Role to assign to the new member + * Role to assign to the new member. * * @generated from field: metalstack.api.v2.TenantRole role = 3; */ @@ -163,13 +163,13 @@ export declare const TenantServiceAddMemberResponseSchema: GenMessage & { /** - * Login of the tenant from which the member will be removed + * Login of the tenant from which the member will be removed. * * @generated from field: string tenant = 1; */ tenant: string; /** - * Login of the member to remove + * Login of the member to remove. * * @generated from field: string member = 2; */ diff --git a/js/metalstack/admin/v2/tenant_pb.ts b/js/metalstack/admin/v2/tenant_pb.ts index 5f0439d3..79547bb7 100644 --- a/js/metalstack/admin/v2/tenant_pb.ts +++ b/js/metalstack/admin/v2/tenant_pb.ts @@ -25,35 +25,35 @@ export const file_metalstack_admin_v2_tenant: GenFile = /*@__PURE__*/ */ export type TenantServiceCreateRequest = Message<"metalstack.admin.v2.TenantServiceCreateRequest"> & { /** - * Name of the tenant + * Name of the tenant. * * @generated from field: string name = 1; */ name: string; /** - * Description of the tenant + * Description of the tenant. * * @generated from field: optional string description = 2; */ description?: string | undefined; /** - * Email of the tenant, if not set will be inherited from the creator + * Email of the tenant, if not set will be inherited from the creator. * * @generated from field: optional string email = 3; */ email?: string | undefined; /** - * AvatarUrl of the tenant + * AvatarUrl of the tenant. * * @generated from field: optional string avatar_url = 4; */ avatarUrl?: string | undefined; /** - * Labels on the tenant + * Labels on the tenant. * * @generated from field: metalstack.api.v2.Labels labels = 5; */ @@ -144,21 +144,21 @@ export const TenantServiceListResponseSchema: GenMessage & { /** - * Login of the tenant to which the member will be added + * Login of the tenant to which the member will be added. * * @generated from field: string tenant = 1; */ tenant: string; /** - * Login of the member to add + * Login of the member to add. * * @generated from field: string member = 2; */ member: string; /** - * Role to assign to the new member + * Role to assign to the new member. * * @generated from field: metalstack.api.v2.TenantRole role = 3; */ @@ -200,14 +200,14 @@ export const TenantServiceAddMemberResponseSchema: GenMessage & { /** - * Login of the tenant from which the member will be removed + * Login of the tenant from which the member will be removed. * * @generated from field: string tenant = 1; */ tenant: string; /** - * Login of the member to remove + * Login of the member to remove. * * @generated from field: string member = 2; */ diff --git a/js/metalstack/admin/v2/token_pb.d.ts b/js/metalstack/admin/v2/token_pb.d.ts index 7580e6e4..464a48e8 100644 --- a/js/metalstack/admin/v2/token_pb.d.ts +++ b/js/metalstack/admin/v2/token_pb.d.ts @@ -83,13 +83,13 @@ export declare const TokenServiceRevokeResponseSchema: GenMessage & { /** - * User this token should be created for, if omitted, user is derived from caller + * User this token should be created for, if omitted, user is derived from caller. * * @generated from field: optional string user = 1; */ user?: string | undefined; /** - * TokenCreateRequest which should be created + * TokenCreateRequest which should be created. * * @generated from field: metalstack.api.v2.TokenServiceCreateRequest token_create_request = 2; */ diff --git a/js/metalstack/admin/v2/token_pb.ts b/js/metalstack/admin/v2/token_pb.ts index 75e96b9f..b9e75ba2 100644 --- a/js/metalstack/admin/v2/token_pb.ts +++ b/js/metalstack/admin/v2/token_pb.ts @@ -109,14 +109,14 @@ export const TokenServiceRevokeResponseSchema: GenMessage & { /** - * User this token should be created for, if omitted, user is derived from caller + * User this token should be created for, if omitted, user is derived from caller. * * @generated from field: optional string user = 1; */ user?: string | undefined; /** - * TokenCreateRequest which should be created + * TokenCreateRequest which should be created. * * @generated from field: metalstack.api.v2.TokenServiceCreateRequest token_create_request = 2; */ diff --git a/js/metalstack/admin/v2/vpn_pb.d.ts b/js/metalstack/admin/v2/vpn_pb.d.ts index 37b9c812..968d5357 100644 --- a/js/metalstack/admin/v2/vpn_pb.d.ts +++ b/js/metalstack/admin/v2/vpn_pb.d.ts @@ -13,7 +13,7 @@ export declare const file_metalstack_admin_v2_vpn: GenFile; */ export type VPNServiceAuthKeyRequest = Message<"metalstack.admin.v2.VPNServiceAuthKeyRequest"> & { /** - * Project for which a VPN authentication key should be generated + * Project for which a VPN authentication key should be generated. * * @generated from field: string project = 1; */ @@ -69,13 +69,13 @@ export type VPNServiceAuthKeyResponse = Message<"metalstack.admin.v2.VPNServiceA */ ephemeral: boolean; /** - * ExpiresAt this key cannot be used after this timestamp + * ExpiresAt this key cannot be used after this timestamp. * * @generated from field: google.protobuf.Timestamp expires_at = 4; */ expiresAt?: Timestamp | undefined; /** - * CreatedAt this key was created at this timestamp + * CreatedAt this key was created at this timestamp. * * @generated from field: google.protobuf.Timestamp created_at = 5; */ @@ -111,7 +111,7 @@ export declare const VPNServiceListNodesRequestSchema: GenMessage & { /** - * Nodes connected to the VPN + * Nodes connected to the VPN. * * @generated from field: repeated metalstack.api.v2.VPNNode nodes = 1; */ diff --git a/js/metalstack/admin/v2/vpn_pb.ts b/js/metalstack/admin/v2/vpn_pb.ts index ef61e397..98388de7 100644 --- a/js/metalstack/admin/v2/vpn_pb.ts +++ b/js/metalstack/admin/v2/vpn_pb.ts @@ -25,7 +25,7 @@ export const file_metalstack_admin_v2_vpn: GenFile = /*@__PURE__*/ */ export type VPNServiceAuthKeyRequest = Message<"metalstack.admin.v2.VPNServiceAuthKeyRequest"> & { /** - * Project for which a VPN authentication key should be generated + * Project for which a VPN authentication key should be generated. * * @generated from field: string project = 1; */ @@ -90,14 +90,14 @@ export type VPNServiceAuthKeyResponse = Message<"metalstack.admin.v2.VPNServiceA ephemeral: boolean; /** - * ExpiresAt this key cannot be used after this timestamp + * ExpiresAt this key cannot be used after this timestamp. * * @generated from field: google.protobuf.Timestamp expires_at = 4; */ expiresAt?: Timestamp | undefined; /** - * CreatedAt this key was created at this timestamp + * CreatedAt this key was created at this timestamp. * * @generated from field: google.protobuf.Timestamp created_at = 5; */ @@ -139,7 +139,7 @@ export const VPNServiceListNodesRequestSchema: GenMessage & { /** - * Nodes connected to the VPN + * Nodes connected to the VPN. * * @generated from field: repeated metalstack.api.v2.VPNNode nodes = 1; */ diff --git a/js/metalstack/api/v2/audit_pb.d.ts b/js/metalstack/api/v2/audit_pb.d.ts index b01a5b68..243f2b03 100644 --- a/js/metalstack/api/v2/audit_pb.d.ts +++ b/js/metalstack/api/v2/audit_pb.d.ts @@ -13,7 +13,7 @@ export declare const file_metalstack_api_v2_audit: GenFile; */ export type AuditTrace = Message<"metalstack.api.v2.AuditTrace"> & { /** - * Uuid of the audit trace + * Uuid of the audit trace. * * @generated from field: string uuid = 1; */ @@ -73,7 +73,7 @@ export type AuditTrace = Message<"metalstack.api.v2.AuditTrace"> & { */ phase: AuditPhase; /** - * Meta for this audit trace + * Meta for this audit trace. * * @generated from field: metalstack.api.v2.Meta meta = 11; */ @@ -91,7 +91,7 @@ export declare const AuditTraceSchema: GenMessage; */ export type AuditQuery = Message<"metalstack.api.v2.AuditQuery"> & { /** - * Uuid of the audit trace + * Uuid of the audit trace. * * @generated from field: optional string uuid = 2; */ @@ -145,7 +145,7 @@ export type AuditQuery = Message<"metalstack.api.v2.AuditQuery"> & { */ body?: string | undefined; /** - * Limit is a number limiting the length of the response (min: 1, max: 1000, defaults to 200) + * Limit is a number limiting the length of the response (min: 1, max: 1000, defaults to 200). * * @generated from field: optional int32 limit = 11; */ @@ -169,7 +169,7 @@ export declare const AuditQuerySchema: GenMessage; */ export type AuditServiceListRequest = Message<"metalstack.api.v2.AuditServiceListRequest"> & { /** - * Login for this tenant + * Login for this tenant. * * @generated from field: string login = 1; */ @@ -211,13 +211,13 @@ export declare const AuditServiceListResponseSchema: GenMessage & { /** - * Login for this tenant + * Login for this tenant. * * @generated from field: string login = 1; */ login: string; /** - * Uuid of the audit trace + * Uuid of the audit trace. * * @generated from field: string uuid = 2; */ diff --git a/js/metalstack/api/v2/audit_pb.ts b/js/metalstack/api/v2/audit_pb.ts index 44d297f6..4ace809a 100644 --- a/js/metalstack/api/v2/audit_pb.ts +++ b/js/metalstack/api/v2/audit_pb.ts @@ -25,7 +25,7 @@ export const file_metalstack_api_v2_audit: GenFile = /*@__PURE__*/ */ export type AuditTrace = Message<"metalstack.api.v2.AuditTrace"> & { /** - * Uuid of the audit trace + * Uuid of the audit trace. * * @generated from field: string uuid = 1; */ @@ -95,7 +95,7 @@ export type AuditTrace = Message<"metalstack.api.v2.AuditTrace"> & { phase: AuditPhase; /** - * Meta for this audit trace + * Meta for this audit trace. * * @generated from field: metalstack.api.v2.Meta meta = 11; */ @@ -116,7 +116,7 @@ export const AuditTraceSchema: GenMessage = /*@__PURE__*/ */ export type AuditQuery = Message<"metalstack.api.v2.AuditQuery"> & { /** - * Uuid of the audit trace + * Uuid of the audit trace. * * @generated from field: optional string uuid = 2; */ @@ -179,7 +179,7 @@ export type AuditQuery = Message<"metalstack.api.v2.AuditQuery"> & { body?: string | undefined; /** - * Limit is a number limiting the length of the response (min: 1, max: 1000, defaults to 200) + * Limit is a number limiting the length of the response (min: 1, max: 1000, defaults to 200). * * @generated from field: optional int32 limit = 11; */ @@ -207,7 +207,7 @@ export const AuditQuerySchema: GenMessage = /*@__PURE__*/ */ export type AuditServiceListRequest = Message<"metalstack.api.v2.AuditServiceListRequest"> & { /** - * Login for this tenant + * Login for this tenant. * * @generated from field: string login = 1; */ @@ -256,14 +256,14 @@ export const AuditServiceListResponseSchema: GenMessage & { /** - * Login for this tenant + * Login for this tenant. * * @generated from field: string login = 1; */ login: string; /** - * Uuid of the audit trace + * Uuid of the audit trace. * * @generated from field: string uuid = 2; */ diff --git a/js/metalstack/api/v2/common_pb.d.ts b/js/metalstack/api/v2/common_pb.d.ts index 36426c6d..f867f646 100644 --- a/js/metalstack/api/v2/common_pb.d.ts +++ b/js/metalstack/api/v2/common_pb.d.ts @@ -12,7 +12,7 @@ export declare const file_metalstack_api_v2_common: GenFile; */ export type Paging = Message<"metalstack.api.v2.Paging"> & { /** - * Page is used for pagination, if unset only the first page is returned, + * Page is used for pagination, if unset only the first page is returned,. * the list response contains then the page number for the next page. * * @generated from field: optional uint64 page = 1; @@ -37,7 +37,7 @@ export declare const PagingSchema: GenMessage; */ export type Labels = Message<"metalstack.api.v2.Labels"> & { /** - * Labels consists labels + * Labels consists labels. * * @generated from field: map labels = 1; */ @@ -51,13 +51,13 @@ export type Labels = Message<"metalstack.api.v2.Labels"> & { */ export declare const LabelsSchema: GenMessage; /** - * Meta of a message + * Meta of a message. * * @generated from message metalstack.api.v2.Meta */ export type Meta = Message<"metalstack.api.v2.Meta"> & { /** - * Tags on this entity + * Tags on this entity. * * @generated from field: optional metalstack.api.v2.Labels labels = 1; */ @@ -70,7 +70,7 @@ export type Meta = Message<"metalstack.api.v2.Meta"> & { createdAt?: Timestamp | undefined; /** * UpdatedAt is the date when this entity was updated. - * must be part of the update request to ensure optimistic locking + * must be part of the update request to ensure optimistic locking. * * @generated from field: google.protobuf.Timestamp updated_at = 3; */ @@ -107,7 +107,7 @@ export type UpdateLabels = Message<"metalstack.api.v2.UpdateLabels"> & { */ strategy: { /** - * Replace existing labels with the given ones + * Replace existing labels with the given ones. * * @generated from field: metalstack.api.v2.Labels replace = 1; */ @@ -163,13 +163,13 @@ export declare const LabelsPatchSchema: GenMessage; export type UpdateMeta = Message<"metalstack.api.v2.UpdateMeta"> & { /** * UpdatedAt is the date when this entity was updated. - * must be part of the update request to ensure optimistic locking + * Must be part of the update request to ensure optimistic locking. * * @generated from field: google.protobuf.Timestamp updated_at = 1; */ updatedAt?: Timestamp | undefined; /** - * LockingStrategy to be used for this update request + * LockingStrategy to be used for this update request. * * @generated from field: metalstack.api.v2.OptimisticLockingStrategy locking_strategy = 2; */ @@ -193,25 +193,25 @@ export declare enum TenantRole { */ UNSPECIFIED = 0, /** - * TENANT_ROLE_OWNER the logged in user needs at least owner role to call this method + * TENANT_ROLE_OWNER the logged in user needs at least owner role to call this method. * * @generated from enum value: TENANT_ROLE_OWNER = 1; */ OWNER = 1, /** - * TENANT_ROLE_EDITOR the logged in user needs at least editor role to call this method + * TENANT_ROLE_EDITOR the logged in user needs at least editor role to call this method. * * @generated from enum value: TENANT_ROLE_EDITOR = 2; */ EDITOR = 2, /** - * TENANT_ROLE_VIEWER the logged in user needs at least viewer role to call this method + * TENANT_ROLE_VIEWER the logged in user needs at least viewer role to call this method. * * @generated from enum value: TENANT_ROLE_VIEWER = 3; */ VIEWER = 3, /** - * TENANT_ROLE_GUEST the logged in user needs at least guest role to call this method + * TENANT_ROLE_GUEST the logged in user needs at least guest role to call this method. * The guest role is assumed by users who are invited to a tenant's project without them. * having a direct membership within the tenant. * @@ -236,19 +236,19 @@ export declare enum ProjectRole { */ UNSPECIFIED = 0, /** - * PROJECT_ROLE_OWNER the logged in user needs at least owner role to call this method + * PROJECT_ROLE_OWNER the logged in user needs at least owner role to call this method. * * @generated from enum value: PROJECT_ROLE_OWNER = 1; */ OWNER = 1, /** - * PROJECT_ROLE_EDITOR the logged in user needs at least editor role to call this method + * PROJECT_ROLE_EDITOR the logged in user needs at least editor role to call this method. * * @generated from enum value: PROJECT_ROLE_EDITOR = 2; */ EDITOR = 2, /** - * PROJECT_ROLE_VIEWER the logged in user needs at least viewer role to call this method + * PROJECT_ROLE_VIEWER the logged in user needs at least viewer role to call this method. * * @generated from enum value: PROJECT_ROLE_VIEWER = 3; */ @@ -271,13 +271,13 @@ export declare enum AdminRole { */ UNSPECIFIED = 0, /** - * ADMIN_ROLE_EDITOR the logged in user needs at least editor role to call this method + * ADMIN_ROLE_EDITOR the logged in user needs at least editor role to call this method. * * @generated from enum value: ADMIN_ROLE_EDITOR = 1; */ EDITOR = 1, /** - * ADMIN_ROLE_VIEWER the logged in user needs at least viewer role to call this method + * ADMIN_ROLE_VIEWER the logged in user needs at least viewer role to call this method. * * @generated from enum value: ADMIN_ROLE_VIEWER = 2; */ @@ -300,13 +300,13 @@ export declare enum InfraRole { */ UNSPECIFIED = 0, /** - * INFRA_ROLE_EDITOR a microservice needs at least editor role to call this method + * INFRA_ROLE_EDITOR a microservice needs at least editor role to call this method. * * @generated from enum value: INFRA_ROLE_EDITOR = 1; */ EDITOR = 1, /** - * INFRA_ROLE_VIEWER a microservice needs at least viewer role to call this method + * INFRA_ROLE_VIEWER a microservice needs at least viewer role to call this method. * * @generated from enum value: INFRA_ROLE_VIEWER = 2; */ @@ -329,13 +329,13 @@ export declare enum MachineRole { */ UNSPECIFIED = 0, /** - * MACHINE_ROLE_EDITOR a microservice needs at least editor role to call this method + * MACHINE_ROLE_EDITOR a microservice needs at least editor role to call this method. * * @generated from enum value: MACHINE_ROLE_EDITOR = 1; */ EDITOR = 1, /** - * MACHINE_ROLE_VIEWER a microservice needs at least viewer role to call this method + * MACHINE_ROLE_VIEWER a microservice needs at least viewer role to call this method. * * @generated from enum value: MACHINE_ROLE_VIEWER = 2; */ @@ -346,7 +346,7 @@ export declare enum MachineRole { */ export declare const MachineRoleSchema: GenEnum; /** - * Visibility of a method + * Visibility of a method. * * @generated from enum metalstack.api.v2.Visibility */ @@ -364,7 +364,7 @@ export declare enum Visibility { */ PUBLIC = 1, /** - * VISIBILITY_SELF restricts calls to the authenticated user only + * VISIBILITY_SELF restricts calls to the authenticated user only. * * @generated from enum value: VISIBILITY_SELF = 2; */ @@ -375,9 +375,9 @@ export declare enum Visibility { */ export declare const VisibilitySchema: GenEnum; /** - * Auditing option specified per service method - * by default all service methods are included - * add the auditing option if you want to exclude a method in auditing + * Auditing option specified per service method. + * By default all service methods are included. + * Add the auditing option if you want to exclude a method in auditing. * * @generated from enum metalstack.api.v2.Auditing */ @@ -389,13 +389,13 @@ export declare enum Auditing { */ UNSPECIFIED = 0, /** - * AUDITING_INCLUDED if a method is annotated with this, all calls are audited + * AUDITING_INCLUDED if a method is annotated with this, all calls are audited. * * @generated from enum value: AUDITING_INCLUDED = 1; */ INCLUDED = 1, /** - * AUDITING_EXCLUDED if a method is annotated with this, no calls are audited + * AUDITING_EXCLUDED if a method is annotated with this, no calls are audited. * * @generated from enum value: AUDITING_EXCLUDED = 2; */ @@ -407,26 +407,26 @@ export declare enum Auditing { export declare const AuditingSchema: GenEnum; /** * OptimisticLockingStrategy defines how optimistic locking should be handled. - * It defaults to client side, which requires the UpdatedAt timestamp to be provided + * It defaults to client side, which requires the UpdatedAt timestamp to be provided. * * @generated from enum metalstack.api.v2.OptimisticLockingStrategy */ export declare enum OptimisticLockingStrategy { /** - * OPTIMISTIC_LOCKING_STRATEGY_UNSPECIFIED same as client side + * OPTIMISTIC_LOCKING_STRATEGY_UNSPECIFIED same as client side. * * @generated from enum value: OPTIMISTIC_LOCKING_STRATEGY_UNSPECIFIED = 0; */ UNSPECIFIED = 0, /** - * OPTIMISTIC_LOCKING_STRATEGY_CLIENT requires UpdatedAt to be specified + * OPTIMISTIC_LOCKING_STRATEGY_CLIENT requires UpdatedAt to be specified. * * @generated from enum value: OPTIMISTIC_LOCKING_STRATEGY_CLIENT = 1; */ CLIENT = 1, /** - * OPTIMISTIC_LOCKING_STRATEGY_SERVER allows to omit UpdatedAt - * and fetches the most recent entity before updating with the given values with the update request + * OPTIMISTIC_LOCKING_STRATEGY_SERVER allows to omit UpdatedAt. + * and fetches the most recent entity before updating with the given values with the update request. * * @generated from enum value: OPTIMISTIC_LOCKING_STRATEGY_SERVER = 2; */ @@ -479,7 +479,7 @@ export declare const infra_roles: GenExtension; */ export declare const machine_roles: GenExtension; /** - * StringValue which can be set to a enum + * StringValue which can be set to a enum. * * @generated from extension: string enum_string_value = 52000; */ diff --git a/js/metalstack/api/v2/common_pb.js b/js/metalstack/api/v2/common_pb.js index d1fcd234..9f834742 100644 --- a/js/metalstack/api/v2/common_pb.js +++ b/js/metalstack/api/v2/common_pb.js @@ -53,25 +53,25 @@ export var TenantRole; */ TenantRole[TenantRole["UNSPECIFIED"] = 0] = "UNSPECIFIED"; /** - * TENANT_ROLE_OWNER the logged in user needs at least owner role to call this method + * TENANT_ROLE_OWNER the logged in user needs at least owner role to call this method. * * @generated from enum value: TENANT_ROLE_OWNER = 1; */ TenantRole[TenantRole["OWNER"] = 1] = "OWNER"; /** - * TENANT_ROLE_EDITOR the logged in user needs at least editor role to call this method + * TENANT_ROLE_EDITOR the logged in user needs at least editor role to call this method. * * @generated from enum value: TENANT_ROLE_EDITOR = 2; */ TenantRole[TenantRole["EDITOR"] = 2] = "EDITOR"; /** - * TENANT_ROLE_VIEWER the logged in user needs at least viewer role to call this method + * TENANT_ROLE_VIEWER the logged in user needs at least viewer role to call this method. * * @generated from enum value: TENANT_ROLE_VIEWER = 3; */ TenantRole[TenantRole["VIEWER"] = 3] = "VIEWER"; /** - * TENANT_ROLE_GUEST the logged in user needs at least guest role to call this method + * TENANT_ROLE_GUEST the logged in user needs at least guest role to call this method. * The guest role is assumed by users who are invited to a tenant's project without them. * having a direct membership within the tenant. * @@ -97,19 +97,19 @@ export var ProjectRole; */ ProjectRole[ProjectRole["UNSPECIFIED"] = 0] = "UNSPECIFIED"; /** - * PROJECT_ROLE_OWNER the logged in user needs at least owner role to call this method + * PROJECT_ROLE_OWNER the logged in user needs at least owner role to call this method. * * @generated from enum value: PROJECT_ROLE_OWNER = 1; */ ProjectRole[ProjectRole["OWNER"] = 1] = "OWNER"; /** - * PROJECT_ROLE_EDITOR the logged in user needs at least editor role to call this method + * PROJECT_ROLE_EDITOR the logged in user needs at least editor role to call this method. * * @generated from enum value: PROJECT_ROLE_EDITOR = 2; */ ProjectRole[ProjectRole["EDITOR"] = 2] = "EDITOR"; /** - * PROJECT_ROLE_VIEWER the logged in user needs at least viewer role to call this method + * PROJECT_ROLE_VIEWER the logged in user needs at least viewer role to call this method. * * @generated from enum value: PROJECT_ROLE_VIEWER = 3; */ @@ -133,13 +133,13 @@ export var AdminRole; */ AdminRole[AdminRole["UNSPECIFIED"] = 0] = "UNSPECIFIED"; /** - * ADMIN_ROLE_EDITOR the logged in user needs at least editor role to call this method + * ADMIN_ROLE_EDITOR the logged in user needs at least editor role to call this method. * * @generated from enum value: ADMIN_ROLE_EDITOR = 1; */ AdminRole[AdminRole["EDITOR"] = 1] = "EDITOR"; /** - * ADMIN_ROLE_VIEWER the logged in user needs at least viewer role to call this method + * ADMIN_ROLE_VIEWER the logged in user needs at least viewer role to call this method. * * @generated from enum value: ADMIN_ROLE_VIEWER = 2; */ @@ -163,13 +163,13 @@ export var InfraRole; */ InfraRole[InfraRole["UNSPECIFIED"] = 0] = "UNSPECIFIED"; /** - * INFRA_ROLE_EDITOR a microservice needs at least editor role to call this method + * INFRA_ROLE_EDITOR a microservice needs at least editor role to call this method. * * @generated from enum value: INFRA_ROLE_EDITOR = 1; */ InfraRole[InfraRole["EDITOR"] = 1] = "EDITOR"; /** - * INFRA_ROLE_VIEWER a microservice needs at least viewer role to call this method + * INFRA_ROLE_VIEWER a microservice needs at least viewer role to call this method. * * @generated from enum value: INFRA_ROLE_VIEWER = 2; */ @@ -193,13 +193,13 @@ export var MachineRole; */ MachineRole[MachineRole["UNSPECIFIED"] = 0] = "UNSPECIFIED"; /** - * MACHINE_ROLE_EDITOR a microservice needs at least editor role to call this method + * MACHINE_ROLE_EDITOR a microservice needs at least editor role to call this method. * * @generated from enum value: MACHINE_ROLE_EDITOR = 1; */ MachineRole[MachineRole["EDITOR"] = 1] = "EDITOR"; /** - * MACHINE_ROLE_VIEWER a microservice needs at least viewer role to call this method + * MACHINE_ROLE_VIEWER a microservice needs at least viewer role to call this method. * * @generated from enum value: MACHINE_ROLE_VIEWER = 2; */ @@ -210,7 +210,7 @@ export var MachineRole; */ export const MachineRoleSchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_common, 4); /** - * Visibility of a method + * Visibility of a method. * * @generated from enum metalstack.api.v2.Visibility */ @@ -229,7 +229,7 @@ export var Visibility; */ Visibility[Visibility["PUBLIC"] = 1] = "PUBLIC"; /** - * VISIBILITY_SELF restricts calls to the authenticated user only + * VISIBILITY_SELF restricts calls to the authenticated user only. * * @generated from enum value: VISIBILITY_SELF = 2; */ @@ -240,9 +240,9 @@ export var Visibility; */ export const VisibilitySchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_common, 5); /** - * Auditing option specified per service method - * by default all service methods are included - * add the auditing option if you want to exclude a method in auditing + * Auditing option specified per service method. + * By default all service methods are included. + * Add the auditing option if you want to exclude a method in auditing. * * @generated from enum metalstack.api.v2.Auditing */ @@ -255,13 +255,13 @@ export var Auditing; */ Auditing[Auditing["UNSPECIFIED"] = 0] = "UNSPECIFIED"; /** - * AUDITING_INCLUDED if a method is annotated with this, all calls are audited + * AUDITING_INCLUDED if a method is annotated with this, all calls are audited. * * @generated from enum value: AUDITING_INCLUDED = 1; */ Auditing[Auditing["INCLUDED"] = 1] = "INCLUDED"; /** - * AUDITING_EXCLUDED if a method is annotated with this, no calls are audited + * AUDITING_EXCLUDED if a method is annotated with this, no calls are audited. * * @generated from enum value: AUDITING_EXCLUDED = 2; */ @@ -273,27 +273,27 @@ export var Auditing; export const AuditingSchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_common, 6); /** * OptimisticLockingStrategy defines how optimistic locking should be handled. - * It defaults to client side, which requires the UpdatedAt timestamp to be provided + * It defaults to client side, which requires the UpdatedAt timestamp to be provided. * * @generated from enum metalstack.api.v2.OptimisticLockingStrategy */ export var OptimisticLockingStrategy; (function (OptimisticLockingStrategy) { /** - * OPTIMISTIC_LOCKING_STRATEGY_UNSPECIFIED same as client side + * OPTIMISTIC_LOCKING_STRATEGY_UNSPECIFIED same as client side. * * @generated from enum value: OPTIMISTIC_LOCKING_STRATEGY_UNSPECIFIED = 0; */ OptimisticLockingStrategy[OptimisticLockingStrategy["UNSPECIFIED"] = 0] = "UNSPECIFIED"; /** - * OPTIMISTIC_LOCKING_STRATEGY_CLIENT requires UpdatedAt to be specified + * OPTIMISTIC_LOCKING_STRATEGY_CLIENT requires UpdatedAt to be specified. * * @generated from enum value: OPTIMISTIC_LOCKING_STRATEGY_CLIENT = 1; */ OptimisticLockingStrategy[OptimisticLockingStrategy["CLIENT"] = 1] = "CLIENT"; /** - * OPTIMISTIC_LOCKING_STRATEGY_SERVER allows to omit UpdatedAt - * and fetches the most recent entity before updating with the given values with the update request + * OPTIMISTIC_LOCKING_STRATEGY_SERVER allows to omit UpdatedAt. + * and fetches the most recent entity before updating with the given values with the update request. * * @generated from enum value: OPTIMISTIC_LOCKING_STRATEGY_SERVER = 2; */ @@ -346,7 +346,7 @@ export const infra_roles = /*@__PURE__*/ extDesc(file_metalstack_api_v2_common, */ export const machine_roles = /*@__PURE__*/ extDesc(file_metalstack_api_v2_common, 6); /** - * StringValue which can be set to a enum + * StringValue which can be set to a enum. * * @generated from extension: string enum_string_value = 52000; */ diff --git a/js/metalstack/api/v2/common_pb.ts b/js/metalstack/api/v2/common_pb.ts index 585f0a62..8b209cf3 100644 --- a/js/metalstack/api/v2/common_pb.ts +++ b/js/metalstack/api/v2/common_pb.ts @@ -23,7 +23,7 @@ export const file_metalstack_api_v2_common: GenFile = /*@__PURE__*/ */ export type Paging = Message<"metalstack.api.v2.Paging"> & { /** - * Page is used for pagination, if unset only the first page is returned, + * Page is used for pagination, if unset only the first page is returned,. * the list response contains then the page number for the next page. * * @generated from field: optional uint64 page = 1; @@ -52,7 +52,7 @@ export const PagingSchema: GenMessage = /*@__PURE__*/ */ export type Labels = Message<"metalstack.api.v2.Labels"> & { /** - * Labels consists labels + * Labels consists labels. * * @generated from field: map labels = 1; */ @@ -67,13 +67,13 @@ export const LabelsSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_common, 1); /** - * Meta of a message + * Meta of a message. * * @generated from message metalstack.api.v2.Meta */ export type Meta = Message<"metalstack.api.v2.Meta"> & { /** - * Tags on this entity + * Tags on this entity. * * @generated from field: optional metalstack.api.v2.Labels labels = 1; */ @@ -88,7 +88,7 @@ export type Meta = Message<"metalstack.api.v2.Meta"> & { /** * UpdatedAt is the date when this entity was updated. - * must be part of the update request to ensure optimistic locking + * must be part of the update request to ensure optimistic locking. * * @generated from field: google.protobuf.Timestamp updated_at = 3; */ @@ -130,7 +130,7 @@ export type UpdateLabels = Message<"metalstack.api.v2.UpdateLabels"> & { */ strategy: { /** - * Replace existing labels with the given ones + * Replace existing labels with the given ones. * * @generated from field: metalstack.api.v2.Labels replace = 1; */ @@ -190,14 +190,14 @@ export const LabelsPatchSchema: GenMessage = /*@__PURE__*/ export type UpdateMeta = Message<"metalstack.api.v2.UpdateMeta"> & { /** * UpdatedAt is the date when this entity was updated. - * must be part of the update request to ensure optimistic locking + * Must be part of the update request to ensure optimistic locking. * * @generated from field: google.protobuf.Timestamp updated_at = 1; */ updatedAt?: Timestamp | undefined; /** - * LockingStrategy to be used for this update request + * LockingStrategy to be used for this update request. * * @generated from field: metalstack.api.v2.OptimisticLockingStrategy locking_strategy = 2; */ @@ -225,28 +225,28 @@ export enum TenantRole { UNSPECIFIED = 0, /** - * TENANT_ROLE_OWNER the logged in user needs at least owner role to call this method + * TENANT_ROLE_OWNER the logged in user needs at least owner role to call this method. * * @generated from enum value: TENANT_ROLE_OWNER = 1; */ OWNER = 1, /** - * TENANT_ROLE_EDITOR the logged in user needs at least editor role to call this method + * TENANT_ROLE_EDITOR the logged in user needs at least editor role to call this method. * * @generated from enum value: TENANT_ROLE_EDITOR = 2; */ EDITOR = 2, /** - * TENANT_ROLE_VIEWER the logged in user needs at least viewer role to call this method + * TENANT_ROLE_VIEWER the logged in user needs at least viewer role to call this method. * * @generated from enum value: TENANT_ROLE_VIEWER = 3; */ VIEWER = 3, /** - * TENANT_ROLE_GUEST the logged in user needs at least guest role to call this method + * TENANT_ROLE_GUEST the logged in user needs at least guest role to call this method. * The guest role is assumed by users who are invited to a tenant's project without them. * having a direct membership within the tenant. * @@ -275,21 +275,21 @@ export enum ProjectRole { UNSPECIFIED = 0, /** - * PROJECT_ROLE_OWNER the logged in user needs at least owner role to call this method + * PROJECT_ROLE_OWNER the logged in user needs at least owner role to call this method. * * @generated from enum value: PROJECT_ROLE_OWNER = 1; */ OWNER = 1, /** - * PROJECT_ROLE_EDITOR the logged in user needs at least editor role to call this method + * PROJECT_ROLE_EDITOR the logged in user needs at least editor role to call this method. * * @generated from enum value: PROJECT_ROLE_EDITOR = 2; */ EDITOR = 2, /** - * PROJECT_ROLE_VIEWER the logged in user needs at least viewer role to call this method + * PROJECT_ROLE_VIEWER the logged in user needs at least viewer role to call this method. * * @generated from enum value: PROJECT_ROLE_VIEWER = 3; */ @@ -316,14 +316,14 @@ export enum AdminRole { UNSPECIFIED = 0, /** - * ADMIN_ROLE_EDITOR the logged in user needs at least editor role to call this method + * ADMIN_ROLE_EDITOR the logged in user needs at least editor role to call this method. * * @generated from enum value: ADMIN_ROLE_EDITOR = 1; */ EDITOR = 1, /** - * ADMIN_ROLE_VIEWER the logged in user needs at least viewer role to call this method + * ADMIN_ROLE_VIEWER the logged in user needs at least viewer role to call this method. * * @generated from enum value: ADMIN_ROLE_VIEWER = 2; */ @@ -350,14 +350,14 @@ export enum InfraRole { UNSPECIFIED = 0, /** - * INFRA_ROLE_EDITOR a microservice needs at least editor role to call this method + * INFRA_ROLE_EDITOR a microservice needs at least editor role to call this method. * * @generated from enum value: INFRA_ROLE_EDITOR = 1; */ EDITOR = 1, /** - * INFRA_ROLE_VIEWER a microservice needs at least viewer role to call this method + * INFRA_ROLE_VIEWER a microservice needs at least viewer role to call this method. * * @generated from enum value: INFRA_ROLE_VIEWER = 2; */ @@ -384,14 +384,14 @@ export enum MachineRole { UNSPECIFIED = 0, /** - * MACHINE_ROLE_EDITOR a microservice needs at least editor role to call this method + * MACHINE_ROLE_EDITOR a microservice needs at least editor role to call this method. * * @generated from enum value: MACHINE_ROLE_EDITOR = 1; */ EDITOR = 1, /** - * MACHINE_ROLE_VIEWER a microservice needs at least viewer role to call this method + * MACHINE_ROLE_VIEWER a microservice needs at least viewer role to call this method. * * @generated from enum value: MACHINE_ROLE_VIEWER = 2; */ @@ -405,7 +405,7 @@ export const MachineRoleSchema: GenEnum = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_common, 4); /** - * Visibility of a method + * Visibility of a method. * * @generated from enum metalstack.api.v2.Visibility */ @@ -425,7 +425,7 @@ export enum Visibility { PUBLIC = 1, /** - * VISIBILITY_SELF restricts calls to the authenticated user only + * VISIBILITY_SELF restricts calls to the authenticated user only. * * @generated from enum value: VISIBILITY_SELF = 2; */ @@ -439,9 +439,9 @@ export const VisibilitySchema: GenEnum = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_common, 5); /** - * Auditing option specified per service method - * by default all service methods are included - * add the auditing option if you want to exclude a method in auditing + * Auditing option specified per service method. + * By default all service methods are included. + * Add the auditing option if you want to exclude a method in auditing. * * @generated from enum metalstack.api.v2.Auditing */ @@ -454,14 +454,14 @@ export enum Auditing { UNSPECIFIED = 0, /** - * AUDITING_INCLUDED if a method is annotated with this, all calls are audited + * AUDITING_INCLUDED if a method is annotated with this, all calls are audited. * * @generated from enum value: AUDITING_INCLUDED = 1; */ INCLUDED = 1, /** - * AUDITING_EXCLUDED if a method is annotated with this, no calls are audited + * AUDITING_EXCLUDED if a method is annotated with this, no calls are audited. * * @generated from enum value: AUDITING_EXCLUDED = 2; */ @@ -476,28 +476,28 @@ export const AuditingSchema: GenEnum = /*@__PURE__*/ /** * OptimisticLockingStrategy defines how optimistic locking should be handled. - * It defaults to client side, which requires the UpdatedAt timestamp to be provided + * It defaults to client side, which requires the UpdatedAt timestamp to be provided. * * @generated from enum metalstack.api.v2.OptimisticLockingStrategy */ export enum OptimisticLockingStrategy { /** - * OPTIMISTIC_LOCKING_STRATEGY_UNSPECIFIED same as client side + * OPTIMISTIC_LOCKING_STRATEGY_UNSPECIFIED same as client side. * * @generated from enum value: OPTIMISTIC_LOCKING_STRATEGY_UNSPECIFIED = 0; */ UNSPECIFIED = 0, /** - * OPTIMISTIC_LOCKING_STRATEGY_CLIENT requires UpdatedAt to be specified + * OPTIMISTIC_LOCKING_STRATEGY_CLIENT requires UpdatedAt to be specified. * * @generated from enum value: OPTIMISTIC_LOCKING_STRATEGY_CLIENT = 1; */ CLIENT = 1, /** - * OPTIMISTIC_LOCKING_STRATEGY_SERVER allows to omit UpdatedAt - * and fetches the most recent entity before updating with the given values with the update request + * OPTIMISTIC_LOCKING_STRATEGY_SERVER allows to omit UpdatedAt. + * and fetches the most recent entity before updating with the given values with the update request. * * @generated from enum value: OPTIMISTIC_LOCKING_STRATEGY_SERVER = 2; */ @@ -567,7 +567,7 @@ export const machine_roles: GenExtension = /*@__PU extDesc(file_metalstack_api_v2_common, 6); /** - * StringValue which can be set to a enum + * StringValue which can be set to a enum. * * @generated from extension: string enum_string_value = 52000; */ diff --git a/js/metalstack/api/v2/component_pb.d.ts b/js/metalstack/api/v2/component_pb.d.ts index 5847a6d5..65086f4a 100644 --- a/js/metalstack/api/v2/component_pb.d.ts +++ b/js/metalstack/api/v2/component_pb.d.ts @@ -52,7 +52,7 @@ export type Component = Message<"metalstack.api.v2.Component"> & { */ interval?: Duration | undefined; /** - * Version of this service + * Version of this service. * * @generated from field: metalstack.api.v2.Version version = 7; */ @@ -64,7 +64,7 @@ export type Component = Message<"metalstack.api.v2.Component"> & { */ token?: Token | undefined; /** - * Meta for this component + * Meta for this component. * * @generated from field: metalstack.api.v2.Meta meta = 9; */ @@ -76,7 +76,7 @@ export type Component = Message<"metalstack.api.v2.Component"> & { */ export declare const ComponentSchema: GenMessage; /** - * ComponentQuery to query components + * ComponentQuery to query components. * * @generated from message metalstack.api.v2.ComponentQuery */ diff --git a/js/metalstack/api/v2/component_pb.ts b/js/metalstack/api/v2/component_pb.ts index b06225fa..8f451c08 100644 --- a/js/metalstack/api/v2/component_pb.ts +++ b/js/metalstack/api/v2/component_pb.ts @@ -72,7 +72,7 @@ export type Component = Message<"metalstack.api.v2.Component"> & { interval?: Duration | undefined; /** - * Version of this service + * Version of this service. * * @generated from field: metalstack.api.v2.Version version = 7; */ @@ -86,7 +86,7 @@ export type Component = Message<"metalstack.api.v2.Component"> & { token?: Token | undefined; /** - * Meta for this component + * Meta for this component. * * @generated from field: metalstack.api.v2.Meta meta = 9; */ @@ -101,7 +101,7 @@ export const ComponentSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_component, 0); /** - * ComponentQuery to query components + * ComponentQuery to query components. * * @generated from message metalstack.api.v2.ComponentQuery */ diff --git a/js/metalstack/api/v2/filesystem_pb.d.ts b/js/metalstack/api/v2/filesystem_pb.d.ts index b605aea9..10ca12c2 100644 --- a/js/metalstack/api/v2/filesystem_pb.d.ts +++ b/js/metalstack/api/v2/filesystem_pb.d.ts @@ -12,7 +12,7 @@ export declare const file_metalstack_api_v2_filesystem: GenFile; */ export type FilesystemServiceGetRequest = Message<"metalstack.api.v2.FilesystemServiceGetRequest"> & { /** - * ID of the filesystem to get + * ID of the filesystem to get. * * @generated from field: string id = 1; */ @@ -30,7 +30,7 @@ export declare const FilesystemServiceGetRequestSchema: GenMessage & { /** - * ID of the filesystem to get + * ID of the filesystem to get. * * @generated from field: optional string id = 1; */ @@ -48,7 +48,7 @@ export declare const FilesystemServiceListRequestSchema: GenMessage & { /** - * FilesystemLayout the filesystemlayout + * FilesystemLayout the filesystemlayout. * * @generated from field: metalstack.api.v2.FilesystemLayout filesystem_layout = 1; */ @@ -66,7 +66,7 @@ export declare const FilesystemServiceGetResponseSchema: GenMessage & { /** - * FilesystemLayouts the filesystemlayouts + * FilesystemLayouts the filesystemlayouts. * * @generated from field: repeated metalstack.api.v2.FilesystemLayout filesystem_layouts = 1; */ @@ -78,31 +78,31 @@ export type FilesystemServiceListResponse = Message<"metalstack.api.v2.Filesyste */ export declare const FilesystemServiceListResponseSchema: GenMessage; /** - * FilesystemLayout + * FilesystemLayout. * * @generated from message metalstack.api.v2.FilesystemLayout */ export type FilesystemLayout = Message<"metalstack.api.v2.FilesystemLayout"> & { /** - * Id of this filesystemLayout + * Id of this filesystemLayout. * * @generated from field: string id = 1; */ id: string; /** - * Meta for this filesystemLayout + * Meta for this filesystemLayout. * * @generated from field: metalstack.api.v2.Meta meta = 2; */ meta?: Meta | undefined; /** - * Name of this filesystemLayout + * Name of this filesystemLayout. * * @generated from field: optional string name = 3; */ name?: string | undefined; /** - * Description of this filesystemLayout + * Description of this filesystemLayout. * * @generated from field: optional string description = 4; */ @@ -120,7 +120,7 @@ export type FilesystemLayout = Message<"metalstack.api.v2.FilesystemLayout"> & { */ disks: Disk[]; /** - * raid arrays to create + * Raid arrays to create. * * @generated from field: repeated metalstack.api.v2.Raid raid = 7; */ @@ -138,7 +138,7 @@ export type FilesystemLayout = Message<"metalstack.api.v2.FilesystemLayout"> & { */ logicalVolumes: LogicalVolume[]; /** - * Constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts + * Constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts. * * @generated from field: metalstack.api.v2.FilesystemLayoutConstraints constraints = 10; */ @@ -150,24 +150,24 @@ export type FilesystemLayout = Message<"metalstack.api.v2.FilesystemLayout"> & { */ export declare const FilesystemLayoutSchema: GenMessage; /** - * FilesystemLayoutConstraints + * FilesystemLayoutConstraints. * * @generated from message metalstack.api.v2.FilesystemLayoutConstraints */ export type FilesystemLayoutConstraints = Message<"metalstack.api.v2.FilesystemLayoutConstraints"> & { /** * Sizes list of sizes this layout applies to. - * this could either be a concrete size, or a asterisk to match all sizes + * This could either be a concrete size, or a asterisk to match all sizes. * * @generated from field: repeated string sizes = 1; */ sizes: string[]; /** - * Images list of images this layout applies to in the following form. - * key must be the first part of available images, e.g. the name of the image - * value must be a semver match expression with the constraint and the version separated by space - * this would match all debian images which are greater or equal 12.0 - * "debian":">= 12.0" + * Images list of images this layout applies to in the following form: + * Key must be the first part of available images, e.g. the name of the imag. + * Value must be a semver match expression with the constraint and the version separated by space. + * This would match all debian images which are greater or equal 12: + * "debian": >= 12.0. * * @generated from field: map images = 2; */ @@ -181,55 +181,55 @@ export type FilesystemLayoutConstraints = Message<"metalstack.api.v2.FilesystemL */ export declare const FilesystemLayoutConstraintsSchema: GenMessage; /** - * Filesystem + * Filesystem. * * @generated from message metalstack.api.v2.Filesystem */ export type Filesystem = Message<"metalstack.api.v2.Filesystem"> & { /** - * Device the underlying device where this filesystem should be created + * Device the underlying device where this filesystem should be created. * * @generated from field: string device = 1; */ device: string; /** - * Format of the filesystem format + * Format of the filesystem format. * * @generated from field: metalstack.api.v2.Format format = 2; */ format: Format; /** - * Name of this filesystem + * Name of this filesystem. * * @generated from field: optional string name = 3; */ name?: string | undefined; /** - * Description of this filesystem + * Description of this filesystem. * * @generated from field: optional string description = 4; */ description?: string | undefined; /** - * Path the mountpoint where this filesystem should be mounted on + * Path the mountpoint where this filesystem should be mounted on. * * @generated from field: optional string path = 5; */ path?: string | undefined; /** - * Label an optional label for this filesystem + * Label an optional label for this filesystem. * * @generated from field: optional string label = 6; */ label?: string | undefined; /** - * MountOptions the options to use to mount this filesystem + * MountOptions the options to use to mount this filesystem. * * @generated from field: repeated string mount_options = 7; */ mountOptions: string[]; /** - * CreateOptions the options to use to create (mkfs) this filesystem + * CreateOptions the options to use to create (mkfs) this filesystem. * * @generated from field: repeated string create_options = 8; */ @@ -241,13 +241,13 @@ export type Filesystem = Message<"metalstack.api.v2.Filesystem"> & { */ export declare const FilesystemSchema: GenMessage; /** - * Disk + * Disk. * * @generated from message metalstack.api.v2.Disk */ export type Disk = Message<"metalstack.api.v2.Disk"> & { /** - * Device the device to create the partitions + * Device the device to create the partitions. * * @generated from field: string device = 1; */ @@ -265,13 +265,13 @@ export type Disk = Message<"metalstack.api.v2.Disk"> & { */ export declare const DiskSchema: GenMessage; /** - * Raid + * Raid. * * @generated from message metalstack.api.v2.Raid */ export type Raid = Message<"metalstack.api.v2.Raid"> & { /** - * ArrayName the name of the resulting array device + * ArrayName the name of the resulting array device. * * @generated from field: string array_name = 1; */ @@ -289,13 +289,13 @@ export type Raid = Message<"metalstack.api.v2.Raid"> & { */ level: RaidLevel; /** - * CreateOptions the options to use to create the raid array + * CreateOptions the options to use to create the raid array. * * @generated from field: repeated string create_options = 4; */ createOptions: string[]; /** - * Spares number of spares for the raid array + * Spares number of spares for the raid array. * * @generated from field: int32 spares = 5; */ @@ -307,7 +307,7 @@ export type Raid = Message<"metalstack.api.v2.Raid"> & { */ export declare const RaidSchema: GenMessage; /** - * DiskPartition + * DiskPartition. * * @generated from message metalstack.api.v2.DiskPartition */ @@ -319,19 +319,19 @@ export type DiskPartition = Message<"metalstack.api.v2.DiskPartition"> & { */ number: number; /** - * Label an optional label for this partition + * Label an optional label for this partition. * * @generated from field: optional string label = 2; */ label?: string | undefined; /** - * Size in mebibytes (MiB) of this partition + * Size in mebibytes (MiB) of this partition. * * @generated from field: uint64 size = 3; */ size: bigint; /** - * GPTType the gpt partition table type of this partition + * GPTType the gpt partition table type of this partition. * * @generated from field: optional metalstack.api.v2.GPTType gpt_type = 4; */ @@ -343,13 +343,13 @@ export type DiskPartition = Message<"metalstack.api.v2.DiskPartition"> & { */ export declare const DiskPartitionSchema: GenMessage; /** - * VolumeGroup + * VolumeGroup. * * @generated from message metalstack.api.v2.VolumeGroup */ export type VolumeGroup = Message<"metalstack.api.v2.VolumeGroup"> & { /** - * Name the name of the resulting volume group + * Name the name of the resulting volume group. * * @generated from field: string name = 1; */ @@ -373,31 +373,31 @@ export type VolumeGroup = Message<"metalstack.api.v2.VolumeGroup"> & { */ export declare const VolumeGroupSchema: GenMessage; /** - * LogicalVolume + * LogicalVolume. * * @generated from message metalstack.api.v2.LogicalVolume */ export type LogicalVolume = Message<"metalstack.api.v2.LogicalVolume"> & { /** - * Name the name of the logical volume + * Name the name of the logical volume. * * @generated from field: string name = 1; */ name: string; /** - * VolumeGroup the name of the volume group where to create the logical volume onto + * VolumeGroup the name of the volume group where to create the logical volume onto. * * @generated from field: string volume_group = 2; */ volumeGroup: string; /** - * Size size in mebibytes (MiB) of this volume + * Size size in mebibytes (MiB) of this volume. * * @generated from field: uint64 size = 3; */ size: bigint; /** - * LVMType the type of this logical volume can be either linear|striped|raid1 + * LVMType the type of this logical volume can be either linear|striped|raid1. * * @generated from field: metalstack.api.v2.LVMType lvm_type = 4; */ @@ -409,7 +409,7 @@ export type LogicalVolume = Message<"metalstack.api.v2.LogicalVolume"> & { */ export declare const LogicalVolumeSchema: GenMessage; /** - * LVMType + * LVMType. * * @generated from enum metalstack.api.v2.LVMType */ @@ -421,19 +421,19 @@ export declare enum LVMType { */ LVM_TYPE_UNSPECIFIED = 0, /** - * LVM_TYPE_LINEAR append across all physical volumes + * LVM_TYPE_LINEAR append across all physical volumes. * * @generated from enum value: LVM_TYPE_LINEAR = 1; */ LVM_TYPE_LINEAR = 1, /** - * LVM_TYPE_STRIPED stripe across all physical volumes + * LVM_TYPE_STRIPED stripe across all physical volumes. * * @generated from enum value: LVM_TYPE_STRIPED = 2; */ LVM_TYPE_STRIPED = 2, /** - * LVM_TYPE_RAID1 mirror with raid across all physical volumes + * LVM_TYPE_RAID1 mirror with raid across all physical volumes. * * @generated from enum value: LVM_TYPE_RAID1 = 3; */ @@ -450,7 +450,7 @@ export declare const LVMTypeSchema: GenEnum; */ export declare enum Format { /** - * FORMAT_UNSPECIFIED + * FORMAT_UNSPECIFIED. * * @generated from enum value: FORMAT_UNSPECIFIED = 0; */ @@ -486,7 +486,7 @@ export declare enum Format { */ TMPFS = 5, /** - * FORMAT_NONE + * FORMAT_NONE. * * @generated from enum value: FORMAT_NONE = 6; */ @@ -509,25 +509,25 @@ export declare enum GPTType { */ GPT_TYPE_UNSPECIFIED = 0, /** - * GPT_TYPE_BOOT EFI Boot Partition + * GPT_TYPE_BOOT EFI Boot Partition. * * @generated from enum value: GPT_TYPE_BOOT = 1; */ GPT_TYPE_BOOT = 1, /** - * GPT_TYPE_LINUX Linux Partition + * GPT_TYPE_LINUX Linux Partition. * * @generated from enum value: GPT_TYPE_LINUX = 2; */ GPT_TYPE_LINUX = 2, /** - * GPT_TYPE_LINUX_RAID Linux Raid Partition + * GPT_TYPE_LINUX_RAID Linux Raid Partition. * * @generated from enum value: GPT_TYPE_LINUX_RAID = 3; */ GPT_TYPE_LINUX_RAID = 3, /** - * GPT_TYPE_LINUX_LVM Linux LVM Partition + * GPT_TYPE_LINUX_LVM Linux LVM Partition. * * @generated from enum value: GPT_TYPE_LINUX_LVM = 4; */ diff --git a/js/metalstack/api/v2/filesystem_pb.js b/js/metalstack/api/v2/filesystem_pb.js index 41855d75..4e9797b7 100644 --- a/js/metalstack/api/v2/filesystem_pb.js +++ b/js/metalstack/api/v2/filesystem_pb.js @@ -70,7 +70,7 @@ export const VolumeGroupSchema = /*@__PURE__*/ messageDesc(file_metalstack_api_v */ export const LogicalVolumeSchema = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_filesystem, 11); /** - * LVMType + * LVMType. * * @generated from enum metalstack.api.v2.LVMType */ @@ -83,19 +83,19 @@ export var LVMType; */ LVMType[LVMType["LVM_TYPE_UNSPECIFIED"] = 0] = "LVM_TYPE_UNSPECIFIED"; /** - * LVM_TYPE_LINEAR append across all physical volumes + * LVM_TYPE_LINEAR append across all physical volumes. * * @generated from enum value: LVM_TYPE_LINEAR = 1; */ LVMType[LVMType["LVM_TYPE_LINEAR"] = 1] = "LVM_TYPE_LINEAR"; /** - * LVM_TYPE_STRIPED stripe across all physical volumes + * LVM_TYPE_STRIPED stripe across all physical volumes. * * @generated from enum value: LVM_TYPE_STRIPED = 2; */ LVMType[LVMType["LVM_TYPE_STRIPED"] = 2] = "LVM_TYPE_STRIPED"; /** - * LVM_TYPE_RAID1 mirror with raid across all physical volumes + * LVM_TYPE_RAID1 mirror with raid across all physical volumes. * * @generated from enum value: LVM_TYPE_RAID1 = 3; */ @@ -113,7 +113,7 @@ export const LVMTypeSchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_files export var Format; (function (Format) { /** - * FORMAT_UNSPECIFIED + * FORMAT_UNSPECIFIED. * * @generated from enum value: FORMAT_UNSPECIFIED = 0; */ @@ -149,7 +149,7 @@ export var Format; */ Format[Format["TMPFS"] = 5] = "TMPFS"; /** - * FORMAT_NONE + * FORMAT_NONE. * * @generated from enum value: FORMAT_NONE = 6; */ @@ -173,25 +173,25 @@ export var GPTType; */ GPTType[GPTType["GPT_TYPE_UNSPECIFIED"] = 0] = "GPT_TYPE_UNSPECIFIED"; /** - * GPT_TYPE_BOOT EFI Boot Partition + * GPT_TYPE_BOOT EFI Boot Partition. * * @generated from enum value: GPT_TYPE_BOOT = 1; */ GPTType[GPTType["GPT_TYPE_BOOT"] = 1] = "GPT_TYPE_BOOT"; /** - * GPT_TYPE_LINUX Linux Partition + * GPT_TYPE_LINUX Linux Partition. * * @generated from enum value: GPT_TYPE_LINUX = 2; */ GPTType[GPTType["GPT_TYPE_LINUX"] = 2] = "GPT_TYPE_LINUX"; /** - * GPT_TYPE_LINUX_RAID Linux Raid Partition + * GPT_TYPE_LINUX_RAID Linux Raid Partition. * * @generated from enum value: GPT_TYPE_LINUX_RAID = 3; */ GPTType[GPTType["GPT_TYPE_LINUX_RAID"] = 3] = "GPT_TYPE_LINUX_RAID"; /** - * GPT_TYPE_LINUX_LVM Linux LVM Partition + * GPT_TYPE_LINUX_LVM Linux LVM Partition. * * @generated from enum value: GPT_TYPE_LINUX_LVM = 4; */ diff --git a/js/metalstack/api/v2/filesystem_pb.ts b/js/metalstack/api/v2/filesystem_pb.ts index 4493af17..5da51dec 100644 --- a/js/metalstack/api/v2/filesystem_pb.ts +++ b/js/metalstack/api/v2/filesystem_pb.ts @@ -23,7 +23,7 @@ export const file_metalstack_api_v2_filesystem: GenFile = /*@__PURE__*/ */ export type FilesystemServiceGetRequest = Message<"metalstack.api.v2.FilesystemServiceGetRequest"> & { /** - * ID of the filesystem to get + * ID of the filesystem to get. * * @generated from field: string id = 1; */ @@ -44,7 +44,7 @@ export const FilesystemServiceGetRequestSchema: GenMessage & { /** - * ID of the filesystem to get + * ID of the filesystem to get. * * @generated from field: optional string id = 1; */ @@ -65,7 +65,7 @@ export const FilesystemServiceListRequestSchema: GenMessage & { /** - * FilesystemLayout the filesystemlayout + * FilesystemLayout the filesystemlayout. * * @generated from field: metalstack.api.v2.FilesystemLayout filesystem_layout = 1; */ @@ -86,7 +86,7 @@ export const FilesystemServiceGetResponseSchema: GenMessage & { /** - * FilesystemLayouts the filesystemlayouts + * FilesystemLayouts the filesystemlayouts. * * @generated from field: repeated metalstack.api.v2.FilesystemLayout filesystem_layouts = 1; */ @@ -101,34 +101,34 @@ export const FilesystemServiceListResponseSchema: GenMessage & { /** - * Id of this filesystemLayout + * Id of this filesystemLayout. * * @generated from field: string id = 1; */ id: string; /** - * Meta for this filesystemLayout + * Meta for this filesystemLayout. * * @generated from field: metalstack.api.v2.Meta meta = 2; */ meta?: Meta | undefined; /** - * Name of this filesystemLayout + * Name of this filesystemLayout. * * @generated from field: optional string name = 3; */ name?: string | undefined; /** - * Description of this filesystemLayout + * Description of this filesystemLayout. * * @generated from field: optional string description = 4; */ @@ -149,7 +149,7 @@ export type FilesystemLayout = Message<"metalstack.api.v2.FilesystemLayout"> & { disks: Disk[]; /** - * raid arrays to create + * Raid arrays to create. * * @generated from field: repeated metalstack.api.v2.Raid raid = 7; */ @@ -170,7 +170,7 @@ export type FilesystemLayout = Message<"metalstack.api.v2.FilesystemLayout"> & { logicalVolumes: LogicalVolume[]; /** - * Constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts + * Constraints which must match that this layout is taken, if sizes and images are empty these are develop layouts. * * @generated from field: metalstack.api.v2.FilesystemLayoutConstraints constraints = 10; */ @@ -185,25 +185,25 @@ export const FilesystemLayoutSchema: GenMessage = /*@__PURE__* messageDesc(file_metalstack_api_v2_filesystem, 4); /** - * FilesystemLayoutConstraints + * FilesystemLayoutConstraints. * * @generated from message metalstack.api.v2.FilesystemLayoutConstraints */ export type FilesystemLayoutConstraints = Message<"metalstack.api.v2.FilesystemLayoutConstraints"> & { /** * Sizes list of sizes this layout applies to. - * this could either be a concrete size, or a asterisk to match all sizes + * This could either be a concrete size, or a asterisk to match all sizes. * * @generated from field: repeated string sizes = 1; */ sizes: string[]; /** - * Images list of images this layout applies to in the following form. - * key must be the first part of available images, e.g. the name of the image - * value must be a semver match expression with the constraint and the version separated by space - * this would match all debian images which are greater or equal 12.0 - * "debian":">= 12.0" + * Images list of images this layout applies to in the following form: + * Key must be the first part of available images, e.g. the name of the imag. + * Value must be a semver match expression with the constraint and the version separated by space. + * This would match all debian images which are greater or equal 12: + * "debian": >= 12.0. * * @generated from field: map images = 2; */ @@ -218,62 +218,62 @@ export const FilesystemLayoutConstraintsSchema: GenMessage & { /** - * Device the underlying device where this filesystem should be created + * Device the underlying device where this filesystem should be created. * * @generated from field: string device = 1; */ device: string; /** - * Format of the filesystem format + * Format of the filesystem format. * * @generated from field: metalstack.api.v2.Format format = 2; */ format: Format; /** - * Name of this filesystem + * Name of this filesystem. * * @generated from field: optional string name = 3; */ name?: string | undefined; /** - * Description of this filesystem + * Description of this filesystem. * * @generated from field: optional string description = 4; */ description?: string | undefined; /** - * Path the mountpoint where this filesystem should be mounted on + * Path the mountpoint where this filesystem should be mounted on. * * @generated from field: optional string path = 5; */ path?: string | undefined; /** - * Label an optional label for this filesystem + * Label an optional label for this filesystem. * * @generated from field: optional string label = 6; */ label?: string | undefined; /** - * MountOptions the options to use to mount this filesystem + * MountOptions the options to use to mount this filesystem. * * @generated from field: repeated string mount_options = 7; */ mountOptions: string[]; /** - * CreateOptions the options to use to create (mkfs) this filesystem + * CreateOptions the options to use to create (mkfs) this filesystem. * * @generated from field: repeated string create_options = 8; */ @@ -288,13 +288,13 @@ export const FilesystemSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_filesystem, 6); /** - * Disk + * Disk. * * @generated from message metalstack.api.v2.Disk */ export type Disk = Message<"metalstack.api.v2.Disk"> & { /** - * Device the device to create the partitions + * Device the device to create the partitions. * * @generated from field: string device = 1; */ @@ -316,13 +316,13 @@ export const DiskSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_filesystem, 7); /** - * Raid + * Raid. * * @generated from message metalstack.api.v2.Raid */ export type Raid = Message<"metalstack.api.v2.Raid"> & { /** - * ArrayName the name of the resulting array device + * ArrayName the name of the resulting array device. * * @generated from field: string array_name = 1; */ @@ -343,14 +343,14 @@ export type Raid = Message<"metalstack.api.v2.Raid"> & { level: RaidLevel; /** - * CreateOptions the options to use to create the raid array + * CreateOptions the options to use to create the raid array. * * @generated from field: repeated string create_options = 4; */ createOptions: string[]; /** - * Spares number of spares for the raid array + * Spares number of spares for the raid array. * * @generated from field: int32 spares = 5; */ @@ -365,7 +365,7 @@ export const RaidSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_filesystem, 8); /** - * DiskPartition + * DiskPartition. * * @generated from message metalstack.api.v2.DiskPartition */ @@ -378,21 +378,21 @@ export type DiskPartition = Message<"metalstack.api.v2.DiskPartition"> & { number: number; /** - * Label an optional label for this partition + * Label an optional label for this partition. * * @generated from field: optional string label = 2; */ label?: string | undefined; /** - * Size in mebibytes (MiB) of this partition + * Size in mebibytes (MiB) of this partition. * * @generated from field: uint64 size = 3; */ size: bigint; /** - * GPTType the gpt partition table type of this partition + * GPTType the gpt partition table type of this partition. * * @generated from field: optional metalstack.api.v2.GPTType gpt_type = 4; */ @@ -407,13 +407,13 @@ export const DiskPartitionSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_filesystem, 9); /** - * VolumeGroup + * VolumeGroup. * * @generated from message metalstack.api.v2.VolumeGroup */ export type VolumeGroup = Message<"metalstack.api.v2.VolumeGroup"> & { /** - * Name the name of the resulting volume group + * Name the name of the resulting volume group. * * @generated from field: string name = 1; */ @@ -442,34 +442,34 @@ export const VolumeGroupSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_filesystem, 10); /** - * LogicalVolume + * LogicalVolume. * * @generated from message metalstack.api.v2.LogicalVolume */ export type LogicalVolume = Message<"metalstack.api.v2.LogicalVolume"> & { /** - * Name the name of the logical volume + * Name the name of the logical volume. * * @generated from field: string name = 1; */ name: string; /** - * VolumeGroup the name of the volume group where to create the logical volume onto + * VolumeGroup the name of the volume group where to create the logical volume onto. * * @generated from field: string volume_group = 2; */ volumeGroup: string; /** - * Size size in mebibytes (MiB) of this volume + * Size size in mebibytes (MiB) of this volume. * * @generated from field: uint64 size = 3; */ size: bigint; /** - * LVMType the type of this logical volume can be either linear|striped|raid1 + * LVMType the type of this logical volume can be either linear|striped|raid1. * * @generated from field: metalstack.api.v2.LVMType lvm_type = 4; */ @@ -484,7 +484,7 @@ export const LogicalVolumeSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_filesystem, 11); /** - * LVMType + * LVMType. * * @generated from enum metalstack.api.v2.LVMType */ @@ -497,21 +497,21 @@ export enum LVMType { LVM_TYPE_UNSPECIFIED = 0, /** - * LVM_TYPE_LINEAR append across all physical volumes + * LVM_TYPE_LINEAR append across all physical volumes. * * @generated from enum value: LVM_TYPE_LINEAR = 1; */ LVM_TYPE_LINEAR = 1, /** - * LVM_TYPE_STRIPED stripe across all physical volumes + * LVM_TYPE_STRIPED stripe across all physical volumes. * * @generated from enum value: LVM_TYPE_STRIPED = 2; */ LVM_TYPE_STRIPED = 2, /** - * LVM_TYPE_RAID1 mirror with raid across all physical volumes + * LVM_TYPE_RAID1 mirror with raid across all physical volumes. * * @generated from enum value: LVM_TYPE_RAID1 = 3; */ @@ -531,7 +531,7 @@ export const LVMTypeSchema: GenEnum = /*@__PURE__*/ */ export enum Format { /** - * FORMAT_UNSPECIFIED + * FORMAT_UNSPECIFIED. * * @generated from enum value: FORMAT_UNSPECIFIED = 0; */ @@ -573,7 +573,7 @@ export enum Format { TMPFS = 5, /** - * FORMAT_NONE + * FORMAT_NONE. * * @generated from enum value: FORMAT_NONE = 6; */ @@ -600,28 +600,28 @@ export enum GPTType { GPT_TYPE_UNSPECIFIED = 0, /** - * GPT_TYPE_BOOT EFI Boot Partition + * GPT_TYPE_BOOT EFI Boot Partition. * * @generated from enum value: GPT_TYPE_BOOT = 1; */ GPT_TYPE_BOOT = 1, /** - * GPT_TYPE_LINUX Linux Partition + * GPT_TYPE_LINUX Linux Partition. * * @generated from enum value: GPT_TYPE_LINUX = 2; */ GPT_TYPE_LINUX = 2, /** - * GPT_TYPE_LINUX_RAID Linux Raid Partition + * GPT_TYPE_LINUX_RAID Linux Raid Partition. * * @generated from enum value: GPT_TYPE_LINUX_RAID = 3; */ GPT_TYPE_LINUX_RAID = 3, /** - * GPT_TYPE_LINUX_LVM Linux LVM Partition + * GPT_TYPE_LINUX_LVM Linux LVM Partition. * * @generated from enum value: GPT_TYPE_LINUX_LVM = 4; */ diff --git a/js/metalstack/api/v2/health_pb.d.ts b/js/metalstack/api/v2/health_pb.d.ts index 5152f4ae..aab3125e 100644 --- a/js/metalstack/api/v2/health_pb.d.ts +++ b/js/metalstack/api/v2/health_pb.d.ts @@ -120,25 +120,25 @@ export declare const HealthServiceGetResponseSchema: GenMessage & { /** - * ID of the image to get + * ID of the image to get. * * @generated from field: string id = 1; */ @@ -49,14 +49,14 @@ export declare const ImageServiceListRequestSchema: GenMessage & { /** - * OS for which the latest image should be fetched - * should contain os and major.minor then latest patch version of this os is returned + * OS for which the latest image should be fetched. + * Should contain os and major.minor then latest patch version of this os is returned. * * @generated from field: string os = 1; */ os: string; /** - * Classification of the image latest image + * Classification of the image latest image. * * @generated from field: optional metalstack.api.v2.ImageClassification classification = 2; */ @@ -74,7 +74,7 @@ export declare const ImageServiceLatestRequestSchema: GenMessage & { /** - * Image the image + * Image the image. * * @generated from field: metalstack.api.v2.Image image = 1; */ @@ -92,7 +92,7 @@ export declare const ImageServiceGetResponseSchema: GenMessage & { /** - * Images the images + * Images the images. * * @generated from field: repeated metalstack.api.v2.Image images = 1; */ @@ -110,7 +110,7 @@ export declare const ImageServiceListResponseSchema: GenMessage & { /** - * Image which is the latest for one os + * Image which is the latest for one os. * * @generated from field: metalstack.api.v2.Image image = 1; */ @@ -122,49 +122,49 @@ export type ImageServiceLatestResponse = Message<"metalstack.api.v2.ImageService */ export declare const ImageServiceLatestResponseSchema: GenMessage; /** - * Image + * Image. * * @generated from message metalstack.api.v2.Image */ export type Image = Message<"metalstack.api.v2.Image"> & { /** - * Id of this image + * Id of this image. * * @generated from field: string id = 1; */ id: string; /** - * Meta for this image + * Meta for this image. * * @generated from field: metalstack.api.v2.Meta meta = 2; */ meta?: Meta | undefined; /** - * URL where this image is located + * URL where this image is located. * * @generated from field: string url = 3; */ url: string; /** - * Name of this image + * Name of this image. * * @generated from field: optional string name = 4; */ name?: string | undefined; /** - * Description of this image + * Description of this image. * * @generated from field: optional string description = 5; */ description?: string | undefined; /** - * Features of this image + * Features of this image. * * @generated from field: repeated metalstack.api.v2.ImageFeature features = 6; */ features: ImageFeature[]; /** - * Classification of this image + * Classification of this image. * * @generated from field: metalstack.api.v2.ImageClassification classification = 7; */ @@ -188,13 +188,13 @@ export declare const ImageSchema: GenMessage; */ export type ImageUsage = Message<"metalstack.api.v2.ImageUsage"> & { /** - * Image with usage + * Image with usage. * * @generated from field: metalstack.api.v2.Image image = 1; */ image?: Image | undefined; /** - * UsedBy the following machines/firewalls + * UsedBy the following machines/firewalls. * * @generated from field: repeated string used_by = 2; */ @@ -212,49 +212,49 @@ export declare const ImageUsageSchema: GenMessage; */ export type ImageQuery = Message<"metalstack.api.v2.ImageQuery"> & { /** - * ID of the image to get + * ID of the image to get. * * @generated from field: optional string id = 1; */ id?: string | undefined; /** - * OS of the image + * OS of the image. * * @generated from field: optional string os = 2; */ os?: string | undefined; /** - * Version of the Image + * Version of the Image. * * @generated from field: optional string version = 3; */ version?: string | undefined; /** - * Name of the image to query + * Name of the image to query. * * @generated from field: optional string name = 4; */ name?: string | undefined; /** - * Description of the image to query + * Description of the image to query. * * @generated from field: optional string description = 5; */ description?: string | undefined; /** - * Url of the image to query + * Url of the image to query. * * @generated from field: optional string url = 6; */ url?: string | undefined; /** - * Feature of the image to query + * Feature of the image to query. * * @generated from field: optional metalstack.api.v2.ImageFeature feature = 7; */ feature?: ImageFeature | undefined; /** - * Classification of the image to query + * Classification of the image to query. * * @generated from field: optional metalstack.api.v2.ImageClassification classification = 8; */ @@ -272,7 +272,7 @@ export type ImageQuery = Message<"metalstack.api.v2.ImageQuery"> & { */ export declare const ImageQuerySchema: GenMessage; /** - * ImageFeature + * ImageFeature. * * @generated from enum metalstack.api.v2.ImageFeature */ @@ -301,7 +301,7 @@ export declare enum ImageFeature { */ export declare const ImageFeatureSchema: GenEnum; /** - * Image + * Image. * * @generated from enum metalstack.api.v2.ImageClassification */ diff --git a/js/metalstack/api/v2/image_pb.js b/js/metalstack/api/v2/image_pb.js index 8d3f45bf..211ebd16 100644 --- a/js/metalstack/api/v2/image_pb.js +++ b/js/metalstack/api/v2/image_pb.js @@ -56,7 +56,7 @@ export const ImageUsageSchema = /*@__PURE__*/ messageDesc(file_metalstack_api_v2 */ export const ImageQuerySchema = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_image, 8); /** - * ImageFeature + * ImageFeature. * * @generated from enum metalstack.api.v2.ImageFeature */ @@ -86,7 +86,7 @@ export var ImageFeature; */ export const ImageFeatureSchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_image, 0); /** - * Image + * Image. * * @generated from enum metalstack.api.v2.ImageClassification */ diff --git a/js/metalstack/api/v2/image_pb.ts b/js/metalstack/api/v2/image_pb.ts index c509ceb6..cce3ef1b 100644 --- a/js/metalstack/api/v2/image_pb.ts +++ b/js/metalstack/api/v2/image_pb.ts @@ -25,7 +25,7 @@ export const file_metalstack_api_v2_image: GenFile = /*@__PURE__*/ */ export type ImageServiceGetRequest = Message<"metalstack.api.v2.ImageServiceGetRequest"> & { /** - * ID of the image to get + * ID of the image to get. * * @generated from field: string id = 1; */ @@ -67,15 +67,15 @@ export const ImageServiceListRequestSchema: GenMessage */ export type ImageServiceLatestRequest = Message<"metalstack.api.v2.ImageServiceLatestRequest"> & { /** - * OS for which the latest image should be fetched - * should contain os and major.minor then latest patch version of this os is returned + * OS for which the latest image should be fetched. + * Should contain os and major.minor then latest patch version of this os is returned. * * @generated from field: string os = 1; */ os: string; /** - * Classification of the image latest image + * Classification of the image latest image. * * @generated from field: optional metalstack.api.v2.ImageClassification classification = 2; */ @@ -96,7 +96,7 @@ export const ImageServiceLatestRequestSchema: GenMessage & { /** - * Image the image + * Image the image. * * @generated from field: metalstack.api.v2.Image image = 1; */ @@ -117,7 +117,7 @@ export const ImageServiceGetResponseSchema: GenMessage */ export type ImageServiceListResponse = Message<"metalstack.api.v2.ImageServiceListResponse"> & { /** - * Images the images + * Images the images. * * @generated from field: repeated metalstack.api.v2.Image images = 1; */ @@ -138,7 +138,7 @@ export const ImageServiceListResponseSchema: GenMessage & { /** - * Image which is the latest for one os + * Image which is the latest for one os. * * @generated from field: metalstack.api.v2.Image image = 1; */ @@ -153,55 +153,55 @@ export const ImageServiceLatestResponseSchema: GenMessage & { /** - * Id of this image + * Id of this image. * * @generated from field: string id = 1; */ id: string; /** - * Meta for this image + * Meta for this image. * * @generated from field: metalstack.api.v2.Meta meta = 2; */ meta?: Meta | undefined; /** - * URL where this image is located + * URL where this image is located. * * @generated from field: string url = 3; */ url: string; /** - * Name of this image + * Name of this image. * * @generated from field: optional string name = 4; */ name?: string | undefined; /** - * Description of this image + * Description of this image. * * @generated from field: optional string description = 5; */ description?: string | undefined; /** - * Features of this image + * Features of this image. * * @generated from field: repeated metalstack.api.v2.ImageFeature features = 6; */ features: ImageFeature[]; /** - * Classification of this image + * Classification of this image. * * @generated from field: metalstack.api.v2.ImageClassification classification = 7; */ @@ -229,14 +229,14 @@ export const ImageSchema: GenMessage = /*@__PURE__*/ */ export type ImageUsage = Message<"metalstack.api.v2.ImageUsage"> & { /** - * Image with usage + * Image with usage. * * @generated from field: metalstack.api.v2.Image image = 1; */ image?: Image | undefined; /** - * UsedBy the following machines/firewalls + * UsedBy the following machines/firewalls. * * @generated from field: repeated string used_by = 2; */ @@ -257,56 +257,56 @@ export const ImageUsageSchema: GenMessage = /*@__PURE__*/ */ export type ImageQuery = Message<"metalstack.api.v2.ImageQuery"> & { /** - * ID of the image to get + * ID of the image to get. * * @generated from field: optional string id = 1; */ id?: string | undefined; /** - * OS of the image + * OS of the image. * * @generated from field: optional string os = 2; */ os?: string | undefined; /** - * Version of the Image + * Version of the Image. * * @generated from field: optional string version = 3; */ version?: string | undefined; /** - * Name of the image to query + * Name of the image to query. * * @generated from field: optional string name = 4; */ name?: string | undefined; /** - * Description of the image to query + * Description of the image to query. * * @generated from field: optional string description = 5; */ description?: string | undefined; /** - * Url of the image to query + * Url of the image to query. * * @generated from field: optional string url = 6; */ url?: string | undefined; /** - * Feature of the image to query + * Feature of the image to query. * * @generated from field: optional metalstack.api.v2.ImageFeature feature = 7; */ feature?: ImageFeature | undefined; /** - * Classification of the image to query + * Classification of the image to query. * * @generated from field: optional metalstack.api.v2.ImageClassification classification = 8; */ @@ -328,7 +328,7 @@ export const ImageQuerySchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_image, 8); /** - * ImageFeature + * ImageFeature. * * @generated from enum metalstack.api.v2.ImageFeature */ @@ -362,7 +362,7 @@ export const ImageFeatureSchema: GenEnum = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_image, 0); /** - * Image + * Image. * * @generated from enum metalstack.api.v2.ImageClassification */ diff --git a/js/metalstack/api/v2/ip_pb.d.ts b/js/metalstack/api/v2/ip_pb.d.ts index 03f70edb..cc9c3cae 100644 --- a/js/metalstack/api/v2/ip_pb.d.ts +++ b/js/metalstack/api/v2/ip_pb.d.ts @@ -12,13 +12,13 @@ export declare const file_metalstack_api_v2_ip: GenFile; */ export type IP = Message<"metalstack.api.v2.IP"> & { /** - * Uuid of this ip + * Uuid of this ip. * * @generated from field: string uuid = 1; */ uuid: string; /** - * Meta for this ip + * Meta for this ip. * * @generated from field: metalstack.api.v2.Meta meta = 2; */ @@ -30,13 +30,13 @@ export type IP = Message<"metalstack.api.v2.IP"> & { */ ip: string; /** - * Name of this ip + * Name of this ip. * * @generated from field: string name = 4; */ name: string; /** - * Description of this ip + * Description of this ip. * * @generated from field: string description = 5; */ @@ -54,14 +54,14 @@ export type IP = Message<"metalstack.api.v2.IP"> & { */ project: string; /** - * Type of this ip + * Type of this ip. * * @generated from field: metalstack.api.v2.IPType type = 8; */ type: IPType; /** * Namespace if specified this ip is from a namespaced network and can therefore overlap with others. - * Will be equal with project most of the time + * Will be equal with project most of the time. * * @generated from field: optional string namespace = 9; */ @@ -79,13 +79,13 @@ export declare const IPSchema: GenMessage; */ export type IPServiceGetRequest = Message<"metalstack.api.v2.IPServiceGetRequest"> & { /** - * IP of the ip to get + * IP of the ip to get. * * @generated from field: string ip = 1; */ ip: string; /** - * Project of the ip + * Project of the ip. * * @generated from field: string project = 2; */ @@ -115,49 +115,49 @@ export type IPServiceCreateRequest = Message<"metalstack.api.v2.IPServiceCreateR */ network: string; /** - * Project of the ip + * Project of the ip. * * @generated from field: string project = 2; */ project: string; /** - * Name of the ip + * Name of the ip. * * @generated from field: optional string name = 3; */ name?: string | undefined; /** - * Description of the ip + * Description of the ip. * * @generated from field: optional string description = 4; */ description?: string | undefined; /** - * IP if given try to create this ip if still available + * IP if given try to create this ip if still available. * * @generated from field: optional string ip = 5; */ ip?: string | undefined; /** - * Machine for which this ip should get created + * Machine for which this ip should get created. * * @generated from field: optional string machine = 6; */ machine?: string | undefined; /** - * Labels to put onto the ip + * Labels to put onto the ip. * * @generated from field: optional metalstack.api.v2.Labels labels = 7; */ labels?: Labels | undefined; /** - * Type of the IP, ether ephemeral (default), or static + * Type of the IP, ether ephemeral (default), or static. * * @generated from field: optional metalstack.api.v2.IPType type = 8; */ type?: IPType | undefined; /** - * Addressfamily of the IP to create, defaults to ipv4 + * Addressfamily of the IP to create, defaults to ipv4. * * @generated from field: optional metalstack.api.v2.IPAddressFamily address_family = 9; */ @@ -175,7 +175,7 @@ export declare const IPServiceCreateRequestSchema: GenMessage & { /** - * Ip the ip address to update + * Ip the ip address to update. * * @generated from field: string ip = 1; */ @@ -187,31 +187,31 @@ export type IPServiceUpdateRequest = Message<"metalstack.api.v2.IPServiceUpdateR */ updateMeta?: UpdateMeta | undefined; /** - * Project id of the ip + * Project id of the ip. * * @generated from field: string project = 3; */ project: string; /** - * Name of this ip + * Name of this ip. * * @generated from field: optional string name = 4; */ name?: string | undefined; /** - * Description of this ip + * Description of this ip. * * @generated from field: optional string description = 5; */ description?: string | undefined; /** - * Type of this ip + * Type of this ip. * * @generated from field: optional metalstack.api.v2.IPType type = 6; */ type?: IPType | undefined; /** - * Labels on this ip + * Labels on this ip. * * @generated from field: optional metalstack.api.v2.UpdateLabels labels = 7; */ @@ -229,7 +229,7 @@ export declare const IPServiceUpdateRequestSchema: GenMessage & { /** - * Project of the ips to list + * Project of the ips to list. * * @generated from field: string project = 1; */ @@ -253,7 +253,7 @@ export declare const IPServiceListRequestSchema: GenMessage & { /** - * Ip the ip to list + * Ip the ip to list. * * @generated from field: optional string ip = 1; */ @@ -265,37 +265,37 @@ export type IPQuery = Message<"metalstack.api.v2.IPQuery"> & { */ network?: string | undefined; /** - * Project of the ips to list + * Project of the ips to list. * * @generated from field: optional string project = 3; */ project?: string | undefined; /** - * Name of this ip + * Name of this ip. * * @generated from field: optional string name = 4; */ name?: string | undefined; /** - * UUID for which these IPs should be filtered + * UUID for which these IPs should be filtered. * * @generated from field: optional string uuid = 5; */ uuid?: string | undefined; /** - * Machine for which these IPs should be filtered + * Machine for which these IPs should be filtered. * * @generated from field: optional string machine = 6; */ machine?: string | undefined; /** - * ParentPrefixCidr for which this ips should get filtered + * ParentPrefixCidr for which this ips should get filtered. * * @generated from field: optional string parent_prefix_cidr = 7; */ parentPrefixCidr?: string | undefined; /** - * Labels for which these IPs should be filtered + * Labels for which these IPs should be filtered. * * @generated from field: optional metalstack.api.v2.Labels labels = 8; */ @@ -331,13 +331,13 @@ export declare const IPQuerySchema: GenMessage; */ export type IPServiceDeleteRequest = Message<"metalstack.api.v2.IPServiceDeleteRequest"> & { /** - * IP of the ip to delete + * IP of the ip to delete. * * @generated from field: string ip = 1; */ ip: string; /** - * Project of the ip + * Project of the ip. * * @generated from field: string project = 2; */ @@ -355,7 +355,7 @@ export declare const IPServiceDeleteRequestSchema: GenMessage & { /** - * Ip the ip + * Ip the ip. * * @generated from field: metalstack.api.v2.IP ip = 1; */ @@ -373,7 +373,7 @@ export declare const IPServiceGetResponseSchema: GenMessage & { /** - * Ip the ip + * Ip the ip. * * @generated from field: metalstack.api.v2.IP ip = 1; */ @@ -391,7 +391,7 @@ export declare const IPServiceUpdateResponseSchema: GenMessage & { /** - * Ip the ip + * Ip the ip. * * @generated from field: metalstack.api.v2.IP ip = 1; */ @@ -409,7 +409,7 @@ export declare const IPServiceCreateResponseSchema: GenMessage & { /** - * Ips the ips + * Ips the ips. * * @generated from field: repeated metalstack.api.v2.IP ips = 1; */ @@ -427,7 +427,7 @@ export declare const IPServiceListResponseSchema: GenMessage & { /** - * Ip the ip + * Ip the ip. * * @generated from field: metalstack.api.v2.IP ip = 1; */ diff --git a/js/metalstack/api/v2/ip_pb.ts b/js/metalstack/api/v2/ip_pb.ts index aa7836c8..89ae10d4 100644 --- a/js/metalstack/api/v2/ip_pb.ts +++ b/js/metalstack/api/v2/ip_pb.ts @@ -23,14 +23,14 @@ export const file_metalstack_api_v2_ip: GenFile = /*@__PURE__*/ */ export type IP = Message<"metalstack.api.v2.IP"> & { /** - * Uuid of this ip + * Uuid of this ip. * * @generated from field: string uuid = 1; */ uuid: string; /** - * Meta for this ip + * Meta for this ip. * * @generated from field: metalstack.api.v2.Meta meta = 2; */ @@ -44,14 +44,14 @@ export type IP = Message<"metalstack.api.v2.IP"> & { ip: string; /** - * Name of this ip + * Name of this ip. * * @generated from field: string name = 4; */ name: string; /** - * Description of this ip + * Description of this ip. * * @generated from field: string description = 5; */ @@ -72,7 +72,7 @@ export type IP = Message<"metalstack.api.v2.IP"> & { project: string; /** - * Type of this ip + * Type of this ip. * * @generated from field: metalstack.api.v2.IPType type = 8; */ @@ -80,7 +80,7 @@ export type IP = Message<"metalstack.api.v2.IP"> & { /** * Namespace if specified this ip is from a namespaced network and can therefore overlap with others. - * Will be equal with project most of the time + * Will be equal with project most of the time. * * @generated from field: optional string namespace = 9; */ @@ -101,14 +101,14 @@ export const IPSchema: GenMessage = /*@__PURE__*/ */ export type IPServiceGetRequest = Message<"metalstack.api.v2.IPServiceGetRequest"> & { /** - * IP of the ip to get + * IP of the ip to get. * * @generated from field: string ip = 1; */ ip: string; /** - * Project of the ip + * Project of the ip. * * @generated from field: string project = 2; */ @@ -143,56 +143,56 @@ export type IPServiceCreateRequest = Message<"metalstack.api.v2.IPServiceCreateR network: string; /** - * Project of the ip + * Project of the ip. * * @generated from field: string project = 2; */ project: string; /** - * Name of the ip + * Name of the ip. * * @generated from field: optional string name = 3; */ name?: string | undefined; /** - * Description of the ip + * Description of the ip. * * @generated from field: optional string description = 4; */ description?: string | undefined; /** - * IP if given try to create this ip if still available + * IP if given try to create this ip if still available. * * @generated from field: optional string ip = 5; */ ip?: string | undefined; /** - * Machine for which this ip should get created + * Machine for which this ip should get created. * * @generated from field: optional string machine = 6; */ machine?: string | undefined; /** - * Labels to put onto the ip + * Labels to put onto the ip. * * @generated from field: optional metalstack.api.v2.Labels labels = 7; */ labels?: Labels | undefined; /** - * Type of the IP, ether ephemeral (default), or static + * Type of the IP, ether ephemeral (default), or static. * * @generated from field: optional metalstack.api.v2.IPType type = 8; */ type?: IPType | undefined; /** - * Addressfamily of the IP to create, defaults to ipv4 + * Addressfamily of the IP to create, defaults to ipv4. * * @generated from field: optional metalstack.api.v2.IPAddressFamily address_family = 9; */ @@ -213,7 +213,7 @@ export const IPServiceCreateRequestSchema: GenMessage = */ export type IPServiceUpdateRequest = Message<"metalstack.api.v2.IPServiceUpdateRequest"> & { /** - * Ip the ip address to update + * Ip the ip address to update. * * @generated from field: string ip = 1; */ @@ -227,35 +227,35 @@ export type IPServiceUpdateRequest = Message<"metalstack.api.v2.IPServiceUpdateR updateMeta?: UpdateMeta | undefined; /** - * Project id of the ip + * Project id of the ip. * * @generated from field: string project = 3; */ project: string; /** - * Name of this ip + * Name of this ip. * * @generated from field: optional string name = 4; */ name?: string | undefined; /** - * Description of this ip + * Description of this ip. * * @generated from field: optional string description = 5; */ description?: string | undefined; /** - * Type of this ip + * Type of this ip. * * @generated from field: optional metalstack.api.v2.IPType type = 6; */ type?: IPType | undefined; /** - * Labels on this ip + * Labels on this ip. * * @generated from field: optional metalstack.api.v2.UpdateLabels labels = 7; */ @@ -276,7 +276,7 @@ export const IPServiceUpdateRequestSchema: GenMessage = */ export type IPServiceListRequest = Message<"metalstack.api.v2.IPServiceListRequest"> & { /** - * Project of the ips to list + * Project of the ips to list. * * @generated from field: string project = 1; */ @@ -304,7 +304,7 @@ export const IPServiceListRequestSchema: GenMessage = /*@_ */ export type IPQuery = Message<"metalstack.api.v2.IPQuery"> & { /** - * Ip the ip to list + * Ip the ip to list. * * @generated from field: optional string ip = 1; */ @@ -318,42 +318,42 @@ export type IPQuery = Message<"metalstack.api.v2.IPQuery"> & { network?: string | undefined; /** - * Project of the ips to list + * Project of the ips to list. * * @generated from field: optional string project = 3; */ project?: string | undefined; /** - * Name of this ip + * Name of this ip. * * @generated from field: optional string name = 4; */ name?: string | undefined; /** - * UUID for which these IPs should be filtered + * UUID for which these IPs should be filtered. * * @generated from field: optional string uuid = 5; */ uuid?: string | undefined; /** - * Machine for which these IPs should be filtered + * Machine for which these IPs should be filtered. * * @generated from field: optional string machine = 6; */ machine?: string | undefined; /** - * ParentPrefixCidr for which this ips should get filtered + * ParentPrefixCidr for which this ips should get filtered. * * @generated from field: optional string parent_prefix_cidr = 7; */ parentPrefixCidr?: string | undefined; /** - * Labels for which these IPs should be filtered + * Labels for which these IPs should be filtered. * * @generated from field: optional metalstack.api.v2.Labels labels = 8; */ @@ -395,14 +395,14 @@ export const IPQuerySchema: GenMessage = /*@__PURE__*/ */ export type IPServiceDeleteRequest = Message<"metalstack.api.v2.IPServiceDeleteRequest"> & { /** - * IP of the ip to delete + * IP of the ip to delete. * * @generated from field: string ip = 1; */ ip: string; /** - * Project of the ip + * Project of the ip. * * @generated from field: string project = 2; */ @@ -423,7 +423,7 @@ export const IPServiceDeleteRequestSchema: GenMessage = */ export type IPServiceGetResponse = Message<"metalstack.api.v2.IPServiceGetResponse"> & { /** - * Ip the ip + * Ip the ip. * * @generated from field: metalstack.api.v2.IP ip = 1; */ @@ -444,7 +444,7 @@ export const IPServiceGetResponseSchema: GenMessage = /*@_ */ export type IPServiceUpdateResponse = Message<"metalstack.api.v2.IPServiceUpdateResponse"> & { /** - * Ip the ip + * Ip the ip. * * @generated from field: metalstack.api.v2.IP ip = 1; */ @@ -465,7 +465,7 @@ export const IPServiceUpdateResponseSchema: GenMessage */ export type IPServiceCreateResponse = Message<"metalstack.api.v2.IPServiceCreateResponse"> & { /** - * Ip the ip + * Ip the ip. * * @generated from field: metalstack.api.v2.IP ip = 1; */ @@ -486,7 +486,7 @@ export const IPServiceCreateResponseSchema: GenMessage */ export type IPServiceListResponse = Message<"metalstack.api.v2.IPServiceListResponse"> & { /** - * Ips the ips + * Ips the ips. * * @generated from field: repeated metalstack.api.v2.IP ips = 1; */ @@ -507,7 +507,7 @@ export const IPServiceListResponseSchema: GenMessage = /* */ export type IPServiceDeleteResponse = Message<"metalstack.api.v2.IPServiceDeleteResponse"> & { /** - * Ip the ip + * Ip the ip. * * @generated from field: metalstack.api.v2.IP ip = 1; */ diff --git a/js/metalstack/api/v2/machine_pb.d.ts b/js/metalstack/api/v2/machine_pb.d.ts index 40c54a65..21599846 100644 --- a/js/metalstack/api/v2/machine_pb.d.ts +++ b/js/metalstack/api/v2/machine_pb.d.ts @@ -18,13 +18,13 @@ export declare const file_metalstack_api_v2_machine: GenFile; */ export type MachineServiceGetRequest = Message<"metalstack.api.v2.MachineServiceGetRequest"> & { /** - * UUID of the machine to get + * UUID of the machine to get. * * @generated from field: string uuid = 1; */ uuid: string; /** - * Project of the machine + * Project of the machine. * * @generated from field: string project = 2; */ @@ -60,7 +60,7 @@ export declare const MachineServiceGetResponseSchema: GenMessage & { /** - * Project of the machine + * Project of the machine. * * @generated from field: string project = 1; */ @@ -68,57 +68,57 @@ export type MachineServiceCreateRequest = Message<"metalstack.api.v2.MachineServ /** * UUID if this field is set, this specific machine will be allocated if it is not in available state and not currently allocated. * this field takes precedence over size and partition. - * Can only be used with ADMIN_ROLE_EDITOR + * Can only be used with ADMIN_ROLE_EDITOR. * * @generated from field: optional string uuid = 2; */ uuid?: string | undefined; /** - * Name of this machine + * Name of this machine. * * @generated from field: string name = 3; */ name: string; /** - * Description for this machine + * Description for this machine. * * @generated from field: optional string description = 4; */ description?: string | undefined; /** - * Hostname the hostname for the allocated machine (defaults to metal) + * Hostname the hostname for the allocated machine (defaults to metal). * * @generated from field: optional string hostname = 5; */ hostname?: string | undefined; /** - * Partition the partition id to assign this machine to, must be omitted if uuid is given + * Partition the partition id to assign this machine to, must be omitted if uuid is given. * * @generated from field: optional string partition = 6; */ partition?: string | undefined; /** - * Size of the machine to create, must be omitted if uuid is given + * Size of the machine to create, must be omitted if uuid is given. * * @generated from field: optional string size = 7; */ size?: string | undefined; /** - * Image which should be installed on this machine - * The image can be specified either in the fully qualified form, e.g. including os, major, minor and patch. - * - debian-13.0.20260402 - * or in a simplified form which omits the patch version - * - debian-13.0 - * If the fully qualified form is specified, exactly this image is taken regardless of the image classification - * if the short form is given, only the most recent images which has image classification supported is used. + * Image which should be installed on this machine. + * The image can be specified either in the fully qualified form, e.g. including os, major, minor and patch + * - debian-13.0.2026040 + * - or in a simplified form which omits the patch version. + * - debian-13. + * If the fully qualified form is specified, exactly this image is taken regardless of the image classification. + * If the short form is given, only the most recent images which has image classification supported is used. * * @generated from field: string image = 8; */ image: string; /** - * FilesystemLayout which should be applied for the operating system installation + * FilesystemLayout which should be applied for the operating system installation. * Is defaulted by a lookup at the available fsls for this size and image. - * Can be specified to test new fsls during development of fsls + * Can be specified to test new fsls during development of fsls. * * @generated from field: optional string filesystem_layout = 9; */ @@ -131,13 +131,13 @@ export type MachineServiceCreateRequest = Message<"metalstack.api.v2.MachineServ sshPublicKeys: string[]; /** * Userdata contains instructions required to bootstrap the machine. - * AWS limits the max userdata size to 16k, lets allow twice as much + * AWS limits the max userdata size to 16k, lets allow twice as much. * * @generated from field: optional string userdata = 11; */ userdata?: string | undefined; /** - * Labels to be attached to this machine allocation + * Labels to be attached to this machine allocation. * * @generated from field: metalstack.api.v2.Labels labels = 12; */ @@ -150,25 +150,25 @@ export type MachineServiceCreateRequest = Message<"metalstack.api.v2.MachineServ networks: MachineAllocationNetwork[]; /** * PlacementTags by default machines are spread across the racks inside a partition for every project. - * if placement tags are provided, the machine candidate has an additional anti-affinity to other machines having the same tags + * if placement tags are provided, the machine candidate has an additional anti-affinity to other machines having the same tags. * * @generated from field: repeated string placement_tags = 14; */ placementTags: string[]; /** - * DNSServer the dns servers used for the machine + * DNSServer the dns servers used for the machine. * * @generated from field: repeated metalstack.api.v2.DNSServer dns_servers = 15; */ dnsServers: DNSServer[]; /** - * NTPServer the ntp servers used for the machine + * NTPServer the ntp servers used for the machine. * * @generated from field: repeated metalstack.api.v2.NTPServer ntp_servers = 16; */ ntpServers: NTPServer[]; /** - * AllocationType of this machine + * AllocationType of this machine. * * @generated from field: metalstack.api.v2.MachineAllocationType allocation_type = 17; */ @@ -192,7 +192,7 @@ export declare const MachineServiceCreateRequestSchema: GenMessage & { /** - * FirewallRules to be applied if this is a firewall + * FirewallRules to be applied if this is a firewall. * * @generated from field: metalstack.api.v2.FirewallRules firewall_rules = 1; */ @@ -210,7 +210,7 @@ export declare const FirewallSpecSchema: GenMessage; */ export type MachineServiceCreateResponse = Message<"metalstack.api.v2.MachineServiceCreateResponse"> & { /** - * Machine which was created + * Machine which was created. * * @generated from field: metalstack.api.v2.Machine machine = 1; */ @@ -228,7 +228,7 @@ export declare const MachineServiceCreateResponseSchema: GenMessage & { /** - * UUID of the machine to modify + * UUID of the machine to modify. * * @generated from field: string uuid = 1; */ @@ -240,25 +240,25 @@ export type MachineServiceUpdateRequest = Message<"metalstack.api.v2.MachineServ */ updateMeta?: UpdateMeta | undefined; /** - * Project of the machine + * Project of the machine. * * @generated from field: string project = 3; */ project: string; /** - * Description of this machine allocation + * Description of this machine allocation. * * @generated from field: optional string description = 4; */ description?: string | undefined; /** - * Labels to update on this machine allocation + * Labels to update on this machine allocation. * * @generated from field: optional metalstack.api.v2.UpdateLabels labels = 5; */ labels?: UpdateLabels | undefined; /** - * SSHPublicKeys which should be update of this machine allocation + * SSHPublicKeys which should be update of this machine allocation. * * @generated from field: repeated string ssh_public_keys = 6; */ @@ -276,7 +276,7 @@ export declare const MachineServiceUpdateRequestSchema: GenMessage & { /** - * Machine which was updated + * Machine which was updated. * * @generated from field: metalstack.api.v2.Machine machine = 1; */ @@ -294,7 +294,7 @@ export declare const MachineServiceUpdateResponseSchema: GenMessage & { /** - * Project of the machines to list + * Project of the machines to list. * * @generated from field: string project = 1; */ @@ -336,13 +336,13 @@ export declare const MachineServiceListResponseSchema: GenMessage & { /** - * UUID of the machine to delete + * UUID of the machine to delete. * * @generated from field: string uuid = 1; */ uuid: string; /** - * Project of the machine + * Project of the machine. * * @generated from field: string project = 2; */ @@ -360,7 +360,7 @@ export declare const MachineServiceDeleteRequestSchema: GenMessage & { /** - * Machine which was deleted + * Machine which was deleted. * * @generated from field: metalstack.api.v2.Machine machine = 1; */ @@ -378,19 +378,19 @@ export declare const MachineServiceDeleteResponseSchema: GenMessage & { /** - * UUID of the machine to send the command to + * UUID of the machine to send the command to. * * @generated from field: string uuid = 1; */ uuid: string; /** - * Project of the machine + * Project of the machine. * * @generated from field: string project = 2; */ project: string; /** - * Command to send to the bmc of the machine + * Command to send to the bmc of the machine. * * @generated from field: metalstack.api.v2.MachineBMCCommand command = 3; */ @@ -419,13 +419,13 @@ export declare const MachineServiceBMCCommandResponseSchema: GenMessage & { /** - * UUID of the machine to get + * UUID of the machine to get. * * @generated from field: string uuid = 1; */ uuid: string; /** - * Project of the machine + * Project of the machine. * * @generated from field: string project = 2; */ @@ -443,7 +443,7 @@ export declare const MachineServiceGetBMCRequestSchema: GenMessage & { /** - * UUID of the machine + * UUID of the machine. * * @generated from field: string uuid = 1; */ @@ -467,19 +467,19 @@ export declare const MachineServiceGetBMCResponseSchema: GenMessage & { /** - * UUID of this machine + * UUID of this machine. * * @generated from field: string uuid = 1; */ uuid: string; /** - * Meta for this machine + * Meta for this machine. * * @generated from field: metalstack.api.v2.Meta meta = 2; */ meta?: Meta | undefined; /** - * Partition where this machine resides + * Partition where this machine resides. * * @generated from field: metalstack.api.v2.Partition partition = 3; */ @@ -497,19 +497,19 @@ export type Machine = Message<"metalstack.api.v2.Machine"> & { */ room: string; /** - * Size of this machine + * Size of this machine. * * @generated from field: metalstack.api.v2.Size size = 6; */ size?: Size | undefined; /** - * Hardware specs of this machine + * Hardware specs of this machine. * * @generated from field: metalstack.api.v2.MachineHardware hardware = 7; */ hardware?: MachineHardware | undefined; /** - * Allocation details + * Allocation details. * * @generated from field: metalstack.api.v2.MachineAllocation allocation = 8; */ @@ -551,13 +551,13 @@ export type MachineStatus = Message<"metalstack.api.v2.MachineStatus"> & { */ ledState?: MachineChassisIdentifyLEDState | undefined; /** - * Liveliness of this machine + * Liveliness of this machine. * * @generated from field: metalstack.api.v2.MachineLiveliness liveliness = 3; */ liveliness: MachineLiveliness; /** - * MetalHammerVersion the version of metal hammer which put the machine in waiting state + * MetalHammerVersion the version of metal hammer which put the machine in waiting state. * * @generated from field: string metal_hammer_version = 4; */ @@ -575,19 +575,19 @@ export declare const MachineStatusSchema: GenMessage; */ export type MachineCondition = Message<"metalstack.api.v2.MachineCondition"> & { /** - * State the state of this machine. empty means available for all + * State the state of this machine. empty means available for al. * * @generated from field: metalstack.api.v2.MachineState state = 1; */ state: MachineState; /** - * Description a description why this machine is in the given state + * Description a description why this machine is in the given state. * * @generated from field: string description = 2; */ description: string; /** - * Issuer the user that changed the state + * Issuer the user that changed the state. * * @generated from field: string issuer = 3; */ @@ -605,105 +605,105 @@ export declare const MachineConditionSchema: GenMessage; */ export type MachineAllocation = Message<"metalstack.api.v2.MachineAllocation"> & { /** - * UUID of this machine allocation + * UUID of this machine allocation. * * @generated from field: string uuid = 1; */ uuid: string; /** - * Meta for this machine allocation + * Meta for this machine allocation. * * @generated from field: metalstack.api.v2.Meta meta = 2; */ meta?: Meta | undefined; /** - * Name of this allocation + * Name of this allocation. * * @generated from field: string name = 3; */ name: string; /** - * Description of this allocation + * Description of this allocation. * * @generated from field: string description = 4; */ description: string; /** - * Created By indicates who created this machine allocation + * Created By indicates who created this machine allocation. * * @generated from field: string created_by = 5; */ createdBy: string; /** - * Project of the allocation + * Project of the allocation. * * @generated from field: string project = 6; */ project: string; /** - * Image to be used to install on this machine + * Image to be used to install on this machine. * * @generated from field: metalstack.api.v2.Image image = 7; */ image?: Image | undefined; /** - * FilesystemLayout to create on the disks + * FilesystemLayout to create on the disks. * * @generated from field: metalstack.api.v2.FilesystemLayout filesystem_layout = 8; */ filesystemLayout?: FilesystemLayout | undefined; /** - * Networks this machine should be attached to + * Networks this machine should be attached to. * Order of ips of external networks will be preserved. * * @generated from field: repeated metalstack.api.v2.MachineNetwork networks = 9; */ networks: MachineNetwork[]; /** - * Hostname of the allocated machine + * Hostname of the allocated machine. * * @generated from field: string hostname = 10; */ hostname: string; /** - * SSHPublicKeys which should be installed on this machine + * SSHPublicKeys which should be installed on this machine. * * @generated from field: repeated string ssh_public_keys = 11; */ sshPublicKeys: string[]; /** * Userdata contains instructions required to bootstrap the machine. - * AWS limits the max userdata size to 16k, lets allow twice as much + * AWS limits the max userdata size to 16k, lets allow twice as much. * * @generated from field: string userdata = 12; */ userdata: string; /** - * AllocationType of this machine + * AllocationType of this machine. * * @generated from field: metalstack.api.v2.MachineAllocationType allocation_type = 13; */ allocationType: MachineAllocationType; /** - * FirewallRules to be applied if this is a firewall + * FirewallRules to be applied if this is a firewall. * * @generated from field: metalstack.api.v2.FirewallRules firewall_rules = 14; */ firewallRules?: FirewallRules | undefined; /** - * DNSServers for this machine + * DNSServers for this machine. * * @generated from field: repeated metalstack.api.v2.DNSServer dns_servers = 15; */ dnsServers: DNSServer[]; /** - * NTPServers for this machine + * NTPServers for this machine. * * @generated from field: repeated metalstack.api.v2.NTPServer ntp_servers = 16; */ ntpServers: NTPServer[]; /** - * VPN connection configuration + * VPN connection configuration. * * @generated from field: metalstack.api.v2.MachineVPN vpn = 17; */ @@ -721,13 +721,13 @@ export declare const MachineAllocationSchema: GenMessage; */ export type MachineAllocationNetwork = Message<"metalstack.api.v2.MachineAllocationNetwork"> & { /** - * Network the id of the network that this machine will be placed in + * Network the id of the network that this machine will be placed in. * * @generated from field: string network = 1; */ network: string; /** - * IPs to to attach to this machine additionally + * IPs to to attach to this machine additionally. * If none given, one ip address is acquired per network for the machine. * Order of ips is preserved on the loopback interface. * @@ -771,25 +771,25 @@ export declare const FirewallRulesSchema: GenMessage; */ export type FirewallEgressRule = Message<"metalstack.api.v2.FirewallEgressRule"> & { /** - * Protocol the protocol for the rule, defaults to tcp + * Protocol the protocol for the rule, defaults to tcp. * * @generated from field: metalstack.api.v2.IPProtocol protocol = 1; */ protocol: IPProtocol; /** - * Ports the ports affected by this rule + * Ports the ports affected by this rule. * * @generated from field: repeated uint32 ports = 2; */ ports: number[]; /** - * To the destination cidrs affected by this rule + * To the destination cidrs affected by this rule. * * @generated from field: repeated string to = 3; */ to: string[]; /** - * Comment for this rule + * Comment for this rule. * * @generated from field: string comment = 4; */ @@ -807,31 +807,31 @@ export declare const FirewallEgressRuleSchema: GenMessage; */ export type FirewallIngressRule = Message<"metalstack.api.v2.FirewallIngressRule"> & { /** - * Protocol the protocol for the rule, defaults to tcp + * Protocol the protocol for the rule, defaults to tcp. * * @generated from field: metalstack.api.v2.IPProtocol protocol = 1; */ protocol: IPProtocol; /** - * Ports the ports affected by this rule + * Ports the ports affected by this rule. * * @generated from field: repeated uint32 ports = 2; */ ports: number[]; /** - * To the destination cidrs affected by this rule + * To the destination cidrs affected by this rule. * * @generated from field: repeated string to = 3; */ to: string[]; /** - * From the source cidrs affected by this rule + * From the source cidrs affected by this rule. * * @generated from field: repeated string from = 4; */ from: string[]; /** - * Comment for this rule + * Comment for this rule. * * @generated from field: string comment = 5; */ @@ -849,13 +849,13 @@ export declare const FirewallIngressRuleSchema: GenMessage; */ export type MachineNetwork = Message<"metalstack.api.v2.MachineNetwork"> & { /** - * Network the networkID of the allocated machine in this vrf + * Network the networkID of the allocated machine in this vrf. * * @generated from field: string network = 1; */ network: string; /** - * Prefixes the prefixes of this network + * Prefixes the prefixes of this network. * * @generated from field: repeated string prefixes = 2; */ @@ -867,13 +867,13 @@ export type MachineNetwork = Message<"metalstack.api.v2.MachineNetwork"> & { */ destinationPrefixes: string[]; /** - * IPs the ip addresses of the allocated machine in this vrf + * IPs the ip addresses of the allocated machine in this vrf. * * @generated from field: repeated string ips = 4; */ ips: string[]; /** - * NetworkType the type of network of this vrf + * NetworkType the type of network of this vrf. * * @generated from field: metalstack.api.v2.NetworkType network_type = 5; */ @@ -885,13 +885,13 @@ export type MachineNetwork = Message<"metalstack.api.v2.MachineNetwork"> & { */ natType: NATType; /** - * VRF the vrf id + * VRF the vrf id. * * @generated from field: uint64 vrf = 7; */ vrf: bigint; /** - * ASN the autonomous system number for this network + * ASN the autonomous system number for this network. * * @generated from field: uint32 asn = 8; */ @@ -915,31 +915,31 @@ export declare const MachineNetworkSchema: GenMessage; */ export type MachineHardware = Message<"metalstack.api.v2.MachineHardware"> & { /** - * Memory the total memory of the machine in bytes + * Memory the total memory of the machine in bytes. * * @generated from field: uint64 memory = 1; */ memory: bigint; /** - * Disks the list of block devices of this machine + * Disks the list of block devices of this machine. * * @generated from field: repeated metalstack.api.v2.MachineBlockDevice disks = 2; */ disks: MachineBlockDevice[]; /** - * CPUs the cpu details + * CPUs the cpu details. * * @generated from field: repeated metalstack.api.v2.MetalCPU cpus = 3; */ cpus: MetalCPU[]; /** - * GPUs the gpu details + * GPUs the gpu details. * * @generated from field: repeated metalstack.api.v2.MetalGPU gpus = 4; */ gpus: MetalGPU[]; /** - * Nics the list of network interfaces of this machine + * Nics the list of network interfaces of this machine. * * @generated from field: repeated metalstack.api.v2.MachineNic nics = 5; */ @@ -957,25 +957,25 @@ export declare const MachineHardwareSchema: GenMessage; */ export type MetalCPU = Message<"metalstack.api.v2.MetalCPU"> & { /** - * Vendor of this cpu + * Vendor of this cpu. * * @generated from field: string vendor = 1; */ vendor: string; /** - * Model of this cpu + * Model of this cpu. * * @generated from field: string model = 2; */ model: string; /** - * Cores of this cpu + * Cores of this cpu. * * @generated from field: uint32 cores = 3; */ cores: number; /** - * Threads of this cpu + * Threads of this cpu. * * @generated from field: uint32 threads = 4; */ @@ -993,13 +993,13 @@ export declare const MetalCPUSchema: GenMessage; */ export type MetalGPU = Message<"metalstack.api.v2.MetalGPU"> & { /** - * Vendor of this gpu + * Vendor of this gpu. * * @generated from field: string vendor = 1; */ vendor: string; /** - * Model of this gpu + * Model of this gpu. * * @generated from field: string model = 2; */ @@ -1017,49 +1017,49 @@ export declare const MetalGPUSchema: GenMessage; */ export type MachineNic = Message<"metalstack.api.v2.MachineNic"> & { /** - * Mac the macaddress of this interface + * Mac the macaddress of this interface. * * @generated from field: string mac = 1; */ mac: string; /** - * Name of this interface + * Name of this interface. * * @generated from field: string name = 2; */ name: string; /** - * Identifier the unique identifier of this network interface + * Identifier the unique identifier of this network interface. * * @generated from field: string identifier = 3; */ identifier: string; /** - * Vendor of this network card + * Vendor of this network card. * * @generated from field: string vendor = 4; */ vendor: string; /** - * Model of this network card + * Model of this network card. * * @generated from field: string model = 5; */ model: string; /** - * Speed in bits/second of this network card + * Speed in bits/second of this network card. * * @generated from field: uint64 speed = 6; */ speed: bigint; /** - * Neighbors the neighbors visible to this network interface + * Neighbors the neighbors visible to this network interface. * * @generated from field: repeated metalstack.api.v2.MachineNic neighbors = 7; */ neighbors: MachineNic[]; /** - * Hostname the nic belongs to + * Hostname the nic belongs to. * * @generated from field: string hostname = 8; */ @@ -1077,13 +1077,13 @@ export declare const MachineNicSchema: GenMessage; */ export type MachineBlockDevice = Message<"metalstack.api.v2.MachineBlockDevice"> & { /** - * Name of this block device + * Name of this block device. * * @generated from field: string name = 1; */ name: string; /** - * Size of this block device in bytes + * Size of this block device in bytes. * * @generated from field: uint64 size = 2; */ @@ -1101,13 +1101,13 @@ export declare const MachineBlockDeviceSchema: GenMessage; */ export type MachineChassisIdentifyLEDState = Message<"metalstack.api.v2.MachineChassisIdentifyLEDState"> & { /** - * Value the state of this chassis identify LED. empty means LED-OFF + * Value the state of this chassis identify LED. empty means LED-OF. * * @generated from field: string value = 1; */ value: string; /** - * Description a description why this chassis identify LED is in the given state + * Description a description why this chassis identify LED is in the given state. * * @generated from field: string description = 2; */ @@ -1179,19 +1179,19 @@ export declare const MachineBMCReportSchema: GenMessage; */ export type MachineBios = Message<"metalstack.api.v2.MachineBios"> & { /** - * Version the bios version + * Version the bios version. * * @generated from field: string version = 1; */ version: string; /** - * Vendor the bios vendor + * Vendor the bios vendor. * * @generated from field: string vendor = 2; */ vendor: string; /** - * Date the bios date as string because every vendor has different ideas how to describe the date + * Date the bios date as string because every vendor has different ideas how to describe the date. * * @generated from field: string date = 3; */ @@ -1209,43 +1209,43 @@ export declare const MachineBiosSchema: GenMessage; */ export type MachineBMC = Message<"metalstack.api.v2.MachineBMC"> & { /** - * Address of this ipmi device from outside in the form of : + * Address of this ipmi device from outside in the form of :. * * @generated from field: string address = 1; */ address: string; /** - * Mac address of the network interface of this ipmi device + * Mac address of the network interface of this ipmi device. * * @generated from field: string mac = 2; */ mac: string; /** - * User of this ipmi device + * User of this ipmi device. * * @generated from field: string user = 3; */ user: string; /** - * Password of this ipmi device + * Password of this ipmi device. * * @generated from field: string password = 4; */ password: string; /** - * Interface of this ipmi device + * Interface of this ipmi device. * * @generated from field: string interface = 5; */ interface: string; /** - * Version of this bmc device + * Version of this bmc device. * * @generated from field: string version = 6; */ version: string; /** - * PowerState of this machine + * PowerState of this machine. * * @generated from field: string power_state = 7; */ @@ -1323,34 +1323,26 @@ export declare const MachineFRUSchema: GenMessage; */ export type MachinePowerMetric = Message<"metalstack.api.v2.MachinePowerMetric"> & { /** - * AverageConsumedWatts shall represent the - * average power level that occurred averaged over the last IntervalInMin - * minutes. + * AverageConsumedWatts shall represent the average power level that occurred averaged over the last IntervalInMin minutes. * * @generated from field: float average_consumed_watts = 1; */ averageConsumedWatts: number; /** - * IntervalInMin shall represent the time - * interval (or window), in minutes, in which the PowerMetrics properties - * are measured over. + * IntervalInMin shall represent the time interval (or window), in minutes, in which the PowerMetrics properties are measured over. * Should be an integer, but some Dell implementations return as a float. * * @generated from field: float interval_in_min = 2; */ intervalInMin: number; /** - * MaxConsumedWatts shall represent the - * maximum power level in watts that occurred within the last - * IntervalInMin minutes. + * MaxConsumedWatts shall represent the maximum power level in watts that occurred within the last IntervalInMin minutes. * * @generated from field: float max_consumed_watts = 3; */ maxConsumedWatts: number; /** - * MinConsumedWatts shall represent the - * minimum power level in watts that occurred within the last - * IntervalInMin minutes. + * MinConsumedWatts shall represent the minimum power level in watts that occurred within the last IntervalInMin minutes. * * @generated from field: float min_consumed_watts = 4; */ @@ -1368,13 +1360,13 @@ export declare const MachinePowerMetricSchema: GenMessage; */ export type MachinePowerSupply = Message<"metalstack.api.v2.MachinePowerSupply"> & { /** - * Health of the powersupply + * Health of the powersupply. * * @generated from field: string health = 1; */ health: string; /** - * State of the powersupply + * State of the powersupply. * * @generated from field: string state = 2; */ @@ -1386,25 +1378,25 @@ export type MachinePowerSupply = Message<"metalstack.api.v2.MachinePowerSupply"> */ export declare const MachinePowerSupplySchema: GenMessage; /** - * MachineRecentProvisioningEvents the recent provisioning events for this machine + * MachineRecentProvisioningEvents the recent provisioning events for this machine. * * @generated from message metalstack.api.v2.MachineRecentProvisioningEvents */ export type MachineRecentProvisioningEvents = Message<"metalstack.api.v2.MachineRecentProvisioningEvents"> & { /** - * Events the log of recent machine provisioning events + * Events the log of recent machine provisioning events. * * @generated from field: repeated metalstack.api.v2.MachineProvisioningEvent events = 1; */ events: MachineProvisioningEvent[]; /** - * LastEventTime the time where the last event was received + * LastEventTime the time where the last event was received. * * @generated from field: google.protobuf.Timestamp last_event_time = 2; */ lastEventTime?: Timestamp | undefined; /** - * LastErrorEvent the last erroneous event received + * LastErrorEvent the last erroneous event received. * * @generated from field: metalstack.api.v2.MachineProvisioningEvent last_error_event = 3; */ @@ -1428,19 +1420,19 @@ export declare const MachineRecentProvisioningEventsSchema: GenMessage & { /** - * Time the time that this event was received + * Time the time that this event was received. * * @generated from field: google.protobuf.Timestamp time = 1; */ time?: Timestamp | undefined; /** - * Event the event emitted by the machine + * Event the event emitted by the machine. * * @generated from field: metalstack.api.v2.MachineProvisioningEventType event = 2; */ event: MachineProvisioningEventType; /** - * Message an additional message to add to the event + * Message an additional message to add to the event. * * @generated from field: string message = 3; */ @@ -1458,13 +1450,13 @@ export declare const MachineProvisioningEventSchema: GenMessage & { /** - * Address of VPN control plane + * Address of VPN control plane. * * @generated from field: string control_plane_address = 1; */ controlPlaneAddress: string; /** - * Auth key used to connect to VPN + * Auth key used to connect to VPN. * * @generated from field: string auth_key = 2; */ @@ -1476,7 +1468,7 @@ export type MachineVPN = Message<"metalstack.api.v2.MachineVPN"> & { */ connected: boolean; /** - * IPs of the machine connected to the vpn + * IPs of the machine connected to the vpn. * * @generated from field: repeated string ips = 4; */ @@ -1494,91 +1486,91 @@ export declare const MachineVPNSchema: GenMessage; */ export type MachineQuery = Message<"metalstack.api.v2.MachineQuery"> & { /** - * UUID of the machine to get + * UUID of the machine to get. * * @generated from field: optional string uuid = 1; */ uuid?: string | undefined; /** - * Name of the machine to get + * Name of the machine to get. * * @generated from field: optional string name = 2; */ name?: string | undefined; /** - * Partition of the machine to get + * Partition of the machine to get. * * @generated from field: optional string partition = 3; */ partition?: string | undefined; /** - * Size of the machine to get + * Size of the machine to get. * * @generated from field: optional string size = 4; */ size?: string | undefined; /** - * Rack of the machine to get + * Rack of the machine to get. * * @generated from field: optional string rack = 5; */ rack?: string | undefined; /** - * Room of the machine to get + * Room of the machine to get. * * @generated from field: optional string room = 6; */ room?: string | undefined; /** - * Labels for which this machine should get filtered + * Labels for which this machine should get filtered. * * @generated from field: optional metalstack.api.v2.Labels labels = 7; */ labels?: Labels | undefined; /** - * Allocation specific machine queries + * Allocation specific machine queries. * * @generated from field: optional metalstack.api.v2.MachineAllocationQuery allocation = 8; */ allocation?: MachineAllocationQuery | undefined; /** - * Network specific machine queries + * Network specific machine queries. * * @generated from field: optional metalstack.api.v2.MachineNetworkQuery network = 9; */ network?: MachineNetworkQuery | undefined; /** - * Nic specific machine queries + * Nic specific machine queries. * * @generated from field: optional metalstack.api.v2.MachineNicQuery nic = 10; */ nic?: MachineNicQuery | undefined; /** - * Disk specific machine queries + * Disk specific machine queries. * * @generated from field: optional metalstack.api.v2.MachineDiskQuery disk = 11; */ disk?: MachineDiskQuery | undefined; /** - * Bmc specific machine queries + * Bmc specific machine queries. * * @generated from field: optional metalstack.api.v2.MachineBMCQuery bmc = 12; */ bmc?: MachineBMCQuery | undefined; /** - * Fru specific machine queries + * Fru specific machine queries. * * @generated from field: optional metalstack.api.v2.MachineFRUQuery fru = 13; */ fru?: MachineFRUQuery | undefined; /** - * Hardware specific machine query + * Hardware specific machine query. * * @generated from field: optional metalstack.api.v2.MachineHardwareQuery hardware = 14; */ hardware?: MachineHardwareQuery | undefined; /** - * State this machine has + * State this machine has. * * @generated from field: optional metalstack.api.v2.MachineState state = 15; */ @@ -1611,61 +1603,61 @@ export type MachineQuery = Message<"metalstack.api.v2.MachineQuery"> & { */ export declare const MachineQuerySchema: GenMessage; /** - * MachineAllocationQuery allocation specific query parameters + * MachineAllocationQuery allocation specific query parameters. * * @generated from message metalstack.api.v2.MachineAllocationQuery */ export type MachineAllocationQuery = Message<"metalstack.api.v2.MachineAllocationQuery"> & { /** - * UUID of the allocation of the machine to get + * UUID of the allocation of the machine to get. * * @generated from field: optional string uuid = 1; */ uuid?: string | undefined; /** - * Name of the machine to get + * Name of the machine to get. * * @generated from field: optional string name = 2; */ name?: string | undefined; /** - * Project of the machine to get + * Project of the machine to get. * * @generated from field: optional string project = 3; */ project?: string | undefined; /** - * Image of the machine to get + * Image of the machine to get. * * @generated from field: optional string image = 4; */ image?: string | undefined; /** - * FilesystemLayout of the machine to get + * FilesystemLayout of the machine to get. * * @generated from field: optional string filesystem_layout = 5; */ filesystemLayout?: string | undefined; /** - * Hostname of the machine to get + * Hostname of the machine to get. * * @generated from field: optional string hostname = 6; */ hostname?: string | undefined; /** - * AllocationType of this machine + * AllocationType of this machine. * * @generated from field: optional metalstack.api.v2.MachineAllocationType allocation_type = 7; */ allocationType?: MachineAllocationType | undefined; /** - * Labels for which this machine allocation should get filtered + * Labels for which this machine allocation should get filtered. * * @generated from field: optional metalstack.api.v2.Labels labels = 8; */ labels?: Labels | undefined; /** - * VPN query if this machine has a vpn configuration + * VPN query if this machine has a vpn configuration. * * @generated from field: optional metalstack.api.v2.MachineVPN vpn = 9; */ @@ -1677,43 +1669,43 @@ export type MachineAllocationQuery = Message<"metalstack.api.v2.MachineAllocatio */ export declare const MachineAllocationQuerySchema: GenMessage; /** - * MachineNetworkQuery network specific machine queries + * MachineNetworkQuery network specific machine queries. * * @generated from message metalstack.api.v2.MachineNetworkQuery */ export type MachineNetworkQuery = Message<"metalstack.api.v2.MachineNetworkQuery"> & { /** - * Networks this machine is connected to + * Networks this machine is connected to. * * @generated from field: repeated string networks = 1; */ networks: string[]; /** - * Prefixes this machine is connected to + * Prefixes this machine is connected to. * * @generated from field: repeated string prefixes = 2; */ prefixes: string[]; /** - * DestinationPrefixes this machine is connected to + * DestinationPrefixes this machine is connected to. * * @generated from field: repeated string destination_prefixes = 3; */ destinationPrefixes: string[]; /** - * IPs this machine has + * IPs this machine has. * * @generated from field: repeated string ips = 4; */ ips: string[]; /** - * VRFs this machine is connected to + * VRFs this machine is connected to. * * @generated from field: repeated uint64 vrfs = 5; */ vrfs: bigint[]; /** - * ASNs this machine is connected to + * ASNs this machine is connected to. * * @generated from field: repeated uint32 asns = 6; */ @@ -1725,31 +1717,31 @@ export type MachineNetworkQuery = Message<"metalstack.api.v2.MachineNetworkQuery */ export declare const MachineNetworkQuerySchema: GenMessage; /** - * MachineNicQuery nic specific machine queries + * MachineNicQuery nic specific machine queries. * * @generated from message metalstack.api.v2.MachineNicQuery */ export type MachineNicQuery = Message<"metalstack.api.v2.MachineNicQuery"> & { /** - * Macs this machine nic has + * Macs this machine nic has. * * @generated from field: repeated string macs = 1; */ macs: string[]; /** - * Names this machine nic has + * Names this machine nic has. * * @generated from field: repeated string names = 2; */ names: string[]; /** - * NeighborMacs this machine nic has + * NeighborMacs this machine nic has. * * @generated from field: repeated string neighbor_macs = 3; */ neighborMacs: string[]; /** - * NeighborNames this machine nic has + * NeighborNames this machine nic has. * * @generated from field: repeated string neighbor_names = 4; */ @@ -1761,19 +1753,19 @@ export type MachineNicQuery = Message<"metalstack.api.v2.MachineNicQuery"> & { */ export declare const MachineNicQuerySchema: GenMessage; /** - * MachineDiskQuery disk specific machine queries + * MachineDiskQuery disk specific machine queries. * * @generated from message metalstack.api.v2.MachineDiskQuery */ export type MachineDiskQuery = Message<"metalstack.api.v2.MachineDiskQuery"> & { /** - * Names of disks in this machine + * Names of disks in this machine. * * @generated from field: repeated string names = 1; */ names: string[]; /** - * Sizes of disks in this machine + * Sizes of disks in this machine. * * @generated from field: repeated uint64 sizes = 2; */ @@ -1785,31 +1777,31 @@ export type MachineDiskQuery = Message<"metalstack.api.v2.MachineDiskQuery"> & { */ export declare const MachineDiskQuerySchema: GenMessage; /** - * MachineBMCQuery machine ipmi or bmc specific machine queries + * MachineBMCQuery machine ipmi or bmc specific machine queries. * * @generated from message metalstack.api.v2.MachineBMCQuery */ export type MachineBMCQuery = Message<"metalstack.api.v2.MachineBMCQuery"> & { /** - * Address of the ipmi system of this machine + * Address of the ipmi system of this machine. * * @generated from field: optional string address = 1; */ address?: string | undefined; /** - * Mac of the ipmi system of this machine + * Mac of the ipmi system of this machine. * * @generated from field: optional string mac = 2; */ mac?: string | undefined; /** - * User of the ipmi system of this machine + * User of the ipmi system of this machine. * * @generated from field: optional string user = 3; */ user?: string | undefined; /** - * Interface of the ipmi system of this machine + * Interface of the ipmi system of this machine. * * @generated from field: optional string interface = 4; */ @@ -1821,55 +1813,55 @@ export type MachineBMCQuery = Message<"metalstack.api.v2.MachineBMCQuery"> & { */ export declare const MachineBMCQuerySchema: GenMessage; /** - * MachineFRUQuery machine fru specific machine queries + * MachineFRUQuery machine fru specific machine queries. * * @generated from message metalstack.api.v2.MachineFRUQuery */ export type MachineFRUQuery = Message<"metalstack.api.v2.MachineFRUQuery"> & { /** - * ChassisPartNumber of this machine + * ChassisPartNumber of this machine. * * @generated from field: optional string chassis_part_number = 1; */ chassisPartNumber?: string | undefined; /** - * ChassisPartSerial of this machine + * ChassisPartSerial of this machine. * * @generated from field: optional string chassis_part_serial = 2; */ chassisPartSerial?: string | undefined; /** - * BoardMFG of this machine + * BoardMFG of this machine. * * @generated from field: optional string board_mfg = 3; */ boardMfg?: string | undefined; /** - * BoardSerial of this machine + * BoardSerial of this machine. * * @generated from field: optional string board_serial = 4; */ boardSerial?: string | undefined; /** - * BoardPartNumber of this machine + * BoardPartNumber of this machine. * * @generated from field: optional string board_part_number = 5; */ boardPartNumber?: string | undefined; /** - * ProductManufacturer of this machine + * ProductManufacturer of this machine. * * @generated from field: optional string product_manufacturer = 6; */ productManufacturer?: string | undefined; /** - * ProductPartNumber of this machine + * ProductPartNumber of this machine. * * @generated from field: optional string product_part_number = 7; */ productPartNumber?: string | undefined; /** - * ProductSerial of this machine + * ProductSerial of this machine. * * @generated from field: optional string product_serial = 8; */ @@ -1881,19 +1873,19 @@ export type MachineFRUQuery = Message<"metalstack.api.v2.MachineFRUQuery"> & { */ export declare const MachineFRUQuerySchema: GenMessage; /** - * MachineHardwareQuery machine hardware specific machine queries + * MachineHardwareQuery machine hardware specific machine queries. * * @generated from message metalstack.api.v2.MachineHardwareQuery */ export type MachineHardwareQuery = Message<"metalstack.api.v2.MachineHardwareQuery"> & { /** - * Memory the total memory of the machine in bytes + * Memory the total memory of the machine in bytes. * * @generated from field: optional uint64 memory = 1; */ memory?: bigint | undefined; /** - * CPUCores the number of cpu cores + * CPUCores the number of cpu cores. * * @generated from field: optional uint32 cpu_cores = 2; */ @@ -1911,7 +1903,7 @@ export declare const MachineHardwareQuerySchema: GenMessage & { /** - * MachineQuery to select specific machines + * MachineQuery to select specific machines. * * @generated from field: metalstack.api.v2.MachineQuery machine_query = 1; */ @@ -1923,7 +1915,7 @@ export type MachineIssuesQuery = Message<"metalstack.api.v2.MachineIssuesQuery"> */ only: MachineIssueType[]; /** - * Omits the specified machine issues + * Omits the specified machine issues. * * @generated from field: repeated metalstack.api.v2.MachineIssueType omit = 3; */ @@ -1953,13 +1945,13 @@ export declare const MachineIssuesQuerySchema: GenMessage; */ export type MachineIssues = Message<"metalstack.api.v2.MachineIssues"> & { /** - * UUID of the machine for which the issues are listed + * UUID of the machine for which the issues are listed. * * @generated from field: string uuid = 1; */ uuid: string; /** - * Issues of this machine + * Issues of this machine. * * @generated from field: repeated metalstack.api.v2.MachineIssue issues = 2; */ @@ -1977,7 +1969,7 @@ export declare const MachineIssuesSchema: GenMessage; */ export type MachineIssue = Message<"metalstack.api.v2.MachineIssue"> & { /** - * Type specifies the issue type (id) + * Type specifies the issue type (id). * * @generated from field: metalstack.api.v2.MachineIssueType type = 1; */ @@ -2054,19 +2046,19 @@ export declare enum MachineState { */ UNSPECIFIED = 0, /** - * MACHINE_STATE_TAINTED this machine is tainted, i.e. this machine is not considered during random machine allocation, but still by specifying the uuid + * MACHINE_STATE_TAINTED this machine is tainted, i.e. this machine is not considered during random machine allocation, but still by specifying the uui. * * @generated from enum value: MACHINE_STATE_TAINTED = 1; */ TAINTED = 1, /** - * MACHINE_STATE_LOCKED this machine is locked, i.e. this machine cannot be allocated or deleted + * MACHINE_STATE_LOCKED this machine is locked, i.e. this machine cannot be allocated or delete. * * @generated from enum value: MACHINE_STATE_LOCKED = 2; */ LOCKED = 2, /** - * MACHINE_STATE_AVAILABLE this machine is available for all + * MACHINE_STATE_AVAILABLE this machine is available for all. * * @generated from enum value: MACHINE_STATE_AVAILABLE = 3; */ @@ -2077,7 +2069,7 @@ export declare enum MachineState { */ export declare const MachineStateSchema: GenEnum; /** - * MachineProvisioningEventState possible event states + * MachineProvisioningEventState possible event states. * * @generated from enum metalstack.api.v2.MachineProvisioningEventState */ @@ -2089,13 +2081,13 @@ export declare enum MachineProvisioningEventState { */ UNSPECIFIED = 0, /** - * MACHINE_PROVISIONING_EVENT_STATE_CRASHLOOP machine is in crash loop + * MACHINE_PROVISIONING_EVENT_STATE_CRASHLOOP machine is in crash loop. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_STATE_CRASHLOOP = 1; */ CRASHLOOP = 1, /** - * MACHINE_PROVISIONING_EVENT_STATE_FAILED_RECLAIM machine is in failed reclaim + * MACHINE_PROVISIONING_EVENT_STATE_FAILED_RECLAIM machine is in failed reclaim. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_STATE_FAILED_RECLAIM = 2; */ @@ -2118,67 +2110,67 @@ export declare enum MachineProvisioningEventType { */ UNSPECIFIED = 0, /** - * MACHINE_PROVISIONING_EVENT_TYPE_ALIVE machine is alive + * MACHINE_PROVISIONING_EVENT_TYPE_ALIVE machine is alive. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_ALIVE = 1; */ ALIVE = 1, /** - * MACHINE_PROVISIONING_EVENT_TYPE_CRASHED machine crashed + * MACHINE_PROVISIONING_EVENT_TYPE_CRASHED machine crashed. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_CRASHED = 2; */ CRASHED = 2, /** - * MACHINE_PROVISIONING_EVENT_TYPE_PXE_BOOTING machine is pxe booting into metal-hammer + * MACHINE_PROVISIONING_EVENT_TYPE_PXE_BOOTING machine is pxe booting into metal-hammer. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_PXE_BOOTING = 3; */ PXE_BOOTING = 3, /** - * MACHINE_PROVISIONING_EVENT_TYPE_PLANNED_REBOOT machine got a reboot instruction + * MACHINE_PROVISIONING_EVENT_TYPE_PLANNED_REBOOT machine got a reboot instruction. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_PLANNED_REBOOT = 4; */ PLANNED_REBOOT = 4, /** - * MACHINE_PROVISIONING_EVENT_TYPE_PREPARING metal-hammer is preparing the machine + * MACHINE_PROVISIONING_EVENT_TYPE_PREPARING metal-hammer is preparing the machine. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_PREPARING = 5; */ PREPARING = 5, /** - * MACHINE_PROVISIONING_EVENT_TYPE_REGISTERING metal-hammer registers machine at the apiserver + * MACHINE_PROVISIONING_EVENT_TYPE_REGISTERING metal-hammer registers machine at the apiserver. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_REGISTERING = 6; */ REGISTERING = 6, /** - * MACHINE_PROVISIONING_EVENT_TYPE_WAITING machine is waiting for installation + * MACHINE_PROVISIONING_EVENT_TYPE_WAITING machine is waiting for installation. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_WAITING = 7; */ WAITING = 7, /** - * MACHINE_PROVISIONING_EVENT_TYPE_INSTALLING metal-hammer is installing the desired os + * MACHINE_PROVISIONING_EVENT_TYPE_INSTALLING metal-hammer is installing the desired os. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_INSTALLING = 8; */ INSTALLING = 8, /** - * MACHINE_PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL metal-hammer completed installation and boots into target os + * MACHINE_PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL metal-hammer completed installation and boots into target os. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL = 9; */ BOOTING_NEW_KERNEL = 9, /** - * MACHINE_PROVISIONING_EVENT_TYPE_PHONED_HOME machine is installed and phones home + * MACHINE_PROVISIONING_EVENT_TYPE_PHONED_HOME machine is installed and phones home. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_PHONED_HOME = 10; */ PHONED_HOME = 10, /** - * MACHINE_PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM machine is not allocated, but phones home + * MACHINE_PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM machine is not allocated, but phones home. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM = 11; */ @@ -2201,19 +2193,19 @@ export declare enum MachineLiveliness { */ UNSPECIFIED = 0, /** - * MACHINE_LIVELINESS_ALIVE liveliness is alive + * MACHINE_LIVELINESS_ALIVE liveliness is alive. * * @generated from enum value: MACHINE_LIVELINESS_ALIVE = 1; */ ALIVE = 1, /** - * MACHINE_LIVELINESS_DEAD liveliness is dead + * MACHINE_LIVELINESS_DEAD liveliness is dead. * * @generated from enum value: MACHINE_LIVELINESS_DEAD = 2; */ DEAD = 2, /** - * MACHINE_LIVELINESS_UNKNOWN liveliness is unknown + * MACHINE_LIVELINESS_UNKNOWN liveliness is unknown. * * @generated from enum value: MACHINE_LIVELINESS_UNKNOWN = 3; */ @@ -2289,43 +2281,43 @@ export declare enum MachineBMCCommand { */ MACHINE_BMC_COMMAND_CYCLE = 4, /** - * MACHINE_BMC_COMMAND_BOOT_TO_BIOS boot the machine into bios + * MACHINE_BMC_COMMAND_BOOT_TO_BIOS boot the machine into bios. * * @generated from enum value: MACHINE_BMC_COMMAND_BOOT_TO_BIOS = 5; */ MACHINE_BMC_COMMAND_BOOT_TO_BIOS = 5, /** - * MACHINE_BMC_COMMAND_BOOT_FROM_DISK boot the machine from hard disk + * MACHINE_BMC_COMMAND_BOOT_FROM_DISK boot the machine from hard disk. * * @generated from enum value: MACHINE_BMC_COMMAND_BOOT_FROM_DISK = 6; */ MACHINE_BMC_COMMAND_BOOT_FROM_DISK = 6, /** - * MACHINE_BMC_COMMAND_BOOT_FROM_PXE boot the machine from pxe + * MACHINE_BMC_COMMAND_BOOT_FROM_PXE boot the machine from pxe. * * @generated from enum value: MACHINE_BMC_COMMAND_BOOT_FROM_PXE = 7; */ MACHINE_BMC_COMMAND_BOOT_FROM_PXE = 7, /** - * MACHINE_BMC_COMMAND_IDENTIFY_LED_ON set identify led of the machine chassis to on + * MACHINE_BMC_COMMAND_IDENTIFY_LED_ON set identify led of the machine chassis to on. * * @generated from enum value: MACHINE_BMC_COMMAND_IDENTIFY_LED_ON = 8; */ MACHINE_BMC_COMMAND_IDENTIFY_LED_ON = 8, /** - * MACHINE_BMC_COMMAND_IDENTIFY_LED_OFF set identify led of the machine chassis to off + * MACHINE_BMC_COMMAND_IDENTIFY_LED_OFF set identify led of the machine chassis to off. * * @generated from enum value: MACHINE_BMC_COMMAND_IDENTIFY_LED_OFF = 9; */ MACHINE_BMC_COMMAND_IDENTIFY_LED_OFF = 9, /** - * MACHINE_BMC_COMMAND_MACHINE_DELETED should be called if the machine was deleted to power cycle and boot into pxe + * MACHINE_BMC_COMMAND_MACHINE_DELETED should be called if the machine was deleted to power cycle and boot into pxe. * * @generated from enum value: MACHINE_BMC_COMMAND_MACHINE_DELETED = 10; */ MACHINE_BMC_COMMAND_MACHINE_DELETED = 10, /** - * MACHINE_BMC_COMMAND_MACHINE_CREATED should be called if the machine was created to set the boot order to boot from disk + * MACHINE_BMC_COMMAND_MACHINE_CREATED should be called if the machine was created to set the boot order to boot from disk. * * @generated from enum value: MACHINE_BMC_COMMAND_MACHINE_CREATED = 11; */ @@ -2342,85 +2334,85 @@ export declare const MachineBMCCommandSchema: GenEnum; */ export declare enum MachineIssueType { /** - * MACHINE_ISSUE_TYPE_UNSPECIFIED type is not specified + * MACHINE_ISSUE_TYPE_UNSPECIFIED type is not specified. * * @generated from enum value: MACHINE_ISSUE_TYPE_UNSPECIFIED = 0; */ UNSPECIFIED = 0, /** - * MACHINE_ISSUE_TYPE_ASN_UNIQUENESS machine asn is not unique + * MACHINE_ISSUE_TYPE_ASN_UNIQUENESS machine asn is not unique. * * @generated from enum value: MACHINE_ISSUE_TYPE_ASN_UNIQUENESS = 1; */ ASN_UNIQUENESS = 1, /** - * MACHINE_ISSUE_TYPE_BMC_INFO_OUTDATED machine bmc info out of date + * MACHINE_ISSUE_TYPE_BMC_INFO_OUTDATED machine bmc info out of date. * * @generated from enum value: MACHINE_ISSUE_TYPE_BMC_INFO_OUTDATED = 2; */ BMC_INFO_OUTDATED = 2, /** - * MACHINE_ISSUE_TYPE_BMC_NON_DISTINCT_IP machine bmc ip is not distinct + * MACHINE_ISSUE_TYPE_BMC_NON_DISTINCT_IP machine bmc ip is not distinct. * * @generated from enum value: MACHINE_ISSUE_TYPE_BMC_NON_DISTINCT_IP = 3; */ BMC_NON_DISTINCT_IP = 3, /** - * MACHINE_ISSUE_TYPE_BMC_WITHOUT_IP machine bmc without ip + * MACHINE_ISSUE_TYPE_BMC_WITHOUT_IP machine bmc without ip. * * @generated from enum value: MACHINE_ISSUE_TYPE_BMC_WITHOUT_IP = 4; */ BMC_WITHOUT_IP = 4, /** - * MACHINE_ISSUE_TYPE_BMC_WITHOUT_MAC machine bmc without mac address + * MACHINE_ISSUE_TYPE_BMC_WITHOUT_MAC machine bmc without mac address. * * @generated from enum value: MACHINE_ISSUE_TYPE_BMC_WITHOUT_MAC = 5; */ BMC_WITHOUT_MAC = 5, /** - * MACHINE_ISSUE_TYPE_CRASH_LOOP machine is in crashloop + * MACHINE_ISSUE_TYPE_CRASH_LOOP machine is in crashloop. * * @generated from enum value: MACHINE_ISSUE_TYPE_CRASH_LOOP = 6; */ CRASH_LOOP = 6, /** - * MACHINE_ISSUE_TYPE_FAILED_MACHINE_RECLAIM machine was not freed after delete + * MACHINE_ISSUE_TYPE_FAILED_MACHINE_RECLAIM machine was not freed after delete. * * @generated from enum value: MACHINE_ISSUE_TYPE_FAILED_MACHINE_RECLAIM = 7; */ FAILED_MACHINE_RECLAIM = 7, /** - * MACHINE_ISSUE_TYPE_LAST_EVENT_ERROR machine last event error + * MACHINE_ISSUE_TYPE_LAST_EVENT_ERROR machine last event error. * * @generated from enum value: MACHINE_ISSUE_TYPE_LAST_EVENT_ERROR = 8; */ LAST_EVENT_ERROR = 8, /** - * MACHINE_ISSUE_TYPE_LIVELINESS_DEAD machine is dead + * MACHINE_ISSUE_TYPE_LIVELINESS_DEAD machine is dead. * * @generated from enum value: MACHINE_ISSUE_TYPE_LIVELINESS_DEAD = 9; */ LIVELINESS_DEAD = 9, /** - * MACHINE_ISSUE_TYPE_LIVELINESS_NOT_AVAILABLE machine liveliness is not available + * MACHINE_ISSUE_TYPE_LIVELINESS_NOT_AVAILABLE machine liveliness is not available. * * @generated from enum value: MACHINE_ISSUE_TYPE_LIVELINESS_NOT_AVAILABLE = 10; */ LIVELINESS_NOT_AVAILABLE = 10, /** - * MACHINE_ISSUE_TYPE_LIVELINESS_UNKNOWN machine liveliness is unknown + * MACHINE_ISSUE_TYPE_LIVELINESS_UNKNOWN machine liveliness is unknown. * * @generated from enum value: MACHINE_ISSUE_TYPE_LIVELINESS_UNKNOWN = 11; */ LIVELINESS_UNKNOWN = 11, /** - * MACHINE_ISSUE_TYPE_NO_EVENT_CONTAINER machine does not have a event container + * MACHINE_ISSUE_TYPE_NO_EVENT_CONTAINER machine does not have a event container. * * @generated from enum value: MACHINE_ISSUE_TYPE_NO_EVENT_CONTAINER = 12; */ NO_EVENT_CONTAINER = 12, /** - * MACHINE_ISSUE_TYPE_NO_PARTITION no partition set + * MACHINE_ISSUE_TYPE_NO_PARTITION no partition set. * * @generated from enum value: MACHINE_ISSUE_TYPE_NO_PARTITION = 13; */ @@ -2437,25 +2429,25 @@ export declare const MachineIssueTypeSchema: GenEnum; */ export declare enum MachineIssueSeverity { /** - * MACHINE_ISSUE_SEVERITY_UNSPECIFIED severity is not specified + * MACHINE_ISSUE_SEVERITY_UNSPECIFIED severity is not specified. * * @generated from enum value: MACHINE_ISSUE_SEVERITY_UNSPECIFIED = 0; */ UNSPECIFIED = 0, /** - * MACHINE_ISSUE_SEVERITY_MINOR machine issues is of severity minor + * MACHINE_ISSUE_SEVERITY_MINOR machine issues is of severity minor. * * @generated from enum value: MACHINE_ISSUE_SEVERITY_MINOR = 1; */ MINOR = 1, /** - * MACHINE_ISSUE_SEVERITY_MAJOR machine issues is of severity major + * MACHINE_ISSUE_SEVERITY_MAJOR machine issues is of severity major. * * @generated from enum value: MACHINE_ISSUE_SEVERITY_MAJOR = 2; */ MAJOR = 2, /** - * MACHINE_ISSUE_SEVERITY_CRITICAL machine issues is of severity critical + * MACHINE_ISSUE_SEVERITY_CRITICAL machine issues is of severity critical. * * @generated from enum value: MACHINE_ISSUE_SEVERITY_CRITICAL = 3; */ diff --git a/js/metalstack/api/v2/machine_pb.js b/js/metalstack/api/v2/machine_pb.js index 26ea8592..ebc0ea61 100644 --- a/js/metalstack/api/v2/machine_pb.js +++ b/js/metalstack/api/v2/machine_pb.js @@ -309,19 +309,19 @@ export var MachineState; */ MachineState[MachineState["UNSPECIFIED"] = 0] = "UNSPECIFIED"; /** - * MACHINE_STATE_TAINTED this machine is tainted, i.e. this machine is not considered during random machine allocation, but still by specifying the uuid + * MACHINE_STATE_TAINTED this machine is tainted, i.e. this machine is not considered during random machine allocation, but still by specifying the uui. * * @generated from enum value: MACHINE_STATE_TAINTED = 1; */ MachineState[MachineState["TAINTED"] = 1] = "TAINTED"; /** - * MACHINE_STATE_LOCKED this machine is locked, i.e. this machine cannot be allocated or deleted + * MACHINE_STATE_LOCKED this machine is locked, i.e. this machine cannot be allocated or delete. * * @generated from enum value: MACHINE_STATE_LOCKED = 2; */ MachineState[MachineState["LOCKED"] = 2] = "LOCKED"; /** - * MACHINE_STATE_AVAILABLE this machine is available for all + * MACHINE_STATE_AVAILABLE this machine is available for all. * * @generated from enum value: MACHINE_STATE_AVAILABLE = 3; */ @@ -332,7 +332,7 @@ export var MachineState; */ export const MachineStateSchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_machine, 1); /** - * MachineProvisioningEventState possible event states + * MachineProvisioningEventState possible event states. * * @generated from enum metalstack.api.v2.MachineProvisioningEventState */ @@ -345,13 +345,13 @@ export var MachineProvisioningEventState; */ MachineProvisioningEventState[MachineProvisioningEventState["UNSPECIFIED"] = 0] = "UNSPECIFIED"; /** - * MACHINE_PROVISIONING_EVENT_STATE_CRASHLOOP machine is in crash loop + * MACHINE_PROVISIONING_EVENT_STATE_CRASHLOOP machine is in crash loop. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_STATE_CRASHLOOP = 1; */ MachineProvisioningEventState[MachineProvisioningEventState["CRASHLOOP"] = 1] = "CRASHLOOP"; /** - * MACHINE_PROVISIONING_EVENT_STATE_FAILED_RECLAIM machine is in failed reclaim + * MACHINE_PROVISIONING_EVENT_STATE_FAILED_RECLAIM machine is in failed reclaim. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_STATE_FAILED_RECLAIM = 2; */ @@ -375,67 +375,67 @@ export var MachineProvisioningEventType; */ MachineProvisioningEventType[MachineProvisioningEventType["UNSPECIFIED"] = 0] = "UNSPECIFIED"; /** - * MACHINE_PROVISIONING_EVENT_TYPE_ALIVE machine is alive + * MACHINE_PROVISIONING_EVENT_TYPE_ALIVE machine is alive. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_ALIVE = 1; */ MachineProvisioningEventType[MachineProvisioningEventType["ALIVE"] = 1] = "ALIVE"; /** - * MACHINE_PROVISIONING_EVENT_TYPE_CRASHED machine crashed + * MACHINE_PROVISIONING_EVENT_TYPE_CRASHED machine crashed. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_CRASHED = 2; */ MachineProvisioningEventType[MachineProvisioningEventType["CRASHED"] = 2] = "CRASHED"; /** - * MACHINE_PROVISIONING_EVENT_TYPE_PXE_BOOTING machine is pxe booting into metal-hammer + * MACHINE_PROVISIONING_EVENT_TYPE_PXE_BOOTING machine is pxe booting into metal-hammer. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_PXE_BOOTING = 3; */ MachineProvisioningEventType[MachineProvisioningEventType["PXE_BOOTING"] = 3] = "PXE_BOOTING"; /** - * MACHINE_PROVISIONING_EVENT_TYPE_PLANNED_REBOOT machine got a reboot instruction + * MACHINE_PROVISIONING_EVENT_TYPE_PLANNED_REBOOT machine got a reboot instruction. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_PLANNED_REBOOT = 4; */ MachineProvisioningEventType[MachineProvisioningEventType["PLANNED_REBOOT"] = 4] = "PLANNED_REBOOT"; /** - * MACHINE_PROVISIONING_EVENT_TYPE_PREPARING metal-hammer is preparing the machine + * MACHINE_PROVISIONING_EVENT_TYPE_PREPARING metal-hammer is preparing the machine. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_PREPARING = 5; */ MachineProvisioningEventType[MachineProvisioningEventType["PREPARING"] = 5] = "PREPARING"; /** - * MACHINE_PROVISIONING_EVENT_TYPE_REGISTERING metal-hammer registers machine at the apiserver + * MACHINE_PROVISIONING_EVENT_TYPE_REGISTERING metal-hammer registers machine at the apiserver. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_REGISTERING = 6; */ MachineProvisioningEventType[MachineProvisioningEventType["REGISTERING"] = 6] = "REGISTERING"; /** - * MACHINE_PROVISIONING_EVENT_TYPE_WAITING machine is waiting for installation + * MACHINE_PROVISIONING_EVENT_TYPE_WAITING machine is waiting for installation. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_WAITING = 7; */ MachineProvisioningEventType[MachineProvisioningEventType["WAITING"] = 7] = "WAITING"; /** - * MACHINE_PROVISIONING_EVENT_TYPE_INSTALLING metal-hammer is installing the desired os + * MACHINE_PROVISIONING_EVENT_TYPE_INSTALLING metal-hammer is installing the desired os. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_INSTALLING = 8; */ MachineProvisioningEventType[MachineProvisioningEventType["INSTALLING"] = 8] = "INSTALLING"; /** - * MACHINE_PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL metal-hammer completed installation and boots into target os + * MACHINE_PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL metal-hammer completed installation and boots into target os. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL = 9; */ MachineProvisioningEventType[MachineProvisioningEventType["BOOTING_NEW_KERNEL"] = 9] = "BOOTING_NEW_KERNEL"; /** - * MACHINE_PROVISIONING_EVENT_TYPE_PHONED_HOME machine is installed and phones home + * MACHINE_PROVISIONING_EVENT_TYPE_PHONED_HOME machine is installed and phones home. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_PHONED_HOME = 10; */ MachineProvisioningEventType[MachineProvisioningEventType["PHONED_HOME"] = 10] = "PHONED_HOME"; /** - * MACHINE_PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM machine is not allocated, but phones home + * MACHINE_PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM machine is not allocated, but phones home. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM = 11; */ @@ -459,19 +459,19 @@ export var MachineLiveliness; */ MachineLiveliness[MachineLiveliness["UNSPECIFIED"] = 0] = "UNSPECIFIED"; /** - * MACHINE_LIVELINESS_ALIVE liveliness is alive + * MACHINE_LIVELINESS_ALIVE liveliness is alive. * * @generated from enum value: MACHINE_LIVELINESS_ALIVE = 1; */ MachineLiveliness[MachineLiveliness["ALIVE"] = 1] = "ALIVE"; /** - * MACHINE_LIVELINESS_DEAD liveliness is dead + * MACHINE_LIVELINESS_DEAD liveliness is dead. * * @generated from enum value: MACHINE_LIVELINESS_DEAD = 2; */ MachineLiveliness[MachineLiveliness["DEAD"] = 2] = "DEAD"; /** - * MACHINE_LIVELINESS_UNKNOWN liveliness is unknown + * MACHINE_LIVELINESS_UNKNOWN liveliness is unknown. * * @generated from enum value: MACHINE_LIVELINESS_UNKNOWN = 3; */ @@ -549,43 +549,43 @@ export var MachineBMCCommand; */ MachineBMCCommand[MachineBMCCommand["MACHINE_BMC_COMMAND_CYCLE"] = 4] = "MACHINE_BMC_COMMAND_CYCLE"; /** - * MACHINE_BMC_COMMAND_BOOT_TO_BIOS boot the machine into bios + * MACHINE_BMC_COMMAND_BOOT_TO_BIOS boot the machine into bios. * * @generated from enum value: MACHINE_BMC_COMMAND_BOOT_TO_BIOS = 5; */ MachineBMCCommand[MachineBMCCommand["MACHINE_BMC_COMMAND_BOOT_TO_BIOS"] = 5] = "MACHINE_BMC_COMMAND_BOOT_TO_BIOS"; /** - * MACHINE_BMC_COMMAND_BOOT_FROM_DISK boot the machine from hard disk + * MACHINE_BMC_COMMAND_BOOT_FROM_DISK boot the machine from hard disk. * * @generated from enum value: MACHINE_BMC_COMMAND_BOOT_FROM_DISK = 6; */ MachineBMCCommand[MachineBMCCommand["MACHINE_BMC_COMMAND_BOOT_FROM_DISK"] = 6] = "MACHINE_BMC_COMMAND_BOOT_FROM_DISK"; /** - * MACHINE_BMC_COMMAND_BOOT_FROM_PXE boot the machine from pxe + * MACHINE_BMC_COMMAND_BOOT_FROM_PXE boot the machine from pxe. * * @generated from enum value: MACHINE_BMC_COMMAND_BOOT_FROM_PXE = 7; */ MachineBMCCommand[MachineBMCCommand["MACHINE_BMC_COMMAND_BOOT_FROM_PXE"] = 7] = "MACHINE_BMC_COMMAND_BOOT_FROM_PXE"; /** - * MACHINE_BMC_COMMAND_IDENTIFY_LED_ON set identify led of the machine chassis to on + * MACHINE_BMC_COMMAND_IDENTIFY_LED_ON set identify led of the machine chassis to on. * * @generated from enum value: MACHINE_BMC_COMMAND_IDENTIFY_LED_ON = 8; */ MachineBMCCommand[MachineBMCCommand["MACHINE_BMC_COMMAND_IDENTIFY_LED_ON"] = 8] = "MACHINE_BMC_COMMAND_IDENTIFY_LED_ON"; /** - * MACHINE_BMC_COMMAND_IDENTIFY_LED_OFF set identify led of the machine chassis to off + * MACHINE_BMC_COMMAND_IDENTIFY_LED_OFF set identify led of the machine chassis to off. * * @generated from enum value: MACHINE_BMC_COMMAND_IDENTIFY_LED_OFF = 9; */ MachineBMCCommand[MachineBMCCommand["MACHINE_BMC_COMMAND_IDENTIFY_LED_OFF"] = 9] = "MACHINE_BMC_COMMAND_IDENTIFY_LED_OFF"; /** - * MACHINE_BMC_COMMAND_MACHINE_DELETED should be called if the machine was deleted to power cycle and boot into pxe + * MACHINE_BMC_COMMAND_MACHINE_DELETED should be called if the machine was deleted to power cycle and boot into pxe. * * @generated from enum value: MACHINE_BMC_COMMAND_MACHINE_DELETED = 10; */ MachineBMCCommand[MachineBMCCommand["MACHINE_BMC_COMMAND_MACHINE_DELETED"] = 10] = "MACHINE_BMC_COMMAND_MACHINE_DELETED"; /** - * MACHINE_BMC_COMMAND_MACHINE_CREATED should be called if the machine was created to set the boot order to boot from disk + * MACHINE_BMC_COMMAND_MACHINE_CREATED should be called if the machine was created to set the boot order to boot from disk. * * @generated from enum value: MACHINE_BMC_COMMAND_MACHINE_CREATED = 11; */ @@ -603,85 +603,85 @@ export const MachineBMCCommandSchema = /*@__PURE__*/ enumDesc(file_metalstack_ap export var MachineIssueType; (function (MachineIssueType) { /** - * MACHINE_ISSUE_TYPE_UNSPECIFIED type is not specified + * MACHINE_ISSUE_TYPE_UNSPECIFIED type is not specified. * * @generated from enum value: MACHINE_ISSUE_TYPE_UNSPECIFIED = 0; */ MachineIssueType[MachineIssueType["UNSPECIFIED"] = 0] = "UNSPECIFIED"; /** - * MACHINE_ISSUE_TYPE_ASN_UNIQUENESS machine asn is not unique + * MACHINE_ISSUE_TYPE_ASN_UNIQUENESS machine asn is not unique. * * @generated from enum value: MACHINE_ISSUE_TYPE_ASN_UNIQUENESS = 1; */ MachineIssueType[MachineIssueType["ASN_UNIQUENESS"] = 1] = "ASN_UNIQUENESS"; /** - * MACHINE_ISSUE_TYPE_BMC_INFO_OUTDATED machine bmc info out of date + * MACHINE_ISSUE_TYPE_BMC_INFO_OUTDATED machine bmc info out of date. * * @generated from enum value: MACHINE_ISSUE_TYPE_BMC_INFO_OUTDATED = 2; */ MachineIssueType[MachineIssueType["BMC_INFO_OUTDATED"] = 2] = "BMC_INFO_OUTDATED"; /** - * MACHINE_ISSUE_TYPE_BMC_NON_DISTINCT_IP machine bmc ip is not distinct + * MACHINE_ISSUE_TYPE_BMC_NON_DISTINCT_IP machine bmc ip is not distinct. * * @generated from enum value: MACHINE_ISSUE_TYPE_BMC_NON_DISTINCT_IP = 3; */ MachineIssueType[MachineIssueType["BMC_NON_DISTINCT_IP"] = 3] = "BMC_NON_DISTINCT_IP"; /** - * MACHINE_ISSUE_TYPE_BMC_WITHOUT_IP machine bmc without ip + * MACHINE_ISSUE_TYPE_BMC_WITHOUT_IP machine bmc without ip. * * @generated from enum value: MACHINE_ISSUE_TYPE_BMC_WITHOUT_IP = 4; */ MachineIssueType[MachineIssueType["BMC_WITHOUT_IP"] = 4] = "BMC_WITHOUT_IP"; /** - * MACHINE_ISSUE_TYPE_BMC_WITHOUT_MAC machine bmc without mac address + * MACHINE_ISSUE_TYPE_BMC_WITHOUT_MAC machine bmc without mac address. * * @generated from enum value: MACHINE_ISSUE_TYPE_BMC_WITHOUT_MAC = 5; */ MachineIssueType[MachineIssueType["BMC_WITHOUT_MAC"] = 5] = "BMC_WITHOUT_MAC"; /** - * MACHINE_ISSUE_TYPE_CRASH_LOOP machine is in crashloop + * MACHINE_ISSUE_TYPE_CRASH_LOOP machine is in crashloop. * * @generated from enum value: MACHINE_ISSUE_TYPE_CRASH_LOOP = 6; */ MachineIssueType[MachineIssueType["CRASH_LOOP"] = 6] = "CRASH_LOOP"; /** - * MACHINE_ISSUE_TYPE_FAILED_MACHINE_RECLAIM machine was not freed after delete + * MACHINE_ISSUE_TYPE_FAILED_MACHINE_RECLAIM machine was not freed after delete. * * @generated from enum value: MACHINE_ISSUE_TYPE_FAILED_MACHINE_RECLAIM = 7; */ MachineIssueType[MachineIssueType["FAILED_MACHINE_RECLAIM"] = 7] = "FAILED_MACHINE_RECLAIM"; /** - * MACHINE_ISSUE_TYPE_LAST_EVENT_ERROR machine last event error + * MACHINE_ISSUE_TYPE_LAST_EVENT_ERROR machine last event error. * * @generated from enum value: MACHINE_ISSUE_TYPE_LAST_EVENT_ERROR = 8; */ MachineIssueType[MachineIssueType["LAST_EVENT_ERROR"] = 8] = "LAST_EVENT_ERROR"; /** - * MACHINE_ISSUE_TYPE_LIVELINESS_DEAD machine is dead + * MACHINE_ISSUE_TYPE_LIVELINESS_DEAD machine is dead. * * @generated from enum value: MACHINE_ISSUE_TYPE_LIVELINESS_DEAD = 9; */ MachineIssueType[MachineIssueType["LIVELINESS_DEAD"] = 9] = "LIVELINESS_DEAD"; /** - * MACHINE_ISSUE_TYPE_LIVELINESS_NOT_AVAILABLE machine liveliness is not available + * MACHINE_ISSUE_TYPE_LIVELINESS_NOT_AVAILABLE machine liveliness is not available. * * @generated from enum value: MACHINE_ISSUE_TYPE_LIVELINESS_NOT_AVAILABLE = 10; */ MachineIssueType[MachineIssueType["LIVELINESS_NOT_AVAILABLE"] = 10] = "LIVELINESS_NOT_AVAILABLE"; /** - * MACHINE_ISSUE_TYPE_LIVELINESS_UNKNOWN machine liveliness is unknown + * MACHINE_ISSUE_TYPE_LIVELINESS_UNKNOWN machine liveliness is unknown. * * @generated from enum value: MACHINE_ISSUE_TYPE_LIVELINESS_UNKNOWN = 11; */ MachineIssueType[MachineIssueType["LIVELINESS_UNKNOWN"] = 11] = "LIVELINESS_UNKNOWN"; /** - * MACHINE_ISSUE_TYPE_NO_EVENT_CONTAINER machine does not have a event container + * MACHINE_ISSUE_TYPE_NO_EVENT_CONTAINER machine does not have a event container. * * @generated from enum value: MACHINE_ISSUE_TYPE_NO_EVENT_CONTAINER = 12; */ MachineIssueType[MachineIssueType["NO_EVENT_CONTAINER"] = 12] = "NO_EVENT_CONTAINER"; /** - * MACHINE_ISSUE_TYPE_NO_PARTITION no partition set + * MACHINE_ISSUE_TYPE_NO_PARTITION no partition set. * * @generated from enum value: MACHINE_ISSUE_TYPE_NO_PARTITION = 13; */ @@ -699,25 +699,25 @@ export const MachineIssueTypeSchema = /*@__PURE__*/ enumDesc(file_metalstack_api export var MachineIssueSeverity; (function (MachineIssueSeverity) { /** - * MACHINE_ISSUE_SEVERITY_UNSPECIFIED severity is not specified + * MACHINE_ISSUE_SEVERITY_UNSPECIFIED severity is not specified. * * @generated from enum value: MACHINE_ISSUE_SEVERITY_UNSPECIFIED = 0; */ MachineIssueSeverity[MachineIssueSeverity["UNSPECIFIED"] = 0] = "UNSPECIFIED"; /** - * MACHINE_ISSUE_SEVERITY_MINOR machine issues is of severity minor + * MACHINE_ISSUE_SEVERITY_MINOR machine issues is of severity minor. * * @generated from enum value: MACHINE_ISSUE_SEVERITY_MINOR = 1; */ MachineIssueSeverity[MachineIssueSeverity["MINOR"] = 1] = "MINOR"; /** - * MACHINE_ISSUE_SEVERITY_MAJOR machine issues is of severity major + * MACHINE_ISSUE_SEVERITY_MAJOR machine issues is of severity major. * * @generated from enum value: MACHINE_ISSUE_SEVERITY_MAJOR = 2; */ MachineIssueSeverity[MachineIssueSeverity["MAJOR"] = 2] = "MAJOR"; /** - * MACHINE_ISSUE_SEVERITY_CRITICAL machine issues is of severity critical + * MACHINE_ISSUE_SEVERITY_CRITICAL machine issues is of severity critical. * * @generated from enum value: MACHINE_ISSUE_SEVERITY_CRITICAL = 3; */ diff --git a/js/metalstack/api/v2/machine_pb.ts b/js/metalstack/api/v2/machine_pb.ts index 99aa02e5..31fa7234 100644 --- a/js/metalstack/api/v2/machine_pb.ts +++ b/js/metalstack/api/v2/machine_pb.ts @@ -35,14 +35,14 @@ export const file_metalstack_api_v2_machine: GenFile = /*@__PURE__*/ */ export type MachineServiceGetRequest = Message<"metalstack.api.v2.MachineServiceGetRequest"> & { /** - * UUID of the machine to get + * UUID of the machine to get. * * @generated from field: string uuid = 1; */ uuid: string; /** - * Project of the machine + * Project of the machine. * * @generated from field: string project = 2; */ @@ -84,7 +84,7 @@ export const MachineServiceGetResponseSchema: GenMessage & { /** - * Project of the machine + * Project of the machine. * * @generated from field: string project = 1; */ @@ -93,64 +93,64 @@ export type MachineServiceCreateRequest = Message<"metalstack.api.v2.MachineServ /** * UUID if this field is set, this specific machine will be allocated if it is not in available state and not currently allocated. * this field takes precedence over size and partition. - * Can only be used with ADMIN_ROLE_EDITOR + * Can only be used with ADMIN_ROLE_EDITOR. * * @generated from field: optional string uuid = 2; */ uuid?: string | undefined; /** - * Name of this machine + * Name of this machine. * * @generated from field: string name = 3; */ name: string; /** - * Description for this machine + * Description for this machine. * * @generated from field: optional string description = 4; */ description?: string | undefined; /** - * Hostname the hostname for the allocated machine (defaults to metal) + * Hostname the hostname for the allocated machine (defaults to metal). * * @generated from field: optional string hostname = 5; */ hostname?: string | undefined; /** - * Partition the partition id to assign this machine to, must be omitted if uuid is given + * Partition the partition id to assign this machine to, must be omitted if uuid is given. * * @generated from field: optional string partition = 6; */ partition?: string | undefined; /** - * Size of the machine to create, must be omitted if uuid is given + * Size of the machine to create, must be omitted if uuid is given. * * @generated from field: optional string size = 7; */ size?: string | undefined; /** - * Image which should be installed on this machine - * The image can be specified either in the fully qualified form, e.g. including os, major, minor and patch. - * - debian-13.0.20260402 - * or in a simplified form which omits the patch version - * - debian-13.0 - * If the fully qualified form is specified, exactly this image is taken regardless of the image classification - * if the short form is given, only the most recent images which has image classification supported is used. + * Image which should be installed on this machine. + * The image can be specified either in the fully qualified form, e.g. including os, major, minor and patch + * - debian-13.0.2026040 + * - or in a simplified form which omits the patch version. + * - debian-13. + * If the fully qualified form is specified, exactly this image is taken regardless of the image classification. + * If the short form is given, only the most recent images which has image classification supported is used. * * @generated from field: string image = 8; */ image: string; /** - * FilesystemLayout which should be applied for the operating system installation + * FilesystemLayout which should be applied for the operating system installation. * Is defaulted by a lookup at the available fsls for this size and image. - * Can be specified to test new fsls during development of fsls + * Can be specified to test new fsls during development of fsls. * * @generated from field: optional string filesystem_layout = 9; */ @@ -165,14 +165,14 @@ export type MachineServiceCreateRequest = Message<"metalstack.api.v2.MachineServ /** * Userdata contains instructions required to bootstrap the machine. - * AWS limits the max userdata size to 16k, lets allow twice as much + * AWS limits the max userdata size to 16k, lets allow twice as much. * * @generated from field: optional string userdata = 11; */ userdata?: string | undefined; /** - * Labels to be attached to this machine allocation + * Labels to be attached to this machine allocation. * * @generated from field: metalstack.api.v2.Labels labels = 12; */ @@ -187,28 +187,28 @@ export type MachineServiceCreateRequest = Message<"metalstack.api.v2.MachineServ /** * PlacementTags by default machines are spread across the racks inside a partition for every project. - * if placement tags are provided, the machine candidate has an additional anti-affinity to other machines having the same tags + * if placement tags are provided, the machine candidate has an additional anti-affinity to other machines having the same tags. * * @generated from field: repeated string placement_tags = 14; */ placementTags: string[]; /** - * DNSServer the dns servers used for the machine + * DNSServer the dns servers used for the machine. * * @generated from field: repeated metalstack.api.v2.DNSServer dns_servers = 15; */ dnsServers: DNSServer[]; /** - * NTPServer the ntp servers used for the machine + * NTPServer the ntp servers used for the machine. * * @generated from field: repeated metalstack.api.v2.NTPServer ntp_servers = 16; */ ntpServers: NTPServer[]; /** - * AllocationType of this machine + * AllocationType of this machine. * * @generated from field: metalstack.api.v2.MachineAllocationType allocation_type = 17; */ @@ -236,7 +236,7 @@ export const MachineServiceCreateRequestSchema: GenMessage & { /** - * FirewallRules to be applied if this is a firewall + * FirewallRules to be applied if this is a firewall. * * @generated from field: metalstack.api.v2.FirewallRules firewall_rules = 1; */ @@ -257,7 +257,7 @@ export const FirewallSpecSchema: GenMessage = /*@__PURE__*/ */ export type MachineServiceCreateResponse = Message<"metalstack.api.v2.MachineServiceCreateResponse"> & { /** - * Machine which was created + * Machine which was created. * * @generated from field: metalstack.api.v2.Machine machine = 1; */ @@ -278,7 +278,7 @@ export const MachineServiceCreateResponseSchema: GenMessage & { /** - * UUID of the machine to modify + * UUID of the machine to modify. * * @generated from field: string uuid = 1; */ @@ -292,28 +292,28 @@ export type MachineServiceUpdateRequest = Message<"metalstack.api.v2.MachineServ updateMeta?: UpdateMeta | undefined; /** - * Project of the machine + * Project of the machine. * * @generated from field: string project = 3; */ project: string; /** - * Description of this machine allocation + * Description of this machine allocation. * * @generated from field: optional string description = 4; */ description?: string | undefined; /** - * Labels to update on this machine allocation + * Labels to update on this machine allocation. * * @generated from field: optional metalstack.api.v2.UpdateLabels labels = 5; */ labels?: UpdateLabels | undefined; /** - * SSHPublicKeys which should be update of this machine allocation + * SSHPublicKeys which should be update of this machine allocation. * * @generated from field: repeated string ssh_public_keys = 6; */ @@ -334,7 +334,7 @@ export const MachineServiceUpdateRequestSchema: GenMessage & { /** - * Machine which was updated + * Machine which was updated. * * @generated from field: metalstack.api.v2.Machine machine = 1; */ @@ -355,7 +355,7 @@ export const MachineServiceUpdateResponseSchema: GenMessage & { /** - * Project of the machines to list + * Project of the machines to list. * * @generated from field: string project = 1; */ @@ -404,14 +404,14 @@ export const MachineServiceListResponseSchema: GenMessage & { /** - * UUID of the machine to delete + * UUID of the machine to delete. * * @generated from field: string uuid = 1; */ uuid: string; /** - * Project of the machine + * Project of the machine. * * @generated from field: string project = 2; */ @@ -432,7 +432,7 @@ export const MachineServiceDeleteRequestSchema: GenMessage & { /** - * Machine which was deleted + * Machine which was deleted. * * @generated from field: metalstack.api.v2.Machine machine = 1; */ @@ -453,21 +453,21 @@ export const MachineServiceDeleteResponseSchema: GenMessage & { /** - * UUID of the machine to send the command to + * UUID of the machine to send the command to. * * @generated from field: string uuid = 1; */ uuid: string; /** - * Project of the machine + * Project of the machine. * * @generated from field: string project = 2; */ project: string; /** - * Command to send to the bmc of the machine + * Command to send to the bmc of the machine. * * @generated from field: metalstack.api.v2.MachineBMCCommand command = 3; */ @@ -503,14 +503,14 @@ export const MachineServiceBMCCommandResponseSchema: GenMessage & { /** - * UUID of the machine to get + * UUID of the machine to get. * * @generated from field: string uuid = 1; */ uuid: string; /** - * Project of the machine + * Project of the machine. * * @generated from field: string project = 2; */ @@ -531,7 +531,7 @@ export const MachineServiceGetBMCRequestSchema: GenMessage & { /** - * UUID of the machine + * UUID of the machine. * * @generated from field: string uuid = 1; */ @@ -559,21 +559,21 @@ export const MachineServiceGetBMCResponseSchema: GenMessage & { /** - * UUID of this machine + * UUID of this machine. * * @generated from field: string uuid = 1; */ uuid: string; /** - * Meta for this machine + * Meta for this machine. * * @generated from field: metalstack.api.v2.Meta meta = 2; */ meta?: Meta | undefined; /** - * Partition where this machine resides + * Partition where this machine resides. * * @generated from field: metalstack.api.v2.Partition partition = 3; */ @@ -594,21 +594,21 @@ export type Machine = Message<"metalstack.api.v2.Machine"> & { room: string; /** - * Size of this machine + * Size of this machine. * * @generated from field: metalstack.api.v2.Size size = 6; */ size?: Size | undefined; /** - * Hardware specs of this machine + * Hardware specs of this machine. * * @generated from field: metalstack.api.v2.MachineHardware hardware = 7; */ hardware?: MachineHardware | undefined; /** - * Allocation details + * Allocation details. * * @generated from field: metalstack.api.v2.MachineAllocation allocation = 8; */ @@ -657,14 +657,14 @@ export type MachineStatus = Message<"metalstack.api.v2.MachineStatus"> & { ledState?: MachineChassisIdentifyLEDState | undefined; /** - * Liveliness of this machine + * Liveliness of this machine. * * @generated from field: metalstack.api.v2.MachineLiveliness liveliness = 3; */ liveliness: MachineLiveliness; /** - * MetalHammerVersion the version of metal hammer which put the machine in waiting state + * MetalHammerVersion the version of metal hammer which put the machine in waiting state. * * @generated from field: string metal_hammer_version = 4; */ @@ -685,21 +685,21 @@ export const MachineStatusSchema: GenMessage = /*@__PURE__*/ */ export type MachineCondition = Message<"metalstack.api.v2.MachineCondition"> & { /** - * State the state of this machine. empty means available for all + * State the state of this machine. empty means available for al. * * @generated from field: metalstack.api.v2.MachineState state = 1; */ state: MachineState; /** - * Description a description why this machine is in the given state + * Description a description why this machine is in the given state. * * @generated from field: string description = 2; */ description: string; /** - * Issuer the user that changed the state + * Issuer the user that changed the state. * * @generated from field: string issuer = 3; */ @@ -720,63 +720,63 @@ export const MachineConditionSchema: GenMessage = /*@__PURE__* */ export type MachineAllocation = Message<"metalstack.api.v2.MachineAllocation"> & { /** - * UUID of this machine allocation + * UUID of this machine allocation. * * @generated from field: string uuid = 1; */ uuid: string; /** - * Meta for this machine allocation + * Meta for this machine allocation. * * @generated from field: metalstack.api.v2.Meta meta = 2; */ meta?: Meta | undefined; /** - * Name of this allocation + * Name of this allocation. * * @generated from field: string name = 3; */ name: string; /** - * Description of this allocation + * Description of this allocation. * * @generated from field: string description = 4; */ description: string; /** - * Created By indicates who created this machine allocation + * Created By indicates who created this machine allocation. * * @generated from field: string created_by = 5; */ createdBy: string; /** - * Project of the allocation + * Project of the allocation. * * @generated from field: string project = 6; */ project: string; /** - * Image to be used to install on this machine + * Image to be used to install on this machine. * * @generated from field: metalstack.api.v2.Image image = 7; */ image?: Image | undefined; /** - * FilesystemLayout to create on the disks + * FilesystemLayout to create on the disks. * * @generated from field: metalstack.api.v2.FilesystemLayout filesystem_layout = 8; */ filesystemLayout?: FilesystemLayout | undefined; /** - * Networks this machine should be attached to + * Networks this machine should be attached to. * Order of ips of external networks will be preserved. * * @generated from field: repeated metalstack.api.v2.MachineNetwork networks = 9; @@ -784,14 +784,14 @@ export type MachineAllocation = Message<"metalstack.api.v2.MachineAllocation"> & networks: MachineNetwork[]; /** - * Hostname of the allocated machine + * Hostname of the allocated machine. * * @generated from field: string hostname = 10; */ hostname: string; /** - * SSHPublicKeys which should be installed on this machine + * SSHPublicKeys which should be installed on this machine. * * @generated from field: repeated string ssh_public_keys = 11; */ @@ -799,42 +799,42 @@ export type MachineAllocation = Message<"metalstack.api.v2.MachineAllocation"> & /** * Userdata contains instructions required to bootstrap the machine. - * AWS limits the max userdata size to 16k, lets allow twice as much + * AWS limits the max userdata size to 16k, lets allow twice as much. * * @generated from field: string userdata = 12; */ userdata: string; /** - * AllocationType of this machine + * AllocationType of this machine. * * @generated from field: metalstack.api.v2.MachineAllocationType allocation_type = 13; */ allocationType: MachineAllocationType; /** - * FirewallRules to be applied if this is a firewall + * FirewallRules to be applied if this is a firewall. * * @generated from field: metalstack.api.v2.FirewallRules firewall_rules = 14; */ firewallRules?: FirewallRules | undefined; /** - * DNSServers for this machine + * DNSServers for this machine. * * @generated from field: repeated metalstack.api.v2.DNSServer dns_servers = 15; */ dnsServers: DNSServer[]; /** - * NTPServers for this machine + * NTPServers for this machine. * * @generated from field: repeated metalstack.api.v2.NTPServer ntp_servers = 16; */ ntpServers: NTPServer[]; /** - * VPN connection configuration + * VPN connection configuration. * * @generated from field: metalstack.api.v2.MachineVPN vpn = 17; */ @@ -855,14 +855,14 @@ export const MachineAllocationSchema: GenMessage = /*@__PURE_ */ export type MachineAllocationNetwork = Message<"metalstack.api.v2.MachineAllocationNetwork"> & { /** - * Network the id of the network that this machine will be placed in + * Network the id of the network that this machine will be placed in. * * @generated from field: string network = 1; */ network: string; /** - * IPs to to attach to this machine additionally + * IPs to to attach to this machine additionally. * If none given, one ip address is acquired per network for the machine. * Order of ips is preserved on the loopback interface. * @@ -913,28 +913,28 @@ export const FirewallRulesSchema: GenMessage = /*@__PURE__*/ */ export type FirewallEgressRule = Message<"metalstack.api.v2.FirewallEgressRule"> & { /** - * Protocol the protocol for the rule, defaults to tcp + * Protocol the protocol for the rule, defaults to tcp. * * @generated from field: metalstack.api.v2.IPProtocol protocol = 1; */ protocol: IPProtocol; /** - * Ports the ports affected by this rule + * Ports the ports affected by this rule. * * @generated from field: repeated uint32 ports = 2; */ ports: number[]; /** - * To the destination cidrs affected by this rule + * To the destination cidrs affected by this rule. * * @generated from field: repeated string to = 3; */ to: string[]; /** - * Comment for this rule + * Comment for this rule. * * @generated from field: string comment = 4; */ @@ -955,35 +955,35 @@ export const FirewallEgressRuleSchema: GenMessage = /*@__PUR */ export type FirewallIngressRule = Message<"metalstack.api.v2.FirewallIngressRule"> & { /** - * Protocol the protocol for the rule, defaults to tcp + * Protocol the protocol for the rule, defaults to tcp. * * @generated from field: metalstack.api.v2.IPProtocol protocol = 1; */ protocol: IPProtocol; /** - * Ports the ports affected by this rule + * Ports the ports affected by this rule. * * @generated from field: repeated uint32 ports = 2; */ ports: number[]; /** - * To the destination cidrs affected by this rule + * To the destination cidrs affected by this rule. * * @generated from field: repeated string to = 3; */ to: string[]; /** - * From the source cidrs affected by this rule + * From the source cidrs affected by this rule. * * @generated from field: repeated string from = 4; */ from: string[]; /** - * Comment for this rule + * Comment for this rule. * * @generated from field: string comment = 5; */ @@ -1004,14 +1004,14 @@ export const FirewallIngressRuleSchema: GenMessage = /*@__P */ export type MachineNetwork = Message<"metalstack.api.v2.MachineNetwork"> & { /** - * Network the networkID of the allocated machine in this vrf + * Network the networkID of the allocated machine in this vrf. * * @generated from field: string network = 1; */ network: string; /** - * Prefixes the prefixes of this network + * Prefixes the prefixes of this network. * * @generated from field: repeated string prefixes = 2; */ @@ -1025,14 +1025,14 @@ export type MachineNetwork = Message<"metalstack.api.v2.MachineNetwork"> & { destinationPrefixes: string[]; /** - * IPs the ip addresses of the allocated machine in this vrf + * IPs the ip addresses of the allocated machine in this vrf. * * @generated from field: repeated string ips = 4; */ ips: string[]; /** - * NetworkType the type of network of this vrf + * NetworkType the type of network of this vrf. * * @generated from field: metalstack.api.v2.NetworkType network_type = 5; */ @@ -1046,14 +1046,14 @@ export type MachineNetwork = Message<"metalstack.api.v2.MachineNetwork"> & { natType: NATType; /** - * VRF the vrf id + * VRF the vrf id. * * @generated from field: uint64 vrf = 7; */ vrf: bigint; /** - * ASN the autonomous system number for this network + * ASN the autonomous system number for this network. * * @generated from field: uint32 asn = 8; */ @@ -1081,35 +1081,35 @@ export const MachineNetworkSchema: GenMessage = /*@__PURE__*/ */ export type MachineHardware = Message<"metalstack.api.v2.MachineHardware"> & { /** - * Memory the total memory of the machine in bytes + * Memory the total memory of the machine in bytes. * * @generated from field: uint64 memory = 1; */ memory: bigint; /** - * Disks the list of block devices of this machine + * Disks the list of block devices of this machine. * * @generated from field: repeated metalstack.api.v2.MachineBlockDevice disks = 2; */ disks: MachineBlockDevice[]; /** - * CPUs the cpu details + * CPUs the cpu details. * * @generated from field: repeated metalstack.api.v2.MetalCPU cpus = 3; */ cpus: MetalCPU[]; /** - * GPUs the gpu details + * GPUs the gpu details. * * @generated from field: repeated metalstack.api.v2.MetalGPU gpus = 4; */ gpus: MetalGPU[]; /** - * Nics the list of network interfaces of this machine + * Nics the list of network interfaces of this machine. * * @generated from field: repeated metalstack.api.v2.MachineNic nics = 5; */ @@ -1130,28 +1130,28 @@ export const MachineHardwareSchema: GenMessage = /*@__PURE__*/ */ export type MetalCPU = Message<"metalstack.api.v2.MetalCPU"> & { /** - * Vendor of this cpu + * Vendor of this cpu. * * @generated from field: string vendor = 1; */ vendor: string; /** - * Model of this cpu + * Model of this cpu. * * @generated from field: string model = 2; */ model: string; /** - * Cores of this cpu + * Cores of this cpu. * * @generated from field: uint32 cores = 3; */ cores: number; /** - * Threads of this cpu + * Threads of this cpu. * * @generated from field: uint32 threads = 4; */ @@ -1172,14 +1172,14 @@ export const MetalCPUSchema: GenMessage = /*@__PURE__*/ */ export type MetalGPU = Message<"metalstack.api.v2.MetalGPU"> & { /** - * Vendor of this gpu + * Vendor of this gpu. * * @generated from field: string vendor = 1; */ vendor: string; /** - * Model of this gpu + * Model of this gpu. * * @generated from field: string model = 2; */ @@ -1200,56 +1200,56 @@ export const MetalGPUSchema: GenMessage = /*@__PURE__*/ */ export type MachineNic = Message<"metalstack.api.v2.MachineNic"> & { /** - * Mac the macaddress of this interface + * Mac the macaddress of this interface. * * @generated from field: string mac = 1; */ mac: string; /** - * Name of this interface + * Name of this interface. * * @generated from field: string name = 2; */ name: string; /** - * Identifier the unique identifier of this network interface + * Identifier the unique identifier of this network interface. * * @generated from field: string identifier = 3; */ identifier: string; /** - * Vendor of this network card + * Vendor of this network card. * * @generated from field: string vendor = 4; */ vendor: string; /** - * Model of this network card + * Model of this network card. * * @generated from field: string model = 5; */ model: string; /** - * Speed in bits/second of this network card + * Speed in bits/second of this network card. * * @generated from field: uint64 speed = 6; */ speed: bigint; /** - * Neighbors the neighbors visible to this network interface + * Neighbors the neighbors visible to this network interface. * * @generated from field: repeated metalstack.api.v2.MachineNic neighbors = 7; */ neighbors: MachineNic[]; /** - * Hostname the nic belongs to + * Hostname the nic belongs to. * * @generated from field: string hostname = 8; */ @@ -1270,14 +1270,14 @@ export const MachineNicSchema: GenMessage = /*@__PURE__*/ */ export type MachineBlockDevice = Message<"metalstack.api.v2.MachineBlockDevice"> & { /** - * Name of this block device + * Name of this block device. * * @generated from field: string name = 1; */ name: string; /** - * Size of this block device in bytes + * Size of this block device in bytes. * * @generated from field: uint64 size = 2; */ @@ -1298,14 +1298,14 @@ export const MachineBlockDeviceSchema: GenMessage = /*@__PUR */ export type MachineChassisIdentifyLEDState = Message<"metalstack.api.v2.MachineChassisIdentifyLEDState"> & { /** - * Value the state of this chassis identify LED. empty means LED-OFF + * Value the state of this chassis identify LED. empty means LED-OF. * * @generated from field: string value = 1; */ value: string; /** - * Description a description why this chassis identify LED is in the given state + * Description a description why this chassis identify LED is in the given state. * * @generated from field: string description = 2; */ @@ -1389,21 +1389,21 @@ export const MachineBMCReportSchema: GenMessage = /*@__PURE__* */ export type MachineBios = Message<"metalstack.api.v2.MachineBios"> & { /** - * Version the bios version + * Version the bios version. * * @generated from field: string version = 1; */ version: string; /** - * Vendor the bios vendor + * Vendor the bios vendor. * * @generated from field: string vendor = 2; */ vendor: string; /** - * Date the bios date as string because every vendor has different ideas how to describe the date + * Date the bios date as string because every vendor has different ideas how to describe the date. * * @generated from field: string date = 3; */ @@ -1424,49 +1424,49 @@ export const MachineBiosSchema: GenMessage = /*@__PURE__*/ */ export type MachineBMC = Message<"metalstack.api.v2.MachineBMC"> & { /** - * Address of this ipmi device from outside in the form of : + * Address of this ipmi device from outside in the form of :. * * @generated from field: string address = 1; */ address: string; /** - * Mac address of the network interface of this ipmi device + * Mac address of the network interface of this ipmi device. * * @generated from field: string mac = 2; */ mac: string; /** - * User of this ipmi device + * User of this ipmi device. * * @generated from field: string user = 3; */ user: string; /** - * Password of this ipmi device + * Password of this ipmi device. * * @generated from field: string password = 4; */ password: string; /** - * Interface of this ipmi device + * Interface of this ipmi device. * * @generated from field: string interface = 5; */ interface: string; /** - * Version of this bmc device + * Version of this bmc device. * * @generated from field: string version = 6; */ version: string; /** - * PowerState of this machine + * PowerState of this machine. * * @generated from field: string power_state = 7; */ @@ -1557,18 +1557,14 @@ export const MachineFRUSchema: GenMessage = /*@__PURE__*/ */ export type MachinePowerMetric = Message<"metalstack.api.v2.MachinePowerMetric"> & { /** - * AverageConsumedWatts shall represent the - * average power level that occurred averaged over the last IntervalInMin - * minutes. + * AverageConsumedWatts shall represent the average power level that occurred averaged over the last IntervalInMin minutes. * * @generated from field: float average_consumed_watts = 1; */ averageConsumedWatts: number; /** - * IntervalInMin shall represent the time - * interval (or window), in minutes, in which the PowerMetrics properties - * are measured over. + * IntervalInMin shall represent the time interval (or window), in minutes, in which the PowerMetrics properties are measured over. * Should be an integer, but some Dell implementations return as a float. * * @generated from field: float interval_in_min = 2; @@ -1576,18 +1572,14 @@ export type MachinePowerMetric = Message<"metalstack.api.v2.MachinePowerMetric"> intervalInMin: number; /** - * MaxConsumedWatts shall represent the - * maximum power level in watts that occurred within the last - * IntervalInMin minutes. + * MaxConsumedWatts shall represent the maximum power level in watts that occurred within the last IntervalInMin minutes. * * @generated from field: float max_consumed_watts = 3; */ maxConsumedWatts: number; /** - * MinConsumedWatts shall represent the - * minimum power level in watts that occurred within the last - * IntervalInMin minutes. + * MinConsumedWatts shall represent the minimum power level in watts that occurred within the last IntervalInMin minutes. * * @generated from field: float min_consumed_watts = 4; */ @@ -1608,14 +1600,14 @@ export const MachinePowerMetricSchema: GenMessage = /*@__PUR */ export type MachinePowerSupply = Message<"metalstack.api.v2.MachinePowerSupply"> & { /** - * Health of the powersupply + * Health of the powersupply. * * @generated from field: string health = 1; */ health: string; /** - * State of the powersupply + * State of the powersupply. * * @generated from field: string state = 2; */ @@ -1630,27 +1622,27 @@ export const MachinePowerSupplySchema: GenMessage = /*@__PUR messageDesc(file_metalstack_api_v2_machine, 35); /** - * MachineRecentProvisioningEvents the recent provisioning events for this machine + * MachineRecentProvisioningEvents the recent provisioning events for this machine. * * @generated from message metalstack.api.v2.MachineRecentProvisioningEvents */ export type MachineRecentProvisioningEvents = Message<"metalstack.api.v2.MachineRecentProvisioningEvents"> & { /** - * Events the log of recent machine provisioning events + * Events the log of recent machine provisioning events. * * @generated from field: repeated metalstack.api.v2.MachineProvisioningEvent events = 1; */ events: MachineProvisioningEvent[]; /** - * LastEventTime the time where the last event was received + * LastEventTime the time where the last event was received. * * @generated from field: google.protobuf.Timestamp last_event_time = 2; */ lastEventTime?: Timestamp | undefined; /** - * LastErrorEvent the last erroneous event received + * LastErrorEvent the last erroneous event received. * * @generated from field: metalstack.api.v2.MachineProvisioningEvent last_error_event = 3; */ @@ -1678,21 +1670,21 @@ export const MachineRecentProvisioningEventsSchema: GenMessage & { /** - * Time the time that this event was received + * Time the time that this event was received. * * @generated from field: google.protobuf.Timestamp time = 1; */ time?: Timestamp | undefined; /** - * Event the event emitted by the machine + * Event the event emitted by the machine. * * @generated from field: metalstack.api.v2.MachineProvisioningEventType event = 2; */ event: MachineProvisioningEventType; /** - * Message an additional message to add to the event + * Message an additional message to add to the event. * * @generated from field: string message = 3; */ @@ -1713,14 +1705,14 @@ export const MachineProvisioningEventSchema: GenMessage & { /** - * Address of VPN control plane + * Address of VPN control plane. * * @generated from field: string control_plane_address = 1; */ controlPlaneAddress: string; /** - * Auth key used to connect to VPN + * Auth key used to connect to VPN. * * @generated from field: string auth_key = 2; */ @@ -1734,7 +1726,7 @@ export type MachineVPN = Message<"metalstack.api.v2.MachineVPN"> & { connected: boolean; /** - * IPs of the machine connected to the vpn + * IPs of the machine connected to the vpn. * * @generated from field: repeated string ips = 4; */ @@ -1755,105 +1747,105 @@ export const MachineVPNSchema: GenMessage = /*@__PURE__*/ */ export type MachineQuery = Message<"metalstack.api.v2.MachineQuery"> & { /** - * UUID of the machine to get + * UUID of the machine to get. * * @generated from field: optional string uuid = 1; */ uuid?: string | undefined; /** - * Name of the machine to get + * Name of the machine to get. * * @generated from field: optional string name = 2; */ name?: string | undefined; /** - * Partition of the machine to get + * Partition of the machine to get. * * @generated from field: optional string partition = 3; */ partition?: string | undefined; /** - * Size of the machine to get + * Size of the machine to get. * * @generated from field: optional string size = 4; */ size?: string | undefined; /** - * Rack of the machine to get + * Rack of the machine to get. * * @generated from field: optional string rack = 5; */ rack?: string | undefined; /** - * Room of the machine to get + * Room of the machine to get. * * @generated from field: optional string room = 6; */ room?: string | undefined; /** - * Labels for which this machine should get filtered + * Labels for which this machine should get filtered. * * @generated from field: optional metalstack.api.v2.Labels labels = 7; */ labels?: Labels | undefined; /** - * Allocation specific machine queries + * Allocation specific machine queries. * * @generated from field: optional metalstack.api.v2.MachineAllocationQuery allocation = 8; */ allocation?: MachineAllocationQuery | undefined; /** - * Network specific machine queries + * Network specific machine queries. * * @generated from field: optional metalstack.api.v2.MachineNetworkQuery network = 9; */ network?: MachineNetworkQuery | undefined; /** - * Nic specific machine queries + * Nic specific machine queries. * * @generated from field: optional metalstack.api.v2.MachineNicQuery nic = 10; */ nic?: MachineNicQuery | undefined; /** - * Disk specific machine queries + * Disk specific machine queries. * * @generated from field: optional metalstack.api.v2.MachineDiskQuery disk = 11; */ disk?: MachineDiskQuery | undefined; /** - * Bmc specific machine queries + * Bmc specific machine queries. * * @generated from field: optional metalstack.api.v2.MachineBMCQuery bmc = 12; */ bmc?: MachineBMCQuery | undefined; /** - * Fru specific machine queries + * Fru specific machine queries. * * @generated from field: optional metalstack.api.v2.MachineFRUQuery fru = 13; */ fru?: MachineFRUQuery | undefined; /** - * Hardware specific machine query + * Hardware specific machine query. * * @generated from field: optional metalstack.api.v2.MachineHardwareQuery hardware = 14; */ hardware?: MachineHardwareQuery | undefined; /** - * State this machine has + * State this machine has. * * @generated from field: optional metalstack.api.v2.MachineState state = 15; */ @@ -1892,69 +1884,69 @@ export const MachineQuerySchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_machine, 39); /** - * MachineAllocationQuery allocation specific query parameters + * MachineAllocationQuery allocation specific query parameters. * * @generated from message metalstack.api.v2.MachineAllocationQuery */ export type MachineAllocationQuery = Message<"metalstack.api.v2.MachineAllocationQuery"> & { /** - * UUID of the allocation of the machine to get + * UUID of the allocation of the machine to get. * * @generated from field: optional string uuid = 1; */ uuid?: string | undefined; /** - * Name of the machine to get + * Name of the machine to get. * * @generated from field: optional string name = 2; */ name?: string | undefined; /** - * Project of the machine to get + * Project of the machine to get. * * @generated from field: optional string project = 3; */ project?: string | undefined; /** - * Image of the machine to get + * Image of the machine to get. * * @generated from field: optional string image = 4; */ image?: string | undefined; /** - * FilesystemLayout of the machine to get + * FilesystemLayout of the machine to get. * * @generated from field: optional string filesystem_layout = 5; */ filesystemLayout?: string | undefined; /** - * Hostname of the machine to get + * Hostname of the machine to get. * * @generated from field: optional string hostname = 6; */ hostname?: string | undefined; /** - * AllocationType of this machine + * AllocationType of this machine. * * @generated from field: optional metalstack.api.v2.MachineAllocationType allocation_type = 7; */ allocationType?: MachineAllocationType | undefined; /** - * Labels for which this machine allocation should get filtered + * Labels for which this machine allocation should get filtered. * * @generated from field: optional metalstack.api.v2.Labels labels = 8; */ labels?: Labels | undefined; /** - * VPN query if this machine has a vpn configuration + * VPN query if this machine has a vpn configuration. * * @generated from field: optional metalstack.api.v2.MachineVPN vpn = 9; */ @@ -1969,48 +1961,48 @@ export const MachineAllocationQuerySchema: GenMessage = messageDesc(file_metalstack_api_v2_machine, 40); /** - * MachineNetworkQuery network specific machine queries + * MachineNetworkQuery network specific machine queries. * * @generated from message metalstack.api.v2.MachineNetworkQuery */ export type MachineNetworkQuery = Message<"metalstack.api.v2.MachineNetworkQuery"> & { /** - * Networks this machine is connected to + * Networks this machine is connected to. * * @generated from field: repeated string networks = 1; */ networks: string[]; /** - * Prefixes this machine is connected to + * Prefixes this machine is connected to. * * @generated from field: repeated string prefixes = 2; */ prefixes: string[]; /** - * DestinationPrefixes this machine is connected to + * DestinationPrefixes this machine is connected to. * * @generated from field: repeated string destination_prefixes = 3; */ destinationPrefixes: string[]; /** - * IPs this machine has + * IPs this machine has. * * @generated from field: repeated string ips = 4; */ ips: string[]; /** - * VRFs this machine is connected to + * VRFs this machine is connected to. * * @generated from field: repeated uint64 vrfs = 5; */ vrfs: bigint[]; /** - * ASNs this machine is connected to + * ASNs this machine is connected to. * * @generated from field: repeated uint32 asns = 6; */ @@ -2025,34 +2017,34 @@ export const MachineNetworkQuerySchema: GenMessage = /*@__P messageDesc(file_metalstack_api_v2_machine, 41); /** - * MachineNicQuery nic specific machine queries + * MachineNicQuery nic specific machine queries. * * @generated from message metalstack.api.v2.MachineNicQuery */ export type MachineNicQuery = Message<"metalstack.api.v2.MachineNicQuery"> & { /** - * Macs this machine nic has + * Macs this machine nic has. * * @generated from field: repeated string macs = 1; */ macs: string[]; /** - * Names this machine nic has + * Names this machine nic has. * * @generated from field: repeated string names = 2; */ names: string[]; /** - * NeighborMacs this machine nic has + * NeighborMacs this machine nic has. * * @generated from field: repeated string neighbor_macs = 3; */ neighborMacs: string[]; /** - * NeighborNames this machine nic has + * NeighborNames this machine nic has. * * @generated from field: repeated string neighbor_names = 4; */ @@ -2067,20 +2059,20 @@ export const MachineNicQuerySchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_machine, 42); /** - * MachineDiskQuery disk specific machine queries + * MachineDiskQuery disk specific machine queries. * * @generated from message metalstack.api.v2.MachineDiskQuery */ export type MachineDiskQuery = Message<"metalstack.api.v2.MachineDiskQuery"> & { /** - * Names of disks in this machine + * Names of disks in this machine. * * @generated from field: repeated string names = 1; */ names: string[]; /** - * Sizes of disks in this machine + * Sizes of disks in this machine. * * @generated from field: repeated uint64 sizes = 2; */ @@ -2095,34 +2087,34 @@ export const MachineDiskQuerySchema: GenMessage = /*@__PURE__* messageDesc(file_metalstack_api_v2_machine, 43); /** - * MachineBMCQuery machine ipmi or bmc specific machine queries + * MachineBMCQuery machine ipmi or bmc specific machine queries. * * @generated from message metalstack.api.v2.MachineBMCQuery */ export type MachineBMCQuery = Message<"metalstack.api.v2.MachineBMCQuery"> & { /** - * Address of the ipmi system of this machine + * Address of the ipmi system of this machine. * * @generated from field: optional string address = 1; */ address?: string | undefined; /** - * Mac of the ipmi system of this machine + * Mac of the ipmi system of this machine. * * @generated from field: optional string mac = 2; */ mac?: string | undefined; /** - * User of the ipmi system of this machine + * User of the ipmi system of this machine. * * @generated from field: optional string user = 3; */ user?: string | undefined; /** - * Interface of the ipmi system of this machine + * Interface of the ipmi system of this machine. * * @generated from field: optional string interface = 4; */ @@ -2137,62 +2129,62 @@ export const MachineBMCQuerySchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_machine, 44); /** - * MachineFRUQuery machine fru specific machine queries + * MachineFRUQuery machine fru specific machine queries. * * @generated from message metalstack.api.v2.MachineFRUQuery */ export type MachineFRUQuery = Message<"metalstack.api.v2.MachineFRUQuery"> & { /** - * ChassisPartNumber of this machine + * ChassisPartNumber of this machine. * * @generated from field: optional string chassis_part_number = 1; */ chassisPartNumber?: string | undefined; /** - * ChassisPartSerial of this machine + * ChassisPartSerial of this machine. * * @generated from field: optional string chassis_part_serial = 2; */ chassisPartSerial?: string | undefined; /** - * BoardMFG of this machine + * BoardMFG of this machine. * * @generated from field: optional string board_mfg = 3; */ boardMfg?: string | undefined; /** - * BoardSerial of this machine + * BoardSerial of this machine. * * @generated from field: optional string board_serial = 4; */ boardSerial?: string | undefined; /** - * BoardPartNumber of this machine + * BoardPartNumber of this machine. * * @generated from field: optional string board_part_number = 5; */ boardPartNumber?: string | undefined; /** - * ProductManufacturer of this machine + * ProductManufacturer of this machine. * * @generated from field: optional string product_manufacturer = 6; */ productManufacturer?: string | undefined; /** - * ProductPartNumber of this machine + * ProductPartNumber of this machine. * * @generated from field: optional string product_part_number = 7; */ productPartNumber?: string | undefined; /** - * ProductSerial of this machine + * ProductSerial of this machine. * * @generated from field: optional string product_serial = 8; */ @@ -2207,20 +2199,20 @@ export const MachineFRUQuerySchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_machine, 45); /** - * MachineHardwareQuery machine hardware specific machine queries + * MachineHardwareQuery machine hardware specific machine queries. * * @generated from message metalstack.api.v2.MachineHardwareQuery */ export type MachineHardwareQuery = Message<"metalstack.api.v2.MachineHardwareQuery"> & { /** - * Memory the total memory of the machine in bytes + * Memory the total memory of the machine in bytes. * * @generated from field: optional uint64 memory = 1; */ memory?: bigint | undefined; /** - * CPUCores the number of cpu cores + * CPUCores the number of cpu cores. * * @generated from field: optional uint32 cpu_cores = 2; */ @@ -2241,7 +2233,7 @@ export const MachineHardwareQuerySchema: GenMessage = /*@_ */ export type MachineIssuesQuery = Message<"metalstack.api.v2.MachineIssuesQuery"> & { /** - * MachineQuery to select specific machines + * MachineQuery to select specific machines. * * @generated from field: metalstack.api.v2.MachineQuery machine_query = 1; */ @@ -2255,7 +2247,7 @@ export type MachineIssuesQuery = Message<"metalstack.api.v2.MachineIssuesQuery"> only: MachineIssueType[]; /** - * Omits the specified machine issues + * Omits the specified machine issues. * * @generated from field: repeated metalstack.api.v2.MachineIssueType omit = 3; */ @@ -2290,14 +2282,14 @@ export const MachineIssuesQuerySchema: GenMessage = /*@__PUR */ export type MachineIssues = Message<"metalstack.api.v2.MachineIssues"> & { /** - * UUID of the machine for which the issues are listed + * UUID of the machine for which the issues are listed. * * @generated from field: string uuid = 1; */ uuid: string; /** - * Issues of this machine + * Issues of this machine. * * @generated from field: repeated metalstack.api.v2.MachineIssue issues = 2; */ @@ -2318,7 +2310,7 @@ export const MachineIssuesSchema: GenMessage = /*@__PURE__*/ */ export type MachineIssue = Message<"metalstack.api.v2.MachineIssue"> & { /** - * Type specifies the issue type (id) + * Type specifies the issue type (id). * * @generated from field: metalstack.api.v2.MachineIssueType type = 1; */ @@ -2408,21 +2400,21 @@ export enum MachineState { UNSPECIFIED = 0, /** - * MACHINE_STATE_TAINTED this machine is tainted, i.e. this machine is not considered during random machine allocation, but still by specifying the uuid + * MACHINE_STATE_TAINTED this machine is tainted, i.e. this machine is not considered during random machine allocation, but still by specifying the uui. * * @generated from enum value: MACHINE_STATE_TAINTED = 1; */ TAINTED = 1, /** - * MACHINE_STATE_LOCKED this machine is locked, i.e. this machine cannot be allocated or deleted + * MACHINE_STATE_LOCKED this machine is locked, i.e. this machine cannot be allocated or delete. * * @generated from enum value: MACHINE_STATE_LOCKED = 2; */ LOCKED = 2, /** - * MACHINE_STATE_AVAILABLE this machine is available for all + * MACHINE_STATE_AVAILABLE this machine is available for all. * * @generated from enum value: MACHINE_STATE_AVAILABLE = 3; */ @@ -2436,7 +2428,7 @@ export const MachineStateSchema: GenEnum = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_machine, 1); /** - * MachineProvisioningEventState possible event states + * MachineProvisioningEventState possible event states. * * @generated from enum metalstack.api.v2.MachineProvisioningEventState */ @@ -2449,14 +2441,14 @@ export enum MachineProvisioningEventState { UNSPECIFIED = 0, /** - * MACHINE_PROVISIONING_EVENT_STATE_CRASHLOOP machine is in crash loop + * MACHINE_PROVISIONING_EVENT_STATE_CRASHLOOP machine is in crash loop. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_STATE_CRASHLOOP = 1; */ CRASHLOOP = 1, /** - * MACHINE_PROVISIONING_EVENT_STATE_FAILED_RECLAIM machine is in failed reclaim + * MACHINE_PROVISIONING_EVENT_STATE_FAILED_RECLAIM machine is in failed reclaim. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_STATE_FAILED_RECLAIM = 2; */ @@ -2483,77 +2475,77 @@ export enum MachineProvisioningEventType { UNSPECIFIED = 0, /** - * MACHINE_PROVISIONING_EVENT_TYPE_ALIVE machine is alive + * MACHINE_PROVISIONING_EVENT_TYPE_ALIVE machine is alive. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_ALIVE = 1; */ ALIVE = 1, /** - * MACHINE_PROVISIONING_EVENT_TYPE_CRASHED machine crashed + * MACHINE_PROVISIONING_EVENT_TYPE_CRASHED machine crashed. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_CRASHED = 2; */ CRASHED = 2, /** - * MACHINE_PROVISIONING_EVENT_TYPE_PXE_BOOTING machine is pxe booting into metal-hammer + * MACHINE_PROVISIONING_EVENT_TYPE_PXE_BOOTING machine is pxe booting into metal-hammer. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_PXE_BOOTING = 3; */ PXE_BOOTING = 3, /** - * MACHINE_PROVISIONING_EVENT_TYPE_PLANNED_REBOOT machine got a reboot instruction + * MACHINE_PROVISIONING_EVENT_TYPE_PLANNED_REBOOT machine got a reboot instruction. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_PLANNED_REBOOT = 4; */ PLANNED_REBOOT = 4, /** - * MACHINE_PROVISIONING_EVENT_TYPE_PREPARING metal-hammer is preparing the machine + * MACHINE_PROVISIONING_EVENT_TYPE_PREPARING metal-hammer is preparing the machine. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_PREPARING = 5; */ PREPARING = 5, /** - * MACHINE_PROVISIONING_EVENT_TYPE_REGISTERING metal-hammer registers machine at the apiserver + * MACHINE_PROVISIONING_EVENT_TYPE_REGISTERING metal-hammer registers machine at the apiserver. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_REGISTERING = 6; */ REGISTERING = 6, /** - * MACHINE_PROVISIONING_EVENT_TYPE_WAITING machine is waiting for installation + * MACHINE_PROVISIONING_EVENT_TYPE_WAITING machine is waiting for installation. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_WAITING = 7; */ WAITING = 7, /** - * MACHINE_PROVISIONING_EVENT_TYPE_INSTALLING metal-hammer is installing the desired os + * MACHINE_PROVISIONING_EVENT_TYPE_INSTALLING metal-hammer is installing the desired os. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_INSTALLING = 8; */ INSTALLING = 8, /** - * MACHINE_PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL metal-hammer completed installation and boots into target os + * MACHINE_PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL metal-hammer completed installation and boots into target os. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL = 9; */ BOOTING_NEW_KERNEL = 9, /** - * MACHINE_PROVISIONING_EVENT_TYPE_PHONED_HOME machine is installed and phones home + * MACHINE_PROVISIONING_EVENT_TYPE_PHONED_HOME machine is installed and phones home. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_PHONED_HOME = 10; */ PHONED_HOME = 10, /** - * MACHINE_PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM machine is not allocated, but phones home + * MACHINE_PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM machine is not allocated, but phones home. * * @generated from enum value: MACHINE_PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM = 11; */ @@ -2580,21 +2572,21 @@ export enum MachineLiveliness { UNSPECIFIED = 0, /** - * MACHINE_LIVELINESS_ALIVE liveliness is alive + * MACHINE_LIVELINESS_ALIVE liveliness is alive. * * @generated from enum value: MACHINE_LIVELINESS_ALIVE = 1; */ ALIVE = 1, /** - * MACHINE_LIVELINESS_DEAD liveliness is dead + * MACHINE_LIVELINESS_DEAD liveliness is dead. * * @generated from enum value: MACHINE_LIVELINESS_DEAD = 2; */ DEAD = 2, /** - * MACHINE_LIVELINESS_UNKNOWN liveliness is unknown + * MACHINE_LIVELINESS_UNKNOWN liveliness is unknown. * * @generated from enum value: MACHINE_LIVELINESS_UNKNOWN = 3; */ @@ -2683,49 +2675,49 @@ export enum MachineBMCCommand { MACHINE_BMC_COMMAND_CYCLE = 4, /** - * MACHINE_BMC_COMMAND_BOOT_TO_BIOS boot the machine into bios + * MACHINE_BMC_COMMAND_BOOT_TO_BIOS boot the machine into bios. * * @generated from enum value: MACHINE_BMC_COMMAND_BOOT_TO_BIOS = 5; */ MACHINE_BMC_COMMAND_BOOT_TO_BIOS = 5, /** - * MACHINE_BMC_COMMAND_BOOT_FROM_DISK boot the machine from hard disk + * MACHINE_BMC_COMMAND_BOOT_FROM_DISK boot the machine from hard disk. * * @generated from enum value: MACHINE_BMC_COMMAND_BOOT_FROM_DISK = 6; */ MACHINE_BMC_COMMAND_BOOT_FROM_DISK = 6, /** - * MACHINE_BMC_COMMAND_BOOT_FROM_PXE boot the machine from pxe + * MACHINE_BMC_COMMAND_BOOT_FROM_PXE boot the machine from pxe. * * @generated from enum value: MACHINE_BMC_COMMAND_BOOT_FROM_PXE = 7; */ MACHINE_BMC_COMMAND_BOOT_FROM_PXE = 7, /** - * MACHINE_BMC_COMMAND_IDENTIFY_LED_ON set identify led of the machine chassis to on + * MACHINE_BMC_COMMAND_IDENTIFY_LED_ON set identify led of the machine chassis to on. * * @generated from enum value: MACHINE_BMC_COMMAND_IDENTIFY_LED_ON = 8; */ MACHINE_BMC_COMMAND_IDENTIFY_LED_ON = 8, /** - * MACHINE_BMC_COMMAND_IDENTIFY_LED_OFF set identify led of the machine chassis to off + * MACHINE_BMC_COMMAND_IDENTIFY_LED_OFF set identify led of the machine chassis to off. * * @generated from enum value: MACHINE_BMC_COMMAND_IDENTIFY_LED_OFF = 9; */ MACHINE_BMC_COMMAND_IDENTIFY_LED_OFF = 9, /** - * MACHINE_BMC_COMMAND_MACHINE_DELETED should be called if the machine was deleted to power cycle and boot into pxe + * MACHINE_BMC_COMMAND_MACHINE_DELETED should be called if the machine was deleted to power cycle and boot into pxe. * * @generated from enum value: MACHINE_BMC_COMMAND_MACHINE_DELETED = 10; */ MACHINE_BMC_COMMAND_MACHINE_DELETED = 10, /** - * MACHINE_BMC_COMMAND_MACHINE_CREATED should be called if the machine was created to set the boot order to boot from disk + * MACHINE_BMC_COMMAND_MACHINE_CREATED should be called if the machine was created to set the boot order to boot from disk. * * @generated from enum value: MACHINE_BMC_COMMAND_MACHINE_CREATED = 11; */ @@ -2745,98 +2737,98 @@ export const MachineBMCCommandSchema: GenEnum = /*@__PURE__*/ */ export enum MachineIssueType { /** - * MACHINE_ISSUE_TYPE_UNSPECIFIED type is not specified + * MACHINE_ISSUE_TYPE_UNSPECIFIED type is not specified. * * @generated from enum value: MACHINE_ISSUE_TYPE_UNSPECIFIED = 0; */ UNSPECIFIED = 0, /** - * MACHINE_ISSUE_TYPE_ASN_UNIQUENESS machine asn is not unique + * MACHINE_ISSUE_TYPE_ASN_UNIQUENESS machine asn is not unique. * * @generated from enum value: MACHINE_ISSUE_TYPE_ASN_UNIQUENESS = 1; */ ASN_UNIQUENESS = 1, /** - * MACHINE_ISSUE_TYPE_BMC_INFO_OUTDATED machine bmc info out of date + * MACHINE_ISSUE_TYPE_BMC_INFO_OUTDATED machine bmc info out of date. * * @generated from enum value: MACHINE_ISSUE_TYPE_BMC_INFO_OUTDATED = 2; */ BMC_INFO_OUTDATED = 2, /** - * MACHINE_ISSUE_TYPE_BMC_NON_DISTINCT_IP machine bmc ip is not distinct + * MACHINE_ISSUE_TYPE_BMC_NON_DISTINCT_IP machine bmc ip is not distinct. * * @generated from enum value: MACHINE_ISSUE_TYPE_BMC_NON_DISTINCT_IP = 3; */ BMC_NON_DISTINCT_IP = 3, /** - * MACHINE_ISSUE_TYPE_BMC_WITHOUT_IP machine bmc without ip + * MACHINE_ISSUE_TYPE_BMC_WITHOUT_IP machine bmc without ip. * * @generated from enum value: MACHINE_ISSUE_TYPE_BMC_WITHOUT_IP = 4; */ BMC_WITHOUT_IP = 4, /** - * MACHINE_ISSUE_TYPE_BMC_WITHOUT_MAC machine bmc without mac address + * MACHINE_ISSUE_TYPE_BMC_WITHOUT_MAC machine bmc without mac address. * * @generated from enum value: MACHINE_ISSUE_TYPE_BMC_WITHOUT_MAC = 5; */ BMC_WITHOUT_MAC = 5, /** - * MACHINE_ISSUE_TYPE_CRASH_LOOP machine is in crashloop + * MACHINE_ISSUE_TYPE_CRASH_LOOP machine is in crashloop. * * @generated from enum value: MACHINE_ISSUE_TYPE_CRASH_LOOP = 6; */ CRASH_LOOP = 6, /** - * MACHINE_ISSUE_TYPE_FAILED_MACHINE_RECLAIM machine was not freed after delete + * MACHINE_ISSUE_TYPE_FAILED_MACHINE_RECLAIM machine was not freed after delete. * * @generated from enum value: MACHINE_ISSUE_TYPE_FAILED_MACHINE_RECLAIM = 7; */ FAILED_MACHINE_RECLAIM = 7, /** - * MACHINE_ISSUE_TYPE_LAST_EVENT_ERROR machine last event error + * MACHINE_ISSUE_TYPE_LAST_EVENT_ERROR machine last event error. * * @generated from enum value: MACHINE_ISSUE_TYPE_LAST_EVENT_ERROR = 8; */ LAST_EVENT_ERROR = 8, /** - * MACHINE_ISSUE_TYPE_LIVELINESS_DEAD machine is dead + * MACHINE_ISSUE_TYPE_LIVELINESS_DEAD machine is dead. * * @generated from enum value: MACHINE_ISSUE_TYPE_LIVELINESS_DEAD = 9; */ LIVELINESS_DEAD = 9, /** - * MACHINE_ISSUE_TYPE_LIVELINESS_NOT_AVAILABLE machine liveliness is not available + * MACHINE_ISSUE_TYPE_LIVELINESS_NOT_AVAILABLE machine liveliness is not available. * * @generated from enum value: MACHINE_ISSUE_TYPE_LIVELINESS_NOT_AVAILABLE = 10; */ LIVELINESS_NOT_AVAILABLE = 10, /** - * MACHINE_ISSUE_TYPE_LIVELINESS_UNKNOWN machine liveliness is unknown + * MACHINE_ISSUE_TYPE_LIVELINESS_UNKNOWN machine liveliness is unknown. * * @generated from enum value: MACHINE_ISSUE_TYPE_LIVELINESS_UNKNOWN = 11; */ LIVELINESS_UNKNOWN = 11, /** - * MACHINE_ISSUE_TYPE_NO_EVENT_CONTAINER machine does not have a event container + * MACHINE_ISSUE_TYPE_NO_EVENT_CONTAINER machine does not have a event container. * * @generated from enum value: MACHINE_ISSUE_TYPE_NO_EVENT_CONTAINER = 12; */ NO_EVENT_CONTAINER = 12, /** - * MACHINE_ISSUE_TYPE_NO_PARTITION no partition set + * MACHINE_ISSUE_TYPE_NO_PARTITION no partition set. * * @generated from enum value: MACHINE_ISSUE_TYPE_NO_PARTITION = 13; */ @@ -2856,28 +2848,28 @@ export const MachineIssueTypeSchema: GenEnum = /*@__PURE__*/ */ export enum MachineIssueSeverity { /** - * MACHINE_ISSUE_SEVERITY_UNSPECIFIED severity is not specified + * MACHINE_ISSUE_SEVERITY_UNSPECIFIED severity is not specified. * * @generated from enum value: MACHINE_ISSUE_SEVERITY_UNSPECIFIED = 0; */ UNSPECIFIED = 0, /** - * MACHINE_ISSUE_SEVERITY_MINOR machine issues is of severity minor + * MACHINE_ISSUE_SEVERITY_MINOR machine issues is of severity minor. * * @generated from enum value: MACHINE_ISSUE_SEVERITY_MINOR = 1; */ MINOR = 1, /** - * MACHINE_ISSUE_SEVERITY_MAJOR machine issues is of severity major + * MACHINE_ISSUE_SEVERITY_MAJOR machine issues is of severity major. * * @generated from enum value: MACHINE_ISSUE_SEVERITY_MAJOR = 2; */ MAJOR = 2, /** - * MACHINE_ISSUE_SEVERITY_CRITICAL machine issues is of severity critical + * MACHINE_ISSUE_SEVERITY_CRITICAL machine issues is of severity critical. * * @generated from enum value: MACHINE_ISSUE_SEVERITY_CRITICAL = 3; */ diff --git a/js/metalstack/api/v2/network_pb.d.ts b/js/metalstack/api/v2/network_pb.d.ts index 3929ab3c..6e5497e0 100644 --- a/js/metalstack/api/v2/network_pb.d.ts +++ b/js/metalstack/api/v2/network_pb.d.ts @@ -6,19 +6,19 @@ import type { Message } from "@bufbuild/protobuf"; */ export declare const file_metalstack_api_v2_network: GenFile; /** - * NetworkServiceGetRequest + * NetworkServiceGetRequest. * * @generated from message metalstack.api.v2.NetworkServiceGetRequest */ export type NetworkServiceGetRequest = Message<"metalstack.api.v2.NetworkServiceGetRequest"> & { /** - * ID of the network to get + * ID of the network to get. * * @generated from field: string id = 1; */ id: string; /** - * Project of the network + * Project of the network. * * @generated from field: string project = 2; */ @@ -30,13 +30,13 @@ export type NetworkServiceGetRequest = Message<"metalstack.api.v2.NetworkService */ export declare const NetworkServiceGetRequestSchema: GenMessage; /** - * NetworkServiceGetResponse + * NetworkServiceGetResponse. * * @generated from message metalstack.api.v2.NetworkServiceGetResponse */ export type NetworkServiceGetResponse = Message<"metalstack.api.v2.NetworkServiceGetResponse"> & { /** - * Network which was requested to get + * Network which was requested to get. * * @generated from field: metalstack.api.v2.Network network = 1; */ @@ -48,7 +48,7 @@ export type NetworkServiceGetResponse = Message<"metalstack.api.v2.NetworkServic */ export declare const NetworkServiceGetResponseSchema: GenMessage; /** - * NetworkServiceCreateRequest + * NetworkServiceCreateRequest. * * @generated from message metalstack.api.v2.NetworkServiceCreateRequest */ @@ -60,13 +60,13 @@ export type NetworkServiceCreateRequest = Message<"metalstack.api.v2.NetworkServ */ project: string; /** - * Name of this network + * Name of this network. * * @generated from field: optional string name = 2; */ name?: string | undefined; /** - * Description of this network + * Description of this network. * * @generated from field: optional string description = 3; */ @@ -78,7 +78,7 @@ export type NetworkServiceCreateRequest = Message<"metalstack.api.v2.NetworkServ */ partition?: string | undefined; /** - * Labels on this network + * Labels on this network. * * @generated from field: metalstack.api.v2.Labels labels = 5; */ @@ -90,13 +90,13 @@ export type NetworkServiceCreateRequest = Message<"metalstack.api.v2.NetworkServ */ parentNetwork?: string | undefined; /** - * Length per addressfamily + * Length per addressfamily. * * @generated from field: optional metalstack.api.v2.ChildPrefixLength length = 7; */ length?: ChildPrefixLength | undefined; /** - * AddressFamily to create, defaults to the same as the parent + * AddressFamily to create, defaults to the same as the parent. * * @generated from field: optional metalstack.api.v2.NetworkAddressFamily address_family = 8; */ @@ -108,7 +108,7 @@ export type NetworkServiceCreateRequest = Message<"metalstack.api.v2.NetworkServ */ export declare const NetworkServiceCreateRequestSchema: GenMessage; /** - * NetworkServiceCreateResponse + * NetworkServiceCreateResponse. * * @generated from message metalstack.api.v2.NetworkServiceCreateResponse */ @@ -126,13 +126,13 @@ export type NetworkServiceCreateResponse = Message<"metalstack.api.v2.NetworkSer */ export declare const NetworkServiceCreateResponseSchema: GenMessage; /** - * NetworkServiceUpdateRequest + * NetworkServiceUpdateRequest. * * @generated from message metalstack.api.v2.NetworkServiceUpdateRequest */ export type NetworkServiceUpdateRequest = Message<"metalstack.api.v2.NetworkServiceUpdateRequest"> & { /** - * ID of the network to get + * ID of the network to get. * * @generated from field: string id = 1; */ @@ -144,25 +144,25 @@ export type NetworkServiceUpdateRequest = Message<"metalstack.api.v2.NetworkServ */ updateMeta?: UpdateMeta | undefined; /** - * Project of the network + * Project of the network. * * @generated from field: string project = 3; */ project: string; /** - * Name of this network + * Name of this network. * * @generated from field: optional string name = 4; */ name?: string | undefined; /** - * Description of this network + * Description of this network. * * @generated from field: optional string description = 5; */ description?: string | undefined; /** - * Labels on this network + * Labels on this network. * * @generated from field: optional metalstack.api.v2.UpdateLabels labels = 6; */ @@ -174,7 +174,7 @@ export type NetworkServiceUpdateRequest = Message<"metalstack.api.v2.NetworkServ */ export declare const NetworkServiceUpdateRequestSchema: GenMessage; /** - * NetworkServiceUpdateResponse + * NetworkServiceUpdateResponse. * * @generated from message metalstack.api.v2.NetworkServiceUpdateResponse */ @@ -192,13 +192,13 @@ export type NetworkServiceUpdateResponse = Message<"metalstack.api.v2.NetworkSer */ export declare const NetworkServiceUpdateResponseSchema: GenMessage; /** - * NetworkServiceListRequest + * NetworkServiceListRequest. * * @generated from message metalstack.api.v2.NetworkServiceListRequest */ export type NetworkServiceListRequest = Message<"metalstack.api.v2.NetworkServiceListRequest"> & { /** - * Project of the networks to list + * Project of the networks to list. * * @generated from field: string project = 1; */ @@ -216,7 +216,7 @@ export type NetworkServiceListRequest = Message<"metalstack.api.v2.NetworkServic */ export declare const NetworkServiceListRequestSchema: GenMessage; /** - * NetworkServiceListResponse + * NetworkServiceListResponse. * * @generated from message metalstack.api.v2.NetworkServiceListResponse */ @@ -234,13 +234,13 @@ export type NetworkServiceListResponse = Message<"metalstack.api.v2.NetworkServi */ export declare const NetworkServiceListResponseSchema: GenMessage; /** - * NetworkServiceListRequest + * NetworkServiceListRequest. * * @generated from message metalstack.api.v2.NetworkServiceListBaseNetworksRequest */ export type NetworkServiceListBaseNetworksRequest = Message<"metalstack.api.v2.NetworkServiceListBaseNetworksRequest"> & { /** - * Project of the base networks to list + * Project of the base networks to list. * * @generated from field: string project = 1; */ @@ -258,7 +258,7 @@ export type NetworkServiceListBaseNetworksRequest = Message<"metalstack.api.v2.N */ export declare const NetworkServiceListBaseNetworksRequestSchema: GenMessage; /** - * NetworkServiceListResponse + * NetworkServiceListResponse. * * @generated from message metalstack.api.v2.NetworkServiceListBaseNetworksResponse */ @@ -276,19 +276,19 @@ export type NetworkServiceListBaseNetworksResponse = Message<"metalstack.api.v2. */ export declare const NetworkServiceListBaseNetworksResponseSchema: GenMessage; /** - * NetworkServiceDeleteRequest + * NetworkServiceDeleteRequest. * * @generated from message metalstack.api.v2.NetworkServiceDeleteRequest */ export type NetworkServiceDeleteRequest = Message<"metalstack.api.v2.NetworkServiceDeleteRequest"> & { /** - * ID of the network to get + * ID of the network to get. * * @generated from field: string id = 1; */ id: string; /** - * Project of the network + * Project of the network. * * @generated from field: string project = 2; */ @@ -300,7 +300,7 @@ export type NetworkServiceDeleteRequest = Message<"metalstack.api.v2.NetworkServ */ export declare const NetworkServiceDeleteRequestSchema: GenMessage; /** - * NetworkServiceDeleteResponse + * NetworkServiceDeleteResponse. * * @generated from message metalstack.api.v2.NetworkServiceDeleteResponse */ @@ -318,31 +318,31 @@ export type NetworkServiceDeleteResponse = Message<"metalstack.api.v2.NetworkSer */ export declare const NetworkServiceDeleteResponseSchema: GenMessage; /** - * Network + * Network. * * @generated from message metalstack.api.v2.Network */ export type Network = Message<"metalstack.api.v2.Network"> & { /** - * Id of this network + * Id of this network. * * @generated from field: string id = 1; */ id: string; /** - * Meta for this network + * Meta for this network. * * @generated from field: metalstack.api.v2.Meta meta = 2; */ meta?: Meta | undefined; /** - * Name of this network + * Name of this network. * * @generated from field: optional string name = 3; */ name?: string | undefined; /** - * Description of this network + * Description of this network. * * @generated from field: optional string description = 4; */ @@ -361,19 +361,19 @@ export type Network = Message<"metalstack.api.v2.Network"> & { project?: string | undefined; /** * Namespace if specified, this network is namespaced and can therefore overlap with others. - * Will be equal with project most of the time + * Will be equal with project most of the time. * * @generated from field: optional string namespace = 7; */ namespace?: string | undefined; /** - * Prefixes in this network + * Prefixes in this network. * * @generated from field: repeated string prefixes = 8; */ prefixes: string[]; /** - * Destination Prefixes in this network + * Destination Prefixes in this network. * * @generated from field: repeated string destination_prefixes = 9; */ @@ -391,13 +391,13 @@ export type Network = Message<"metalstack.api.v2.Network"> & { */ minChildPrefixLength?: ChildPrefixLength | undefined; /** - * Type of the network + * Type of the network. * * @generated from field: metalstack.api.v2.NetworkType type = 12; */ type: NetworkType; /** - * NATType of this network + * NATType of this network. * * @generated from field: metalstack.api.v2.NATType nat_type = 13; */ @@ -421,7 +421,7 @@ export type Network = Message<"metalstack.api.v2.Network"> & { */ additionalAnnouncableCidrs: string[]; /** - * Consumption of IPs and prefixes in this network + * Consumption of IPs and prefixes in this network. * * @generated from field: metalstack.api.v2.NetworkConsumption consumption = 17; */ @@ -439,19 +439,19 @@ export declare const NetworkSchema: GenMessage; */ export type NetworkQuery = Message<"metalstack.api.v2.NetworkQuery"> & { /** - * Id of the network to query + * Id of the network to query. * * @generated from field: optional string id = 1; */ id?: string | undefined; /** - * Name of this network + * Name of this network. * * @generated from field: optional string name = 2; */ name?: string | undefined; /** - * Description of this network + * Description of this network. * * @generated from field: optional string description = 3; */ @@ -475,13 +475,13 @@ export type NetworkQuery = Message<"metalstack.api.v2.NetworkQuery"> & { */ namespace?: string | undefined; /** - * Prefixes in this network + * Prefixes in this network. * * @generated from field: repeated string prefixes = 7; */ prefixes: string[]; /** - * Destination Prefixes in this network + * Destination Prefixes in this network. * * @generated from field: repeated string destination_prefixes = 8; */ @@ -499,25 +499,25 @@ export type NetworkQuery = Message<"metalstack.api.v2.NetworkQuery"> & { */ parentNetwork?: string | undefined; /** - * Addressfamily to query + * Addressfamily to query. * * @generated from field: optional metalstack.api.v2.NetworkAddressFamily address_family = 11; */ addressFamily?: NetworkAddressFamily | undefined; /** - * Type of the network to query for + * Type of the network to query for. * * @generated from field: optional metalstack.api.v2.NetworkType type = 12; */ type?: NetworkType | undefined; /** - * NATType configured + * NATType configured. * * @generated from field: optional metalstack.api.v2.NATType nat_type = 13; */ natType?: NATType | undefined; /** - * Labels on this network + * Labels on this network. * * @generated from field: optional metalstack.api.v2.Labels labels = 14; */ @@ -529,19 +529,19 @@ export type NetworkQuery = Message<"metalstack.api.v2.NetworkQuery"> & { */ export declare const NetworkQuerySchema: GenMessage; /** - * ChildPrefixLength + * ChildPrefixLength. * * @generated from message metalstack.api.v2.ChildPrefixLength */ export type ChildPrefixLength = Message<"metalstack.api.v2.ChildPrefixLength"> & { /** - * IPv4 bit length of this network in this addressfamily + * IPv4 bit length of this network in this addressfamily. * * @generated from field: optional uint32 ipv4 = 1; */ ipv4?: number | undefined; /** - * IPv6 bit length of this network in this addressfamily + * IPv6 bit length of this network in this addressfamily. * * @generated from field: optional uint32 ipv6 = 2; */ @@ -559,7 +559,7 @@ export declare const ChildPrefixLengthSchema: GenMessage; */ export type NetworkConsumption = Message<"metalstack.api.v2.NetworkConsumption"> & { /** - * IPv4 network usage + * IPv4 network usage. * * @generated from field: metalstack.api.v2.NetworkUsage ipv4 = 1; */ @@ -583,25 +583,25 @@ export declare const NetworkConsumptionSchema: GenMessage; */ export type NetworkUsage = Message<"metalstack.api.v2.NetworkUsage"> & { /** - * the total available IPs + * the total available IPs. * * @generated from field: uint64 available_ips = 1; */ availableIps: bigint; /** - * the total used IPs + * the total used IPs. * * @generated from field: uint64 used_ips = 2; */ usedIps: bigint; /** - * the total available 2-bit prefixes + * the total available 2-bit prefixes. * * @generated from field: uint64 available_prefixes = 3; */ availablePrefixes: bigint; /** - * the total used Prefixes + * the total used Prefixes. * * @generated from field: uint64 used_prefixes = 4; */ @@ -631,7 +631,7 @@ export declare enum NATType { */ NAT_TYPE_NONE = 1, /** - * NAT_TYPE_IPV4_MASQUERADE masquerade ipv4 behind gateway ip when traffic enters this network + * NAT_TYPE_IPV4_MASQUERADE masquerade ipv4 behind gateway ip when traffic enters this network. * * @generated from enum value: NAT_TYPE_IPV4_MASQUERADE = 2; */ @@ -663,7 +663,7 @@ export declare enum NetworkType { EXTERNAL = 1, /** * NETWORK_TYPE_UNDERLAY indicates a underlay network. - * The underlay network connects all switches and the firewalls to build a EVPN dataplane + * The underlay network connects all switches and the firewalls to build a EVPN dataplane. * It is not project scoped. Is part of the dataplane and reserved for administrative purposes. * * @generated from enum value: NETWORK_TYPE_UNDERLAY = 2; diff --git a/js/metalstack/api/v2/network_pb.js b/js/metalstack/api/v2/network_pb.js index 3690a46a..51d7eb64 100644 --- a/js/metalstack/api/v2/network_pb.js +++ b/js/metalstack/api/v2/network_pb.js @@ -114,7 +114,7 @@ export var NATType; */ NATType[NATType["NAT_TYPE_NONE"] = 1] = "NAT_TYPE_NONE"; /** - * NAT_TYPE_IPV4_MASQUERADE masquerade ipv4 behind gateway ip when traffic enters this network + * NAT_TYPE_IPV4_MASQUERADE masquerade ipv4 behind gateway ip when traffic enters this network. * * @generated from enum value: NAT_TYPE_IPV4_MASQUERADE = 2; */ @@ -147,7 +147,7 @@ export var NetworkType; NetworkType[NetworkType["EXTERNAL"] = 1] = "EXTERNAL"; /** * NETWORK_TYPE_UNDERLAY indicates a underlay network. - * The underlay network connects all switches and the firewalls to build a EVPN dataplane + * The underlay network connects all switches and the firewalls to build a EVPN dataplane. * It is not project scoped. Is part of the dataplane and reserved for administrative purposes. * * @generated from enum value: NETWORK_TYPE_UNDERLAY = 2; diff --git a/js/metalstack/api/v2/network_pb.ts b/js/metalstack/api/v2/network_pb.ts index ac318869..0488fdd3 100644 --- a/js/metalstack/api/v2/network_pb.ts +++ b/js/metalstack/api/v2/network_pb.ts @@ -17,20 +17,20 @@ export const file_metalstack_api_v2_network: GenFile = /*@__PURE__*/ fileDesc("Ch9tZXRhbHN0YWNrL2FwaS92Mi9uZXR3b3JrLnByb3RvEhFtZXRhbHN0YWNrLmFwaS52MiJRChhOZXR3b3JrU2VydmljZUdldFJlcXVlc3QSFwoCaWQYASABKAlCC7pICHIGwLOusQIBEhwKB3Byb2plY3QYAiABKAlCC7pICNgBAXIDsAEBIkgKGU5ldHdvcmtTZXJ2aWNlR2V0UmVzcG9uc2USKwoHbmV0d29yaxgBIAEoCzIaLm1ldGFsc3RhY2suYXBpLnYyLk5ldHdvcmsi3AMKG05ldHdvcmtTZXJ2aWNlQ3JlYXRlUmVxdWVzdBIZCgdwcm9qZWN0GAEgASgJQgi6SAVyA7ABARIeCgRuYW1lGAIgASgJQgu6SAhyBsCzrrECAUgAiAEBEiUKC2Rlc2NyaXB0aW9uGAMgASgJQgu6SAhyBsizrrECAUgBiAEBEiMKCXBhcnRpdGlvbhgEIAEoCUILukgIcgbQs66xAgFIAogBARIpCgZsYWJlbHMYBSABKAsyGS5tZXRhbHN0YWNrLmFwaS52Mi5MYWJlbHMSKAoOcGFyZW50X25ldHdvcmsYBiABKAlCC7pICHIGwLOusQIBSAOIAQESOQoGbGVuZ3RoGAcgASgLMiQubWV0YWxzdGFjay5hcGkudjIuQ2hpbGRQcmVmaXhMZW5ndGhIBIgBARJOCg5hZGRyZXNzX2ZhbWlseRgIIAEoDjInLm1ldGFsc3RhY2suYXBpLnYyLk5ldHdvcmtBZGRyZXNzRmFtaWx5Qgi6SAWCAQIQAUgFiAEBQgcKBV9uYW1lQg4KDF9kZXNjcmlwdGlvbkIMCgpfcGFydGl0aW9uQhEKD19wYXJlbnRfbmV0d29ya0IJCgdfbGVuZ3RoQhEKD19hZGRyZXNzX2ZhbWlseSJLChxOZXR3b3JrU2VydmljZUNyZWF0ZVJlc3BvbnNlEisKB25ldHdvcmsYASABKAsyGi5tZXRhbHN0YWNrLmFwaS52Mi5OZXR3b3JrIq4CChtOZXR3b3JrU2VydmljZVVwZGF0ZVJlcXVlc3QSFwoCaWQYASABKAlCC7pICHIGwLOusQIBEjoKC3VwZGF0ZV9tZXRhGAIgASgLMh0ubWV0YWxzdGFjay5hcGkudjIuVXBkYXRlTWV0YUIGukgDyAEBEhkKB3Byb2plY3QYAyABKAlCCLpIBXIDsAEBEh4KBG5hbWUYBCABKAlCC7pICHIGwLOusQIBSACIAQESJQoLZGVzY3JpcHRpb24YBSABKAlCC7pICHIGyLOusQIBSAGIAQESNAoGbGFiZWxzGAYgASgLMh8ubWV0YWxzdGFjay5hcGkudjIuVXBkYXRlTGFiZWxzSAKIAQFCBwoFX25hbWVCDgoMX2Rlc2NyaXB0aW9uQgkKB19sYWJlbHMiSwocTmV0d29ya1NlcnZpY2VVcGRhdGVSZXNwb25zZRIrCgduZXR3b3JrGAEgASgLMhoubWV0YWxzdGFjay5hcGkudjIuTmV0d29yayJpChlOZXR3b3JrU2VydmljZUxpc3RSZXF1ZXN0EhwKB3Byb2plY3QYASABKAlCC7pICNgBAXIDsAEBEi4KBXF1ZXJ5GAIgASgLMh8ubWV0YWxzdGFjay5hcGkudjIuTmV0d29ya1F1ZXJ5IkoKGk5ldHdvcmtTZXJ2aWNlTGlzdFJlc3BvbnNlEiwKCG5ldHdvcmtzGAEgAygLMhoubWV0YWxzdGFjay5hcGkudjIuTmV0d29yayJ1CiVOZXR3b3JrU2VydmljZUxpc3RCYXNlTmV0d29ya3NSZXF1ZXN0EhwKB3Byb2plY3QYASABKAlCC7pICNgBAXIDsAEBEi4KBXF1ZXJ5GAIgASgLMh8ubWV0YWxzdGFjay5hcGkudjIuTmV0d29ya1F1ZXJ5IlYKJk5ldHdvcmtTZXJ2aWNlTGlzdEJhc2VOZXR3b3Jrc1Jlc3BvbnNlEiwKCG5ldHdvcmtzGAEgAygLMhoubWV0YWxzdGFjay5hcGkudjIuTmV0d29yayJRChtOZXR3b3JrU2VydmljZURlbGV0ZVJlcXVlc3QSFwoCaWQYASABKAlCC7pICHIGwLOusQIBEhkKB3Byb2plY3QYAiABKAlCCLpIBXIDsAEBIksKHE5ldHdvcmtTZXJ2aWNlRGVsZXRlUmVzcG9uc2USKwoHbmV0d29yaxgBIAEoCzIaLm1ldGFsc3RhY2suYXBpLnYyLk5ldHdvcmsizQYKB05ldHdvcmsSFwoCaWQYASABKAlCC7pICHIGwLOusQIBEiUKBG1ldGEYAiABKAsyFy5tZXRhbHN0YWNrLmFwaS52Mi5NZXRhEh4KBG5hbWUYAyABKAlCC7pICHIGwLOusQIBSACIAQESJQoLZGVzY3JpcHRpb24YBCABKAlCC7pICHIGyLOusQIBSAGIAQESIwoJcGFydGl0aW9uGAUgASgJQgu6SAhyBtCzrrECAUgCiAEBEh4KB3Byb2plY3QYBiABKAlCCLpIBXIDsAEBSAOIAQESIAoJbmFtZXNwYWNlGAcgASgJQgi6SAVyA7ABAUgEiAEBEh4KCHByZWZpeGVzGAggAygJQgy6SAmSAQa4pLOxAgESKgoUZGVzdGluYXRpb25fcHJlZml4ZXMYCSADKAlCDLpICZIBBriks7ECARJJChtkZWZhdWx0X2NoaWxkX3ByZWZpeF9sZW5ndGgYCiABKAsyJC5tZXRhbHN0YWNrLmFwaS52Mi5DaGlsZFByZWZpeExlbmd0aBJFChdtaW5fY2hpbGRfcHJlZml4X2xlbmd0aBgLIAEoCzIkLm1ldGFsc3RhY2suYXBpLnYyLkNoaWxkUHJlZml4TGVuZ3RoEjYKBHR5cGUYDCABKA4yHi5tZXRhbHN0YWNrLmFwaS52Mi5OZXR3b3JrVHlwZUIIukgFggECEAESNgoIbmF0X3R5cGUYDSABKA4yGi5tZXRhbHN0YWNrLmFwaS52Mi5OQVRUeXBlQgi6SAWCAQIQARIQCgN2cmYYDiABKA1IBYgBARIoCg5wYXJlbnRfbmV0d29yaxgPIAEoCUILukgIcgbAs66xAgFIBogBARIyChxhZGRpdGlvbmFsX2Fubm91bmNhYmxlX2NpZHJzGBAgAygJQgy6SAmSAQa4pLOxAgESOgoLY29uc3VtcHRpb24YESABKAsyJS5tZXRhbHN0YWNrLmFwaS52Mi5OZXR3b3JrQ29uc3VtcHRpb25CBwoFX25hbWVCDgoMX2Rlc2NyaXB0aW9uQgwKCl9wYXJ0aXRpb25CCgoIX3Byb2plY3RCDAoKX25hbWVzcGFjZUIGCgRfdnJmQhEKD19wYXJlbnRfbmV0d29yayLzBQoMTmV0d29ya1F1ZXJ5EhwKAmlkGAEgASgJQgu6SAhyBsCzrrECAUgAiAEBEh4KBG5hbWUYAiABKAlCC7pICHIGwLOusQIBSAGIAQESJQoLZGVzY3JpcHRpb24YAyABKAlCC7pICHIGyLOusQIBSAKIAQESIwoJcGFydGl0aW9uGAQgASgJQgu6SAhyBtCzrrECAUgDiAEBEh4KB3Byb2plY3QYBSABKAlCCLpIBXIDsAEBSASIAQESIAoJbmFtZXNwYWNlGAYgASgJQgi6SAVyA7ABAUgFiAEBEh4KCHByZWZpeGVzGAcgAygJQgy6SAmSAQa4pLOxAgESKgoUZGVzdGluYXRpb25fcHJlZml4ZXMYCCADKAlCDLpICZIBBriks7ECARIQCgN2cmYYCSABKA1IBogBARIoCg5wYXJlbnRfbmV0d29yaxgKIAEoCUILukgIcgbAs66xAgFIB4gBARJOCg5hZGRyZXNzX2ZhbWlseRgLIAEoDjInLm1ldGFsc3RhY2suYXBpLnYyLk5ldHdvcmtBZGRyZXNzRmFtaWx5Qgi6SAWCAQIQAUgIiAEBEjsKBHR5cGUYDCABKA4yHi5tZXRhbHN0YWNrLmFwaS52Mi5OZXR3b3JrVHlwZUIIukgFggECEAFICYgBARI7CghuYXRfdHlwZRgNIAEoDjIaLm1ldGFsc3RhY2suYXBpLnYyLk5BVFR5cGVCCLpIBYIBAhABSAqIAQESLgoGbGFiZWxzGA4gASgLMhkubWV0YWxzdGFjay5hcGkudjIuTGFiZWxzSAuIAQFCBQoDX2lkQgcKBV9uYW1lQg4KDF9kZXNjcmlwdGlvbkIMCgpfcGFydGl0aW9uQgoKCF9wcm9qZWN0QgwKCl9uYW1lc3BhY2VCBgoEX3ZyZkIRCg9fcGFyZW50X25ldHdvcmtCEQoPX2FkZHJlc3NfZmFtaWx5QgcKBV90eXBlQgsKCV9uYXRfdHlwZUIJCgdfbGFiZWxzImIKEUNoaWxkUHJlZml4TGVuZ3RoEhwKBGlwdjQYASABKA1CCbpIBioEGCAgAEgAiAEBEh0KBGlwdjYYAiABKA1CCrpIByoFGIABIABIAYgBAUIHCgVfaXB2NEIHCgVfaXB2NiJyChJOZXR3b3JrQ29uc3VtcHRpb24SLQoEaXB2NBgBIAEoCzIfLm1ldGFsc3RhY2suYXBpLnYyLk5ldHdvcmtVc2FnZRItCgRpcHY2GAIgASgLMh8ubWV0YWxzdGFjay5hcGkudjIuTmV0d29ya1VzYWdlImoKDE5ldHdvcmtVc2FnZRIVCg1hdmFpbGFibGVfaXBzGAEgASgEEhAKCHVzZWRfaXBzGAIgASgEEhoKEmF2YWlsYWJsZV9wcmVmaXhlcxgDIAEoBBIVCg11c2VkX3ByZWZpeGVzGAQgASgEKm0KB05BVFR5cGUSGAoUTkFUX1RZUEVfVU5TUEVDSUZJRUQQABIbCg1OQVRfVFlQRV9OT05FEAEaCIKyGQRub25lEisKGE5BVF9UWVBFX0lQVjRfTUFTUVVFUkFERRACGg2CshkJaXB2NC1tYXNxKq0CCgtOZXR3b3JrVHlwZRIcChhORVRXT1JLX1RZUEVfVU5TUEVDSUZJRUQQABInChVORVRXT1JLX1RZUEVfRVhURVJOQUwQARoMgrIZCGV4dGVybmFsEicKFU5FVFdPUktfVFlQRV9VTkRFUkxBWRACGgyCshkIdW5kZXJsYXkSIQoSTkVUV09SS19UWVBFX1NVUEVSEAMaCYKyGQVzdXBlchI3Ch1ORVRXT1JLX1RZUEVfU1VQRVJfTkFNRVNQQUNFRBAEGhSCshkQc3VwZXItbmFtZXNwYWNlZBIhChJORVRXT1JLX1RZUEVfQ0hJTEQQBRoJgrIZBWNoaWxkEi8KGU5FVFdPUktfVFlQRV9DSElMRF9TSEFSRUQQBhoQgrIZDGNoaWxkLXNoYXJlZCrHAQoUTmV0d29ya0FkZHJlc3NGYW1pbHkSJgoiTkVUV09SS19BRERSRVNTX0ZBTUlMWV9VTlNQRUNJRklFRBAAEicKGU5FVFdPUktfQUREUkVTU19GQU1JTFlfVjQQARoIgrIZBGlwdjQSJwoZTkVUV09SS19BRERSRVNTX0ZBTUlMWV9WNhACGgiCshkEaXB2NhI1CiFORVRXT1JLX0FERFJFU1NfRkFNSUxZX0RVQUxfU1RBQ0sQAxoOgrIZCmR1YWwtc3RhY2sy7QUKDk5ldHdvcmtTZXJ2aWNlEm0KA0dldBIrLm1ldGFsc3RhY2suYXBpLnYyLk5ldHdvcmtTZXJ2aWNlR2V0UmVxdWVzdBosLm1ldGFsc3RhY2suYXBpLnYyLk5ldHdvcmtTZXJ2aWNlR2V0UmVzcG9uc2UiC8rzGAMBAgPg8xgCEnUKBkNyZWF0ZRIuLm1ldGFsc3RhY2suYXBpLnYyLk5ldHdvcmtTZXJ2aWNlQ3JlYXRlUmVxdWVzdBovLm1ldGFsc3RhY2suYXBpLnYyLk5ldHdvcmtTZXJ2aWNlQ3JlYXRlUmVzcG9uc2UiCsrzGAIBAuDzGAESdQoGVXBkYXRlEi4ubWV0YWxzdGFjay5hcGkudjIuTmV0d29ya1NlcnZpY2VVcGRhdGVSZXF1ZXN0Gi8ubWV0YWxzdGFjay5hcGkudjIuTmV0d29ya1NlcnZpY2VVcGRhdGVSZXNwb25zZSIKyvMYAgEC4PMYARJwCgRMaXN0EiwubWV0YWxzdGFjay5hcGkudjIuTmV0d29ya1NlcnZpY2VMaXN0UmVxdWVzdBotLm1ldGFsc3RhY2suYXBpLnYyLk5ldHdvcmtTZXJ2aWNlTGlzdFJlc3BvbnNlIgvK8xgDAQID4PMYAhKUAQoQTGlzdEJhc2VOZXR3b3JrcxI4Lm1ldGFsc3RhY2suYXBpLnYyLk5ldHdvcmtTZXJ2aWNlTGlzdEJhc2VOZXR3b3Jrc1JlcXVlc3QaOS5tZXRhbHN0YWNrLmFwaS52Mi5OZXR3b3JrU2VydmljZUxpc3RCYXNlTmV0d29ya3NSZXNwb25zZSILyvMYAwECA+DzGAISdQoGRGVsZXRlEi4ubWV0YWxzdGFjay5hcGkudjIuTmV0d29ya1NlcnZpY2VEZWxldGVSZXF1ZXN0Gi8ubWV0YWxzdGFjay5hcGkudjIuTmV0d29ya1NlcnZpY2VEZWxldGVSZXNwb25zZSIKyvMYAgEC4PMYAULCAQoVY29tLm1ldGFsc3RhY2suYXBpLnYyQgxOZXR3b3JrUHJvdG9QAVo1Z2l0aHViLmNvbS9tZXRhbC1zdGFjay9hcGkvZ28vbWV0YWxzdGFjay9hcGkvdjI7YXBpdjKiAgNNQViqAhFNZXRhbHN0YWNrLkFwaS5WMsoCEU1ldGFsc3RhY2tcQXBpXFYy4gIdTWV0YWxzdGFja1xBcGlcVjJcR1BCTWV0YWRhdGHqAhNNZXRhbHN0YWNrOjpBcGk6OlYyYgZwcm90bzM", [file_buf_validate_validate, file_metalstack_api_v2_common, file_metalstack_api_v2_predefined_rules]); /** - * NetworkServiceGetRequest + * NetworkServiceGetRequest. * * @generated from message metalstack.api.v2.NetworkServiceGetRequest */ export type NetworkServiceGetRequest = Message<"metalstack.api.v2.NetworkServiceGetRequest"> & { /** - * ID of the network to get + * ID of the network to get. * * @generated from field: string id = 1; */ id: string; /** - * Project of the network + * Project of the network. * * @generated from field: string project = 2; */ @@ -45,13 +45,13 @@ export const NetworkServiceGetRequestSchema: GenMessage & { /** - * Network which was requested to get + * Network which was requested to get. * * @generated from field: metalstack.api.v2.Network network = 1; */ @@ -66,7 +66,7 @@ export const NetworkServiceGetResponseSchema: GenMessage & { /** - * ID of the network to get + * ID of the network to get. * * @generated from field: string id = 1; */ @@ -177,28 +177,28 @@ export type NetworkServiceUpdateRequest = Message<"metalstack.api.v2.NetworkServ updateMeta?: UpdateMeta | undefined; /** - * Project of the network + * Project of the network. * * @generated from field: string project = 3; */ project: string; /** - * Name of this network + * Name of this network. * * @generated from field: optional string name = 4; */ name?: string | undefined; /** - * Description of this network + * Description of this network. * * @generated from field: optional string description = 5; */ description?: string | undefined; /** - * Labels on this network + * Labels on this network. * * @generated from field: optional metalstack.api.v2.UpdateLabels labels = 6; */ @@ -213,7 +213,7 @@ export const NetworkServiceUpdateRequestSchema: GenMessage & { /** - * Project of the networks to list + * Project of the networks to list. * * @generated from field: string project = 1; */ @@ -262,7 +262,7 @@ export const NetworkServiceListRequestSchema: GenMessage & { /** - * Project of the base networks to list + * Project of the base networks to list. * * @generated from field: string project = 1; */ @@ -311,7 +311,7 @@ export const NetworkServiceListBaseNetworksRequestSchema: GenMessage & { /** - * ID of the network to get + * ID of the network to get. * * @generated from field: string id = 1; */ id: string; /** - * Project of the network + * Project of the network. * * @generated from field: string project = 2; */ @@ -360,7 +360,7 @@ export const NetworkServiceDeleteRequestSchema: GenMessage & { /** - * Id of this network + * Id of this network. * * @generated from field: string id = 1; */ id: string; /** - * Meta for this network + * Meta for this network. * * @generated from field: metalstack.api.v2.Meta meta = 2; */ meta?: Meta | undefined; /** - * Name of this network + * Name of this network. * * @generated from field: optional string name = 3; */ name?: string | undefined; /** - * Description of this network + * Description of this network. * * @generated from field: optional string description = 4; */ @@ -430,21 +430,21 @@ export type Network = Message<"metalstack.api.v2.Network"> & { /** * Namespace if specified, this network is namespaced and can therefore overlap with others. - * Will be equal with project most of the time + * Will be equal with project most of the time. * * @generated from field: optional string namespace = 7; */ namespace?: string | undefined; /** - * Prefixes in this network + * Prefixes in this network. * * @generated from field: repeated string prefixes = 8; */ prefixes: string[]; /** - * Destination Prefixes in this network + * Destination Prefixes in this network. * * @generated from field: repeated string destination_prefixes = 9; */ @@ -465,14 +465,14 @@ export type Network = Message<"metalstack.api.v2.Network"> & { minChildPrefixLength?: ChildPrefixLength | undefined; /** - * Type of the network + * Type of the network. * * @generated from field: metalstack.api.v2.NetworkType type = 12; */ type: NetworkType; /** - * NATType of this network + * NATType of this network. * * @generated from field: metalstack.api.v2.NATType nat_type = 13; */ @@ -500,7 +500,7 @@ export type Network = Message<"metalstack.api.v2.Network"> & { additionalAnnouncableCidrs: string[]; /** - * Consumption of IPs and prefixes in this network + * Consumption of IPs and prefixes in this network. * * @generated from field: metalstack.api.v2.NetworkConsumption consumption = 17; */ @@ -521,21 +521,21 @@ export const NetworkSchema: GenMessage = /*@__PURE__*/ */ export type NetworkQuery = Message<"metalstack.api.v2.NetworkQuery"> & { /** - * Id of the network to query + * Id of the network to query. * * @generated from field: optional string id = 1; */ id?: string | undefined; /** - * Name of this network + * Name of this network. * * @generated from field: optional string name = 2; */ name?: string | undefined; /** - * Description of this network + * Description of this network. * * @generated from field: optional string description = 3; */ @@ -563,14 +563,14 @@ export type NetworkQuery = Message<"metalstack.api.v2.NetworkQuery"> & { namespace?: string | undefined; /** - * Prefixes in this network + * Prefixes in this network. * * @generated from field: repeated string prefixes = 7; */ prefixes: string[]; /** - * Destination Prefixes in this network + * Destination Prefixes in this network. * * @generated from field: repeated string destination_prefixes = 8; */ @@ -591,28 +591,28 @@ export type NetworkQuery = Message<"metalstack.api.v2.NetworkQuery"> & { parentNetwork?: string | undefined; /** - * Addressfamily to query + * Addressfamily to query. * * @generated from field: optional metalstack.api.v2.NetworkAddressFamily address_family = 11; */ addressFamily?: NetworkAddressFamily | undefined; /** - * Type of the network to query for + * Type of the network to query for. * * @generated from field: optional metalstack.api.v2.NetworkType type = 12; */ type?: NetworkType | undefined; /** - * NATType configured + * NATType configured. * * @generated from field: optional metalstack.api.v2.NATType nat_type = 13; */ natType?: NATType | undefined; /** - * Labels on this network + * Labels on this network. * * @generated from field: optional metalstack.api.v2.Labels labels = 14; */ @@ -627,20 +627,20 @@ export const NetworkQuerySchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_network, 13); /** - * ChildPrefixLength + * ChildPrefixLength. * * @generated from message metalstack.api.v2.ChildPrefixLength */ export type ChildPrefixLength = Message<"metalstack.api.v2.ChildPrefixLength"> & { /** - * IPv4 bit length of this network in this addressfamily + * IPv4 bit length of this network in this addressfamily. * * @generated from field: optional uint32 ipv4 = 1; */ ipv4?: number | undefined; /** - * IPv6 bit length of this network in this addressfamily + * IPv6 bit length of this network in this addressfamily. * * @generated from field: optional uint32 ipv6 = 2; */ @@ -661,7 +661,7 @@ export const ChildPrefixLengthSchema: GenMessage = /*@__PURE_ */ export type NetworkConsumption = Message<"metalstack.api.v2.NetworkConsumption"> & { /** - * IPv4 network usage + * IPv4 network usage. * * @generated from field: metalstack.api.v2.NetworkUsage ipv4 = 1; */ @@ -689,28 +689,28 @@ export const NetworkConsumptionSchema: GenMessage = /*@__PUR */ export type NetworkUsage = Message<"metalstack.api.v2.NetworkUsage"> & { /** - * the total available IPs + * the total available IPs. * * @generated from field: uint64 available_ips = 1; */ availableIps: bigint; /** - * the total used IPs + * the total used IPs. * * @generated from field: uint64 used_ips = 2; */ usedIps: bigint; /** - * the total available 2-bit prefixes + * the total available 2-bit prefixes. * * @generated from field: uint64 available_prefixes = 3; */ availablePrefixes: bigint; /** - * the total used Prefixes + * the total used Prefixes. * * @generated from field: uint64 used_prefixes = 4; */ @@ -745,7 +745,7 @@ export enum NATType { NAT_TYPE_NONE = 1, /** - * NAT_TYPE_IPV4_MASQUERADE masquerade ipv4 behind gateway ip when traffic enters this network + * NAT_TYPE_IPV4_MASQUERADE masquerade ipv4 behind gateway ip when traffic enters this network. * * @generated from enum value: NAT_TYPE_IPV4_MASQUERADE = 2; */ @@ -782,7 +782,7 @@ export enum NetworkType { /** * NETWORK_TYPE_UNDERLAY indicates a underlay network. - * The underlay network connects all switches and the firewalls to build a EVPN dataplane + * The underlay network connects all switches and the firewalls to build a EVPN dataplane. * It is not project scoped. Is part of the dataplane and reserved for administrative purposes. * * @generated from enum value: NETWORK_TYPE_UNDERLAY = 2; diff --git a/js/metalstack/api/v2/partition_pb.d.ts b/js/metalstack/api/v2/partition_pb.d.ts index bde66e38..2f123e85 100644 --- a/js/metalstack/api/v2/partition_pb.d.ts +++ b/js/metalstack/api/v2/partition_pb.d.ts @@ -12,19 +12,19 @@ export declare const file_metalstack_api_v2_partition: GenFile; */ export type Partition = Message<"metalstack.api.v2.Partition"> & { /** - * ID of this partition + * ID of this partition. * * @generated from field: string id = 1; */ id: string; /** - * Meta for this partition + * Meta for this partition. * * @generated from field: metalstack.api.v2.Meta meta = 2; */ meta?: Meta | undefined; /** - * Description of this partition + * Description of this partition. * * @generated from field: string description = 3; */ @@ -36,20 +36,20 @@ export type Partition = Message<"metalstack.api.v2.Partition"> & { */ bootConfiguration?: PartitionBootConfiguration | undefined; /** - * DNSServers for this partition + * DNSServers for this partition. * * @generated from field: repeated metalstack.api.v2.DNSServer dns_servers = 5; */ dnsServers: DNSServer[]; /** - * NTPServers for this partition + * NTPServers for this partition. * * @generated from field: repeated metalstack.api.v2.NTPServer ntp_servers = 6; */ ntpServers: NTPServer[]; /** * ManagementServiceAddresses defines where the management is reachable. - * should be in the form : + * should be in the form :. * * @generated from field: repeated string mgmt_service_addresses = 7; */ @@ -67,7 +67,7 @@ export declare const PartitionSchema: GenMessage; */ export type PartitionQuery = Message<"metalstack.api.v2.PartitionQuery"> & { /** - * ID of the partition to get + * ID of the partition to get. * * @generated from field: optional string id = 1; */ @@ -91,19 +91,19 @@ export declare const PartitionQuerySchema: GenMessage; */ export type PartitionBootConfiguration = Message<"metalstack.api.v2.PartitionBootConfiguration"> & { /** - * ImageURL the url to download the initrd for the boot image + * ImageURL the url to download the initrd for the boot image. * * @generated from field: string image_url = 1; */ imageUrl: string; /** - * KernelURL the url to download the kernel for the boot image + * KernelURL the url to download the kernel for the boot image. * * @generated from field: string kernel_url = 2; */ kernelUrl: string; /** - * Commandline the kernel command line for the boot image + * Commandline the kernel command line for the boot image. * * @generated from field: string commandline = 3; */ @@ -115,13 +115,13 @@ export type PartitionBootConfiguration = Message<"metalstack.api.v2.PartitionBoo */ export declare const PartitionBootConfigurationSchema: GenMessage; /** - * DNSServer + * DNSServer. * * @generated from message metalstack.api.v2.DNSServer */ export type DNSServer = Message<"metalstack.api.v2.DNSServer"> & { /** - * IP address of this dns server + * IP address of this dns server. * * @generated from field: string ip = 1; */ @@ -133,13 +133,13 @@ export type DNSServer = Message<"metalstack.api.v2.DNSServer"> & { */ export declare const DNSServerSchema: GenMessage; /** - * NTPServer + * NTPServer. * * @generated from message metalstack.api.v2.NTPServer */ export type NTPServer = Message<"metalstack.api.v2.NTPServer"> & { /** - * Address either as ip or hostname + * Address either as ip or hostname. * * @generated from field: string address = 1; */ @@ -157,7 +157,7 @@ export declare const NTPServerSchema: GenMessage; */ export type PartitionServiceGetRequest = Message<"metalstack.api.v2.PartitionServiceGetRequest"> & { /** - * ID of the partition to get + * ID of the partition to get. * * @generated from field: string id = 1; */ diff --git a/js/metalstack/api/v2/partition_pb.ts b/js/metalstack/api/v2/partition_pb.ts index 184bb297..1c5c52fd 100644 --- a/js/metalstack/api/v2/partition_pb.ts +++ b/js/metalstack/api/v2/partition_pb.ts @@ -23,21 +23,21 @@ export const file_metalstack_api_v2_partition: GenFile = /*@__PURE__*/ */ export type Partition = Message<"metalstack.api.v2.Partition"> & { /** - * ID of this partition + * ID of this partition. * * @generated from field: string id = 1; */ id: string; /** - * Meta for this partition + * Meta for this partition. * * @generated from field: metalstack.api.v2.Meta meta = 2; */ meta?: Meta | undefined; /** - * Description of this partition + * Description of this partition. * * @generated from field: string description = 3; */ @@ -51,14 +51,14 @@ export type Partition = Message<"metalstack.api.v2.Partition"> & { bootConfiguration?: PartitionBootConfiguration | undefined; /** - * DNSServers for this partition + * DNSServers for this partition. * * @generated from field: repeated metalstack.api.v2.DNSServer dns_servers = 5; */ dnsServers: DNSServer[]; /** - * NTPServers for this partition + * NTPServers for this partition. * * @generated from field: repeated metalstack.api.v2.NTPServer ntp_servers = 6; */ @@ -66,7 +66,7 @@ export type Partition = Message<"metalstack.api.v2.Partition"> & { /** * ManagementServiceAddresses defines where the management is reachable. - * should be in the form : + * should be in the form :. * * @generated from field: repeated string mgmt_service_addresses = 7; */ @@ -87,7 +87,7 @@ export const PartitionSchema: GenMessage = /*@__PURE__*/ */ export type PartitionQuery = Message<"metalstack.api.v2.PartitionQuery"> & { /** - * ID of the partition to get + * ID of the partition to get. * * @generated from field: optional string id = 1; */ @@ -115,21 +115,21 @@ export const PartitionQuerySchema: GenMessage = /*@__PURE__*/ */ export type PartitionBootConfiguration = Message<"metalstack.api.v2.PartitionBootConfiguration"> & { /** - * ImageURL the url to download the initrd for the boot image + * ImageURL the url to download the initrd for the boot image. * * @generated from field: string image_url = 1; */ imageUrl: string; /** - * KernelURL the url to download the kernel for the boot image + * KernelURL the url to download the kernel for the boot image. * * @generated from field: string kernel_url = 2; */ kernelUrl: string; /** - * Commandline the kernel command line for the boot image + * Commandline the kernel command line for the boot image. * * @generated from field: string commandline = 3; */ @@ -144,13 +144,13 @@ export const PartitionBootConfigurationSchema: GenMessage & { /** - * IP address of this dns server + * IP address of this dns server. * * @generated from field: string ip = 1; */ @@ -165,13 +165,13 @@ export const DNSServerSchema: GenMessage = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_partition, 3); /** - * NTPServer + * NTPServer. * * @generated from message metalstack.api.v2.NTPServer */ export type NTPServer = Message<"metalstack.api.v2.NTPServer"> & { /** - * Address either as ip or hostname + * Address either as ip or hostname. * * @generated from field: string address = 1; */ @@ -192,7 +192,7 @@ export const NTPServerSchema: GenMessage = /*@__PURE__*/ */ export type PartitionServiceGetRequest = Message<"metalstack.api.v2.PartitionServiceGetRequest"> & { /** - * ID of the partition to get + * ID of the partition to get. * * @generated from field: string id = 1; */ diff --git a/js/metalstack/api/v2/project_pb.d.ts b/js/metalstack/api/v2/project_pb.d.ts index 45f206e8..7fb60e0e 100644 --- a/js/metalstack/api/v2/project_pb.d.ts +++ b/js/metalstack/api/v2/project_pb.d.ts @@ -8,43 +8,43 @@ import type { Message } from "@bufbuild/protobuf"; export declare const file_metalstack_api_v2_project: GenFile; /** * Project defines a group of resources belonging to a tenant. - * a tenant can have multiple projects + * a tenant can have multiple projects. * * @generated from message metalstack.api.v2.Project */ export type Project = Message<"metalstack.api.v2.Project"> & { /** - * Uuid of this project + * Uuid of this project. * * @generated from field: string uuid = 1; */ uuid: string; /** - * Meta for this project + * Meta for this project. * * @generated from field: metalstack.api.v2.Meta meta = 2; */ meta?: Meta | undefined; /** - * Name of this project must be unique per tenant + * Name of this project must be unique per tenant. * * @generated from field: string name = 3; */ name: string; /** - * Description of this project + * Description of this project. * * @generated from field: string description = 4; */ description: string; /** - * Tenant this project belongs to + * Tenant this project belongs to. * * @generated from field: string tenant = 5; */ tenant: string; /** - * AvatarUrl of the Project + * AvatarUrl of the Project. * * @generated from field: optional string avatar_url = 6; */ @@ -82,13 +82,13 @@ export type ProjectMember = Message<"metalstack.api.v2.ProjectMember"> & { */ inheritedMembership: boolean; /** - * CreatedAt the date when the member was added to the project + * CreatedAt the date when the member was added to the project. * * @generated from field: google.protobuf.Timestamp created_at = 4; */ createdAt?: Timestamp | undefined; /** - * Meta for this project member + * Meta for this project member. * * @generated from field: metalstack.api.v2.Meta meta = 5; */ @@ -148,13 +148,13 @@ export type ProjectInvite = Message<"metalstack.api.v2.ProjectInvite"> & { */ tenantName: string; /** - * ExpiresAt the date when this invite expires + * ExpiresAt the date when this invite expires. * * @generated from field: google.protobuf.Timestamp expires_at = 8; */ expiresAt?: Timestamp | undefined; /** - * JoinedAt the date when the member accepted this invite + * JoinedAt the date when the member accepted this invite. * * @generated from field: google.protobuf.Timestamp joined_at = 9; */ @@ -268,7 +268,7 @@ export type ProjectServiceGetResponse = Message<"metalstack.api.v2.ProjectServic */ project?: Project | undefined; /** - * ProjectMembers in this project, projects guests will only see direct project members and not implicit memberships from tenant permissions + * ProjectMembers in this project, projects guests will only see direct project members and not implicit memberships from tenant permissions. * * @generated from field: repeated metalstack.api.v2.ProjectMember project_members = 2; */ @@ -287,31 +287,31 @@ export declare const ProjectServiceGetResponseSchema: GenMessage & { /** * Login is the tenant of this project. - * TODO: is login really a good name? + * TODO: is login really a good name?. * * @generated from field: string login = 1; */ login: string; /** - * Name of this project, unique per tenant + * Name of this project, unique per tenant. * * @generated from field: string name = 2; */ name: string; /** - * Description of this project + * Description of this project. * * @generated from field: string description = 3; */ description: string; /** - * Avatar URL of the project + * Avatar URL of the project. * * @generated from field: optional string avatar_url = 4; */ avatarUrl?: string | undefined; /** - * Labels on the project + * Labels on the project. * * @generated from field: metalstack.api.v2.Labels labels = 5; */ @@ -395,25 +395,25 @@ export type ProjectServiceUpdateRequest = Message<"metalstack.api.v2.ProjectServ */ updateMeta?: UpdateMeta | undefined; /** - * Name of this project unique per tenant + * Name of this project unique per tenant. * * @generated from field: optional string name = 3; */ name?: string | undefined; /** - * Description of this project + * Description of this project. * * @generated from field: optional string description = 4; */ description?: string | undefined; /** - * Avatar URL of the project + * Avatar URL of the project. * * @generated from field: optional string avatar_url = 5; */ avatarUrl?: string | undefined; /** - * Labels on this project + * Labels on this project. * * @generated from field: optional metalstack.api.v2.UpdateLabels labels = 6; */ @@ -455,7 +455,7 @@ export type ProjectServiceInviteRequest = Message<"metalstack.api.v2.ProjectServ */ project: string; /** - * Role of this user in this project + * Role of this user in this project. * * @generated from field: metalstack.api.v2.ProjectRole role = 2; */ @@ -474,8 +474,8 @@ export declare const ProjectServiceInviteRequestSchema: GenMessage & { /** * Inviter contains a secret which can be sent to a potential user. - * can be appended to the invitation endpoint at our cloud console like - * console.metalstack.cloud/invite/ + * can be appended to the invitation endpoint at our cloud console like. + * console.metalstack.cloud/invite/ & { /** - * Invites not already accepted the invitation to this project + * Invites not already accepted the invitation to this project. * * @generated from field: repeated metalstack.api.v2.ProjectInvite invites = 1; */ @@ -529,7 +529,7 @@ export declare const ProjectServiceInvitesListResponseSchema: GenMessage & { /** - * Secret of the invite to list + * Secret of the invite to list. * * @generated from field: string secret = 1; */ @@ -600,13 +600,13 @@ export type ProjectServiceAddMemberRequest = Message<"metalstack.api.v2.ProjectS */ project: string; /** - * Login of the member to add + * Login of the member to add. * * @generated from field: string member = 2; */ member: string; /** - * Role to assign to the new member + * Role to assign to the new member. * * @generated from field: metalstack.api.v2.ProjectRole role = 3; */ @@ -743,13 +743,13 @@ export declare const ProjectServiceInviteAcceptRequestSchema: GenMessage & { /** - * Project ID of the project joined + * Project ID of the project joined. * * @generated from field: string project = 1; */ project: string; /** - * ProjectName of the project joined + * ProjectName of the project joined. * * @generated from field: string project_name = 2; */ @@ -773,7 +773,7 @@ export type ProjectServiceInviteDeleteRequest = Message<"metalstack.api.v2.Proje */ project: string; /** - * Secret of the invite to delete + * Secret of the invite to delete. * * @generated from field: string secret = 2; */ @@ -932,7 +932,7 @@ export declare const ProjectService: GenService<{ output: typeof ProjectServiceInvitesListResponseSchema; }; /** - * InviteGet get an invite + * InviteGet get an invite. * * @generated from rpc metalstack.api.v2.ProjectService.InviteGet */ diff --git a/js/metalstack/api/v2/project_pb.ts b/js/metalstack/api/v2/project_pb.ts index 0d07008d..ebd3447e 100644 --- a/js/metalstack/api/v2/project_pb.ts +++ b/js/metalstack/api/v2/project_pb.ts @@ -20,48 +20,48 @@ export const file_metalstack_api_v2_project: GenFile = /*@__PURE__*/ /** * Project defines a group of resources belonging to a tenant. - * a tenant can have multiple projects + * a tenant can have multiple projects. * * @generated from message metalstack.api.v2.Project */ export type Project = Message<"metalstack.api.v2.Project"> & { /** - * Uuid of this project + * Uuid of this project. * * @generated from field: string uuid = 1; */ uuid: string; /** - * Meta for this project + * Meta for this project. * * @generated from field: metalstack.api.v2.Meta meta = 2; */ meta?: Meta | undefined; /** - * Name of this project must be unique per tenant + * Name of this project must be unique per tenant. * * @generated from field: string name = 3; */ name: string; /** - * Description of this project + * Description of this project. * * @generated from field: string description = 4; */ description: string; /** - * Tenant this project belongs to + * Tenant this project belongs to. * * @generated from field: string tenant = 5; */ tenant: string; /** - * AvatarUrl of the Project + * AvatarUrl of the Project. * * @generated from field: optional string avatar_url = 6; */ @@ -105,14 +105,14 @@ export type ProjectMember = Message<"metalstack.api.v2.ProjectMember"> & { inheritedMembership: boolean; /** - * CreatedAt the date when the member was added to the project + * CreatedAt the date when the member was added to the project. * * @generated from field: google.protobuf.Timestamp created_at = 4; */ createdAt?: Timestamp | undefined; /** - * Meta for this project member + * Meta for this project member. * * @generated from field: metalstack.api.v2.Meta meta = 5; */ @@ -182,14 +182,14 @@ export type ProjectInvite = Message<"metalstack.api.v2.ProjectInvite"> & { tenantName: string; /** - * ExpiresAt the date when this invite expires + * ExpiresAt the date when this invite expires. * * @generated from field: google.protobuf.Timestamp expires_at = 8; */ expiresAt?: Timestamp | undefined; /** - * JoinedAt the date when the member accepted this invite + * JoinedAt the date when the member accepted this invite. * * @generated from field: google.protobuf.Timestamp joined_at = 9; */ @@ -322,7 +322,7 @@ export type ProjectServiceGetResponse = Message<"metalstack.api.v2.ProjectServic project?: Project | undefined; /** - * ProjectMembers in this project, projects guests will only see direct project members and not implicit memberships from tenant permissions + * ProjectMembers in this project, projects guests will only see direct project members and not implicit memberships from tenant permissions. * * @generated from field: repeated metalstack.api.v2.ProjectMember project_members = 2; */ @@ -344,35 +344,35 @@ export const ProjectServiceGetResponseSchema: GenMessage & { /** * Login is the tenant of this project. - * TODO: is login really a good name? + * TODO: is login really a good name?. * * @generated from field: string login = 1; */ login: string; /** - * Name of this project, unique per tenant + * Name of this project, unique per tenant. * * @generated from field: string name = 2; */ name: string; /** - * Description of this project + * Description of this project. * * @generated from field: string description = 3; */ description: string; /** - * Avatar URL of the project + * Avatar URL of the project. * * @generated from field: optional string avatar_url = 4; */ avatarUrl?: string | undefined; /** - * Labels on the project + * Labels on the project. * * @generated from field: metalstack.api.v2.Labels labels = 5; */ @@ -470,28 +470,28 @@ export type ProjectServiceUpdateRequest = Message<"metalstack.api.v2.ProjectServ updateMeta?: UpdateMeta | undefined; /** - * Name of this project unique per tenant + * Name of this project unique per tenant. * * @generated from field: optional string name = 3; */ name?: string | undefined; /** - * Description of this project + * Description of this project. * * @generated from field: optional string description = 4; */ description?: string | undefined; /** - * Avatar URL of the project + * Avatar URL of the project. * * @generated from field: optional string avatar_url = 5; */ avatarUrl?: string | undefined; /** - * Labels on this project + * Labels on this project. * * @generated from field: optional metalstack.api.v2.UpdateLabels labels = 6; */ @@ -540,7 +540,7 @@ export type ProjectServiceInviteRequest = Message<"metalstack.api.v2.ProjectServ project: string; /** - * Role of this user in this project + * Role of this user in this project. * * @generated from field: metalstack.api.v2.ProjectRole role = 2; */ @@ -562,8 +562,8 @@ export const ProjectServiceInviteRequestSchema: GenMessage & { /** * Inviter contains a secret which can be sent to a potential user. - * can be appended to the invitation endpoint at our cloud console like - * console.metalstack.cloud/invite/ + * can be appended to the invitation endpoint at our cloud console like. + * console.metalstack.cloud/invite/ & { /** - * Invites not already accepted the invitation to this project + * Invites not already accepted the invitation to this project. * * @generated from field: repeated metalstack.api.v2.ProjectInvite invites = 1; */ @@ -626,7 +626,7 @@ export const ProjectServiceInvitesListResponseSchema: GenMessage & { /** - * Secret of the invite to list + * Secret of the invite to list. * * @generated from field: string secret = 1; */ @@ -711,14 +711,14 @@ export type ProjectServiceAddMemberRequest = Message<"metalstack.api.v2.ProjectS project: string; /** - * Login of the member to add + * Login of the member to add. * * @generated from field: string member = 2; */ member: string; /** - * Role to assign to the new member + * Role to assign to the new member. * * @generated from field: metalstack.api.v2.ProjectRole role = 3; */ @@ -880,14 +880,14 @@ export const ProjectServiceInviteAcceptRequestSchema: GenMessage & { /** - * Project ID of the project joined + * Project ID of the project joined. * * @generated from field: string project = 1; */ project: string; /** - * ProjectName of the project joined + * ProjectName of the project joined. * * @generated from field: string project_name = 2; */ @@ -915,7 +915,7 @@ export type ProjectServiceInviteDeleteRequest = Message<"metalstack.api.v2.Proje project: string; /** - * Secret of the invite to delete + * Secret of the invite to delete. * * @generated from field: string secret = 2; */ @@ -1081,7 +1081,7 @@ export const ProjectService: GenService<{ output: typeof ProjectServiceInvitesListResponseSchema; }, /** - * InviteGet get an invite + * InviteGet get an invite. * * @generated from rpc metalstack.api.v2.ProjectService.InviteGet */ diff --git a/js/metalstack/api/v2/size_imageconstraint_pb.d.ts b/js/metalstack/api/v2/size_imageconstraint_pb.d.ts index 6d875ddb..8efa4acf 100644 --- a/js/metalstack/api/v2/size_imageconstraint_pb.d.ts +++ b/js/metalstack/api/v2/size_imageconstraint_pb.d.ts @@ -12,13 +12,13 @@ export declare const file_metalstack_api_v2_size_imageconstraint: GenFile; */ export type SizeImageConstraintServiceTryRequest = Message<"metalstack.api.v2.SizeImageConstraintServiceTryRequest"> & { /** - * Size to try + * Size to try. * * @generated from field: string size = 1; */ size: string; /** - * Image to try + * Image to try. * * @generated from field: string image = 2; */ @@ -42,8 +42,7 @@ export type SizeImageConstraintServiceTryResponse = Message<"metalstack.api.v2.S export declare const SizeImageConstraintServiceTryResponseSchema: GenMessage; /** * SizeImageConstraint expresses optional restrictions for specific size to image combinations. - * this might be required if the support for a specific hardware in a given size is only supported - * with a newer version of the image. + * This might be required if the support for a specific hardware in a given size is only supported with a newer version of the image. * * If the size in question is not found, no restrictions apply. * If the image in question is not found, no restrictions apply as well. @@ -59,25 +58,25 @@ export type SizeImageConstraint = Message<"metalstack.api.v2.SizeImageConstraint */ size: string; /** - * ImageConstraints to apply to this size + * ImageConstraints to apply to this size. * * @generated from field: repeated metalstack.api.v2.ImageConstraint image_constraints = 2; */ imageConstraints: ImageConstraint[]; /** - * Meta for this size image constraint + * Meta for this size image constraint. * * @generated from field: metalstack.api.v2.Meta meta = 3; */ meta?: Meta | undefined; /** - * Name of this size image constraint + * Name of this size image constraint. * * @generated from field: optional string name = 4; */ name?: string | undefined; /** - * Description of this size image constraint + * Description of this size image constraint. * * @generated from field: optional string description = 5; */ @@ -90,22 +89,22 @@ export type SizeImageConstraint = Message<"metalstack.api.v2.SizeImageConstraint export declare const SizeImageConstraintSchema: GenMessage; /** * ImageConstraint defines a constraint for an image. - * examples: + * Examples: * images: - * ubuntu: ">= 20.04.20211011" - * debian: ">= 10.0.20210101" + * ubuntu: ">= 20.04.20211011 + * debian: ">= 10.0.20210101 * * @generated from message metalstack.api.v2.ImageConstraint */ export type ImageConstraint = Message<"metalstack.api.v2.ImageConstraint"> & { /** - * Image of the constraint + * Image of the constraint. * * @generated from field: string image = 1; */ image: string; /** - * SemverMatch which defines in semver match format which image version should apply + * SemverMatch which defines in semver match format which image version should apply. * * @generated from field: string semver_match = 2; */ @@ -123,19 +122,19 @@ export declare const ImageConstraintSchema: GenMessage; */ export type SizeImageConstraintQuery = Message<"metalstack.api.v2.SizeImageConstraintQuery"> & { /** - * Size of the size image constraint + * Size of the size image constraint. * * @generated from field: optional string size = 1; */ size?: string | undefined; /** - * Name of the size image constraint to query + * Name of the size image constraint to query. * * @generated from field: optional string name = 2; */ name?: string | undefined; /** - * Description of the size image constraint to query + * Description of the size image constraint to query. * * @generated from field: optional string description = 3; */ diff --git a/js/metalstack/api/v2/size_imageconstraint_pb.ts b/js/metalstack/api/v2/size_imageconstraint_pb.ts index 6240ca0c..37e913ee 100644 --- a/js/metalstack/api/v2/size_imageconstraint_pb.ts +++ b/js/metalstack/api/v2/size_imageconstraint_pb.ts @@ -23,14 +23,14 @@ export const file_metalstack_api_v2_size_imageconstraint: GenFile = /*@__PURE__* */ export type SizeImageConstraintServiceTryRequest = Message<"metalstack.api.v2.SizeImageConstraintServiceTryRequest"> & { /** - * Size to try + * Size to try. * * @generated from field: string size = 1; */ size: string; /** - * Image to try + * Image to try. * * @generated from field: string image = 2; */ @@ -61,8 +61,7 @@ export const SizeImageConstraintServiceTryResponseSchema: GenMessage = /*@__P /** * ImageConstraint defines a constraint for an image. - * examples: + * Examples: * images: - * ubuntu: ">= 20.04.20211011" - * debian: ">= 10.0.20210101" + * ubuntu: ">= 20.04.20211011 + * debian: ">= 10.0.20210101 * * @generated from message metalstack.api.v2.ImageConstraint */ export type ImageConstraint = Message<"metalstack.api.v2.ImageConstraint"> & { /** - * Image of the constraint + * Image of the constraint. * * @generated from field: string image = 1; */ image: string; /** - * SemverMatch which defines in semver match format which image version should apply + * SemverMatch which defines in semver match format which image version should apply. * * @generated from field: string semver_match = 2; */ @@ -153,21 +152,21 @@ export const ImageConstraintSchema: GenMessage = /*@__PURE__*/ */ export type SizeImageConstraintQuery = Message<"metalstack.api.v2.SizeImageConstraintQuery"> & { /** - * Size of the size image constraint + * Size of the size image constraint. * * @generated from field: optional string size = 1; */ size?: string | undefined; /** - * Name of the size image constraint to query + * Name of the size image constraint to query. * * @generated from field: optional string name = 2; */ name?: string | undefined; /** - * Description of the size image constraint to query + * Description of the size image constraint to query. * * @generated from field: optional string description = 3; */ diff --git a/js/metalstack/api/v2/size_pb.d.ts b/js/metalstack/api/v2/size_pb.d.ts index 0d1cd815..b11e4246 100644 --- a/js/metalstack/api/v2/size_pb.d.ts +++ b/js/metalstack/api/v2/size_pb.d.ts @@ -12,7 +12,7 @@ export declare const file_metalstack_api_v2_size: GenFile; */ export type SizeServiceGetRequest = Message<"metalstack.api.v2.SizeServiceGetRequest"> & { /** - * ID of the size to get + * ID of the size to get. * * @generated from field: string id = 1; */ @@ -48,7 +48,7 @@ export declare const SizeServiceListRequestSchema: GenMessage & { /** - * Size the size + * Size the size. * * @generated from field: metalstack.api.v2.Size size = 1; */ @@ -66,7 +66,7 @@ export declare const SizeServiceGetResponseSchema: GenMessage & { /** - * Sizes the sizes + * Sizes the sizes. * * @generated from field: repeated metalstack.api.v2.Size sizes = 1; */ @@ -78,37 +78,37 @@ export type SizeServiceListResponse = Message<"metalstack.api.v2.SizeServiceList */ export declare const SizeServiceListResponseSchema: GenMessage; /** - * Size + * Size. * * @generated from message metalstack.api.v2.Size */ export type Size = Message<"metalstack.api.v2.Size"> & { /** - * Id of this size + * Id of this size. * * @generated from field: string id = 1; */ id: string; /** - * Meta for this size + * Meta for this size. * * @generated from field: metalstack.api.v2.Meta meta = 2; */ meta?: Meta | undefined; /** - * Name of this size + * Name of this size. * * @generated from field: optional string name = 3; */ name?: string | undefined; /** - * Description of this size + * Description of this size. * * @generated from field: optional string description = 4; */ description?: string | undefined; /** - * Constraints which must match that a specific machine is considered of this size + * Constraints which must match that a specific machine is considered of this size. * * @generated from field: repeated metalstack.api.v2.SizeConstraint constraints = 5; */ @@ -126,19 +126,19 @@ export declare const SizeSchema: GenMessage; */ export type SizeConstraint = Message<"metalstack.api.v2.SizeConstraint"> & { /** - * Type a machine matches to a size in order to make them easier to categorize + * Type a machine matches to a size in order to make them easier to categorize. * * @generated from field: metalstack.api.v2.SizeConstraintType type = 1; */ type: SizeConstraintType; /** - * Min the minimum value of the constraint + * Min the minimum value of the constraint. * * @generated from field: uint64 min = 2; */ min: bigint; /** - * Max the maximum value of the constraint + * Max the maximum value of the constraint. * * @generated from field: uint64 max = 3; */ @@ -162,19 +162,19 @@ export declare const SizeConstraintSchema: GenMessage; */ export type SizeQuery = Message<"metalstack.api.v2.SizeQuery"> & { /** - * ID of the size to get + * ID of the size to get. * * @generated from field: optional string id = 1; */ id?: string | undefined; /** - * Name of the size to query + * Name of the size to query. * * @generated from field: optional string name = 2; */ name?: string | undefined; /** - * Description of the size to query + * Description of the size to query. * * @generated from field: optional string description = 3; */ @@ -198,7 +198,7 @@ export declare const SizeQuerySchema: GenMessage; */ export declare enum SizeConstraintType { /** - * SIZE_CONSTRAINT_TYPE_UNSPECIFIED type is not specified + * SIZE_CONSTRAINT_TYPE_UNSPECIFIED type is not specified. * * @generated from enum value: SIZE_CONSTRAINT_TYPE_UNSPECIFIED = 0; */ diff --git a/js/metalstack/api/v2/size_pb.js b/js/metalstack/api/v2/size_pb.js index 3660a31a..f384daa5 100644 --- a/js/metalstack/api/v2/size_pb.js +++ b/js/metalstack/api/v2/size_pb.js @@ -52,7 +52,7 @@ export const SizeQuerySchema = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_ export var SizeConstraintType; (function (SizeConstraintType) { /** - * SIZE_CONSTRAINT_TYPE_UNSPECIFIED type is not specified + * SIZE_CONSTRAINT_TYPE_UNSPECIFIED type is not specified. * * @generated from enum value: SIZE_CONSTRAINT_TYPE_UNSPECIFIED = 0; */ diff --git a/js/metalstack/api/v2/size_pb.ts b/js/metalstack/api/v2/size_pb.ts index 30902ad3..8f0425ea 100644 --- a/js/metalstack/api/v2/size_pb.ts +++ b/js/metalstack/api/v2/size_pb.ts @@ -23,7 +23,7 @@ export const file_metalstack_api_v2_size: GenFile = /*@__PURE__*/ */ export type SizeServiceGetRequest = Message<"metalstack.api.v2.SizeServiceGetRequest"> & { /** - * ID of the size to get + * ID of the size to get. * * @generated from field: string id = 1; */ @@ -65,7 +65,7 @@ export const SizeServiceListRequestSchema: GenMessage = */ export type SizeServiceGetResponse = Message<"metalstack.api.v2.SizeServiceGetResponse"> & { /** - * Size the size + * Size the size. * * @generated from field: metalstack.api.v2.Size size = 1; */ @@ -86,7 +86,7 @@ export const SizeServiceGetResponseSchema: GenMessage = */ export type SizeServiceListResponse = Message<"metalstack.api.v2.SizeServiceListResponse"> & { /** - * Sizes the sizes + * Sizes the sizes. * * @generated from field: repeated metalstack.api.v2.Size sizes = 1; */ @@ -101,41 +101,41 @@ export const SizeServiceListResponseSchema: GenMessage messageDesc(file_metalstack_api_v2_size, 3); /** - * Size + * Size. * * @generated from message metalstack.api.v2.Size */ export type Size = Message<"metalstack.api.v2.Size"> & { /** - * Id of this size + * Id of this size. * * @generated from field: string id = 1; */ id: string; /** - * Meta for this size + * Meta for this size. * * @generated from field: metalstack.api.v2.Meta meta = 2; */ meta?: Meta | undefined; /** - * Name of this size + * Name of this size. * * @generated from field: optional string name = 3; */ name?: string | undefined; /** - * Description of this size + * Description of this size. * * @generated from field: optional string description = 4; */ description?: string | undefined; /** - * Constraints which must match that a specific machine is considered of this size + * Constraints which must match that a specific machine is considered of this size. * * @generated from field: repeated metalstack.api.v2.SizeConstraint constraints = 5; */ @@ -156,21 +156,21 @@ export const SizeSchema: GenMessage = /*@__PURE__*/ */ export type SizeConstraint = Message<"metalstack.api.v2.SizeConstraint"> & { /** - * Type a machine matches to a size in order to make them easier to categorize + * Type a machine matches to a size in order to make them easier to categorize. * * @generated from field: metalstack.api.v2.SizeConstraintType type = 1; */ type: SizeConstraintType; /** - * Min the minimum value of the constraint + * Min the minimum value of the constraint. * * @generated from field: uint64 min = 2; */ min: bigint; /** - * Max the maximum value of the constraint + * Max the maximum value of the constraint. * * @generated from field: uint64 max = 3; */ @@ -198,21 +198,21 @@ export const SizeConstraintSchema: GenMessage = /*@__PURE__*/ */ export type SizeQuery = Message<"metalstack.api.v2.SizeQuery"> & { /** - * ID of the size to get + * ID of the size to get. * * @generated from field: optional string id = 1; */ id?: string | undefined; /** - * Name of the size to query + * Name of the size to query. * * @generated from field: optional string name = 2; */ name?: string | undefined; /** - * Description of the size to query + * Description of the size to query. * * @generated from field: optional string description = 3; */ @@ -240,7 +240,7 @@ export const SizeQuerySchema: GenMessage = /*@__PURE__*/ */ export enum SizeConstraintType { /** - * SIZE_CONSTRAINT_TYPE_UNSPECIFIED type is not specified + * SIZE_CONSTRAINT_TYPE_UNSPECIFIED type is not specified. * * @generated from enum value: SIZE_CONSTRAINT_TYPE_UNSPECIFIED = 0; */ diff --git a/js/metalstack/api/v2/size_reservation_pb.d.ts b/js/metalstack/api/v2/size_reservation_pb.d.ts index bb0a283b..f2bde2c0 100644 --- a/js/metalstack/api/v2/size_reservation_pb.d.ts +++ b/js/metalstack/api/v2/size_reservation_pb.d.ts @@ -12,13 +12,13 @@ export declare const file_metalstack_api_v2_size_reservation: GenFile; */ export type SizeReservationServiceGetRequest = Message<"metalstack.api.v2.SizeReservationServiceGetRequest"> & { /** - * ID of the size reservation to get + * ID of the size reservation to get. * * @generated from field: string id = 1; */ id: string; /** - * Project of the size reservation + * Project of the size reservation. * * @generated from field: string project = 2; */ @@ -36,7 +36,7 @@ export declare const SizeReservationServiceGetRequestSchema: GenMessage & { /** - * Project of the size reservation + * Project of the size reservation. * * @generated from field: string project = 1; */ @@ -60,7 +60,7 @@ export declare const SizeReservationServiceListRequestSchema: GenMessage & { /** - * Size reservation + * Size reservation. * * @generated from field: metalstack.api.v2.SizeReservation size_reservation = 1; */ @@ -78,7 +78,7 @@ export declare const SizeReservationServiceGetResponseSchema: GenMessage & { /** - * Size reservations + * Size reservations. * * @generated from field: repeated metalstack.api.v2.SizeReservation size_reservations = 1; */ @@ -90,55 +90,55 @@ export type SizeReservationServiceListResponse = Message<"metalstack.api.v2.Size */ export declare const SizeReservationServiceListResponseSchema: GenMessage; /** - * SizeReservation + * SizeReservation. * * @generated from message metalstack.api.v2.SizeReservation */ export type SizeReservation = Message<"metalstack.api.v2.SizeReservation"> & { /** - * Id of this size reservation, is generated on creation + * Id of this size reservation, is generated on creation. * * @generated from field: string id = 1; */ id: string; /** - * Meta for this size reservation + * Meta for this size reservation. * * @generated from field: metalstack.api.v2.Meta meta = 2; */ meta?: Meta | undefined; /** - * Name of this size reservation + * Name of this size reservation. * * @generated from field: string name = 3; */ name: string; /** - * Description of this size reservation + * Description of this size reservation. * * @generated from field: string description = 4; */ description: string; /** - * Project of the size reservation + * Project of the size reservation. * * @generated from field: string project = 5; */ project: string; /** - * Size id of this size reservation + * Size id of this size reservation. * * @generated from field: string size = 6; */ size: string; /** - * Partition ids of this size reservation + * Partition ids of this size reservation. * * @generated from field: repeated string partitions = 7; */ partitions: string[]; /** - * Amount of reservations of this size reservation + * Amount of reservations of this size reservation. * * @generated from field: int32 amount = 8; */ @@ -156,37 +156,37 @@ export declare const SizeReservationSchema: GenMessage; */ export type SizeReservationQuery = Message<"metalstack.api.v2.SizeReservationQuery"> & { /** - * ID of the size reservation to get + * ID of the size reservation to get. * * @generated from field: optional string id = 1; */ id?: string | undefined; /** - * Name of this size reservation + * Name of this size reservation. * * @generated from field: optional string name = 2; */ name?: string | undefined; /** - * Description of this size reservation + * Description of this size reservation. * * @generated from field: optional string description = 3; */ description?: string | undefined; /** - * Size id of this size reservation + * Size id of this size reservation. * * @generated from field: optional string size = 4; */ size?: string | undefined; /** - * Project of the size reservation + * Project of the size reservation. * * @generated from field: optional string project = 5; */ project?: string | undefined; /** - * Partition of the size reservation + * Partition of the size reservation. * * @generated from field: optional string partition = 6; */ diff --git a/js/metalstack/api/v2/size_reservation_pb.ts b/js/metalstack/api/v2/size_reservation_pb.ts index 4472fe5d..da426cc1 100644 --- a/js/metalstack/api/v2/size_reservation_pb.ts +++ b/js/metalstack/api/v2/size_reservation_pb.ts @@ -23,14 +23,14 @@ export const file_metalstack_api_v2_size_reservation: GenFile = /*@__PURE__*/ */ export type SizeReservationServiceGetRequest = Message<"metalstack.api.v2.SizeReservationServiceGetRequest"> & { /** - * ID of the size reservation to get + * ID of the size reservation to get. * * @generated from field: string id = 1; */ id: string; /** - * Project of the size reservation + * Project of the size reservation. * * @generated from field: string project = 2; */ @@ -51,7 +51,7 @@ export const SizeReservationServiceGetRequestSchema: GenMessage & { /** - * Project of the size reservation + * Project of the size reservation. * * @generated from field: string project = 1; */ @@ -79,7 +79,7 @@ export const SizeReservationServiceListRequestSchema: GenMessage & { /** - * Size reservation + * Size reservation. * * @generated from field: metalstack.api.v2.SizeReservation size_reservation = 1; */ @@ -100,7 +100,7 @@ export const SizeReservationServiceGetResponseSchema: GenMessage & { /** - * Size reservations + * Size reservations. * * @generated from field: repeated metalstack.api.v2.SizeReservation size_reservations = 1; */ @@ -115,62 +115,62 @@ export const SizeReservationServiceListResponseSchema: GenMessage & { /** - * Id of this size reservation, is generated on creation + * Id of this size reservation, is generated on creation. * * @generated from field: string id = 1; */ id: string; /** - * Meta for this size reservation + * Meta for this size reservation. * * @generated from field: metalstack.api.v2.Meta meta = 2; */ meta?: Meta | undefined; /** - * Name of this size reservation + * Name of this size reservation. * * @generated from field: string name = 3; */ name: string; /** - * Description of this size reservation + * Description of this size reservation. * * @generated from field: string description = 4; */ description: string; /** - * Project of the size reservation + * Project of the size reservation. * * @generated from field: string project = 5; */ project: string; /** - * Size id of this size reservation + * Size id of this size reservation. * * @generated from field: string size = 6; */ size: string; /** - * Partition ids of this size reservation + * Partition ids of this size reservation. * * @generated from field: repeated string partitions = 7; */ partitions: string[]; /** - * Amount of reservations of this size reservation + * Amount of reservations of this size reservation. * * @generated from field: int32 amount = 8; */ @@ -191,42 +191,42 @@ export const SizeReservationSchema: GenMessage = /*@__PURE__*/ */ export type SizeReservationQuery = Message<"metalstack.api.v2.SizeReservationQuery"> & { /** - * ID of the size reservation to get + * ID of the size reservation to get. * * @generated from field: optional string id = 1; */ id?: string | undefined; /** - * Name of this size reservation + * Name of this size reservation. * * @generated from field: optional string name = 2; */ name?: string | undefined; /** - * Description of this size reservation + * Description of this size reservation. * * @generated from field: optional string description = 3; */ description?: string | undefined; /** - * Size id of this size reservation + * Size id of this size reservation. * * @generated from field: optional string size = 4; */ size?: string | undefined; /** - * Project of the size reservation + * Project of the size reservation. * * @generated from field: optional string project = 5; */ project?: string | undefined; /** - * Partition of the size reservation + * Partition of the size reservation. * * @generated from field: optional string partition = 6; */ diff --git a/js/metalstack/api/v2/switch_pb.d.ts b/js/metalstack/api/v2/switch_pb.d.ts index 9798892b..eeac5162 100644 --- a/js/metalstack/api/v2/switch_pb.d.ts +++ b/js/metalstack/api/v2/switch_pb.d.ts @@ -146,25 +146,25 @@ export declare const SwitchOSSchema: GenMessage; */ export type SwitchNic = Message<"metalstack.api.v2.SwitchNic"> & { /** - * Name of the switch port + * Name of the switch port. * * @generated from field: string name = 1; */ name: string; /** - * Identifier of the port + * Identifier of the port. * * @generated from field: string identifier = 2; */ identifier: string; /** - * MAC address of the port + * MAC address of the port. * * @generated from field: string mac = 3; */ mac: string; /** - * VRF name if the port is bound in one + * VRF name if the port is bound in one. * * @generated from field: optional string vrf = 4; */ @@ -200,13 +200,13 @@ export declare const SwitchNicSchema: GenMessage; */ export type BGPFilter = Message<"metalstack.api.v2.BGPFilter"> & { /** - * CIDRs for which to allow BGP + * CIDRs for which to allow BGP. * * @generated from field: repeated string cidrs = 1; */ cidrs: string[]; /** - * VNIs for which to allow BGP + * VNIs for which to allow BGP. * * @generated from field: repeated string vnis = 2; */ diff --git a/js/metalstack/api/v2/switch_pb.ts b/js/metalstack/api/v2/switch_pb.ts index 89811fde..e590d4fa 100644 --- a/js/metalstack/api/v2/switch_pb.ts +++ b/js/metalstack/api/v2/switch_pb.ts @@ -181,28 +181,28 @@ export const SwitchOSSchema: GenMessage = /*@__PURE__*/ */ export type SwitchNic = Message<"metalstack.api.v2.SwitchNic"> & { /** - * Name of the switch port + * Name of the switch port. * * @generated from field: string name = 1; */ name: string; /** - * Identifier of the port + * Identifier of the port. * * @generated from field: string identifier = 2; */ identifier: string; /** - * MAC address of the port + * MAC address of the port. * * @generated from field: string mac = 3; */ mac: string; /** - * VRF name if the port is bound in one + * VRF name if the port is bound in one. * * @generated from field: optional string vrf = 4; */ @@ -244,14 +244,14 @@ export const SwitchNicSchema: GenMessage = /*@__PURE__*/ */ export type BGPFilter = Message<"metalstack.api.v2.BGPFilter"> & { /** - * CIDRs for which to allow BGP + * CIDRs for which to allow BGP. * * @generated from field: repeated string cidrs = 1; */ cidrs: string[]; /** - * VNIs for which to allow BGP + * VNIs for which to allow BGP. * * @generated from field: repeated string vnis = 2; */ diff --git a/js/metalstack/api/v2/tenant_pb.d.ts b/js/metalstack/api/v2/tenant_pb.d.ts index 68ef02c1..75b31aa2 100644 --- a/js/metalstack/api/v2/tenant_pb.d.ts +++ b/js/metalstack/api/v2/tenant_pb.d.ts @@ -13,43 +13,43 @@ export declare const file_metalstack_api_v2_tenant: GenFile; */ export type Tenant = Message<"metalstack.api.v2.Tenant"> & { /** - * Login of the tenant + * Login of the tenant. * * @generated from field: string login = 1; */ login: string; /** - * Meta for this tenant + * Meta for this tenant. * * @generated from field: metalstack.api.v2.Meta meta = 2; */ meta?: Meta | undefined; /** - * Name of the tenant + * Name of the tenant. * * @generated from field: string name = 3; */ name: string; /** - * Email of the tenant + * Email of the tenant. * * @generated from field: string email = 4; */ email: string; /** - * Description of this tenant + * Description of this tenant. * * @generated from field: string description = 5; */ description: string; /** - * AvatarUrl of the tenant + * AvatarUrl of the tenant. * * @generated from field: string avatar_url = 6; */ avatarUrl: string; /** - * CreatedBy stores who created this tenant + * CreatedBy stores who created this tenant. * * @generated from field: string created_by = 7; */ @@ -79,19 +79,19 @@ export type TenantMember = Message<"metalstack.api.v2.TenantMember"> & { */ role: TenantRole; /** - * Projects in which a user is a direct member + * Projects in which a user is a direct member. * * @generated from field: repeated string projects = 3; */ projects: string[]; /** - * CreatedAt the date when the member was added to the tenant + * CreatedAt the date when the member was added to the tenant. * * @generated from field: google.protobuf.Timestamp created_at = 4; */ createdAt?: Timestamp | undefined; /** - * Meta for this tenant member + * Meta for this tenant member. * * @generated from field: metalstack.api.v2.Meta meta = 5; */ @@ -151,13 +151,13 @@ export type TenantInvite = Message<"metalstack.api.v2.TenantInvite"> & { */ tenantName: string; /** - * ExpiresAt the date when this invite expires + * ExpiresAt the date when this invite expires. * * @generated from field: google.protobuf.Timestamp expires_at = 8; */ expiresAt?: Timestamp | undefined; /** - * JoinedAt the date when the member accepted this invite + * JoinedAt the date when the member accepted this invite. * * @generated from field: google.protobuf.Timestamp joined_at = 9; */ @@ -229,7 +229,7 @@ export declare const TenantQuerySchema: GenMessage; */ export type TenantServiceGetRequest = Message<"metalstack.api.v2.TenantServiceGetRequest"> & { /** - * Login of the tenant + * Login of the tenant. * * @generated from field: string login = 1; */ @@ -247,31 +247,31 @@ export declare const TenantServiceGetRequestSchema: GenMessage & { /** - * Name of this tenant + * Name of this tenant. * * @generated from field: string name = 1; */ name: string; /** - * Description of this tenant + * Description of this tenant. * * @generated from field: optional string description = 2; */ description?: string | undefined; /** - * Email of the tenant, if not set will be inherited from the creator + * Email of the tenant, if not set will be inherited from the creator. * * @generated from field: optional string email = 3; */ email?: string | undefined; /** - * AvatarUrl of the tenant + * AvatarUrl of the tenant. * * @generated from field: optional string avatar_url = 4; */ avatarUrl?: string | undefined; /** - * Labels on the tenant + * Labels on the tenant. * * @generated from field: metalstack.api.v2.Labels labels = 5; */ @@ -289,7 +289,7 @@ export declare const TenantServiceCreateRequestSchema: GenMessage & { /** - * Login of the tenant + * Login of the tenant. * * @generated from field: string login = 1; */ @@ -301,31 +301,31 @@ export type TenantServiceUpdateRequest = Message<"metalstack.api.v2.TenantServic */ updateMeta?: UpdateMeta | undefined; /** - * Name of the tenant + * Name of the tenant. * * @generated from field: optional string name = 3; */ name?: string | undefined; /** - * Email of the tenant + * Email of the tenant. * * @generated from field: optional string email = 4; */ email?: string | undefined; /** - * Description of this tenant + * Description of this tenant. * * @generated from field: optional string description = 5; */ description?: string | undefined; /** - * AvatarUrl of the tenant + * AvatarUrl of the tenant. * * @generated from field: optional string avatar_url = 6; */ avatarUrl?: string | undefined; /** - * Labels on the tenant + * Labels on the tenant. * * @generated from field: optional metalstack.api.v2.UpdateLabels labels = 7; */ @@ -343,7 +343,7 @@ export declare const TenantServiceUpdateRequestSchema: GenMessage & { /** - * Login of the tenant + * Login of the tenant. * * @generated from field: string login = 1; */ @@ -367,7 +367,7 @@ export type TenantServiceGetResponse = Message<"metalstack.api.v2.TenantServiceG */ tenant?: Tenant | undefined; /** - * TenantMembers of this tenant + * TenantMembers of this tenant. * * @generated from field: repeated metalstack.api.v2.TenantMember tenant_members = 2; */ @@ -457,13 +457,13 @@ export declare const TenantServiceDeleteResponseSchema: GenMessage & { /** - * Login of the tenant + * Login of the tenant. * * @generated from field: string login = 1; */ login: string; /** - * Role of this user in this tenant + * Role of this user in this tenant. * * @generated from field: metalstack.api.v2.TenantRole role = 2; */ @@ -482,8 +482,6 @@ export declare const TenantServiceInviteRequestSchema: GenMessage & { /** * Invite contains a secret which can be sent to a potential user. - * can be appended to the invitation endpoint at our cloud console like - * console.metalstack.cloud/invite/ * * @generated from field: metalstack.api.v2.TenantInvite invite = 1; */ @@ -501,7 +499,7 @@ export declare const TenantServiceInviteResponseSchema: GenMessage & { /** - * Login of the tenant + * Login of the tenant. * * @generated from field: string login = 1; */ @@ -519,7 +517,7 @@ export declare const TenantServiceInvitesListRequestSchema: GenMessage & { /** - * Invites that have not yet accepted the invitation to this tenant + * Invites that have not yet accepted the invitation to this tenant. * * @generated from field: repeated metalstack.api.v2.TenantInvite invites = 1; */ @@ -537,7 +535,7 @@ export declare const TenantServiceInvitesListResponseSchema: GenMessage & { /** - * Secret of the invite to get + * Secret of the invite to get. * * @generated from field: string secret = 1; */ @@ -573,7 +571,7 @@ export declare const TenantServiceInviteGetResponseSchema: GenMessage & { /** - * Login of the tenant + * Login of the tenant. * * @generated from field: string login = 1; */ @@ -597,7 +595,7 @@ export declare const TenantServiceRemoveMemberRequestSchema: GenMessage & { /** - * Login of the tenant + * Login of the tenant. * * @generated from field: string login = 1; */ @@ -662,13 +660,13 @@ export declare const TenantServiceInviteAcceptRequestSchema: GenMessage & { /** - * Tenant ID of the joined tenant + * Tenant ID of the joined tenant. * * @generated from field: string tenant = 1; */ tenant: string; /** - * TenantName of the joined tenant + * TenantName of the joined tenant. * * @generated from field: string tenant_name = 2; */ @@ -686,13 +684,13 @@ export declare const TenantServiceInviteAcceptResponseSchema: GenMessage & { /** - * Login of the tenant + * Login of the tenant. * * @generated from field: string login = 1; */ login: string; /** - * Secret of the invite to delete + * Secret of the invite to delete. * * @generated from field: string secret = 2; */ @@ -721,19 +719,19 @@ export declare const TenantServiceInviteDeleteResponseSchema: GenMessage & { /** - * Login of the tenant to which the member will be added + * Login of the tenant to which the member will be added. * * @generated from field: string login = 1; */ login: string; /** - * Login of the member to add + * Login of the member to add. * * @generated from field: string member = 2; */ member: string; /** - * Role to assign to the new member + * Role to assign to the new member. * * @generated from field: metalstack.api.v2.TenantRole role = 3; */ @@ -769,7 +767,7 @@ export declare const TenantServiceAddMemberResponseSchema: GenMessage & { /** - * Login of the tenant + * Login of the tenant. * * @generated from field: string login = 1; */ @@ -781,7 +779,7 @@ export type TenantServiceUpdateMemberRequest = Message<"metalstack.api.v2.Tenant */ member: string; /** - * Role of this user in this tenant + * Role of this user in this tenant. * * @generated from field: metalstack.api.v2.TenantRole role = 3; */ @@ -897,7 +895,7 @@ export declare const TenantService: GenService<{ output: typeof TenantServiceRemoveMemberResponseSchema; }; /** - * UpdateMember update a member of a tenant + * UpdateMember update a member of a tenant. * * @generated from rpc metalstack.api.v2.TenantService.UpdateMember */ @@ -947,7 +945,7 @@ export declare const TenantService: GenService<{ output: typeof TenantServiceInvitesListResponseSchema; }; /** - * InviteGet get an invite + * InviteGet get an invite. * * @generated from rpc metalstack.api.v2.TenantService.InviteGet */ diff --git a/js/metalstack/api/v2/tenant_pb.ts b/js/metalstack/api/v2/tenant_pb.ts index 01fe007f..6592cbbe 100644 --- a/js/metalstack/api/v2/tenant_pb.ts +++ b/js/metalstack/api/v2/tenant_pb.ts @@ -25,49 +25,49 @@ export const file_metalstack_api_v2_tenant: GenFile = /*@__PURE__*/ */ export type Tenant = Message<"metalstack.api.v2.Tenant"> & { /** - * Login of the tenant + * Login of the tenant. * * @generated from field: string login = 1; */ login: string; /** - * Meta for this tenant + * Meta for this tenant. * * @generated from field: metalstack.api.v2.Meta meta = 2; */ meta?: Meta | undefined; /** - * Name of the tenant + * Name of the tenant. * * @generated from field: string name = 3; */ name: string; /** - * Email of the tenant + * Email of the tenant. * * @generated from field: string email = 4; */ email: string; /** - * Description of this tenant + * Description of this tenant. * * @generated from field: string description = 5; */ description: string; /** - * AvatarUrl of the tenant + * AvatarUrl of the tenant. * * @generated from field: string avatar_url = 6; */ avatarUrl: string; /** - * CreatedBy stores who created this tenant + * CreatedBy stores who created this tenant. * * @generated from field: string created_by = 7; */ @@ -102,21 +102,21 @@ export type TenantMember = Message<"metalstack.api.v2.TenantMember"> & { role: TenantRole; /** - * Projects in which a user is a direct member + * Projects in which a user is a direct member. * * @generated from field: repeated string projects = 3; */ projects: string[]; /** - * CreatedAt the date when the member was added to the tenant + * CreatedAt the date when the member was added to the tenant. * * @generated from field: google.protobuf.Timestamp created_at = 4; */ createdAt?: Timestamp | undefined; /** - * Meta for this tenant member + * Meta for this tenant member. * * @generated from field: metalstack.api.v2.Meta meta = 5; */ @@ -186,14 +186,14 @@ export type TenantInvite = Message<"metalstack.api.v2.TenantInvite"> & { tenantName: string; /** - * ExpiresAt the date when this invite expires + * ExpiresAt the date when this invite expires. * * @generated from field: google.protobuf.Timestamp expires_at = 8; */ expiresAt?: Timestamp | undefined; /** - * JoinedAt the date when the member accepted this invite + * JoinedAt the date when the member accepted this invite. * * @generated from field: google.protobuf.Timestamp joined_at = 9; */ @@ -277,7 +277,7 @@ export const TenantQuerySchema: GenMessage = /*@__PURE__*/ */ export type TenantServiceGetRequest = Message<"metalstack.api.v2.TenantServiceGetRequest"> & { /** - * Login of the tenant + * Login of the tenant. * * @generated from field: string login = 1; */ @@ -298,35 +298,35 @@ export const TenantServiceGetRequestSchema: GenMessage */ export type TenantServiceCreateRequest = Message<"metalstack.api.v2.TenantServiceCreateRequest"> & { /** - * Name of this tenant + * Name of this tenant. * * @generated from field: string name = 1; */ name: string; /** - * Description of this tenant + * Description of this tenant. * * @generated from field: optional string description = 2; */ description?: string | undefined; /** - * Email of the tenant, if not set will be inherited from the creator + * Email of the tenant, if not set will be inherited from the creator. * * @generated from field: optional string email = 3; */ email?: string | undefined; /** - * AvatarUrl of the tenant + * AvatarUrl of the tenant. * * @generated from field: optional string avatar_url = 4; */ avatarUrl?: string | undefined; /** - * Labels on the tenant + * Labels on the tenant. * * @generated from field: metalstack.api.v2.Labels labels = 5; */ @@ -347,7 +347,7 @@ export const TenantServiceCreateRequestSchema: GenMessage & { /** - * Login of the tenant + * Login of the tenant. * * @generated from field: string login = 1; */ @@ -361,35 +361,35 @@ export type TenantServiceUpdateRequest = Message<"metalstack.api.v2.TenantServic updateMeta?: UpdateMeta | undefined; /** - * Name of the tenant + * Name of the tenant. * * @generated from field: optional string name = 3; */ name?: string | undefined; /** - * Email of the tenant + * Email of the tenant. * * @generated from field: optional string email = 4; */ email?: string | undefined; /** - * Description of this tenant + * Description of this tenant. * * @generated from field: optional string description = 5; */ description?: string | undefined; /** - * AvatarUrl of the tenant + * AvatarUrl of the tenant. * * @generated from field: optional string avatar_url = 6; */ avatarUrl?: string | undefined; /** - * Labels on the tenant + * Labels on the tenant. * * @generated from field: optional metalstack.api.v2.UpdateLabels labels = 7; */ @@ -410,7 +410,7 @@ export const TenantServiceUpdateRequestSchema: GenMessage & { /** - * Login of the tenant + * Login of the tenant. * * @generated from field: string login = 1; */ @@ -438,7 +438,7 @@ export type TenantServiceGetResponse = Message<"metalstack.api.v2.TenantServiceG tenant?: Tenant | undefined; /** - * TenantMembers of this tenant + * TenantMembers of this tenant. * * @generated from field: repeated metalstack.api.v2.TenantMember tenant_members = 2; */ @@ -543,14 +543,14 @@ export const TenantServiceDeleteResponseSchema: GenMessage & { /** - * Login of the tenant + * Login of the tenant. * * @generated from field: string login = 1; */ login: string; /** - * Role of this user in this tenant + * Role of this user in this tenant. * * @generated from field: metalstack.api.v2.TenantRole role = 2; */ @@ -572,8 +572,6 @@ export const TenantServiceInviteRequestSchema: GenMessage & { /** * Invite contains a secret which can be sent to a potential user. - * can be appended to the invitation endpoint at our cloud console like - * console.metalstack.cloud/invite/ * * @generated from field: metalstack.api.v2.TenantInvite invite = 1; */ @@ -594,7 +592,7 @@ export const TenantServiceInviteResponseSchema: GenMessage & { /** - * Login of the tenant + * Login of the tenant. * * @generated from field: string login = 1; */ @@ -615,7 +613,7 @@ export const TenantServiceInvitesListRequestSchema: GenMessage & { /** - * Invites that have not yet accepted the invitation to this tenant + * Invites that have not yet accepted the invitation to this tenant. * * @generated from field: repeated metalstack.api.v2.TenantInvite invites = 1; */ @@ -636,7 +634,7 @@ export const TenantServiceInvitesListResponseSchema: GenMessage & { /** - * Secret of the invite to get + * Secret of the invite to get. * * @generated from field: string secret = 1; */ @@ -678,7 +676,7 @@ export const TenantServiceInviteGetResponseSchema: GenMessage & { /** - * Login of the tenant + * Login of the tenant. * * @generated from field: string login = 1; */ @@ -706,7 +704,7 @@ export const TenantServiceRemoveMemberRequestSchema: GenMessage & { /** - * Login of the tenant + * Login of the tenant. * * @generated from field: string login = 1; */ @@ -784,14 +782,14 @@ export const TenantServiceInviteAcceptRequestSchema: GenMessage & { /** - * Tenant ID of the joined tenant + * Tenant ID of the joined tenant. * * @generated from field: string tenant = 1; */ tenant: string; /** - * TenantName of the joined tenant + * TenantName of the joined tenant. * * @generated from field: string tenant_name = 2; */ @@ -812,14 +810,14 @@ export const TenantServiceInviteAcceptResponseSchema: GenMessage & { /** - * Login of the tenant + * Login of the tenant. * * @generated from field: string login = 1; */ login: string; /** - * Secret of the invite to delete + * Secret of the invite to delete. * * @generated from field: string secret = 2; */ @@ -855,21 +853,21 @@ export const TenantServiceInviteDeleteResponseSchema: GenMessage & { /** - * Login of the tenant to which the member will be added + * Login of the tenant to which the member will be added. * * @generated from field: string login = 1; */ login: string; /** - * Login of the member to add + * Login of the member to add. * * @generated from field: string member = 2; */ member: string; /** - * Role to assign to the new member + * Role to assign to the new member. * * @generated from field: metalstack.api.v2.TenantRole role = 3; */ @@ -911,7 +909,7 @@ export const TenantServiceAddMemberResponseSchema: GenMessage & { /** - * Login of the tenant + * Login of the tenant. * * @generated from field: string login = 1; */ @@ -925,7 +923,7 @@ export type TenantServiceUpdateMemberRequest = Message<"metalstack.api.v2.Tenant member: string; /** - * Role of this user in this tenant + * Role of this user in this tenant. * * @generated from field: metalstack.api.v2.TenantRole role = 3; */ @@ -1047,7 +1045,7 @@ export const TenantService: GenService<{ output: typeof TenantServiceRemoveMemberResponseSchema; }, /** - * UpdateMember update a member of a tenant + * UpdateMember update a member of a tenant. * * @generated from rpc metalstack.api.v2.TenantService.UpdateMember */ @@ -1097,7 +1095,7 @@ export const TenantService: GenService<{ output: typeof TenantServiceInvitesListResponseSchema; }, /** - * InviteGet get an invite + * InviteGet get an invite. * * @generated from rpc metalstack.api.v2.TenantService.InviteGet */ diff --git a/js/metalstack/api/v2/token_pb.d.ts b/js/metalstack/api/v2/token_pb.d.ts index c5d1899f..f6cbbbc6 100644 --- a/js/metalstack/api/v2/token_pb.d.ts +++ b/js/metalstack/api/v2/token_pb.d.ts @@ -20,25 +20,25 @@ export declare const file_metalstack_api_v2_token: GenFile; * The api token should be used to authenticate services. * In contrast to a user token, the api token permissions and roles apply as configured during the token create process. * - * Message level validation, can be developed using https://protovalidate.com/playground + * Message level validation, can be developed using https://protovalidate.com/playground. * * @generated from message metalstack.api.v2.Token */ export type Token = Message<"metalstack.api.v2.Token"> & { /** - * Uuid of the jwt token, used to reference it by revoke + * Uuid of the jwt token, used to reference it by revoke. * * @generated from field: string uuid = 1; */ uuid: string; /** - * User who created this token + * User who created this token. * * @generated from field: string user = 2; */ user: string; /** - * Meta for this token + * Meta for this token. * * @generated from field: metalstack.api.v2.Meta meta = 3; */ @@ -123,7 +123,7 @@ export declare const TokenSchema: GenMessage; */ export type TokenServiceCreateRequest = Message<"metalstack.api.v2.TokenServiceCreateRequest"> & { /** - * Description of the token + * Description of the token. * * @generated from field: string description = 1; */ @@ -177,7 +177,7 @@ export type TokenServiceCreateRequest = Message<"metalstack.api.v2.TokenServiceC [key: string]: MachineRole; }; /** - * Labels on this token + * Labels on this token. * * @generated from field: metalstack.api.v2.Labels labels = 9; */ @@ -195,18 +195,17 @@ export declare const TokenServiceCreateRequestSchema: GenMessage & { /** - * Subject maybe either the project or the tenant - * for which the methods should be allowed + * Subject may be either the project or the tenant for which the methods should be allowed. * - * asterisk (*) can be specified to match any subject - * empty string ("") can be specified for requests that do not require a subject, e.g. partition list - * otherwise either a projectid or a tenant login should be specified + * Asterisk (*) can be specified to match any subject. + * Empty string ("") can be specified for requests that do not require a subject, e.g. partition list. + * Otherwise either a projectid or a tenant login should be specified. * * @generated from field: string subject = 1; */ subject: string; /** - * Methods which should be accessible + * Methods which should be accessible. * * @generated from field: repeated string methods = 2; */ @@ -301,7 +300,7 @@ export declare const PermissionsByVisibilitySchema: GenMessage & { /** - * Methods which should be accessible + * Methods which should be accessible. * * @generated from field: repeated string methods = 2; */ @@ -319,7 +318,7 @@ export declare const PublicPermissionsSchema: GenMessage; */ export type SelfPermissions = Message<"metalstack.api.v2.SelfPermissions"> & { /** - * Methods which should be accessible + * Methods which should be accessible. * * @generated from field: repeated string methods = 2; */ @@ -337,13 +336,14 @@ export declare const SelfPermissionsSchema: GenMessage; */ export type ProjectPermissions = Message<"metalstack.api.v2.ProjectPermissions"> & { /** - * asterisk (*) can be specified to match any subject + * Project scope for the permissions. + * Asterisk (*) can be specified to match any subject. * * @generated from field: string project = 1; */ project: string; /** - * Methods which should be accessible + * Methods which should be accessible. * * @generated from field: repeated string methods = 2; */ @@ -361,14 +361,14 @@ export declare const ProjectPermissionsSchema: GenMessage; */ export type TenantPermissions = Message<"metalstack.api.v2.TenantPermissions"> & { /** - * Login of the tenant - * asterisk (*) can be specified to match any subject + * Login of the tenant. + * Asterisk (*) can be specified to match any subject. * * @generated from field: string login = 1; */ login: string; /** - * Methods which should be accessible + * Methods which should be accessible. * * @generated from field: repeated string methods = 2; */ @@ -386,7 +386,7 @@ export declare const TenantPermissionsSchema: GenMessage; */ export type AdminPermissions = Message<"metalstack.api.v2.AdminPermissions"> & { /** - * Methods which should be accessible + * Methods which should be accessible. * * @generated from field: repeated string methods = 2; */ @@ -404,14 +404,14 @@ export declare const AdminPermissionsSchema: GenMessage; */ export type MachinePermissions = Message<"metalstack.api.v2.MachinePermissions"> & { /** - * UUID of this machine - * asterisk (*) can be specified to match any subject + * UUID of this machine. + * Asterisk (*) can be specified to match any subject. * * @generated from field: string uuid = 1; */ uuid: string; /** - * Methods which should be accessible + * Methods which should be accessible. * * @generated from field: repeated string methods = 2; */ @@ -429,7 +429,7 @@ export declare const MachinePermissionsSchema: GenMessage; */ export type InfraPermissions = Message<"metalstack.api.v2.InfraPermissions"> & { /** - * Methods which should be accessible + * Methods which should be accessible. * * @generated from field: repeated string methods = 2; */ @@ -447,7 +447,7 @@ export declare const InfraPermissionsSchema: GenMessage; */ export type TokenServiceCreateResponse = Message<"metalstack.api.v2.TokenServiceCreateResponse"> & { /** - * Token which was created + * Token which was created. * * @generated from field: metalstack.api.v2.Token token = 1; */ @@ -507,7 +507,7 @@ export declare const TokenServiceListResponseSchema: GenMessage & { /** - * Uuid of the token to revoke + * Uuid of the token to revoke. * * @generated from field: string uuid = 1; */ @@ -536,7 +536,7 @@ export declare const TokenServiceRevokeResponseSchema: GenMessage & { /** - * Uuid of the token to update + * Uuid of the token to update. * * @generated from field: string uuid = 1; */ @@ -597,7 +597,7 @@ export type TokenServiceUpdateRequest = Message<"metalstack.api.v2.TokenServiceU [key: string]: MachineRole; }; /** - * Labels on this token + * Labels on this token. * * @generated from field: metalstack.api.v2.UpdateLabels labels = 10; */ @@ -633,7 +633,7 @@ export declare const TokenServiceUpdateResponseSchema: GenMessage & { /** - * Uuid of the token to get + * Uuid of the token to get. * * @generated from field: string uuid = 1; */ @@ -665,7 +665,7 @@ export declare const TokenServiceGetResponseSchema: GenMessage & { /** - * Token which was refreshed + * Token which was refreshed. * * @generated from field: metalstack.api.v2.Token token = 1; */ @@ -706,20 +706,20 @@ export declare const TokenServiceRefreshResponseSchema: GenMessage & { /** - * UUID of the token to get + * UUID of the token to get. * * @generated from field: optional string uuid = 1; */ uuid?: string | undefined; /** - * Name of the token user to query + * Name of the token user to query. * Only useful for admins. * * @generated from field: optional string user = 2; */ user?: string | undefined; /** - * Description of the token to query + * Description of the token to query. * * @generated from field: optional string description = 3; */ @@ -731,7 +731,7 @@ export type TokenQuery = Message<"metalstack.api.v2.TokenQuery"> & { */ labels?: Labels | undefined; /** - * Token type of the token to query + * Token type of the token to query. * * @generated from field: optional metalstack.api.v2.TokenType token_type = 5; */ diff --git a/js/metalstack/api/v2/token_pb.ts b/js/metalstack/api/v2/token_pb.ts index 5b6043f7..17021392 100644 --- a/js/metalstack/api/v2/token_pb.ts +++ b/js/metalstack/api/v2/token_pb.ts @@ -32,27 +32,27 @@ export const file_metalstack_api_v2_token: GenFile = /*@__PURE__*/ * The api token should be used to authenticate services. * In contrast to a user token, the api token permissions and roles apply as configured during the token create process. * - * Message level validation, can be developed using https://protovalidate.com/playground + * Message level validation, can be developed using https://protovalidate.com/playground. * * @generated from message metalstack.api.v2.Token */ export type Token = Message<"metalstack.api.v2.Token"> & { /** - * Uuid of the jwt token, used to reference it by revoke + * Uuid of the jwt token, used to reference it by revoke. * * @generated from field: string uuid = 1; */ uuid: string; /** - * User who created this token + * User who created this token. * * @generated from field: string user = 2; */ user: string; /** - * Meta for this token + * Meta for this token. * * @generated from field: metalstack.api.v2.Meta meta = 3; */ @@ -144,7 +144,7 @@ export const TokenSchema: GenMessage = /*@__PURE__*/ */ export type TokenServiceCreateRequest = Message<"metalstack.api.v2.TokenServiceCreateRequest"> & { /** - * Description of the token + * Description of the token. * * @generated from field: string description = 1; */ @@ -200,7 +200,7 @@ export type TokenServiceCreateRequest = Message<"metalstack.api.v2.TokenServiceC machineRoles: { [key: string]: MachineRole }; /** - * Labels on this token + * Labels on this token. * * @generated from field: metalstack.api.v2.Labels labels = 9; */ @@ -221,19 +221,18 @@ export const TokenServiceCreateRequestSchema: GenMessage & { /** - * Subject maybe either the project or the tenant - * for which the methods should be allowed + * Subject may be either the project or the tenant for which the methods should be allowed. * - * asterisk (*) can be specified to match any subject - * empty string ("") can be specified for requests that do not require a subject, e.g. partition list - * otherwise either a projectid or a tenant login should be specified + * Asterisk (*) can be specified to match any subject. + * Empty string ("") can be specified for requests that do not require a subject, e.g. partition list. + * Otherwise either a projectid or a tenant login should be specified. * * @generated from field: string subject = 1; */ subject: string; /** - * Methods which should be accessible + * Methods which should be accessible. * * @generated from field: repeated string methods = 2; */ @@ -331,7 +330,7 @@ export const PermissionsByVisibilitySchema: GenMessage */ export type PublicPermissions = Message<"metalstack.api.v2.PublicPermissions"> & { /** - * Methods which should be accessible + * Methods which should be accessible. * * @generated from field: repeated string methods = 2; */ @@ -352,7 +351,7 @@ export const PublicPermissionsSchema: GenMessage = /*@__PURE_ */ export type SelfPermissions = Message<"metalstack.api.v2.SelfPermissions"> & { /** - * Methods which should be accessible + * Methods which should be accessible. * * @generated from field: repeated string methods = 2; */ @@ -373,14 +372,15 @@ export const SelfPermissionsSchema: GenMessage = /*@__PURE__*/ */ export type ProjectPermissions = Message<"metalstack.api.v2.ProjectPermissions"> & { /** - * asterisk (*) can be specified to match any subject + * Project scope for the permissions. + * Asterisk (*) can be specified to match any subject. * * @generated from field: string project = 1; */ project: string; /** - * Methods which should be accessible + * Methods which should be accessible. * * @generated from field: repeated string methods = 2; */ @@ -401,15 +401,15 @@ export const ProjectPermissionsSchema: GenMessage = /*@__PUR */ export type TenantPermissions = Message<"metalstack.api.v2.TenantPermissions"> & { /** - * Login of the tenant - * asterisk (*) can be specified to match any subject + * Login of the tenant. + * Asterisk (*) can be specified to match any subject. * * @generated from field: string login = 1; */ login: string; /** - * Methods which should be accessible + * Methods which should be accessible. * * @generated from field: repeated string methods = 2; */ @@ -430,7 +430,7 @@ export const TenantPermissionsSchema: GenMessage = /*@__PURE_ */ export type AdminPermissions = Message<"metalstack.api.v2.AdminPermissions"> & { /** - * Methods which should be accessible + * Methods which should be accessible. * * @generated from field: repeated string methods = 2; */ @@ -451,15 +451,15 @@ export const AdminPermissionsSchema: GenMessage = /*@__PURE__* */ export type MachinePermissions = Message<"metalstack.api.v2.MachinePermissions"> & { /** - * UUID of this machine - * asterisk (*) can be specified to match any subject + * UUID of this machine. + * Asterisk (*) can be specified to match any subject. * * @generated from field: string uuid = 1; */ uuid: string; /** - * Methods which should be accessible + * Methods which should be accessible. * * @generated from field: repeated string methods = 2; */ @@ -480,7 +480,7 @@ export const MachinePermissionsSchema: GenMessage = /*@__PUR */ export type InfraPermissions = Message<"metalstack.api.v2.InfraPermissions"> & { /** - * Methods which should be accessible + * Methods which should be accessible. * * @generated from field: repeated string methods = 2; */ @@ -501,7 +501,7 @@ export const InfraPermissionsSchema: GenMessage = /*@__PURE__* */ export type TokenServiceCreateResponse = Message<"metalstack.api.v2.TokenServiceCreateResponse"> & { /** - * Token which was created + * Token which was created. * * @generated from field: metalstack.api.v2.Token token = 1; */ @@ -571,7 +571,7 @@ export const TokenServiceListResponseSchema: GenMessage & { /** - * Uuid of the token to revoke + * Uuid of the token to revoke. * * @generated from field: string uuid = 1; */ @@ -607,7 +607,7 @@ export const TokenServiceRevokeResponseSchema: GenMessage & { /** - * Uuid of the token to update + * Uuid of the token to update. * * @generated from field: string uuid = 1; */ @@ -671,7 +671,7 @@ export type TokenServiceUpdateRequest = Message<"metalstack.api.v2.TokenServiceU machineRoles: { [key: string]: MachineRole }; /** - * Labels on this token + * Labels on this token. * * @generated from field: metalstack.api.v2.UpdateLabels labels = 10; */ @@ -713,7 +713,7 @@ export const TokenServiceUpdateResponseSchema: GenMessage & { /** - * Uuid of the token to get + * Uuid of the token to get. * * @generated from field: string uuid = 1; */ @@ -751,7 +751,7 @@ export const TokenServiceGetResponseSchema: GenMessage /** * TokenServiceRefreshRequest is the request payload of a token refresh request. * Permissions, Roles and Expiration duration and all other properties are inherited from the calling token. - * The expiration duration will be calculated from the existing token (exp - iat) + * The expiration duration will be calculated from the existing token (exp - iat). * * @generated from message metalstack.api.v2.TokenServiceRefreshRequest */ @@ -772,7 +772,7 @@ export const TokenServiceRefreshRequestSchema: GenMessage & { /** - * Token which was refreshed + * Token which was refreshed. * * @generated from field: metalstack.api.v2.Token token = 1; */ @@ -800,14 +800,14 @@ export const TokenServiceRefreshResponseSchema: GenMessage & { /** - * UUID of the token to get + * UUID of the token to get. * * @generated from field: optional string uuid = 1; */ uuid?: string | undefined; /** - * Name of the token user to query + * Name of the token user to query. * Only useful for admins. * * @generated from field: optional string user = 2; @@ -815,7 +815,7 @@ export type TokenQuery = Message<"metalstack.api.v2.TokenQuery"> & { user?: string | undefined; /** - * Description of the token to query + * Description of the token to query. * * @generated from field: optional string description = 3; */ @@ -829,7 +829,7 @@ export type TokenQuery = Message<"metalstack.api.v2.TokenQuery"> & { labels?: Labels | undefined; /** - * Token type of the token to query + * Token type of the token to query. * * @generated from field: optional metalstack.api.v2.TokenType token_type = 5; */ diff --git a/js/metalstack/api/v2/user_pb.d.ts b/js/metalstack/api/v2/user_pb.d.ts index 0873ef3a..4250744d 100644 --- a/js/metalstack/api/v2/user_pb.d.ts +++ b/js/metalstack/api/v2/user_pb.d.ts @@ -19,37 +19,37 @@ export type User = Message<"metalstack.api.v2.User"> & { */ login: string; /** - * Name of the user + * Name of the user. * * @generated from field: string name = 2; */ name: string; /** - * Email of the user + * Email of the user. * * @generated from field: string email = 3; */ email: string; /** - * AvatarUrl of the user + * AvatarUrl of the user. * * @generated from field: string avatar_url = 4; */ avatarUrl: string; /** - * Tenants the user belongs to + * Tenants the user belongs to. * * @generated from field: repeated metalstack.api.v2.Tenant tenants = 5; */ tenants: Tenant[]; /** - * Projects the user belongs to + * Projects the user belongs to. * * @generated from field: repeated metalstack.api.v2.Project projects = 6; */ projects: Project[]; /** - * DefaultTenant the default tenant that this user belongs to + * DefaultTenant the default tenant that this user belongs to. * * @generated from field: metalstack.api.v2.Tenant default_tenant = 7; */ diff --git a/js/metalstack/api/v2/user_pb.ts b/js/metalstack/api/v2/user_pb.ts index 7e3f262b..f814a3e2 100644 --- a/js/metalstack/api/v2/user_pb.ts +++ b/js/metalstack/api/v2/user_pb.ts @@ -33,42 +33,42 @@ export type User = Message<"metalstack.api.v2.User"> & { login: string; /** - * Name of the user + * Name of the user. * * @generated from field: string name = 2; */ name: string; /** - * Email of the user + * Email of the user. * * @generated from field: string email = 3; */ email: string; /** - * AvatarUrl of the user + * AvatarUrl of the user. * * @generated from field: string avatar_url = 4; */ avatarUrl: string; /** - * Tenants the user belongs to + * Tenants the user belongs to. * * @generated from field: repeated metalstack.api.v2.Tenant tenants = 5; */ tenants: Tenant[]; /** - * Projects the user belongs to + * Projects the user belongs to. * * @generated from field: repeated metalstack.api.v2.Project projects = 6; */ projects: Project[]; /** - * DefaultTenant the default tenant that this user belongs to + * DefaultTenant the default tenant that this user belongs to. * * @generated from field: metalstack.api.v2.Tenant default_tenant = 7; */ diff --git a/js/metalstack/api/v2/version_pb.d.ts b/js/metalstack/api/v2/version_pb.d.ts index d2d3a60a..d3f4a6fe 100644 --- a/js/metalstack/api/v2/version_pb.d.ts +++ b/js/metalstack/api/v2/version_pb.d.ts @@ -11,25 +11,25 @@ export declare const file_metalstack_api_v2_version: GenFile; */ export type Version = Message<"metalstack.api.v2.Version"> & { /** - * Version of the application + * Version of the application. * * @generated from field: string version = 1; */ version: string; /** - * Revision of the application + * Revision of the application. * * @generated from field: string revision = 2; */ revision: string; /** - * GitSHA1 of the application + * GitSHA1 of the application. * * @generated from field: string git_sha1 = 3; */ gitSha1: string; /** - * BuildDate of the application + * BuildDate of the application. * * @generated from field: string build_date = 4; */ diff --git a/js/metalstack/api/v2/version_pb.ts b/js/metalstack/api/v2/version_pb.ts index 84102c78..9a3b3b56 100644 --- a/js/metalstack/api/v2/version_pb.ts +++ b/js/metalstack/api/v2/version_pb.ts @@ -22,28 +22,28 @@ export const file_metalstack_api_v2_version: GenFile = /*@__PURE__*/ */ export type Version = Message<"metalstack.api.v2.Version"> & { /** - * Version of the application + * Version of the application. * * @generated from field: string version = 1; */ version: string; /** - * Revision of the application + * Revision of the application. * * @generated from field: string revision = 2; */ revision: string; /** - * GitSHA1 of the application + * GitSHA1 of the application. * * @generated from field: string git_sha1 = 3; */ gitSha1: string; /** - * BuildDate of the application + * BuildDate of the application. * * @generated from field: string build_date = 4; */ diff --git a/js/metalstack/api/v2/vpn_pb.d.ts b/js/metalstack/api/v2/vpn_pb.d.ts index 7687adc6..84feddde 100644 --- a/js/metalstack/api/v2/vpn_pb.d.ts +++ b/js/metalstack/api/v2/vpn_pb.d.ts @@ -12,31 +12,31 @@ export declare const file_metalstack_api_v2_vpn: GenFile; */ export type VPNNode = Message<"metalstack.api.v2.VPNNode"> & { /** - * ID of this node + * ID of this node. * * @generated from field: uint64 id = 1; */ id: bigint; /** - * Name of this node + * Name of this node. * * @generated from field: string name = 2; */ name: string; /** - * Project of this node, maps to a project + * Project of this node, maps to a project. * * @generated from field: string project = 3; */ project: string; /** - * IPAddresses of this node in the VPN + * IPAddresses of this node in the VPN. * * @generated from field: repeated string ip_addresses = 4; */ ipAddresses: string[]; /** - * LastSeen timestamp when this node reached out to the control plane + * LastSeen timestamp when this node reached out to the control plane. * * @generated from field: google.protobuf.Timestamp last_seen = 5; */ diff --git a/js/metalstack/api/v2/vpn_pb.ts b/js/metalstack/api/v2/vpn_pb.ts index ad35be4b..06821e43 100644 --- a/js/metalstack/api/v2/vpn_pb.ts +++ b/js/metalstack/api/v2/vpn_pb.ts @@ -23,35 +23,35 @@ export const file_metalstack_api_v2_vpn: GenFile = /*@__PURE__*/ */ export type VPNNode = Message<"metalstack.api.v2.VPNNode"> & { /** - * ID of this node + * ID of this node. * * @generated from field: uint64 id = 1; */ id: bigint; /** - * Name of this node + * Name of this node. * * @generated from field: string name = 2; */ name: string; /** - * Project of this node, maps to a project + * Project of this node, maps to a project. * * @generated from field: string project = 3; */ project: string; /** - * IPAddresses of this node in the VPN + * IPAddresses of this node in the VPN. * * @generated from field: repeated string ip_addresses = 4; */ ipAddresses: string[]; /** - * LastSeen timestamp when this node reached out to the control plane + * LastSeen timestamp when this node reached out to the control plane. * * @generated from field: google.protobuf.Timestamp last_seen = 5; */ diff --git a/js/metalstack/infra/v2/bmc_pb.d.ts b/js/metalstack/infra/v2/bmc_pb.d.ts index 94f4d543..858cf267 100644 --- a/js/metalstack/infra/v2/bmc_pb.d.ts +++ b/js/metalstack/infra/v2/bmc_pb.d.ts @@ -80,13 +80,13 @@ export declare const WaitForBMCCommandRequestSchema: GenMessage & { /** - * UUID of the machine to send the command to + * UUID of the machine to send the command to. * * @generated from field: string uuid = 1; */ uuid: string; /** - * BmcCommand to execute against the BMC of the machine + * BmcCommand to execute against the BMC of the machine. * * @generated from field: metalstack.api.v2.MachineBMCCommand bmc_command = 2; */ @@ -124,7 +124,7 @@ export type BMCCommandDoneRequest = Message<"metalstack.infra.v2.BMCCommandDoneR */ commandId: string; /** - * Error of the command execution, nil if it was successful + * Error of the command execution, nil if it was successful. * * @generated from field: optional string error = 2; */ diff --git a/js/metalstack/infra/v2/bmc_pb.ts b/js/metalstack/infra/v2/bmc_pb.ts index afc16acd..c64b51b8 100644 --- a/js/metalstack/infra/v2/bmc_pb.ts +++ b/js/metalstack/infra/v2/bmc_pb.ts @@ -101,14 +101,14 @@ export const WaitForBMCCommandRequestSchema: GenMessage & { /** - * UUID of the machine to send the command to + * UUID of the machine to send the command to. * * @generated from field: string uuid = 1; */ uuid: string; /** - * BmcCommand to execute against the BMC of the machine + * BmcCommand to execute against the BMC of the machine. * * @generated from field: metalstack.api.v2.MachineBMCCommand bmc_command = 2; */ @@ -152,7 +152,7 @@ export type BMCCommandDoneRequest = Message<"metalstack.infra.v2.BMCCommandDoneR commandId: string; /** - * Error of the command execution, nil if it was successful + * Error of the command execution, nil if it was successful. * * @generated from field: optional string error = 2; */ diff --git a/js/metalstack/infra/v2/boot_pb.d.ts b/js/metalstack/infra/v2/boot_pb.d.ts index 1f1af233..88747f85 100644 --- a/js/metalstack/infra/v2/boot_pb.d.ts +++ b/js/metalstack/infra/v2/boot_pb.d.ts @@ -12,7 +12,7 @@ export declare const file_metalstack_infra_v2_boot: GenFile; */ export type BootServiceDhcpRequest = Message<"metalstack.infra.v2.BootServiceDhcpRequest"> & { /** - * UUID of the machine + * UUID of the machine. * * @generated from field: string uuid = 1; */ @@ -47,7 +47,7 @@ export declare const BootServiceDhcpResponseSchema: GenMessage & { /** - * Mac address of the machine + * Mac address of the machine. * * @generated from field: string mac = 1; */ @@ -101,37 +101,37 @@ export declare const BootServiceBootResponseSchema: GenMessage & { /** - * UUID of this machine + * UUID of this machine. * * @generated from field: string uuid = 1; */ uuid: string; /** - * Hardware details of this machine + * Hardware details of this machine. * * @generated from field: metalstack.api.v2.MachineHardware hardware = 2; */ hardware?: MachineHardware | undefined; /** - * Bios details of this machine + * Bios details of this machine. * * @generated from field: metalstack.api.v2.MachineBios bios = 3; */ bios?: MachineBios | undefined; /** - * BMC details of this machine + * BMC details of this machine. * * @generated from field: metalstack.api.v2.MachineBMC bmc = 4; */ bmc?: MachineBMC | undefined; /** - * FRU details of this machine + * FRU details of this machine. * * @generated from field: metalstack.api.v2.MachineFRU fru = 5; */ fru?: MachineFRU | undefined; /** - * Tags of this machine + * Tags of this machine. * * @generated from field: repeated string tags = 6; */ @@ -155,13 +155,13 @@ export type BootServiceRegisterRequest = Message<"metalstack.infra.v2.BootServic */ export declare const BootServiceRegisterRequestSchema: GenMessage; /** - * BootServiceRegisterResponse response to a BootServiceRegisterResponse request + * BootServiceRegisterResponse response to a BootServiceRegisterResponse request. * * @generated from message metalstack.infra.v2.BootServiceRegisterResponse */ export type BootServiceRegisterResponse = Message<"metalstack.infra.v2.BootServiceRegisterResponse"> & { /** - * UUID of this machine + * UUID of this machine. * * @generated from field: string uuid = 1; */ @@ -173,7 +173,7 @@ export type BootServiceRegisterResponse = Message<"metalstack.infra.v2.BootServi */ size: string; /** - * Partition of this machine + * Partition of this machine. * * @generated from field: string partition = 3; */ @@ -191,7 +191,7 @@ export declare const BootServiceRegisterResponseSchema: GenMessage & { /** - * UUID of this machine + * UUID of this machine. * * @generated from field: string uuid = 1; */ @@ -203,7 +203,7 @@ export type BootServiceWaitRequest = Message<"metalstack.infra.v2.BootServiceWai */ export declare const BootServiceWaitRequestSchema: GenMessage; /** - * BootServiceWaitResponse response to a wait request + * BootServiceWaitResponse response to a wait request. * * @generated from message metalstack.infra.v2.BootServiceWaitResponse */ @@ -227,13 +227,13 @@ export declare const BootServiceWaitResponseSchema: GenMessage & { /** - * UUID of the machine to boot + * UUID of the machine to boot. * * @generated from field: string uuid = 1; */ uuid: string; /** - * ConsolePassword + * ConsolePassword. * * @generated from field: string console_password = 2; */ @@ -256,13 +256,13 @@ export type BootServiceInstallationSucceededResponse = Message<"metalstack.infra */ export declare const BootServiceInstallationSucceededResponseSchema: GenMessage; /** - * BootServiceSuperUserPasswordRequest this call returns the password for the machine superuser + * BootServiceSuperUserPasswordRequest this call returns the password for the machine superuser. * * @generated from message metalstack.infra.v2.BootServiceSuperUserPasswordRequest */ export type BootServiceSuperUserPasswordRequest = Message<"metalstack.infra.v2.BootServiceSuperUserPasswordRequest"> & { /** - * UUID of this machine + * UUID of this machine. * * @generated from field: string uuid = 1; */ @@ -274,7 +274,7 @@ export type BootServiceSuperUserPasswordRequest = Message<"metalstack.infra.v2.B */ export declare const BootServiceSuperUserPasswordRequestSchema: GenMessage; /** - * BootServiceSuperUserPasswordResponse the super user password is returned + * BootServiceSuperUserPasswordResponse the super user password is returned. * * @generated from message metalstack.infra.v2.BootServiceSuperUserPasswordResponse */ diff --git a/js/metalstack/infra/v2/boot_pb.ts b/js/metalstack/infra/v2/boot_pb.ts index 21b7bf77..4dde9f4e 100644 --- a/js/metalstack/infra/v2/boot_pb.ts +++ b/js/metalstack/infra/v2/boot_pb.ts @@ -24,7 +24,7 @@ export const file_metalstack_infra_v2_boot: GenFile = /*@__PURE__*/ */ export type BootServiceDhcpRequest = Message<"metalstack.infra.v2.BootServiceDhcpRequest"> & { /** - * UUID of the machine + * UUID of the machine. * * @generated from field: string uuid = 1; */ @@ -67,7 +67,7 @@ export const BootServiceDhcpResponseSchema: GenMessage */ export type BootServiceBootRequest = Message<"metalstack.infra.v2.BootServiceBootRequest"> & { /** - * Mac address of the machine + * Mac address of the machine. * * @generated from field: string mac = 1; */ @@ -130,42 +130,42 @@ export const BootServiceBootResponseSchema: GenMessage */ export type BootServiceRegisterRequest = Message<"metalstack.infra.v2.BootServiceRegisterRequest"> & { /** - * UUID of this machine + * UUID of this machine. * * @generated from field: string uuid = 1; */ uuid: string; /** - * Hardware details of this machine + * Hardware details of this machine. * * @generated from field: metalstack.api.v2.MachineHardware hardware = 2; */ hardware?: MachineHardware | undefined; /** - * Bios details of this machine + * Bios details of this machine. * * @generated from field: metalstack.api.v2.MachineBios bios = 3; */ bios?: MachineBios | undefined; /** - * BMC details of this machine + * BMC details of this machine. * * @generated from field: metalstack.api.v2.MachineBMC bmc = 4; */ bmc?: MachineBMC | undefined; /** - * FRU details of this machine + * FRU details of this machine. * * @generated from field: metalstack.api.v2.MachineFRU fru = 5; */ fru?: MachineFRU | undefined; /** - * Tags of this machine + * Tags of this machine. * * @generated from field: repeated string tags = 6; */ @@ -194,13 +194,13 @@ export const BootServiceRegisterRequestSchema: GenMessage & { /** - * UUID of this machine + * UUID of this machine. * * @generated from field: string uuid = 1; */ @@ -214,7 +214,7 @@ export type BootServiceRegisterResponse = Message<"metalstack.infra.v2.BootServi size: string; /** - * Partition of this machine + * Partition of this machine. * * @generated from field: string partition = 3; */ @@ -235,7 +235,7 @@ export const BootServiceRegisterResponseSchema: GenMessage & { /** - * UUID of this machine + * UUID of this machine. * * @generated from field: string uuid = 1; */ @@ -250,7 +250,7 @@ export const BootServiceWaitRequestSchema: GenMessage = messageDesc(file_metalstack_infra_v2_boot, 6); /** - * BootServiceWaitResponse response to a wait request + * BootServiceWaitResponse response to a wait request. * * @generated from message metalstack.infra.v2.BootServiceWaitResponse */ @@ -277,14 +277,14 @@ export const BootServiceWaitResponseSchema: GenMessage */ export type BootServiceInstallationSucceededRequest = Message<"metalstack.infra.v2.BootServiceInstallationSucceededRequest"> & { /** - * UUID of the machine to boot + * UUID of the machine to boot. * * @generated from field: string uuid = 1; */ uuid: string; /** - * ConsolePassword + * ConsolePassword. * * @generated from field: string console_password = 2; */ @@ -314,13 +314,13 @@ export const BootServiceInstallationSucceededResponseSchema: GenMessage & { /** - * UUID of this machine + * UUID of this machine. * * @generated from field: string uuid = 1; */ @@ -335,7 +335,7 @@ export const BootServiceSuperUserPasswordRequestSchema: GenMessage & { /** - * Events grouped by machine IDs + * Events grouped by machine IDs. * * @generated from field: map events = 1; */ @@ -32,7 +32,7 @@ export declare const EventServiceSendRequestSchema: GenMessage & { /** - * Events counts the number of events successfully stored in the database + * Events counts the number of events successfully stored in the database. * * @generated from field: uint64 events = 1; */ diff --git a/js/metalstack/infra/v2/event_pb.ts b/js/metalstack/infra/v2/event_pb.ts index a3fe8436..6d8e92e8 100644 --- a/js/metalstack/infra/v2/event_pb.ts +++ b/js/metalstack/infra/v2/event_pb.ts @@ -22,7 +22,7 @@ export const file_metalstack_infra_v2_event: GenFile = /*@__PURE__*/ */ export type EventServiceSendRequest = Message<"metalstack.infra.v2.EventServiceSendRequest"> & { /** - * Events grouped by machine IDs + * Events grouped by machine IDs. * * @generated from field: map events = 1; */ @@ -43,7 +43,7 @@ export const EventServiceSendRequestSchema: GenMessage */ export type EventServiceSendResponse = Message<"metalstack.infra.v2.EventServiceSendResponse"> & { /** - * Events counts the number of events successfully stored in the database + * Events counts the number of events successfully stored in the database. * * @generated from field: uint64 events = 1; */ diff --git a/js/metalstack/infra/v2/switch_pb.d.ts b/js/metalstack/infra/v2/switch_pb.d.ts index c93f0a72..d018fccc 100644 --- a/js/metalstack/infra/v2/switch_pb.d.ts +++ b/js/metalstack/infra/v2/switch_pb.d.ts @@ -13,7 +13,7 @@ export declare const file_metalstack_infra_v2_switch: GenFile; */ export type SwitchServiceGetRequest = Message<"metalstack.infra.v2.SwitchServiceGetRequest"> & { /** - * Id of the switch + * Id of the switch. * * @generated from field: string id = 1; */ @@ -49,7 +49,7 @@ export declare const SwitchServiceGetResponseSchema: GenMessage & { /** - * Switch to register + * Switch to register. * * @generated from field: metalstack.api.v2.Switch switch = 1; */ @@ -85,19 +85,19 @@ export declare const SwitchServiceRegisterResponseSchema: GenMessage & { /** - * Id of the switch + * Id of the switch. * * @generated from field: string id = 1; */ id: string; /** - * Duration of the sync + * Duration of the sync. * * @generated from field: google.protobuf.Duration duration = 2; */ duration?: Duration | undefined; /** - * Error if any occurred during the sync + * Error if any occurred during the sync. * * @generated from field: optional string error = 3; */ @@ -131,7 +131,7 @@ export declare const SwitchServiceHeartbeatRequestSchema: GenMessage & { /** - * Id of the switch + * Id of the switch. * * @generated from field: string id = 1; */ diff --git a/js/metalstack/infra/v2/switch_pb.ts b/js/metalstack/infra/v2/switch_pb.ts index 7425ef70..66974525 100644 --- a/js/metalstack/infra/v2/switch_pb.ts +++ b/js/metalstack/infra/v2/switch_pb.ts @@ -26,7 +26,7 @@ export const file_metalstack_infra_v2_switch: GenFile = /*@__PURE__*/ */ export type SwitchServiceGetRequest = Message<"metalstack.infra.v2.SwitchServiceGetRequest"> & { /** - * Id of the switch + * Id of the switch. * * @generated from field: string id = 1; */ @@ -68,7 +68,7 @@ export const SwitchServiceGetResponseSchema: GenMessage & { /** - * Switch to register + * Switch to register. * * @generated from field: metalstack.api.v2.Switch switch = 1; */ @@ -110,21 +110,21 @@ export const SwitchServiceRegisterResponseSchema: GenMessage & { /** - * Id of the switch + * Id of the switch. * * @generated from field: string id = 1; */ id: string; /** - * Duration of the sync + * Duration of the sync. * * @generated from field: google.protobuf.Duration duration = 2; */ duration?: Duration | undefined; /** - * Error if any occurred during the sync + * Error if any occurred during the sync. * * @generated from field: optional string error = 3; */ @@ -159,7 +159,7 @@ export const SwitchServiceHeartbeatRequestSchema: GenMessage & { /** - * Id of the switch + * Id of the switch. * * @generated from field: string id = 1; */
interval google.protobuf.Duration

Interval at which the ping is scheduled, must be between 5 seconds and 1 hour

Interval at which the ping is scheduled, must be between 5 seconds and 1 hour.

version metalstack.api.v2.Version

Version of this service

Version of this service.

EventServiceSendRequest.EventsEntry repeated

Events grouped by machine IDs

Events grouped by machine IDs.

uint64

Events counts the number of events successfully stored in the database

Events counts the number of events successfully stored in the database.

string

Id of the switch

Id of the switch.

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.

id string

Id of the switch

Id of the switch.

switch metalstack.api.v2.Switch

Switch to register

Switch to register.