@metal-stack/api 0.4.3 → 0.5.1

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 (151) hide show
  1. package/{js/Makefile → Makefile} +5 -2
  2. package/bun.lock +74 -0
  3. package/client-test.d.ts +1 -0
  4. package/client-test.js +45 -0
  5. package/client-test.ts +49 -0
  6. package/client.d.ts +97 -0
  7. package/client.js +347 -0
  8. package/client.ts +662 -0
  9. package/{js/metalstack → metalstack}/admin/v2/audit_pb.d.ts +5 -5
  10. package/{js/metalstack → metalstack}/admin/v2/audit_pb.ts +5 -5
  11. package/{js/metalstack → metalstack}/admin/v2/component_pb.d.ts +6 -6
  12. package/{js/metalstack → metalstack}/admin/v2/component_pb.ts +6 -6
  13. package/{js/metalstack → metalstack}/admin/v2/filesystem_pb.d.ts +28 -28
  14. package/{js/metalstack → metalstack}/admin/v2/filesystem_pb.ts +28 -28
  15. package/{js/metalstack → metalstack}/admin/v2/image_pb.d.ts +22 -16
  16. package/{js/metalstack → metalstack}/admin/v2/image_pb.js +1 -1
  17. package/{js/metalstack → metalstack}/admin/v2/image_pb.ts +24 -17
  18. package/{js/metalstack → metalstack}/admin/v2/ip_pb.d.ts +2 -2
  19. package/{js/metalstack → metalstack}/admin/v2/ip_pb.ts +2 -2
  20. package/{js/metalstack → metalstack}/admin/v2/machine_pb.d.ts +47 -55
  21. package/{js/metalstack → metalstack}/admin/v2/machine_pb.js +1 -1
  22. package/{js/metalstack → metalstack}/admin/v2/machine_pb.ts +48 -55
  23. package/{js/metalstack → metalstack}/admin/v2/network_pb.d.ts +36 -36
  24. package/{js/metalstack → metalstack}/admin/v2/network_pb.ts +36 -36
  25. package/{js/metalstack → metalstack}/admin/v2/partition_pb.d.ts +26 -26
  26. package/{js/metalstack → metalstack}/admin/v2/partition_pb.ts +26 -26
  27. package/{js/metalstack → metalstack}/admin/v2/project_pb.d.ts +2 -2
  28. package/{js/metalstack → metalstack}/admin/v2/project_pb.ts +2 -2
  29. package/{js/metalstack → metalstack}/admin/v2/size_imageconstraint_pb.d.ts +18 -18
  30. package/{js/metalstack → metalstack}/admin/v2/size_imageconstraint_pb.ts +18 -18
  31. package/{js/metalstack → metalstack}/admin/v2/size_pb.d.ts +11 -11
  32. package/{js/metalstack → metalstack}/admin/v2/size_pb.ts +11 -11
  33. package/{js/metalstack → metalstack}/admin/v2/size_reservation_pb.d.ts +14 -14
  34. package/{js/metalstack → metalstack}/admin/v2/size_reservation_pb.ts +14 -14
  35. package/{js/metalstack → metalstack}/admin/v2/switch_pb.d.ts +29 -29
  36. package/{js/metalstack → metalstack}/admin/v2/switch_pb.ts +29 -29
  37. package/{js/metalstack → metalstack}/admin/v2/task_pb.d.ts +47 -47
  38. package/{js/metalstack → metalstack}/admin/v2/task_pb.js +8 -8
  39. package/{js/metalstack → metalstack}/admin/v2/task_pb.ts +47 -47
  40. package/{js/metalstack → metalstack}/admin/v2/tenant_pb.d.ts +22 -22
  41. package/{js/metalstack → metalstack}/admin/v2/tenant_pb.ts +22 -22
  42. package/{js/metalstack → metalstack}/admin/v2/token_pb.d.ts +8 -8
  43. package/{js/metalstack → metalstack}/admin/v2/token_pb.ts +8 -8
  44. package/{js/metalstack → metalstack}/admin/v2/vpn_pb.d.ts +13 -13
  45. package/{js/metalstack → metalstack}/admin/v2/vpn_pb.ts +13 -13
  46. package/{js/metalstack → metalstack}/api/v2/audit_pb.d.ts +37 -37
  47. package/{js/metalstack → metalstack}/api/v2/audit_pb.js +3 -3
  48. package/{js/metalstack → metalstack}/api/v2/audit_pb.ts +37 -37
  49. package/{js/metalstack → metalstack}/api/v2/common_pb.d.ts +68 -68
  50. package/{js/metalstack → metalstack}/api/v2/common_pb.js +47 -47
  51. package/{js/metalstack → metalstack}/api/v2/common_pb.ts +68 -68
  52. package/{js/metalstack → metalstack}/api/v2/component_pb.d.ts +17 -17
  53. package/{js/metalstack → metalstack}/api/v2/component_pb.js +8 -8
  54. package/{js/metalstack → metalstack}/api/v2/component_pb.ts +17 -17
  55. package/{js/metalstack → metalstack}/api/v2/filesystem_pb.d.ts +82 -82
  56. package/{js/metalstack → metalstack}/api/v2/filesystem_pb.js +23 -23
  57. package/{js/metalstack → metalstack}/api/v2/filesystem_pb.ts +82 -82
  58. package/{js/metalstack → metalstack}/api/v2/health_pb.d.ts +21 -21
  59. package/{js/metalstack → metalstack}/api/v2/health_pb.js +13 -13
  60. package/{js/metalstack → metalstack}/api/v2/health_pb.ts +21 -21
  61. package/{js/metalstack → metalstack}/api/v2/image_pb.d.ts +45 -45
  62. package/{js/metalstack → metalstack}/api/v2/image_pb.js +9 -9
  63. package/{js/metalstack → metalstack}/api/v2/image_pb.ts +45 -45
  64. package/{js/metalstack → metalstack}/api/v2/ip_pb.d.ts +67 -67
  65. package/{js/metalstack → metalstack}/api/v2/ip_pb.js +8 -8
  66. package/{js/metalstack → metalstack}/api/v2/ip_pb.ts +67 -67
  67. package/{js/metalstack → metalstack}/api/v2/machine_pb.d.ts +422 -374
  68. package/{js/metalstack → metalstack}/api/v2/machine_pb.js +94 -89
  69. package/{js/metalstack → metalstack}/api/v2/machine_pb.ts +453 -396
  70. package/{js/metalstack → metalstack}/api/v2/method_pb.d.ts +7 -7
  71. package/{js/metalstack → metalstack}/api/v2/method_pb.ts +7 -7
  72. package/{js/metalstack → metalstack}/api/v2/network_pb.d.ts +98 -98
  73. package/{js/metalstack → metalstack}/api/v2/network_pb.js +16 -16
  74. package/{js/metalstack → metalstack}/api/v2/network_pb.ts +98 -98
  75. package/{js/metalstack → metalstack}/api/v2/partition_pb.d.ts +28 -28
  76. package/{js/metalstack → metalstack}/api/v2/partition_pb.ts +28 -28
  77. package/{js/metalstack → metalstack}/api/v2/predefined_rules_pb.d.ts +30 -24
  78. package/{js/metalstack → metalstack}/api/v2/predefined_rules_pb.js +40 -34
  79. package/{js/metalstack → metalstack}/api/v2/predefined_rules_pb.ts +42 -34
  80. package/{js/metalstack → metalstack}/api/v2/project_pb.d.ts +114 -114
  81. package/{js/metalstack → metalstack}/api/v2/project_pb.ts +114 -114
  82. package/{js/metalstack → metalstack}/api/v2/size_imageconstraint_pb.d.ts +21 -22
  83. package/{js/metalstack → metalstack}/api/v2/size_imageconstraint_pb.ts +21 -22
  84. package/{js/metalstack → metalstack}/api/v2/size_pb.d.ts +29 -29
  85. package/{js/metalstack → metalstack}/api/v2/size_pb.js +6 -6
  86. package/{js/metalstack → metalstack}/api/v2/size_pb.ts +29 -29
  87. package/{js/metalstack → metalstack}/api/v2/size_reservation_pb.d.ts +27 -27
  88. package/{js/metalstack → metalstack}/api/v2/size_reservation_pb.ts +27 -27
  89. package/{js/metalstack → metalstack}/api/v2/switch_pb.d.ts +8 -8
  90. package/{js/metalstack → metalstack}/api/v2/switch_pb.js +1 -1
  91. package/{js/metalstack → metalstack}/api/v2/switch_pb.ts +9 -9
  92. package/{js/metalstack → metalstack}/api/v2/tenant_pb.d.ts +114 -116
  93. package/{js/metalstack → metalstack}/api/v2/tenant_pb.ts +114 -116
  94. package/{js/metalstack → metalstack}/api/v2/token_pb.d.ts +103 -103
  95. package/{js/metalstack → metalstack}/api/v2/token_pb.js +3 -3
  96. package/{js/metalstack → metalstack}/api/v2/token_pb.ts +103 -103
  97. package/{js/metalstack → metalstack}/api/v2/user_pb.d.ts +8 -8
  98. package/{js/metalstack → metalstack}/api/v2/user_pb.ts +8 -8
  99. package/{js/metalstack → metalstack}/api/v2/version_pb.d.ts +5 -5
  100. package/{js/metalstack → metalstack}/api/v2/version_pb.ts +5 -5
  101. package/{js/metalstack → metalstack}/api/v2/vpn_pb.d.ts +6 -6
  102. package/{js/metalstack → metalstack}/api/v2/vpn_pb.ts +6 -6
  103. package/{js/metalstack → metalstack}/infra/v2/bmc_pb.d.ts +15 -17
  104. package/{js/metalstack → metalstack}/infra/v2/bmc_pb.js +1 -1
  105. package/{js/metalstack → metalstack}/infra/v2/bmc_pb.ts +16 -16
  106. package/{js/metalstack → metalstack}/infra/v2/boot_pb.d.ts +36 -36
  107. package/{js/metalstack → metalstack}/infra/v2/boot_pb.ts +36 -36
  108. package/{js/metalstack → metalstack}/infra/v2/component_pb.d.ts +5 -5
  109. package/{js/metalstack → metalstack}/infra/v2/component_pb.ts +5 -5
  110. package/{js/metalstack → metalstack}/infra/v2/event_pb.d.ts +3 -3
  111. package/{js/metalstack → metalstack}/infra/v2/event_pb.ts +3 -3
  112. package/{js/metalstack → metalstack}/infra/v2/switch_pb.d.ts +12 -12
  113. package/{js/metalstack → metalstack}/infra/v2/switch_pb.ts +12 -12
  114. package/package.json +4 -3
  115. package/test-interceptor.d.ts +9 -0
  116. package/test-interceptor.js +33 -0
  117. package/test-interceptor.ts +49 -0
  118. package/tsconfig.json +14 -0
  119. package/LICENSE +0 -21
  120. package/README.md +0 -117
  121. package/js/tsconfig.json +0 -70
  122. /package/{js/buf → buf}/validate/validate_pb.d.ts +0 -0
  123. /package/{js/buf → buf}/validate/validate_pb.js +0 -0
  124. /package/{js/buf → buf}/validate/validate_pb.ts +0 -0
  125. /package/{js/metalstack → metalstack}/admin/v2/audit_pb.js +0 -0
  126. /package/{js/metalstack → metalstack}/admin/v2/component_pb.js +0 -0
  127. /package/{js/metalstack → metalstack}/admin/v2/filesystem_pb.js +0 -0
  128. /package/{js/metalstack → metalstack}/admin/v2/ip_pb.js +0 -0
  129. /package/{js/metalstack → metalstack}/admin/v2/network_pb.js +0 -0
  130. /package/{js/metalstack → metalstack}/admin/v2/partition_pb.js +0 -0
  131. /package/{js/metalstack → metalstack}/admin/v2/project_pb.js +0 -0
  132. /package/{js/metalstack → metalstack}/admin/v2/size_imageconstraint_pb.js +0 -0
  133. /package/{js/metalstack → metalstack}/admin/v2/size_pb.js +0 -0
  134. /package/{js/metalstack → metalstack}/admin/v2/size_reservation_pb.js +0 -0
  135. /package/{js/metalstack → metalstack}/admin/v2/switch_pb.js +0 -0
  136. /package/{js/metalstack → metalstack}/admin/v2/tenant_pb.js +0 -0
  137. /package/{js/metalstack → metalstack}/admin/v2/token_pb.js +0 -0
  138. /package/{js/metalstack → metalstack}/admin/v2/vpn_pb.js +0 -0
  139. /package/{js/metalstack → metalstack}/api/v2/method_pb.js +0 -0
  140. /package/{js/metalstack → metalstack}/api/v2/partition_pb.js +0 -0
  141. /package/{js/metalstack → metalstack}/api/v2/project_pb.js +0 -0
  142. /package/{js/metalstack → metalstack}/api/v2/size_imageconstraint_pb.js +0 -0
  143. /package/{js/metalstack → metalstack}/api/v2/size_reservation_pb.js +0 -0
  144. /package/{js/metalstack → metalstack}/api/v2/tenant_pb.js +0 -0
  145. /package/{js/metalstack → metalstack}/api/v2/user_pb.js +0 -0
  146. /package/{js/metalstack → metalstack}/api/v2/version_pb.js +0 -0
  147. /package/{js/metalstack → metalstack}/api/v2/vpn_pb.js +0 -0
  148. /package/{js/metalstack → metalstack}/infra/v2/boot_pb.js +0 -0
  149. /package/{js/metalstack → metalstack}/infra/v2/component_pb.js +0 -0
  150. /package/{js/metalstack → metalstack}/infra/v2/event_pb.js +0 -0
  151. /package/{js/metalstack → metalstack}/infra/v2/switch_pb.js +0 -0
