@stack-spot/portal-network 0.34.1 → 0.36.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [0.36.0](https://github.com/stack-spot/portal-commons/compare/portal-network@v0.35.0...portal-network@v0.36.0) (2024-10-04)
+
+
+### Features
+
+* Update content ([fb8daf6](https://github.com/stack-spot/portal-commons/commit/fb8daf6a3dbc18eff040328a0f248bdb886559dd))
+* Workspace manager ([0349e8d](https://github.com/stack-spot/portal-commons/commit/0349e8d8e81c8146b7f42a7aee7d73f5dbdbd45b))
+
+## [0.35.0](https://github.com/stack-spot/portal-commons/compare/portal-network@v0.34.1...portal-network@v0.35.0) (2024-10-04)
+
+
+### Features
+
+* Update content swagger ([#397](https://github.com/stack-spot/portal-commons/issues/397)) ([7c5c0d2](https://github.com/stack-spot/portal-commons/commit/7c5c0d268072ea8af2ddda642e98113cc5003746))
+
 ## [0.34.1](https://github.com/stack-spot/portal-commons/compare/portal-network@v0.34.0...portal-network@v0.34.1) (2024-10-03)
 
 

package/dist/api/content.d.ts

@@ -106,7 +106,7 @@ export type CreateConnectionInterfaceTypeRequest = {
 };
 export type YamlValidationError = {
     details: string;
-    "type": "STK_VAL_0000_YAML_BASE_ERROR" | "STK_VAL_5010_YAML_FIELDS_ERROR" | "STK_VAL_5011_YAML_REQUIRED_FIELD" | "STK_VAL_5012_YAML_INVALID_FIELD_FORMAT" | "STK_VAL_5013_YAML_INVALID_VALUE_BY_ENUM" | "STK_VAL_5015_YAML_ADDITIONAL_FIELD" | "STK_VAL_5016_YAML_FIELD_INVALID_TYPE" | "STK_VAL_5018_INVALID_TECHNOLOGIES" | "STK_VAL_5021_MARKDOWN_LINK_NOT_FOUND" | "STK_VAL_5022_INVALID_INPUT_DEFAULT" | "STK_VAL_5024_PLUGIN_VERSION_NOT_FOUND" | "STK_VAL_5026_FILE_NOT_FOUND" | "STK_VAL_5027_FILE_EMPTY" | "STK_VAL_5030_FUNCTION_RUN_IS_REQUIRED" | "STK_VAL_5031_INVALID_INPUT_CONDITION_OPERATOR" | "STK_VAL_5032_INVALID_INPUT_CONDITION_VALUE" | "STK_VAL_5034_INVALID_INPUT_CONDITION_VARIABLE_DOES_NOT_EXIST" | "STK_VAL_5035_INVALID_CONNECTION_TYPE" | "STK_VAL_5036_INVALID_CONNECTION_TYPE_OUTPUT" | "STK_VAL_5037_DUPLICATED_CONNECTION_ALIAS" | "STK_VAL_5039_INVALID_LINK_URL_TYPE" | "STK_VAL_5040_INVALID_CONNECTION_LINK_VARIABLE" | "STK_VAL_5041_INVALID_CONNECTION_ALIAS_LINK_VARIABLE" | "STK_VAL_5042_INVALID_CONNECTION_OUTPUT_LINK_VARIABLE" | "STK_VAL_5043_DUPLICATED_LINK_NAME" | "STK_VAL_5044_INPUT_NAME_AS_RESERVED_WORD" | "STK_VAL_5045_DYNAMIC_LINK_VARIABLE_NOT_FOUND" | "STK_VAL_5046_LINK_WITH_COMPLEX_JINJA_EXPRESSION" | "STK_VAL_5047_INVALID_DYNAMIC_LINK_URL" | "STK_VAL_5048_DUPLICATED_INPUT_NAMES" | "STK_VAL_5049_INVALID_INPUT_DEFAULT_NOT_IN_ITEMS" | "STK_VAL_5053_MISSING_ACTION_IN_REQUIRES" | "STK_VAL_5054_DUPLICATED_NAME" | "STK_VAL_5055_DUPLICATED_VALUE" | "STK_VAL_5057_ACTION_NOT_DECLARED" | "STK_VAL_5058_OLD_DOCS_DECLARED" | "STK_VAL_5059_OLD_DOCS_WILL_BE_IGNORED" | "STK_VAL_5061_ACTION_VERSION_NOT_FOUND" | "STK_VAL_5062_PLUGIN_OF_STARTER_IS_NOT_DECLARED" | "STK_VAL_5063_STARTER_MUST_CONTAIN_PLUGIN" | "STK_VAL_5064_REQUIRED_PLUGIN_NOT_PUBLISHED" | "STK_VAL_5065_REQUIRED_ACTION_NOT_PUBLISHED" | "STK_VAL_5066_MISSING_PLUGIN_REQUIRED_IN_STACK" | "STK_VAL_5067_MISSING_ACTION_REQUIRED_IN_STACK" | "STK_VAL_5068_INFRA_PLUGIN_APP_ALLOWED_FALSE" | "STK_VAL_5073_SOURCE_AND_ITEMS_BEING_USED" | "STK_VAL_5076_MISSING_OUTPUT_FROM_GENERATES" | "STK_VAL_5077_MISSING_PLUGIN_REQUIRED_IN_STARTER" | "STK_VAL_5078_WRONG_PLUGIN_TYPE_IN_STACK" | "STK_VAL_5079_DUPLICATED_SLUG" | "STK_VAL_5080_INVALID_DEPENDS_ON_JOBS" | "STK_VAL_5081_DUPLICATED_JOB" | "STK_VAL_5082_DUPLICATED_STEP" | "STK_VAL_5083_WORKFLOW_VERSION_NOT_FOUND" | "STK_VAL_5084_MISSING_INPUT_REQUIRED_IN_STEP_JOB" | "STK_VAL_5085_CYCLIC_DEPENDENCY_JOB" | "STK_VAL_5086_CYCLIC_DEPENDENCY_WORKFLOW" | "STK_VAL_5087_WORKFLOW_CREATE_DEPENDENCY" | "STK_VAL_5088_INVALID_VARIABLE";
+    "type": "STK_VAL_0000_YAML_BASE_ERROR" | "STK_VAL_5010_YAML_FIELDS_ERROR" | "STK_VAL_5011_YAML_REQUIRED_FIELD" | "STK_VAL_5012_YAML_INVALID_FIELD_FORMAT" | "STK_VAL_5013_YAML_INVALID_VALUE_BY_ENUM" | "STK_VAL_5015_YAML_ADDITIONAL_FIELD" | "STK_VAL_5016_YAML_FIELD_INVALID_TYPE" | "STK_VAL_5018_INVALID_TECHNOLOGIES" | "STK_VAL_5021_MARKDOWN_LINK_NOT_FOUND" | "STK_VAL_5022_INVALID_INPUT_DEFAULT" | "STK_VAL_5024_PLUGIN_VERSION_NOT_FOUND" | "STK_VAL_5026_FILE_NOT_FOUND" | "STK_VAL_5027_FILE_EMPTY" | "STK_VAL_5030_FUNCTION_RUN_IS_REQUIRED" | "STK_VAL_5031_INVALID_INPUT_CONDITION_OPERATOR" | "STK_VAL_5032_INVALID_INPUT_CONDITION_VALUE" | "STK_VAL_5034_INVALID_INPUT_CONDITION_VARIABLE_DOES_NOT_EXIST" | "STK_VAL_5035_INVALID_CONNECTION_TYPE" | "STK_VAL_5036_INVALID_CONNECTION_TYPE_OUTPUT" | "STK_VAL_5037_DUPLICATED_CONNECTION_ALIAS" | "STK_VAL_5039_INVALID_LINK_URL_TYPE" | "STK_VAL_5040_INVALID_CONNECTION_LINK_VARIABLE" | "STK_VAL_5041_INVALID_CONNECTION_ALIAS_LINK_VARIABLE" | "STK_VAL_5042_INVALID_CONNECTION_OUTPUT_LINK_VARIABLE" | "STK_VAL_5043_DUPLICATED_LINK_NAME" | "STK_VAL_5044_INPUT_NAME_AS_RESERVED_WORD" | "STK_VAL_5045_DYNAMIC_LINK_VARIABLE_NOT_FOUND" | "STK_VAL_5046_LINK_WITH_COMPLEX_JINJA_EXPRESSION" | "STK_VAL_5047_INVALID_DYNAMIC_LINK_URL" | "STK_VAL_5048_DUPLICATED_INPUT_NAMES" | "STK_VAL_5049_INVALID_INPUT_DEFAULT_NOT_IN_ITEMS" | "STK_VAL_5053_MISSING_ACTION_IN_REQUIRES" | "STK_VAL_5054_DUPLICATED_NAME" | "STK_VAL_5055_DUPLICATED_VALUE" | "STK_VAL_5057_ACTION_NOT_DECLARED" | "STK_VAL_5058_OLD_DOCS_DECLARED" | "STK_VAL_5059_OLD_DOCS_WILL_BE_IGNORED" | "STK_VAL_5061_ACTION_VERSION_NOT_FOUND" | "STK_VAL_5062_PLUGIN_OF_STARTER_IS_NOT_DECLARED" | "STK_VAL_5063_STARTER_MUST_CONTAIN_PLUGIN" | "STK_VAL_5064_REQUIRED_PLUGIN_NOT_PUBLISHED" | "STK_VAL_5065_REQUIRED_ACTION_NOT_PUBLISHED" | "STK_VAL_5066_MISSING_PLUGIN_REQUIRED_IN_STACK" | "STK_VAL_5067_MISSING_ACTION_REQUIRED_IN_STACK" | "STK_VAL_5068_INFRA_PLUGIN_APP_ALLOWED_FALSE" | "STK_VAL_5073_SOURCE_AND_ITEMS_BEING_USED" | "STK_VAL_5076_MISSING_OUTPUT_FROM_GENERATES" | "STK_VAL_5077_MISSING_PLUGIN_REQUIRED_IN_STARTER" | "STK_VAL_5078_WRONG_PLUGIN_TYPE_IN_STACK" | "STK_VAL_5079_DUPLICATED_SLUG" | "STK_VAL_5080_INVALID_VARIABLE" | "STK_VAL_5081_INVALID_VARIABLE_REFERENCE" | "STK_VAL_5082_DUPLICATED_JOB" | "STK_VAL_5083_DUPLICATED_STEP" | "STK_VAL_5084_WORKFLOW_VERSION_NOT_FOUND" | "STK_VAL_5085_MISSING_INPUT_REQUIRED_IN_STEP_JOB" | "STK_VAL_5086_CYCLIC_DEPENDENCY_JOB" | "STK_VAL_5087_CYCLIC_DEPENDENCY_WORKFLOW" | "STK_VAL_5088_WORKFLOW_CREATE_DEPENDENCY" | "STK_VAL_5089_INVALID_DEPENDS_ON_JOBS" | "STK_VAL_5090_INVALID_JOB_STEP_WORKFLOW_TYPE" | "STK_VAL_5091_MULTIPLE_GENERATED_CONNECTION_DEFINITION";
     field?: string;
     value?: object;
     examples: string[];
@@ -304,6 +304,7 @@ export type GetStackActionResponse = {
     "type": string;
     qualifier: string;
     status: string;
+    isDocumented: boolean;
 };
 export type GetStackVersionResponse = {
     stack: GetStackVersionStackResponse;
@@ -352,10 +353,10 @@ export type SortObject = {
 export type PageableObject = {
     offset?: number;
     sort?: SortObject[];
-    pageSize?: number;
-    pageNumber?: number;
     paged?: boolean;
     unpaged?: boolean;
+    pageSize?: number;
+    pageNumber?: number;
 };
 export type PageGetStackStudioResponse = {
     totalElements?: number;
@@ -451,6 +452,8 @@ export type PluginGeneratesConnectionResponse = {
     typeId: string;
     "type": string;
     alias: string;
+    optional: boolean;
+    source: string;
     outputs?: OutputResponse[];
 };
 export type PluginGeneratesLinkResponse = {
@@ -632,6 +635,7 @@ export type ActionResponse = {
     repository?: string;
     governance?: ActionGovernanceResponse;
     status: string;
+    hasRequiredConnection: boolean;
 };
 export type PageActionResponse = {
     totalElements?: number;
@@ -1007,11 +1011,60 @@ export type PageStudioResponse = {
     numberOfElements?: number;
     empty?: boolean;
 };
+export type GovernanceDto = {
+    id?: string;
+    status: string;
+    pendingDiscussionReading?: boolean;
+};
+export type PluginVersionDto = {
+    pluginVersionId: string;
+    slug: string;
+    version: string;
+    createdBy: string;
+    createdAt: string;
+    status: string;
+    governance?: GovernanceDto;
+};
+export type PagePluginVersionDto = {
+    totalElements?: number;
+    totalPages?: number;
+    first?: boolean;
+    last?: boolean;
+    size?: number;
+    content?: PluginVersionDto[];
+    "number"?: number;
+    sort?: SortObject[];
+    pageable?: PageableObject;
+    numberOfElements?: number;
+    empty?: boolean;
+};
 export type DownloadBase64Response = {
     fileBase64: string;
     fileName: string;
     actionVersionId: string;
 };
+export type ActionVersionDto = {
+    actionVersionId: string;
+    version: string;
+    createdBy: string;
+    createdAt: string;
+    updatedAt?: string;
+    status: string;
+    governance?: GovernanceDto;
+};
+export type PageActionVersionDto = {
+    totalElements?: number;
+    totalPages?: number;
+    first?: boolean;
+    last?: boolean;
+    size?: number;
+    content?: ActionVersionDto[];
+    "number"?: number;
+    sort?: SortObject[];
+    pageable?: PageableObject;
+    numberOfElements?: number;
+    empty?: boolean;
+};
 export type StackStudioV2Response = {
     slug: string;
     name: string;
@@ -1067,6 +1120,10 @@ export type PluginInputConditionResponse = {
     operator?: string;
     value?: JsonNode;
 };
+export type PluginOutputResponse = {
+    "from": string;
+    to: string;
+};
 export type PluginInputResponse = {
     label?: string;
     name?: string;
@@ -1082,6 +1139,7 @@ export type PluginInputResponse = {
     isGlobal?: boolean;
     inputEnv?: boolean;
     connectionInterfaceType?: string;
+    outputs?: PluginOutputResponse[];
     input?: PluginInputResponse;
 };
 export type PluginComputedInputResponse = {
@@ -1108,9 +1166,11 @@ export type GetWorkflowsByStudioLatestVersionDataResponse = {
     id: string;
     displayName: string;
     label: string;
+    description: string;
     semanticVersion: string;
     targetApp: boolean;
     targetInfra: boolean;
+    createdAt: string;
 };
 export type GetWorkflowsByStudioResponse = {
     id: string;
@@ -1137,6 +1197,56 @@ export type DownloadWorkflowBase64Response = {
     file_name: string;
     workflowVersionId: string;
 };
+export type WorkflowStudioResponse = {
+    slug: string;
+    name: string;
+    imageUrl?: string;
+    description?: string;
+};
+export type GetWorkflowCommandResponse = {
+    "default": string;
+    workspace: string;
+};
+export type WorkflowVersionJobStepsResponse = {
+    id: string;
+    identifier: string;
+    name: string;
+    label?: string;
+    ordination: number;
+    optional: boolean;
+    workdir?: string;
+    "type": string;
+    alias?: string;
+};
+export type WorkflowVersionJobsResponse = {
+    id: string;
+    identifier: string;
+    label: string;
+    ordination: number;
+    optional: boolean;
+    steps?: WorkflowVersionJobStepsResponse[];
+};
+export type GetWorkflowResponse = {
+    id: string;
+    studio: WorkflowStudioResponse;
+    workflowVersionId: string;
+    "type": string;
+    version: string;
+    slug: string;
+    displayName?: string;
+    description?: string;
+    commands?: GetWorkflowCommandResponse;
+    createdAt: string;
+    createdBy: string;
+    updatedAt?: string;
+    qualifier: string;
+    accountSlug?: string;
+    studioSlug: string;
+    status: string;
+    isDocumented: boolean;
+    documentation?: DocumentationContentResponse;
+    jobs?: WorkflowVersionJobsResponse[];
+};
 export type GetAvailableWorkflowVersionsResponse = {
     workflowVersionId: string;
     version: string;
@@ -1786,6 +1896,16 @@ export type ListDocumentationResponse = {
     documentationId: string;
     languages: DocumentationLanguageResponse[];
 };
+/**
+ * Update Workflow Documentation
+ */
+export declare function updateWorkflowDocumentation({ studioSlug, workflowSlug, body }: {
+    studioSlug: string;
+    workflowSlug: string;
+    body?: {
+        file: Blob;
+    };
+}, opts?: Oazapfts.RequestOpts): Promise<unknown>;
 /**
  * Update Stack and starter docs
  */
@@ -1909,9 +2029,10 @@ export declare function addWorkspace({ studioSlug, studioWorkspaceRequest }: {
 /**
  * Publish Workflow
  */
-export declare function publishWorkflow({ studioSlug, workflowSlug, body }: {
+export declare function publishWorkflow({ studioSlug, workflowSlug, userAgent, body }: {
     studioSlug: string;
     workflowSlug: string;
+    userAgent?: string;
     body?: {
         file: Blob;
     };
@@ -1958,7 +2079,7 @@ export declare function publishPluginController({ studioSlug, pluginSlug, body }
 /**
  * Get available plugin versions by plugin slug
  */
-export declare function getAvailablePluginVersionsByPluginSlug({ studioSlug, pluginSlug, xWorkspaceId, range, appAllowed }: {
+export declare function getAvailablePluginVersionsByPluginSlug1({ studioSlug, pluginSlug, xWorkspaceId, range, appAllowed }: {
     studioSlug: string;
     pluginSlug: string;
     xWorkspaceId?: string;
@@ -2020,7 +2141,7 @@ export declare function createAction({ studioSlug, actionSlug, body }: {
 /**
  * Get available action versions by action slug
  */
-export declare function getAvailableActionVersionsByActionSlug({ studioSlug, actionSlug, xWorkspaceId, range, requiresConnection }: {
+export declare function getAvailableActionVersionsByActionSlug1({ studioSlug, actionSlug, xWorkspaceId, range, requiresConnection }: {
     studioSlug: string;
     actionSlug: string;
     xWorkspaceId?: string;
@@ -2442,6 +2563,17 @@ export declare function getStudios({ xWorkspaceId, authorization, aclOnly, filte
     workspaceId?: string;
     pageable: Pageable;
 }, opts?: Oazapfts.RequestOpts): Promise<PageStudioResponse>;
+/**
+ * Get available plugin versions by plugin slug
+ */
+export declare function getAvailablePluginVersionsByPluginSlug({ studioSlug, pluginSlug, xWorkspaceId, range, appAllowed, pageable }: {
+    studioSlug: string;
+    pluginSlug: string;
+    xWorkspaceId?: string;
+    range: string;
+    appAllowed?: boolean;
+    pageable: Pageable;
+}, opts?: Oazapfts.RequestOpts): Promise<PagePluginVersionDto>;
 /**
  * Download an action by version
  */
@@ -2451,6 +2583,17 @@ export declare function downloadAction({ studioSlug, actionSlug, version, xWorks
     version: string;
     xWorkspaceId?: string;
 }, opts?: Oazapfts.RequestOpts): Promise<DownloadBase64Response>;
+/**
+ * Get available action versions by action slug
+ */
+export declare function getAvailableActionVersionsByActionSlug({ studioSlug, actionSlug, xWorkspaceId, range, requiresConnection, pageable }: {
+    studioSlug: string;
+    actionSlug: string;
+    xWorkspaceId?: string;
+    range: string;
+    requiresConnection?: boolean;
+    pageable: Pageable;
+}, opts?: Oazapfts.RequestOpts): Promise<PageActionVersionDto>;
 /**
  * List stacks from account
  */
@@ -2482,9 +2625,11 @@ export declare function listInputs({ actionVersionId, xWorkspaceId, accountId }:
 /**
  * Get workflows from studio
  */
-export declare function getWorkflowByStudioSlug({ studioSlug, xWorkspaceId, pageable }: {
+export declare function getWorkflowByStudioSlug({ studioSlug, xWorkspaceId, displayName, $type, pageable }: {
     studioSlug: string;
     xWorkspaceId?: string;
+    displayName?: string;
+    $type?: "starter" | "deploy" | "destroy" | "rollback" | "reusable" | "create";
     pageable: Pageable;
 }, opts?: Oazapfts.RequestOpts): Promise<PageGetWorkflowsByStudioResponse>;
 /**
@@ -2505,6 +2650,15 @@ export declare function downloadWorkflowBase64({ studioSlug, workflowSlug, versi
     version: string;
     xWorkspaceId?: string;
 }, opts?: Oazapfts.RequestOpts): Promise<DownloadWorkflowBase64Response>;
+/**
+ * Get workflow version
+ */
+export declare function getWorkflow({ studioSlug, workflowSlug, version, xWorkspaceId }: {
+    studioSlug: string;
+    workflowSlug: string;
+    version?: string;
+    xWorkspaceId?: string;
+}, opts?: Oazapfts.RequestOpts): Promise<GetWorkflowResponse>;
 /**
  * Get available workflow versions by workflow slug
  */