Skip to content

feat(docs): unify response schema for the GetSessions endpoint #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
kaua-alves-queiros wants to merge 7 commits into from
Closed

feat(docs): unify response schema for the GetSessions endpoint #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
65e7378
feat: The GetSessionsResponse now includes example string values for …
kaua-alves-queiros Aug 28, 2025
20e2385
Merge branch 'avoylenko:main' into main
kaua-alves-queiros Aug 30, 2025
fe09cbf
Merge branch 'avoylenko:main' into main
kaua-alves-queiros Aug 31, 2025
2f47f83
Merge branch 'avoylenko:main' into main
kaua-alves-queiros Sep 2, 2025
215c37c
Merge branch 'avoylenko:main' into main
kaua-alves-queiros Sep 6, 2025
db5929f
Merge branch 'avoylenko:main' into main
kaua-alves-queiros Sep 10, 2025
ca4eea9
feat(docs): unify response schema for the GetSessions endpoint
kaua-alves-queiros Sep 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 70 additions & 3 deletions src/controllers/sessionController.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -397,12 +397,79 @@ const getSessions = async (req, res) => {
description: "Retrieved all sessions.",
content: {
"application/json": {
schema: { "$ref": "#/definitions/GetSessionsResponse" }
schema: { "$ref": "#/definitions/GetSessionsResponse" },
examples: {
"Success": {
success: true,
result: ["sessionId1", "sessionId2", "sessionId3"],
message: "Retrieved all sessions.",
}
}
}
}
}

#swagger.responses[404] = {
description: "Not found.",
content: {
"application/json": {
schema: { "$ref": "#/definitions/GetSessionsResponse" },
examples: {
"Bad request": {
value: {
success: false,
result: [],
message: "Sessions not found"
}
}
}
}
}
}

#swagger.responses[403] = {
description: "Forbidden",
content: {
"application/json": {
schema: { "$ref": "#/definitions/GetSessionsResponse" },
examples: {
"Forbidden": {
value: {
success: false,
result: [],
message: "Invalid API key"
}
}
}
}
}
}

#swagger.responses[500] = {
description: "Internal Server Error.",
content: {
"application/json": {
schema: { "$ref": "#/definitions/GetSessionsResponse" },
examples: {
"Internal Server Error": {
value: {
success: false,
result: [],
message: "Internal Server Error."
}
}
}
}
}
}
*/
return res.json({ success: true, result: Array.from(sessions.keys()) })

if(sessions.keys().length === 0) {
res.status(404)
return res.json({ success: false, result: [], message: 'Sessions not found' })
}

return res.json({ success: true, result: Array.from(sessions.keys()), message: 'Sessions retrieved successfully'})
}

/**
Expand Down Expand Up @@ -466,4 +533,4 @@ module.exports = {
terminateAllSessions,
getSessions,
getPageScreenshot
}
}
5 changes: 3 additions & 2 deletions swagger.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,10 @@ const doc = {
},
GetSessionsResponse: {
success: true,
result: ['session1', 'session2']
result: ['session1', 'session2'],
message: 'Sessions retrieved successfully'
}
}
}

swaggerAutogen(outputFile, endpointsFiles, doc)
swaggerAutogen(outputFile, endpointsFiles, doc)
60 changes: 56 additions & 4 deletions swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,26 +120,74 @@
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetSessionsResponse"
},
"examples": {
"Success": {
"success": true,
"result": [
"sessionId1",
"sessionId2",
"sessionId3"
],
"message": "Retrieved all sessions."
}
}
}
}
},
"403": {
"description": "Forbidden.",
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenResponse"
"$ref": "#/components/schemas/GetSessionsResponse"
},
"examples": {
"Forbidden": {
"value": {
"success": false,
"result": [],
"message": "Invalid API key"
}
}
}
}
}
},
"404": {
"description": "Not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetSessionsResponse"
},
"examples": {
"Bad request": {
"value": {
"success": false,
"result": [],
"message": "Sessions not found"
}
}
}
}
}
},
"500": {
"description": "Server failure.",
"description": "Internal Server Error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
"$ref": "#/components/schemas/GetSessionsResponse"
},
"examples": {
"Internal Server Error": {
"value": {
"success": false,
"result": [],
"message": "Internal Server Error."
}
}
}
}
}
Expand Down Expand Up @@ -15066,6 +15114,10 @@
"items": {
"type": "string"
}
},
"message": {
"type": "string",
"example": "Sessions retrieved successfully"
}
},
"xml": {
Expand Down