@metal-stack/api 0.0.40-beta.0

package/js/metalstack/api/v2/common_pb.ts

@@ -0,0 +1,488 @@
+// @generated by protoc-gen-es v2.11.0 with parameter "target=ts"
+// @generated from file metalstack/api/v2/common.proto (package metalstack.api.v2, syntax proto3)
+/* eslint-disable */
+
+import type { GenEnum, GenExtension, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
+import { enumDesc, extDesc, fileDesc, messageDesc } from "@bufbuild/protobuf/codegenv2";
+import { file_buf_validate_validate } from "../../../buf/validate/validate_pb";
+import type { EnumValueOptions, MethodOptions, Timestamp } from "@bufbuild/protobuf/wkt";
+import { file_google_protobuf_descriptor, file_google_protobuf_timestamp } from "@bufbuild/protobuf/wkt";
+import type { Message } from "@bufbuild/protobuf";
+
+/**
+ * Describes the file metalstack/api/v2/common.proto.
+ */
+export const file_metalstack_api_v2_common: GenFile = /*@__PURE__*/
+  fileDesc("Ch5tZXRhbHN0YWNrL2FwaS92Mi9jb21tb24ucHJvdG8SEW1ldGFsc3RhY2suYXBpLnYyIkIKBlBhZ2luZxIRCgRwYWdlGAEgASgESACIAQESEgoFY291bnQYAiABKARIAYgBAUIHCgVfcGFnZUIICgZfY291bnQiiAEKBkxhYmVscxJPCgZsYWJlbHMYASADKAsyJS5tZXRhbHN0YWNrLmFwaS52Mi5MYWJlbHMuTGFiZWxzRW50cnlCGLpIFZoBEiIHcgUQARiAAioHcgUQABiAAhotCgtMYWJlbHNFbnRyeRILCgNrZXkYASABKAkSDQoFdmFsdWUYAiABKAk6AjgBIrUBCgRNZXRhEi4KBmxhYmVscxgBIAEoCzIZLm1ldGFsc3RhY2suYXBpLnYyLkxhYmVsc0gAiAEBEi4KCmNyZWF0ZWRfYXQYAiABKAsyGi5nb29nbGUucHJvdG9idWYuVGltZXN0YW1wEi4KCnVwZGF0ZWRfYXQYAyABKAsyGi5nb29nbGUucHJvdG9idWYuVGltZXN0YW1wEhIKCmdlbmVyYXRpb24YBCABKARCCQoHX2xhYmVscyJJCgxVcGRhdGVMYWJlbHMSKQoGdXBkYXRlGAEgASgLMhkubWV0YWxzdGFjay5hcGkudjIuTGFiZWxzEg4KBnJlbW92ZRgCIAMoCSKOAQoKVXBkYXRlTWV0YRIuCgp1cGRhdGVkX2F0GAEgASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcBJQChBsb2NraW5nX3N0cmF0ZWd5GAIgASgOMiwubWV0YWxzdGFjay5hcGkudjIuT3B0aW1pc3RpY0xvY2tpbmdTdHJhdGVneUIIukgFggECEAEqhwEKClRlbmFudFJvbGUSGwoXVEVOQU5UX1JPTEVfVU5TUEVDSUZJRUQQABIVChFURU5BTlRfUk9MRV9PV05FUhABEhYKElRFTkFOVF9ST0xFX0VESVRPUhACEhYKElRFTkFOVF9ST0xFX1ZJRVdFUhADEhUKEVRFTkFOVF9ST0xFX0dVRVNUEAQqdQoLUHJvamVjdFJvbGUSHAoYUFJPSkVDVF9ST0xFX1VOU1BFQ0lGSUVEEAASFgoSUFJPSkVDVF9ST0xFX09XTkVSEAESFwoTUFJPSkVDVF9ST0xFX0VESVRPUhACEhcKE1BST0pFQ1RfUk9MRV9WSUVXRVIQAypVCglBZG1pblJvbGUSGgoWQURNSU5fUk9MRV9VTlNQRUNJRklFRBAAEhUKEUFETUlOX1JPTEVfRURJVE9SEAESFQoRQURNSU5fUk9MRV9WSUVXRVIQAipVCglJbmZyYVJvbGUSGgoWSU5GUkFfUk9MRV9VTlNQRUNJRklFRBAAEhUKEUlORlJBX1JPTEVfRURJVE9SEAESFQoRSU5GUkFfUk9MRV9WSUVXRVIQAipUCgpWaXNpYmlsaXR5EhoKFlZJU0lCSUxJVFlfVU5TUEVDSUZJRUQQABIVChFWSVNJQklMSVRZX1BVQkxJQxABEhMKD1ZJU0lCSUxJVFlfU0VMRhADKlIKCEF1ZGl0aW5nEhgKFEFVRElUSU5HX1VOU1BFQ0lGSUVEEAASFQoRQVVESVRJTkdfSU5DTFVERUQQARIVChFBVURJVElOR19FWENMVURFRBACKpgBChlPcHRpbWlzdGljTG9ja2luZ1N0cmF0ZWd5EisKJ09QVElNSVNUSUNfTE9DS0lOR19TVFJBVEVHWV9VTlNQRUNJRklFRBAAEiYKIk9QVElNSVNUSUNfTE9DS0lOR19TVFJBVEVHWV9DTElFTlQQARImCiJPUFRJTUlTVElDX0xPQ0tJTkdfU1RSQVRFR1lfU0VSVkVSEAI6YgoMdGVuYW50X3JvbGVzEh4uZ29vZ2xlLnByb3RvYnVmLk1ldGhvZE9wdGlvbnMYuI4DIAMoDjIdLm1ldGFsc3RhY2suYXBpLnYyLlRlbmFudFJvbGVSC3RlbmFudFJvbGVzOmUKDXByb2plY3Rfcm9sZXMSHi5nb29nbGUucHJvdG9idWYuTWV0aG9kT3B0aW9ucxi5jgMgAygOMh4ubWV0YWxzdGFjay5hcGkudjIuUHJvamVjdFJvbGVSDHByb2plY3RSb2xlczpfCgthZG1pbl9yb2xlcxIeLmdvb2dsZS5wcm90b2J1Zi5NZXRob2RPcHRpb25zGLqOAyADKA4yHC5tZXRhbHN0YWNrLmFwaS52Mi5BZG1pblJvbGVSCmFkbWluUm9sZXM6XwoKdmlzaWJpbGl0eRIeLmdvb2dsZS5wcm90b2J1Zi5NZXRob2RPcHRpb25zGLuOAyABKA4yHS5tZXRhbHN0YWNrLmFwaS52Mi5WaXNpYmlsaXR5Ugp2aXNpYmlsaXR5OlkKCGF1ZGl0aW5nEh4uZ29vZ2xlLnByb3RvYnVmLk1ldGhvZE9wdGlvbnMYvI4DIAEoDjIbLm1ldGFsc3RhY2suYXBpLnYyLkF1ZGl0aW5nUghhdWRpdGluZzpfCgtpbmZyYV9yb2xlcxIeLmdvb2dsZS5wcm90b2J1Zi5NZXRob2RPcHRpb25zGL2OAyADKA4yHC5tZXRhbHN0YWNrLmFwaS52Mi5JbmZyYVJvbGVSCmluZnJhUm9sZXM6TwoRZW51bV9zdHJpbmdfdmFsdWUSIS5nb29nbGUucHJvdG9idWYuRW51bVZhbHVlT3B0aW9ucxiglgMgASgJUg9lbnVtU3RyaW5nVmFsdWVCwQEKFWNvbS5tZXRhbHN0YWNrLmFwaS52MkILQ29tbW9uUHJvdG9QAVo1Z2l0aHViLmNvbS9tZXRhbC1zdGFjay9hcGkvZ28vbWV0YWxzdGFjay9hcGkvdjI7YXBpdjKiAgNNQViqAhFNZXRhbHN0YWNrLkFwaS5WMsoCEU1ldGFsc3RhY2tcQXBpXFYy4gIdTWV0YWxzdGFja1xBcGlcVjJcR1BCTWV0YWRhdGHqAhNNZXRhbHN0YWNrOjpBcGk6OlYyYgZwcm90bzM", [file_buf_validate_validate, file_google_protobuf_descriptor, file_google_protobuf_timestamp]);
+
+/**
+ * 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,
+   * the list response contains then the page number for the next page.
+   *
+   * @generated from field: optional uint64 page = 1;
+   */
+  page?: bigint;
+
+  /**
+   * Count is the number of results returned per page, if not given server side defaults apply
+   *
+   * @generated from field: optional uint64 count = 2;
+   */
+  count?: bigint;
+};
+
+/**
+ * Describes the message metalstack.api.v2.Paging.
+ * Use `create(PagingSchema)` to create a new message.
+ */
+export const PagingSchema: GenMessage<Paging> = /*@__PURE__*/
+  messageDesc(file_metalstack_api_v2_common, 0);
+
+/**
+ * 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
+   *
+   * @generated from field: map<string, string> labels = 1;
+   */
+  labels: { [key: string]: string };
+};
+
+/**
+ * Describes the message metalstack.api.v2.Labels.
+ * Use `create(LabelsSchema)` to create a new message.
+ */
+export const LabelsSchema: GenMessage<Labels> = /*@__PURE__*/
+  messageDesc(file_metalstack_api_v2_common, 1);
+
+/**
+ * Meta of a message
+ *
+ * @generated from message metalstack.api.v2.Meta
+ */
+export type Meta = Message<"metalstack.api.v2.Meta"> & {
+  /**
+   * Tags on this entity
+   *
+   * @generated from field: optional metalstack.api.v2.Labels labels = 1;
+   */
+  labels?: Labels;
+
+  /**
+   * CreatedAt is the date when this entity was created
+   *
+   * @generated from field: google.protobuf.Timestamp created_at = 2;
+   */
+  createdAt?: Timestamp;
+
+  /**
+   * 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;
+   */
+  updatedAt?: Timestamp;
+
+  /**
+   * Generation identifies how often this entity was modified since creation.
+   *
+   * @generated from field: uint64 generation = 4;
+   */
+  generation: bigint;
+};
+
+/**
+ * Describes the message metalstack.api.v2.Meta.
+ * Use `create(MetaSchema)` to create a new message.
+ */
+export const MetaSchema: GenMessage<Meta> = /*@__PURE__*/
+  messageDesc(file_metalstack_api_v2_common, 2);
+
+/**
+ * UpdateLabels is a message to update labels
+ *
+ * @generated from message metalstack.api.v2.UpdateLabels
+ */
+export type UpdateLabels = Message<"metalstack.api.v2.UpdateLabels"> & {
+  /**
+   * Update labels. New ones will be added, existing ones overwritten
+   *
+   * @generated from field: metalstack.api.v2.Labels update = 1;
+   */
+  update?: Labels;
+
+  /**
+   * Remove labels by key
+   *
+   * @generated from field: repeated string remove = 2;
+   */
+  remove: string[];
+};
+
+/**
+ * Describes the message metalstack.api.v2.UpdateLabels.
+ * Use `create(UpdateLabelsSchema)` to create a new message.
+ */
+export const UpdateLabelsSchema: GenMessage<UpdateLabels> = /*@__PURE__*/
+  messageDesc(file_metalstack_api_v2_common, 3);
+
+/**
+ * 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
+   *
+   * @generated from field: google.protobuf.Timestamp updated_at = 1;
+   */
+  updatedAt?: Timestamp;
+
+  /**
+   * LockingStrategy to be used for this update request
+   *
+   * @generated from field: metalstack.api.v2.OptimisticLockingStrategy locking_strategy = 2;
+   */
+  lockingStrategy: OptimisticLockingStrategy;
+};
+
+/**
+ * Describes the message metalstack.api.v2.UpdateMeta.
+ * Use `create(UpdateMetaSchema)` to create a new message.
+ */
+export const UpdateMetaSchema: GenMessage<UpdateMeta> = /*@__PURE__*/
+  messageDesc(file_metalstack_api_v2_common, 4);
+
+/**
+ * TenantRole specifies what role a logged in user needs to call this tenant scoped service
+ *
+ * @generated from enum metalstack.api.v2.TenantRole
+ */
+export enum TenantRole {
+  /**
+   * 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
+   *
+   * @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
+   *
+   * @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
+   *
+   * @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
+   * having a direct membership within the tenant.
+   *
+   * @generated from enum value: TENANT_ROLE_GUEST = 4;
+   */
+  GUEST = 4,
+}
+
+/**
+ * Describes the enum metalstack.api.v2.TenantRole.
+ */
+export const TenantRoleSchema: GenEnum<TenantRole> = /*@__PURE__*/
+  enumDesc(file_metalstack_api_v2_common, 0);
+
+/**
+ * ProjectRole specifies what role a logged in user needs to call this project scoped service
+ *
+ * @generated from enum metalstack.api.v2.ProjectRole
+ */
+export enum ProjectRole {
+  /**
+   * 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
+   *
+   * @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
+   *
+   * @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
+   *
+   * @generated from enum value: PROJECT_ROLE_VIEWER = 3;
+   */
+  VIEWER = 3,
+}
+
+/**
+ * Describes the enum metalstack.api.v2.ProjectRole.
+ */
+export const ProjectRoleSchema: GenEnum<ProjectRole> = /*@__PURE__*/
+  enumDesc(file_metalstack_api_v2_common, 1);
+
+/**
+ * AdminRole specifies what role a logged in user needs to call this admin service
+ *
+ * @generated from enum metalstack.api.v2.AdminRole
+ */
+export enum AdminRole {
+  /**
+   * 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
+   *
+   * @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
+   *
+   * @generated from enum value: ADMIN_ROLE_VIEWER = 2;
+   */
+  VIEWER = 2,
+}
+
+/**
+ * Describes the enum metalstack.api.v2.AdminRole.
+ */
+export const AdminRoleSchema: GenEnum<AdminRole> = /*@__PURE__*/
+  enumDesc(file_metalstack_api_v2_common, 2);
+
+/**
+ * InfraRole specifies what role a microservice needs to call this infra service
+ *
+ * @generated from enum metalstack.api.v2.InfraRole
+ */
+export enum InfraRole {
+  /**
+   * 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
+   *
+   * @generated from enum value: INFRA_ROLE_EDITOR = 1;
+   */
+  EDITOR = 1,
+
+  /**
+   * INFRA_ROLE_VIEWER a microservice needs at least viewer role to call this method
+   *
+   * @generated from enum value: INFRA_ROLE_VIEWER = 2;
+   */
+  VIEWER = 2,
+}
+
+/**
+ * Describes the enum metalstack.api.v2.InfraRole.
+ */
+export const InfraRoleSchema: GenEnum<InfraRole> = /*@__PURE__*/
+  enumDesc(file_metalstack_api_v2_common, 3);
+
+/**
+ * Visibility of a method
+ *
+ * @generated from enum metalstack.api.v2.Visibility
+ */
+export enum Visibility {
+  /**
+   * VISIBILITY_UNSPECIFIED is not defined
+   *
+   * @generated from enum value: VISIBILITY_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * VISIBILITY_PUBLIC specifies that this service is accessible without authentication
+   *
+   * @generated from enum value: VISIBILITY_PUBLIC = 1;
+   */
+  PUBLIC = 1,
+
+  /**
+   * VISIBILITY_SELF enable call this endpoint from the authenticated user only
+   *
+   * @generated from enum value: VISIBILITY_SELF = 3;
+   */
+  SELF = 3,
+}
+
+/**
+ * Describes the enum metalstack.api.v2.Visibility.
+ */
+export const VisibilitySchema: GenEnum<Visibility> = /*@__PURE__*/
+  enumDesc(file_metalstack_api_v2_common, 4);
+
+/**
+ * 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 enum Auditing {
+  /**
+   * 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
+   *
+   * @generated from enum value: AUDITING_INCLUDED = 1;
+   */
+  INCLUDED = 1,
+
+  /**
+   * AUDITING_EXCLUDED if a method is annotated with this, no calls are audited
+   *
+   * @generated from enum value: AUDITING_EXCLUDED = 2;
+   */
+  EXCLUDED = 2,
+}
+
+/**
+ * Describes the enum metalstack.api.v2.Auditing.
+ */
+export const AuditingSchema: GenEnum<Auditing> = /*@__PURE__*/
+  enumDesc(file_metalstack_api_v2_common, 5);
+
+/**
+ * OptimisticLockingStrategy defines how optimistic locking should be handled.
+ * It defaults to client side, which requires the UpdatedAt timestamp to be provided
+ *
+ * @generated from enum metalstack.api.v2.OptimisticLockingStrategy
+ */
+export enum OptimisticLockingStrategy {
+  /**
+   * 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
+   *
+   * @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
+   *
+   * @generated from enum value: OPTIMISTIC_LOCKING_STRATEGY_SERVER = 2;
+   */
+  SERVER = 2,
+}
+
+/**
+ * Describes the enum metalstack.api.v2.OptimisticLockingStrategy.
+ */
+export const OptimisticLockingStrategySchema: GenEnum<OptimisticLockingStrategy> = /*@__PURE__*/
+  enumDesc(file_metalstack_api_v2_common, 6);
+
+/**
+ * TenantRoles are used to define which tenant role a logged in user must provide to call this method
+ *
+ * @generated from extension: repeated metalstack.api.v2.TenantRole tenant_roles = 51000;
+ */
+export const tenant_roles: GenExtension<MethodOptions, TenantRole[]> = /*@__PURE__*/
+  extDesc(file_metalstack_api_v2_common, 0);
+
+/**
+ * ProjectRoles are used to define which project role a logged in user must provide to call this method
+ *
+ * @generated from extension: repeated metalstack.api.v2.ProjectRole project_roles = 51001;
+ */
+export const project_roles: GenExtension<MethodOptions, ProjectRole[]> = /*@__PURE__*/
+  extDesc(file_metalstack_api_v2_common, 1);
+
+/**
+ * AdminRoles are used to define which admin role a logged in user must provide to call this method
+ *
+ * @generated from extension: repeated metalstack.api.v2.AdminRole admin_roles = 51002;
+ */
+export const admin_roles: GenExtension<MethodOptions, AdminRole[]> = /*@__PURE__*/
+  extDesc(file_metalstack_api_v2_common, 2);
+
+/**
+ * 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 const visibility: GenExtension<MethodOptions, Visibility> = /*@__PURE__*/
+  extDesc(file_metalstack_api_v2_common, 3);
+
+/**
+ * Auditing defines if calls to this method should be audited or not
+ *
+ * @generated from extension: metalstack.api.v2.Auditing auditing = 51004;
+ */
+export const auditing: GenExtension<MethodOptions, Auditing> = /*@__PURE__*/
+  extDesc(file_metalstack_api_v2_common, 4);
+
+/**
+ * InfraRoles are used to define which infra role a microservice must provide to call this method
+ *
+ * @generated from extension: repeated metalstack.api.v2.InfraRole infra_roles = 51005;
+ */
+export const infra_roles: GenExtension<MethodOptions, InfraRole[]> = /*@__PURE__*/
+  extDesc(file_metalstack_api_v2_common, 5);
+
+/**
+ * StringValue which can be set to a enum
+ *
+ * @generated from extension: string enum_string_value = 52000;
+ */
+export const enum_string_value: GenExtension<EnumValueOptions, string> = /*@__PURE__*/
+  extDesc(file_metalstack_api_v2_common, 6);
+