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:30:32 +03:00
parent 66aa9b5891
commit bc2cff1d0d
3 changed files with 10 additions and 10 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: properties:
sessionId: sessionId:
type: string type: string
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." description: "`sessionId` is the ID of the session and the name of the temporary folder\nused to store code outputs.<br><br>\nFor SAS, this would be the location of the SASWORK folder.<br><br>\n`sessionId` can be used to poll session state using the\nGET /SASjsApi/session/{sessionId}/state endpoint."
example: 20241028074744-54132-1730101664824 example: 20241028074744-54132-1730101664824
required: required:
- sessionId - sessionId
@@ -605,7 +605,7 @@ components:
properties: properties:
sessionId: sessionId:
type: string type: string
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." description: "`sessionId` is the ID of the session and the name of the temporary folder\nused to store program outputs.<br><br>\nFor SAS, this would be the location of the SASWORK folder.<br><br>\n`sessionId` can be used to poll session state using the\nGET /SASjsApi/session/{sessionId}/state endpoint."
example: 20241028074744-54132-1730101664824 example: 20241028074744-54132-1730101664824
required: required:
- sessionId - sessionId

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

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

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

@@ -40,10 +40,10 @@ interface TriggerProgramPayload {
interface TriggerProgramResponse { interface TriggerProgramResponse {
/** /**
* sessionId is the ID of the session and the name of the temporary folder * `sessionId` is the ID of the session and the name of the temporary folder
* used to store program outputs.<br> * used to store program outputs.<br><br>
* For SAS, this would be the SASWORK folder.<br> * For SAS, this would be the location of the SASWORK folder.<br><br>
* sessionId can be used to poll session state using * `sessionId` can be used to poll session state using the
* GET /SASjsApi/session/{sessionId}/state endpoint. * GET /SASjsApi/session/{sessionId}/state endpoint.
* @example "20241028074744-54132-1730101664824" * @example "20241028074744-54132-1730101664824"
*/ */