1
0
mirror of https://github.com/sasjs/server.git synced 2025-12-10 11:24:35 +00:00

chore(api): updated endpoint description

This commit is contained in:
Yury
2024-10-31 12:27:56 +03:00
parent 48a9a4dd0e
commit 73df102422
2 changed files with 2 additions and 1 deletions

View File

@@ -1859,7 +1859,7 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/SessionState' $ref: '#/components/schemas/SessionState'
summary: 'Get session state (initialising, pending, running, completed, failed).' summary: "Get session state (initialising, pending, running, completed, failed).\nPolling session state won't work in a load-balanced situation."
tags: tags:
- Session - Session
security: security:

View File

@@ -31,6 +31,7 @@ export class SessionController {
/** /**
* @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')