From ca17e7c1921ebd8879c80ed9a7873e2560a5b39d Mon Sep 17 00:00:00 2001
From: Yury <yury@4gl.io>
Date: Thu, 31 Oct 2024 14:08:56 +0300
Subject: [PATCH] chore(api): updated endpoint description

---
 api/public/swagger.yaml        | 3 ++-
 api/src/controllers/session.ts | 4 +++-
 2 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/api/public/swagger.yaml b/api/public/swagger.yaml
index c006b26..243f5a0 100644
--- 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
index c2acea4..e4cfdf5 100644
--- 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')