Skip to content

GitLab

Closed
Created by Administrator@rootOwner

Response snippets in the API Documentation are not up-to-date

Created by: evra

I'm trying to implement a Java REST Api client for Gitlab. While implementing client model I found out that response examples in the doc have less fields then actual REST response.

Summary Response snippets in the API documentation (for example project data) are not in sync with the actual REST API responses.

Steps to reproduce

  1. Request "projects endpoint" /api/v3/projects?private_token=youToken using any REST client
  2. Open help/api/projects doc page
  3. Compare example response for GET /projects and actual response

Expected behavior: Documented response and actual response are equal Observed behavior There are additional fields in the actual response

        ssh_url_to_repo: "git@..."
        http_url_to_repo: "http://....git"
        web_url: "http://..."
        name_with_namespace: "User  / proj"
        namespace: {
        created_at: "2013-07-09T11:09:46Z"
        description: ""
        id: 3
        name: "Operator"
        owner_id: 4
        path: "operator"
        updated_at: "2013-07-09T11:09:46Z"
        }
       owner: {
       ...
        state: "active"
        ...
        }

Possible fixes:

  1. Update docs
  2. Generate REST API docs automatically (based on comments in code / grape DSL)
  3. Provide WADL descriptor