@metal-stack/api 0.0.58 → 0.0.60

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (123) hide show
  1. package/js/metalstack/admin/v2/audit_pb.d.ts +8 -8
  2. package/js/metalstack/admin/v2/audit_pb.js +1 -1
  3. package/js/metalstack/admin/v2/audit_pb.ts +8 -8
  4. package/js/metalstack/admin/v2/component_pb.d.ts +14 -14
  5. package/js/metalstack/admin/v2/component_pb.js +1 -1
  6. package/js/metalstack/admin/v2/component_pb.ts +14 -14
  7. package/js/metalstack/admin/v2/filesystem_pb.d.ts +15 -15
  8. package/js/metalstack/admin/v2/filesystem_pb.js +1 -1
  9. package/js/metalstack/admin/v2/filesystem_pb.ts +15 -15
  10. package/js/metalstack/admin/v2/image_pb.d.ts +20 -20
  11. package/js/metalstack/admin/v2/image_pb.js +1 -1
  12. package/js/metalstack/admin/v2/image_pb.ts +20 -20
  13. package/js/metalstack/admin/v2/ip_pb.d.ts +6 -6
  14. package/js/metalstack/admin/v2/ip_pb.js +1 -1
  15. package/js/metalstack/admin/v2/ip_pb.ts +6 -6
  16. package/js/metalstack/admin/v2/machine_pb.d.ts +10 -10
  17. package/js/metalstack/admin/v2/machine_pb.js +1 -1
  18. package/js/metalstack/admin/v2/machine_pb.ts +10 -10
  19. package/js/metalstack/admin/v2/network_pb.d.ts +30 -30
  20. package/js/metalstack/admin/v2/network_pb.js +2 -2
  21. package/js/metalstack/admin/v2/network_pb.ts +31 -31
  22. package/js/metalstack/admin/v2/partition_pb.d.ts +10 -11
  23. package/js/metalstack/admin/v2/partition_pb.js +2 -2
  24. package/js/metalstack/admin/v2/partition_pb.ts +11 -12
  25. package/js/metalstack/admin/v2/project_pb.d.ts +7 -7
  26. package/js/metalstack/admin/v2/project_pb.js +1 -1
  27. package/js/metalstack/admin/v2/project_pb.ts +7 -7
  28. package/js/metalstack/admin/v2/size_imageconstraint_pb.d.ts +21 -21
  29. package/js/metalstack/admin/v2/size_imageconstraint_pb.js +1 -1
  30. package/js/metalstack/admin/v2/size_imageconstraint_pb.ts +21 -21
  31. package/js/metalstack/admin/v2/size_pb.d.ts +13 -13
  32. package/js/metalstack/admin/v2/size_pb.js +1 -1
  33. package/js/metalstack/admin/v2/size_pb.ts +13 -13
  34. package/js/metalstack/admin/v2/size_reservation_pb.d.ts +17 -17
  35. package/js/metalstack/admin/v2/size_reservation_pb.js +1 -1
  36. package/js/metalstack/admin/v2/size_reservation_pb.ts +17 -17
  37. package/js/metalstack/admin/v2/switch_pb.d.ts +51 -51
  38. package/js/metalstack/admin/v2/switch_pb.js +1 -1
  39. package/js/metalstack/admin/v2/switch_pb.ts +51 -51
  40. package/js/metalstack/admin/v2/task_pb.d.ts +58 -58
  41. package/js/metalstack/admin/v2/task_pb.js +10 -10
  42. package/js/metalstack/admin/v2/task_pb.ts +58 -58
  43. package/js/metalstack/admin/v2/tenant_pb.d.ts +15 -15
  44. package/js/metalstack/admin/v2/tenant_pb.js +2 -2
  45. package/js/metalstack/admin/v2/tenant_pb.ts +16 -16
  46. package/js/metalstack/admin/v2/token_pb.d.ts +13 -13
  47. package/js/metalstack/admin/v2/token_pb.js +1 -1
  48. package/js/metalstack/admin/v2/token_pb.ts +13 -13
  49. package/js/metalstack/admin/v2/vpn_pb.d.ts +20 -20
  50. package/js/metalstack/admin/v2/vpn_pb.js +1 -1
  51. package/js/metalstack/admin/v2/vpn_pb.ts +20 -20
  52. package/js/metalstack/api/v2/audit_pb.d.ts +14 -14
  53. package/js/metalstack/api/v2/audit_pb.js +3 -3
  54. package/js/metalstack/api/v2/audit_pb.ts +14 -14
  55. package/js/metalstack/api/v2/filesystem_pb.d.ts +4 -4
  56. package/js/metalstack/api/v2/filesystem_pb.js +1 -1
  57. package/js/metalstack/api/v2/filesystem_pb.ts +4 -4
  58. package/js/metalstack/api/v2/health_pb.d.ts +20 -20
  59. package/js/metalstack/api/v2/health_pb.js +9 -9
  60. package/js/metalstack/api/v2/health_pb.ts +20 -20
  61. package/js/metalstack/api/v2/image_pb.d.ts +10 -4
  62. package/js/metalstack/api/v2/image_pb.js +2 -2
  63. package/js/metalstack/api/v2/image_pb.ts +12 -5
  64. package/js/metalstack/api/v2/ip_pb.d.ts +6 -6
  65. package/js/metalstack/api/v2/ip_pb.js +1 -1
  66. package/js/metalstack/api/v2/ip_pb.ts +6 -6
  67. package/js/metalstack/api/v2/machine_pb.d.ts +18 -18
  68. package/js/metalstack/api/v2/machine_pb.js +2 -2
  69. package/js/metalstack/api/v2/machine_pb.ts +19 -19
  70. package/js/metalstack/api/v2/method_pb.d.ts +16 -16
  71. package/js/metalstack/api/v2/method_pb.js +3 -3
  72. package/js/metalstack/api/v2/method_pb.ts +17 -17
  73. package/js/metalstack/api/v2/network_pb.d.ts +7 -7
  74. package/js/metalstack/api/v2/network_pb.js +1 -1
  75. package/js/metalstack/api/v2/network_pb.ts +7 -7
  76. package/js/metalstack/api/v2/partition_pb.d.ts +3 -3
  77. package/js/metalstack/api/v2/partition_pb.js +2 -2
  78. package/js/metalstack/api/v2/partition_pb.ts +4 -4
  79. package/js/metalstack/api/v2/predefined_rules_pb.d.ts +18 -0
  80. package/js/metalstack/api/v2/predefined_rules_pb.js +21 -3
  81. package/js/metalstack/api/v2/predefined_rules_pb.ts +27 -3
  82. package/js/metalstack/api/v2/project_pb.d.ts +8 -8
  83. package/js/metalstack/api/v2/project_pb.js +2 -2
  84. package/js/metalstack/api/v2/project_pb.ts +9 -9
  85. package/js/metalstack/api/v2/size_imageconstraint_pb.d.ts +2 -2
  86. package/js/metalstack/api/v2/size_imageconstraint_pb.js +1 -1
  87. package/js/metalstack/api/v2/size_imageconstraint_pb.ts +2 -2
  88. package/js/metalstack/api/v2/size_pb.d.ts +6 -6
  89. package/js/metalstack/api/v2/size_pb.js +2 -2
  90. package/js/metalstack/api/v2/size_pb.ts +7 -7
  91. package/js/metalstack/api/v2/size_reservation_pb.d.ts +3 -3
  92. package/js/metalstack/api/v2/size_reservation_pb.js +1 -1
  93. package/js/metalstack/api/v2/size_reservation_pb.ts +3 -3
  94. package/js/metalstack/api/v2/tenant_pb.d.ts +8 -8
  95. package/js/metalstack/api/v2/tenant_pb.js +2 -2
  96. package/js/metalstack/api/v2/tenant_pb.ts +9 -9
  97. package/js/metalstack/api/v2/token_pb.d.ts +15 -15
  98. package/js/metalstack/api/v2/token_pb.js +2 -2
  99. package/js/metalstack/api/v2/token_pb.ts +16 -16
  100. package/js/metalstack/api/v2/user_pb.d.ts +11 -11
  101. package/js/metalstack/api/v2/user_pb.js +2 -2
  102. package/js/metalstack/api/v2/user_pb.ts +12 -12
  103. package/js/metalstack/api/v2/version_pb.d.ts +6 -6
  104. package/js/metalstack/api/v2/version_pb.js +1 -1
  105. package/js/metalstack/api/v2/version_pb.ts +6 -6
  106. package/js/metalstack/api/v2/vpn_pb.d.ts +4 -4
  107. package/js/metalstack/api/v2/vpn_pb.ts +4 -4
  108. package/js/metalstack/infra/v2/bmc_pb.d.ts +19 -19
  109. package/js/metalstack/infra/v2/bmc_pb.js +1 -1
  110. package/js/metalstack/infra/v2/bmc_pb.ts +19 -19
  111. package/js/metalstack/infra/v2/boot_pb.d.ts +7 -7
  112. package/js/metalstack/infra/v2/boot_pb.js +1 -1
  113. package/js/metalstack/infra/v2/boot_pb.ts +7 -7
  114. package/js/metalstack/infra/v2/component_pb.d.ts +7 -10
  115. package/js/metalstack/infra/v2/component_pb.js +1 -1
  116. package/js/metalstack/infra/v2/component_pb.ts +7 -10
  117. package/js/metalstack/infra/v2/event_pb.d.ts +22 -22
  118. package/js/metalstack/infra/v2/event_pb.js +13 -13
  119. package/js/metalstack/infra/v2/event_pb.ts +22 -22
  120. package/js/metalstack/infra/v2/switch_pb.d.ts +22 -22
  121. package/js/metalstack/infra/v2/switch_pb.js +1 -1
  122. package/js/metalstack/infra/v2/switch_pb.ts +22 -22
  123. package/package.json +1 -1
