@stack-spot/portal-network 0.36.0 → 0.37.0

package/src/api/content.ts

@@ -364,8 +364,8 @@ export type PageableObject = {
     pageNumber?: number;
 };
 export type PageGetStackStudioResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -502,8 +502,8 @@ export type PluginVersionResponse = {
     stkProjectsOnly: boolean;
 };
 export type PagePluginVersionResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -643,8 +643,8 @@ export type ActionResponse = {
     hasRequiredConnection: boolean;
 };
 export type PageActionResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -704,8 +704,8 @@ export type FilterStarterRequest = {
     "type"?: "INFRA" | "APP";
 };
 export type PageStarterResponseWithRange = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -722,8 +722,8 @@ export type FilterStackVersionPluginRequest = {
     text?: string;
 };
 export type PageStackPluginResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -821,8 +821,8 @@ export type FilterStackActionRequest = {
     filter?: string;
 };
 export type PageGetStackActionResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1004,8 +1004,8 @@ export type UpdateDocRequest = {
     publish: boolean;
 };
 export type PageStudioResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1031,8 +1031,8 @@ export type PluginVersionDto = {
     governance?: GovernanceDto;
 };
 export type PagePluginVersionDto = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1058,8 +1058,8 @@ export type ActionVersionDto = {
     governance?: GovernanceDto;
 };
 export type PageActionVersionDto = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1185,8 +1185,8 @@ export type GetWorkflowsByStudioResponse = {
     latestVersion?: GetWorkflowsByStudioLatestVersionDataResponse;
 };
 export type PageGetWorkflowsByStudioResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1257,8 +1257,8 @@ export type GetAvailableWorkflowVersionsResponse = {
     version: string;
 };
 export type PageGetAvailableWorkflowVersionsResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1277,8 +1277,8 @@ export type StackWorkspaceViewResponse = {
     totalLinkedVersions: number;
 };
 export type PageStackWorkspaceViewResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1305,8 +1305,8 @@ export type StackWorkspaceDetailViewResponse = {
     environment?: StackWorkspaceDetailViewEnvironmentResponse;
 };
 export type PageStackWorkspaceDetailViewResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1324,8 +1324,8 @@ export type GetUnusedStackVersionsResponse = {
     status?: string;
 };
 export type PageGetUnusedStackVersionsResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1475,8 +1475,8 @@ export type PluginStarterResponse = {
     stack: StackResponse;
 };
 export type PagePluginStarterResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1501,8 +1501,8 @@ export type GetPluginStackStarterUsageResponse = {
     pluginVersion: GetPluginStackStarterUsagePluginResponse;
 };
 export type PageGetPluginStackStarterUsageResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1523,8 +1523,8 @@ export type PluginStacksResponse = {
     studio: PluginStudioResponse;
 };
 export type PagePluginStacksResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1549,8 +1549,8 @@ export type GetPluginStackUsageResponse = {
     pluginVersion: GetPluginStackUsagePluginResponse;
 };
 export type PageGetPluginStackUsageResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1575,8 +1575,8 @@ export type PluginInfrastructureViewResponse = {
     workspace: PluginInfrastructureWorkspaceResponse;
 };
 export type PagePluginInfrastructureViewResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1601,8 +1601,8 @@ export type InfrastructureEnvironmentsUsesPluginResponse = {
     pluginVersion: GetInfrastructureEnvironmentsUsagePluginVersionResponse;
 };
 export type PageInfrastructureEnvironmentsUsesPluginResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1621,8 +1621,8 @@ export type PluginViewUsageMonitorResponse = {
     studio: PluginStudioResponse;
 };
 export type PagePluginViewUsageMonitorResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1642,8 +1642,8 @@ export type GetDependentPluginsVersionsResponse = {
     pluginVersion: DependentPluginVersionResponse;
 };
 export type PageGetDependentPluginsVersionsResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1660,8 +1660,8 @@ export type GetPluginVersionsNotInUseResponse = {
     status: "DRAFT" | "PUBLISHED" | "DEPRECATED" | "REPROVED";
 };
 export type PageGetPluginVersionsNotInUseResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1694,8 +1694,8 @@ export type PluginApplicationsResponse = {
     workspace: PluginApplicationsWorkspaceResponse;
 };
 export type PagePluginApplicationsResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1720,8 +1720,8 @@ export type PluginUsageMonitorApplicationViewResponse = {
     environment: PluginUsageMonitorApplicationViewEnvironmentResponse;
 };
 export type PagePluginUsageMonitorApplicationViewResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -1843,8 +1843,8 @@ export type ContentEvaluationResponse = {
     pendingDiscussionReading: boolean;
 };
 export type PageContentEvaluationResponse = {
-    totalElements?: number;
     totalPages?: number;
+    totalElements?: number;
     first?: boolean;
     last?: boolean;
     size?: number;
@@ -5281,6 +5281,46 @@ export function getAvailableWorkflowVersionsByWorkflowSlug({ studioSlug, workflo
         ...opts
     }));
 }
