sasjs/server
1
0
Fork 0
mirror of https://github.com/sasjs/server.git synced 2026-01-04 21:30:05 +00:00
Code Issues Projects Releases Wiki Activity

chore(docs): updating API docs

Browse Source
This commit is contained in:
munja
2022-09-20 12:20:50 +01:00
parent 5c0eff5197
commit 1092a73c10
4 changed files with 14 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
api/src/controllers/stp.ts
View File

@@ -23,14 +23,14 @@ interface ExecutePostRequestPayload {
@Tags('STP')
export class STPController {
/**
* Trigger a SAS or JS program using the _program URL parameter.
* Trigger a Stored Program using the _program URL parameter.
*
* Accepts URL parameters and file uploads. For more details, see docs:
*
* https://server.sasjs.io/storedprograms
*
* @summary Execute a Stored Program, returns raw _webout content.
* @param _program Location of SAS or JS code
* @summary Execute a Stored Program, returns _webout and (optionally) log.
* @param _program Location of code in SASjs Drive
* @example _program "/Projects/myApp/some/program"
*/
@Get('/execute')
@@ -43,21 +43,15 @@ export class STPController {
}
/**
* Trigger a SAS or JS program using the _program URL parameter.
* Trigger a Stored Program using the _program URL parameter.
*
* Accepts URL parameters and file uploads. For more details, see docs:
*
* https://server.sasjs.io/storedprograms
*
* The response will be a JSON object with the following root attributes:
* log, webout, headers.
*
* The webout attribute will be nested JSON ONLY if the response-header
* contains a content-type of application/json AND it is valid JSON.
* Otherwise it will be a stringified version of the webout content.
*
* @summary Execute a Stored Program, return a JSON object
* @param _program Location of SAS or JS code
* @param _program Location of code in SASjs Drive
* @example _program "/Projects/myApp/some/program"
*/
@Post('/execute')