milestone
Gets or lists a milestone resource.
Overview​
| Name | milestone |
| Type | Resource |
| Id | gitlab.projects.milestone |
Fields​
The following fields are returned by SELECT queries:
- get
GraphQL response envelope
| Name | Datatype | Description |
|---|---|---|
id | string | ID of the milestone. |
created_at | string | Timestamp of milestone creation. |
description | string | Description of the milestone. |
due_date | string | Timestamp of the milestone due date. |
expired | boolean | Expired state of the milestone (a milestone is expired when the due date is past the current date). Defaults to false when due date has not been set. |
group_ | object | Group identity (id, full_path, name) |
group_milestone | boolean | Indicates if milestone is at group level. |
iid | string | Internal ID of the milestone. |
project | object | Project identity (id, full_path, name) |
project_milestone | boolean | Indicates if milestone is at project level. |
start_date | string | Timestamp of the milestone start date. |
state | string | State of the milestone. (active, closed) |
subgroup_milestone | boolean | Indicates if milestone is at subgroup level. |
title | string | Title of the milestone. |
upcoming | boolean | Upcoming state of the milestone (a milestone is upcoming when the start date is in the future). Defaults to false when start date has not been set. |
updated_at | string | Timestamp of last milestone update. |
web_path | string | Web path of the milestone. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | id, host | Find a milestone. Generated from the GitLab GraphQL schema field Query.milestone (Milestone). |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
host | string | GitLab host, with an optional port (default gitlab.com). Resolved from the GITLAB_HOST environment variable when it is set (x-stackQL-envVar); a WHERE host value always takes precedence. Self-managed instances: the provider is generated from the gitlab.com schema, so older instances may reject fields they do not serve. (default: gitlab.com, x-stackQL-envVar: GITLAB_HOST) |
id | string | Find a milestone by its ID. |
SELECT examples​
- get
Find a milestone. Generated from the GitLab GraphQL schema field Query.milestone (Milestone).
SELECT
id,
created_at,
description,
due_date,
expired,
group_,
group_milestone,
iid,
project,
project_milestone,
start_date,
state,
subgroup_milestone,
title,
upcoming,
updated_at,
web_path
FROM gitlab.projects.milestone
WHERE id = '{{ id }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
;