+/**
+ * Get an workflow documentation
+ */
+export function getWorkflowDoc({ studioSlug, documentationId, language, status }: {
+    studioSlug: string;
+    documentationId: string;
+    language: string;
+    status?: string;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: DocumentationResponse;
+    } | {
+        status: 400;
+    } | {
+        status: 403;
+    } | {
+        status: 404;
+    } | {
+        status: 422;
+        data: {
+            code: string;
+            status: number;
+            details: string;
+            validationDetails?: ValidationDetails[];
+        };
+    } | {
+        status: 500;
+        data: {
+            code: string;
+            status: number;
+            details: string;
+            validationDetails?: ValidationDetails[];
+        };
+    }>(`/v1/studios/${encodeURIComponent(studioSlug)}/workflows/docs/${encodeURIComponent(documentationId)}/language/${encodeURIComponent(language)}${QS.query(QS.explode({
+        status
+    }))}`, {
+        ...opts
+    }));
+}
 /**
  * Get a starter documentation
  */

package/src/client/content.ts

@@ -3,11 +3,13 @@ import { addAction, addLink, addWorkspace, associateActionToPlugin, changeVisibi
   deleteAction, deleteActionVersion, deleteLink, deletePluginVersion, deleteStudio, deleteV1StacksVersionsByStackVersionId,
   delWorkspace, deprecateActionVersion, deprecatePluginVersion, deprecateStackVersionBy, downloadAction, getActionBySlug, 
   getActionsVersions, getActionVersionById, getAllActionVersions, getApplicationDetailsView, getApplicationsUsesPlugin, 
-  getAvailableActionVersionsByActionSlug, getDependentPluginsVersions, getGetPluginView, getInfrastructureEnvironmentsUsesPlugin, 
+  getAvailableActionVersionsByActionSlug, getAvailableWorkflowVersionsByWorkflowSlug, getDependentPluginsVersions, 
+  getGetPluginView, getInfrastructureEnvironmentsUsesPlugin, 
   getListOfInputs, getPluginInfrastructureView, getPluginModalView, getPluginVersions, getPluginVersionsNotInUse, 
   getPluginVersionUsageSummary, getStackUsesPlugin, getStackVersionById, getStackVersionListByIds, getStackWorkspaceDetailView,
   getStackWorkspaces, getStarterStackVersionsAndPluginsVersions, getStarterUsesPlugin, getStudioByIdOrSlug, getStudios1, 
-  getStudiosToCreateButton, getStudioTabs, getUnusedStackVersions, getWorkflow, getWorkflowByStudioSlug, listActions, listActions1, 
+  getStudiosToCreateButton, getStudioTabs, getUnusedStackVersions, getWorkflow, getWorkflowByStudioSlug, getWorkflowDoc, 
+  listActions, listActions1, 
   listActionsByFilters1, listConnectionInterfaceTypes, listLinksByStackVersion, listPlugins, listPluginVersionByIdsController,
   listReasons, listStacksByFilters, listStarters, listWorkspaces, patchStarterV2, removeActionFromPlugin, stackModalViewSummary,
   stackVersionUsageSummary, updateStudio, updateStudioTabs } from '../api/content'
@@ -108,11 +110,15 @@ class ContentClient extends ReactQueryNetworkClient {
   /**
    * Gets workflows from a given studio
    */
-  // workflowDoc = this.query(getWorkflowDoc)
+  workflowDoc = this.query(getWorkflowDoc)
   /**
    * Gets a workflow by slug
    */
   workflow = this.query(getWorkflow)
+  /**
+   * Gets a workflow by slug
+   */
+  workflowVersionsByRange = this.query(getAvailableWorkflowVersionsByWorkflowSlug)
   /**
    * Gets usage summary of stack
    */