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

chore(api): updated endpoint description

Browse Source
This commit is contained in:
Yury
2024-10-31 14:08:56 +03:00
parent 73df102422
commit ca17e7c192
2 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
api/public/swagger.yaml
View File

@@ -1859,7 +1859,8 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/SessionState' $ref: '#/components/schemas/SessionState'
summary: "Get session state (initialising, pending, running, completed, failed).\nPolling session state won't work in a load-balanced situation." description: "The polling endpoint is currently implemented for single-server deployments only.<br>\nLoad balanced / grid topologies will be supported in a future release.<br>\nIf your site requires this, please reach out to SASjs Support."
summary: 'Get session state (initialising, pending, running, completed, failed).'
tags: tags:
- Session - Session
security: security:

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

@@ -30,8 +30,10 @@ export class SessionController {
} }
/** /**
* The polling endpoint is currently implemented for single-server deployments only.<br>
* Load balanced / grid topologies will be supported in a future release.<br>
* If your site requires this, please reach out to SASjs Support.
* @summary Get session state (initialising, pending, running, completed, failed). * @summary Get session state (initialising, pending, running, completed, failed).
* Polling session state won't work in a load-balanced situation.
* @example completed * @example completed
*/ */
@Get('/:sessionId/state') @Get('/:sessionId/state')