From 66aa9b589131f17d14e255250c79628186f95967 Mon Sep 17 00:00:00 2001
From: Yury <yury@4gl.io>
Date: Thu, 31 Oct 2024 15:20:35 +0300
Subject: [PATCH] chore(api): updated trigger endpoints description

---
 api/public/swagger.yaml     | 4 ++--
 api/src/controllers/code.ts | 8 +++++---
 api/src/controllers/stp.ts  | 8 +++++---
 3 files changed, 12 insertions(+), 8 deletions(-)

diff --git a/api/public/swagger.yaml b/api/public/swagger.yaml
index 243f5a0..4e8469e 100644
--- a/api/public/swagger.yaml
+++ b/api/public/swagger.yaml
@@ -113,7 +113,7 @@ components:
             properties:
                 sessionId:
                     type: string
-                    description: "The SessionId is the name of the temporary folder used to store the outputs.\nFor SAS, this would be the SASWORK folder. Can be used to poll job status.\nThis session ID should be used to poll job status."
+                    description: "sessionId is the ID of the session and the name of the temporary folder\nused to store code outputs.<br>\nFor SAS, this would be the SASWORK folder.<br>\nsessionId can be used to poll session state using\nGET /SASjsApi/session/{sessionId}/state endpoint."
                     example: 20241028074744-54132-1730101664824
             required:
                 - sessionId
@@ -605,7 +605,7 @@ components:
             properties:
                 sessionId:
                     type: string
-                    description: "The SessionId is the name of the temporary folder used to store the outputs.\nFor SAS, this would be the SASWORK folder. Can be used to poll program status.\nThis session ID should be used to poll program status."
+                    description: "sessionId is the ID of the session and the name of the temporary folder\nused to store program outputs.<br>\nFor SAS, this would be the SASWORK folder.<br>\nsessionId can be used to poll session state using\nGET /SASjsApi/session/{sessionId}/state endpoint."
                     example: 20241028074744-54132-1730101664824
             required:
                 - sessionId
diff --git a/api/src/controllers/code.ts b/api/src/controllers/code.ts
index 3719cce..f57b184 100644
--- a/api/src/controllers/code.ts
+++ b/api/src/controllers/code.ts
@@ -42,9 +42,11 @@ interface TriggerCodePayload {
 
 interface TriggerCodeResponse {
   /**
-   * The SessionId is the name of the temporary folder used to store the outputs.
-   * For SAS, this would be the SASWORK folder. Can be used to poll job status.
-   * This session ID should be used to poll job status.
+   * sessionId is the ID of the session and the name of the temporary folder
+   * used to store code outputs.<br>
+   * For SAS, this would be the SASWORK folder.<br>
+   * sessionId can be used to poll session state using
+   * GET /SASjsApi/session/{sessionId}/state endpoint.
    * @example "20241028074744-54132-1730101664824"
    */
   sessionId: string
diff --git a/api/src/controllers/stp.ts b/api/src/controllers/stp.ts
index ad3b5bd..0bc432b 100644
--- a/api/src/controllers/stp.ts
+++ b/api/src/controllers/stp.ts
@@ -40,9 +40,11 @@ interface TriggerProgramPayload {
 
 interface TriggerProgramResponse {
   /**
-   * The SessionId is the name of the temporary folder used to store the outputs.
-   * For SAS, this would be the SASWORK folder. Can be used to poll program status.
-   * This session ID should be used to poll program status.
+   * sessionId is the ID of the session and the name of the temporary folder
+   * used to store program outputs.<br>
+   * For SAS, this would be the SASWORK folder.<br>
+   * sessionId can be used to poll session state using
+   * GET /SASjsApi/session/{sessionId}/state endpoint.
    * @example "20241028074744-54132-1730101664824"
    */
   sessionId: string