Skip to content

Official API vs python-gitlab api #2

Closed

Description

@dekimsey

The naming is somewhat inconsistent. This makes it difficult to read the official api and then use the console interface. I do not know if this affects the programmatic api.

Documentation:

Gets a user team project.

GET /user_teams/:id/projects/:project_id
Parameters:

id (required) - The ID of a user_team
project_id (required) - The ID of a user

API:

team-project get --id=ARG1 --team-id=ARG2
# id = the ID of a project
# team_id = the ID of a user_team

Should preferably be rewritten as:

team-project get --id=ARG2 --project-id=ARG1
# id = the ID of a user_team
# project_id = the ID of a project

Currently the use of --id appears to be hard-coded in the design. I'm not sure what would be the best way to change this.

Activity

  1. gpocentek commented on Jul 5, 2013

    @gpocentek
    Contributor

    Hello,

    This problem seems to be related to the teams API only, which hasn't been merged. It would be nice to fix the problem before the merge.

    Thanks.

  2. dekimsey commented on Jul 5, 2013

    @dekimsey
    ContributorAuthor

    Do you have recommendations on how to change this?

  3. gpocentek commented on Jul 7, 2013

    @gpocentek
    Contributor

    After an another look at the issue, I'd rather keep things like they are. It might be confusing if you look at the gitlab API documentation, sure, but I'm not sure that
    The idea for me was that if you want details about a 'project issue', the object you're looking for is the issue, not the project. So it seems (to me) logical to have an id associated with the issue, not with the project.

  4. added a commit that references this issue on Nov 10, 2016
  5. locked as resolved and limited conversation to collaborators on Dec 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions