chore(api): updated trigger endpoints description

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

Hide file tree

Showing 3 changed files with 10 additions and 10 deletions.
diff --git a/api/public/swagger.yaml b/api/public/swagger.yaml
@@ -113,7 +113,7 @@ components:
             properties:
                 sessionId:
                     type: string
-                    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."
+                    description: "`sessionId` is the ID of the session and the name of the temporary folder\nused to store code outputs.<br><br>\nFor SAS, this would be the location of the SASWORK folder.<br><br>\n`sessionId` can be used to poll session state using the\nGET /SASjsApi/session/{sessionId}/state endpoint."
                     example: 20241028074744-54132-1730101664824
             required:
                 - sessionId
@@ -605,7 +605,7 @@ components:
             properties:
                 sessionId:
                     type: string
-                    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."
+                    description: "`sessionId` is the ID of the session and the name of the temporary folder\nused to store program outputs.<br><br>\nFor SAS, this would be the location of the SASWORK folder.<br><br>\n`sessionId` can be used to poll session state using the\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,10 +42,10 @@ interface TriggerCodePayload {
 
 interface TriggerCodeResponse {
   /**
-   * 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
+   * `sessionId` is the ID of the session and the name of the temporary folder
+   * used to store code outputs.<br><br>
+   * For SAS, this would be the location of the SASWORK folder.<br><br>
+   * `sessionId` can be used to poll session state using the
    * GET /SASjsApi/session/{sessionId}/state endpoint.
    * @example "20241028074744-54132-1730101664824"
    */

diff --git a/api/src/controllers/stp.ts b/api/src/controllers/stp.ts
@@ -40,10 +40,10 @@ interface TriggerProgramPayload {
 
 interface TriggerProgramResponse {
   /**
-   * 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
+   * `sessionId` is the ID of the session and the name of the temporary folder
+   * used to store program outputs.<br><br>
+   * For SAS, this would be the location of the SASWORK folder.<br><br>
+   * `sessionId` can be used to poll session state using the
    * GET /SASjsApi/session/{sessionId}/state endpoint.
    * @example "20241028074744-54132-1730101664824"
    */