Response snippets in the API Documentation are not up-to-date
Closed
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
- Request "projects endpoint" /api/v3/projects?private_token=youToken using any REST client
- Open help/api/projects doc page
- 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:
- Update docs
- Generate REST API docs automatically (based on comments in code / grape DSL)
- Provide WADL descriptor
Created by: dblessing
Hi @evra. Can you please elaborate more on what you're seeing? Provide screenshots or links to specific locations. Please adapt your issue report to match the Contribution Guidelines as appropriate. Thanks.
By Administrator on 2013-07-11T16:16:50 (imported from GitLab project)
Created by: jvanbaarsen
It's been at least 2 weeks (and a new release) since we heard from you. I'm closing this issue but if you still experience this problem, please open a new issue (but also reference the old issue(s)). Make sure to also include the necessary debugging information conforming to the issue tracker guidelines found in our contributing guidelines. /cc @Razer6
By Administrator on 2013-12-16T19:55:01 (imported from GitLab project)