screwdriver icon indicating copy to clipboard operation
screwdriver copied to clipboard

Correct the description given in the swagger

Open wahapo opened this issue 3 years ago • 3 comments

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.

  • GET /v4/pipelines/{id}/events

    The parameters search, sort, sortBy, and getCount 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.

  • GET /v4/auth/token

    Only /v4/auth/token/{buildId} is listed.

  • GET /v4/events/{id}

    The response workflowGraph.nodes[] actually contains the jobId as id. Other APIs (e.g. GET /v4/pipelimes/{id}/events) seem to have the same issue.

    Actually:

     "workflowGraph": {
       "nodes": [
         {
           "name": "~commit"
         },
         {
           "name": "main",
           "id": 527
         }
       ]
     },
    
  • GET /v4/builds/{id}

    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.

wahapo avatar Mar 09 '21 06:03 wahapo