[go: up one dir, main page]

Skip to content

File openapi_v2.yaml contains wrong response types

Summary

File openapi_v2.yaml contains wrong response types

Steps to reproduce

  1. open https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/api/openapi/openapi_v2.yaml
  2. find operations to get the list of merge requests, for example GET "/api/v4/groups/{id}/merge_requests" or GET "/api/v4/projects/{id}/merge_requests" example: https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/api/openapi/openapi_v2.yaml?plain=1#L16813
  3. check response type and see that there is object type:

What is the current bug behavior?

'200':
  description: List group merge requests
  schema:
     "$ref": "#/definitions/API_Entities_MergeRequestBasic"

What is the expected correct behavior?

Should be something like this, because this api return list of objects:

        '200':
          description: Get a list of subgroups in this group.
          schema:
            type: array
            items:
              "$ref": "#/definitions/API_Entities_MergeRequestBasic"