@@ -6,19 +6,19 @@ import type { Message } from "@bufbuild/protobuf";
6
6
  */
7
7
  export declare const file_metalstack_api_v2_network: GenFile;
8
8
  /**
9
- * NetworkServiceGetRequest
9
+ * NetworkServiceGetRequest.
10
10
  *
11
11
  * @generated from message metalstack.api.v2.NetworkServiceGetRequest
12
12
  */
13
13
  export type NetworkServiceGetRequest = Message<"metalstack.api.v2.NetworkServiceGetRequest"> & {
14
14
  /**
15
- * ID of the network to get
15
+ * ID of the network to get.
16
16
  *
17
17
  * @generated from field: string id = 1;
18
18
  */
19
19
  id: string;
20
20
  /**
21
- * Project of the network
21
+ * Project of the network.
22
22
  *
23
23
  * @generated from field: string project = 2;
24
24
  */
@@ -30,13 +30,13 @@ export type NetworkServiceGetRequest = Message<"metalstack.api.v2.NetworkService
30
30
  */
31
31
  export declare const NetworkServiceGetRequestSchema: GenMessage<NetworkServiceGetRequest>;
32
32
  /**
33
- * NetworkServiceGetResponse
33
+ * NetworkServiceGetResponse.
34
34
  *
35
35
  * @generated from message metalstack.api.v2.NetworkServiceGetResponse
36
36
  */
37
37
  export type NetworkServiceGetResponse = Message<"metalstack.api.v2.NetworkServiceGetResponse"> & {
38
38
  /**
39
- * Network which was requested to get
39
+ * Network which was requested to get.
40
40
  *
41
41
  * @generated from field: metalstack.api.v2.Network network = 1;
42
42
  */
@@ -48,55 +48,55 @@ export type NetworkServiceGetResponse = Message<"metalstack.api.v2.NetworkServic
48
48
  */
49
49
  export declare const NetworkServiceGetResponseSchema: GenMessage<NetworkServiceGetResponse>;
50
50
  /**
51
- * NetworkServiceCreateRequest
51
+ * NetworkServiceCreateRequest.
52
52
  *
53
53
  * @generated from message metalstack.api.v2.NetworkServiceCreateRequest
54
54
  */
55
55
  export type NetworkServiceCreateRequest = Message<"metalstack.api.v2.NetworkServiceCreateRequest"> & {
56
56
  /**
57
- * Project where this network belongs to
57
+ * Project where this network belongs to.
58
58
  *
59
59
  * @generated from field: string project = 1;
60
60
  */
61
61
  project: string;
62
62
  /**
63
- * Name of this network
63
+ * Name of this network.
64
64
  *
65
65
  * @generated from field: optional string name = 2;
66
66
  */
67
67
  name?: string | undefined;
68
68
  /**
69
- * Description of this network
69
+ * Description of this network.
70
70
  *
71
71
  * @generated from field: optional string description = 3;
72
72
  */
73
73
  description?: string | undefined;
74
74
  /**
75
- * Partition where this network will be created
75
+ * Partition where this network will be created.
76
76
  *
77
77
  * @generated from field: optional string partition = 4;
78
78
  */
79
79
  partition?: string | undefined;
80
80
  /**
81
- * Labels on this network
81
+ * Labels on this network.
82
82
  *
83
83
  * @generated from field: metalstack.api.v2.Labels labels = 5;
84
84
  */
85
85
  labels?: Labels | undefined;
86
86
  /**
87
- * Parent Network points to the id of the parent network if any
87
+ * Parent Network points to the id of the parent network if any.
88
88
  *
89
89
  * @generated from field: optional string parent_network = 6;
90
90
  */
91
91
  parentNetwork?: string | undefined;
92
92
  /**
93
- * Length per addressfamily
93
+ * Length per addressfamily.
94
94
  *
95
95
  * @generated from field: optional metalstack.api.v2.ChildPrefixLength length = 7;
96
96
  */
97
97
  length?: ChildPrefixLength | undefined;
98
98
  /**
99
- * AddressFamily to create, defaults to the same as the parent
99
+ * AddressFamily to create, defaults to the same as the parent.
100
100
  *
101
101
  * @generated from field: optional metalstack.api.v2.NetworkAddressFamily address_family = 8;
102
102
  */
@@ -108,13 +108,13 @@ export type NetworkServiceCreateRequest = Message<"metalstack.api.v2.NetworkServ
108
108
  */
109
109
  export declare const NetworkServiceCreateRequestSchema: GenMessage<NetworkServiceCreateRequest>;
110
110
  /**
111
- * NetworkServiceCreateResponse
111
+ * NetworkServiceCreateResponse.
112
112
  *
113
113
  * @generated from message metalstack.api.v2.NetworkServiceCreateResponse
114
114
  */
115
115
  export type NetworkServiceCreateResponse = Message<"metalstack.api.v2.NetworkServiceCreateResponse"> & {
116
116
  /**
117
- * Network is the created network
117
+ * Network is the created network.
118
118
  *
119
119
  * @generated from field: metalstack.api.v2.Network network = 1;
120
120
  */
@@ -126,43 +126,43 @@ export type NetworkServiceCreateResponse = Message<"metalstack.api.v2.NetworkSer
126
126
  */
127
127
  export declare const NetworkServiceCreateResponseSchema: GenMessage<NetworkServiceCreateResponse>;
128
128
  /**
129
- * NetworkServiceUpdateRequest
129
+ * NetworkServiceUpdateRequest.
130
130
  *
131
131
  * @generated from message metalstack.api.v2.NetworkServiceUpdateRequest
132
132
  */
133
133
  export type NetworkServiceUpdateRequest = Message<"metalstack.api.v2.NetworkServiceUpdateRequest"> & {
134
134
  /**
135
- * ID of the network to get
135
+ * ID of the network to get.
136
136
  *
137
137
  * @generated from field: string id = 1;
138
138
  */
139
139
  id: string;
140
140
  /**
141
- * UpdateMeta contains the timestamp and strategy to be used in this update request
141
+ * UpdateMeta contains the timestamp and strategy to be used in this update request.
142
142
  *
143
143
  * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 2;
144
144
  */
145
145
  updateMeta?: UpdateMeta | undefined;
146
146
  /**
147
- * Project of the network
147
+ * Project of the network.
148
148
  *
149
149
  * @generated from field: string project = 3;
150
150
  */
151
151
  project: string;
152
152
  /**
153
- * Name of this network
153
+ * Name of this network.
154
154
  *
155
155
  * @generated from field: optional string name = 4;
156
156
  */
157
157
  name?: string | undefined;
158
158
  /**
159
- * Description of this network
159
+ * Description of this network.
160
160
  *
161
161
  * @generated from field: optional string description = 5;
162
162
  */
163
163
  description?: string | undefined;
164
164
  /**
165
- * Labels on this network
165
+ * Labels on this network.
166
166
  *
167
167
  * @generated from field: optional metalstack.api.v2.UpdateLabels labels = 6;
168
168
  */
@@ -174,13 +174,13 @@ export type NetworkServiceUpdateRequest = Message<"metalstack.api.v2.NetworkServ
174
174
  */
175
175
  export declare const NetworkServiceUpdateRequestSchema: GenMessage<NetworkServiceUpdateRequest>;
176
176
  /**
177
- * NetworkServiceUpdateResponse
177
+ * NetworkServiceUpdateResponse.
178
178
  *
179
179
  * @generated from message metalstack.api.v2.NetworkServiceUpdateResponse
180
180
  */
181
181
  export type NetworkServiceUpdateResponse = Message<"metalstack.api.v2.NetworkServiceUpdateResponse"> & {
182
182
  /**
183
- * Network is the updated network
183
+ * Network is the updated network.
184
184
  *
185
185
  * @generated from field: metalstack.api.v2.Network network = 1;
186
186
  */
@@ -192,19 +192,19 @@ export type NetworkServiceUpdateResponse = Message<"metalstack.api.v2.NetworkSer
192
192
  */
193
193
  export declare const NetworkServiceUpdateResponseSchema: GenMessage<NetworkServiceUpdateResponse>;
194
194
  /**
195
- * NetworkServiceListRequest
195
+ * NetworkServiceListRequest.
196
196
  *
197
197
  * @generated from message metalstack.api.v2.NetworkServiceListRequest
198
198
  */
199
199
  export type NetworkServiceListRequest = Message<"metalstack.api.v2.NetworkServiceListRequest"> & {
200
200
  /**
201
- * Project of the networks to list
201
+ * Project of the networks to list.
202
202
  *
203
203
  * @generated from field: string project = 1;
204
204
  */
205
205
  project: string;
206
206
  /**
207
- * Query which specifies which networks to return
207
+ * Query which specifies which networks to return.
208
208
  *
209
209
  * @generated from field: metalstack.api.v2.NetworkQuery query = 2;
210
210
  */
@@ -216,13 +216,13 @@ export type NetworkServiceListRequest = Message<"metalstack.api.v2.NetworkServic
216
216
  */
217
217
  export declare const NetworkServiceListRequestSchema: GenMessage<NetworkServiceListRequest>;
218
218
  /**
219
- * NetworkServiceListResponse
219
+ * NetworkServiceListResponse.
220
220
  *
221
221
  * @generated from message metalstack.api.v2.NetworkServiceListResponse
222
222
  */
223
223
  export type NetworkServiceListResponse = Message<"metalstack.api.v2.NetworkServiceListResponse"> & {
224
224
  /**
225
- * Networks are the requested networks
225
+ * Networks are the requested networks.
226
226
  *
227
227
  * @generated from field: repeated metalstack.api.v2.Network networks = 1;
228
228
  */
@@ -234,19 +234,19 @@ export type NetworkServiceListResponse = Message<"metalstack.api.v2.NetworkServi
234
234
  */
235
235
  export declare const NetworkServiceListResponseSchema: GenMessage<NetworkServiceListResponse>;
236
236
  /**
237
- * NetworkServiceListRequest
237
+ * NetworkServiceListRequest.
238
238
  *
239
239
  * @generated from message metalstack.api.v2.NetworkServiceListBaseNetworksRequest
240
240
  */
241
241
  export type NetworkServiceListBaseNetworksRequest = Message<"metalstack.api.v2.NetworkServiceListBaseNetworksRequest"> & {
242
242
  /**
243
- * Project of the base networks to list
243
+ * Project of the base networks to list.
244
244
  *
245
245
  * @generated from field: string project = 1;
246
246
  */
247
247
  project: string;
248
248
  /**
249
- * Query which specifies which networks to return
249
+ * Query which specifies which networks to return.
250
250
  *
251
251
  * @generated from field: metalstack.api.v2.NetworkQuery query = 2;
252
252
  */
@@ -258,13 +258,13 @@ export type NetworkServiceListBaseNetworksRequest = Message<"metalstack.api.v2.N
258
258
  */
259
259
  export declare const NetworkServiceListBaseNetworksRequestSchema: GenMessage<NetworkServiceListBaseNetworksRequest>;
260
260
  /**
261
- * NetworkServiceListResponse
261
+ * NetworkServiceListResponse.
262
262
  *
263
263
  * @generated from message metalstack.api.v2.NetworkServiceListBaseNetworksResponse
264
264
  */
265
265
  export type NetworkServiceListBaseNetworksResponse = Message<"metalstack.api.v2.NetworkServiceListBaseNetworksResponse"> & {
266
266
  /**
267
- * Networks are the requested networks
267
+ * Networks are the requested networks.
268
268
  *
269
269
  * @generated from field: repeated metalstack.api.v2.Network networks = 1;
270
270
  */
@@ -276,19 +276,19 @@ export type NetworkServiceListBaseNetworksResponse = Message<"metalstack.api.v2.
276
276
  */
277
277
  export declare const NetworkServiceListBaseNetworksResponseSchema: GenMessage<NetworkServiceListBaseNetworksResponse>;
278
278
  /**
279
- * NetworkServiceDeleteRequest
279
+ * NetworkServiceDeleteRequest.
280
280
  *
281
281
  * @generated from message metalstack.api.v2.NetworkServiceDeleteRequest
282
282
  */
283
283
  export type NetworkServiceDeleteRequest = Message<"metalstack.api.v2.NetworkServiceDeleteRequest"> & {
284
284
  /**
285
- * ID of the network to get
285
+ * ID of the network to get.
286
286
  *
287
287
  * @generated from field: string id = 1;
288
288
  */
289
289
  id: string;
290
290
  /**
291
- * Project of the network
291
+ * Project of the network.
292
292
  *
293
293
  * @generated from field: string project = 2;
294
294
  */
@@ -300,13 +300,13 @@ export type NetworkServiceDeleteRequest = Message<"metalstack.api.v2.NetworkServ
300
300
  */
301
301
  export declare const NetworkServiceDeleteRequestSchema: GenMessage<NetworkServiceDeleteRequest>;
302
302
  /**
303
- * NetworkServiceDeleteResponse
303
+ * NetworkServiceDeleteResponse.
304
304
  *
305
305
  * @generated from message metalstack.api.v2.NetworkServiceDeleteResponse
306
306
  */
307
307
  export type NetworkServiceDeleteResponse = Message<"metalstack.api.v2.NetworkServiceDeleteResponse"> & {
308
308
  /**
309
- * Network is the deleted network
309
+ * Network is the deleted network.
310
310
  *
311
311
  * @generated from field: metalstack.api.v2.Network network = 1;
312
312
  */
@@ -318,86 +318,86 @@ export type NetworkServiceDeleteResponse = Message<"metalstack.api.v2.NetworkSer
318
318
  */
319
319
  export declare const NetworkServiceDeleteResponseSchema: GenMessage<NetworkServiceDeleteResponse>;
320
320
  /**
321
- * Network
321
+ * Network.
322
322
  *
323
323
  * @generated from message metalstack.api.v2.Network
324
324
  */
325
325
  export type Network = Message<"metalstack.api.v2.Network"> & {
326
326
  /**
327
- * Id of this network
327
+ * Id of this network.
328
328
  *
329
329
  * @generated from field: string id = 1;
330
330
  */
331
331
  id: string;
332
332
  /**
333
- * Meta for this network
333
+ * Meta for this network.
334
334
  *
335
335
  * @generated from field: metalstack.api.v2.Meta meta = 2;
336
336
  */
337
337
  meta?: Meta | undefined;
338
338
  /**
339
- * Name of this network
339
+ * Name of this network.
340
340
  *
341
341
  * @generated from field: optional string name = 3;
342
342
  */
343
343
  name?: string | undefined;
344
344
  /**
345
- * Description of this network
345
+ * Description of this network.
346
346
  *
347
347
  * @generated from field: optional string description = 4;
348
348
  */
349
349
  description?: string | undefined;
350
350
  /**
351
- * Partition where this network will be created
351
+ * Partition where this network will be created.
352
352
  *
353
353
  * @generated from field: optional string partition = 5;
354
354
  */
355
355
  partition?: string | undefined;
356
356
  /**
357
- * Project where this network belongs to
357
+ * Project where this network belongs to.
358
358
  *
359
359
  * @generated from field: optional string project = 6;
360
360
  */
361
361
  project?: string | undefined;
362
362
  /**
363
- * Namespace if specified, this network is namespaced and can therefore overlap with others
364
- * Will be equal with project most of the time
363
+ * Namespace if specified, this network is namespaced and can therefore overlap with others.
364
+ * Will be equal with project most of the time.
365
365
  *
366
366
  * @generated from field: optional string namespace = 7;
367
367
  */
368
368
  namespace?: string | undefined;
369
369
  /**
370
- * Prefixes in this network
370
+ * Prefixes in this network.
371
371
  *
372
372
  * @generated from field: repeated string prefixes = 8;
373
373
  */
374
374
  prefixes: string[];
375
375
  /**
376
- * Destination Prefixes in this network
376
+ * Destination Prefixes in this network.
377
377
  *
378
378
  * @generated from field: repeated string destination_prefixes = 9;
379
379
  */
380
380
  destinationPrefixes: string[];
381
381
  /**
382
- * Default Child Prefix length defines the bit length of a child network created per address family, if not specified during the allocate request
382
+ * Default Child Prefix length defines the bit length of a child network created per address family, if not specified during the allocate request.
383
383
  *
384
384
  * @generated from field: metalstack.api.v2.ChildPrefixLength default_child_prefix_length = 10;
385
385
  */
386
386
  defaultChildPrefixLength?: ChildPrefixLength | undefined;
387
387
  /**
388
- * Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length
388
+ * Min Child Prefix length asserts that during child network creation the requested bit length is greater or equal the min child prefix length.
389
389
  *
390
390
  * @generated from field: metalstack.api.v2.ChildPrefixLength min_child_prefix_length = 11;
391
391
  */
392
392
  minChildPrefixLength?: ChildPrefixLength | undefined;
393
393
  /**
394
- * Type of the network
394
+ * Type of the network.
395
395
  *
396
396
  * @generated from field: metalstack.api.v2.NetworkType type = 12;
397
397
  */
398
398
  type: NetworkType;
399
399
  /**
400
- * NATType of this network
400
+ * NATType of this network.
401
401
  *
402
402
  * @generated from field: metalstack.api.v2.NATType nat_type = 13;
403
403
  */
@@ -409,19 +409,19 @@ export type Network = Message<"metalstack.api.v2.Network"> & {
409
409
  */
410
410
  vrf?: number | undefined;
411
411
  /**
412
- * Parent Network points to the id of the parent network if any
412
+ * Parent Network points to the id of the parent network if any.
413
413
  *
414
414
  * @generated from field: optional string parent_network = 15;
415
415
  */
416
416
  parentNetwork?: string | undefined;
417
417
  /**
418
- * AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced
418
+ * AdditionalAnnouncableCidrs will be added to the allow list on the switch which prefixes might be announced.
419
419
  *
420
420
  * @generated from field: repeated string additional_announcable_cidrs = 16;
421
421
  */
422
422
  additionalAnnouncableCidrs: string[];
423
423
  /**
424
- * Consumption of IPs and prefixes in this network
424
+ * Consumption of IPs and prefixes in this network.
425
425
  *
426
426
  * @generated from field: metalstack.api.v2.NetworkConsumption consumption = 17;
427
427
  */
@@ -433,55 +433,55 @@ export type Network = Message<"metalstack.api.v2.Network"> & {
433
433
  */
434
434
  export declare const NetworkSchema: GenMessage<Network>;
435
435
  /**
436
- * NetworkQuery defines which networks to query
436
+ * NetworkQuery defines which networks to query.
437
437
  *
438
438
  * @generated from message metalstack.api.v2.NetworkQuery
439
439
  */
440
440
  export type NetworkQuery = Message<"metalstack.api.v2.NetworkQuery"> & {
441
441
  /**
442
- * Id of the network to query
442
+ * Id of the network to query.
443
443
  *
444
444
  * @generated from field: optional string id = 1;
445
445
  */
446
446
  id?: string | undefined;
447
447
  /**
448
- * Name of this network
448
+ * Name of this network.
449
449
  *
450
450
  * @generated from field: optional string name = 2;
451
451
  */
452
452
  name?: string | undefined;
453
453
  /**
454
- * Description of this network
454
+ * Description of this network.
455
455
  *
456
456
  * @generated from field: optional string description = 3;
457
457
  */
458
458
  description?: string | undefined;
459
459
  /**
460
- * Partition where this network will be created
460
+ * Partition where this network will be created.
461
461
  *
462
462
  * @generated from field: optional string partition = 4;
463
463
  */
464
464
  partition?: string | undefined;
465
465
  /**
466
- * Project where this network belongs to
466
+ * Project where this network belongs to.
467
467
  *
468
468
  * @generated from field: optional string project = 5;
469
469
  */
470
470
  project?: string | undefined;
471
471
  /**
472
- * Namespace where this network belongs to
472
+ * Namespace where this network belongs to.
473
473
  *
474
474
  * @generated from field: optional string namespace = 6;
475
475
  */
476
476
  namespace?: string | undefined;
477
477
  /**
478
- * Prefixes in this network
478
+ * Prefixes in this network.
479
479
  *
480
480
  * @generated from field: repeated string prefixes = 7;
481
481
  */
482
482
  prefixes: string[];
483
483
  /**
484
- * Destination Prefixes in this network
484
+ * Destination Prefixes in this network.
485
485
  *
486
486
  * @generated from field: repeated string destination_prefixes = 8;
487
487
  */
@@ -493,31 +493,31 @@ export type NetworkQuery = Message<"metalstack.api.v2.NetworkQuery"> & {
493
493
  */
494
494
  vrf?: number | undefined;
495
495
  /**
496
- * Parent Network points to the id of the parent network if any
496
+ * Parent Network points to the id of the parent network if any.
497
497
  *
498
498
  * @generated from field: optional string parent_network = 10;
499
499
  */
500
500
  parentNetwork?: string | undefined;
501
501
  /**
502
- * Addressfamily to query
502
+ * Addressfamily to query.
503
503
  *
504
504
  * @generated from field: optional metalstack.api.v2.NetworkAddressFamily address_family = 11;
505
505
  */
506
506
  addressFamily?: NetworkAddressFamily | undefined;
507
507
  /**
508
- * Type of the network to query for
508
+ * Type of the network to query for.
509
509
  *
510
510
  * @generated from field: optional metalstack.api.v2.NetworkType type = 12;
511
511
  */
512
512
  type?: NetworkType | undefined;
513
513
  /**
514
- * NATType configured
514
+ * NATType configured.
515
515
  *
516
516
  * @generated from field: optional metalstack.api.v2.NATType nat_type = 13;
517
517
  */
518
518
  natType?: NATType | undefined;
519
519
  /**
520
- * Labels on this network
520
+ * Labels on this network.
521
521
  *
522
522
  * @generated from field: optional metalstack.api.v2.Labels labels = 14;
523
523
  */
@@ -529,19 +529,19 @@ export type NetworkQuery = Message<"metalstack.api.v2.NetworkQuery"> & {
529
529
  */
530
530
  export declare const NetworkQuerySchema: GenMessage<NetworkQuery>;
531
531
  /**
532
- * ChildPrefixLength
532
+ * ChildPrefixLength.
533
533
  *
534
534
  * @generated from message metalstack.api.v2.ChildPrefixLength
535
535
  */
536
536
  export type ChildPrefixLength = Message<"metalstack.api.v2.ChildPrefixLength"> & {
537
537
  /**
538
- * IPv4 bit length of this network in this addressfamily
538
+ * IPv4 bit length of this network in this addressfamily.
539
539
  *
540
540
  * @generated from field: optional uint32 ipv4 = 1;
541
541
  */
542
542
  ipv4?: number | undefined;
543
543
  /**
544
- * IPv6 bit length of this network in this addressfamily
544
+ * IPv6 bit length of this network in this addressfamily.
545
545
  *
546
546
  * @generated from field: optional uint32 ipv6 = 2;
547
547
  */
@@ -553,19 +553,19 @@ export type ChildPrefixLength = Message<"metalstack.api.v2.ChildPrefixLength"> &
553
553
  */
554
554
  export declare const ChildPrefixLengthSchema: GenMessage<ChildPrefixLength>;
555
555
  /**
556
- * NetworkConsumption contains ip and prefix usage by addressfamily
556
+ * NetworkConsumption contains ip and prefix usage by addressfamily.
557
557
  *
558
558
  * @generated from message metalstack.api.v2.NetworkConsumption
559
559
  */
560
560
  export type NetworkConsumption = Message<"metalstack.api.v2.NetworkConsumption"> & {
561
561
  /**
562
- * IPv4 network usage
562
+ * IPv4 network usage.
563
563
  *
564
564
  * @generated from field: metalstack.api.v2.NetworkUsage ipv4 = 1;
565
565
  */
566
566
  ipv4?: NetworkUsage | undefined;
567
567
  /**
568
- * IPv6 network usage, this can be approximated for high numbers
568
+ * IPv6 network usage, this can be approximated for high numbers.
569
569
  *
570
570
  * @generated from field: metalstack.api.v2.NetworkUsage ipv6 = 2;
571
571
  */
@@ -583,25 +583,25 @@ export declare const NetworkConsumptionSchema: GenMessage<NetworkConsumption>;
583
583
  */
584
584
  export type NetworkUsage = Message<"metalstack.api.v2.NetworkUsage"> & {
585
585
  /**
586
- * the total available IPs
586
+ * the total available IPs.
587
587
  *
588
588
  * @generated from field: uint64 available_ips = 1;
589
589
  */
590
590
  availableIps: bigint;
591
591
  /**
592
- * the total used IPs
592
+ * the total used IPs.
593
593
  *
594
594
  * @generated from field: uint64 used_ips = 2;
595
595
  */
596
596
  usedIps: bigint;
597
597
  /**
598
- * the total available 2-bit prefixes
598
+ * the total available 2-bit prefixes.
599
599
  *
600
600
  * @generated from field: uint64 available_prefixes = 3;
601
601
  */
602
602
  availablePrefixes: bigint;
603
603
  /**
604
- * the total used Prefixes
604
+ * the total used Prefixes.
605
605
  *
606
606
  * @generated from field: uint64 used_prefixes = 4;
607
607
  */
@@ -613,25 +613,25 @@ export type NetworkUsage = Message<"metalstack.api.v2.NetworkUsage"> & {
613
613
  */
614
614
  export declare const NetworkUsageSchema: GenMessage<NetworkUsage>;
615
615
  /**
616
- * NATType defines how and if outgoing traffic is translated
616
+ * NATType defines how and if outgoing traffic is translated.
617
617
  *
618
618
  * @generated from enum metalstack.api.v2.NATType
619
619
  */
620
620
  export declare enum NATType {
621
621
  /**
622
- * NAT_TYPE_UNSPECIFIED indicates a unspecified nat type
622
+ * NAT_TYPE_UNSPECIFIED indicates a unspecified nat type.
623
623
  *
624
624
  * @generated from enum value: NAT_TYPE_UNSPECIFIED = 0;
625
625
  */
626
626
  NAT_TYPE_UNSPECIFIED = 0,
627
627
  /**
628
- * NAT_TYPE_NONE indicates that no nat is configured
628
+ * NAT_TYPE_NONE indicates that no nat is configured.
629
629
  *
630
630
  * @generated from enum value: NAT_TYPE_NONE = 1;
631
631
  */
632
632
  NAT_TYPE_NONE = 1,
633
633
  /**
634
- * NAT_TYPE_IPV4_MASQUERADE masquerade ipv4 behind gateway ip when traffic enters this network
634
+ * NAT_TYPE_IPV4_MASQUERADE masquerade ipv4 behind gateway ip when traffic enters this network.
635
635
  *
636
636
  * @generated from enum value: NAT_TYPE_IPV4_MASQUERADE = 2;
637
637
  */
@@ -642,19 +642,19 @@ export declare enum NATType {
642
642
  */
643
643
  export declare const NATTypeSchema: GenEnum<NATType>;
644
644
  /**
645
- * NetworkType indicates the purpose of the network, it cannot be changed after creation
645
+ * NetworkType indicates the purpose of the network, it cannot be changed after creation.
646
646
  *
647
647
  * @generated from enum metalstack.api.v2.NetworkType
648
648
  */
649
649
  export declare enum NetworkType {
650
650
  /**
651
- * NETWORK_TYPE_UNSPECIFIED indicates a unknown network type
651
+ * NETWORK_TYPE_UNSPECIFIED indicates a unknown network type.
652
652
  *
653
653
  * @generated from enum value: NETWORK_TYPE_UNSPECIFIED = 0;
654
654
  */
655
655
  UNSPECIFIED = 0,
656
656
  /**
657
- * NETWORK_TYPE_EXTERNAL indicates network where multiple projects can allocate ips, it offers connectivity to other external networks
657
+ * NETWORK_TYPE_EXTERNAL indicates network where multiple projects can allocate ips, it offers connectivity to other external networks.
658
658
  * In most cases this is the internet network or a network which offers connectivity to legacy datacenter networks.
659
659
  * If it is not project scoped everyone can allocate Ips in this network, otherwise only from the same project ip allocation is possible.
660
660
  *
@@ -662,22 +662,22 @@ export declare enum NetworkType {
662
662
  */
663
663
  EXTERNAL = 1,
664
664
  /**
665
- * NETWORK_TYPE_UNDERLAY indicates a underlay network
666
- * The underlay network connects all switches and the firewalls to build a EVPN dataplane
665
+ * NETWORK_TYPE_UNDERLAY indicates a underlay network.
666
+ * The underlay network connects all switches and the firewalls to build a EVPN dataplane.
667
667
  * It is not project scoped. Is part of the dataplane and reserved for administrative purposes.
668
668
  *
669
669
  * @generated from enum value: NETWORK_TYPE_UNDERLAY = 2;
670
670
  */
671
671
  UNDERLAY = 2,
672
672
  /**
673
- * NETWORK_TYPE_SUPER indicates a super network which is only used to create child networks
673
+ * NETWORK_TYPE_SUPER indicates a super network which is only used to create child networks.
674
674
  * If the vrf id is given, child networks will inherit this vrf.
675
675
  * If the vrf id is nil in this network, child vrf is taken from the pool.
676
676
  * If the partition is given, child networks inherit the partition.
677
677
  * If the partition is nil, child networks also do not have a partition (i.e. requires vrf is distributed across all partitions).
678
678
  * If the partition is given, only one super network in that partition can be created.
679
679
  * 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).
680
- * For child creation destination prefixes will be inherited
680
+ * For child creation destination prefixes will be inherited.
681
681
  * If this is project scoped, the child project must match, otherwise can be freely specified.
682
682
  *
683
683
  * @generated from enum value: NETWORK_TYPE_SUPER = 3;
@@ -718,31 +718,31 @@ export declare enum NetworkType {
718
718
  */
719
719
  export declare const NetworkTypeSchema: GenEnum<NetworkType>;
720
720
  /**
721
- * NetworkAddressFamily defines the address family of a network
721
+ * NetworkAddressFamily defines the address family of a network.
722
722
  *
723
723
  * @generated from enum metalstack.api.v2.NetworkAddressFamily
724
724
  */
725
725
  export declare enum NetworkAddressFamily {
726
726
  /**
727
- * NETWORK_ADDRESS_FAMILY_UNSPECIFIED is not specified
727
+ * NETWORK_ADDRESS_FAMILY_UNSPECIFIED is not specified.
728
728
  *
729
729
  * @generated from enum value: NETWORK_ADDRESS_FAMILY_UNSPECIFIED = 0;
730
730
  */
731
731
  UNSPECIFIED = 0,
732
732
  /**
733
- * NETWORK_ADDRESS_FAMILY_V4 defines a network with IPv4 address prefixes
733
+ * NETWORK_ADDRESS_FAMILY_V4 defines a network with IPv4 address prefixes.
734
734
  *
735
735
  * @generated from enum value: NETWORK_ADDRESS_FAMILY_V4 = 1;
736
736
  */
737
737
  V4 = 1,
738
738
  /**
739
- * NETWORK_ADDRESS_FAMILY_V6 defines a network with IPv6 address prefixes
739
+ * NETWORK_ADDRESS_FAMILY_V6 defines a network with IPv6 address prefixes.
740
740
  *
741
741
  * @generated from enum value: NETWORK_ADDRESS_FAMILY_V6 = 2;
742
742
  */
743
743
  V6 = 2,
744
744
  /**
745
- * NETWORK_ADDRESS_FAMILY_DUAL_STACK defines a network with both IPv4 and IPv6 address prefixes
745
+ * NETWORK_ADDRESS_FAMILY_DUAL_STACK defines a network with both IPv4 and IPv6 address prefixes.
746
746
  *
747
747
  * @generated from enum value: NETWORK_ADDRESS_FAMILY_DUAL_STACK = 3;
748
748
  */