@octelium/apis 1.0.6 → 1.0.8

package/main/cordiumv1/cordiumv1.client.d.ts

@@ -67,113 +67,168 @@ import type { Secret } from "./cordiumv1.js";
 import type { UnaryCall } from "@protobuf-ts/runtime-rpc";
 import type { RpcOptions } from "@protobuf-ts/runtime-rpc";
 /**
+ * MainService is the primary Cordium API that is used by the Users (i.e. via
+ * the `cordium` CLI, the web portal and the SDKs) to manage their Spaces,
+ * Templates, Workspaces, Memberships, Secrets, UserSecrets, GitProviders and
+ * their UserConfig. Every method is executed on behalf of the authenticated
+ * Octelium User and is authorized against that User's ownership of the
+ * resource and/or their Membership role in the resource's Space.
+ *
  * @generated from protobuf service octelium.api.main.cordium.v1.MainService
  */
 export interface IMainServiceClient {
     /**
-     * CreateSecret creates a Secret
+     * CreateSecret creates a Secret inside a Space. The caller must be at least
+     * an ADMIN Member of the Space. The Secret data is never returned back by
+     * the Cluster once the Secret is created.
      *
      * @generated from protobuf rpc: CreateSecret
      */
     createSecret(input: Secret, options?: RpcOptions): UnaryCall<Secret, Secret>;
     /**
-     * ListSecret lists Secrets
+     * ListSecret lists the Secrets of a Space. The Secrets' data is not
+     * included in the response.
      *
      * @generated from protobuf rpc: ListSecret
      */
     listSecret(input: ListSecretOptions, options?: RpcOptions): UnaryCall<ListSecretOptions, SecretList>;
     /**
-     * DeleteWorkspace deletes a Workspace
+     * DeleteSecret deletes a Secret. The caller must be at least an ADMIN Member
+     * of the Secret's Space.
      *
      * @generated from protobuf rpc: DeleteSecret
      */
     deleteSecret(input: DeleteOptions, options?: RpcOptions): UnaryCall<DeleteOptions, OperationResult>;
     /**
-     * GetWorkspace retrieves a specific Workspace
+     * GetSecret retrieves a specific Secret. The Secret data is not included in
+     * the response.
      *
      * @generated from protobuf rpc: GetSecret
      */
     getSecret(input: GetOptions, options?: RpcOptions): UnaryCall<GetOptions, Secret>;
     /**
-     * CreateTemplate creates a Template owned by the User.
+     * CreateTemplate creates a Template inside a Space. The caller must be at
+     * least an ADMIN Member of the Space.
      *
      * @generated from protobuf rpc: CreateTemplate
      */
     createTemplate(input: Template, options?: RpcOptions): UnaryCall<Template, Template>;
     /**
-     * UpdateTemplate updates a Template owned by the User.
+     * UpdateTemplate updates a Template. The caller must be at least an ADMIN
+     * Member of the Template's Space.
      *
      * @generated from protobuf rpc: UpdateTemplate
      */
     updateTemplate(input: Template, options?: RpcOptions): UnaryCall<Template, Template>;
     /**
-     * DeleteTemplate deletes a Template owned by the User.
+     * DeleteTemplate deletes a Template. The default Template of a Space cannot
+     * be deleted.
      *
      * @generated from protobuf rpc: DeleteTemplate
      */
     deleteTemplate(input: DeleteOptions, options?: RpcOptions): UnaryCall<DeleteOptions, OperationResult>;
     /**
+     * BuildTemplate starts a pre-build for a Template. A pre-build runs a
+     * hidden build Workspace whose storage is snapshotted once it successfully
+     * completes so that the subsequent Workspaces of the Template can be
+     * restored from that snapshot instead of being initialized from scratch. A
+     * Template can only have one running pre-build at a time. Starting a new
+     * pre-build cancels the currently running one, if any.
+     *
      * @generated from protobuf rpc: BuildTemplate
      */
     buildTemplate(input: BuildTemplateRequest, options?: RpcOptions): UnaryCall<BuildTemplateRequest, Template>;
     /**
+     * CancelBuildTemplate cancels the currently running pre-build of a Template,
+     * if any, and returns the updated Template.
+     *
      * @generated from protobuf rpc: CancelBuildTemplate
      */
     cancelBuildTemplate(input: CancelBuildTemplateRequest, options?: RpcOptions): UnaryCall<CancelBuildTemplateRequest, Template>;
     /**
-     * CreateTemplate creates a Template owned by the User.
+     * CreateSpace creates a Space owned by the User. Whether a User is allowed
+     * to own a Space is controlled by the Space ownership rules of the
+     * ClusterConfig. A default Membership and a default Template are
+     * automatically created along with the Space.
      *
      * @generated from protobuf rpc: CreateSpace
      */
     createSpace(input: Space, options?: RpcOptions): UnaryCall<Space, Space>;
     /**
-     * UpdateTemplate updates a Template owned by the User.
+     * UpdateSpace updates a Space. The caller must be the Space creator or an
+     * OWNER Member of the Space.
      *
      * @generated from protobuf rpc: UpdateSpace
      */
     updateSpace(input: Space, options?: RpcOptions): UnaryCall<Space, Space>;
     /**
-     * DeleteTemplate deletes a Template owned by the User.
+     * DeleteSpace deletes a Space as well as all of its Memberships, Templates,
+     * Secrets and GitProviders.
      *
      * @generated from protobuf rpc: DeleteSpace
      */
     deleteSpace(input: DeleteOptions, options?: RpcOptions): UnaryCall<DeleteOptions, OperationResult>;
     /**
+     * CreateMembership adds a User as a Member to a Space. The caller must be at
+     * least an ADMIN Member of the Space. Members can currently only be added to
+     * ORGANIZATION Spaces.
+     *
      * @generated from protobuf rpc: CreateMembership
      */
     createMembership(input: CreateMembershipRequest, options?: RpcOptions): UnaryCall<CreateMembershipRequest, Membership>;
     /**
+     * DeleteMembership removes a Member from a Space. The caller must be at
+     * least an ADMIN Member of the Space. Space creators cannot be removed.
+     *
      * @generated from protobuf rpc: DeleteMembership
      */
     deleteMembership(input: DeleteOptions, options?: RpcOptions): UnaryCall<DeleteOptions, OperationResult>;
     /**
+     * GetSpaceMembership retrieves the Membership of the calling User in a
+     * specific Space.
+     *
      * @generated from protobuf rpc: GetSpaceMembership
      */
     getSpaceMembership(input: GetSpaceMembershipRequest, options?: RpcOptions): UnaryCall<GetSpaceMembershipRequest, Membership>;
     /**
+     * UpdateMembership updates a Membership (i.e. its Role). The caller must be
+     * at least an ADMIN Member of the Space. Setting a Role to OWNER
+     * additionally requires the caller to be an OWNER.
+     *
      * @generated from protobuf rpc: UpdateMembership
      */
     updateMembership(input: Membership, options?: RpcOptions): UnaryCall<Membership, Membership>;
     /**
+     * CreateGitProvider creates a GitProvider inside a Space. The caller must be
+     * at least an ADMIN Member of the Space.
+     *
      * @generated from protobuf rpc: CreateGitProvider
      */
     createGitProvider(input: GitProvider, options?: RpcOptions): UnaryCall<GitProvider, GitProvider>;
     /**
+     * UpdateGitProvider updates a GitProvider.
+     *
      * @generated from protobuf rpc: UpdateGitProvider
      */
     updateGitProvider(input: GitProvider, options?: RpcOptions): UnaryCall<GitProvider, GitProvider>;
     /**
+     * DeleteGitProvider deletes a GitProvider.
+     *
      * @generated from protobuf rpc: DeleteGitProvider
      */
     deleteGitProvider(input: DeleteOptions, options?: RpcOptions): UnaryCall<DeleteOptions, OperationResult>;
     /**
-     * CreateWorkspace creates a Workspace owned by the User.
+     * CreateWorkspace creates a Workspace owned by the User. The Workspace is
+     * created in the STOPPED state and it is assigned a short randomly generated
+     * name by the Cluster. If no Template is set in the request's
+     * `status.templateRef`, the User's default Template is used.
      *
      * @generated from protobuf rpc: CreateWorkspace
      */
     createWorkspace(input: Workspace, options?: RpcOptions): UnaryCall<Workspace, Workspace>;
     /**
-     * UpdateWorkspace updates a Workspace owned by the User.
+     * UpdateWorkspace updates a Workspace owned by the User. Only the
+     * Workspace's displayName and spec can be updated.
      *
      * @generated from protobuf rpc: UpdateWorkspace
      */
@@ -191,107 +246,177 @@ export interface IMainServiceClient {
      */
     listWorkspace(input: ListWorkspaceOptions, options?: RpcOptions): UnaryCall<ListWorkspaceOptions, WorkspaceList>;
     /**
+     * StartWorkspace starts a stopped Workspace. The Cluster creates a dedicated
+     * Octelium Session for the run and moves the Workspace to the INIT_REQUEST
+     * state. The actual initialization is asynchronous and can be followed via
+     * the WatchWorkspace method.
+     *
      * @generated from protobuf rpc: StartWorkspace
      */
     startWorkspace(input: StartWorkspaceRequest, options?: RpcOptions): UnaryCall<StartWorkspaceRequest, StartWorkspaceResponse>;
     /**
+     * StopWorkspace requests a graceful stop of a running Workspace. The
+     * Workspace moves to the STOPPING_REQUEST state and the stoppage itself is
+     * asynchronous.
+     *
      * @generated from protobuf rpc: StopWorkspace
      */
     stopWorkspace(input: StopWorkspaceRequest, options?: RpcOptions): UnaryCall<StopWorkspaceRequest, StopWorkspaceResponse>;
     /**
+     * ShareWorkspacePort shares a named Application of a Workspace with other
+     * Users so that they can access it via the Workspace's public hostname.
+     *
      * @generated from protobuf rpc: ShareWorkspacePort
      */
     shareWorkspacePort(input: ShareWorkspacePortRequest, options?: RpcOptions): UnaryCall<ShareWorkspacePortRequest, ShareWorkspacePortResponse>;
     /**
+     * UnshareWorkspacePort stops sharing a previously shared named Application
+     * of a Workspace.
+     *
      * @generated from protobuf rpc: UnshareWorkspacePort
      */
     unshareWorkspacePort(input: UnshareWorkspacePortRequest, options?: RpcOptions): UnaryCall<UnshareWorkspacePortRequest, UnshareWorkspacePortResponse>;
     /**
+     * ListSpace lists the Spaces that are either created by the User or where
+     * the User is a Member depending on the requested mode.
+     *
      * @generated from protobuf rpc: ListSpace
      */
     listSpace(input: ListSpaceOptions, options?: RpcOptions): UnaryCall<ListSpaceOptions, SpaceList>;
     /**
+     * ListTemplate lists the Templates of a Space that the User is a Member of.
+     *
      * @generated from protobuf rpc: ListTemplate
      */
     listTemplate(input: ListTemplateOptions, options?: RpcOptions): UnaryCall<ListTemplateOptions, TemplateList>;
     /**
+     * ListMembership lists the Memberships of a Space that the User is a Member
+     * of.
+     *
      * @generated from protobuf rpc: ListMembership
      */
     listMembership(input: ListMembershipOptions, options?: RpcOptions): UnaryCall<ListMembershipOptions, MembershipList>;
     /**
+     * ListGitProvider lists the GitProviders of a Space that the User is a
+     * Member of.
+     *
      * @generated from protobuf rpc: ListGitProvider
      */
     listGitProvider(input: ListGitProviderOptions, options?: RpcOptions): UnaryCall<ListGitProviderOptions, GitProviderList>;
     /**
+     * GetSpace retrieves a specific Space. The caller must be a Member of the
+     * Space.
+     *
      * @generated from protobuf rpc: GetSpace
      */
     getSpace(input: GetOptions, options?: RpcOptions): UnaryCall<GetOptions, Space>;
     /**
+     * GetWorkspace retrieves a specific Workspace owned by the User.
+     *
      * @generated from protobuf rpc: GetWorkspace
      */
     getWorkspace(input: GetOptions, options?: RpcOptions): UnaryCall<GetOptions, Workspace>;
     /**
+     * GetTemplate retrieves a specific Template. The caller must be a Member of
+     * the Template's Space.
+     *
      * @generated from protobuf rpc: GetTemplate
      */
     getTemplate(input: GetOptions, options?: RpcOptions): UnaryCall<GetOptions, Template>;
     /**
+     * GetGitProvider retrieves a specific GitProvider. The caller must be a
+     * Member of the GitProvider's Space.
+     *
      * @generated from protobuf rpc: GetGitProvider
      */
     getGitProvider(input: GetOptions, options?: RpcOptions): UnaryCall<GetOptions, GitProvider>;
     /**
+     * GetMembership retrieves a specific Membership. The caller must be a Member
+     * of the Membership's Space.
+     *
      * @generated from protobuf rpc: GetMembership
      */
     getMembership(input: GetOptions, options?: RpcOptions): UnaryCall<GetOptions, Membership>;
     /**
+     * LeaveSpace removes the calling User's own Membership from a Space. Space
+     * creators cannot leave their own Spaces, they can only delete them.
+     *
      * @generated from protobuf rpc: LeaveSpace
      */
     leaveSpace(input: LeaveSpaceRequest, options?: RpcOptions): UnaryCall<LeaveSpaceRequest, LeaveSpaceResponse>;
     /**
-     * CreateWorkspace creates a Workspace owned by the User.
+     * CreateUserSecret creates a UserSecret owned by the User. UserSecrets of
+     * the SSH_KEY type have their key pair generated by the Cluster. The
+     * UserSecret data is never returned back by the Cluster.
      *
      * @generated from protobuf rpc: CreateUserSecret
      */
     createUserSecret(input: UserSecret, options?: RpcOptions): UnaryCall<UserSecret, UserSecret>;
     /**
-     * UpdateWorkspace updates a Workspace owned by the User.
+     * UpdateUserSecret updates a UserSecret owned by the User.
      *
      * @generated from protobuf rpc: UpdateUserSecret
      */
     updateUserSecret(input: UserSecret, options?: RpcOptions): UnaryCall<UserSecret, UserSecret>;
     /**
-     * DeleteWorkspace deletes a Workspace owned by the User.
+     * DeleteUserSecret deletes a UserSecret owned by the User.
      *
      * @generated from protobuf rpc: DeleteUserSecret
      */
     deleteUserSecret(input: DeleteOptions, options?: RpcOptions): UnaryCall<DeleteOptions, OperationResult>;
     /**
-     * ListWorkspace lists the Workspaces owned by the User.
+     * ListUserSecret lists the UserSecrets owned by the User. The UserSecrets'
+     * data is not included in the response.
      *
      * @generated from protobuf rpc: ListUserSecret
      */
     listUserSecret(input: ListUserSecretOptions, options?: RpcOptions): UnaryCall<ListUserSecretOptions, UserSecretList>;
     /**
+     * GetUserSecret retrieves a specific UserSecret owned by the User. The
+     * UserSecret data is not included in the response.
+     *
      * @generated from protobuf rpc: GetUserSecret
      */
     getUserSecret(input: GetOptions, options?: RpcOptions): UnaryCall<GetOptions, UserSecret>;
     /**
+     * GetUserConfig retrieves the calling User's UserConfig. The UserConfig is
+     * automatically created by the Cluster upon the first call.
+     *
      * @generated from protobuf rpc: GetUserConfig
      */
     getUserConfig(input: GetUserConfigRequest, options?: RpcOptions): UnaryCall<GetUserConfigRequest, UserConfig>;
     /**
+     * UpdateUserConfig updates the calling User's UserConfig.
+     *
      * @generated from protobuf rpc: UpdateUserConfig
      */
     updateUserConfig(input: UserConfig, options?: RpcOptions): UnaryCall<UserConfig, UserConfig>;
     /**
+     * ListRegion lists the Regions of the Cluster that are enabled to host
+     * Workspaces.
+     *
      * @generated from protobuf rpc: ListRegion
      */
     listRegion(input: ListRegionOptions, options?: RpcOptions): UnaryCall<ListRegionOptions, RegionList>;
     /**
+     * WatchWorkspace opens a server-side stream that publishes the create,
+     * update and delete events of the User's Workspaces. If a workspaceRef is
+     * set in the request, only the events of that specific Workspace are
+     * published. It is the recommended way to follow a Workspace's state
+     * throughout its lifecycle.
+     *
      * @generated from protobuf rpc: WatchWorkspace
      */
     watchWorkspace(input: WatchWorkspaceRequest, options?: RpcOptions): ServerStreamingCall<WatchWorkspaceRequest, WatchWorkspaceResponse>;
 }
 /**
+ * MainService is the primary Cordium API that is used by the Users (i.e. via
+ * the `cordium` CLI, the web portal and the SDKs) to manage their Spaces,
+ * Templates, Workspaces, Memberships, Secrets, UserSecrets, GitProviders and
+ * their UserConfig. Every method is executed on behalf of the authenticated
+ * Octelium User and is authorized against that User's ownership of the
+ * resource and/or their Membership role in the resource's Space.
+ *
  * @generated from protobuf service octelium.api.main.cordium.v1.MainService
  */
 export declare class MainServiceClient implements IMainServiceClient, ServiceInfo {
@@ -303,109 +428,157 @@ export declare class MainServiceClient implements IMainServiceClient, ServiceInf
     };
     constructor(_transport: RpcTransport);
     /**
-     * CreateSecret creates a Secret
+     * CreateSecret creates a Secret inside a Space. The caller must be at least
+     * an ADMIN Member of the Space. The Secret data is never returned back by
+     * the Cluster once the Secret is created.
      *
      * @generated from protobuf rpc: CreateSecret
      */
     createSecret(input: Secret, options?: RpcOptions): UnaryCall<Secret, Secret>;
     /**
-     * ListSecret lists Secrets
+     * ListSecret lists the Secrets of a Space. The Secrets' data is not
+     * included in the response.
      *
      * @generated from protobuf rpc: ListSecret
      */
     listSecret(input: ListSecretOptions, options?: RpcOptions): UnaryCall<ListSecretOptions, SecretList>;
     /**
-     * DeleteWorkspace deletes a Workspace
+     * DeleteSecret deletes a Secret. The caller must be at least an ADMIN Member
+     * of the Secret's Space.
      *
      * @generated from protobuf rpc: DeleteSecret
      */
     deleteSecret(input: DeleteOptions, options?: RpcOptions): UnaryCall<DeleteOptions, OperationResult>;
     /**
-     * GetWorkspace retrieves a specific Workspace
+     * GetSecret retrieves a specific Secret. The Secret data is not included in
+     * the response.
      *
      * @generated from protobuf rpc: GetSecret
      */
     getSecret(input: GetOptions, options?: RpcOptions): UnaryCall<GetOptions, Secret>;
     /**
-     * CreateTemplate creates a Template owned by the User.
+     * CreateTemplate creates a Template inside a Space. The caller must be at
+     * least an ADMIN Member of the Space.
      *
      * @generated from protobuf rpc: CreateTemplate
      */
     createTemplate(input: Template, options?: RpcOptions): UnaryCall<Template, Template>;
     /**
-     * UpdateTemplate updates a Template owned by the User.
+     * UpdateTemplate updates a Template. The caller must be at least an ADMIN
+     * Member of the Template's Space.
      *
      * @generated from protobuf rpc: UpdateTemplate
      */
     updateTemplate(input: Template, options?: RpcOptions): UnaryCall<Template, Template>;
     /**
-     * DeleteTemplate deletes a Template owned by the User.
+     * DeleteTemplate deletes a Template. The default Template of a Space cannot
+     * be deleted.
      *
      * @generated from protobuf rpc: DeleteTemplate
      */
     deleteTemplate(input: DeleteOptions, options?: RpcOptions): UnaryCall<DeleteOptions, OperationResult>;
     /**
+     * BuildTemplate starts a pre-build for a Template. A pre-build runs a
+     * hidden build Workspace whose storage is snapshotted once it successfully
+     * completes so that the subsequent Workspaces of the Template can be
+     * restored from that snapshot instead of being initialized from scratch. A
+     * Template can only have one running pre-build at a time. Starting a new
+     * pre-build cancels the currently running one, if any.
+     *
      * @generated from protobuf rpc: BuildTemplate
      */
     buildTemplate(input: BuildTemplateRequest, options?: RpcOptions): UnaryCall<BuildTemplateRequest, Template>;
     /**
+     * CancelBuildTemplate cancels the currently running pre-build of a Template,
+     * if any, and returns the updated Template.
+     *
      * @generated from protobuf rpc: CancelBuildTemplate
      */
     cancelBuildTemplate(input: CancelBuildTemplateRequest, options?: RpcOptions): UnaryCall<CancelBuildTemplateRequest, Template>;
     /**
-     * CreateTemplate creates a Template owned by the User.
+     * CreateSpace creates a Space owned by the User. Whether a User is allowed
+     * to own a Space is controlled by the Space ownership rules of the
+     * ClusterConfig. A default Membership and a default Template are
+     * automatically created along with the Space.
      *
      * @generated from protobuf rpc: CreateSpace
      */
     createSpace(input: Space, options?: RpcOptions): UnaryCall<Space, Space>;
     /**
-     * UpdateTemplate updates a Template owned by the User.
+     * UpdateSpace updates a Space. The caller must be the Space creator or an
+     * OWNER Member of the Space.
      *
      * @generated from protobuf rpc: UpdateSpace
      */
     updateSpace(input: Space, options?: RpcOptions): UnaryCall<Space, Space>;
     /**
-     * DeleteTemplate deletes a Template owned by the User.
+     * DeleteSpace deletes a Space as well as all of its Memberships, Templates,
+     * Secrets and GitProviders.
      *
      * @generated from protobuf rpc: DeleteSpace
      */
     deleteSpace(input: DeleteOptions, options?: RpcOptions): UnaryCall<DeleteOptions, OperationResult>;
     /**
+     * CreateMembership adds a User as a Member to a Space. The caller must be at
+     * least an ADMIN Member of the Space. Members can currently only be added to
+     * ORGANIZATION Spaces.
+     *
      * @generated from protobuf rpc: CreateMembership
      */
     createMembership(input: CreateMembershipRequest, options?: RpcOptions): UnaryCall<CreateMembershipRequest, Membership>;
     /**
+     * DeleteMembership removes a Member from a Space. The caller must be at
+     * least an ADMIN Member of the Space. Space creators cannot be removed.
+     *
      * @generated from protobuf rpc: DeleteMembership
      */
     deleteMembership(input: DeleteOptions, options?: RpcOptions): UnaryCall<DeleteOptions, OperationResult>;
     /**
+     * GetSpaceMembership retrieves the Membership of the calling User in a
+     * specific Space.
+     *
      * @generated from protobuf rpc: GetSpaceMembership
      */
     getSpaceMembership(input: GetSpaceMembershipRequest, options?: RpcOptions): UnaryCall<GetSpaceMembershipRequest, Membership>;
     /**
+     * UpdateMembership updates a Membership (i.e. its Role). The caller must be
+     * at least an ADMIN Member of the Space. Setting a Role to OWNER
+     * additionally requires the caller to be an OWNER.
+     *
      * @generated from protobuf rpc: UpdateMembership
      */
     updateMembership(input: Membership, options?: RpcOptions): UnaryCall<Membership, Membership>;
     /**
+     * CreateGitProvider creates a GitProvider inside a Space. The caller must be
+     * at least an ADMIN Member of the Space.
+     *
      * @generated from protobuf rpc: CreateGitProvider
      */
     createGitProvider(input: GitProvider, options?: RpcOptions): UnaryCall<GitProvider, GitProvider>;
     /**
+     * UpdateGitProvider updates a GitProvider.
+     *
      * @generated from protobuf rpc: UpdateGitProvider
      */
     updateGitProvider(input: GitProvider, options?: RpcOptions): UnaryCall<GitProvider, GitProvider>;
     /**
+     * DeleteGitProvider deletes a GitProvider.
+     *
      * @generated from protobuf rpc: DeleteGitProvider
      */
     deleteGitProvider(input: DeleteOptions, options?: RpcOptions): UnaryCall<DeleteOptions, OperationResult>;
     /**
-     * CreateWorkspace creates a Workspace owned by the User.
+     * CreateWorkspace creates a Workspace owned by the User. The Workspace is
+     * created in the STOPPED state and it is assigned a short randomly generated
+     * name by the Cluster. If no Template is set in the request's
+     * `status.templateRef`, the User's default Template is used.
      *
      * @generated from protobuf rpc: CreateWorkspace
      */
     createWorkspace(input: Workspace, options?: RpcOptions): UnaryCall<Workspace, Workspace>;
     /**
-     * UpdateWorkspace updates a Workspace owned by the User.
+     * UpdateWorkspace updates a Workspace owned by the User. Only the
+     * Workspace's displayName and spec can be updated.
      *
      * @generated from protobuf rpc: UpdateWorkspace
      */
@@ -423,144 +596,241 @@ export declare class MainServiceClient implements IMainServiceClient, ServiceInf
      */
     listWorkspace(input: ListWorkspaceOptions, options?: RpcOptions): UnaryCall<ListWorkspaceOptions, WorkspaceList>;
     /**
+     * StartWorkspace starts a stopped Workspace. The Cluster creates a dedicated
+     * Octelium Session for the run and moves the Workspace to the INIT_REQUEST
+     * state. The actual initialization is asynchronous and can be followed via
+     * the WatchWorkspace method.
+     *
      * @generated from protobuf rpc: StartWorkspace
      */
     startWorkspace(input: StartWorkspaceRequest, options?: RpcOptions): UnaryCall<StartWorkspaceRequest, StartWorkspaceResponse>;
     /**
+     * StopWorkspace requests a graceful stop of a running Workspace. The
+     * Workspace moves to the STOPPING_REQUEST state and the stoppage itself is
+     * asynchronous.
+     *
      * @generated from protobuf rpc: StopWorkspace
      */
     stopWorkspace(input: StopWorkspaceRequest, options?: RpcOptions): UnaryCall<StopWorkspaceRequest, StopWorkspaceResponse>;
     /**
+     * ShareWorkspacePort shares a named Application of a Workspace with other
+     * Users so that they can access it via the Workspace's public hostname.
+     *
      * @generated from protobuf rpc: ShareWorkspacePort
      */
     shareWorkspacePort(input: ShareWorkspacePortRequest, options?: RpcOptions): UnaryCall<ShareWorkspacePortRequest, ShareWorkspacePortResponse>;
     /**
+     * UnshareWorkspacePort stops sharing a previously shared named Application
+     * of a Workspace.
+     *
      * @generated from protobuf rpc: UnshareWorkspacePort
      */
     unshareWorkspacePort(input: UnshareWorkspacePortRequest, options?: RpcOptions): UnaryCall<UnshareWorkspacePortRequest, UnshareWorkspacePortResponse>;
     /**
+     * ListSpace lists the Spaces that are either created by the User or where
+     * the User is a Member depending on the requested mode.
+     *
      * @generated from protobuf rpc: ListSpace
      */
     listSpace(input: ListSpaceOptions, options?: RpcOptions): UnaryCall<ListSpaceOptions, SpaceList>;
     /**
+     * ListTemplate lists the Templates of a Space that the User is a Member of.
+     *
      * @generated from protobuf rpc: ListTemplate
      */
     listTemplate(input: ListTemplateOptions, options?: RpcOptions): UnaryCall<ListTemplateOptions, TemplateList>;
     /**
+     * ListMembership lists the Memberships of a Space that the User is a Member
+     * of.
+     *
      * @generated from protobuf rpc: ListMembership
      */
     listMembership(input: ListMembershipOptions, options?: RpcOptions): UnaryCall<ListMembershipOptions, MembershipList>;
     /**
+     * ListGitProvider lists the GitProviders of a Space that the User is a
+     * Member of.
+     *
      * @generated from protobuf rpc: ListGitProvider
      */
     listGitProvider(input: ListGitProviderOptions, options?: RpcOptions): UnaryCall<ListGitProviderOptions, GitProviderList>;
     /**
+     * GetSpace retrieves a specific Space. The caller must be a Member of the
+     * Space.
+     *
      * @generated from protobuf rpc: GetSpace
      */
     getSpace(input: GetOptions, options?: RpcOptions): UnaryCall<GetOptions, Space>;
     /**
+     * GetWorkspace retrieves a specific Workspace owned by the User.
+     *
      * @generated from protobuf rpc: GetWorkspace
      */
     getWorkspace(input: GetOptions, options?: RpcOptions): UnaryCall<GetOptions, Workspace>;
     /**
+     * GetTemplate retrieves a specific Template. The caller must be a Member of
+     * the Template's Space.
+     *
      * @generated from protobuf rpc: GetTemplate
      */
     getTemplate(input: GetOptions, options?: RpcOptions): UnaryCall<GetOptions, Template>;
     /**
+     * GetGitProvider retrieves a specific GitProvider. The caller must be a
+     * Member of the GitProvider's Space.
+     *
      * @generated from protobuf rpc: GetGitProvider
      */
     getGitProvider(input: GetOptions, options?: RpcOptions): UnaryCall<GetOptions, GitProvider>;
     /**
+     * GetMembership retrieves a specific Membership. The caller must be a Member
+     * of the Membership's Space.
+     *
      * @generated from protobuf rpc: GetMembership
      */
     getMembership(input: GetOptions, options?: RpcOptions): UnaryCall<GetOptions, Membership>;
     /**
+     * LeaveSpace removes the calling User's own Membership from a Space. Space
+     * creators cannot leave their own Spaces, they can only delete them.
+     *
      * @generated from protobuf rpc: LeaveSpace
      */
     leaveSpace(input: LeaveSpaceRequest, options?: RpcOptions): UnaryCall<LeaveSpaceRequest, LeaveSpaceResponse>;
     /**
-     * CreateWorkspace creates a Workspace owned by the User.
+     * CreateUserSecret creates a UserSecret owned by the User. UserSecrets of
+     * the SSH_KEY type have their key pair generated by the Cluster. The
+     * UserSecret data is never returned back by the Cluster.
      *
      * @generated from protobuf rpc: CreateUserSecret
      */
     createUserSecret(input: UserSecret, options?: RpcOptions): UnaryCall<UserSecret, UserSecret>;
     /**
-     * UpdateWorkspace updates a Workspace owned by the User.
+     * UpdateUserSecret updates a UserSecret owned by the User.
      *
      * @generated from protobuf rpc: UpdateUserSecret
      */
     updateUserSecret(input: UserSecret, options?: RpcOptions): UnaryCall<UserSecret, UserSecret>;
     /**
-     * DeleteWorkspace deletes a Workspace owned by the User.
+     * DeleteUserSecret deletes a UserSecret owned by the User.
      *
      * @generated from protobuf rpc: DeleteUserSecret
      */
     deleteUserSecret(input: DeleteOptions, options?: RpcOptions): UnaryCall<DeleteOptions, OperationResult>;
     /**
-     * ListWorkspace lists the Workspaces owned by the User.
+     * ListUserSecret lists the UserSecrets owned by the User. The UserSecrets'
+     * data is not included in the response.
      *
      * @generated from protobuf rpc: ListUserSecret
      */
     listUserSecret(input: ListUserSecretOptions, options?: RpcOptions): UnaryCall<ListUserSecretOptions, UserSecretList>;
     /**
+     * GetUserSecret retrieves a specific UserSecret owned by the User. The
+     * UserSecret data is not included in the response.
+     *
      * @generated from protobuf rpc: GetUserSecret
      */
     getUserSecret(input: GetOptions, options?: RpcOptions): UnaryCall<GetOptions, UserSecret>;
     /**
+     * GetUserConfig retrieves the calling User's UserConfig. The UserConfig is
+     * automatically created by the Cluster upon the first call.
+     *
      * @generated from protobuf rpc: GetUserConfig
      */
     getUserConfig(input: GetUserConfigRequest, options?: RpcOptions): UnaryCall<GetUserConfigRequest, UserConfig>;
     /**
+     * UpdateUserConfig updates the calling User's UserConfig.
+     *
      * @generated from protobuf rpc: UpdateUserConfig
      */
     updateUserConfig(input: UserConfig, options?: RpcOptions): UnaryCall<UserConfig, UserConfig>;
     /**
+     * ListRegion lists the Regions of the Cluster that are enabled to host
+     * Workspaces.
+     *
      * @generated from protobuf rpc: ListRegion
      */
     listRegion(input: ListRegionOptions, options?: RpcOptions): UnaryCall<ListRegionOptions, RegionList>;
     /**
+     * WatchWorkspace opens a server-side stream that publishes the create,
+     * update and delete events of the User's Workspaces. If a workspaceRef is
+     * set in the request, only the events of that specific Workspace are
+     * published. It is the recommended way to follow a Workspace's state
+     * throughout its lifecycle.
+     *
      * @generated from protobuf rpc: WatchWorkspace
      */
     watchWorkspace(input: WatchWorkspaceRequest, options?: RpcOptions): ServerStreamingCall<WatchWorkspaceRequest, WatchWorkspaceResponse>;
 }
 /**
+ * WorkspaceService is the API that operates inside a running Workspace. It
+ * provides interactive terminals, command execution and the initialization
+ * logs. Every method requires the Workspace to be owned by the calling User
+ * and to be in the PREPARING or the RUNNING state.
+ *
  * @generated from protobuf service octelium.api.main.cordium.v1.WorkspaceService
  */
 export interface IWorkspaceServiceClient {
     /**
+     * CreateTerminal creates a new interactive terminal (i.e. a PTY-backed
+     * shell) inside a Workspace and returns its ID.
+     *
      * @generated from protobuf rpc: CreateTerminal
      */
     createTerminal(input: CreateTerminalRequest, options?: RpcOptions): UnaryCall<CreateTerminalRequest, CreateTerminalResponse>;
     /**
+     * RemoveTerminal terminates a terminal.
+     *
      * @generated from protobuf rpc: RemoveTerminal
      */
     removeTerminal(input: RemoveTerminalRequest, options?: RpcOptions): UnaryCall<RemoveTerminalRequest, RemoveTerminalResponse>;
     /**
+     * ListTerminal lists the currently open terminals of a Workspace.
+     *
      * @generated from protobuf rpc: ListTerminal
      */
     listTerminal(input: ListTerminalRequest, options?: RpcOptions): UnaryCall<ListTerminalRequest, ListTerminalResponse>;
     /**
+     * WriteTerminalData writes data (i.e. stdin) to a terminal.
+     *
      * @generated from protobuf rpc: WriteTerminalData
      */
     writeTerminalData(input: WriteTerminalDataRequest, options?: RpcOptions): UnaryCall<WriteTerminalDataRequest, WriteTerminalDataResponse>;
     /**
+     * SetTerminalWindowSize resizes a terminal's window.
+     *
      * @generated from protobuf rpc: SetTerminalWindowSize
      */
     setTerminalWindowSize(input: SetTerminalWindowSizeRequest, options?: RpcOptions): UnaryCall<SetTerminalWindowSizeRequest, SetTerminalWindowSizeResponse>;
     /**
+     * ListenTerminal opens a server-side stream of a terminal's output. Multiple
+     * listeners can be attached to the same terminal at the same time.
+     *
      * @generated from protobuf rpc: ListenTerminal
      */
     listenTerminal(input: ListenTerminalRequest, options?: RpcOptions): ServerStreamingCall<ListenTerminalRequest, ListenTerminalResponse>;
     /**
+     * ListenLog opens a server-side stream of a Workspace's initialization logs
+     * (i.e. the repository cloning, image pulling, image building and the
+     * lifecycle tasks output).
+     *
      * @generated from protobuf rpc: ListenLog
      */
     listenLog(input: ListenLogRequest, options?: RpcOptions): ServerStreamingCall<ListenLogRequest, ListenLogResponse>;
     /**
+     * Exec runs a one-off command inside a Workspace over a bidirectional
+     * stream. The first client message must be a `request` message. The
+     * subsequent client messages carry the command's stdin or a kill signal
+     * while the server messages carry the command's stdout, stderr and its
+     * eventual exit code.
+     *
      * @generated from protobuf rpc: Exec
      */
     exec(options?: RpcOptions): DuplexStreamingCall<ExecRequest, ExecResponse>;
 }
 /**
+ * WorkspaceService is the API that operates inside a running Workspace. It
+ * provides interactive terminals, command execution and the initialization
+ * logs. Every method requires the Workspace to be owned by the calling User
+ * and to be in the PREPARING or the RUNNING state.
+ *
  * @generated from protobuf service octelium.api.main.cordium.v1.WorkspaceService
  */
 export declare class WorkspaceServiceClient implements IWorkspaceServiceClient, ServiceInfo {
@@ -572,39 +842,67 @@ export declare class WorkspaceServiceClient implements IWorkspaceServiceClient,
     };
     constructor(_transport: RpcTransport);
     /**
+     * CreateTerminal creates a new interactive terminal (i.e. a PTY-backed
+     * shell) inside a Workspace and returns its ID.
+     *
      * @generated from protobuf rpc: CreateTerminal
      */
     createTerminal(input: CreateTerminalRequest, options?: RpcOptions): UnaryCall<CreateTerminalRequest, CreateTerminalResponse>;
     /**
+     * RemoveTerminal terminates a terminal.
+     *
      * @generated from protobuf rpc: RemoveTerminal
      */
     removeTerminal(input: RemoveTerminalRequest, options?: RpcOptions): UnaryCall<RemoveTerminalRequest, RemoveTerminalResponse>;
     /**
+     * ListTerminal lists the currently open terminals of a Workspace.
+     *
      * @generated from protobuf rpc: ListTerminal
      */
     listTerminal(input: ListTerminalRequest, options?: RpcOptions): UnaryCall<ListTerminalRequest, ListTerminalResponse>;
     /**
+     * WriteTerminalData writes data (i.e. stdin) to a terminal.
+     *
      * @generated from protobuf rpc: WriteTerminalData
      */
     writeTerminalData(input: WriteTerminalDataRequest, options?: RpcOptions): UnaryCall<WriteTerminalDataRequest, WriteTerminalDataResponse>;
     /**
+     * SetTerminalWindowSize resizes a terminal's window.
+     *
      * @generated from protobuf rpc: SetTerminalWindowSize
      */
     setTerminalWindowSize(input: SetTerminalWindowSizeRequest, options?: RpcOptions): UnaryCall<SetTerminalWindowSizeRequest, SetTerminalWindowSizeResponse>;
     /**
+     * ListenTerminal opens a server-side stream of a terminal's output. Multiple
+     * listeners can be attached to the same terminal at the same time.
+     *
      * @generated from protobuf rpc: ListenTerminal
      */
     listenTerminal(input: ListenTerminalRequest, options?: RpcOptions): ServerStreamingCall<ListenTerminalRequest, ListenTerminalResponse>;
     /**
+     * ListenLog opens a server-side stream of a Workspace's initialization logs
+     * (i.e. the repository cloning, image pulling, image building and the
+     * lifecycle tasks output).
+     *
      * @generated from protobuf rpc: ListenLog
      */
     listenLog(input: ListenLogRequest, options?: RpcOptions): ServerStreamingCall<ListenLogRequest, ListenLogResponse>;
     /**
+     * Exec runs a one-off command inside a Workspace over a bidirectional
+     * stream. The first client message must be a `request` message. The
+     * subsequent client messages carry the command's stdin or a kill signal
+     * while the server messages carry the command's stdout, stderr and its
+     * eventual exit code.
+     *
      * @generated from protobuf rpc: Exec
      */
     exec(options?: RpcOptions): DuplexStreamingCall<ExecRequest, ExecResponse>;
 }
 /**
+ * ManagementService is the administrative API of a Cordium Cluster. It is used
+ * by the Cluster administrators (e.g. via `cordium man`) to read and update
+ * the Cluster-wide configuration.
+ *
  * @generated from protobuf service octelium.api.main.cordium.v1.ManagementService
  */
 export interface IManagementServiceClient {
@@ -615,13 +913,17 @@ export interface IManagementServiceClient {
      */
     getClusterConfig(input: GetClusterConfigRequest, options?: RpcOptions): UnaryCall<GetClusterConfigRequest, ClusterConfig>;
     /**
-     * UpdateConfig updates the Cluster Configuration.
+     * UpdateClusterConfig updates the Cluster Configuration.
      *
      * @generated from protobuf rpc: UpdateClusterConfig
      */
     updateClusterConfig(input: ClusterConfig, options?: RpcOptions): UnaryCall<ClusterConfig, ClusterConfig>;
 }
 /**
+ * ManagementService is the administrative API of a Cordium Cluster. It is used
+ * by the Cluster administrators (e.g. via `cordium man`) to read and update
+ * the Cluster-wide configuration.
+ *
  * @generated from protobuf service octelium.api.main.cordium.v1.ManagementService
  */
 export declare class ManagementServiceClient implements IManagementServiceClient, ServiceInfo {
@@ -639,7 +941,7 @@ export declare class ManagementServiceClient implements IManagementServiceClient
      */
     getClusterConfig(input: GetClusterConfigRequest, options?: RpcOptions): UnaryCall<GetClusterConfigRequest, ClusterConfig>;
     /**
-     * UpdateConfig updates the Cluster Configuration.
+     * UpdateClusterConfig updates the Cluster Configuration.
      *
      * @generated from protobuf rpc: UpdateClusterConfig
      */