@metal-stack/api 0.0.59 → 0.0.61

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 (126) 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 +25 -25
  20. package/js/metalstack/admin/v2/network_pb.js +1 -1
  21. package/js/metalstack/admin/v2/network_pb.ts +25 -25
  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 +14 -14
  44. package/js/metalstack/admin/v2/tenant_pb.js +1 -1
  45. package/js/metalstack/admin/v2/tenant_pb.ts +14 -14
  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/common_pb.d.ts +2 -2
  56. package/js/metalstack/api/v2/common_pb.js +4 -3
  57. package/js/metalstack/api/v2/common_pb.ts +4 -3
  58. package/js/metalstack/api/v2/filesystem_pb.d.ts +4 -4
  59. package/js/metalstack/api/v2/filesystem_pb.js +2 -2
  60. package/js/metalstack/api/v2/filesystem_pb.ts +5 -5
  61. package/js/metalstack/api/v2/health_pb.d.ts +20 -20
  62. package/js/metalstack/api/v2/health_pb.js +9 -9
  63. package/js/metalstack/api/v2/health_pb.ts +20 -20
  64. package/js/metalstack/api/v2/image_pb.d.ts +10 -4
  65. package/js/metalstack/api/v2/image_pb.js +2 -2
  66. package/js/metalstack/api/v2/image_pb.ts +12 -5
  67. package/js/metalstack/api/v2/ip_pb.d.ts +6 -6
  68. package/js/metalstack/api/v2/ip_pb.js +1 -1
  69. package/js/metalstack/api/v2/ip_pb.ts +6 -6
  70. package/js/metalstack/api/v2/machine_pb.d.ts +35 -58
  71. package/js/metalstack/api/v2/machine_pb.js +33 -38
  72. package/js/metalstack/api/v2/machine_pb.ts +63 -91
  73. package/js/metalstack/api/v2/method_pb.d.ts +11 -11
  74. package/js/metalstack/api/v2/method_pb.js +3 -3
  75. package/js/metalstack/api/v2/method_pb.ts +12 -12
  76. package/js/metalstack/api/v2/network_pb.d.ts +7 -7
  77. package/js/metalstack/api/v2/network_pb.js +1 -1
  78. package/js/metalstack/api/v2/network_pb.ts +7 -7
  79. package/js/metalstack/api/v2/partition_pb.d.ts +3 -3
  80. package/js/metalstack/api/v2/partition_pb.js +2 -2
  81. package/js/metalstack/api/v2/partition_pb.ts +4 -4
  82. package/js/metalstack/api/v2/predefined_rules_pb.d.ts +22 -4
  83. package/js/metalstack/api/v2/predefined_rules_pb.js +23 -5
  84. package/js/metalstack/api/v2/predefined_rules_pb.ts +30 -6
  85. package/js/metalstack/api/v2/project_pb.d.ts +3 -3
  86. package/js/metalstack/api/v2/project_pb.js +2 -2
  87. package/js/metalstack/api/v2/project_pb.ts +4 -4
  88. package/js/metalstack/api/v2/size_imageconstraint_pb.d.ts +2 -2
  89. package/js/metalstack/api/v2/size_imageconstraint_pb.js +2 -2
  90. package/js/metalstack/api/v2/size_imageconstraint_pb.ts +3 -3
  91. package/js/metalstack/api/v2/size_pb.d.ts +3 -3
  92. package/js/metalstack/api/v2/size_pb.js +2 -2
  93. package/js/metalstack/api/v2/size_pb.ts +4 -4
  94. package/js/metalstack/api/v2/size_reservation_pb.d.ts +3 -3
  95. package/js/metalstack/api/v2/size_reservation_pb.js +1 -1
  96. package/js/metalstack/api/v2/size_reservation_pb.ts +3 -3
  97. package/js/metalstack/api/v2/tenant_pb.d.ts +3 -3
  98. package/js/metalstack/api/v2/tenant_pb.js +2 -2
  99. package/js/metalstack/api/v2/tenant_pb.ts +4 -4
  100. package/js/metalstack/api/v2/token_pb.d.ts +7 -7
  101. package/js/metalstack/api/v2/token_pb.js +2 -2
  102. package/js/metalstack/api/v2/token_pb.ts +8 -8
  103. package/js/metalstack/api/v2/user_pb.d.ts +7 -7
  104. package/js/metalstack/api/v2/user_pb.js +2 -2
  105. package/js/metalstack/api/v2/user_pb.ts +8 -8
  106. package/js/metalstack/api/v2/version_pb.d.ts +6 -6
  107. package/js/metalstack/api/v2/version_pb.js +1 -1
  108. package/js/metalstack/api/v2/version_pb.ts +6 -6
  109. package/js/metalstack/api/v2/vpn_pb.d.ts +4 -4
  110. package/js/metalstack/api/v2/vpn_pb.ts +4 -4
  111. package/js/metalstack/infra/v2/bmc_pb.d.ts +19 -19
  112. package/js/metalstack/infra/v2/bmc_pb.js +1 -1
  113. package/js/metalstack/infra/v2/bmc_pb.ts +19 -19
  114. package/js/metalstack/infra/v2/boot_pb.d.ts +7 -7
  115. package/js/metalstack/infra/v2/boot_pb.js +1 -1
  116. package/js/metalstack/infra/v2/boot_pb.ts +7 -7
  117. package/js/metalstack/infra/v2/component_pb.d.ts +7 -10
  118. package/js/metalstack/infra/v2/component_pb.js +1 -1
  119. package/js/metalstack/infra/v2/component_pb.ts +7 -10
  120. package/js/metalstack/infra/v2/event_pb.d.ts +22 -22
  121. package/js/metalstack/infra/v2/event_pb.js +13 -13
  122. package/js/metalstack/infra/v2/event_pb.ts +22 -22
  123. package/js/metalstack/infra/v2/switch_pb.d.ts +22 -22
  124. package/js/metalstack/infra/v2/switch_pb.js +1 -1
  125. package/js/metalstack/infra/v2/switch_pb.ts +22 -22
  126. package/package.json +1 -1
