chore(api): updated endpoint description

sasjs · Oct 31, 2024 · ca17e7c · ca17e7c
1 parent 73df102
commit ca17e7c
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/api/public/swagger.yaml b/api/public/swagger.yaml
@@ -1859,7 +1859,8 @@ paths:
                         application/json:
                             schema:
                                 $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:
                 - Session
             security:

diff --git a/api/src/controllers/session.ts b/api/src/controllers/session.ts
@@ -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).
-   * Polling session state won't work in a load-balanced situation.
    * @example completed
    */
   @Get('/:sessionId/state')