@metal-stack/api 0.4.4 → 0.5.2

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 +16 -16
  16. package/{js/metalstack → metalstack}/admin/v2/image_pb.ts +16 -16
  17. package/{js/metalstack → metalstack}/admin/v2/ip_pb.d.ts +2 -2
  18. package/{js/metalstack → metalstack}/admin/v2/ip_pb.ts +2 -2
  19. package/{js/metalstack → metalstack}/admin/v2/machine_pb.d.ts +47 -55
  20. package/{js/metalstack → metalstack}/admin/v2/machine_pb.js +1 -1
  21. package/{js/metalstack → metalstack}/admin/v2/machine_pb.ts +48 -55
  22. package/{js/metalstack → metalstack}/admin/v2/network_pb.d.ts +195 -37
  23. package/{js/metalstack → metalstack}/admin/v2/network_pb.js +36 -5
  24. package/{js/metalstack → metalstack}/admin/v2/network_pb.ts +222 -42
  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 +146 -98
  73. package/{js/metalstack → metalstack}/api/v2/network_pb.js +30 -20
  74. package/{js/metalstack → metalstack}/api/v2/network_pb.ts +158 -102
  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/image_pb.js +0 -0
  129. /package/{js/metalstack → metalstack}/admin/v2/ip_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
@@ -7,12 +7,12 @@ import type { Message } from "@bufbuild/protobuf";
7
7
  */
8
8
  export declare const file_metalstack_api_v2_token: GenFile;
9
9
  /**
10
- * Token generates a jwt authentication token to access the api
10
+ * Token generates a jwt authentication token to access the api.
11
11
  *
12
- * There are two different types of tokens, api- and user- tokens
12
+ * There are two different types of tokens, api- and user- tokens.
13
13
  *
14
14
  * A user token is used to authenticate end user requests for example from a cli.
15
- * The configured roles in a user token are expanded in the api server
15
+ * The configured roles in a user token are expanded in the api server.
16
16
  * based on the memberships in other projects and tenants based on the role granted there.
17
17
  * User tokens will never contain permissions.
18
18
  * Permissions are always derived from the tenant and project roles and memberships.
@@ -20,25 +20,25 @@ export declare const file_metalstack_api_v2_token: GenFile;
20
20
  * The api token should be used to authenticate services.
21
21
  * In contrast to a user token, the api token permissions and roles apply as configured during the token create process.
22
22
  *
23
- * Message level validation, can be developed using https://protovalidate.com/playground
23
+ * Message level validation, can be developed using https://protovalidate.com/playground.
24
24
  *
25
25
  * @generated from message metalstack.api.v2.Token
26
26
  */
