@metal-stack/api 0.4.4 → 0.5.2

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

@@ -6,20 +6,20 @@ import type { Message } from "@bufbuild/protobuf";
  */
 export declare const file_metalstack_api_v2_common: GenFile;
 /**
- * Paging defines paging for methods with a lot of results
+ * Paging defines paging for methods with a lot of results.
  *
  * @generated from message metalstack.api.v2.Paging
  */
 export type Paging = Message<"metalstack.api.v2.Paging"> & {
     /**
-     * Page is used for pagination, if unset only the first page is returned,
+     * Page is used for pagination, if unset only the first page is returned,.
      * the list response contains then the page number for the next page.
      *
      * @generated from field: optional uint64 page = 1;
      */
     page?: bigint | undefined;
     /**
-     * Count is the number of results returned per page, if not given server side defaults apply
+     * Count is the number of results returned per page, if not given server side defaults apply.
      *
      * @generated from field: optional uint64 count = 2;
      */
@@ -31,13 +31,13 @@ export type Paging = Message<"metalstack.api.v2.Paging"> & {
  */
 export declare const PagingSchema: GenMessage<Paging>;
 /**
- * Labels define additional information to a entity
+ * Labels define additional information to a entity.
  *
  * @generated from message metalstack.api.v2.Labels
  */
 export type Labels = Message<"metalstack.api.v2.Labels"> & {
     /**
-     * Labels consists labels
+     * Labels consists labels.
      *
      * @generated from field: map<string, string> labels = 1;
      */
@@ -51,26 +51,26 @@ export type Labels = Message<"metalstack.api.v2.Labels"> & {
  */
 export declare const LabelsSchema: GenMessage<Labels>;
 /**
- * Meta of a message
+ * Meta of a message.
  *
  * @generated from message metalstack.api.v2.Meta
  */
 export type Meta = Message<"metalstack.api.v2.Meta"> & {
     /**
-     * Tags on this entity
+     * Tags on this entity.
      *
      * @generated from field: optional metalstack.api.v2.Labels labels = 1;
      */
     labels?: Labels | undefined;
     /**
-     * CreatedAt is the date when this entity was created
+     * CreatedAt is the date when this entity was created.
      *
      * @generated from field: google.protobuf.Timestamp created_at = 2;
      */
     createdAt?: Timestamp | undefined;
     /**
-     * UpdatedAt is the date when this entity was updated
-     * must be part of the update request to ensure optimistic locking
+     * UpdatedAt is the date when this entity was updated.
+     * must be part of the update request to ensure optimistic locking.
      *
      * @generated from field: google.protobuf.Timestamp updated_at = 3;
      */
@@ -95,19 +95,19 @@ export type Meta = Message<"metalstack.api.v2.Meta"> & {
  */
 export declare const MetaSchema: GenMessage<Meta>;
 /**
- * UpdateLabels is a message to update labels
+ * UpdateLabels is a message to update labels.
  *
  * @generated from message metalstack.api.v2.UpdateLabels
  */
 export type UpdateLabels = Message<"metalstack.api.v2.UpdateLabels"> & {
     /**
-     * Strategy defines the label update strategy
+     * Strategy defines the label update strategy.
      *
      * @generated from oneof metalstack.api.v2.UpdateLabels.strategy
      */
     strategy: {
         /**
-         * Replace existing labels with the given ones
+         * Replace existing labels with the given ones.
          *
          * @generated from field: metalstack.api.v2.Labels replace = 1;
          */
@@ -115,7 +115,7 @@ export type UpdateLabels = Message<"metalstack.api.v2.UpdateLabels"> & {
         case: "replace";
     } | {
         /**
-         * Patch adds, updates or remove given labels without modifying others
+         * Patch adds, updates or remove given labels without modifying others.
          *
          * @generated from field: metalstack.api.v2.LabelsPatch patch = 2;
          */
@@ -132,19 +132,19 @@ export type UpdateLabels = Message<"metalstack.api.v2.UpdateLabels"> & {
  */
 export declare const UpdateLabelsSchema: GenMessage<UpdateLabels>;
 /**
- * LabelsPatch adds, updates or remove given labels without modifying others
+ * LabelsPatch adds, updates or remove given labels without modifying others.
  *
  * @generated from message metalstack.api.v2.LabelsPatch
  */
 export type LabelsPatch = Message<"metalstack.api.v2.LabelsPatch"> & {
     /**
-     * Update labels. New ones will be added, existing ones overwritten
+     * Update labels. New ones will be added, existing ones overwritten.
      *
      * @generated from field: metalstack.api.v2.Labels update = 1;
      */
     update?: Labels | undefined;
     /**
-     * Remove labels by key
+     * Remove labels by key.
      *
      * @generated from field: repeated string remove = 2;
      */
@@ -156,20 +156,20 @@ export type LabelsPatch = Message<"metalstack.api.v2.LabelsPatch"> & {
  */
 export declare const LabelsPatchSchema: GenMessage<LabelsPatch>;
 /**
- * UpdateMeta must be provided with every UpdateRequest to define how optimistic locking should be handled
+ * UpdateMeta must be provided with every UpdateRequest to define how optimistic locking should be handled.
  *
  * @generated from message metalstack.api.v2.UpdateMeta
  */
 export type UpdateMeta = Message<"metalstack.api.v2.UpdateMeta"> & {
     /**
-     * UpdatedAt is the date when this entity was updated
-     * must be part of the update request to ensure optimistic locking
+     * UpdatedAt is the date when this entity was updated.
+     * Must be part of the update request to ensure optimistic locking.
      *
      * @generated from field: google.protobuf.Timestamp updated_at = 1;
      */
     updatedAt?: Timestamp | undefined;
     /**
-     * LockingStrategy to be used for this update request
+     * LockingStrategy to be used for this update request.
      *
      * @generated from field: metalstack.api.v2.OptimisticLockingStrategy locking_strategy = 2;
      */
@@ -181,38 +181,38 @@ export type UpdateMeta = Message<"metalstack.api.v2.UpdateMeta"> & {
  */
 export declare const UpdateMetaSchema: GenMessage<UpdateMeta>;
 /**
- * TenantRole specifies what role a logged in user needs to call this tenant scoped service
+ * TenantRole specifies what role a logged in user needs to call this tenant scoped service.
  *
  * @generated from enum metalstack.api.v2.TenantRole
  */
 export declare enum TenantRole {
     /**
-     * TENANT_ROLE_UNSPECIFIED is not specified
+     * TENANT_ROLE_UNSPECIFIED is not specified.
      *
      * @generated from enum value: TENANT_ROLE_UNSPECIFIED = 0;
      */
     UNSPECIFIED = 0,
     /**
-     * TENANT_ROLE_OWNER the logged in user needs at least owner role to call this method
+     * TENANT_ROLE_OWNER the logged in user needs at least owner role to call this method.
      *
      * @generated from enum value: TENANT_ROLE_OWNER = 1;
      */
     OWNER = 1,
     /**
-     * TENANT_ROLE_EDITOR the logged in user needs at least editor role to call this method
+     * TENANT_ROLE_EDITOR the logged in user needs at least editor role to call this method.
      *
      * @generated from enum value: TENANT_ROLE_EDITOR = 2;
      */
     EDITOR = 2,
     /**
-     * TENANT_ROLE_VIEWER the logged in user needs at least viewer role to call this method
+     * TENANT_ROLE_VIEWER the logged in user needs at least viewer role to call this method.
      *
      * @generated from enum value: TENANT_ROLE_VIEWER = 3;
      */
     VIEWER = 3,
     /**
-     * TENANT_ROLE_GUEST the logged in user needs at least guest role to call this method
-     * The guest role is assumed by users who are invited to a tenant's project without them
+     * TENANT_ROLE_GUEST the logged in user needs at least guest role to call this method.
+     * The guest role is assumed by users who are invited to a tenant's project without them.
      * having a direct membership within the tenant.
      *
      * @generated from enum value: TENANT_ROLE_GUEST = 4;
@@ -224,31 +224,31 @@ export declare enum TenantRole {
  */
 export declare const TenantRoleSchema: GenEnum<TenantRole>;
 /**
- * ProjectRole specifies what role a logged in user needs to call this project scoped service
+ * ProjectRole specifies what role a logged in user needs to call this project scoped service.
  *
  * @generated from enum metalstack.api.v2.ProjectRole
  */
 export declare enum ProjectRole {
     /**
-     * PROJECT_ROLE_UNSPECIFIED is not specified
+     * PROJECT_ROLE_UNSPECIFIED is not specified.
      *
      * @generated from enum value: PROJECT_ROLE_UNSPECIFIED = 0;
      */
     UNSPECIFIED = 0,
     /**
-     * PROJECT_ROLE_OWNER the logged in user needs at least owner role to call this method
+     * PROJECT_ROLE_OWNER the logged in user needs at least owner role to call this method.
      *
      * @generated from enum value: PROJECT_ROLE_OWNER = 1;
      */
     OWNER = 1,
     /**
-     * PROJECT_ROLE_EDITOR the logged in user needs at least editor role to call this method
+     * PROJECT_ROLE_EDITOR the logged in user needs at least editor role to call this method.
      *
      * @generated from enum value: PROJECT_ROLE_EDITOR = 2;
      */
     EDITOR = 2,
     /**
-     * PROJECT_ROLE_VIEWER the logged in user needs at least viewer role to call this method
+     * PROJECT_ROLE_VIEWER the logged in user needs at least viewer role to call this method.
      *
      * @generated from enum value: PROJECT_ROLE_VIEWER = 3;
      */
@@ -259,25 +259,25 @@ export declare enum ProjectRole {
  */
 export declare const ProjectRoleSchema: GenEnum<ProjectRole>;
 /**
- * AdminRole specifies what role a logged in user needs to call this admin service
+ * AdminRole specifies what role a logged in user needs to call this admin service.
  *
  * @generated from enum metalstack.api.v2.AdminRole
  */
 export declare enum AdminRole {
     /**
-     * ADMIN_ROLE_UNSPECIFIED is not specified
+     * ADMIN_ROLE_UNSPECIFIED is not specified.
      *
      * @generated from enum value: ADMIN_ROLE_UNSPECIFIED = 0;
      */
     UNSPECIFIED = 0,
     /**
-     * ADMIN_ROLE_EDITOR the logged in user needs at least editor role to call this method
+     * ADMIN_ROLE_EDITOR the logged in user needs at least editor role to call this method.
      *
      * @generated from enum value: ADMIN_ROLE_EDITOR = 1;
      */
     EDITOR = 1,
     /**
-     * ADMIN_ROLE_VIEWER the logged in user needs at least viewer role to call this method
+     * ADMIN_ROLE_VIEWER the logged in user needs at least viewer role to call this method.
      *
      * @generated from enum value: ADMIN_ROLE_VIEWER = 2;
      */
@@ -288,25 +288,25 @@ export declare enum AdminRole {
  */
 export declare const AdminRoleSchema: GenEnum<AdminRole>;
 /**
- * InfraRole specifies what role a microservice needs to call this infra service
+ * InfraRole specifies what role a microservice needs to call this infra service.
  *
  * @generated from enum metalstack.api.v2.InfraRole
  */
 export declare enum InfraRole {
     /**
-     * INFRA_ROLE_UNSPECIFIED is not specified
+     * INFRA_ROLE_UNSPECIFIED is not specified.
      *
      * @generated from enum value: INFRA_ROLE_UNSPECIFIED = 0;
      */
     UNSPECIFIED = 0,
     /**
-     * INFRA_ROLE_EDITOR a microservice needs at least editor role to call this method
+     * INFRA_ROLE_EDITOR a microservice needs at least editor role to call this method.
      *
      * @generated from enum value: INFRA_ROLE_EDITOR = 1;
      */
     EDITOR = 1,
     /**
-     * INFRA_ROLE_VIEWER a microservice needs at least viewer role to call this method
+     * INFRA_ROLE_VIEWER a microservice needs at least viewer role to call this method.
      *
      * @generated from enum value: INFRA_ROLE_VIEWER = 2;
      */
@@ -317,25 +317,25 @@ export declare enum InfraRole {
  */
 export declare const InfraRoleSchema: GenEnum<InfraRole>;
 /**
- * MachineRole specifies what role a microservice needs to call this machine service
+ * MachineRole specifies what role a microservice needs to call this machine service.
  *
  * @generated from enum metalstack.api.v2.MachineRole
  */
 export declare enum MachineRole {
     /**
-     * MACHINE_ROLE_UNSPECIFIED is not specified
+     * MACHINE_ROLE_UNSPECIFIED is not specified.
      *
      * @generated from enum value: MACHINE_ROLE_UNSPECIFIED = 0;
      */
     UNSPECIFIED = 0,
     /**
-     * MACHINE_ROLE_EDITOR a microservice needs at least editor role to call this method
+     * MACHINE_ROLE_EDITOR a microservice needs at least editor role to call this method.
      *
      * @generated from enum value: MACHINE_ROLE_EDITOR = 1;
      */
     EDITOR = 1,
     /**
-     * MACHINE_ROLE_VIEWER a microservice needs at least viewer role to call this method
+     * MACHINE_ROLE_VIEWER a microservice needs at least viewer role to call this method.
      *
      * @generated from enum value: MACHINE_ROLE_VIEWER = 2;
      */
@@ -346,25 +346,25 @@ export declare enum MachineRole {
  */
 export declare const MachineRoleSchema: GenEnum<MachineRole>;
 /**
- * Visibility of a method
+ * Visibility of a method.
  *
  * @generated from enum metalstack.api.v2.Visibility
  */
 export declare enum Visibility {
     /**
-     * VISIBILITY_UNSPECIFIED is not defined
+     * VISIBILITY_UNSPECIFIED is not defined.
      *
      * @generated from enum value: VISIBILITY_UNSPECIFIED = 0;
      */
     UNSPECIFIED = 0,
     /**
-     * VISIBILITY_PUBLIC specifies that this service is accessible without authentication
+     * VISIBILITY_PUBLIC specifies that this service is accessible without authentication.
      *
      * @generated from enum value: VISIBILITY_PUBLIC = 1;
      */
     PUBLIC = 1,
     /**
-     * VISIBILITY_SELF restricts calls to the authenticated user only
+     * VISIBILITY_SELF restricts calls to the authenticated user only.
      *
      * @generated from enum value: VISIBILITY_SELF = 2;
      */
@@ -375,27 +375,27 @@ export declare enum Visibility {
  */
 export declare const VisibilitySchema: GenEnum<Visibility>;
 /**
- * Auditing option specified per service method
- * by default all service methods are included
- * add the auditing option if you want to exclude a method in auditing
+ * Auditing option specified per service method.
+ * By default all service methods are included.
+ * Add the auditing option if you want to exclude a method in auditing.
  *
  * @generated from enum metalstack.api.v2.Auditing
  */
 export declare enum Auditing {
     /**
-     * AUDITING_UNSPECIFIED is not specified
+     * AUDITING_UNSPECIFIED is not specified.
      *
      * @generated from enum value: AUDITING_UNSPECIFIED = 0;
      */
     UNSPECIFIED = 0,
     /**
-     * AUDITING_INCLUDED if a method is annotated with this, all calls are audited
+     * AUDITING_INCLUDED if a method is annotated with this, all calls are audited.
      *
      * @generated from enum value: AUDITING_INCLUDED = 1;
      */
     INCLUDED = 1,
     /**
-     * AUDITING_EXCLUDED if a method is annotated with this, no calls are audited
+     * AUDITING_EXCLUDED if a method is annotated with this, no calls are audited.
      *
      * @generated from enum value: AUDITING_EXCLUDED = 2;
      */
@@ -407,26 +407,26 @@ export declare enum Auditing {
 export declare const AuditingSchema: GenEnum<Auditing>;
 /**
  * OptimisticLockingStrategy defines how optimistic locking should be handled.
- * It defaults to client side, which requires the UpdatedAt timestamp to be provided
+ * It defaults to client side, which requires the UpdatedAt timestamp to be provided.
  *
  * @generated from enum metalstack.api.v2.OptimisticLockingStrategy
  */
 export declare enum OptimisticLockingStrategy {
     /**
-     * OPTIMISTIC_LOCKING_STRATEGY_UNSPECIFIED same as client side
+     * OPTIMISTIC_LOCKING_STRATEGY_UNSPECIFIED same as client side.
      *
      * @generated from enum value: OPTIMISTIC_LOCKING_STRATEGY_UNSPECIFIED = 0;
      */
     UNSPECIFIED = 0,
     /**
-     * OPTIMISTIC_LOCKING_STRATEGY_CLIENT requires UpdatedAt to be specified
+     * OPTIMISTIC_LOCKING_STRATEGY_CLIENT requires UpdatedAt to be specified.
      *
      * @generated from enum value: OPTIMISTIC_LOCKING_STRATEGY_CLIENT = 1;
      */
     CLIENT = 1,
     /**
-     * OPTIMISTIC_LOCKING_STRATEGY_SERVER allows to omit UpdatedAt
-     * and fetches the most recent entity before updating with the given values with the update request
+     * OPTIMISTIC_LOCKING_STRATEGY_SERVER allows to omit UpdatedAt.
+     * and fetches the most recent entity before updating with the given values with the update request.
      *
      * @generated from enum value: OPTIMISTIC_LOCKING_STRATEGY_SERVER = 2;
      */
@@ -437,49 +437,49 @@ export declare enum OptimisticLockingStrategy {
  */
 export declare const OptimisticLockingStrategySchema: GenEnum<OptimisticLockingStrategy>;
 /**
- * TenantRoles are used to define the tenant role a logged in user must provide to call this method
+ * TenantRoles are used to define the tenant role a logged in user must provide to call this method.
  *
  * @generated from extension: repeated metalstack.api.v2.TenantRole tenant_roles = 51000;
  */
 export declare const tenant_roles: GenExtension<MethodOptions, TenantRole[]>;
 /**
- * ProjectRoles are used to define the project role a logged in user must provide to call this method
+ * ProjectRoles are used to define the project role a logged in user must provide to call this method.
  *
  * @generated from extension: repeated metalstack.api.v2.ProjectRole project_roles = 51001;
  */
 export declare const project_roles: GenExtension<MethodOptions, ProjectRole[]>;
 /**
- * AdminRoles are used to define the admin role a logged in user must provide to call this method
+ * AdminRoles are used to define the admin role a logged in user must provide to call this method.
  *
  * @generated from extension: repeated metalstack.api.v2.AdminRole admin_roles = 51002;
  */
 export declare const admin_roles: GenExtension<MethodOptions, AdminRole[]>;
 /**
- * Visibility defines the visibility of this method, this is used to have public or self visible methods
+ * Visibility defines the visibility of this method, this is used to have public or self visible methods.
  *
  * @generated from extension: metalstack.api.v2.Visibility visibility = 51003;
  */
 export declare const visibility: GenExtension<MethodOptions, Visibility>;
 /**
- * Auditing defines if calls to this method should be audited or not
+ * Auditing defines if calls to this method should be audited or not.
  *
  * @generated from extension: metalstack.api.v2.Auditing auditing = 51004;
  */
 export declare const auditing: GenExtension<MethodOptions, Auditing>;
 /**
- * InfraRoles are used to define the infra role a microservice must provide to call this method
+ * InfraRoles are used to define the infra role a microservice must provide to call this method.
  *
  * @generated from extension: repeated metalstack.api.v2.InfraRole infra_roles = 51005;
  */
 export declare const infra_roles: GenExtension<MethodOptions, InfraRole[]>;
 /**
- * MachineRole are used to define which machine role a microservice must provide to call this method
+ * MachineRole are used to define which machine role a microservice must provide to call this method.
  *
  * @generated from extension: repeated metalstack.api.v2.MachineRole machine_roles = 51006;
  */
 export declare const machine_roles: GenExtension<MethodOptions, MachineRole[]>;
 /**
- * StringValue which can be set to a enum
+ * StringValue which can be set to a enum.
  *
  * @generated from extension: string enum_string_value = 52000;
  */