chore(docs): updating swagger definitions

sasjs · Sep 21, 2022 · a810f6c · a810f6c
1 parent 5d6c608
commit a810f6c
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/api/public/swagger.yaml b/api/public/swagger.yaml
@@ -660,8 +660,8 @@ paths:
                                 anyOf:
                                     - {type: string}
                                     - {type: string, format: byte}
-            description: 'Execute SAS code.'
-            summary: 'Run SAS Code and returns log'
+            description: 'Execute Code on the Specified Runtime'
+            summary: 'Run Code and Return Webout Content and Log'
             tags:
                 - Code
             security:
@@ -1686,7 +1686,7 @@ paths:
                                     - {type: string}
                                     - {type: string, format: byte}
             description: "Trigger a Stored Program using the _program URL parameter.\n\nAccepts URL parameters and file uploads.  For more details, see docs:\n\nhttps://server.sasjs.io/storedprograms"
-            summary: 'Execute a Stored Program, return a JSON object'
+            summary: 'Execute a Stored Program, returns _webout and (optionally) log.'
             tags:
                 - STP
             security:

diff --git a/api/src/controllers/code.ts b/api/src/controllers/code.ts
@@ -27,8 +27,8 @@ interface ExecuteCodePayload {
 @Tags('Code')
 export class CodeController {
   /**
-   * Execute SAS code.
-   * @summary Run SAS Code and returns log
+   * Execute Code on the Specified Runtime
+   * @summary Run Code and Return Webout Content and Log
    */
   @Post('/execute')
   public async executeCode(

diff --git a/api/src/controllers/stp.ts b/api/src/controllers/stp.ts
@@ -50,7 +50,7 @@ export class STPController {
    * https://server.sasjs.io/storedprograms
    *
    *
-   * @summary Execute a Stored Program, return a JSON object
+   * @summary Execute a Stored Program, returns _webout and (optionally) log.
    * @param _program Location of code in SASjs Drive
    * @example _program "/Projects/myApp/some/program"
    */
@@ -92,7 +92,7 @@ const execute = async (
     )
 
     if (result instanceof Buffer) {
-      ;(req as any).sasHeaders = httpHeaders
+      ; (req as any).sasHeaders = httpHeaders
     }
 
     return result