@metal-stack/api 0.0.58 → 0.0.60

package/js/metalstack/admin/v2/tenant_pb.ts

@@ -16,23 +16,23 @@ import type { Message } from "@bufbuild/protobuf";
  * Describes the file metalstack/admin/v2/tenant.proto.
  */
 export const file_metalstack_admin_v2_tenant: GenFile = /*@__PURE__*/
-  fileDesc("CiBtZXRhbHN0YWNrL2FkbWluL3YyL3RlbmFudC5wcm90bxITbWV0YWxzdGFjay5hZG1pbi52MiLoAQoaVGVuYW50U2VydmljZUNyZWF0ZVJlcXVlc3QSGQoEbmFtZRgBIAEoCUILukgIcgbAs66xAgESJQoLZGVzY3JpcHRpb24YAiABKAlCC7pICHIGyLOusQIBSACIAQESGwoFZW1haWwYAyABKAlCB7pIBHICYAFIAYgBARIXCgphdmF0YXJfdXJsGAQgASgJSAKIAQESKQoGbGFiZWxzGAUgASgLMhkubWV0YWxzdGFjay5hcGkudjIuTGFiZWxzQg4KDF9kZXNjcmlwdGlvbkIICgZfZW1haWxCDQoLX2F2YXRhcl91cmwiSAobVGVuYW50U2VydmljZUNyZWF0ZVJlc3BvbnNlEikKBnRlbmFudBgBIAEoCzIZLm1ldGFsc3RhY2suYXBpLnYyLlRlbmFudCKMAQoYVGVuYW50U2VydmljZUxpc3RSZXF1ZXN0EhIKBWxvZ2luGAEgASgJSACIAQESHgoEbmFtZRgCIAEoCUILukgIcgbAs66xAgFIAYgBARIpCgZwYWdpbmcYByABKAsyGS5tZXRhbHN0YWNrLmFwaS52Mi5QYWdpbmdCCAoGX2xvZ2luQgcKBV9uYW1lIm0KGVRlbmFudFNlcnZpY2VMaXN0UmVzcG9uc2USKgoHdGVuYW50cxgBIAMoCzIZLm1ldGFsc3RhY2suYXBpLnYyLlRlbmFudBIWCgluZXh0X3BhZ2UYAiABKARIAIgBAUIMCgpfbmV4dF9wYWdlMvIBCg1UZW5hbnRTZXJ2aWNlEnIKBkNyZWF0ZRIvLm1ldGFsc3RhY2suYWRtaW4udjIuVGVuYW50U2VydmljZUNyZWF0ZVJlcXVlc3QaMC5tZXRhbHN0YWNrLmFkbWluLnYyLlRlbmFudFNlcnZpY2VDcmVhdGVSZXNwb25zZSIF0vMYAQESbQoETGlzdBItLm1ldGFsc3RhY2suYWRtaW4udjIuVGVuYW50U2VydmljZUxpc3RSZXF1ZXN0Gi4ubWV0YWxzdGFjay5hZG1pbi52Mi5UZW5hbnRTZXJ2aWNlTGlzdFJlc3BvbnNlIgbS8xgCAQJCzwEKF2NvbS5tZXRhbHN0YWNrLmFkbWluLnYyQgtUZW5hbnRQcm90b1ABWjlnaXRodWIuY29tL21ldGFsLXN0YWNrL2FwaS9nby9tZXRhbHN0YWNrL2FkbWluL3YyO2FkbWludjKiAgNNQViqAhNNZXRhbHN0YWNrLkFkbWluLlYyygITTWV0YWxzdGFja1xBZG1pblxWMuICH01ldGFsc3RhY2tcQWRtaW5cVjJcR1BCTWV0YWRhdGHqAhVNZXRhbHN0YWNrOjpBZG1pbjo6VjJiBnByb3RvMw", [file_buf_validate_validate, file_metalstack_api_v2_common, file_metalstack_api_v2_predefined_rules, file_metalstack_api_v2_tenant]);
+  fileDesc("CiBtZXRhbHN0YWNrL2FkbWluL3YyL3RlbmFudC5wcm90bxITbWV0YWxzdGFjay5hZG1pbi52MiLoAQoaVGVuYW50U2VydmljZUNyZWF0ZVJlcXVlc3QSGQoEbmFtZRgBIAEoCUILukgIcgbAs66xAgESJQoLZGVzY3JpcHRpb24YAiABKAlCC7pICHIGyLOusQIBSACIAQESGwoFZW1haWwYAyABKAlCB7pIBHICYAFIAYgBARIXCgphdmF0YXJfdXJsGAQgASgJSAKIAQESKQoGbGFiZWxzGAUgASgLMhkubWV0YWxzdGFjay5hcGkudjIuTGFiZWxzQg4KDF9kZXNjcmlwdGlvbkIICgZfZW1haWxCDQoLX2F2YXRhcl91cmwiSAobVGVuYW50U2VydmljZUNyZWF0ZVJlc3BvbnNlEikKBnRlbmFudBgBIAEoCzIZLm1ldGFsc3RhY2suYXBpLnYyLlRlbmFudCKMAQoYVGVuYW50U2VydmljZUxpc3RSZXF1ZXN0EhIKBWxvZ2luGAEgASgJSACIAQESHgoEbmFtZRgCIAEoCUILukgIcgbAs66xAgFIAYgBARIpCgZwYWdpbmcYAyABKAsyGS5tZXRhbHN0YWNrLmFwaS52Mi5QYWdpbmdCCAoGX2xvZ2luQgcKBV9uYW1lIm0KGVRlbmFudFNlcnZpY2VMaXN0UmVzcG9uc2USKgoHdGVuYW50cxgBIAMoCzIZLm1ldGFsc3RhY2suYXBpLnYyLlRlbmFudBIWCgluZXh0X3BhZ2UYAiABKARIAIgBAUIMCgpfbmV4dF9wYWdlMvIBCg1UZW5hbnRTZXJ2aWNlEnIKBkNyZWF0ZRIvLm1ldGFsc3RhY2suYWRtaW4udjIuVGVuYW50U2VydmljZUNyZWF0ZVJlcXVlc3QaMC5tZXRhbHN0YWNrLmFkbWluLnYyLlRlbmFudFNlcnZpY2VDcmVhdGVSZXNwb25zZSIF0vMYAQESbQoETGlzdBItLm1ldGFsc3RhY2suYWRtaW4udjIuVGVuYW50U2VydmljZUxpc3RSZXF1ZXN0Gi4ubWV0YWxzdGFjay5hZG1pbi52Mi5UZW5hbnRTZXJ2aWNlTGlzdFJlc3BvbnNlIgbS8xgCAQJCzwEKF2NvbS5tZXRhbHN0YWNrLmFkbWluLnYyQgtUZW5hbnRQcm90b1ABWjlnaXRodWIuY29tL21ldGFsLXN0YWNrL2FwaS9nby9tZXRhbHN0YWNrL2FkbWluL3YyO2FkbWludjKiAgNNQViqAhNNZXRhbHN0YWNrLkFkbWluLlYyygITTWV0YWxzdGFja1xBZG1pblxWMuICH01ldGFsc3RhY2tcQWRtaW5cVjJcR1BCTWV0YWRhdGHqAhVNZXRhbHN0YWNrOjpBZG1pbjo6VjJiBnByb3RvMw", [file_buf_validate_validate, file_metalstack_api_v2_common, file_metalstack_api_v2_predefined_rules, file_metalstack_api_v2_tenant]);
 
 /**
- * TenantServiceCreateRequest is the request payload of the tenant create request
+ * TenantServiceCreateRequest is the request payload for creating a tenant.
  *
  * @generated from message metalstack.admin.v2.TenantServiceCreateRequest
  */
 export type TenantServiceCreateRequest = Message<"metalstack.admin.v2.TenantServiceCreateRequest"> & {
   /**
-   * Name of this tenant
+   * Name of the tenant
    *
    * @generated from field: string name = 1;
    */
   name: string;
 
   /**
-   * Description of this tenant
+   * Description of the tenant
    *
    * @generated from field: optional string description = 2;
    */
@@ -68,13 +68,13 @@ export const TenantServiceCreateRequestSchema: GenMessage<TenantServiceCreateReq
   messageDesc(file_metalstack_admin_v2_tenant, 0);
 
 /**
- * TenantServiceCreateResponse is the response payload of the tenant create request
+ * TenantServiceCreateResponse is the response payload for creating a tenant.
  *
  * @generated from message metalstack.admin.v2.TenantServiceCreateResponse
  */
 export type TenantServiceCreateResponse = Message<"metalstack.admin.v2.TenantServiceCreateResponse"> & {
   /**
-   * Tenant is the tenant
+   * Tenant contains the created tenant
    *
    * @generated from field: metalstack.api.v2.Tenant tenant = 1;
    */
@@ -89,20 +89,20 @@ export const TenantServiceCreateResponseSchema: GenMessage<TenantServiceCreateRe
   messageDesc(file_metalstack_admin_v2_tenant, 1);
 
 /**
- * TenantServiceListRequest is the request payload for a tenant list request
+ * TenantServiceListRequest is the request payload for listing tenants.
  *
  * @generated from message metalstack.admin.v2.TenantServiceListRequest
  */
 export type TenantServiceListRequest = Message<"metalstack.admin.v2.TenantServiceListRequest"> & {
   /**
-   * Login of the tenant to list
+   * Login filters tenants by this login
    *
    * @generated from field: optional string login = 1;
    */
   login?: string;
 
   /**
-   * Name of the tenant to list
+   * Name filters tenants by this name
    *
    * @generated from field: optional string name = 2;
    */
@@ -111,7 +111,7 @@ export type TenantServiceListRequest = Message<"metalstack.admin.v2.TenantServic
   /**
    * Paging details for the list request
    *
-   * @generated from field: metalstack.api.v2.Paging paging = 7;
+   * @generated from field: metalstack.api.v2.Paging paging = 3;
    */
   paging?: Paging;
 };
@@ -124,20 +124,20 @@ export const TenantServiceListRequestSchema: GenMessage<TenantServiceListRequest
   messageDesc(file_metalstack_admin_v2_tenant, 2);
 
 /**
- * TenantServiceListResponse is the response payload for a tenant list request
+ * TenantServiceListResponse is the response payload for listing tenants.
  *
  * @generated from message metalstack.admin.v2.TenantServiceListResponse
  */
 export type TenantServiceListResponse = Message<"metalstack.admin.v2.TenantServiceListResponse"> & {
   /**
-   * Tenants are the list of tenants
+   * Tenants contains the list of tenants
    *
    * @generated from field: repeated metalstack.api.v2.Tenant tenants = 1;
    */
   tenants: Tenant[];
 
   /**
-   * NextPage is used for pagination, returns the next page to be fetched and must then be provided in the list request.
+   * NextPage is used for pagination, returns the next page to be fetched and must then be provided in the list request
    *
    * @generated from field: optional uint64 next_page = 2;
    */
@@ -152,13 +152,13 @@ export const TenantServiceListResponseSchema: GenMessage<TenantServiceListRespon
   messageDesc(file_metalstack_admin_v2_tenant, 3);
 
 /**
- * TenantService serves tenant related functions
+ * TenantService provides tenant management operations.
  *
  * @generated from service metalstack.admin.v2.TenantService
  */
 export const TenantService: GenService<{
   /**
-   * Create a tenant
+   * Creates a new tenant.
    *
    * @generated from rpc metalstack.admin.v2.TenantService.Create
    */
@@ -168,7 +168,7 @@ export const TenantService: GenService<{
     output: typeof TenantServiceCreateResponseSchema;
   },
   /**
-   * List all tenants
+   * Returns the list of all tenants.
    *
    * @generated from rpc metalstack.admin.v2.TenantService.List
    */

package/js/metalstack/admin/v2/token_pb.d.ts

@@ -6,7 +6,7 @@ import type { Message } from "@bufbuild/protobuf";
  */
 export declare const file_metalstack_admin_v2_token: GenFile;
 /**
- * TokenServiceListRequest is the request payload for the token list request
+ * TokenServiceListRequest is the request payload for listing tokens.
  *
  * @generated from message metalstack.admin.v2.TokenServiceListRequest
  */
@@ -24,13 +24,13 @@ export type TokenServiceListRequest = Message<"metalstack.admin.v2.TokenServiceL
  */
 export declare const TokenServiceListRequestSchema: GenMessage<TokenServiceListRequest>;
 /**
- * TokenServiceListResponse is the response payload for the token list request
+ * TokenServiceListResponse is the response payload for listing tokens.
  *
  * @generated from message metalstack.admin.v2.TokenServiceListResponse
  */
 export type TokenServiceListResponse = Message<"metalstack.admin.v2.TokenServiceListResponse"> & {
     /**
-     * Tokens is the list of tokens
+     * Tokens contains the list of tokens
      *
      * @generated from field: repeated metalstack.api.v2.Token tokens = 1;
      */
@@ -42,7 +42,7 @@ export type TokenServiceListResponse = Message<"metalstack.admin.v2.TokenService
  */
 export declare const TokenServiceListResponseSchema: GenMessage<TokenServiceListResponse>;
 /**
- * TokenServiceRevokeRequest is the request payload for the token revoke request
+ * TokenServiceRevokeRequest is the request payload for revoking a token.
  *
  * @generated from message metalstack.admin.v2.TokenServiceRevokeRequest
  */
@@ -66,7 +66,7 @@ export type TokenServiceRevokeRequest = Message<"metalstack.admin.v2.TokenServic
  */
 export declare const TokenServiceRevokeRequestSchema: GenMessage<TokenServiceRevokeRequest>;
 /**
- * TokenServiceRevokeResponse is the response payload for the token revoke request
+ * TokenServiceRevokeResponse is the response payload for revoking a token.
  *
  * @generated from message metalstack.admin.v2.TokenServiceRevokeResponse
  */
@@ -77,7 +77,7 @@ export type TokenServiceRevokeResponse = Message<"metalstack.admin.v2.TokenServi
  */
 export declare const TokenServiceRevokeResponseSchema: GenMessage<TokenServiceRevokeResponse>;
 /**
- * TokenServiceCreateRequest is the request payload to create a token
+ * TokenServiceCreateRequest is the request payload for creating a token.
  *
  * @generated from message metalstack.admin.v2.TokenServiceCreateRequest
  */
@@ -101,19 +101,19 @@ export type TokenServiceCreateRequest = Message<"metalstack.admin.v2.TokenServic
  */
 export declare const TokenServiceCreateRequestSchema: GenMessage<TokenServiceCreateRequest>;
 /**
- * TokenServiceCreateResponse is the response payload of a token create request
+ * TokenServiceCreateResponse is the response payload for creating a token.
  *
  * @generated from message metalstack.admin.v2.TokenServiceCreateResponse
  */
 export type TokenServiceCreateResponse = Message<"metalstack.admin.v2.TokenServiceCreateResponse"> & {
     /**
-     * Token which was created
+     * Token contains the created token
      *
      * @generated from field: metalstack.api.v2.Token token = 1;
      */
     token?: Token;
     /**
-     * Secret is the body if the jwt token, should be used in api requests as bearer token
+     * Secret is the body if the JWT token, should be used in API requests as bearer token
      *
      * @generated from field: string secret = 2;
      */
@@ -125,13 +125,13 @@ export type TokenServiceCreateResponse = Message<"metalstack.admin.v2.TokenServi
  */
 export declare const TokenServiceCreateResponseSchema: GenMessage<TokenServiceCreateResponse>;
 /**
- * TokenService serves token related functions
+ * TokenService provides token management operations.
  *
  * @generated from service metalstack.admin.v2.TokenService
  */
 export declare const TokenService: GenService<{
     /**
-     * List tokens
+     * Returns the list of tokens for a user.
      *
      * @generated from rpc metalstack.admin.v2.TokenService.List
      */
@@ -141,7 +141,7 @@ export declare const TokenService: GenService<{
         output: typeof TokenServiceListResponseSchema;
     };
     /**
-     * Revoke a token
+     * Revokes a token.
      *
      * @generated from rpc metalstack.admin.v2.TokenService.Revoke
      */
@@ -151,7 +151,7 @@ export declare const TokenService: GenService<{
         output: typeof TokenServiceRevokeResponseSchema;
     };
     /**
-     * Create a token to authenticate against the platform, the secret will be only visible in the response.
+     * Creates a token to authenticate against the platform, the secret will be only visible in the response.
      * This service is suitable to create tokens for other users instead of deriving users from tokens directly.
      *
      * @generated from rpc metalstack.admin.v2.TokenService.Create

package/js/metalstack/admin/v2/token_pb.js

@@ -40,7 +40,7 @@ export const TokenServiceCreateRequestSchema = /*@__PURE__*/ messageDesc(file_me
  */
 export const TokenServiceCreateResponseSchema = /*@__PURE__*/ messageDesc(file_metalstack_admin_v2_token, 5);
 /**
- * TokenService serves token related functions
+ * TokenService provides token management operations.
  *
  * @generated from service metalstack.admin.v2.TokenService
  */

package/js/metalstack/admin/v2/token_pb.ts

@@ -17,7 +17,7 @@ export const file_metalstack_admin_v2_token: GenFile = /*@__PURE__*/
   fileDesc("Ch9tZXRhbHN0YWNrL2FkbWluL3YyL3Rva2VuLnByb3RvEhNtZXRhbHN0YWNrLmFkbWluLnYyIjUKF1Rva2VuU2VydmljZUxpc3RSZXF1ZXN0EhEKBHVzZXIYASABKAlIAIgBAUIHCgVfdXNlciJEChhUb2tlblNlcnZpY2VMaXN0UmVzcG9uc2USKAoGdG9rZW5zGAEgAygLMhgubWV0YWxzdGFjay5hcGkudjIuVG9rZW4iTQoZVG9rZW5TZXJ2aWNlUmV2b2tlUmVxdWVzdBIWCgR1dWlkGAEgASgJQgi6SAVyA7ABARIYCgR1c2VyGAIgASgJQgq6SAdyBRACGIAEIhwKGlRva2VuU2VydmljZVJldm9rZVJlc3BvbnNlIo8BChlUb2tlblNlcnZpY2VDcmVhdGVSZXF1ZXN0Eh0KBHVzZXIYASABKAlCCrpIB3IFEAIYgARIAIgBARJKChR0b2tlbl9jcmVhdGVfcmVxdWVzdBgCIAEoCzIsLm1ldGFsc3RhY2suYXBpLnYyLlRva2VuU2VydmljZUNyZWF0ZVJlcXVlc3RCBwoFX3VzZXIiVQoaVG9rZW5TZXJ2aWNlQ3JlYXRlUmVzcG9uc2USJwoFdG9rZW4YASABKAsyGC5tZXRhbHN0YWNrLmFwaS52Mi5Ub2tlbhIOCgZzZWNyZXQYAiABKAky3wIKDFRva2VuU2VydmljZRJrCgRMaXN0EiwubWV0YWxzdGFjay5hZG1pbi52Mi5Ub2tlblNlcnZpY2VMaXN0UmVxdWVzdBotLm1ldGFsc3RhY2suYWRtaW4udjIuVG9rZW5TZXJ2aWNlTGlzdFJlc3BvbnNlIgbS8xgCAQIScAoGUmV2b2tlEi4ubWV0YWxzdGFjay5hZG1pbi52Mi5Ub2tlblNlcnZpY2VSZXZva2VSZXF1ZXN0Gi8ubWV0YWxzdGFjay5hZG1pbi52Mi5Ub2tlblNlcnZpY2VSZXZva2VSZXNwb25zZSIF0vMYAQEScAoGQ3JlYXRlEi4ubWV0YWxzdGFjay5hZG1pbi52Mi5Ub2tlblNlcnZpY2VDcmVhdGVSZXF1ZXN0Gi8ubWV0YWxzdGFjay5hZG1pbi52Mi5Ub2tlblNlcnZpY2VDcmVhdGVSZXNwb25zZSIF0vMYAQFCzgEKF2NvbS5tZXRhbHN0YWNrLmFkbWluLnYyQgpUb2tlblByb3RvUAFaOWdpdGh1Yi5jb20vbWV0YWwtc3RhY2svYXBpL2dvL21ldGFsc3RhY2svYWRtaW4vdjI7YWRtaW52MqICA01BWKoCE01ldGFsc3RhY2suQWRtaW4uVjLKAhNNZXRhbHN0YWNrXEFkbWluXFYy4gIfTWV0YWxzdGFja1xBZG1pblxWMlxHUEJNZXRhZGF0YeoCFU1ldGFsc3RhY2s6OkFkbWluOjpWMmIGcHJvdG8z", [file_buf_validate_validate, file_metalstack_api_v2_common, file_metalstack_api_v2_token]);
 
 /**
- * TokenServiceListRequest is the request payload for the token list request
+ * TokenServiceListRequest is the request payload for listing tokens.
  *
  * @generated from message metalstack.admin.v2.TokenServiceListRequest
  */
@@ -38,13 +38,13 @@ export const TokenServiceListRequestSchema: GenMessage<TokenServiceListRequest>
   messageDesc(file_metalstack_admin_v2_token, 0);
 
 /**
- * TokenServiceListResponse is the response payload for the token list request
+ * TokenServiceListResponse is the response payload for listing tokens.
  *
  * @generated from message metalstack.admin.v2.TokenServiceListResponse
  */
 export type TokenServiceListResponse = Message<"metalstack.admin.v2.TokenServiceListResponse"> & {
   /**
-   * Tokens is the list of tokens
+   * Tokens contains the list of tokens
    *
    * @generated from field: repeated metalstack.api.v2.Token tokens = 1;
    */
@@ -59,7 +59,7 @@ export const TokenServiceListResponseSchema: GenMessage<TokenServiceListResponse
   messageDesc(file_metalstack_admin_v2_token, 1);
 
 /**
- * TokenServiceRevokeRequest is the request payload for the token revoke request
+ * TokenServiceRevokeRequest is the request payload for revoking a token.
  *
  * @generated from message metalstack.admin.v2.TokenServiceRevokeRequest
  */
@@ -87,7 +87,7 @@ export const TokenServiceRevokeRequestSchema: GenMessage<TokenServiceRevokeReque
   messageDesc(file_metalstack_admin_v2_token, 2);
 
 /**
- * TokenServiceRevokeResponse is the response payload for the token revoke request
+ * TokenServiceRevokeResponse is the response payload for revoking a token.
  *
  * @generated from message metalstack.admin.v2.TokenServiceRevokeResponse
  */
@@ -102,7 +102,7 @@ export const TokenServiceRevokeResponseSchema: GenMessage<TokenServiceRevokeResp
   messageDesc(file_metalstack_admin_v2_token, 3);
 
 /**
- * TokenServiceCreateRequest is the request payload to create a token
+ * TokenServiceCreateRequest is the request payload for creating a token.
  *
  * @generated from message metalstack.admin.v2.TokenServiceCreateRequest
  */
@@ -130,20 +130,20 @@ export const TokenServiceCreateRequestSchema: GenMessage<TokenServiceCreateReque
   messageDesc(file_metalstack_admin_v2_token, 4);
 
 /**
- * TokenServiceCreateResponse is the response payload of a token create request
+ * TokenServiceCreateResponse is the response payload for creating a token.
  *
  * @generated from message metalstack.admin.v2.TokenServiceCreateResponse
  */
 export type TokenServiceCreateResponse = Message<"metalstack.admin.v2.TokenServiceCreateResponse"> & {
   /**
-   * Token which was created
+   * Token contains the created token
    *
    * @generated from field: metalstack.api.v2.Token token = 1;
    */
   token?: Token;
 
   /**
-   * Secret is the body if the jwt token, should be used in api requests as bearer token
+   * Secret is the body if the JWT token, should be used in API requests as bearer token
    *
    * @generated from field: string secret = 2;
    */
@@ -158,13 +158,13 @@ export const TokenServiceCreateResponseSchema: GenMessage<TokenServiceCreateResp
   messageDesc(file_metalstack_admin_v2_token, 5);
 
 /**
- * TokenService serves token related functions
+ * TokenService provides token management operations.
  *
  * @generated from service metalstack.admin.v2.TokenService
  */
 export const TokenService: GenService<{
   /**
-   * List tokens
+   * Returns the list of tokens for a user.
    *
    * @generated from rpc metalstack.admin.v2.TokenService.List
    */
@@ -174,7 +174,7 @@ export const TokenService: GenService<{
     output: typeof TokenServiceListResponseSchema;
   },
   /**
-   * Revoke a token
+   * Revokes a token.
    *
    * @generated from rpc metalstack.admin.v2.TokenService.Revoke
    */
@@ -184,7 +184,7 @@ export const TokenService: GenService<{
     output: typeof TokenServiceRevokeResponseSchema;
   },
   /**
-   * Create a token to authenticate against the platform, the secret will be only visible in the response.
+   * Creates a token to authenticate against the platform, the secret will be only visible in the response.
    * This service is suitable to create tokens for other users instead of deriving users from tokens directly.
    *
    * @generated from rpc metalstack.admin.v2.TokenService.Create

package/js/metalstack/admin/v2/vpn_pb.d.ts

@@ -7,32 +7,32 @@ import type { Message } from "@bufbuild/protobuf";
  */
 export declare const file_metalstack_admin_v2_vpn: GenFile;
 /**
- * VPNServiceAuthKeyRequest is the request payload for a vpn authkey request.
+ * VPNServiceAuthKeyRequest is the request payload for generating a VPN authentication key.
  *
  * @generated from message metalstack.admin.v2.VPNServiceAuthKeyRequest
  */
 export type VPNServiceAuthKeyRequest = Message<"metalstack.admin.v2.VPNServiceAuthKeyRequest"> & {
     /**
-     * Project for which a vpn authkey should be generated.
+     * Project for which a VPN authentication key should be generated
      *
      * @generated from field: string project = 1;
      */
     project: string;
     /**
-     * Ephemeral defines if the authkey should be ephemeral.
+     * Ephemeral defines if the authentication key should be ephemeral
      *
      * @generated from field: bool ephemeral = 2;
      */
     ephemeral: boolean;
     /**
-     * Expires defines the duration after which the authkey expires.
+     * Expires defines the duration after which the authentication key expires
      *
      * @generated from field: google.protobuf.Duration expires = 3;
      */
     expires?: Duration;
     /**
-     * Reason must be provided why access to the vpn is requested
-     * reason is only forwarded to a audit sink
+     * Reason must be provided why access to the VPN is requested
+     * Reason is only forwarded to an audit sink
      *
      * @generated from field: string reason = 4;
      */
@@ -44,38 +44,38 @@ export type VPNServiceAuthKeyRequest = Message<"metalstack.admin.v2.VPNServiceAu
  */
 export declare const VPNServiceAuthKeyRequestSchema: GenMessage<VPNServiceAuthKeyRequest>;
 /**
- * VPNServiceAuthKeyResponse is the request payload for a authkey response
+ * VPNServiceAuthKeyResponse is the response payload for generating a VPN authentication key.
  *
  * @generated from message metalstack.admin.v2.VPNServiceAuthKeyResponse
  */
 export type VPNServiceAuthKeyResponse = Message<"metalstack.admin.v2.VPNServiceAuthKeyResponse"> & {
     /**
-     * Address is the address of the vpn control plane.
+     * Address is the address of the VPN control plane
      *
      * @generated from field: string address = 1;
      */
     address: string;
     /**
-     * AuthKey is the key to connect to the vpn at the given address.
-     * This key can only be seen once.
+     * AuthKey is the key to connect to the VPN at the given address
+     * This key can only be seen once
      *
      * @generated from field: string auth_key = 2;
      */
     authKey: string;
     /**
-     * Ephemeral defines if the authkey should be ephemeral.
+     * Ephemeral defines if the authentication key should be ephemeral
      *
      * @generated from field: bool ephemeral = 3;
      */
     ephemeral: boolean;
     /**
-     * ExpiresAt this key cannot be used after this timestamp.
+     * ExpiresAt this key cannot be used after this timestamp
      *
      * @generated from field: google.protobuf.Timestamp expires_at = 4;
      */
     expiresAt?: Timestamp;
     /**
-     * CreatedAt this key was created at this timestamp.
+     * CreatedAt this key was created at this timestamp
      *
      * @generated from field: google.protobuf.Timestamp created_at = 5;
      */
@@ -87,13 +87,13 @@ export type VPNServiceAuthKeyResponse = Message<"metalstack.admin.v2.VPNServiceA
  */
 export declare const VPNServiceAuthKeyResponseSchema: GenMessage<VPNServiceAuthKeyResponse>;
 /**
- * VPNServiceListNodesRequest is the request payload for a vpn list nodes request
+ * VPNServiceListNodesRequest is the request payload for listing VPN nodes.
  *
  * @generated from message metalstack.admin.v2.VPNServiceListNodesRequest
  */
 export type VPNServiceListNodesRequest = Message<"metalstack.admin.v2.VPNServiceListNodesRequest"> & {
     /**
-     * Project if given only nodes of this user are returned
+     * Project filters nodes by this project
      *
      * @generated from field: optional string project = 1;
      */
@@ -105,13 +105,13 @@ export type VPNServiceListNodesRequest = Message<"metalstack.admin.v2.VPNService
  */
 export declare const VPNServiceListNodesRequestSchema: GenMessage<VPNServiceListNodesRequest>;
 /**
- * VPNServiceListNodesResponse is the response payload for a vpn list nodes request
+ * VPNServiceListNodesResponse is the response payload for listing VPN nodes.
  *
  * @generated from message metalstack.admin.v2.VPNServiceListNodesResponse
  */
 export type VPNServiceListNodesResponse = Message<"metalstack.admin.v2.VPNServiceListNodesResponse"> & {
     /**
-     * Nodes connected to the vpn
+     * Nodes connected to the VPN
      *
      * @generated from field: repeated metalstack.api.v2.VPNNode nodes = 1;
      */
@@ -123,13 +123,13 @@ export type VPNServiceListNodesResponse = Message<"metalstack.admin.v2.VPNServic
  */
 export declare const VPNServiceListNodesResponseSchema: GenMessage<VPNServiceListNodesResponse>;
 /**
- * VPNService serves vpn related functions
+ * VPNService provides VPN management operations.
  *
  * @generated from service metalstack.admin.v2.VPNService
  */
 export declare const VPNService: GenService<{
     /**
-     * AuthKey generates a authkey for a project to join a machine to the project vpn
+     * GenerateAuthKey generates an authentication key for a project to join a machine to the project VPN.
      *
      * @generated from rpc metalstack.admin.v2.VPNService.AuthKey
      */
@@ -139,7 +139,7 @@ export declare const VPNService: GenService<{
         output: typeof VPNServiceAuthKeyResponseSchema;
     };
     /**
-     * ListNodes returns a list of machines actually connected to the vpn
+     * Returns the list of machines connected to the VPN.
      *
      * @generated from rpc metalstack.admin.v2.VPNService.ListNodes
      */

package/js/metalstack/admin/v2/vpn_pb.js

@@ -31,7 +31,7 @@ export const VPNServiceListNodesRequestSchema = /*@__PURE__*/ messageDesc(file_m
  */
 export const VPNServiceListNodesResponseSchema = /*@__PURE__*/ messageDesc(file_metalstack_admin_v2_vpn, 3);
 /**
- * VPNService serves vpn related functions
+ * VPNService provides VPN management operations.
  *
  * @generated from service metalstack.admin.v2.VPNService
  */

package/js/metalstack/admin/v2/vpn_pb.ts

@@ -19,35 +19,35 @@ export const file_metalstack_admin_v2_vpn: GenFile = /*@__PURE__*/
   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]);
 
 /**
- * VPNServiceAuthKeyRequest is the request payload for a vpn authkey request.
+ * VPNServiceAuthKeyRequest is the request payload for generating a VPN authentication key.
  *
  * @generated from message metalstack.admin.v2.VPNServiceAuthKeyRequest
  */
 export type VPNServiceAuthKeyRequest = Message<"metalstack.admin.v2.VPNServiceAuthKeyRequest"> & {
   /**
-   * Project for which a vpn authkey should be generated.
+   * Project for which a VPN authentication key should be generated
    *
    * @generated from field: string project = 1;
    */
   project: string;
 
   /**
-   * Ephemeral defines if the authkey should be ephemeral.
+   * Ephemeral defines if the authentication key should be ephemeral
    *
    * @generated from field: bool ephemeral = 2;
    */
   ephemeral: boolean;
 
   /**
-   * Expires defines the duration after which the authkey expires.
+   * Expires defines the duration after which the authentication key expires
    *
    * @generated from field: google.protobuf.Duration expires = 3;
    */
   expires?: Duration;
 
   /**
-   * Reason must be provided why access to the vpn is requested
-   * reason is only forwarded to a audit sink
+   * Reason must be provided why access to the VPN is requested
+   * Reason is only forwarded to an audit sink
    *
    * @generated from field: string reason = 4;
    */
@@ -62,42 +62,42 @@ export const VPNServiceAuthKeyRequestSchema: GenMessage<VPNServiceAuthKeyRequest
   messageDesc(file_metalstack_admin_v2_vpn, 0);
 
 /**
- * VPNServiceAuthKeyResponse is the request payload for a authkey response
+ * VPNServiceAuthKeyResponse is the response payload for generating a VPN authentication key.
  *
  * @generated from message metalstack.admin.v2.VPNServiceAuthKeyResponse
  */
 export type VPNServiceAuthKeyResponse = Message<"metalstack.admin.v2.VPNServiceAuthKeyResponse"> & {
   /**
-   * Address is the address of the vpn control plane.
+   * Address is the address of the VPN control plane
    *
    * @generated from field: string address = 1;
    */
   address: string;
 
   /**
-   * AuthKey is the key to connect to the vpn at the given address.
-   * This key can only be seen once.
+   * AuthKey is the key to connect to the VPN at the given address
+   * This key can only be seen once
    *
    * @generated from field: string auth_key = 2;
    */
   authKey: string;
 
   /**
-   * Ephemeral defines if the authkey should be ephemeral.
+   * Ephemeral defines if the authentication key should be ephemeral
    *
    * @generated from field: bool ephemeral = 3;
    */
   ephemeral: boolean;
 
   /**
-   * ExpiresAt this key cannot be used after this timestamp.
+   * ExpiresAt this key cannot be used after this timestamp
    *
    * @generated from field: google.protobuf.Timestamp expires_at = 4;
    */
   expiresAt?: Timestamp;
 
   /**
-   * CreatedAt this key was created at this timestamp.
+   * CreatedAt this key was created at this timestamp
    *
    * @generated from field: google.protobuf.Timestamp created_at = 5;
    */
@@ -112,13 +112,13 @@ export const VPNServiceAuthKeyResponseSchema: GenMessage<VPNServiceAuthKeyRespon
   messageDesc(file_metalstack_admin_v2_vpn, 1);
 
 /**
- * VPNServiceListNodesRequest is the request payload for a vpn list nodes request
+ * VPNServiceListNodesRequest is the request payload for listing VPN nodes.
  *
  * @generated from message metalstack.admin.v2.VPNServiceListNodesRequest
  */
 export type VPNServiceListNodesRequest = Message<"metalstack.admin.v2.VPNServiceListNodesRequest"> & {
   /**
-   * Project if given only nodes of this user are returned
+   * Project filters nodes by this project
    *
    * @generated from field: optional string project = 1;
    */
@@ -133,13 +133,13 @@ export const VPNServiceListNodesRequestSchema: GenMessage<VPNServiceListNodesReq
   messageDesc(file_metalstack_admin_v2_vpn, 2);
 
 /**
- * VPNServiceListNodesResponse is the response payload for a vpn list nodes request
+ * VPNServiceListNodesResponse is the response payload for listing VPN nodes.
  *
  * @generated from message metalstack.admin.v2.VPNServiceListNodesResponse
  */
 export type VPNServiceListNodesResponse = Message<"metalstack.admin.v2.VPNServiceListNodesResponse"> & {
   /**
-   * Nodes connected to the vpn
+   * Nodes connected to the VPN
    *
    * @generated from field: repeated metalstack.api.v2.VPNNode nodes = 1;
    */
@@ -154,13 +154,13 @@ export const VPNServiceListNodesResponseSchema: GenMessage<VPNServiceListNodesRe
   messageDesc(file_metalstack_admin_v2_vpn, 3);
 
 /**
- * VPNService serves vpn related functions
+ * VPNService provides VPN management operations.
  *
  * @generated from service metalstack.admin.v2.VPNService
  */
 export const VPNService: GenService<{
   /**
-   * AuthKey generates a authkey for a project to join a machine to the project vpn
+   * GenerateAuthKey generates an authentication key for a project to join a machine to the project VPN.
    *
    * @generated from rpc metalstack.admin.v2.VPNService.AuthKey
    */
@@ -170,7 +170,7 @@ export const VPNService: GenService<{
     output: typeof VPNServiceAuthKeyResponseSchema;
   },
   /**
-   * ListNodes returns a list of machines actually connected to the vpn
+   * Returns the list of machines connected to the VPN.
    *
    * @generated from rpc metalstack.admin.v2.VPNService.ListNodes
    */