Skip to content

GitLab

  • Menu
Projects Groups Snippets
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • G gitlabhq1
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 21
    • Issues 21
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 12
    • Merge requests 12
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Packages & Registries
    • Packages & Registries
    • Package Registry
    • Infrastructure Registry
  • Analytics
    • Analytics
    • CI/CD
    • Repository
    • Value stream
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • gpt
  • large_projects
  • gitlabhq1
  • Issues
  • #4530

Closed
Open
Created 11 years ago by Administrator@rootOwner
  • New issue

  • Report abuse

  • New issue

  • Report abuse

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

  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

Linked issues
...

    Related merge requests

    • Administrator
      Administrator @root · 11 years ago
      Owner

      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)

    • Administrator
      Administrator @root · 11 years ago
      Owner

      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)

    • You're only seeing other activity in the feed. To add a comment, switch to one of the following options.
    Please register or sign in to reply
    0 Assignees
    Assign to
    Milestone
    No milestone
    None
    None
    Time tracking
    Due date
    None
    None
    3
    Labels
    API Awaiting developer action/feedback Documentation
    Assign labels
    • No matching results
    • Manage project labels
    Confidentiality
    Not confidential

    You are going to turn on confidentiality. Only team members with at least Reporter access will be able to see and leave comments on the issue.

    Lock issue
    Unlocked
    participants
    Reference: