milestones

Creates, updates, deletes, gets or lists a milestones resource.

Overview

Name	milestones
Type	Resource
Id	github.issues.milestones

Fields

The following fields are returned by SELECT queries:

get_milestone

Response

Name	Datatype	Description
id	integer
node_id	string	(example: MDk6TWlsZXN0b25lMTAwMjYwNA==)
closed_at	string (date-time)	(example: 2013-02-12T13:22:01Z)
closed_issues	integer
created_at	string (date-time)	(example: 2011-04-10T20:09:31Z)
creator	object	A GitHub user. (title: Simple User)
description	string	(example: Tracking milestone for version 1.0)
due_on	string (date-time)	(example: 2012-10-09T23:39:01Z)
html_url	string (uri)	(example: https://github.com/octocat/Hello-World/milestones/v1.0)
labels_url	string (uri)	(example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels)
number	integer	The number of the milestone.
open_issues	integer
state	string	The state of the milestone. (open, closed) (example: open, default: open)
title	string	The title of the milestone. (example: v1.0)
updated_at	string (date-time)	(example: 2014-03-03T18:58:10Z)
url	string (uri)	(example: https://api.github.com/repos/octocat/Hello-World/milestones/1)

list_milestones

Response

Name	Datatype	Description
id	integer
node_id	string	(example: MDk6TWlsZXN0b25lMTAwMjYwNA==)
closed_at	string (date-time)	(example: 2013-02-12T13:22:01Z)
closed_issues	integer
created_at	string (date-time)	(example: 2011-04-10T20:09:31Z)
creator	object	A GitHub user. (title: Simple User)
description	string	(example: Tracking milestone for version 1.0)
due_on	string (date-time)	(example: 2012-10-09T23:39:01Z)
html_url	string (uri)	(example: https://github.com/octocat/Hello-World/milestones/v1.0)
labels_url	string (uri)	(example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels)
number	integer	The number of the milestone.
open_issues	integer
state	string	The state of the milestone. (open, closed) (example: open, default: open)
title	string	The title of the milestone. (example: v1.0)
updated_at	string (date-time)	(example: 2014-03-03T18:58:10Z)
url	string (uri)	(example: https://api.github.com/repos/octocat/Hello-World/milestones/1)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_milestone	select	owner, repo, milestone_number		Gets a milestone using the given milestone number.
list_milestones	select	owner, repo	state, sort, direction, per_page, page	Lists milestones for a repository.
create_milestone	insert	owner, repo, title		Creates a milestone.
update_milestone	update	owner, repo, milestone_number
delete_milestone	delete	owner, repo, milestone_number		Deletes a milestone using the given milestone number.

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
milestone_number	integer	The number that identifies the milestone.
owner	string	The account owner of the repository. The name is not case sensitive.
repo	string	The name of the repository without the .git extension. The name is not case sensitive.
direction	string	The direction of the sort. Either asc or desc.
page	integer	The page number of the results to fetch. For more information, see "Using pagination in the REST API."
per_page	integer	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
sort	string	What to sort results by. Either due_on or completeness.
state	string	The state of the milestone. Either open, closed, or all.

SELECT examples

get_milestone

Gets a milestone using the given milestone number.

SELECT
id,
node_id,
closed_at,
closed_issues,
created_at,
creator,
description,
due_on,
html_url,
labels_url,
number,
open_issues,
state,
title,
updated_at,
url
FROM github.issues.milestones
WHERE owner = '{{ owner }}' -- required
AND repo = '{{ repo }}' -- required
AND milestone_number = '{{ milestone_number }}' -- required
;

list_milestones

Lists milestones for a repository.

SELECT
id,
node_id,
closed_at,
closed_issues,
created_at,
creator,
description,
due_on,
html_url,
labels_url,
number,
open_issues,
state,
title,
updated_at,
url
FROM github.issues.milestones
WHERE owner = '{{ owner }}' -- required
AND repo = '{{ repo }}' -- required
AND state = '{{ state }}'
AND sort = '{{ sort }}'
AND direction = '{{ direction }}'
AND per_page = '{{ per_page }}'
AND page = '{{ page }}'
;

INSERT examples

create_milestone

Creates a milestone.

INSERT INTO github.issues.milestones (
title,
state,
description,
due_on,
owner,
repo
)
SELECT 
'{{ title }}' /* required */,
'{{ state }}',
'{{ description }}',
'{{ due_on }}',
'{{ owner }}',
'{{ repo }}'
RETURNING
id,
node_id,
closed_at,
closed_issues,
created_at,
creator,
description,
due_on,
html_url,
labels_url,
number,
open_issues,
state,
title,
updated_at,
url
;

Manifest

# Description fields are for documentation purposes
- name: milestones
props:
  - name: owner
    value: "{{ owner }}"
    description: Required parameter for the milestones resource.
  - name: repo
    value: "{{ repo }}"
    description: Required parameter for the milestones resource.
  - name: title
    value: "{{ title }}"
    description: |
      The title of the milestone.
  - name: state
    value: "{{ state }}"
    description: |
      The state of the milestone. Either `open` or `closed`.
    valid_values: ['open', 'closed']
    default: open
  - name: description
    value: "{{ description }}"
    description: |
      A description of the milestone.
  - name: due_on
    value: "{{ due_on }}"
    description: |
      The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.

UPDATE examples

update_milestone

No description available.

UPDATE github.issues.milestones
SET 
title = '{{ title }}',
state = '{{ state }}',
description = '{{ description }}',
due_on = '{{ due_on }}'
WHERE 
owner = '{{ owner }}' --required
AND repo = '{{ repo }}' --required
AND milestone_number = '{{ milestone_number }}' --required
RETURNING
id,
node_id,
closed_at,
closed_issues,
created_at,
creator,
description,
due_on,
html_url,
labels_url,
number,
open_issues,
state,
title,
updated_at,
url;

DELETE examples

delete_milestone

Deletes a milestone using the given milestone number.

DELETE FROM github.issues.milestones
WHERE owner = '{{ owner }}' --required
AND repo = '{{ repo }}' --required
AND milestone_number = '{{ milestone_number }}' --required
;