chore(api): updated trigger endpoints description

sasjs · Oct 31, 2024 · 66aa9b5 · 66aa9b5
1 parent ca17e7c
commit 66aa9b5
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 8 deletions.
diff --git 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
@@ -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
@@ -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