@@ -6,19 +6,19 @@ import type { Message } from "@bufbuild/protobuf";
6
6
  */
7
7
  export declare const file_metalstack_infra_v2_bmc: GenFile;
8
8
  /**
9
- * UpdateBMCInfoRequest
9
+ * UpdateBMCInfoRequest is the request payload for updating BMC information.
10
10
  *
11
11
  * @generated from message metalstack.infra.v2.UpdateBMCInfoRequest
12
12
  */
13
13
  export type UpdateBMCInfoRequest = Message<"metalstack.infra.v2.UpdateBMCInfoRequest"> & {
14
14
  /**
15
- * Partition the partition id where metal-bmc wants to receive events
15
+ * Partition is the partition ID where metal-bmc wants to receive events
16
16
  *
17
17
  * @generated from field: string partition = 1;
18
18
  */
19
19
  partition: string;
20
20
  /**
21
- * BmcReports contains maps the bmc report per machine uuid
21
+ * BmcReports contains maps the BMC report per machine UUID
22
22
  *
23
23
  * @generated from field: map<string, metalstack.api.v2.MachineBMCReport> bmc_reports = 2;
24
24
  */
@@ -32,19 +32,19 @@ export type UpdateBMCInfoRequest = Message<"metalstack.infra.v2.UpdateBMCInfoReq
32
32
  */
33
33
  export declare const UpdateBMCInfoRequestSchema: GenMessage<UpdateBMCInfoRequest>;
34
34
  /**
35
- * UpdateBMCInfoResponse
35
+ * UpdateBMCInfoResponse is the response payload for updating BMC information.
36
36
  *
37
37
  * @generated from message metalstack.infra.v2.UpdateBMCInfoResponse
38
38
  */
39
39
  export type UpdateBMCInfoResponse = Message<"metalstack.infra.v2.UpdateBMCInfoResponse"> & {
40
40
  /**
41
- * UpdatedMachines is a slice of machine uuids which were updated
41
+ * UpdatedMachines is a slice of machine UUIDs which were updated
42
42
  *
43
43
  * @generated from field: repeated string updated_machines = 1;
44
44
  */
45
45
  updatedMachines: string[];
46
46
  /**
47
- * CreatedMachines is a slice of machine uuids which were created
47
+ * CreatedMachines is a slice of machine UUIDs which were created
48
48
  *
49
49
  * @generated from field: repeated string created_machines = 2;
50
50
  */
@@ -56,13 +56,13 @@ export type UpdateBMCInfoResponse = Message<"metalstack.infra.v2.UpdateBMCInfoRe
56
56
  */
57
57
  export declare const UpdateBMCInfoResponseSchema: GenMessage<UpdateBMCInfoResponse>;
58
58
  /**
59
- * WaitForBMCCommandRequest
59
+ * WaitForBMCCommandRequest is the request payload for waiting for a BMC command.
60
60
  *
61
61
  * @generated from message metalstack.infra.v2.WaitForBMCCommandRequest
62
62
  */
63
63
  export type WaitForBMCCommandRequest = Message<"metalstack.infra.v2.WaitForBMCCommandRequest"> & {
64
64
  /**
65
- * Partition the partition id where metal-bmc wants to receive bmc commands
65
+ * Partition is the partition ID where metal-bmc wants to receive BMC commands
66
66
  *
67
67
  * @generated from field: string partition = 1;
68
68
  */
@@ -74,7 +74,7 @@ export type WaitForBMCCommandRequest = Message<"metalstack.infra.v2.WaitForBMCCo
74
74
  */
75
75
  export declare const WaitForBMCCommandRequestSchema: GenMessage<WaitForBMCCommandRequest>;
76
76
  /**
77
- * WaitForBMCCommandResponse
77
+ * WaitForBMCCommandResponse is the response payload for waiting for a BMC command.
78
78
  *
79
79
  * @generated from message metalstack.infra.v2.WaitForBMCCommandResponse
80
80
  */
@@ -86,20 +86,20 @@ export type WaitForBMCCommandResponse = Message<"metalstack.infra.v2.WaitForBMCC
86
86
  */
87
87
  uuid: string;
88
88
  /**
89
- * BmcCommand to execute against the bmc of the machine
89
+ * BmcCommand to execute against the BMC of the machine
90
90
  *
91
91
  * @generated from field: metalstack.api.v2.MachineBMCCommand bmc_command = 2;
92
92
  */
93
93
  bmcCommand: MachineBMCCommand;
94
94
  /**
95
- * MachineBmc contains connection details of the machine to issue the bmcCommand to
95
+ * MachineBmc contains connection details of the machine to issue the BMC command to
96
96
  *
97
97
  * @generated from field: metalstack.api.v2.MachineBMC machine_bmc = 3;
98
98
  */
99
99
  machineBmc?: MachineBMC;
100
100
  /**
101
101
  * CommandId is a unique ID which must be sent back after execution
102
- * it is usually in the form: <machine-uuid>:machine-bmc-command:<command>
102
+ * It is usually in the form: <machine-uuid>:machine-bmc-command:<command>
103
103
  *
104
104
  * @generated from field: string command_id = 4;
105
105
  */
@@ -111,14 +111,14 @@ export type WaitForBMCCommandResponse = Message<"metalstack.infra.v2.WaitForBMCC
111
111
  */
112
112
  export declare const WaitForBMCCommandResponseSchema: GenMessage<WaitForBMCCommandResponse>;
113
113
  /**
114
- * BMCCommandDoneRequest must be returned after command execution
114
+ * BMCCommandDoneRequest must be returned after command execution.
115
115
  *
116
116
  * @generated from message metalstack.infra.v2.BMCCommandDoneRequest
117
117
  */
118
118
  export type BMCCommandDoneRequest = Message<"metalstack.infra.v2.BMCCommandDoneRequest"> & {
119
119
  /**
120
120
  * CommandId is a unique ID which must be sent back after execution
121
- * it is usually in the form: <machine-uuid>:machine-bmc-command
121
+ * It is usually in the form: <machine-uuid>:machine-bmc-command
122
122
  *
123
123
  * @generated from field: string command_id = 1;
124
124
  */
@@ -136,7 +136,7 @@ export type BMCCommandDoneRequest = Message<"metalstack.infra.v2.BMCCommandDoneR
136
136
  */
137
137
  export declare const BMCCommandDoneRequestSchema: GenMessage<BMCCommandDoneRequest>;
138
138
  /**
139
- * BMCCommandDoneResponse
139
+ * BMCCommandDoneResponse is the response payload for BMC command completion.
140
140
  *
141
141
  * @generated from message metalstack.infra.v2.BMCCommandDoneResponse
142
142
  */
@@ -147,13 +147,13 @@ export type BMCCommandDoneResponse = Message<"metalstack.infra.v2.BMCCommandDone
147
147
  */
148
148
  export declare const BMCCommandDoneResponseSchema: GenMessage<BMCCommandDoneResponse>;
149
149
  /**
150
- * BMCService serves bmc related functions
150
+ * BMCService provides BMC management operations.
151
151
  *
152
152
  * @generated from service metalstack.infra.v2.BMCService
153
153
  */
154
154
  export declare const BMCService: GenService<{
155
155
  /**
156
- * UpdateBMCInfo
156
+ * Updates BMC information.
157
157
  *
158
158
  * @generated from rpc metalstack.infra.v2.BMCService.UpdateBMCInfo
159
159
  */
@@ -163,7 +163,7 @@ export declare const BMCService: GenService<{
163
163
  output: typeof UpdateBMCInfoResponseSchema;
164
164
  };
165
165
  /**
166
- * WaitForBMCCommand is called by the metal-bmc and is returned with a bmc command to execute.
166
+ * WaitForBMCCommand is called by the metal-bmc and returns a BMC command to execute.
167
167
  *
168
168
  * @generated from rpc metalstack.infra.v2.BMCService.WaitForBMCCommand
169
169
  */
@@ -173,7 +173,7 @@ export declare const BMCService: GenService<{
173
173
  output: typeof WaitForBMCCommandResponseSchema;
174
174
  };
175
175
  /**
176
- * BMCCommandDone must be called from metal-bmc after the command execution
176
+ * BMCCommandDone must be called from metal-bmc after the command execution.
177
177
  *
178
178
  * @generated from rpc metalstack.infra.v2.BMCService.BMCCommandDone
179
179
  */
@@ -41,7 +41,7 @@ export const BMCCommandDoneRequestSchema = /*@__PURE__*/ messageDesc(file_metals
41
41
  */
42
42
  export const BMCCommandDoneResponseSchema = /*@__PURE__*/ messageDesc(file_metalstack_infra_v2_bmc, 5);
43
43
  /**
44
- * BMCService serves bmc related functions
44
+ * BMCService provides BMC management operations.
45
45
  *
46
46
  * @generated from service metalstack.infra.v2.BMCService
47
47
  */
@@ -18,20 +18,20 @@ export const file_metalstack_infra_v2_bmc: GenFile = /*@__PURE__*/
18
18
  fileDesc("Ch1tZXRhbHN0YWNrL2luZnJhL3YyL2JtYy5wcm90bxITbWV0YWxzdGFjay5pbmZyYS52MiLtAQoUVXBkYXRlQk1DSW5mb1JlcXVlc3QSHgoJcGFydGl0aW9uGAEgASgJQgu6SAhyBtCzrrECARJdCgtibWNfcmVwb3J0cxgCIAMoCzI5Lm1ldGFsc3RhY2suaW5mcmEudjIuVXBkYXRlQk1DSW5mb1JlcXVlc3QuQm1jUmVwb3J0c0VudHJ5Qg26SAqaAQciBXIDsAEBGlYKD0JtY1JlcG9ydHNFbnRyeRILCgNrZXkYASABKAkSMgoFdmFsdWUYAiABKAsyIy5tZXRhbHN0YWNrLmFwaS52Mi5NYWNoaW5lQk1DUmVwb3J0OgI4ASJLChVVcGRhdGVCTUNJbmZvUmVzcG9uc2USGAoQdXBkYXRlZF9tYWNoaW5lcxgBIAMoCRIYChBjcmVhdGVkX21hY2hpbmVzGAIgAygJIjoKGFdhaXRGb3JCTUNDb21tYW5kUmVxdWVzdBIeCglwYXJ0aXRpb24YASABKAlCC7pICHIG0LOusQIBIrYBChlXYWl0Rm9yQk1DQ29tbWFuZFJlc3BvbnNlEhYKBHV1aWQYASABKAlCCLpIBXIDsAEBEjkKC2JtY19jb21tYW5kGAIgASgOMiQubWV0YWxzdGFjay5hcGkudjIuTWFjaGluZUJNQ0NvbW1hbmQSMgoLbWFjaGluZV9ibWMYAyABKAsyHS5tZXRhbHN0YWNrLmFwaS52Mi5NYWNoaW5lQk1DEhIKCmNvbW1hbmRfaWQYBCABKAkiSQoVQk1DQ29tbWFuZERvbmVSZXF1ZXN0EhIKCmNvbW1hbmRfaWQYASABKAkSEgoFZXJyb3IYAiABKAlIAIgBAUIICgZfZXJyb3IiGAoWQk1DQ29tbWFuZERvbmVSZXNwb25zZTL2AgoKQk1DU2VydmljZRJxCg1VcGRhdGVCTUNJbmZvEikubWV0YWxzdGFjay5pbmZyYS52Mi5VcGRhdGVCTUNJbmZvUmVxdWVzdBoqLm1ldGFsc3RhY2suaW5mcmEudjIuVXBkYXRlQk1DSW5mb1Jlc3BvbnNlIgng8xgC6vMYAQESfwoRV2FpdEZvckJNQ0NvbW1hbmQSLS5tZXRhbHN0YWNrLmluZnJhLnYyLldhaXRGb3JCTUNDb21tYW5kUmVxdWVzdBouLm1ldGFsc3RhY2suaW5mcmEudjIuV2FpdEZvckJNQ0NvbW1hbmRSZXNwb25zZSIJ4PMYAurzGAEBMAESdAoOQk1DQ29tbWFuZERvbmUSKi5tZXRhbHN0YWNrLmluZnJhLnYyLkJNQ0NvbW1hbmREb25lUmVxdWVzdBorLm1ldGFsc3RhY2suaW5mcmEudjIuQk1DQ29tbWFuZERvbmVSZXNwb25zZSIJ4PMYAerzGAEBQswBChdjb20ubWV0YWxzdGFjay5pbmZyYS52MkIIQm1jUHJvdG9QAVo5Z2l0aHViLmNvbS9tZXRhbC1zdGFjay9hcGkvZ28vbWV0YWxzdGFjay9pbmZyYS92MjtpbmZyYXYyogIDTUlYqgITTWV0YWxzdGFjay5JbmZyYS5WMsoCE01ldGFsc3RhY2tcSW5mcmFcVjLiAh9NZXRhbHN0YWNrXEluZnJhXFYyXEdQQk1ldGFkYXRh6gIVTWV0YWxzdGFjazo6SW5mcmE6OlYyYgZwcm90bzM", [file_buf_validate_validate, file_metalstack_api_v2_common, file_metalstack_api_v2_machine, file_metalstack_api_v2_predefined_rules]);
19
19
 
20
20
  /**
21
- * UpdateBMCInfoRequest
21
+ * UpdateBMCInfoRequest is the request payload for updating BMC information.
22
22
  *
23
23
  * @generated from message metalstack.infra.v2.UpdateBMCInfoRequest
24
24
  */
25
25
  export type UpdateBMCInfoRequest = Message<"metalstack.infra.v2.UpdateBMCInfoRequest"> & {
26
26
  /**
27
- * Partition the partition id where metal-bmc wants to receive events
27
+ * Partition is the partition ID where metal-bmc wants to receive events
28
28
  *
29
29
  * @generated from field: string partition = 1;
30
30
  */
31
31
  partition: string;
32
32
 
33
33
  /**
34
- * BmcReports contains maps the bmc report per machine uuid
34
+ * BmcReports contains maps the BMC report per machine UUID
35
35
  *
36
36
  * @generated from field: map<string, metalstack.api.v2.MachineBMCReport> bmc_reports = 2;
37
37
  */
@@ -46,20 +46,20 @@ export const UpdateBMCInfoRequestSchema: GenMessage<UpdateBMCInfoRequest> = /*@_
46
46
  messageDesc(file_metalstack_infra_v2_bmc, 0);
47
47
 
48
48
  /**
49
- * UpdateBMCInfoResponse
49
+ * UpdateBMCInfoResponse is the response payload for updating BMC information.
50
50
  *
51
51
  * @generated from message metalstack.infra.v2.UpdateBMCInfoResponse
52
52
  */
53
53
  export type UpdateBMCInfoResponse = Message<"metalstack.infra.v2.UpdateBMCInfoResponse"> & {
54
54
  /**
55
- * UpdatedMachines is a slice of machine uuids which were updated
55
+ * UpdatedMachines is a slice of machine UUIDs which were updated
56
56
  *
57
57
  * @generated from field: repeated string updated_machines = 1;
58
58
  */
59
59
  updatedMachines: string[];
60
60
 
61
61
  /**
62
- * CreatedMachines is a slice of machine uuids which were created
62
+ * CreatedMachines is a slice of machine UUIDs which were created
63
63
  *
64
64
  * @generated from field: repeated string created_machines = 2;
65
65
  */
@@ -74,13 +74,13 @@ export const UpdateBMCInfoResponseSchema: GenMessage<UpdateBMCInfoResponse> = /*
74
74
  messageDesc(file_metalstack_infra_v2_bmc, 1);
75
75
 
76
76
  /**
77
- * WaitForBMCCommandRequest
77
+ * WaitForBMCCommandRequest is the request payload for waiting for a BMC command.
78
78
  *
79
79
  * @generated from message metalstack.infra.v2.WaitForBMCCommandRequest
80
80
  */
81
81
  export type WaitForBMCCommandRequest = Message<"metalstack.infra.v2.WaitForBMCCommandRequest"> & {
82
82
  /**
83
- * Partition the partition id where metal-bmc wants to receive bmc commands
83
+ * Partition is the partition ID where metal-bmc wants to receive BMC commands
84
84
  *
85
85
  * @generated from field: string partition = 1;
86
86
  */
@@ -95,7 +95,7 @@ export const WaitForBMCCommandRequestSchema: GenMessage<WaitForBMCCommandRequest
95
95
  messageDesc(file_metalstack_infra_v2_bmc, 2);
96
96
 
97
97
  /**
98
- * WaitForBMCCommandResponse
98
+ * WaitForBMCCommandResponse is the response payload for waiting for a BMC command.
99
99
  *
100
100
  * @generated from message metalstack.infra.v2.WaitForBMCCommandResponse
101
101
  */
@@ -108,14 +108,14 @@ export type WaitForBMCCommandResponse = Message<"metalstack.infra.v2.WaitForBMCC
108
108
  uuid: string;
109
109
 
110
110
  /**
111
- * BmcCommand to execute against the bmc of the machine
111
+ * BmcCommand to execute against the BMC of the machine
112
112
  *
113
113
  * @generated from field: metalstack.api.v2.MachineBMCCommand bmc_command = 2;
114
114
  */
115
115
  bmcCommand: MachineBMCCommand;
116
116
 
117
117
  /**
118
- * MachineBmc contains connection details of the machine to issue the bmcCommand to
118
+ * MachineBmc contains connection details of the machine to issue the BMC command to
119
119
  *
120
120
  * @generated from field: metalstack.api.v2.MachineBMC machine_bmc = 3;
121
121
  */
@@ -123,7 +123,7 @@ export type WaitForBMCCommandResponse = Message<"metalstack.infra.v2.WaitForBMCC
123
123
 
124
124
  /**
125
125
  * CommandId is a unique ID which must be sent back after execution
126
- * it is usually in the form: <machine-uuid>:machine-bmc-command:<command>
126
+ * It is usually in the form: <machine-uuid>:machine-bmc-command:<command>
127
127
  *
128
128
  * @generated from field: string command_id = 4;
129
129
  */
@@ -138,14 +138,14 @@ export const WaitForBMCCommandResponseSchema: GenMessage<WaitForBMCCommandRespon
138
138
  messageDesc(file_metalstack_infra_v2_bmc, 3);
139
139
 
140
140
  /**
141
- * BMCCommandDoneRequest must be returned after command execution
141
+ * BMCCommandDoneRequest must be returned after command execution.
142
142
  *
143
143
  * @generated from message metalstack.infra.v2.BMCCommandDoneRequest
144
144
  */
145
145
  export type BMCCommandDoneRequest = Message<"metalstack.infra.v2.BMCCommandDoneRequest"> & {
146
146
  /**
147
147
  * CommandId is a unique ID which must be sent back after execution
148
- * it is usually in the form: <machine-uuid>:machine-bmc-command
148
+ * It is usually in the form: <machine-uuid>:machine-bmc-command
149
149
  *
150
150
  * @generated from field: string command_id = 1;
151
151
  */
@@ -167,7 +167,7 @@ export const BMCCommandDoneRequestSchema: GenMessage<BMCCommandDoneRequest> = /*
167
167
  messageDesc(file_metalstack_infra_v2_bmc, 4);
168
168
 
169
169
  /**
170
- * BMCCommandDoneResponse
170
+ * BMCCommandDoneResponse is the response payload for BMC command completion.
171
171
  *
172
172
  * @generated from message metalstack.infra.v2.BMCCommandDoneResponse
173
173
  */
@@ -182,13 +182,13 @@ export const BMCCommandDoneResponseSchema: GenMessage<BMCCommandDoneResponse> =
182
182
  messageDesc(file_metalstack_infra_v2_bmc, 5);
183
183
 
184
184
  /**
185
- * BMCService serves bmc related functions
185
+ * BMCService provides BMC management operations.
186
186
  *
187
187
  * @generated from service metalstack.infra.v2.BMCService
188
188
  */
189
189
  export const BMCService: GenService<{
190
190
  /**
191
- * UpdateBMCInfo
191
+ * Updates BMC information.
192
192
  *
193
193
  * @generated from rpc metalstack.infra.v2.BMCService.UpdateBMCInfo
194
194
  */
@@ -198,7 +198,7 @@ export const BMCService: GenService<{
198
198
  output: typeof UpdateBMCInfoResponseSchema;
199
199
  },
200
200
  /**
201
- * WaitForBMCCommand is called by the metal-bmc and is returned with a bmc command to execute.
201
+ * WaitForBMCCommand is called by the metal-bmc and returns a BMC command to execute.
202
202
  *
203
203
  * @generated from rpc metalstack.infra.v2.BMCService.WaitForBMCCommand
204
204
  */
@@ -208,7 +208,7 @@ export const BMCService: GenService<{
208
208
  output: typeof WaitForBMCCommandResponseSchema;
209
209
  },
210
210
  /**
211
- * BMCCommandDone must be called from metal-bmc after the command execution
211
+ * BMCCommandDone must be called from metal-bmc after the command execution.
212
212
  *
213
213
  * @generated from rpc metalstack.infra.v2.BMCService.BMCCommandDone
214
214
  */
@@ -298,7 +298,7 @@ export type BootServiceSuperUserPasswordResponse = Message<"metalstack.infra.v2.
298
298
  */
299
299
  export declare const BootServiceSuperUserPasswordResponseSchema: GenMessage<BootServiceSuperUserPasswordResponse>;
300
300
  /**
301
- * BootService is used for all boot related requests, either pixiecore or metal-hammer
301
+ * BootService provides boot-related operations for pixiecore and metal-hammer.
302
302
  *
303
303
  * Pixiecore
304
304
  *
@@ -306,7 +306,7 @@ export declare const BootServiceSuperUserPasswordResponseSchema: GenMessage<Boot
306
306
  */
307
307
  export declare const BootService: GenService<{
308
308
  /**
309
- * Dhcp is the first dhcp request (option 97). A ProvisioningEventPXEBooting is fired
309
+ * Dhcp handles the first DHCP request (option 97). A ProvisioningEventPXEBooting is fired.
310
310
  *
311
311
  * @generated from rpc metalstack.infra.v2.BootService.Dhcp
312
312
  */
@@ -316,7 +316,7 @@ export declare const BootService: GenService<{
316
316
  output: typeof BootServiceDhcpResponseSchema;
317
317
  };
318
318
  /**
319
- * Boot is called from pixie once the machine got the first dhcp response and ipxie asks for subsequent kernel and initrd
319
+ * Boot is called from pixie once the machine got the first DHCP response and ipxe asks for subsequent kernel and initrd.
320
320
  *
321
321
  * @generated from rpc metalstack.infra.v2.BootService.Boot
322
322
  */
@@ -326,7 +326,7 @@ export declare const BootService: GenService<{
326
326
  output: typeof BootServiceBootResponseSchema;
327
327
  };
328
328
  /**
329
- * SuperUserPassword metal-hammer takes the configured root password for the bmc from metal-apiserver and configure the bmc accordingly
329
+ * SuperUserPassword returns the configured root password for the BMC.
330
330
  *
331
331
  * @generated from rpc metalstack.infra.v2.BootService.SuperUserPassword
332
332
  */
@@ -336,7 +336,7 @@ export declare const BootService: GenService<{
336
336
  output: typeof BootServiceSuperUserPasswordResponseSchema;
337
337
  };
338
338
  /**
339
- * Register is called from metal-hammer after hardware inventory is finished, tells metal-apiserver all gory details about that machine
339
+ * Register is called from metal-hammer after hardware inventory is finished, tells metal-apiserver all details about that machine.
340
340
  *
341
341
  * @generated from rpc metalstack.infra.v2.BootService.Register
342
342
  */
@@ -346,7 +346,7 @@ export declare const BootService: GenService<{
346
346
  output: typeof BootServiceRegisterResponseSchema;
347
347
  };
348
348
  /**
349
- * Wait is a hanging call that waits until the machine gets allocated by a user
349
+ * Wait is a hanging call that waits until the machine gets allocated by a user.
350
350
  *
351
351
  * @generated from rpc metalstack.infra.v2.BootService.Wait
352
352
  */
@@ -356,7 +356,7 @@ export declare const BootService: GenService<{
356
356
  output: typeof BootServiceWaitResponseSchema;
357
357
  };
358
358
  /**
359
- * InstallationSucceeded tells metal-apiserver installation was either successful
359
+ * InstallationSucceeded tells metal-apiserver that installation was successful.
360
360
  *
361
361
  * @generated from rpc metalstack.infra.v2.BootService.InstallationSucceeded
362
362
  */
@@ -71,7 +71,7 @@ export const BootServiceSuperUserPasswordRequestSchema = /*@__PURE__*/ messageDe
71
71
  */
72
72
  export const BootServiceSuperUserPasswordResponseSchema = /*@__PURE__*/ messageDesc(file_metalstack_infra_v2_boot, 11);
73
73
  /**
74
- * BootService is used for all boot related requests, either pixiecore or metal-hammer
74
+ * BootService provides boot-related operations for pixiecore and metal-hammer.
75
75
  *
76
76
  * Pixiecore
77
77
  *
@@ -363,7 +363,7 @@ export const BootServiceSuperUserPasswordResponseSchema: GenMessage<BootServiceS
363
363
  messageDesc(file_metalstack_infra_v2_boot, 11);
364
364
 
365
365
  /**
366
- * BootService is used for all boot related requests, either pixiecore or metal-hammer
366
+ * BootService provides boot-related operations for pixiecore and metal-hammer.
367
367
  *
368
368
  * Pixiecore
369
369
  *
@@ -371,7 +371,7 @@ export const BootServiceSuperUserPasswordResponseSchema: GenMessage<BootServiceS
371
371
  */
372
372
  export const BootService: GenService<{
373
373
  /**
374
- * Dhcp is the first dhcp request (option 97). A ProvisioningEventPXEBooting is fired
374
+ * Dhcp handles the first DHCP request (option 97). A ProvisioningEventPXEBooting is fired.
375
375
  *
376
376
  * @generated from rpc metalstack.infra.v2.BootService.Dhcp
377
377
  */
@@ -381,7 +381,7 @@ export const BootService: GenService<{
381
381
  output: typeof BootServiceDhcpResponseSchema;
382
382
  },
383
383
  /**
384
- * Boot is called from pixie once the machine got the first dhcp response and ipxie asks for subsequent kernel and initrd
384
+ * Boot is called from pixie once the machine got the first DHCP response and ipxe asks for subsequent kernel and initrd.
385
385
  *
386
386
  * @generated from rpc metalstack.infra.v2.BootService.Boot
387
387
  */
@@ -391,7 +391,7 @@ export const BootService: GenService<{
391
391
  output: typeof BootServiceBootResponseSchema;
392
392
  },
393
393
  /**
394
- * SuperUserPassword metal-hammer takes the configured root password for the bmc from metal-apiserver and configure the bmc accordingly
394
+ * SuperUserPassword returns the configured root password for the BMC.
395
395
  *
396
396
  * @generated from rpc metalstack.infra.v2.BootService.SuperUserPassword
397
397
  */
@@ -401,7 +401,7 @@ export const BootService: GenService<{
401
401
  output: typeof BootServiceSuperUserPasswordResponseSchema;
402
402
  },
403
403
  /**
404
- * Register is called from metal-hammer after hardware inventory is finished, tells metal-apiserver all gory details about that machine
404
+ * Register is called from metal-hammer after hardware inventory is finished, tells metal-apiserver all details about that machine.
405
405
  *
406
406
  * @generated from rpc metalstack.infra.v2.BootService.Register
407
407
  */
@@ -411,7 +411,7 @@ export const BootService: GenService<{
411
411
  output: typeof BootServiceRegisterResponseSchema;
412
412
  },
413
413
  /**
414
- * Wait is a hanging call that waits until the machine gets allocated by a user
414
+ * Wait is a hanging call that waits until the machine gets allocated by a user.
415
415
  *
416
416
  * @generated from rpc metalstack.infra.v2.BootService.Wait
417
417
  */
@@ -421,7 +421,7 @@ export const BootService: GenService<{
421
421
  output: typeof BootServiceWaitResponseSchema;
422
422
  },
423
423
  /**
424
- * InstallationSucceeded tells metal-apiserver installation was either successful
424
+ * InstallationSucceeded tells metal-apiserver that installation was successful.
425
425
  *
426
426
  * @generated from rpc metalstack.infra.v2.BootService.InstallationSucceeded
427
427
  */
@@ -8,7 +8,7 @@ import type { Message } from "@bufbuild/protobuf";
8
8
  */
9
9
  export declare const file_metalstack_infra_v2_component: GenFile;
10
10
  /**
11
- * ComponentServicePingRequest is sent from a microservice to report its state regularly
11
+ * ComponentServicePingRequest is the request payload for pinging a microservice.
12
12
  *
13
13
  * @generated from message metalstack.infra.v2.ComponentServicePingRequest
14
14
  */
@@ -20,21 +20,19 @@ export type ComponentServicePingRequest = Message<"metalstack.infra.v2.Component
20
20
  */
21
21
  type: ComponentType;
22
22
  /**
23
- * Identifier is a unique identifier of this service, e.g. if two instance are running, this might be the pod id.
24
- * micro_service and identifier guarantee uniqueness.
23
+ * Identifier is a unique identifier of this service, for example if two instances are running, this might be the pod ID
25
24
  *
26
25
  * @generated from field: string identifier = 2;
27
26
  */
28
27
  identifier: string;
29
28
  /**
30
- * StartedAt is the timestamp this service was started.
29
+ * StartedAt is the timestamp this service was started
31
30
  *
32
31
  * @generated from field: google.protobuf.Timestamp started_at = 3;
33
32
  */
34
33
  startedAt?: Timestamp;
35
34
  /**
36
- * Interval at which the ping is scheduled, must be between 5 seconds and 1 hour.
37
- * Also gets validated in the same way in go/client/ping.go.
35
+ * Interval at which the ping is scheduled, must be between 5 seconds and 1 hour
38
36
  *
39
37
  * @generated from field: google.protobuf.Duration interval = 4;
40
38
  */
@@ -52,7 +50,7 @@ export type ComponentServicePingRequest = Message<"metalstack.infra.v2.Component
52
50
  */
53
51
  export declare const ComponentServicePingRequestSchema: GenMessage<ComponentServicePingRequest>;
54
52
  /**
55
- * ComponentServicePingResponse is the response to a ping request
53
+ * ComponentServicePingResponse is the response payload for pinging a microservice.
56
54
  *
57
55
  * @generated from message metalstack.infra.v2.ComponentServicePingResponse
58
56
  */
@@ -63,14 +61,13 @@ export type ComponentServicePingResponse = Message<"metalstack.infra.v2.Componen
63
61
  */
64
62
  export declare const ComponentServicePingResponseSchema: GenMessage<ComponentServicePingResponse>;
65
63
  /**
66
- * ComponentService serves component, e.g. microservices related functions.
64
+ * ComponentService provides microservice component management operations.
67
65
  *
68
66
  * @generated from service metalstack.infra.v2.ComponentService
69
67
  */
70
68
  export declare const ComponentService: GenService<{
71
69
  /**
72
- * Ping must be called from every connected microservice in a recurring manner
73
- * to get visibility of all registered microservices.
70
+ * Returns the ping response to register or report the microservice state.
74
71
  *
75
72
  * @generated from rpc metalstack.infra.v2.ComponentService.Ping
76
73
  */
@@ -23,7 +23,7 @@ export const ComponentServicePingRequestSchema = /*@__PURE__*/ messageDesc(file_
23
23
  */
24
24
  export const ComponentServicePingResponseSchema = /*@__PURE__*/ messageDesc(file_metalstack_infra_v2_component, 1);
25
25
  /**
26
- * ComponentService serves component, e.g. microservices related functions.
26
+ * ComponentService provides microservice component management operations.
27
27
  *
28
28
  * @generated from service metalstack.infra.v2.ComponentService
29
29
  */
@@ -22,7 +22,7 @@ export const file_metalstack_infra_v2_component: GenFile = /*@__PURE__*/
22
22
  fileDesc("CiNtZXRhbHN0YWNrL2luZnJhL3YyL2NvbXBvbmVudC5wcm90bxITbWV0YWxzdGFjay5pbmZyYS52MiKdAgobQ29tcG9uZW50U2VydmljZVBpbmdSZXF1ZXN0EjgKBHR5cGUYASABKA4yIC5tZXRhbHN0YWNrLmFwaS52Mi5Db21wb25lbnRUeXBlQgi6SAWCAQIQARIfCgppZGVudGlmaWVyGAIgASgJQgu6SAhyBsCzrrECARI4CgpzdGFydGVkX2F0GAMgASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcEIIukgFsgECOAESPAoIaW50ZXJ2YWwYBCABKAsyGS5nb29nbGUucHJvdG9idWYuRHVyYXRpb25CD7pIDKoBCSIDCJAcMgIIBRIrCgd2ZXJzaW9uGAUgASgLMhoubWV0YWxzdGFjay5hcGkudjIuVmVyc2lvbiIeChxDb21wb25lbnRTZXJ2aWNlUGluZ1Jlc3BvbnNlMooBChBDb21wb25lbnRTZXJ2aWNlEnYKBFBpbmcSMC5tZXRhbHN0YWNrLmluZnJhLnYyLkNvbXBvbmVudFNlcnZpY2VQaW5nUmVxdWVzdBoxLm1ldGFsc3RhY2suaW5mcmEudjIuQ29tcG9uZW50U2VydmljZVBpbmdSZXNwb25zZSIJ4PMYAurzGAEBQtIBChdjb20ubWV0YWxzdGFjay5pbmZyYS52MkIOQ29tcG9uZW50UHJvdG9QAVo5Z2l0aHViLmNvbS9tZXRhbC1zdGFjay9hcGkvZ28vbWV0YWxzdGFjay9pbmZyYS92MjtpbmZyYXYyogIDTUlYqgITTWV0YWxzdGFjay5JbmZyYS5WMsoCE01ldGFsc3RhY2tcSW5mcmFcVjLiAh9NZXRhbHN0YWNrXEluZnJhXFYyXEdQQk1ldGFkYXRh6gIVTWV0YWxzdGFjazo6SW5mcmE6OlYyYgZwcm90bzM", [file_buf_validate_validate, file_google_protobuf_duration, file_google_protobuf_timestamp, file_metalstack_api_v2_common, file_metalstack_api_v2_component, file_metalstack_api_v2_predefined_rules, file_metalstack_api_v2_version]);
23
23
 
24
24
  /**
25
- * ComponentServicePingRequest is sent from a microservice to report its state regularly
25
+ * ComponentServicePingRequest is the request payload for pinging a microservice.
26
26
  *
27
27
  * @generated from message metalstack.infra.v2.ComponentServicePingRequest
28
28
  */
@@ -35,23 +35,21 @@ export type ComponentServicePingRequest = Message<"metalstack.infra.v2.Component
35
35
  type: ComponentType;
36
36
 
37
37
  /**
38
- * Identifier is a unique identifier of this service, e.g. if two instance are running, this might be the pod id.
39
- * micro_service and identifier guarantee uniqueness.
38
+ * Identifier is a unique identifier of this service, for example if two instances are running, this might be the pod ID
40
39
  *
41
40
  * @generated from field: string identifier = 2;
42
41
  */
43
42
  identifier: string;
44
43
 
45
44
  /**
46
- * StartedAt is the timestamp this service was started.
45
+ * StartedAt is the timestamp this service was started
47
46
  *
48
47
  * @generated from field: google.protobuf.Timestamp started_at = 3;
49
48
  */
50
49
  startedAt?: Timestamp;
51
50
 
52
51
  /**
53
- * Interval at which the ping is scheduled, must be between 5 seconds and 1 hour.
54
- * Also gets validated in the same way in go/client/ping.go.
52
+ * Interval at which the ping is scheduled, must be between 5 seconds and 1 hour
55
53
  *
56
54
  * @generated from field: google.protobuf.Duration interval = 4;
57
55
  */
@@ -73,7 +71,7 @@ export const ComponentServicePingRequestSchema: GenMessage<ComponentServicePingR
73
71
  messageDesc(file_metalstack_infra_v2_component, 0);
74
72
 
75
73
  /**
76
- * ComponentServicePingResponse is the response to a ping request
74
+ * ComponentServicePingResponse is the response payload for pinging a microservice.
77
75
  *
78
76
  * @generated from message metalstack.infra.v2.ComponentServicePingResponse
79
77
  */
@@ -88,14 +86,13 @@ export const ComponentServicePingResponseSchema: GenMessage<ComponentServicePing
88
86
  messageDesc(file_metalstack_infra_v2_component, 1);
89
87
 
90
88
  /**
91
- * ComponentService serves component, e.g. microservices related functions.
89
+ * ComponentService provides microservice component management operations.
92
90
  *
93
91
  * @generated from service metalstack.infra.v2.ComponentService
94
92
  */
95
93
  export const ComponentService: GenService<{
96
94
  /**
97
- * Ping must be called from every connected microservice in a recurring manner
98
- * to get visibility of all registered microservices.
95
+ * Returns the ping response to register or report the microservice state.
99
96
  *
100
97
  * @generated from rpc metalstack.infra.v2.ComponentService.Ping
101
98
  */