sasjs/server
1
0
Fork 0
mirror of https://github.com/sasjs/server.git synced 2025-12-11 03:34:35 +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

20
api/public/swagger.yaml
View File

@@ -98,11 +98,11 @@ components:
properties: properties:
code: code:
type: string type: string
description: 'Code of program' description: 'The code to be executed'
example: '* Code HERE;' example: '* Your Code HERE;'
runTime: runTime:
$ref: '#/components/schemas/RunTimeType' $ref: '#/components/schemas/RunTimeType'
description: 'runtime for program' description: 'The runtime for the code - eg SAS, JS, PY or R'
example: js example: js
required: required:
- code - code
@@ -113,7 +113,7 @@ components:
properties: properties:
sessionId: sessionId:
type: string 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'' }' example: '{ sessionId: ''20241028074744-54132-1730101664824'' }'
required: required:
- sessionId - sessionId
@@ -123,11 +123,11 @@ components:
properties: properties:
code: code:
type: string type: string
description: 'Code of program' description: 'The code to be executed'
example: '* Code HERE;' example: '* Your Code HERE;'
runTime: runTime:
$ref: '#/components/schemas/RunTimeType' $ref: '#/components/schemas/RunTimeType'
description: 'runtime for program' description: 'The runtime for the code - eg SAS, JS, PY or R'
example: sas example: sas
expiresAfterMins: expiresAfterMins:
type: number type: number
@@ -846,7 +846,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/TriggerCodeResponse' $ref: '#/components/schemas/TriggerCodeResponse'
description: 'Trigger Code on the Specified Runtime' 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: tags:
- Code - Code
security: security:
@@ -1852,7 +1852,7 @@ paths:
bearerAuth: [] bearerAuth: []
parameters: parameters:
- -
description: 'Location of code in SASjs Drive' description: 'Location of Stored Program in SASjs Drive.'
in: query in: query
name: _program name: _program
required: true required: true
@@ -1860,7 +1860,7 @@ paths:
type: string type: string
example: /Projects/myApp/some/program 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 in: query
name: _debug name: _debug
required: false required: false

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

@@ -10,12 +10,12 @@ import {
interface ExecuteCodePayload { interface ExecuteCodePayload {
/** /**
* Code of program * The code to be executed
* @example "* Code HERE;" * @example "* Your Code HERE;"
*/ */
code: string code: string
/** /**
* runtime for program * The runtime for the code - eg SAS, JS, PY or R
* @example "js" * @example "js"
*/ */
runTime: RunTimeType runTime: RunTimeType
@@ -23,12 +23,12 @@ interface ExecuteCodePayload {
interface TriggerCodePayload { interface TriggerCodePayload {
/** /**
* Code of program * The code to be executed
* @example "* Code HERE;" * @example "* Your Code HERE;"
*/ */
code: string code: string
/** /**
* runtime for program * The runtime for the code - eg SAS, JS, PY or R
* @example "sas" * @example "sas"
*/ */
runTime: RunTimeType runTime: RunTimeType
@@ -42,7 +42,8 @@ interface TriggerCodePayload {
interface TriggerCodeResponse { 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. * This session ID should be used to poll job status.
* @example "{ sessionId: '20241028074744-54132-1730101664824' }" * @example "{ sessionId: '20241028074744-54132-1730101664824' }"
*/ */
@@ -74,7 +75,7 @@ export class CodeController {
/** /**
* Trigger Code on the Specified Runtime * 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') @Post('/trigger')
public async triggerCode( public async triggerCode(

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

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