Tentacat v0.7.2 Tentacat.Milestones
Summary
Functions
Create a milestone
Delete a milestone
Get a single milestone
List milestones
Update a milestone
Functions
Specs
create(binary, binary, list | map, Tentacat.Client.t) :: Tentacat.response
Create a milestone
Possible values for body
:
- ["title": "v1.0"]
- ["state": "open"]
- ["description": "Tracking milestone for version 1.0"]
- ["due_on": "2012-10-09T23:39:01Z"]
Example
Tentacat.Milestones.create "elixir-lang", "elixir", %{"title" => "Issue", "state" => "open"}
Tentacat.Milestones.create "elixir-lang", "elixir", %{"title" => "Issue", "state" => "closed"}, client
More info at: https://developer.github.com/v3/issues/milestones/#create-a-milestone
Specs
delete(binary, binary, binary | integer, Tentacat.Client.t) :: Tentacat.response
Delete a milestone
Example
Tentacat.Milestones.delete "elixir-lang", "elixir", "2974"
Tentacat.Milestones.delete "elixir-lang", "elixir", "2974", client
More info at: https://developer.github.com/v3/issues/milestones/#delete-a-milestone
Specs
find(binary, binary, binary | integer, Tentacat.Client.t) :: Tentacat.response
Get a single milestone
Example
Tentacat.Milestones.find "elixir-lang", "elixir", "2974"
Tentacat.Milestones.find "elixir-lang", "elixir", "2974", client
More info at: https://developer.github.com/v3/issues/milestones/#get-a-single-milestone
Specs
list(binary, binary, Tentacat.Client.t) :: Tentacat.response
List milestones
Example
Tentacat.Milestones.list "elixir-lang", "elixir"
Tentacat.Milestones.list "elixir-lang", "elixir", client
More info at: https://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository
Specs
update(binary, binary, binary | integer, list | map, Tentacat.Client.t) :: Tentacat.response
Update a milestone
Possible values for body
:
- ["title": "v1.0"]
- ["state": "open"]
- ["description": "Tracking milestone for version 1.0"]
- ["due_on": "2012-10-09T23:39:01Z"]
Example
Tentacat.Milestones.update "elixir-lang", "elixir", "2974", %{"title" => "edgurgel"}
Tentacat.Milestones.update "elixir-lang", "elixir", "2974", %{"state" => "closed"}, client
More info at: https://developer.github.com/v3/issues/milestones/#update-a-milestone