group_milestones

Gets or lists a group_milestones resource.

Overview

Name	group_milestones
Type	Resource
Id	gitlab.groups.group_milestones

Fields

The following fields are returned by SELECT queries:

list

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
list	select	full_path, host	containing_date, include_ancestors, include_descendants, search_title, sort, state, title	Milestones of the group. Generated from the GitLab GraphQL schema field Group.milestones (connection of Milestone nodes).

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
full_path	string	Full path of the group, for example gitlab-org
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)
containing_date	string	Date the milestone contains.
include_ancestors	boolean	Include milestones from all parent groups.
include_descendants	boolean	Include milestones from all subgroups and subprojects.
search_title	string	Search string for the title.
sort	string	Sort milestones by the criteria.
state	string	Filter milestones by state.
title	string	Title of the milestone.

SELECT examples

list

Milestones of the group. Generated from the GitLab GraphQL schema field Group.milestones (connection of Milestone nodes).

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.groups.group_milestones
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
AND containing_date = '{{ containing_date }}'
AND include_ancestors = '{{ include_ancestors }}'
AND include_descendants = '{{ include_descendants }}'
AND search_title = '{{ search_title }}'
AND sort = '{{ sort }}'
AND state = '{{ state }}'
AND title = '{{ title }}'
;