chore(swagger): improved description

sasjs · Oct 29, 2024 · 049a7f4 · 049a7f4
1 parent 3053c68
commit 049a7f4
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 20 deletions.
diff --git a/api/public/swagger.yaml b/api/public/swagger.yaml
@@ -98,11 +98,11 @@ components:
             properties:
                 code:
                     type: string
-                    description: 'Code of program'
-                    example: '* Code HERE;'
+                    description: 'The code to be executed'
+                    example: '* Your Code HERE;'
                 runTime:
                     $ref: '#/components/schemas/RunTimeType'
-                    description: 'runtime for program'
+                    description: 'The runtime for the code - eg SAS, JS, PY or R'
                     example: js
             required:
                 - code
@@ -113,7 +113,7 @@ components:
             properties:
                 sessionId:
                     type: string
-                    description: "Session ID (SAS WORK folder) used to execute code.\nThis session ID should be used to poll job status."
+                    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."
                     example: '{ sessionId: ''20241028074744-54132-1730101664824'' }'
             required:
                 - sessionId
@@ -123,11 +123,11 @@ components:
             properties:
                 code:
                     type: string
-                    description: 'Code of program'
-                    example: '* Code HERE;'
+                    description: 'The code to be executed'
+                    example: '* Your Code HERE;'
                 runTime:
                     $ref: '#/components/schemas/RunTimeType'
-                    description: 'runtime for program'
+                    description: 'The runtime for the code - eg SAS, JS, PY or R'
                     example: sas
                 expiresAfterMins:
                     type: number
@@ -846,7 +846,7 @@ paths:
                             schema:
                                 $ref: '#/components/schemas/TriggerCodeResponse'
             description: 'Trigger Code on the Specified Runtime'
-            summary: 'Trigger Code and Return Session Id not awaiting for the job completion'
+            summary: 'Triggers code and returns SessionId immediately - does not wait for job completion'
             tags:
                 - Code
             security:
@@ -1852,15 +1852,15 @@ paths:
                     bearerAuth: []
             parameters:
                 -
-                    description: 'Location of code in SASjs Drive'
+                    description: 'Location of Stored Program in SASjs Drive.'
                     in: query
                     name: _program
                     required: true
                     schema:
                         type: string
                     example: /Projects/myApp/some/program
                 -
-                    description: 'Optional query param for setting debug mode, which will return the session log.'
+                    description: 'Optional query param for setting debug mode (returns the session log in the response body).'
                     in: query
                     name: _debug
                     required: false

diff --git a/api/src/controllers/code.ts b/api/src/controllers/code.ts
@@ -10,25 +10,25 @@ import {
 
 interface ExecuteCodePayload {
   /**
-   * Code of program
-   * @example "* Code HERE;"
+   * The code to be executed
+   * @example "* Your Code HERE;"
    */
   code: string
   /**
-   * runtime for program
+   * The runtime for the code - eg SAS, JS, PY or R
    * @example "js"
    */
   runTime: RunTimeType
 }
 
 interface TriggerCodePayload {
   /**
-   * Code of program
-   * @example "* Code HERE;"
+   * The code to be executed
+   * @example "* Your Code HERE;"
    */
   code: string
   /**
-   * runtime for program
+   * The runtime for the code - eg SAS, JS, PY or R
    * @example "sas"
    */
   runTime: RunTimeType
@@ -42,7 +42,8 @@ interface TriggerCodePayload {
 
 interface TriggerCodeResponse {
   /**
-   * Session ID (SAS WORK folder) used to execute code.
+   * 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.
    * @example "{ sessionId: '20241028074744-54132-1730101664824' }"
    */
@@ -74,7 +75,7 @@ export class CodeController {
 
   /**
    * Trigger Code on the Specified Runtime
-   * @summary Trigger Code and Return Session Id not awaiting for the job completion
+   * @summary Triggers code and returns SessionId immediately - does not wait for job completion
    */
   @Post('/trigger')
   public async triggerCode(

diff --git a/api/src/controllers/stp.ts b/api/src/controllers/stp.ts
@@ -30,8 +30,8 @@ export class STPController {
    * https://server.sasjs.io/storedprograms
    *
    * @summary Execute a Stored Program, returns _webout and (optionally) log.
-   * @param _program Location of code in SASjs Drive
-   * @param _debug Optional query param for setting debug mode, which will return the session log.
+   * @param _program Location of Stored Program in SASjs Drive.
+   * @param _debug Optional query param for setting debug mode (returns the session log in the response body).
    * @example _program "/Projects/myApp/some/program"
    * @example _debug 131
    */