screwdriver
screwdriver copied to clipboard
Correct the description given in the swagger
What happened: The description given in the swagger is wrong.
What you expected to happen: I have found the points below. There may be others.
-
The parameters
search
,sort
,sortBy
, andgetCount
don't seem to be used in the actual application. Other APIs (e.g.GET /v4/pipelines/{id}/jobs
) seem to have the same issue. -
Only
/v4/auth/token/{buildId}
is listed. -
The response
workflowGraph.nodes[]
actually contains the jobId asid
. Other APIs (e.g.GET /v4/pipelimes/{id}/events
) seem to have the same issue.Actually
:"workflowGraph": { "nodes": [ { "name": "~commit" }, { "name": "main", "id": 527 } ] },
-
In the case where there is only one value for
parentBuildId
, it seems that it is not actually an array. If it is always returned in an array, it will be sufficient.Actually
:"parentBuildId": 5, OR "parentBuildId": [ 6, 7 ],
How to reproduce it: See swagger.