@@ -6,7 +6,7 @@ import type { Message } from "@bufbuild/protobuf";
6
6
  */
7
7
  export declare const file_metalstack_admin_v2_token: GenFile;
8
8
  /**
9
- * TokenServiceListRequest is the request payload for the token list request
9
+ * TokenServiceListRequest is the request payload for listing tokens.
10
10
  *
11
11
  * @generated from message metalstack.admin.v2.TokenServiceListRequest
12
12
  */
@@ -24,13 +24,13 @@ export type TokenServiceListRequest = Message<"metalstack.admin.v2.TokenServiceL
24
24
  */
25
25
  export declare const TokenServiceListRequestSchema: GenMessage<TokenServiceListRequest>;
26
26
  /**
27
- * TokenServiceListResponse is the response payload for the token list request
27
+ * TokenServiceListResponse is the response payload for listing tokens.
28
28
  *
29
29
  * @generated from message metalstack.admin.v2.TokenServiceListResponse
30
30
  */
31
31
  export type TokenServiceListResponse = Message<"metalstack.admin.v2.TokenServiceListResponse"> & {
32
32
  /**
33
- * Tokens is the list of tokens
33
+ * Tokens contains the list of tokens
34
34
  *
35
35
  * @generated from field: repeated metalstack.api.v2.Token tokens = 1;
36
36
  */
@@ -42,7 +42,7 @@ export type TokenServiceListResponse = Message<"metalstack.admin.v2.TokenService
42
42
  */
43
43
  export declare const TokenServiceListResponseSchema: GenMessage<TokenServiceListResponse>;
44
44
  /**
45
- * TokenServiceRevokeRequest is the request payload for the token revoke request
45
+ * TokenServiceRevokeRequest is the request payload for revoking a token.
46
46
  *
47
47
  * @generated from message metalstack.admin.v2.TokenServiceRevokeRequest
48
48
  */
@@ -66,7 +66,7 @@ export type TokenServiceRevokeRequest = Message<"metalstack.admin.v2.TokenServic
66
66
  */
67
67
  export declare const TokenServiceRevokeRequestSchema: GenMessage<TokenServiceRevokeRequest>;
68
68
  /**
69
- * TokenServiceRevokeResponse is the response payload for the token revoke request
69
+ * TokenServiceRevokeResponse is the response payload for revoking a token.
70
70
  *
71
71
  * @generated from message metalstack.admin.v2.TokenServiceRevokeResponse
72
72
  */
@@ -77,7 +77,7 @@ export type TokenServiceRevokeResponse = Message<"metalstack.admin.v2.TokenServi
77
77
  */
78
78
  export declare const TokenServiceRevokeResponseSchema: GenMessage<TokenServiceRevokeResponse>;
79
79
  /**
80
- * TokenServiceCreateRequest is the request payload to create a token
80
+ * TokenServiceCreateRequest is the request payload for creating a token.
81
81
  *
82
82
  * @generated from message metalstack.admin.v2.TokenServiceCreateRequest
83
83
  */
@@ -101,19 +101,19 @@ export type TokenServiceCreateRequest = Message<"metalstack.admin.v2.TokenServic
101
101
  */
102
102
  export declare const TokenServiceCreateRequestSchema: GenMessage<TokenServiceCreateRequest>;
103
103
  /**
104
- * TokenServiceCreateResponse is the response payload of a token create request
104
+ * TokenServiceCreateResponse is the response payload for creating a token.
105
105
  *
106
106
  * @generated from message metalstack.admin.v2.TokenServiceCreateResponse
107
107
  */
108
108
  export type TokenServiceCreateResponse = Message<"metalstack.admin.v2.TokenServiceCreateResponse"> & {
109
109
  /**
110
- * Token which was created
110
+ * Token contains the created token
111
111
  *
112
112
  * @generated from field: metalstack.api.v2.Token token = 1;
113
113
  */
114
114
  token?: Token;
115
115
  /**
116
- * Secret is the body if the jwt token, should be used in api requests as bearer token
116
+ * Secret is the body if the JWT token, should be used in API requests as bearer token
117
117
  *
118
118
  * @generated from field: string secret = 2;
119
119
  */
@@ -125,13 +125,13 @@ export type TokenServiceCreateResponse = Message<"metalstack.admin.v2.TokenServi
125
125
  */
126
126
  export declare const TokenServiceCreateResponseSchema: GenMessage<TokenServiceCreateResponse>;
127
127
  /**
128
- * TokenService serves token related functions
128
+ * TokenService provides token management operations.
129
129
  *
130
130
  * @generated from service metalstack.admin.v2.TokenService
131
131
  */
132
132
  export declare const TokenService: GenService<{
133
133
  /**
134
- * List tokens
134
+ * Returns the list of tokens for a user.
135
135
  *
136
136
  * @generated from rpc metalstack.admin.v2.TokenService.List
137
137
  */
@@ -141,7 +141,7 @@ export declare const TokenService: GenService<{
141
141
  output: typeof TokenServiceListResponseSchema;
142
142
  };
143
143
  /**
144
- * Revoke a token
144
+ * Revokes a token.
145
145
  *
146
146
  * @generated from rpc metalstack.admin.v2.TokenService.Revoke
147
147
  */
@@ -151,7 +151,7 @@ export declare const TokenService: GenService<{
151
151
  output: typeof TokenServiceRevokeResponseSchema;
152
152
  };
153
153
  /**
154
- * Create a token to authenticate against the platform, the secret will be only visible in the response.
154
+ * Creates a token to authenticate against the platform, the secret will be only visible in the response.
155
155
  * This service is suitable to create tokens for other users instead of deriving users from tokens directly.
156
156
  *
157
157
  * @generated from rpc metalstack.admin.v2.TokenService.Create
@@ -40,7 +40,7 @@ export const TokenServiceCreateRequestSchema = /*@__PURE__*/ messageDesc(file_me
40
40
  */
41
41
  export const TokenServiceCreateResponseSchema = /*@__PURE__*/ messageDesc(file_metalstack_admin_v2_token, 5);
42
42
  /**
43
- * TokenService serves token related functions
43
+ * TokenService provides token management operations.
44
44
  *
45
45
  * @generated from service metalstack.admin.v2.TokenService
46
46
  */
@@ -17,7 +17,7 @@ export const file_metalstack_admin_v2_token: GenFile = /*@__PURE__*/
17
17
  fileDesc("Ch9tZXRhbHN0YWNrL2FkbWluL3YyL3Rva2VuLnByb3RvEhNtZXRhbHN0YWNrLmFkbWluLnYyIjUKF1Rva2VuU2VydmljZUxpc3RSZXF1ZXN0EhEKBHVzZXIYASABKAlIAIgBAUIHCgVfdXNlciJEChhUb2tlblNlcnZpY2VMaXN0UmVzcG9uc2USKAoGdG9rZW5zGAEgAygLMhgubWV0YWxzdGFjay5hcGkudjIuVG9rZW4iTQoZVG9rZW5TZXJ2aWNlUmV2b2tlUmVxdWVzdBIWCgR1dWlkGAEgASgJQgi6SAVyA7ABARIYCgR1c2VyGAIgASgJQgq6SAdyBRACGIAEIhwKGlRva2VuU2VydmljZVJldm9rZVJlc3BvbnNlIo8BChlUb2tlblNlcnZpY2VDcmVhdGVSZXF1ZXN0Eh0KBHVzZXIYASABKAlCCrpIB3IFEAIYgARIAIgBARJKChR0b2tlbl9jcmVhdGVfcmVxdWVzdBgCIAEoCzIsLm1ldGFsc3RhY2suYXBpLnYyLlRva2VuU2VydmljZUNyZWF0ZVJlcXVlc3RCBwoFX3VzZXIiVQoaVG9rZW5TZXJ2aWNlQ3JlYXRlUmVzcG9uc2USJwoFdG9rZW4YASABKAsyGC5tZXRhbHN0YWNrLmFwaS52Mi5Ub2tlbhIOCgZzZWNyZXQYAiABKAky3wIKDFRva2VuU2VydmljZRJrCgRMaXN0EiwubWV0YWxzdGFjay5hZG1pbi52Mi5Ub2tlblNlcnZpY2VMaXN0UmVxdWVzdBotLm1ldGFsc3RhY2suYWRtaW4udjIuVG9rZW5TZXJ2aWNlTGlzdFJlc3BvbnNlIgbS8xgCAQIScAoGUmV2b2tlEi4ubWV0YWxzdGFjay5hZG1pbi52Mi5Ub2tlblNlcnZpY2VSZXZva2VSZXF1ZXN0Gi8ubWV0YWxzdGFjay5hZG1pbi52Mi5Ub2tlblNlcnZpY2VSZXZva2VSZXNwb25zZSIF0vMYAQEScAoGQ3JlYXRlEi4ubWV0YWxzdGFjay5hZG1pbi52Mi5Ub2tlblNlcnZpY2VDcmVhdGVSZXF1ZXN0Gi8ubWV0YWxzdGFjay5hZG1pbi52Mi5Ub2tlblNlcnZpY2VDcmVhdGVSZXNwb25zZSIF0vMYAQFCzgEKF2NvbS5tZXRhbHN0YWNrLmFkbWluLnYyQgpUb2tlblByb3RvUAFaOWdpdGh1Yi5jb20vbWV0YWwtc3RhY2svYXBpL2dvL21ldGFsc3RhY2svYWRtaW4vdjI7YWRtaW52MqICA01BWKoCE01ldGFsc3RhY2suQWRtaW4uVjLKAhNNZXRhbHN0YWNrXEFkbWluXFYy4gIfTWV0YWxzdGFja1xBZG1pblxWMlxHUEJNZXRhZGF0YeoCFU1ldGFsc3RhY2s6OkFkbWluOjpWMmIGcHJvdG8z", [file_buf_validate_validate, file_metalstack_api_v2_common, file_metalstack_api_v2_token]);
18
18
 
19
19
  /**
20
- * TokenServiceListRequest is the request payload for the token list request
20
+ * TokenServiceListRequest is the request payload for listing tokens.
21
21
  *
22
22
  * @generated from message metalstack.admin.v2.TokenServiceListRequest
23
23
  */
@@ -38,13 +38,13 @@ export const TokenServiceListRequestSchema: GenMessage<TokenServiceListRequest>
38
38
  messageDesc(file_metalstack_admin_v2_token, 0);
39
39
 
40
40
  /**
41
- * TokenServiceListResponse is the response payload for the token list request
41
+ * TokenServiceListResponse is the response payload for listing tokens.
42
42
  *
43
43
  * @generated from message metalstack.admin.v2.TokenServiceListResponse
44
44
  */
45
45
  export type TokenServiceListResponse = Message<"metalstack.admin.v2.TokenServiceListResponse"> & {
46
46
  /**
47
- * Tokens is the list of tokens
47
+ * Tokens contains the list of tokens
48
48
  *
49
49
  * @generated from field: repeated metalstack.api.v2.Token tokens = 1;
50
50
  */
@@ -59,7 +59,7 @@ export const TokenServiceListResponseSchema: GenMessage<TokenServiceListResponse
59
59
  messageDesc(file_metalstack_admin_v2_token, 1);
60
60
 
61
61
  /**
62
- * TokenServiceRevokeRequest is the request payload for the token revoke request
62
+ * TokenServiceRevokeRequest is the request payload for revoking a token.
63
63
  *
64
64
  * @generated from message metalstack.admin.v2.TokenServiceRevokeRequest
65
65
  */
@@ -87,7 +87,7 @@ export const TokenServiceRevokeRequestSchema: GenMessage<TokenServiceRevokeReque
87
87
  messageDesc(file_metalstack_admin_v2_token, 2);
88
88
 
89
89
  /**
90
- * TokenServiceRevokeResponse is the response payload for the token revoke request
90
+ * TokenServiceRevokeResponse is the response payload for revoking a token.
91
91
  *
92
92
  * @generated from message metalstack.admin.v2.TokenServiceRevokeResponse
93
93
  */
@@ -102,7 +102,7 @@ export const TokenServiceRevokeResponseSchema: GenMessage<TokenServiceRevokeResp
102
102
  messageDesc(file_metalstack_admin_v2_token, 3);
103
103
 
104
104
  /**
105
- * TokenServiceCreateRequest is the request payload to create a token
105
+ * TokenServiceCreateRequest is the request payload for creating a token.
106
106
  *
107
107
  * @generated from message metalstack.admin.v2.TokenServiceCreateRequest
108
108
  */
@@ -130,20 +130,20 @@ export const TokenServiceCreateRequestSchema: GenMessage<TokenServiceCreateReque
130
130
  messageDesc(file_metalstack_admin_v2_token, 4);
131
131
 
132
132
  /**
133
- * TokenServiceCreateResponse is the response payload of a token create request
133
+ * TokenServiceCreateResponse is the response payload for creating a token.
134
134
  *
135
135
  * @generated from message metalstack.admin.v2.TokenServiceCreateResponse
136
136
  */
137
137
  export type TokenServiceCreateResponse = Message<"metalstack.admin.v2.TokenServiceCreateResponse"> & {
138
138
  /**
139
- * Token which was created
139
+ * Token contains the created token
140
140
  *
141
141
  * @generated from field: metalstack.api.v2.Token token = 1;
142
142
  */
143
143
  token?: Token;
144
144
 
145
145
  /**
146
- * Secret is the body if the jwt token, should be used in api requests as bearer token
146
+ * Secret is the body if the JWT token, should be used in API requests as bearer token
147
147
  *
148
148
  * @generated from field: string secret = 2;
149
149
  */
@@ -158,13 +158,13 @@ export const TokenServiceCreateResponseSchema: GenMessage<TokenServiceCreateResp
158
158
  messageDesc(file_metalstack_admin_v2_token, 5);
159
159
 
160
160
  /**
161
- * TokenService serves token related functions
161
+ * TokenService provides token management operations.
162
162
  *
163
163
  * @generated from service metalstack.admin.v2.TokenService
164
164
  */
165
165
  export const TokenService: GenService<{
166
166
  /**
167
- * List tokens
167
+ * Returns the list of tokens for a user.
168
168
  *
169
169
  * @generated from rpc metalstack.admin.v2.TokenService.List
170
170
  */
@@ -174,7 +174,7 @@ export const TokenService: GenService<{
174
174
  output: typeof TokenServiceListResponseSchema;
175
175
  },
176
176
  /**
177
- * Revoke a token
177
+ * Revokes a token.
178
178
  *
179
179
  * @generated from rpc metalstack.admin.v2.TokenService.Revoke
180
180
  */
@@ -184,7 +184,7 @@ export const TokenService: GenService<{
184
184
  output: typeof TokenServiceRevokeResponseSchema;
185
185
  },
186
186
  /**
187
- * Create a token to authenticate against the platform, the secret will be only visible in the response.
187
+ * Creates a token to authenticate against the platform, the secret will be only visible in the response.
188
188
  * This service is suitable to create tokens for other users instead of deriving users from tokens directly.
189
189
  *
190
190
  * @generated from rpc metalstack.admin.v2.TokenService.Create
@@ -7,32 +7,32 @@ import type { Message } from "@bufbuild/protobuf";
7
7
  */
8
8
  export declare const file_metalstack_admin_v2_vpn: GenFile;
9
9
  /**
10
- * VPNServiceAuthKeyRequest is the request payload for a vpn authkey request.
10
+ * VPNServiceAuthKeyRequest is the request payload for generating a VPN authentication key.
11
11
  *
12
12
  * @generated from message metalstack.admin.v2.VPNServiceAuthKeyRequest
13
13
  */
14
14
  export type VPNServiceAuthKeyRequest = Message<"metalstack.admin.v2.VPNServiceAuthKeyRequest"> & {
15
15
  /**
16
- * Project for which a vpn authkey should be generated.
16
+ * Project for which a VPN authentication key should be generated
17
17
  *
18
18
  * @generated from field: string project = 1;
19
19
  */
20
20
  project: string;
21
21
  /**
22
- * Ephemeral defines if the authkey should be ephemeral.
22
+ * Ephemeral defines if the authentication key should be ephemeral
23
23
  *
24
24
  * @generated from field: bool ephemeral = 2;
25
25
  */
26
26
  ephemeral: boolean;
27
27
  /**
28
- * Expires defines the duration after which the authkey expires.
28
+ * Expires defines the duration after which the authentication key expires
29
29
  *
30
30
  * @generated from field: google.protobuf.Duration expires = 3;
31
31
  */
32
32
  expires?: Duration;
33
33
  /**
34
- * Reason must be provided why access to the vpn is requested
35
- * reason is only forwarded to a audit sink
34
+ * Reason must be provided why access to the VPN is requested
35
+ * Reason is only forwarded to an audit sink
36
36
  *
37
37
  * @generated from field: string reason = 4;
38
38
  */
@@ -44,38 +44,38 @@ export type VPNServiceAuthKeyRequest = Message<"metalstack.admin.v2.VPNServiceAu
44
44
  */
45
45
  export declare const VPNServiceAuthKeyRequestSchema: GenMessage<VPNServiceAuthKeyRequest>;
46
46
  /**
47
- * VPNServiceAuthKeyResponse is the request payload for a authkey response
47
+ * VPNServiceAuthKeyResponse is the response payload for generating a VPN authentication key.
48
48
  *
49
49
  * @generated from message metalstack.admin.v2.VPNServiceAuthKeyResponse
50
50
  */
51
51
  export type VPNServiceAuthKeyResponse = Message<"metalstack.admin.v2.VPNServiceAuthKeyResponse"> & {
52
52
  /**
53
- * Address is the address of the vpn control plane.
53
+ * Address is the address of the VPN control plane
54
54
  *
55
55
  * @generated from field: string address = 1;
56
56
  */
57
57
  address: string;
58
58
  /**
59
- * AuthKey is the key to connect to the vpn at the given address.
60
- * This key can only be seen once.
59
+ * AuthKey is the key to connect to the VPN at the given address
60
+ * This key can only be seen once
61
61
  *
62
62
  * @generated from field: string auth_key = 2;
63
63
  */
64
64
  authKey: string;
65
65
  /**
66
- * Ephemeral defines if the authkey should be ephemeral.
66
+ * Ephemeral defines if the authentication key should be ephemeral
67
67
  *
68
68
  * @generated from field: bool ephemeral = 3;
69
69
  */
70
70
  ephemeral: boolean;
71
71
  /**
72
- * ExpiresAt this key cannot be used after this timestamp.
72
+ * ExpiresAt this key cannot be used after this timestamp
73
73
  *
74
74
  * @generated from field: google.protobuf.Timestamp expires_at = 4;
75
75
  */
76
76
  expiresAt?: Timestamp;
77
77
  /**
78
- * CreatedAt this key was created at this timestamp.
78
+ * CreatedAt this key was created at this timestamp
79
79
  *
80
80
  * @generated from field: google.protobuf.Timestamp created_at = 5;
81
81
  */
@@ -87,13 +87,13 @@ export type VPNServiceAuthKeyResponse = Message<"metalstack.admin.v2.VPNServiceA
87
87
  */
88
88
  export declare const VPNServiceAuthKeyResponseSchema: GenMessage<VPNServiceAuthKeyResponse>;
89
89
  /**
90
- * VPNServiceListNodesRequest is the request payload for a vpn list nodes request
90
+ * VPNServiceListNodesRequest is the request payload for listing VPN nodes.
91
91
  *
92
92
  * @generated from message metalstack.admin.v2.VPNServiceListNodesRequest
93
93
  */
94
94
  export type VPNServiceListNodesRequest = Message<"metalstack.admin.v2.VPNServiceListNodesRequest"> & {
95
95
  /**
96
- * Project if given only nodes of this user are returned
96
+ * Project filters nodes by this project
97
97
  *
98
98
  * @generated from field: optional string project = 1;
99
99
  */
@@ -105,13 +105,13 @@ export type VPNServiceListNodesRequest = Message<"metalstack.admin.v2.VPNService
105
105
  */
106
106
  export declare const VPNServiceListNodesRequestSchema: GenMessage<VPNServiceListNodesRequest>;
107
107
  /**
108
- * VPNServiceListNodesResponse is the response payload for a vpn list nodes request
108
+ * VPNServiceListNodesResponse is the response payload for listing VPN nodes.
109
109
  *
110
110
  * @generated from message metalstack.admin.v2.VPNServiceListNodesResponse
111
111
  */
112
112
  export type VPNServiceListNodesResponse = Message<"metalstack.admin.v2.VPNServiceListNodesResponse"> & {
113
113
  /**
114
- * Nodes connected to the vpn
114
+ * Nodes connected to the VPN
115
115
  *
116
116
  * @generated from field: repeated metalstack.api.v2.VPNNode nodes = 1;
117
117
  */
@@ -123,13 +123,13 @@ export type VPNServiceListNodesResponse = Message<"metalstack.admin.v2.VPNServic
123
123
  */
124
124
  export declare const VPNServiceListNodesResponseSchema: GenMessage<VPNServiceListNodesResponse>;
125
125
  /**
126
- * VPNService serves vpn related functions
126
+ * VPNService provides VPN management operations.
127
127
  *
128
128
  * @generated from service metalstack.admin.v2.VPNService
129
129
  */
130
130
  export declare const VPNService: GenService<{
131
131
  /**
132
- * AuthKey generates a authkey for a project to join a machine to the project vpn
132
+ * GenerateAuthKey generates an authentication key for a project to join a machine to the project VPN.
133
133
  *
134
134
  * @generated from rpc metalstack.admin.v2.VPNService.AuthKey
135
135
  */
@@ -139,7 +139,7 @@ export declare const VPNService: GenService<{
139
139
  output: typeof VPNServiceAuthKeyResponseSchema;
140
140
  };
141
141
  /**
142
- * ListNodes returns a list of machines actually connected to the vpn
142
+ * Returns the list of machines connected to the VPN.
143
143
  *
144
144
  * @generated from rpc metalstack.admin.v2.VPNService.ListNodes
145
145
  */
@@ -31,7 +31,7 @@ export const VPNServiceListNodesRequestSchema = /*@__PURE__*/ messageDesc(file_m
31
31
  */
32
32
  export const VPNServiceListNodesResponseSchema = /*@__PURE__*/ messageDesc(file_metalstack_admin_v2_vpn, 3);
33
33
  /**
34
- * VPNService serves vpn related functions
34
+ * VPNService provides VPN management operations.
35
35
  *
36
36
  * @generated from service metalstack.admin.v2.VPNService
37
37
  */
@@ -19,35 +19,35 @@ export const file_metalstack_admin_v2_vpn: GenFile = /*@__PURE__*/
19
19
  fileDesc("Ch1tZXRhbHN0YWNrL2FkbWluL3YyL3Zwbi5wcm90bxITbWV0YWxzdGFjay5hZG1pbi52MiKQAQoYVlBOU2VydmljZUF1dGhLZXlSZXF1ZXN0EhkKB3Byb2plY3QYASABKAlCCLpIBXIDsAEBEhEKCWVwaGVtZXJhbBgCIAEoCBIqCgdleHBpcmVzGAMgASgLMhkuZ29vZ2xlLnByb3RvYnVmLkR1cmF0aW9uEhoKBnJlYXNvbhgEIAEoCUIKukgHcgUQChiABCKxAQoZVlBOU2VydmljZUF1dGhLZXlSZXNwb25zZRIPCgdhZGRyZXNzGAEgASgJEhAKCGF1dGhfa2V5GAIgASgJEhEKCWVwaGVtZXJhbBgDIAEoCBIuCgpleHBpcmVzX2F0GAQgASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcBIuCgpjcmVhdGVkX2F0GAUgASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcCI+ChpWUE5TZXJ2aWNlTGlzdE5vZGVzUmVxdWVzdBIUCgdwcm9qZWN0GAEgASgJSACIAQFCCgoIX3Byb2plY3QiSAobVlBOU2VydmljZUxpc3ROb2Rlc1Jlc3BvbnNlEikKBW5vZGVzGAEgAygLMhoubWV0YWxzdGFjay5hcGkudjIuVlBOTm9kZTL1AQoKVlBOU2VydmljZRJvCgdBdXRoS2V5Ei0ubWV0YWxzdGFjay5hZG1pbi52Mi5WUE5TZXJ2aWNlQXV0aEtleVJlcXVlc3QaLi5tZXRhbHN0YWNrLmFkbWluLnYyLlZQTlNlcnZpY2VBdXRoS2V5UmVzcG9uc2UiBdLzGAEBEnYKCUxpc3ROb2RlcxIvLm1ldGFsc3RhY2suYWRtaW4udjIuVlBOU2VydmljZUxpc3ROb2Rlc1JlcXVlc3QaMC5tZXRhbHN0YWNrLmFkbWluLnYyLlZQTlNlcnZpY2VMaXN0Tm9kZXNSZXNwb25zZSIG0vMYAgECQswBChdjb20ubWV0YWxzdGFjay5hZG1pbi52MkIIVnBuUHJvdG9QAVo5Z2l0aHViLmNvbS9tZXRhbC1zdGFjay9hcGkvZ28vbWV0YWxzdGFjay9hZG1pbi92MjthZG1pbnYyogIDTUFYqgITTWV0YWxzdGFjay5BZG1pbi5WMsoCE01ldGFsc3RhY2tcQWRtaW5cVjLiAh9NZXRhbHN0YWNrXEFkbWluXFYyXEdQQk1ldGFkYXRh6gIVTWV0YWxzdGFjazo6QWRtaW46OlYyYgZwcm90bzM", [file_buf_validate_validate, file_google_protobuf_duration, file_google_protobuf_timestamp, file_metalstack_api_v2_common, file_metalstack_api_v2_vpn]);
20
20
 
21
21
  /**
22
- * VPNServiceAuthKeyRequest is the request payload for a vpn authkey request.
22
+ * VPNServiceAuthKeyRequest is the request payload for generating a VPN authentication key.
23
23
  *
24
24
  * @generated from message metalstack.admin.v2.VPNServiceAuthKeyRequest
25
25
  */
26
26
  export type VPNServiceAuthKeyRequest = Message<"metalstack.admin.v2.VPNServiceAuthKeyRequest"> & {
27
27
  /**
28
- * Project for which a vpn authkey should be generated.
28
+ * Project for which a VPN authentication key should be generated
29
29
  *
30
30
  * @generated from field: string project = 1;
31
31
  */
32
32
  project: string;
33
33
 
34
34
  /**
35
- * Ephemeral defines if the authkey should be ephemeral.
35
+ * Ephemeral defines if the authentication key should be ephemeral
36
36
  *
37
37
  * @generated from field: bool ephemeral = 2;
38
38
  */
39
39
  ephemeral: boolean;
40
40
 
41
41
  /**
42
- * Expires defines the duration after which the authkey expires.
42
+ * Expires defines the duration after which the authentication key expires
43
43
  *
44
44
  * @generated from field: google.protobuf.Duration expires = 3;
45
45
  */
46
46
  expires?: Duration;
47
47
 
48
48
  /**
49
- * Reason must be provided why access to the vpn is requested
50
- * reason is only forwarded to a audit sink
49
+ * Reason must be provided why access to the VPN is requested
50
+ * Reason is only forwarded to an audit sink
51
51
  *
52
52
  * @generated from field: string reason = 4;
53
53
  */
@@ -62,42 +62,42 @@ export const VPNServiceAuthKeyRequestSchema: GenMessage<VPNServiceAuthKeyRequest
62
62
  messageDesc(file_metalstack_admin_v2_vpn, 0);
63
63
 
64
64
  /**
65
- * VPNServiceAuthKeyResponse is the request payload for a authkey response
65
+ * VPNServiceAuthKeyResponse is the response payload for generating a VPN authentication key.
66
66
  *
67
67
  * @generated from message metalstack.admin.v2.VPNServiceAuthKeyResponse
68
68
  */
69
69
  export type VPNServiceAuthKeyResponse = Message<"metalstack.admin.v2.VPNServiceAuthKeyResponse"> & {
70
70
  /**
71
- * Address is the address of the vpn control plane.
71
+ * Address is the address of the VPN control plane
72
72
  *
73
73
  * @generated from field: string address = 1;
74
74
  */
75
75
  address: string;
76
76
 
77
77
  /**
78
- * AuthKey is the key to connect to the vpn at the given address.
79
- * This key can only be seen once.
78
+ * AuthKey is the key to connect to the VPN at the given address
79
+ * This key can only be seen once
80
80
  *
81
81
  * @generated from field: string auth_key = 2;
82
82
  */
83
83
  authKey: string;
84
84
 
85
85
  /**
86
- * Ephemeral defines if the authkey should be ephemeral.
86
+ * Ephemeral defines if the authentication key should be ephemeral
87
87
  *
88
88
  * @generated from field: bool ephemeral = 3;
89
89
  */
90
90
  ephemeral: boolean;
91
91
 
92
92
  /**
93
- * ExpiresAt this key cannot be used after this timestamp.
93
+ * ExpiresAt this key cannot be used after this timestamp
94
94
  *
95
95
  * @generated from field: google.protobuf.Timestamp expires_at = 4;
96
96
  */
97
97
  expiresAt?: Timestamp;
98
98
 
99
99
  /**
100
- * CreatedAt this key was created at this timestamp.
100
+ * CreatedAt this key was created at this timestamp
101
101
  *
102
102
  * @generated from field: google.protobuf.Timestamp created_at = 5;
103
103
  */
@@ -112,13 +112,13 @@ export const VPNServiceAuthKeyResponseSchema: GenMessage<VPNServiceAuthKeyRespon
112
112
  messageDesc(file_metalstack_admin_v2_vpn, 1);
113
113
 
114
114
  /**
115
- * VPNServiceListNodesRequest is the request payload for a vpn list nodes request
115
+ * VPNServiceListNodesRequest is the request payload for listing VPN nodes.
116
116
  *
117
117
  * @generated from message metalstack.admin.v2.VPNServiceListNodesRequest
118
118
  */
119
119
  export type VPNServiceListNodesRequest = Message<"metalstack.admin.v2.VPNServiceListNodesRequest"> & {
120
120
  /**
121
- * Project if given only nodes of this user are returned
121
+ * Project filters nodes by this project
122
122
  *
123
123
  * @generated from field: optional string project = 1;
124
124
  */
@@ -133,13 +133,13 @@ export const VPNServiceListNodesRequestSchema: GenMessage<VPNServiceListNodesReq
133
133
  messageDesc(file_metalstack_admin_v2_vpn, 2);
134
134
 
135
135
  /**
136
- * VPNServiceListNodesResponse is the response payload for a vpn list nodes request
136
+ * VPNServiceListNodesResponse is the response payload for listing VPN nodes.
137
137
  *
138
138
  * @generated from message metalstack.admin.v2.VPNServiceListNodesResponse
139
139
  */
140
140
  export type VPNServiceListNodesResponse = Message<"metalstack.admin.v2.VPNServiceListNodesResponse"> & {
141
141
  /**
142
- * Nodes connected to the vpn
142
+ * Nodes connected to the VPN
143
143
  *
144
144
  * @generated from field: repeated metalstack.api.v2.VPNNode nodes = 1;
145
145
  */
@@ -154,13 +154,13 @@ export const VPNServiceListNodesResponseSchema: GenMessage<VPNServiceListNodesRe
154
154
  messageDesc(file_metalstack_admin_v2_vpn, 3);
155
155
 
156
156
  /**
157
- * VPNService serves vpn related functions
157
+ * VPNService provides VPN management operations.
158
158
  *
159
159
  * @generated from service metalstack.admin.v2.VPNService
160
160
  */
161
161
  export const VPNService: GenService<{
162
162
  /**
163
- * AuthKey generates a authkey for a project to join a machine to the project vpn
163
+ * GenerateAuthKey generates an authentication key for a project to join a machine to the project VPN.
164
164
  *
165
165
  * @generated from rpc metalstack.admin.v2.VPNService.AuthKey
166
166
  */
@@ -170,7 +170,7 @@ export const VPNService: GenService<{
170
170
  output: typeof VPNServiceAuthKeyResponseSchema;
171
171
  },
172
172
  /**
173
- * ListNodes returns a list of machines actually connected to the vpn
173
+ * Returns the list of machines connected to the VPN.
174
174
  *
175
175
  * @generated from rpc metalstack.admin.v2.VPNService.ListNodes
176
176
  */
@@ -6,7 +6,7 @@ import type { Message } from "@bufbuild/protobuf";
6
6
  */
7
7
  export declare const file_metalstack_api_v2_audit: GenFile;
8
8
  /**
9
- * AuditTrace is an audit trace
9
+ * AuditTrace is an audit trace.
10
10
  *
11
11
  * @generated from message metalstack.api.v2.AuditTrace
12
12
  */
@@ -18,49 +18,49 @@ export type AuditTrace = Message<"metalstack.api.v2.AuditTrace"> & {
18
18
  */
19
19
  uuid: string;
20
20
  /**
21
- * Timestamp is the timestamp when the request arrived at the api
21
+ * Timestamp is the timestamp when the request arrived at the API
22
22
  *
23
23
  * @generated from field: google.protobuf.Timestamp timestamp = 2;
24
24
  */
25
25
  timestamp?: Timestamp;
26
26
  /**
27
- * User is the login user who called the api method
27
+ * User is the login user who called the API method
28
28
  *
29
29
  * @generated from field: string user = 3;
30
30
  */
31
31
  user: string;
32
32
  /**
33
- * Tenant is the tenant targeted by the api call
33
+ * Tenant is the tenant targeted by the API call
34
34
  *
35
35
  * @generated from field: string tenant = 4;
36
36
  */
37
37
  tenant: string;
38
38
  /**
39
- * Project is the project targeted by the api call
39
+ * Project is the project targeted by the API call
40
40
  *
41
41
  * @generated from field: optional string project = 5;
42
42
  */
43
43
  project?: string;
44
44
  /**
45
- * Method is the api method that was called
45
+ * Method is the API method that was called
46
46
  *
47
47
  * @generated from field: string method = 6;
48
48
  */
49
49
  method: string;
50
50
  /**
51
- * Body is the payload of the api call. In the request phase this contains the payload sent by the client, in the request phase it contains the payload returned by the api server
51
+ * Body is the payload of the API call. In the request phase this contains the payload sent by the client, in the response phase it contains the payload returned by the API server
52
52
  *
53
53
  * @generated from field: optional string body = 7;
54
54
  */
55
55
  body?: string;
56
56
  /**
57
- * Source IP contains the source ip address of the api call
57
+ * SourceIP contains the source IP address of the API call
58
58
  *
59
59
  * @generated from field: string source_ip = 8;
60
60
  */
61
61
  sourceIp: string;
62
62
  /**
63
- * Result Code is a status code describing the result of the api call. It is set for traces in the response phase and contains official gRPC status codes
63
+ * ResultCode is a status code describing the result of the API call. It is set for traces in the response phase and contains official gRPC status codes
64
64
  *
65
65
  * @generated from field: optional int32 result_code = 9;
66
66
  */
@@ -246,7 +246,7 @@ export type AuditServiceGetResponse = Message<"metalstack.api.v2.AuditServiceGet
246
246
  */
247
247
  export declare const AuditServiceGetResponseSchema: GenMessage<AuditServiceGetResponse>;
248
248
  /**
249
- * AuditPhase specifies phase of an audit trace
249
+ * AuditPhase specifies the phase of an audit trace.
250
250
  *
251
251
  * @generated from enum metalstack.api.v2.AuditPhase
252
252
  */
@@ -264,7 +264,7 @@ export declare enum AuditPhase {
264
264
  */
265
265
  REQUEST = 1,
266
266
  /**
267
- * AUDIT_PHASE_REQUEST defines an audit trace in the response phase
267
+ * AUDIT_PHASE_RESPONSE defines an audit trace in the response phase
268
268
  *
269
269
  * @generated from enum value: AUDIT_PHASE_RESPONSE = 2;
270
270
  */
@@ -275,13 +275,13 @@ export declare enum AuditPhase {
275
275
  */
276
276
  export declare const AuditPhaseSchema: GenEnum<AuditPhase>;
277
277
  /**
278
- * AuditService serves audit related functions
278
+ * AuditService provides audit logging operations.
279
279
  *
280
280
  * @generated from service metalstack.api.v2.AuditService
281
281
  */
282
282
  export declare const AuditService: GenService<{
283
283
  /**
284
- * Get an audit trace
284
+ * Returns the audit trace with the specified UUID.
285
285
  *
286
286
  * @generated from rpc metalstack.api.v2.AuditService.Get
287
287
  */
@@ -291,7 +291,7 @@ export declare const AuditService: GenService<{
291
291
  output: typeof AuditServiceGetResponseSchema;
292
292
  };
293
293
  /**
294
- * List audit traces
294
+ * Returns the list of audit traces.
295
295
  *
296
296
  * @generated from rpc metalstack.api.v2.AuditService.List
297
297
  */
@@ -41,7 +41,7 @@ export const AuditServiceGetRequestSchema = /*@__PURE__*/ messageDesc(file_metal
41
41
  */
42
42
  export const AuditServiceGetResponseSchema = /*@__PURE__*/ messageDesc(file_metalstack_api_v2_audit, 5);
43
43
  /**
44
- * AuditPhase specifies phase of an audit trace
44
+ * AuditPhase specifies the phase of an audit trace.
45
45
  *
46
46
  * @generated from enum metalstack.api.v2.AuditPhase
47
47
  */
@@ -60,7 +60,7 @@ export var AuditPhase;
60
60
  */
61
61
  AuditPhase[AuditPhase["REQUEST"] = 1] = "REQUEST";
62
62
  /**
63
- * AUDIT_PHASE_REQUEST defines an audit trace in the response phase
63
+ * AUDIT_PHASE_RESPONSE defines an audit trace in the response phase
64
64
  *
65
65
  * @generated from enum value: AUDIT_PHASE_RESPONSE = 2;
66
66
  */
@@ -71,7 +71,7 @@ export var AuditPhase;
71
71
  */
72
72
  export const AuditPhaseSchema = /*@__PURE__*/ enumDesc(file_metalstack_api_v2_audit, 0);
73
73
  /**
74
- * AuditService serves audit related functions
74
+ * AuditService provides audit logging operations.
75
75
  *
76
76
  * @generated from service metalstack.api.v2.AuditService
77
77
  */