feat: update parameter descriptions in Session API (#4140)

This commit is contained in:
amaankm
2025-09-02 14:01:06 +05:30
committed by GitHub
parent f93aeb5350
commit 01000f7022
3 changed files with 19 additions and 19 deletions

View File

@@ -68,7 +68,7 @@ func (c *ApiController) GetSessions() {
// @Title GetSingleSession // @Title GetSingleSession
// @Tag Session API // @Tag Session API
// @Description Get session for one user in one application. // @Description Get session for one user in one application.
// @Param id query string true "The id(organization/application/user) of session" // @Param sessionPkId query string true "The id(organization/user/application) of session"
// @Success 200 {array} string The Response object // @Success 200 {array} string The Response object
// @router /get-session [get] // @router /get-session [get]
func (c *ApiController) GetSingleSession() { func (c *ApiController) GetSingleSession() {
@@ -87,7 +87,7 @@ func (c *ApiController) GetSingleSession() {
// @Title UpdateSession // @Title UpdateSession
// @Tag Session API // @Tag Session API
// @Description Update session for one user in one application. // @Description Update session for one user in one application.
// @Param id query string true "The id(organization/application/user) of session" // @Param id query string true "The id(organization/user/application) of session"
// @Success 200 {array} string The Response object // @Success 200 {array} string The Response object
// @router /update-session [post] // @router /update-session [post]
func (c *ApiController) UpdateSession() { func (c *ApiController) UpdateSession() {
@@ -106,7 +106,7 @@ func (c *ApiController) UpdateSession() {
// @Title AddSession // @Title AddSession
// @Tag Session API // @Tag Session API
// @Description Add session for one user in one application. If there are other existing sessions, join the session into the list. // @Description Add session for one user in one application. If there are other existing sessions, join the session into the list.
// @Param id query string true "The id(organization/application/user) of session" // @Param id query string true "The id(organization/user/application) of session"
// @Param sessionId query string true "sessionId to be added" // @Param sessionId query string true "sessionId to be added"
// @Success 200 {array} string The Response object // @Success 200 {array} string The Response object
// @router /add-session [post] // @router /add-session [post]
@@ -126,7 +126,7 @@ func (c *ApiController) AddSession() {
// @Title DeleteSession // @Title DeleteSession
// @Tag Session API // @Tag Session API
// @Description Delete session for one user in one application. // @Description Delete session for one user in one application.
// @Param id query string true "The id(organization/application/user) of session" // @Param id query string true "The id(organization/user/application) of session"
// @Success 200 {array} string The Response object // @Success 200 {array} string The Response object
// @router /delete-session [post] // @router /delete-session [post]
func (c *ApiController) DeleteSession() { func (c *ApiController) DeleteSession() {
@@ -145,7 +145,7 @@ func (c *ApiController) DeleteSession() {
// @Title IsSessionDuplicated // @Title IsSessionDuplicated
// @Tag Session API // @Tag Session API
// @Description Check if there are other different sessions for one user in one application. // @Description Check if there are other different sessions for one user in one application.
// @Param id query string true "The id(organization/application/user) of session" // @Param sessionPkId query string true "The id(organization/user/application) of session"
// @Param sessionId query string true "sessionId to be checked" // @Param sessionId query string true "sessionId to be checked"
// @Success 200 {array} string The Response object // @Success 200 {array} string The Response object
// @router /is-session-duplicated [get] // @router /is-session-duplicated [get]

View File

@@ -638,7 +638,7 @@
{ {
"in": "query", "in": "query",
"name": "id", "name": "id",
"description": "The id(organization/application/user) of session", "description": "The id(organization/user/application) of session",
"required": true, "required": true,
"type": "string" "type": "string"
}, },
@@ -1448,7 +1448,7 @@
{ {
"in": "query", "in": "query",
"name": "id", "name": "id",
"description": "The id(organization/application/user) of session", "description": "The id(organization/user/application) of session",
"required": true, "required": true,
"type": "string" "type": "string"
} }
@@ -3318,8 +3318,8 @@
"parameters": [ "parameters": [
{ {
"in": "query", "in": "query",
"name": "id", "name": "sessionPkId",
"description": "The id(organization/application/user) of session", "description": "The id(organization/user/application) of session",
"required": true, "required": true,
"type": "string" "type": "string"
} }
@@ -4034,8 +4034,8 @@
"parameters": [ "parameters": [
{ {
"in": "query", "in": "query",
"name": "id", "name": "sessionPkId",
"description": "The id(organization/application/user) of session", "description": "The id(organization/user/application) of session",
"required": true, "required": true,
"type": "string" "type": "string"
}, },
@@ -5457,7 +5457,7 @@
{ {
"in": "query", "in": "query",
"name": "id", "name": "id",
"description": "The id(organization/application/user) of session", "description": "The id(organization/user/application) of session",
"required": true, "required": true,
"type": "string" "type": "string"
} }

View File

@@ -413,7 +413,7 @@ paths:
parameters: parameters:
- in: query - in: query
name: id name: id
description: The id(organization/application/user) of session description: The id(organization/user/application) of session
required: true required: true
type: string type: string
- in: query - in: query
@@ -935,7 +935,7 @@ paths:
parameters: parameters:
- in: query - in: query
name: id name: id
description: The id(organization/application/user) of session description: The id(organization/user/application) of session
required: true required: true
type: string type: string
responses: responses:
@@ -2159,8 +2159,8 @@ paths:
operationId: ApiController.GetSingleSession operationId: ApiController.GetSingleSession
parameters: parameters:
- in: query - in: query
name: id name: sessionPkId
description: The id(organization/application/user) of session description: The id(organization/user/application) of session
required: true required: true
type: string type: string
responses: responses:
@@ -2629,8 +2629,8 @@ paths:
operationId: ApiController.IsSessionDuplicated operationId: ApiController.IsSessionDuplicated
parameters: parameters:
- in: query - in: query
name: id name: sessionPkId
description: The id(organization/application/user) of session description: The id(organization/user/application) of session
required: true required: true
type: string type: string
- in: query - in: query
@@ -3567,7 +3567,7 @@ paths:
parameters: parameters:
- in: query - in: query
name: id name: id
description: The id(organization/application/user) of session description: The id(organization/user/application) of session
required: true required: true
type: string type: string
responses: responses: