Skip to content
Snippets Groups Projects
New issue look: Off

Feature Request: Documentation for the Event API for GitLab

    • Closed (moved) Issue created by username-removed-268956 @matthew.wilkinson

    Dear GitLab team :)

    When using the project events API I found there was no documentation for the specific events that can happen. I had to manually go through lots projects to find the various events that can be raised.

    I also found there were differences between GitLab 7x and 8x. I'm happy to share the information I have, but I don't think it's complete!

    Many thanks

    Matt

    Designs

    Child items ...

    • Activity

    • username-removed-152826
      username-removed-152826 @ben.boeckel ·
      Contributor

      This is one thing we had to track down from release to release as well. The main differences I'm aware of are the ones I added and the NoteEvent addition at some point along the line.

    • Sid Sijbrandij
      Sid Sijbrandij @sytses ·
      Owner

      @matthew.wilkinson If you can share the information you have (preferably in the form of a merge request) that would be great!

    • username-removed-268956
      username-removed-268956 @matthew.wilkinson ·
      Author Guest

      Ok :) I'm just having a few days holiday, I'll make a MR on Monday Sid!

    • username-removed-268956
      username-removed-268956 @matthew.wilkinson ·
      Author Guest

      author_id

      The user responsible for the event.

      author_id is always an Int

      action_name

      The type of action that is happening.

      action_name is always a String.

      • opened
        • Where target_type is equal to "Issue". Indicates a user opened an issue. The issue title can be found with the "target_title" property.
        • Where target_type is equal to "MergeRequest". Indicates a user opened a merge request. The merge request title can be found with the "target_title" property.
        • Where target_type is equal to "Milestone". Indicates a user opened a milestone. The milestone title can be found with the "target_title" property.
      • closed
        • Where target_type is equal to "Issue". Indicates a user closed an issue. The issue title can be found with the "target_title" property.
        • Where target_type is equal to "MergeRequest". Indicates a user closed a merge request. The merge request title can be found with the "target_title" property.
        • Where target_type is equal to "Milestone". Indicates a user closed a milestone. The milestone title can be found with the "target_title" property.
      • created
        • The project was created.
      • imported
        • The project was imported from GitHub (etc).
      • commented on
        • Where target_type is equal to "Note". Indicates a user commented on something (an Issue, or a Merge Request). The details of the comment can be found with the "target_id" property, which is the Id of the Note. Using the Issues comments API you can find the corresponding Issue / Note / Comment text.
      • destroyed
        • Where target_type is equal to "Milestone". Indicates a user destroyed a milestone. The milestone title can be found with the "target_title" property.
      • accepted
        • Where target_type is equal to "Milestone". Indicates a user accepted a milestone. The milestone title can be found with the "target_title" property.
      • joined
        • The author of the event has joined the project.

      The following are supported on GitLab 8x

      • pushed_new
        • Indicates user is pushing a new branch. The new branch name can be found in data["ref"].
      • pushed_to
        • Indicates user is pushing to an existing branch. The branch name can be found in data["ref"].
      • deleted
        • Indicates user is deleting a branch. The branch name can be found in data["ref"].

      The following are supported on GitLab 7x (but not GitLab 8x)

      • opened
        • Where target_type is nil. Indicates a user pushed to a branch or created a new branch. If the data["before"] is equal to "00000000" then the user created a new branch. Otherwise, the user was pushing to an existing branch.
        • Where target_type is equal to "Note". This is equivalent to GitLab 8x action_name = "commented on".
      • closed
        • Where target_type is nil. Indicates a user is deleting a branch. This can confirmed by looking at the data["after"] and should be equal to "00000000".

      data

      This is a transformable object, and can indicate more information about certain actions. See action_name for examples that use the data value.

      data is optionally [String : AnyObject]

      created_at

      This is the date the event was created, the date format ISO8601.

      created_at is always a String

    • username-removed-268956
      username-removed-268956 @matthew.wilkinson ·
      Author Guest

      hey Sid, I'd like to create a Merge Request, but not sure how to do it. I can find the right file to modify in the API docs, but do I need permissions to create a merge request?

    • username-removed-268956 Status changed to closed

      Status changed to closed

    • username-removed-268956 Status changed to reopened

      Status changed to reopened

    • username-removed-268956
      username-removed-268956 @matthew.wilkinson ·
      Author Guest

      Oops!

    • Sid Sijbrandij
      Sid Sijbrandij @sytses ·
      Owner

      @dzaporozhets can you have a look?

    • username-removed-444
      username-removed-444 @dzaporozhets ·
      Owner

      Hi @matthew.wilkinson

      You can fork the project and make changes to API docs in your fork. Then submit merge requests to our project and mention me

    • username-removed-386624 Added ~13884 label

      Added ~13884 label

    • username-removed-152826
      username-removed-152826 @ben.boeckel ·
      Contributor

      I think this is now basically a duplicate of #20387 (moved).

    • username-removed-419655
      username-removed-419655 @markglenfletcher1 ·
      Developer

      This still seems relevant. I think that the Events API documentation could include a section to add some further information about the properties here.

      Opening this for a Community Contribution with Accepting Merge Requests

    • username-removed-419655 added Accepting Merge Requests Documentation docs-write feature proposal labels

      added Accepting Merge Requests Documentation docs-write feature proposal labels

    • Felipe Artur moved to gitlab#3935 (closed)

      moved to gitlab#3935 (closed)

    • Felipe Artur
      Felipe Artur @felipe_artur ·
      Maintainer

      Hey! :wave:

      GitLab is moving all development for both GitLab Community Edition and Enterprise Edition into a single codebase. The current gitlab-ce repository will become a read-only mirror, without any proprietary code. All development is moved to the current gitlab-ee repository, which we will rename to just gitlab in the coming weeks. As part of this migration, issues will be moved to the current gitlab-ee project.

      If you have any questions about all of this, please ask them in our dedicated FAQ issue.

      https://gitlab.com/gitlab-org/gitlab-ee/issues/13855

      You can also find more information here:

      Frequently Asked Questions

      For an up to date list of questions and answers, please take a look at https://gitlab.com/gitlab-org/gitlab-ee/issues/13855

      What will we do with the repository names?

      https://gitlab.com/gitlab-org/gitlab-ee/ will become https://gitlab.com/gitlab-org/gitlab, and https://gitlab.com/gitlab-org/gitlab-ce will become https://gitlab.com/gitlab-org/gitlab-foss.

      Why rename gitlab-ce to gitlab-foss?

      Using "gitlab" and "gitlab-ce" would be confusing, so we decided to rename gitlab-ce to gitlab-foss to make the purpose of this FOSS repository more clear

      I created a merge requests for CE, and this got closed. What do I need to do?

      You will need to create a merge request at https://gitlab.com/gitlab-org/gitlab-ee/. This link will eventually redirect to https://gitlab.com/gitlab-org/gitlab.

      How does the licensing work in this new setup?

      Everything in the ee/ directory is proprietary. Everything else is free and open source software. If your merge request does not change anything in the ee/ directory, the process of contributing changes is the same as when using the gitlab-ce repository.

      Will you accept merge requests on the gitlab-ce/gitlab-foss project after it has been renamed?

      No. Merge requests submitted to this project will be closed automatically.

      Will I still be able to view old issues and merge requests in gitlab-ce/gitlab-foss?

      Yes.

      How will this affect users of GitLab CE using Omnibus?

      No changes will be necessary, as the packages built remain the same.

      How will this affect users of GitLab CE that build from source?

      Once the project has been renamed, you will need to change your Git remotes to use this new URL. GitLab will take care of redirecting Git operations so there is no hard deadline, but we recommend doing this as soon as the projects have been renamed.

      Where can I see a timeline of the remaining steps?

      https://gitlab.com/gitlab-org/gitlab-ee/issues/13304

      Will community contributions submitted to the new "gitlab" repository be available in the new gitlab-foss repository?

      Yes, these changes will be synced to gitlab-foss automatically, several times per day.

    • Felipe Artur locked this issue

      locked this issue

    • Nikola Milojevic mentioned in merge request !14785

      mentioned in merge request !14785

    Please register or sign in to reply