27
27
  export type Token = Message<"metalstack.api.v2.Token"> & {
28
28
  /**
29
- * Uuid of the jwt token, used to reference it by revoke
29
+ * Uuid of the jwt token, used to reference it by revoke.
30
30
  *
31
31
  * @generated from field: string uuid = 1;
32
32
  */
33
33
  uuid: string;
34
34
  /**
35
- * User who created this token
35
+ * User who created this token.
36
36
  *
37
37
  * @generated from field: string user = 2;
38
38
  */
39
39
  user: string;
40
40
  /**
41
- * Meta for this token
41
+ * Meta for this token.
42
42
  *
43
43
  * @generated from field: metalstack.api.v2.Meta meta = 3;
44
44
  */
@@ -50,31 +50,31 @@ export type Token = Message<"metalstack.api.v2.Token"> & {
50
50
  */
51
51
  description: string;
52
52
  /**
53
- * Permissions is a list of service methods this token can be used for
53
+ * Permissions is a list of service methods this token can be used for.
54
54
  *
55
55
  * @generated from field: repeated metalstack.api.v2.MethodPermission permissions = 5;
56
56
  */
57
57
  permissions: MethodPermission[];
58
58
  /**
59
- * Expires gives the date in the future after which this token can not be used anymore
59
+ * Expires gives the date in the future after which this token can not be used anymore.
60
60
  *
61
61
  * @generated from field: google.protobuf.Timestamp expires = 6;
62
62
  */
63
63
  expires?: Timestamp | undefined;
64
64
  /**
65
- * IssuedAt gives the date when this token was created
65
+ * IssuedAt gives the date when this token was created.
66
66
  *
67
67
  * @generated from field: google.protobuf.Timestamp issued_at = 7;
68
68
  */
69
69
  issuedAt?: Timestamp | undefined;
70
70
  /**
71
- * TokenType describes the type of this token
71
+ * TokenType describes the type of this token.
72
72
  *
73
73
  * @generated from field: metalstack.api.v2.TokenType token_type = 8;
74
74
  */
75
75
  tokenType: TokenType;
76
76
  /**
77
- * ProjectRoles associates a project id with the corresponding role of the token owner
77
+ * ProjectRoles associates a project id with the corresponding role of the token owner.
78
78
  *
79
79
  * @generated from field: map<string, metalstack.api.v2.ProjectRole> project_roles = 9;
80
80
  */
@@ -82,7 +82,7 @@ export type Token = Message<"metalstack.api.v2.Token"> & {
82
82
  [key: string]: ProjectRole;
83
83
  };
84
84
  /**
85
- * TenantRoles associates a tenant id with the corresponding role of the token owner
85
+ * TenantRoles associates a tenant id with the corresponding role of the token owner.
86
86
  *
87
87
  * @generated from field: map<string, metalstack.api.v2.TenantRole> tenant_roles = 10;
88
88
  */
@@ -90,20 +90,20 @@ export type Token = Message<"metalstack.api.v2.Token"> & {
90
90
  [key: string]: TenantRole;
91
91
  };
92
92
  /**
93
- * AdminRole defines the admin role of the token owner
93
+ * AdminRole defines the admin role of the token owner.
94
94
  *
95
95
  * @generated from field: optional metalstack.api.v2.AdminRole admin_role = 11;
96
96
  */
97
97
  adminRole?: AdminRole | undefined;
98
98
  /**
99
- * InfraRole defines the infrastructure role of the token owner
99
+ * InfraRole defines the infrastructure role of the token owner.
100
100
  *
101
101
  * @generated from field: optional metalstack.api.v2.InfraRole infra_role = 12;
102
102
  */
103
103
  infraRole?: InfraRole | undefined;
104
104
  /**
105
- * MachineRoles associates a machine uuid with the corresponding role of the token owner
106
- * TODO: decide if we need this map from machine.uuid->role, we could instead use the subject in the token instead
105
+ * MachineRoles associates a machine uuid with the corresponding role of the token owner.
106
+ * TODO: decide if we need this map from machine.uuid->role, we could instead use the subject in the token instead.
107
107
  *
108
108
  * @generated from field: map<string, metalstack.api.v2.MachineRole> machine_roles = 13;
109
109
  */
@@ -117,31 +117,31 @@ export type Token = Message<"metalstack.api.v2.Token"> & {
117
117
  */
118
118
  export declare const TokenSchema: GenMessage<Token>;
119
119
  /**
120
- * TokenServiceCreateRequest is the request payload to create a token
120
+ * TokenServiceCreateRequest is the request payload to create a token.
121
121
  *
122
122
  * @generated from message metalstack.api.v2.TokenServiceCreateRequest
123
123
  */
124
124
  export type TokenServiceCreateRequest = Message<"metalstack.api.v2.TokenServiceCreateRequest"> & {
125
125
  /**
126
- * Description of the token
126
+ * Description of the token.
127
127
  *
128
128
  * @generated from field: string description = 1;
129
129
  */
130
130
  description: string;
131
131
  /**
132
- * Permissions is a list of service methods this token can be used for
132
+ * Permissions is a list of service methods this token can be used for.
133
133
  *
134
134
  * @generated from field: repeated metalstack.api.v2.PermissionsByVisibility permissions = 2;
135
135
  */
136
136
  permissions: PermissionsByVisibility[];
137
137
  /**
138
- * Expires gives the duration since now, after which this token can not be used anymore
138
+ * Expires gives the duration since now, after which this token can not be used anymore.
139
139
  *
140
140
  * @generated from field: google.protobuf.Duration expires = 3;
141
141
  */
142
142
  expires?: Duration | undefined;
143
143
  /**
144
- * ProjectRoles associates a project id with the corresponding role of the token owner
144
+ * ProjectRoles associates a project id with the corresponding role of the token owner.
145
145
  *
146
146
  * @generated from field: map<string, metalstack.api.v2.ProjectRole> project_roles = 4;
147
147
  */
@@ -149,7 +149,7 @@ export type TokenServiceCreateRequest = Message<"metalstack.api.v2.TokenServiceC
149
149
  [key: string]: ProjectRole;
150
150
  };
151
151
  /**
152
- * TenantRoles associates a tenant id with the corresponding role of the token owner
152
+ * TenantRoles associates a tenant id with the corresponding role of the token owner.
153
153
  *
154
154
  * @generated from field: map<string, metalstack.api.v2.TenantRole> tenant_roles = 5;
155
155
  */
@@ -157,19 +157,19 @@ export type TokenServiceCreateRequest = Message<"metalstack.api.v2.TokenServiceC
157
157
  [key: string]: TenantRole;
158
158
  };
159
159
  /**
160
- * AdminRole defines the admin role of the token owner
160
+ * AdminRole defines the admin role of the token owner.
161
161
  *
162
162
  * @generated from field: optional metalstack.api.v2.AdminRole admin_role = 6;
163
163
  */
164
164
  adminRole?: AdminRole | undefined;
165
165
  /**
166
- * InfraRole defines the infrastructure role of the token owner
166
+ * InfraRole defines the infrastructure role of the token owner.
167
167
  *
168
168
  * @generated from field: optional metalstack.api.v2.InfraRole infra_role = 7;
169
169
  */
170
170
  infraRole?: InfraRole | undefined;
171
171
  /**
172
- * MachineRoles associates a machine uuid with the corresponding role of the token owner
172
+ * MachineRoles associates a machine uuid with the corresponding role of the token owner.
173
173
  *
174
174
  * @generated from field: map<string, metalstack.api.v2.MachineRole> machine_roles = 8;
175
175
  */
@@ -177,7 +177,7 @@ export type TokenServiceCreateRequest = Message<"metalstack.api.v2.TokenServiceC
177
177
  [key: string]: MachineRole;
178
178
  };
179
179
  /**
180
- * Labels on this token
180
+ * Labels on this token.
181
181
  *
182
182
  * @generated from field: metalstack.api.v2.Labels labels = 9;
183
183
  */
@@ -189,24 +189,23 @@ export type TokenServiceCreateRequest = Message<"metalstack.api.v2.TokenServiceC
189
189
  */
190
190
  export declare const TokenServiceCreateRequestSchema: GenMessage<TokenServiceCreateRequest>;
191
191
  /**
192
- * MethodPermission is a mapping from a subject/project to a service method
192
+ * MethodPermission is a mapping from a subject/project to a service method.
193
193
  *
194
194
  * @generated from message metalstack.api.v2.MethodPermission
195
195
  */
196
196
  export type MethodPermission = Message<"metalstack.api.v2.MethodPermission"> & {
197
197
  /**
198
- * Subject maybe either the project or the tenant
199
- * for which the methods should be allowed
198
+ * Subject may be either the project or the tenant for which the methods should be allowed.
200
199
  *
201
- * asterisk (*) can be specified to match any subject
202
- * empty string ("") can be specified for requests that do not require a subject, e.g. partition list
203
- * otherwise either a projectid or a tenant login should be specified
200
+ * Asterisk (*) can be specified to match any subject.
201
+ * Empty string ("") can be specified for requests that do not require a subject, e.g. partition list.
202
+ * Otherwise either a projectid or a tenant login should be specified.
204
203
  *
205
204
  * @generated from field: string subject = 1;
206
205
  */
207
206
  subject: string;
208
207
  /**
209
- * Methods which should be accessible
208
+ * Methods which should be accessible.
210
209
  *
211
210
  * @generated from field: repeated string methods = 2;
212
211
  */
@@ -218,19 +217,19 @@ export type MethodPermission = Message<"metalstack.api.v2.MethodPermission"> & {
218
217
  */
219
218
  export declare const MethodPermissionSchema: GenMessage<MethodPermission>;
220
219
  /**
221
- * PermissionsByVisibility contains method permissions by visibility
220
+ * PermissionsByVisibility contains method permissions by visibility.
222
221
  *
223
222
  * @generated from message metalstack.api.v2.PermissionsByVisibility
224
223
  */
225
224
  export type PermissionsByVisibility = Message<"metalstack.api.v2.PermissionsByVisibility"> & {
226
225
  /**
227
- * Visibility defines the visibility of the requested method permissions
226
+ * Visibility defines the visibility of the requested method permissions.
228
227
  *
229
228
  * @generated from oneof metalstack.api.v2.PermissionsByVisibility.visibility
230
229
  */
231
230
  visibility: {
232
231
  /**
233
- * PublicPermissions carries public method permissions
232
+ * PublicPermissions carries public method permissions.
234
233
  *
235
234
  * @generated from field: metalstack.api.v2.PublicPermissions public = 1;
236
235
  */
@@ -238,7 +237,7 @@ export type PermissionsByVisibility = Message<"metalstack.api.v2.PermissionsByVi
238
237
  case: "public";
239
238
  } | {
240
239
  /**
241
- * SelfPermissions carries self method permissions
240
+ * SelfPermissions carries self method permissions.
242
241
  *
243
242
  * @generated from field: metalstack.api.v2.SelfPermissions self = 2;
244
243
  */
@@ -246,7 +245,7 @@ export type PermissionsByVisibility = Message<"metalstack.api.v2.PermissionsByVi
246
245
  case: "self";
247
246
  } | {
248
247
  /**
249
- * ProjectPermissions carries project method permissions
248
+ * ProjectPermissions carries project method permissions.
250
249
  *
251
250
  * @generated from field: metalstack.api.v2.ProjectPermissions project = 3;
252
251
  */
@@ -254,7 +253,7 @@ export type PermissionsByVisibility = Message<"metalstack.api.v2.PermissionsByVi
254
253
  case: "project";
255
254
  } | {
256
255
  /**
257
- * TenantPermissions carries tenant method permissions
256
+ * TenantPermissions carries tenant method permissions.
258
257
  *
259
258
  * @generated from field: metalstack.api.v2.TenantPermissions tenant = 4;
260
259
  */
@@ -262,7 +261,7 @@ export type PermissionsByVisibility = Message<"metalstack.api.v2.PermissionsByVi
262
261
  case: "tenant";
263
262
  } | {
264
263
  /**
265
- * AdminPermissions carries admin method permissions
264
+ * AdminPermissions carries admin method permissions.
266
265
  *
267
266
  * @generated from field: metalstack.api.v2.AdminPermissions admin = 5;
268
267
  */
@@ -270,7 +269,7 @@ export type PermissionsByVisibility = Message<"metalstack.api.v2.PermissionsByVi
270
269
  case: "admin";
271
270
  } | {
272
271
  /**
273
- * MachinePermissions carries machine method permissions
272
+ * MachinePermissions carries machine method permissions.
274
273
  *
275
274
  * @generated from field: metalstack.api.v2.MachinePermissions machine = 6;
276
275
  */
@@ -278,7 +277,7 @@ export type PermissionsByVisibility = Message<"metalstack.api.v2.PermissionsByVi
278
277
  case: "machine";
279
278
  } | {
280
279
  /**
281
- * InfraPermissions carries infra method permissions
280
+ * InfraPermissions carries infra method permissions.
282
281
  *
283
282
  * @generated from field: metalstack.api.v2.InfraPermissions infra = 7;
284
283
  */
@@ -295,13 +294,13 @@ export type PermissionsByVisibility = Message<"metalstack.api.v2.PermissionsByVi
295
294
  */
296
295
  export declare const PermissionsByVisibilitySchema: GenMessage<PermissionsByVisibility>;
297
296
  /**
298
- * PublicPermissions carries public method permissions
297
+ * PublicPermissions carries public method permissions.
299
298
  *
300
299
  * @generated from message metalstack.api.v2.PublicPermissions
301
300
  */
302
301
  export type PublicPermissions = Message<"metalstack.api.v2.PublicPermissions"> & {
303
302
  /**
304
- * Methods which should be accessible
303
+ * Methods which should be accessible.
305
304
  *
306
305
  * @generated from field: repeated string methods = 2;
307
306
  */
@@ -313,13 +312,13 @@ export type PublicPermissions = Message<"metalstack.api.v2.PublicPermissions"> &
313
312
  */
314
313
  export declare const PublicPermissionsSchema: GenMessage<PublicPermissions>;
315
314
  /**
316
- * SelfPermissions carries self method permissions
315
+ * SelfPermissions carries self method permissions.
317
316
  *
318
317
  * @generated from message metalstack.api.v2.SelfPermissions
319
318
  */
320
319
  export type SelfPermissions = Message<"metalstack.api.v2.SelfPermissions"> & {
321
320
  /**
322
- * Methods which should be accessible
321
+ * Methods which should be accessible.
323
322
  *
324
323
  * @generated from field: repeated string methods = 2;
325
324
  */
@@ -331,19 +330,20 @@ export type SelfPermissions = Message<"metalstack.api.v2.SelfPermissions"> & {
331
330
  */
332
331
  export declare const SelfPermissionsSchema: GenMessage<SelfPermissions>;
333
332
  /**
334
- * ProjectPermissions carries project method permissions
333
+ * ProjectPermissions carries project method permissions.
335
334
  *
336
335
  * @generated from message metalstack.api.v2.ProjectPermissions
337
336
  */
338
337
  export type ProjectPermissions = Message<"metalstack.api.v2.ProjectPermissions"> & {
339
338
  /**
340
- * asterisk (*) can be specified to match any subject
339
+ * Project scope for the permissions.
340
+ * Asterisk (*) can be specified to match any subject.
341
341
  *
342
342
  * @generated from field: string project = 1;
343
343
  */
344
344
  project: string;
345
345
  /**
346
- * Methods which should be accessible
346
+ * Methods which should be accessible.
347
347
  *
348
348
  * @generated from field: repeated string methods = 2;
349
349
  */
@@ -355,20 +355,20 @@ export type ProjectPermissions = Message<"metalstack.api.v2.ProjectPermissions">
355
355
  */
356
356
  export declare const ProjectPermissionsSchema: GenMessage<ProjectPermissions>;
357
357
  /**
358
- * TenantPermissions carries tenant method permissions
358
+ * TenantPermissions carries tenant method permissions.
359
359
  *
360
360
  * @generated from message metalstack.api.v2.TenantPermissions
361
361
  */
362
362
  export type TenantPermissions = Message<"metalstack.api.v2.TenantPermissions"> & {
363
363
  /**
364
- * Login of the tenant
365
- * asterisk (*) can be specified to match any subject
364
+ * Login of the tenant.
365
+ * Asterisk (*) can be specified to match any subject.
366
366
  *
367
367
  * @generated from field: string login = 1;
368
368
  */
369
369
  login: string;
370
370
  /**
371
- * Methods which should be accessible
371
+ * Methods which should be accessible.
372
372
  *
373
373
  * @generated from field: repeated string methods = 2;
374
374
  */
@@ -380,13 +380,13 @@ export type TenantPermissions = Message<"metalstack.api.v2.TenantPermissions"> &
380
380
  */
381
381
  export declare const TenantPermissionsSchema: GenMessage<TenantPermissions>;
382
382
  /**
383
- * AdminPermissions carries admin method permissions
383
+ * AdminPermissions carries admin method permissions.
384
384
  *
385
385
  * @generated from message metalstack.api.v2.AdminPermissions
386
386
  */
387
387
  export type AdminPermissions = Message<"metalstack.api.v2.AdminPermissions"> & {
388
388
  /**
389
- * Methods which should be accessible
389
+ * Methods which should be accessible.
390
390
  *
391
391
  * @generated from field: repeated string methods = 2;
392
392
  */
@@ -398,20 +398,20 @@ export type AdminPermissions = Message<"metalstack.api.v2.AdminPermissions"> & {
398
398
  */
399
399
  export declare const AdminPermissionsSchema: GenMessage<AdminPermissions>;
400
400
  /**
401
- * MachinePermissions carries machine method permissions
401
+ * MachinePermissions carries machine method permissions.
402
402
  *
403
403
  * @generated from message metalstack.api.v2.MachinePermissions
404
404
  */
405
405
  export type MachinePermissions = Message<"metalstack.api.v2.MachinePermissions"> & {
406
406
  /**
407
- * UUID of this machine
408
- * asterisk (*) can be specified to match any subject
407
+ * UUID of this machine.
408
+ * Asterisk (*) can be specified to match any subject.
409
409
  *
410
410
  * @generated from field: string uuid = 1;
411
411
  */
412
412
  uuid: string;
413
413
  /**
414
- * Methods which should be accessible
414
+ * Methods which should be accessible.
415
415
  *
416
416
  * @generated from field: repeated string methods = 2;
417
417
  */
@@ -423,13 +423,13 @@ export type MachinePermissions = Message<"metalstack.api.v2.MachinePermissions">
423
423
  */
424
424
  export declare const MachinePermissionsSchema: GenMessage<MachinePermissions>;
425
425
  /**
426
- * InfraPermissions carries infra method permissions
426
+ * InfraPermissions carries infra method permissions.
427
427
  *
428
428
  * @generated from message metalstack.api.v2.InfraPermissions
429
429
  */
430
430
  export type InfraPermissions = Message<"metalstack.api.v2.InfraPermissions"> & {
431
431
  /**
432
- * Methods which should be accessible
432
+ * Methods which should be accessible.
433
433
  *
434
434
  * @generated from field: repeated string methods = 2;
435
435
  */
@@ -441,19 +441,19 @@ export type InfraPermissions = Message<"metalstack.api.v2.InfraPermissions"> & {
441
441
  */
442
442
  export declare const InfraPermissionsSchema: GenMessage<InfraPermissions>;
443
443
  /**
444
- * TokenServiceCreateResponse is the response payload of a token create request
444
+ * TokenServiceCreateResponse is the response payload of a token create request.
445
445
  *
446
446
  * @generated from message metalstack.api.v2.TokenServiceCreateResponse
447
447
  */
448
448
  export type TokenServiceCreateResponse = Message<"metalstack.api.v2.TokenServiceCreateResponse"> & {
449
449
  /**
450
- * Token which was created
450
+ * Token which was created.
451
451
  *
452
452
  * @generated from field: metalstack.api.v2.Token token = 1;
453
453
  */
454
454
  token?: Token | undefined;
455
455
  /**
456
- * Secret is the body of the JWT token, should be used in API requests as bearer token
456
+ * Secret is the body of the JWT token, should be used in API requests as bearer token.
457
457
  *
458
458
  * @generated from field: string secret = 2;
459
459
  */
@@ -465,13 +465,13 @@ export type TokenServiceCreateResponse = Message<"metalstack.api.v2.TokenService
465
465
  */
466
466
  export declare const TokenServiceCreateResponseSchema: GenMessage<TokenServiceCreateResponse>;
467
467
  /**
468
- * TokenServiceListRequest is the request payload to list tokens
468
+ * TokenServiceListRequest is the request payload to list tokens.
469
469
  *
470
470
  * @generated from message metalstack.api.v2.TokenServiceListRequest
471
471
  */
472
472
  export type TokenServiceListRequest = Message<"metalstack.api.v2.TokenServiceListRequest"> & {
473
473
  /**
474
- * Query for tokens
474
+ * Query for tokens.
475
475
  *
476
476
  * @generated from field: metalstack.api.v2.TokenQuery query = 1;
477
477
  */
@@ -483,13 +483,13 @@ export type TokenServiceListRequest = Message<"metalstack.api.v2.TokenServiceLis
483
483
  */
484
484
  export declare const TokenServiceListRequestSchema: GenMessage<TokenServiceListRequest>;
485
485
  /**
486
- * TokenServiceListResponse is the response payload of a token list request
486
+ * TokenServiceListResponse is the response payload of a token list request.
487
487
  *
488
488
  * @generated from message metalstack.api.v2.TokenServiceListResponse
489
489
  */
490
490
  export type TokenServiceListResponse = Message<"metalstack.api.v2.TokenServiceListResponse"> & {
491
491
  /**
492
- * Tokens is a list of tokens without the secrets
492
+ * Tokens is a list of tokens without the secrets.
493
493
  *
494
494
  * @generated from field: repeated metalstack.api.v2.Token tokens = 1;
495
495
  */
@@ -501,13 +501,13 @@ export type TokenServiceListResponse = Message<"metalstack.api.v2.TokenServiceLi
501
501
  */
502
502
  export declare const TokenServiceListResponseSchema: GenMessage<TokenServiceListResponse>;
503
503
  /**
504
- * TokenServiceRevokeRequest is the request payload of a token revoke request
504
+ * TokenServiceRevokeRequest is the request payload of a token revoke request.
505
505
  *
506
506
  * @generated from message metalstack.api.v2.TokenServiceRevokeRequest
507
507
  */
508
508
  export type TokenServiceRevokeRequest = Message<"metalstack.api.v2.TokenServiceRevokeRequest"> & {
509
509
  /**
510
- * Uuid of the token to revoke
510
+ * Uuid of the token to revoke.
511
511
  *
512
512
  * @generated from field: string uuid = 1;
513
513
  */
@@ -519,7 +519,7 @@ export type TokenServiceRevokeRequest = Message<"metalstack.api.v2.TokenServiceR
519
519
  */
520
520
  export declare const TokenServiceRevokeRequestSchema: GenMessage<TokenServiceRevokeRequest>;
521
521
  /**
522
- * TokenServiceRevokeResponse is the response payload of a token revoke request
522
+ * TokenServiceRevokeResponse is the response payload of a token revoke request.
523
523
  *
524
524
  * @generated from message metalstack.api.v2.TokenServiceRevokeResponse
525
525
  */
@@ -530,20 +530,20 @@ export type TokenServiceRevokeResponse = Message<"metalstack.api.v2.TokenService
530
530
  */
531
531
  export declare const TokenServiceRevokeResponseSchema: GenMessage<TokenServiceRevokeResponse>;
532
532
  /**
533
- * TokenServiceUpdateRequest is the request payload of a token update request
533
+ * TokenServiceUpdateRequest is the request payload of a token update request.
534
534
  *
535
535
  * @generated from message metalstack.api.v2.TokenServiceUpdateRequest
536
536
  */
537
537
  export type TokenServiceUpdateRequest = Message<"metalstack.api.v2.TokenServiceUpdateRequest"> & {
538
538
  /**
539
- * Uuid of the token to update
539
+ * Uuid of the token to update.
540
540
  *
541
541
  * @generated from field: string uuid = 1;
542
542
  */
543
543
  uuid: string;
544
544
  /**
545
- * UpdateMeta contains the timestamp and strategy to be used in this update request
546
- * TokenUpdate is not guarded with optlock in the backend
545
+ * UpdateMeta contains the timestamp and strategy to be used in this update request.
546
+ * TokenUpdate is not guarded with optlock in the backend.
547
547
  *
548
548
  * @generated from field: metalstack.api.v2.UpdateMeta update_meta = 2;
549
549
  */
@@ -555,13 +555,13 @@ export type TokenServiceUpdateRequest = Message<"metalstack.api.v2.TokenServiceU
555
555
  */
556
556
  description?: string | undefined;
557
557
  /**
558
- * Permissions is a list of service methods this token can be used for
558
+ * Permissions is a list of service methods this token can be used for.
559
559
  *
560
560
  * @generated from field: repeated metalstack.api.v2.PermissionsByVisibility permissions = 4;
561
561
  */
562
562
  permissions: PermissionsByVisibility[];
563
563
  /**
564
- * ProjectRoles associates a project id with the corresponding role of the token owner
564
+ * ProjectRoles associates a project id with the corresponding role of the token owner.
565
565
  *
566
566
  * @generated from field: map<string, metalstack.api.v2.ProjectRole> project_roles = 5;
567
567
  */
@@ -569,7 +569,7 @@ export type TokenServiceUpdateRequest = Message<"metalstack.api.v2.TokenServiceU
569
569
  [key: string]: ProjectRole;
570
570
  };
571
571
  /**
572
- * TenantRoles associates a tenant id with the corresponding role of the token owner
572
+ * TenantRoles associates a tenant id with the corresponding role of the token owner.
573
573
  *
574
574
  * @generated from field: map<string, metalstack.api.v2.TenantRole> tenant_roles = 6;
575
575
  */
@@ -577,19 +577,19 @@ export type TokenServiceUpdateRequest = Message<"metalstack.api.v2.TokenServiceU
577
577
  [key: string]: TenantRole;
578
578
  };
579
579
  /**
580
- * AdminRole defines the admin role of the token owner
580
+ * AdminRole defines the admin role of the token owner.
581
581
  *
582
582
  * @generated from field: optional metalstack.api.v2.AdminRole admin_role = 7;
583
583
  */
584
584
  adminRole?: AdminRole | undefined;
585
585
  /**
586
- * InfraRole defines the infrastructure role of the token owner
586
+ * InfraRole defines the infrastructure role of the token owner.
587
587
  *
588
588
  * @generated from field: optional metalstack.api.v2.InfraRole infra_role = 8;
589
589
  */
590
590
  infraRole?: InfraRole | undefined;
591
591
  /**
592
- * MachineRoles associates a machine uuid with the corresponding role of the token owner
592
+ * MachineRoles associates a machine uuid with the corresponding role of the token owner.
593
593
  *
594
594
  * @generated from field: map<string, metalstack.api.v2.MachineRole> machine_roles = 9;
595
595
  */
@@ -597,7 +597,7 @@ export type TokenServiceUpdateRequest = Message<"metalstack.api.v2.TokenServiceU
597
597
  [key: string]: MachineRole;
598
598
  };
599
599
  /**
600
- * Labels on this token
600
+ * Labels on this token.
601
601
  *
602
602
  * @generated from field: metalstack.api.v2.UpdateLabels labels = 10;
603
603
  */
@@ -609,13 +609,13 @@ export type TokenServiceUpdateRequest = Message<"metalstack.api.v2.TokenServiceU
609
609
  */
610
610
  export declare const TokenServiceUpdateRequestSchema: GenMessage<TokenServiceUpdateRequest>;
611
611
  /**
612
- * TokenServiceUpdateResponse is the response payload of a token update request
612
+ * TokenServiceUpdateResponse is the response payload of a token update request.
613
613
  *
614
614
  * @generated from message metalstack.api.v2.TokenServiceUpdateResponse
615
615
  */
616
616
  export type TokenServiceUpdateResponse = Message<"metalstack.api.v2.TokenServiceUpdateResponse"> & {
617
617
  /**
618
- * Token is the updated token
618
+ * Token is the updated token.
619
619
  *
620
620
  * @generated from field: metalstack.api.v2.Token token = 1;
621
621
  */
@@ -627,13 +627,13 @@ export type TokenServiceUpdateResponse = Message<"metalstack.api.v2.TokenService
627
627
  */
628
628
  export declare const TokenServiceUpdateResponseSchema: GenMessage<TokenServiceUpdateResponse>;
629
629
  /**
630
- * TokenServiceGetRequest is the request payload of a token get request
630
+ * TokenServiceGetRequest is the request payload of a token get request.
631
631
  *
632
632
  * @generated from message metalstack.api.v2.TokenServiceGetRequest
633
633
  */
634
634
  export type TokenServiceGetRequest = Message<"metalstack.api.v2.TokenServiceGetRequest"> & {
635
635
  /**
636
- * Uuid of the token to get
636
+ * Uuid of the token to get.
637
637
  *
638
638
  * @generated from field: string uuid = 1;
639
639
  */
@@ -645,13 +645,13 @@ export type TokenServiceGetRequest = Message<"metalstack.api.v2.TokenServiceGetR
645
645
  */
646
646
  export declare const TokenServiceGetRequestSchema: GenMessage<TokenServiceGetRequest>;
647
647
  /**
648
- * TokenServiceGetResponse is the response payload of a token get request
648
+ * TokenServiceGetResponse is the response payload of a token get request.
649
649
  *
650
650
  * @generated from message metalstack.api.v2.TokenServiceGetResponse
651
651
  */
652
652
  export type TokenServiceGetResponse = Message<"metalstack.api.v2.TokenServiceGetResponse"> & {
653
653
  /**
654
- * Token is the token
654
+ * Token is the token.
655
655
  *
656
656
  * @generated from field: metalstack.api.v2.Token token = 1;
657
657
  */
@@ -663,9 +663,9 @@ export type TokenServiceGetResponse = Message<"metalstack.api.v2.TokenServiceGet
663
663
  */
664
664
  export declare const TokenServiceGetResponseSchema: GenMessage<TokenServiceGetResponse>;
665
665
  /**
666
- * TokenServiceRefreshRequest is the request payload of a token refresh request
666
+ * TokenServiceRefreshRequest is the request payload of a token refresh request.
667
667
  * Permissions, Roles and Expiration duration and all other properties are inherited from the calling token.
668
- * The expiration duration will be calculated from the existing token (exp - iat)
668
+ * The expiration duration will be calculated from the existing token (exp - iat).
669
669
  *
670
670
  * @generated from message metalstack.api.v2.TokenServiceRefreshRequest
671
671
  */
@@ -676,19 +676,19 @@ export type TokenServiceRefreshRequest = Message<"metalstack.api.v2.TokenService
676
676
  */
677
677
  export declare const TokenServiceRefreshRequestSchema: GenMessage<TokenServiceRefreshRequest>;
678
678
  /**
679
- * TokenServiceRefreshResponse is the response payload of a token refresh request
679
+ * TokenServiceRefreshResponse is the response payload of a token refresh request.
680
680
  *
681
681
  * @generated from message metalstack.api.v2.TokenServiceRefreshResponse
682
682
  */
683
683
  export type TokenServiceRefreshResponse = Message<"metalstack.api.v2.TokenServiceRefreshResponse"> & {
684
684
  /**
685
- * Token which was refreshed
685
+ * Token which was refreshed.
686
686
  *
687
687
  * @generated from field: metalstack.api.v2.Token token = 1;
688
688
  */
689
689
  token?: Token | undefined;
690
690
  /**
691
- * Secret is the body of the JWT token, should be used in API requests as bearer token
691
+ * Secret is the body of the JWT token, should be used in API requests as bearer token.
692
692
  *
693
693
  * @generated from field: string secret = 2;
694
694
  */
@@ -700,38 +700,38 @@ export type TokenServiceRefreshResponse = Message<"metalstack.api.v2.TokenServic
700
700
  */
701
701
  export declare const TokenServiceRefreshResponseSchema: GenMessage<TokenServiceRefreshResponse>;
702
702
  /**
703
- * TokenQuery is used to search tokens
703
+ * TokenQuery is used to search tokens.
704
704
  *
705
705
  * @generated from message metalstack.api.v2.TokenQuery
706
706
  */
707
707
  export type TokenQuery = Message<"metalstack.api.v2.TokenQuery"> & {
708
708
  /**
709
- * UUID of the token to get
709
+ * UUID of the token to get.
710
710
  *
711
711
  * @generated from field: optional string uuid = 1;
712
712
  */
713
713
  uuid?: string | undefined;
714
714
  /**
715
- * Name of the token user to query
715
+ * Name of the token user to query.
716
716
  * Only useful for admins.
717
717
  *
718
718
  * @generated from field: optional string user = 2;
719
719
  */
720
720
  user?: string | undefined;
721
721
  /**
722
- * Description of the token to query
722
+ * Description of the token to query.
723
723
  *
724
724
  * @generated from field: optional string description = 3;
725
725
  */
726
726
  description?: string | undefined;
727
727
  /**
728
- * Labels lists only tokens containing the given labels
728
+ * Labels lists only tokens containing the given labels.
729
729
  *
730
730
  * @generated from field: optional metalstack.api.v2.Labels labels = 4;
731
731
  */
732
732
  labels?: Labels | undefined;
733
733
  /**
734
- * Token type of the token to query
734
+ * Token type of the token to query.
735
735
  *
736
736
  * @generated from field: optional metalstack.api.v2.TokenType token_type = 5;
737
737
  */
@@ -743,19 +743,19 @@ export type TokenQuery = Message<"metalstack.api.v2.TokenQuery"> & {
743
743
  */
744
744
  export declare const TokenQuerySchema: GenMessage<TokenQuery>;
745
745
  /**
746
- * TokenType specifies different use cases of tokens
746
+ * TokenType specifies different use cases of tokens.
747
747
  *
748
748
  * @generated from enum metalstack.api.v2.TokenType
749
749
  */
750
750
  export declare enum TokenType {
751
751
  /**
752
- * TOKEN_TYPE_UNSPECIFIED is not specified
752
+ * TOKEN_TYPE_UNSPECIFIED is not specified.
753
753
  *
754
754
  * @generated from enum value: TOKEN_TYPE_UNSPECIFIED = 0;
755
755
  */
756
756
  UNSPECIFIED = 0,
757
757
  /**
758
- * TOKEN_TYPE_API is a token for api usage
758
+ * TOKEN_TYPE_API is a token for api usage.
759
759
  *
760
760
  * @generated from enum value: TOKEN_TYPE_API = 1;
761
761
  */