Commit 7506b083 authored by Evan Read's avatar Evan Read

Merge branch '344646-remove-epic-support-from-events-api-documentation' into 'master'

Clarify special behavior of Epic-originated Events

See merge request gitlab-org/gitlab!73544
parents 10da9f9f f934bd2d
......@@ -8,55 +8,9 @@ info: To determine the technical writer assigned to the Stage/Group associated w
## Filter parameters
### Action Types
Available types for the `action` parameter, and the resources that might be affected:
- `approved`
- Merge request
- `closed`
- Epic **(PREMIUM)**
- Issue
- Merge request
- Milestone
- `commented` on any `Noteable` record.
- Alert
- Commit
- Design
- Issue
- Merge request
- Snippet
- `created`
- Design
- Epic **(PREMIUM)**
- Issue
- Merge request
- Milestone
- Project
- Wiki page
- `destroyed`
- Design
- Milestone
- Wiki page
- `expired`
- Project membership
- `joined`
- Project membership
- `left`
- Project membership
- `merged`
- Merge request
- `pushed` commits to (or deleted commits from) a repository, individually or in bulk.
- Project
- `reopened`
- Epic **(PREMIUM)**
- Issue
- Merge request
- Milestone
- `updated`
- Design
- Wiki page
### Actions
See [User contribution events](../user/index.md#user-contribution-events) for available types for the `action` parameter.
These options are in lowercase.
### Target Types
......@@ -72,6 +26,7 @@ Available target types for the `target_type` parameter are:
- `user`
These options are in lowercase.
Events associated with epics are not available using the API.
### Date formatting
......@@ -88,6 +43,7 @@ GitLab removes events older than 3 years from the events table for performance r
## List currently authenticated user's events
Get a list of events for the authenticated user. Scope `read_user` or `api` is required.
Events associated with epics are not available using the API.
```plaintext
GET /events
......@@ -97,7 +53,7 @@ Parameters:
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `action` | string | no | Include only events of a particular [action type](#action-types) |
| `action` | string | no | Include only events of a particular [action type](#actions) |
| `target_type` | string | no | Include only events of a particular [target type](#target-types) |
| `before` | date | no | Include only events created before a particular date. [View how to format dates](#date-formatting). |
| `after` | date | no | Include only events created after a particular date. [View how to format dates](#date-formatting). |
......@@ -160,6 +116,7 @@ Example response:
### Get user contribution events
Get the contribution events for the specified user, sorted from newest to oldest. Scope `read_user` or `api` is required.
Events associated with epics are not available using API.
```plaintext
GET /users/:id/events
......@@ -170,7 +127,7 @@ Parameters:
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer | yes | The ID or Username of the user |
| `action` | string | no | Include only events of a particular [action type](#action-types) |
| `action` | string | no | Include only events of a particular [action type](#actions) |
| `target_type` | string | no | Include only events of a particular [target type](#target-types) |
| `before` | date | no | Include only events created before a particular date. [View how to format dates](#date-formatting). |
| `after` | date | no | Include only events created after a particular date. [View how to format dates](#date-formatting). |
......@@ -308,7 +265,7 @@ Parameters:
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `project_id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) |
| `action` | string | no | Include only events of a particular [action type](#action-types) |
| `action` | string | no | Include only events of a particular [action type](#actions) |
| `target_type` | string | no | Include only events of a particular [target type](#target-types) |
| `before` | date | no | Include only events created before a particular date. [View how to format dates](#date-formatting). |
| `after` | date | no | Include only events created after a particular date. [View how to format dates](#date-formatting). |
......
......@@ -8,7 +8,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/3090) in GitLab 12.2 for subgroups.
With Contribution Analytics you can get an overview of the [contribution actions](../../../api/events.md#action-types) in your
With Contribution Analytics, you can get an overview of the [contribution events](../../index.md#user-contribution-events) in your
group.
- Analyze your team's contributions over a period of time, and offer a bonus for the top
......
......@@ -85,6 +85,7 @@ There are several types of users in GitLab:
## User activity
GitLab tracks user contribution activity.
You can follow or unfollow other users from their [user profiles](profile/index.md#access-your-user-profile).
To view a user's activity in a top-level Activity view:
......@@ -92,6 +93,55 @@ To view a user's activity in a top-level Activity view:
1. In the GitLab menu, select **Activity**.
1. Select the **Followed users** tab.
### User contribution events
Each of these contribution events is tracked:
- `approved`
- Merge request
- `closed`
- [Epic](group/epics/index.md)
- Issue
- Merge request
- Milestone
- `commented` on any `Noteable` record.
- Alert
- Commit
- Design
- Issue
- Merge request
- Snippet
- `created`
- Design
- [Epic](group/epics/index.md)
- Issue
- Merge request
- Milestone
- Project
- Wiki page
- `destroyed`
- Design
- Milestone
- Wiki page
- `expired`
- Project membership
- `joined`
- Project membership
- `left`
- Project membership
- `merged`
- Merge request
- `pushed` commits to (or deleted commits from) a repository, individually or in bulk.
- Project
- `reopened`
- [Epic](group/epics/index.md)
- Issue
- Merge request
- Milestone
- `updated`
- Design
- Wiki page
## Projects
In GitLab, you can create [projects](project/index.md) to host
......
......@@ -129,7 +129,7 @@ To add links to other accounts:
## Show private contributions on your user profile page
In the user contribution calendar graph and recent activity list, you can see your [contribution actions](../../api/events.md#action-types) to private projects.
In the user contribution calendar graph and recent activity list, you can see your [contribution actions](../index.md#user-contribution-events) to private projects.
To show private contributions:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment