Skip to content

Commit 9a2f869

Browse files
pk910pk910
committed
update swagger docs
1 parent a640ea2 commit 9a2f869

File tree

3 files changed

+177
-0
lines changed

3 files changed

+177
-0
lines changed

‎pkg/coordinator/web/api/docs/docs.go‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -294,6 +294,73 @@ const docTemplate = `{
294294
}
295295
}
296296
},
297+
"/api/v1/test_run/{runId}/task/{taskIndex}/details": {
298+
"get": {
299+
"description": "Returns the task details with given run ID and task index. Includes full log, configuration and result variables (unless security trimmed).",
300+
"produces": [
301+
"application/json"
302+
],
303+
"tags": [
304+
"TestRun"
305+
],
306+
"summary": "Get detailed task of a given test run",
307+
"operationId": "getTestRunTaskDetails",
308+
"parameters": [
309+
{
310+
"type": "string",
311+
"description": "ID of the test run",
312+
"name": "runId",
313+
"in": "path",
314+
"required": true
315+
},
316+
{
317+
"type": "string",
318+
"description": "Index of the task to get details for",
319+
"name": "taskIndex",
320+
"in": "path",
321+
"required": true
322+
}
323+
],
324+
"responses": {
325+
"200": {
326+
"description": "Success",
327+
"schema": {
328+
"allOf": [
329+
{
330+
"$ref": "#/definitions/github_com_ethpandaops_assertoor_pkg_coordinator_web_api.Response"
331+
},
332+
{
333+
"type": "object",
334+
"properties": {
335+
"data": {
336+
"$ref": "#/definitions/api.GetTestRunDetailedTask"
337+
}
338+
}
339+
}
340+
]
341+
}
342+
},
343+
"400": {
344+
"description": "Bad Request",
345+
"schema": {
346+
"$ref": "#/definitions/github_com_ethpandaops_assertoor_pkg_coordinator_web_api.Response"
347+
}
348+
},
349+
"404": {
350+
"description": "Not Found",
351+
"schema": {
352+
"$ref": "#/definitions/github_com_ethpandaops_assertoor_pkg_coordinator_web_api.Response"
353+
}
354+
},
355+
"500": {
356+
"description": "Server Error",
357+
"schema": {
358+
"$ref": "#/definitions/github_com_ethpandaops_assertoor_pkg_coordinator_web_api.Response"
359+
}
360+
}
361+
}
362+
}
363+
},
297364
"/api/v1/test_run/{runId}/task/{taskIndex}/result/{resultType}/{fileId}": {
298365
"get": {
299366
"description": "Returns a specific result file from a task",

‎pkg/coordinator/web/api/docs/swagger.json‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -286,6 +286,73 @@
286286
}
287287
}
288288
},
289+
"/api/v1/test_run/{runId}/task/{taskIndex}/details": {
290+
"get": {
291+
"description": "Returns the task details with given run ID and task index. Includes full log, configuration and result variables (unless security trimmed).",
292+
"produces": [
293+
"application/json"
294+
],
295+
"tags": [
296+
"TestRun"
297+
],
298+
"summary": "Get detailed task of a given test run",
299+
"operationId": "getTestRunTaskDetails",
300+
"parameters": [
301+
{
302+
"type": "string",
303+
"description": "ID of the test run",
304+
"name": "runId",
305+
"in": "path",
306+
"required": true
307+
},
308+
{
309+
"type": "string",
310+
"description": "Index of the task to get details for",
311+
"name": "taskIndex",
312+
"in": "path",
313+
"required": true
314+
}
315+
],
316+
"responses": {
317+
"200": {
318+
"description": "Success",
319+
"schema": {
320+
"allOf": [
321+
{
322+
"$ref": "#/definitions/github_com_ethpandaops_assertoor_pkg_coordinator_web_api.Response"
323+
},
324+
{
325+
"type": "object",
326+
"properties": {
327+
"data": {
328+
"$ref": "#/definitions/api.GetTestRunDetailedTask"
329+
}
330+
}
331+
}
332+
]
333+
}
334+
},
335+
"400": {
336+
"description": "Bad Request",
337+
"schema": {
338+
"$ref": "#/definitions/github_com_ethpandaops_assertoor_pkg_coordinator_web_api.Response"
339+
}
340+
},
341+
"404": {
342+
"description": "Not Found",
343+
"schema": {
344+
"$ref": "#/definitions/github_com_ethpandaops_assertoor_pkg_coordinator_web_api.Response"
345+
}
346+
},
347+
"500": {
348+
"description": "Server Error",
349+
"schema": {
350+
"$ref": "#/definitions/github_com_ethpandaops_assertoor_pkg_coordinator_web_api.Response"
351+
}
352+
}
353+
}
354+
}
355+
},
289356
"/api/v1/test_run/{runId}/task/{taskIndex}/result/{resultType}/{fileId}": {
290357
"get": {
291358
"description": "Returns a specific result file from a task",

‎pkg/coordinator/web/api/docs/swagger.yaml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -535,6 +535,49 @@ paths:
535535
summary: Get test run status by run ID
536536
tags:
537537
- TestRun
538+
/api/v1/test_run/{runId}/task/{taskIndex}/details:
539+
get:
540+
description: Returns the task details with given run ID and task index. Includes
541+
full log, configuration and result variables (unless security trimmed).
542+
operationId: getTestRunTaskDetails
543+
parameters:
544+
- description: ID of the test run
545+
in: path
546+
name: runId
547+
required: true
548+
type: string
549+
- description: Index of the task to get details for
550+
in: path
551+
name: taskIndex
552+
required: true
553+
type: string
554+
produces:
555+
- application/json
556+
responses:
557+
"200":
558+
description: Success
559+
schema:
560+
allOf:
561+
- $ref: '#/definitions/github_com_ethpandaops_assertoor_pkg_coordinator_web_api.Response'
562+
- properties:
563+
data:
564+
$ref: '#/definitions/api.GetTestRunDetailedTask'
565+
type: object
566+
"400":
567+
description: Bad Request
568+
schema:
569+
$ref: '#/definitions/github_com_ethpandaops_assertoor_pkg_coordinator_web_api.Response'
570+
"404":
571+
description: Not Found
572+
schema:
573+
$ref: '#/definitions/github_com_ethpandaops_assertoor_pkg_coordinator_web_api.Response'
574+
"500":
575+
description: Server Error
576+
schema:
577+
$ref: '#/definitions/github_com_ethpandaops_assertoor_pkg_coordinator_web_api.Response'
578+
summary: Get detailed task of a given test run
579+
tags:
580+
- TestRun
538581
/api/v1/test_run/{runId}/task/{taskIndex}/result/{resultType}/{fileId}:
539582
get:
540583
description: Returns a specific result file from a task

0 commit comments

Comments
 (0)