@stack-spot/portal-network 0.35.0 → 0.37.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [0.37.0](https://github.com/stack-spot/portal-commons/compare/portal-network@v0.36.0...portal-network@v0.37.0) (2024-10-07)
+
+
+### Features
+
+* update content ([#406](https://github.com/stack-spot/portal-commons/issues/406)) ([a0e19f0](https://github.com/stack-spot/portal-commons/commit/a0e19f0a5f59b54410b4ece38fae28c47b570762))
+
+## [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)
 
 

package/dist/api/content.d.ts

@@ -353,14 +353,14 @@ 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;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -497,8 +497,8 @@ export type PluginVersionResponse = {
     stkProjectsOnly: boolean;
 };
 export type PagePluginVersionResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -638,8 +638,8 @@ export type ActionResponse = {
     hasRequiredConnection: boolean;
 };
 export type PageActionResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -699,8 +699,8 @@ export type FilterStarterRequest = {
     "type"?: "INFRA" | "APP";
 };
 export type PageStarterResponseWithRange = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -717,8 +717,8 @@ export type FilterStackVersionPluginRequest = {
     text?: string;
 };
 export type PageStackPluginResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -816,8 +816,8 @@ export type FilterStackActionRequest = {
     filter?: string;
 };
 export type PageGetStackActionResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -999,8 +999,8 @@ export type UpdateDocRequest = {
     publish: boolean;
 };
 export type PageStudioResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1026,8 +1026,8 @@ export type PluginVersionDto = {
     governance?: GovernanceDto;
 };
 export type PagePluginVersionDto = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1053,8 +1053,8 @@ export type ActionVersionDto = {
     governance?: GovernanceDto;
 };
 export type PageActionVersionDto = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1166,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;
@@ -1178,8 +1180,8 @@ export type GetWorkflowsByStudioResponse = {
     latestVersion?: GetWorkflowsByStudioLatestVersionDataResponse;
 };
 export type PageGetWorkflowsByStudioResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1195,13 +1197,63 @@ 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;
 };
 export type PageGetAvailableWorkflowVersionsResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1220,8 +1272,8 @@ export type StackWorkspaceViewResponse = {
     totalLinkedVersions: number;
 };
 export type PageStackWorkspaceViewResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1248,8 +1300,8 @@ export type StackWorkspaceDetailViewResponse = {
     environment?: StackWorkspaceDetailViewEnvironmentResponse;
 };
 export type PageStackWorkspaceDetailViewResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1267,8 +1319,8 @@ export type GetUnusedStackVersionsResponse = {
     status?: string;
 };
 export type PageGetUnusedStackVersionsResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1418,8 +1470,8 @@ export type PluginStarterResponse = {
     stack: StackResponse;
 };
 export type PagePluginStarterResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1444,8 +1496,8 @@ export type GetPluginStackStarterUsageResponse = {
     pluginVersion: GetPluginStackStarterUsagePluginResponse;
 };
 export type PageGetPluginStackStarterUsageResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1466,8 +1518,8 @@ export type PluginStacksResponse = {
     studio: PluginStudioResponse;
 };
 export type PagePluginStacksResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1492,8 +1544,8 @@ export type GetPluginStackUsageResponse = {
     pluginVersion: GetPluginStackUsagePluginResponse;
 };
 export type PageGetPluginStackUsageResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1518,8 +1570,8 @@ export type PluginInfrastructureViewResponse = {
     workspace: PluginInfrastructureWorkspaceResponse;
 };
 export type PagePluginInfrastructureViewResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1544,8 +1596,8 @@ export type InfrastructureEnvironmentsUsesPluginResponse = {
     pluginVersion: GetInfrastructureEnvironmentsUsagePluginVersionResponse;
 };
 export type PageInfrastructureEnvironmentsUsesPluginResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1564,8 +1616,8 @@ export type PluginViewUsageMonitorResponse = {
     studio: PluginStudioResponse;
 };
 export type PagePluginViewUsageMonitorResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1585,8 +1637,8 @@ export type GetDependentPluginsVersionsResponse = {
     pluginVersion: DependentPluginVersionResponse;
 };
 export type PageGetDependentPluginsVersionsResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1603,8 +1655,8 @@ export type GetPluginVersionsNotInUseResponse = {
     status: "DRAFT" | "PUBLISHED" | "DEPRECATED" | "REPROVED";
 };
 export type PageGetPluginVersionsNotInUseResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1637,8 +1689,8 @@ export type PluginApplicationsResponse = {
     workspace: PluginApplicationsWorkspaceResponse;
 };
 export type PagePluginApplicationsResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1663,8 +1715,8 @@ export type PluginUsageMonitorApplicationViewResponse = {
     environment: PluginUsageMonitorApplicationViewEnvironmentResponse;
 };
 export type PagePluginUsageMonitorApplicationViewResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1786,8 +1838,8 @@ export type ContentEvaluationResponse = {
     pendingDiscussionReading: boolean;
 };
 export type PageContentEvaluationResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1941,8 +1993,7 @@ export declare function createConnectionInterfaceType({ createConnectionInterfac
 /**
  * Validate and return info from a workflow
  */
-export declare function validateWorkflow({ studioSlug, body }: {
-    studioSlug?: string;
+export declare function validateWorkflow({ body }: {
     body?: {
         file: Blob;
     };
@@ -2125,9 +2176,8 @@ export declare function listStudios({ xWorkspaceId, filterStudioRequest }: {
 /**
  * Validate and return info from a starter
  */
-export declare function validateStack({ starterPath, studioSlug, body }: {
+export declare function validateStack({ starterPath, body }: {
     starterPath: string;
-    studioSlug?: string;
     body?: {
         file: Blob;
     };
@@ -2277,8 +2327,7 @@ export declare function getStackVersionListByIds({ xWorkspaceId, filterStackVers
 /**
  * Validate and return info from a stack
  */
-export declare function validateStack1({ studioSlug, body }: {
-    studioSlug?: string;
+export declare function validateStack1({ body }: {
     body?: {
         file: Blob;
     };
@@ -2306,8 +2355,7 @@ export declare function deprecatePluginVersion({ pluginVersionId, deprecateConte
 /**
  * Validate and return info from a plugin
  */
-export declare function validatePlugin({ studioSlug, body }: {
-    studioSlug?: string;
+export declare function validatePlugin({ body }: {
     body?: {
         file: Blob;
     };
@@ -2359,8 +2407,7 @@ export declare function deprecateActionVersion({ actionVersionId, deprecateConte
 /**
  * Validate and return info from a action
  */
-export declare function validateAction({ studioSlug, body }: {
-    studioSlug?: string;
+export declare function validateAction({ body }: {
     body?: {
         file: Blob;
     };
@@ -2603,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
  */
@@ -2613,6 +2669,15 @@ export declare function getAvailableWorkflowVersionsByWorkflowSlug({ studioSlug,
     range: string;
     pageable: Pageable;
 }, opts?: Oazapfts.RequestOpts): Promise<PageGetAvailableWorkflowVersionsResponse>;
+/**
+ * Get an workflow documentation
+ */
+export declare function getWorkflowDoc({ studioSlug, documentationId, language, status }: {
+    studioSlug: string;
+    documentationId: string;
+    language: string;
+    status?: string;
+}, opts?: Oazapfts.RequestOpts): Promise<DocumentationResponse>;
 /**
  * Get a starter documentation
  */