diff options
Diffstat (limited to 'doc/api/epic_links.md')
| -rw-r--r-- | doc/api/epic_links.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/api/epic_links.md b/doc/api/epic_links.md index a368b806f75..319d1a1ee9b 100644 --- a/doc/api/epic_links.md +++ b/doc/api/epic_links.md @@ -1,7 +1,7 @@ --- stage: Plan group: Product Planning -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- # Epic Links API **(ULTIMATE)** @@ -12,10 +12,10 @@ Manages parent-child [epic relationships](../user/group/epics/index.md#multi-lev Every API call to `epic_links` must be authenticated. -If a user is not a member of a group and the group is private, a `GET` request on that group will result to a `404` status code. +If a user makes a `GET` request to a private group they are not a member of, the result is a `404` status code. Multi-level Epics are available only in GitLab [Ultimate/Gold](https://about.gitlab.com/pricing/). -If the Multi-level Epics feature is not available, a `403` status code will be returned. +If the Multi-level Epics feature is not available, a `403` status code is returned. ## List epics related to a given epic @@ -135,9 +135,9 @@ POST /groups/:id/epics/:epic_iid/epics | Attribute | Type | Required | Description | | --------------- | -------------- | -------- | ------------------------------------------------------------------------------------------------------------------ | | `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | -| `epic_iid` | integer | yes | The internal ID of the (future parent) epic. | -| `title` | string | yes | The title of a newly created epic. | -| `confidential` | boolean | no | Whether the epic should be confidential. Will be ignored if `confidential_epics` feature flag is disabled. Defaults to the confidentiality state of the parent epic. | +| `epic_iid` | integer | yes | The internal ID of the (future parent) epic. | +| `title` | string | yes | The title of a newly created epic. | +| `confidential` | boolean | no | Whether the epic should be confidential. Parameter is ignored if `confidential_epics` feature flag is disabled. Defaults to the confidentiality state of the parent epic. | ```shell curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/epics/5/epics?title=Newpic" |