From b0349fea3e012787d1bde286ea54831a1d74ab2b Mon Sep 17 00:00:00 2001 From: Subramanian Neelakantan Date: Tue, 23 Jul 2024 04:14:00 +0000 Subject: [PATCH] [PLAT-14710] update api doc for /session_info Summary: This should have been part of D36712, but was missed. So following up with another change to update the api doc. Test Plan: swaggerGen Reviewers: svarshney, #yba-api-review! Reviewed By: svarshney Subscribers: yugaware Differential Revision: https://phorge.dev.yugabyte.com/D36761 --- .../java/com/yugabyte/yw/controllers/SessionController.java | 4 +++- managed/src/main/resources/swagger-strict.json | 2 +- managed/src/main/resources/swagger.json | 2 +- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/managed/src/main/java/com/yugabyte/yw/controllers/SessionController.java b/managed/src/main/java/com/yugabyte/yw/controllers/SessionController.java index 56d4343603b4..81e006bc4804 100644 --- a/managed/src/main/java/com/yugabyte/yw/controllers/SessionController.java +++ b/managed/src/main/java/com/yugabyte/yw/controllers/SessionController.java @@ -181,7 +181,9 @@ public static class SessionInfo { @ApiOperation( nickname = "getSessionInfo", - value = "Get current user/customer uuid auth/api token", + value = + "Get current user and customer uuid. This will not generate or return the API token, use" + + " /api_token API for that.", authorizations = @Authorization(AbstractPlatformController.API_KEY_AUTH), response = SessionInfo.class) @With(TokenAuthenticator.class) diff --git a/managed/src/main/resources/swagger-strict.json b/managed/src/main/resources/swagger-strict.json index 16253e0bd06f..7fb1f51d8f5d 100644 --- a/managed/src/main/resources/swagger-strict.json +++ b/managed/src/main/resources/swagger-strict.json @@ -28556,7 +28556,7 @@ "security" : [ { "apiKeyAuth" : [ ] } ], - "summary" : "Get current user/customer uuid auth/api token", + "summary" : "Get current user and customer uuid. This will not generate or return the API token, use /api_token API for that.", "tags" : [ "Session management" ] } }, diff --git a/managed/src/main/resources/swagger.json b/managed/src/main/resources/swagger.json index 96b94d4b3ab7..564a3235c85e 100644 --- a/managed/src/main/resources/swagger.json +++ b/managed/src/main/resources/swagger.json @@ -30018,7 +30018,7 @@ "security" : [ { "apiKeyAuth" : [ ] } ], - "summary" : "Get current user/customer uuid auth/api token", + "summary" : "Get current user and customer uuid. This will not generate or return the API token, use /api_token API for that.", "tags" : [ "Session management" ] } },