sasjs/server
1
0
Fork 0
mirror of https://github.com/sasjs/server.git synced 2025-12-10 11:24:35 +00:00
Code Issues Projects Releases Wiki Activity

chore(api): updated trigger endpoints description

Browse Source
This commit is contained in:
Yury
2024-10-31 15:20:35 +03:00
parent ca17e7c192
commit 66aa9b5891
3 changed files with 12 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
api/public/swagger.yaml
View File

@@ -113,7 +113,7 @@ components:
properties:
sessionId:
type: string
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."
description: "sessionId is the ID of the session and the name of the temporary folder\nused to store code outputs.<br>\nFor SAS, this would be the SASWORK folder.<br>\nsessionId can be used to poll session state using\nGET /SASjsApi/session/{sessionId}/state endpoint."
example: 20241028074744-54132-1730101664824
required:
- sessionId
@@ -605,7 +605,7 @@ components:
properties:
sessionId:
type: string
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 program status.\nThis session ID should be used to poll program status."
description: "sessionId is the ID of the session and the name of the temporary folder\nused to store program outputs.<br>\nFor SAS, this would be the SASWORK folder.<br>\nsessionId can be used to poll session state using\nGET /SASjsApi/session/{sessionId}/state endpoint."
example: 20241028074744-54132-1730101664824
required:
- sessionId

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

@@ -42,9 +42,11 @@ interface TriggerCodePayload {
interface TriggerCodeResponse {
/**
* 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.
* sessionId is the ID of the session and the name of the temporary folder
* used to store code outputs.<br>
* For SAS, this would be the SASWORK folder.<br>
* sessionId can be used to poll session state using
* GET /SASjsApi/session/{sessionId}/state endpoint.
* @example "20241028074744-54132-1730101664824"
*/
sessionId: string

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

@@ -40,9 +40,11 @@ interface TriggerProgramPayload {
interface TriggerProgramResponse {
/**
* 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 program status.
* This session ID should be used to poll program status.
* sessionId is the ID of the session and the name of the temporary folder
* used to store program outputs.<br>
* For SAS, this would be the SASWORK folder.<br>
* sessionId can be used to poll session state using
* GET /SASjsApi/session/{sessionId}/state endpoint.
* @example "20241028074744-54132-1730101664824"
*/
sessionId: string