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

chore(swagger): improved description

Browse Source
This commit is contained in:
Yury
2024-10-29 12:02:26 +03:00
parent 3053c68bdf
commit 049a7f4b80
3 changed files with 21 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
api/src/controllers/code.ts
View File

@@ -10,12 +10,12 @@ 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
@@ -23,12 +23,12 @@ interface ExecuteCodePayload {
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(

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

@@ -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
*/