@metal-stack/api 0.4.4 → 0.5.1

package/{js/metalstack → metalstack}/admin/v2/token_pb.d.ts

@@ -12,7 +12,7 @@ export declare const file_metalstack_admin_v2_token: GenFile;
  */
 export type TokenServiceListRequest = Message<"metalstack.admin.v2.TokenServiceListRequest"> & {
     /**
-     * Query for tokens
+     * Query for tokens.
      *
      * @generated from field: metalstack.api.v2.TokenQuery query = 1;
      */
@@ -30,7 +30,7 @@ export declare const TokenServiceListRequestSchema: GenMessage<TokenServiceListR
  */
 export type TokenServiceListResponse = Message<"metalstack.admin.v2.TokenServiceListResponse"> & {
     /**
-     * Tokens contains the list of tokens
+     * Tokens contains the list of tokens.
      *
      * @generated from field: repeated metalstack.api.v2.Token tokens = 1;
      */
@@ -48,13 +48,13 @@ export declare const TokenServiceListResponseSchema: GenMessage<TokenServiceList
  */
 export type TokenServiceRevokeRequest = Message<"metalstack.admin.v2.TokenServiceRevokeRequest"> & {
     /**
-     * Uuid is the uuid of the token which should be revoked
+     * Uuid is the uuid of the token which should be revoked.
      *
      * @generated from field: string uuid = 1;
      */
     uuid: string;
     /**
-     * User is the id of the user for which the token should be revoked
+     * User is the id of the user for which the token should be revoked.
      *
      * @generated from field: string user = 2;
      */
@@ -83,13 +83,13 @@ export declare const TokenServiceRevokeResponseSchema: GenMessage<TokenServiceRe
  */
 export type TokenServiceCreateRequest = Message<"metalstack.admin.v2.TokenServiceCreateRequest"> & {
     /**
-     * User this token should be created for, if omitted, user is derived from caller
+     * User this token should be created for, if omitted, user is derived from caller.
      *
      * @generated from field: optional string user = 1;
      */
     user?: string | undefined;
     /**
-     * TokenCreateRequest which should be created
+     * TokenCreateRequest which should be created.
      *
      * @generated from field: metalstack.api.v2.TokenServiceCreateRequest token_create_request = 2;
      */
@@ -107,13 +107,13 @@ export declare const TokenServiceCreateRequestSchema: GenMessage<TokenServiceCre
  */
 export type TokenServiceCreateResponse = Message<"metalstack.admin.v2.TokenServiceCreateResponse"> & {
     /**
-     * Token contains the created token
+     * Token contains the created token.
      *
      * @generated from field: metalstack.api.v2.Token token = 1;
      */
     token?: Token | undefined;
     /**
-     * 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;
      */

package/{js/metalstack → metalstack}/admin/v2/token_pb.ts

@@ -24,7 +24,7 @@ export const file_metalstack_admin_v2_token: GenFile = /*@__PURE__*/
  */
 export type TokenServiceListRequest = Message<"metalstack.admin.v2.TokenServiceListRequest"> & {
   /**
-   * Query for tokens
+   * Query for tokens.
    *
    * @generated from field: metalstack.api.v2.TokenQuery query = 1;
    */
@@ -45,7 +45,7 @@ export const TokenServiceListRequestSchema: GenMessage<TokenServiceListRequest>
  */
 export type TokenServiceListResponse = Message<"metalstack.admin.v2.TokenServiceListResponse"> & {
   /**
-   * Tokens contains the list of tokens
+   * Tokens contains the list of tokens.
    *
    * @generated from field: repeated metalstack.api.v2.Token tokens = 1;
    */
@@ -66,14 +66,14 @@ export const TokenServiceListResponseSchema: GenMessage<TokenServiceListResponse
  */
 export type TokenServiceRevokeRequest = Message<"metalstack.admin.v2.TokenServiceRevokeRequest"> & {
   /**
-   * Uuid is the uuid of the token which should be revoked
+   * Uuid is the uuid of the token which should be revoked.
    *
    * @generated from field: string uuid = 1;
    */
   uuid: string;
 
   /**
-   * User is the id of the user for which the token should be revoked
+   * User is the id of the user for which the token should be revoked.
    *
    * @generated from field: string user = 2;
    */
@@ -109,14 +109,14 @@ export const TokenServiceRevokeResponseSchema: GenMessage<TokenServiceRevokeResp
  */
 export type TokenServiceCreateRequest = Message<"metalstack.admin.v2.TokenServiceCreateRequest"> & {
   /**
-   * User this token should be created for, if omitted, user is derived from caller
+   * User this token should be created for, if omitted, user is derived from caller.
    *
    * @generated from field: optional string user = 1;
    */
   user?: string | undefined;
 
   /**
-   * TokenCreateRequest which should be created
+   * TokenCreateRequest which should be created.
    *
    * @generated from field: metalstack.api.v2.TokenServiceCreateRequest token_create_request = 2;
    */
@@ -137,14 +137,14 @@ export const TokenServiceCreateRequestSchema: GenMessage<TokenServiceCreateReque
  */
 export type TokenServiceCreateResponse = Message<"metalstack.admin.v2.TokenServiceCreateResponse"> & {
   /**
-   * Token contains the created token
+   * Token contains the created token.
    *
    * @generated from field: metalstack.api.v2.Token token = 1;
    */
   token?: Token | undefined;
 
   /**
-   * 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;
    */

package/{js/metalstack → metalstack}/admin/v2/vpn_pb.d.ts

@@ -13,26 +13,26 @@ export declare const file_metalstack_admin_v2_vpn: GenFile;
  */
 export type VPNServiceAuthKeyRequest = Message<"metalstack.admin.v2.VPNServiceAuthKeyRequest"> & {
     /**
-     * Project for which a VPN authentication key 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 authentication key 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 authentication key expires
+     * Expires defines the duration after which the authentication key expires.
      *
      * @generated from field: google.protobuf.Duration expires = 3;
      */
     expires?: Duration | undefined;
     /**
-     * Reason must be provided why access to the VPN is requested
-     * Reason is only forwarded to an 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;
      */
@@ -50,32 +50,32 @@ export declare const VPNServiceAuthKeyRequestSchema: GenMessage<VPNServiceAuthKe
  */
 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 authentication key 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 | undefined;
     /**
-     * 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;
      */
@@ -93,7 +93,7 @@ export declare const VPNServiceAuthKeyResponseSchema: GenMessage<VPNServiceAuthK
  */
 export type VPNServiceListNodesRequest = Message<"metalstack.admin.v2.VPNServiceListNodesRequest"> & {
     /**
-     * Project filters nodes by this project
+     * Project filters nodes by this project.
      *
      * @generated from field: optional string project = 1;
      */
@@ -111,7 +111,7 @@ export declare const VPNServiceListNodesRequestSchema: GenMessage<VPNServiceList
  */
 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;
      */

package/{js/metalstack → metalstack}/admin/v2/vpn_pb.ts

@@ -25,29 +25,29 @@ export const file_metalstack_admin_v2_vpn: GenFile = /*@__PURE__*/
  */
 export type VPNServiceAuthKeyRequest = Message<"metalstack.admin.v2.VPNServiceAuthKeyRequest"> & {
   /**
-   * Project for which a VPN authentication key 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 authentication key 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 authentication key expires
+   * Expires defines the duration after which the authentication key expires.
    *
    * @generated from field: google.protobuf.Duration expires = 3;
    */
   expires?: Duration | undefined;
 
   /**
-   * Reason must be provided why access to the VPN is requested
-   * Reason is only forwarded to an 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;
    */
@@ -68,36 +68,36 @@ export const VPNServiceAuthKeyRequestSchema: GenMessage<VPNServiceAuthKeyRequest
  */
 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 authentication key 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 | undefined;
 
   /**
-   * 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;
    */
@@ -118,7 +118,7 @@ export const VPNServiceAuthKeyResponseSchema: GenMessage<VPNServiceAuthKeyRespon
  */
 export type VPNServiceListNodesRequest = Message<"metalstack.admin.v2.VPNServiceListNodesRequest"> & {
   /**
-   * Project filters nodes by this project
+   * Project filters nodes by this project.
    *
    * @generated from field: optional string project = 1;
    */
@@ -139,7 +139,7 @@ export const VPNServiceListNodesRequestSchema: GenMessage<VPNServiceListNodesReq
  */
 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;
    */

package/{js/metalstack → metalstack}/api/v2/audit_pb.d.ts

@@ -13,67 +13,67 @@ export declare const file_metalstack_api_v2_audit: GenFile;
  */
 export type AuditTrace = Message<"metalstack.api.v2.AuditTrace"> & {
     /**
-     * Uuid of the audit trace
+     * Uuid of the audit trace.
      *
      * @generated from field: string uuid = 1;
      */
     uuid: string;
     /**
-     * Timestamp is the timestamp when the request arrived at the API
+     * Timestamp is the timestamp when the request arrived at the API.
      *
      * @generated from field: google.protobuf.Timestamp timestamp = 2;
      */
     timestamp?: Timestamp | undefined;
     /**
-     * User is the login user who called the API method
+     * User is the login user who called the API method.
      *
      * @generated from field: string user = 3;
      */
     user: string;
     /**
-     * Tenant is the tenant targeted by the API call
+     * Tenant is the tenant targeted by the API call.
      *
      * @generated from field: string tenant = 4;
      */
     tenant: string;
     /**
-     * Project is the project targeted by the API call
+     * Project is the project targeted by the API call.
      *
      * @generated from field: optional string project = 5;
      */
     project?: string | undefined;
     /**
-     * Method is the API method that was called
+     * Method is the API method that was called.
      *
      * @generated from field: string method = 6;
      */
     method: string;
     /**
-     * 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
+     * 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.
      *
      * @generated from field: optional string body = 7;
      */
     body?: string | undefined;
     /**
-     * SourceIP contains the source IP address of the API call
+     * SourceIP contains the source IP address of the API call.
      *
      * @generated from field: string source_ip = 8;
      */
     sourceIp: string;
     /**
-     * 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
+     * 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.
      *
      * @generated from field: optional int32 result_code = 9;
      */
     resultCode?: number | undefined;
     /**
-     * Phase represents the phase of the audit trace
+     * Phase represents the phase of the audit trace.
      *
      * @generated from field: metalstack.api.v2.AuditPhase phase = 10;
      */
     phase: AuditPhase;
     /**
-     * Meta for this audit trace
+     * Meta for this audit trace.
      *
      * @generated from field: metalstack.api.v2.Meta meta = 11;
      */
@@ -85,73 +85,73 @@ export type AuditTrace = Message<"metalstack.api.v2.AuditTrace"> & {
  */
 export declare const AuditTraceSchema: GenMessage<AuditTrace>;
 /**
- * AuditQuery is the query for audit traces
+ * AuditQuery is the query for audit traces.
  *
  * @generated from message metalstack.api.v2.AuditQuery
  */
 export type AuditQuery = Message<"metalstack.api.v2.AuditQuery"> & {
     /**
-     * Uuid of the audit trace
+     * Uuid of the audit trace.
      *
      * @generated from field: optional string uuid = 2;
      */
     uuid?: string | undefined;
     /**
-     * From describes the start of the time window in which to list audit traces. Defaults to the last eight hours
+     * From describes the start of the time window in which to list audit traces. Defaults to the last eight hours.
      *
      * @generated from field: optional google.protobuf.Timestamp from = 3;
      */
     from?: Timestamp | undefined;
     /**
-     * To describes the end of the time window in which to list audit traces. Defaults to the time the request was issued
+     * To describes the end of the time window in which to list audit traces. Defaults to the time the request was issued.
      *
      * @generated from field: optional google.protobuf.Timestamp to = 4;
      */
     to?: Timestamp | undefined;
     /**
-     * User is the user who called the api method
+     * User is the user who called the api method.
      *
      * @generated from field: optional string user = 5;
      */
     user?: string | undefined;
     /**
-     * Project is the project targeted by the api call
+     * Project is the project targeted by the api call.
      *
      * @generated from field: optional string project = 6;
      */
     project?: string | undefined;
     /**
-     * Method is the api method that was called
+     * Method is the api method that was called.
      *
      * @generated from field: optional string method = 7;
      */
     method?: string | undefined;
     /**
-     * Source IP contains the ip address of the caller
+     * Source IP contains the ip address of the caller.
      *
      * @generated from field: optional string source_ip = 8;
      */
     sourceIp?: string | undefined;
     /**
-     * Result Code is a string describing the result of the api call
+     * Result Code is a string describing the result of the api call.
      *
      * @generated from field: optional int32 result_code = 9;
      */
     resultCode?: number | undefined;
     /**
-     * Body is a string providing text-search of the body field
+     * Body is a string providing text-search of the body field.
      *
      * @generated from field: optional string body = 10;
      */
     body?: string | undefined;
     /**
-     * Limit is a number limiting the length of the response (min: 1, max: 1000, defaults to 200)
+     * Limit is a number limiting the length of the response (min: 1, max: 1000, defaults to 200).
      *
      * @generated from field: optional int32 limit = 11;
      */
     limit?: number | undefined;
     /**
-     * Phase specifies the audit phase
+     * Phase specifies the audit phase.
      *
      * @generated from field: optional metalstack.api.v2.AuditPhase phase = 12;
      */
@@ -163,19 +163,19 @@ export type AuditQuery = Message<"metalstack.api.v2.AuditQuery"> & {
  */
 export declare const AuditQuerySchema: GenMessage<AuditQuery>;
 /**
- * AuditServiceListRequest is the request payload for an audit list request
+ * AuditServiceListRequest is the request payload for an audit list request.
  *
  * @generated from message metalstack.api.v2.AuditServiceListRequest
  */
 export type AuditServiceListRequest = Message<"metalstack.api.v2.AuditServiceListRequest"> & {
     /**
-     * Login for this tenant
+     * Login for this tenant.
      *
      * @generated from field: string login = 1;
      */
     login: string;
     /**
-     * Query for audit traces
+     * Query for audit traces.
      *
      * @generated from field: metalstack.api.v2.AuditQuery query = 2;
      */
@@ -187,13 +187,13 @@ export type AuditServiceListRequest = Message<"metalstack.api.v2.AuditServiceLis
  */
 export declare const AuditServiceListRequestSchema: GenMessage<AuditServiceListRequest>;
 /**
- * AuditServiceListResponse is the response payload of a audit list request
+ * AuditServiceListResponse is the response payload of a audit list request.
  *
  * @generated from message metalstack.api.v2.AuditServiceListResponse
  */
 export type AuditServiceListResponse = Message<"metalstack.api.v2.AuditServiceListResponse"> & {
     /**
-     * Traces is a list of audit traces
+     * Traces is a list of audit traces.
      *
      * @generated from field: repeated metalstack.api.v2.AuditTrace traces = 1;
      */
@@ -205,25 +205,25 @@ export type AuditServiceListResponse = Message<"metalstack.api.v2.AuditServiceLi
  */
 export declare const AuditServiceListResponseSchema: GenMessage<AuditServiceListResponse>;
 /**
- * AuditServiceGetRequest is the request payload of a audit get request
+ * AuditServiceGetRequest is the request payload of a audit get request.
  *
  * @generated from message metalstack.api.v2.AuditServiceGetRequest
  */
 export type AuditServiceGetRequest = Message<"metalstack.api.v2.AuditServiceGetRequest"> & {
     /**
-     * Login for this tenant
+     * Login for this tenant.
      *
      * @generated from field: string login = 1;
      */
     login: string;
     /**
-     * Uuid of the audit trace
+     * Uuid of the audit trace.
      *
      * @generated from field: string uuid = 2;
      */
     uuid: string;
     /**
-     * Phase specifies the audit phase. Defaults to request
+     * Phase specifies the audit phase. Defaults to request.
      *
      * @generated from field: optional metalstack.api.v2.AuditPhase phase = 3;
      */
@@ -235,13 +235,13 @@ export type AuditServiceGetRequest = Message<"metalstack.api.v2.AuditServiceGetR
  */
 export declare const AuditServiceGetRequestSchema: GenMessage<AuditServiceGetRequest>;
 /**
- * AuditServiceGetResponse is the response payload of a audit get request
+ * AuditServiceGetResponse is the response payload of a audit get request.
  *
  * @generated from message metalstack.api.v2.AuditServiceGetResponse
  */
 export type AuditServiceGetResponse = Message<"metalstack.api.v2.AuditServiceGetResponse"> & {
     /**
-     * Trace is the audit trace
+     * Trace is the audit trace.
      *
      * @generated from field: metalstack.api.v2.AuditTrace trace = 1;
      */
@@ -259,19 +259,19 @@ export declare const AuditServiceGetResponseSchema: GenMessage<AuditServiceGetRe
  */
 export declare enum AuditPhase {
     /**
-     * AUDIT_PHASE_UNSPECIFIED is not specified
+     * AUDIT_PHASE_UNSPECIFIED is not specified.
      *
      * @generated from enum value: AUDIT_PHASE_UNSPECIFIED = 0;
      */
     UNSPECIFIED = 0,
     /**
-     * AUDIT_PHASE_REQUEST defines an audit trace in the request phase
+     * AUDIT_PHASE_REQUEST defines an audit trace in the request phase.
      *
      * @generated from enum value: AUDIT_PHASE_REQUEST = 1;
      */
     REQUEST = 1,
     /**
-     * AUDIT_PHASE_RESPONSE defines an audit trace in the response phase
+     * AUDIT_PHASE_RESPONSE defines an audit trace in the response phase.
      *
      * @generated from enum value: AUDIT_PHASE_RESPONSE = 2;
      */

package/{js/metalstack → metalstack}/api/v2/audit_pb.js

@@ -48,19 +48,19 @@ export const AuditServiceGetResponseSchema = /*@__PURE__*/ messageDesc(file_meta
 export var AuditPhase;
 (function (AuditPhase) {
     /**
-     * AUDIT_PHASE_UNSPECIFIED is not specified
+     * AUDIT_PHASE_UNSPECIFIED is not specified.
      *
      * @generated from enum value: AUDIT_PHASE_UNSPECIFIED = 0;
      */
     AuditPhase[AuditPhase["UNSPECIFIED"] = 0] = "UNSPECIFIED";
     /**
-     * AUDIT_PHASE_REQUEST defines an audit trace in the request phase
+     * AUDIT_PHASE_REQUEST defines an audit trace in the request phase.
      *
      * @generated from enum value: AUDIT_PHASE_REQUEST = 1;
      */
     AuditPhase[AuditPhase["REQUEST"] = 1] = "REQUEST";
     /**
-     * AUDIT_PHASE_RESPONSE defines an audit trace in the response phase
+     * AUDIT_PHASE_RESPONSE defines an audit trace in the response phase.
      *
      * @generated from enum value: AUDIT_PHASE_RESPONSE = 2;
      */