Skip to content

Commit a1d783d

Browse files
committed
small fix to the swagger documentation
1 parent f169aa0 commit a1d783d

File tree

3 files changed

+20
-20
lines changed

3 files changed

+20
-20
lines changed

docs/docs.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,7 @@ const docTemplate = `{
381381
}
382382
}
383383
},
384-
"/v1/sessions/{session_token}/ws/logs": {
384+
"/sessions/{session_token}/ws/logs": {
385385
"get": {
386386
"description": "Upgrades the HTTP connection to a WebSocket and streams session log lines as UTF-8 text frames.\nThe server sends periodic ping frames (~30s) and expects pong responses; idle connections may be closed.",
387387
"tags": [

docs/swagger.yaml

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -497,24 +497,7 @@ paths:
497497
summary: Get session statistics
498498
tags:
499499
- sessions
500-
/sessions/list:
501-
get:
502-
description: Returns the session tokens for all currently active sessions.
503-
produces:
504-
- application/json
505-
responses:
506-
"200":
507-
description: OK
508-
schema:
509-
$ref: '#/definitions/v1.ListSessionsResponse'
510-
"404":
511-
description: Zero sessions found
512-
schema:
513-
$ref: '#/definitions/v1.ErrorResponse'
514-
summary: List active sessions
515-
tags:
516-
- sessions
517-
/v1/sessions/{session_token}/ws/logs:
500+
/sessions/{session_token}/ws/logs:
518501
get:
519502
description: |-
520503
Upgrades the HTTP connection to a WebSocket and streams session log lines as UTF-8 text frames.
@@ -546,6 +529,23 @@ paths:
546529
summary: Stream session logs (WebSocket)
547530
tags:
548531
- sessions
532+
/sessions/list:
533+
get:
534+
description: Returns the session tokens for all currently active sessions.
535+
produces:
536+
- application/json
537+
responses:
538+
"200":
539+
description: OK
540+
schema:
541+
$ref: '#/definitions/v1.ListSessionsResponse'
542+
"404":
543+
description: Zero sessions found
544+
schema:
545+
$ref: '#/definitions/v1.ErrorResponse'
546+
summary: List active sessions
547+
tags:
548+
- sessions
549549
swagger: "2.0"
550550
tags:
551551
- description: System endpoints (health, etc.)

engine/api/server/v1/websocket.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ var upgrader = websocket.Upgrader{
3030
// @Success 101 "Switching Protocols (WebSocket upgrade)"
3131
// @Failure 400 {object} ErrorResponse "Invalid session token"
3232
// @Failure 404 {object} ErrorResponse "Session not found"
33-
// @Router /v1/sessions/{session_token}/ws/logs [get]
33+
// @Router /sessions/{session_token}/ws/logs [get]
3434
// @Header 101 {string} Upgrade "websocket"
3535
// @Header 101 {string} Connection "Upgrade"
3636
func (v *V1Handlers) WSLogsHandler(w http.ResponseWriter, r *http.Request) {

0 commit comments

Comments
 (0)