View Source GitHub.Issues (GitHub REST API Client v0.0.13)
Provides API endpoints related to issues
Link to this section Summary
Functions
Add assignees to an issue
Add labels to an issue
Check if a user can be assigned
Check if a user can be assigned to a issue
Create an issue
Create an issue comment
Create a label
Create a milestone
Delete an issue comment
Delete a label
Delete a milestone
Get an issue
Get an issue comment
Get an issue event
Get a label
Get a milestone
List issues assigned to the authenticated user
List assignees
List issue comments
List issue comments for a repository
List issue events
List issue events for a repository
List timeline events for an issue
List user account issues assigned to the authenticated user
List organization issues assigned to the authenticated user
List repository issues
List labels for issues in a milestone
List labels for a repository
List labels for an issue
List milestones
Lock an issue
Remove all labels from an issue
Remove assignees from an issue
Remove a label from an issue
Set labels for an issue
Unlock an issue
Update an issue
Update an issue comment
Update a label
Update a milestone
Link to this section Functions
@spec add_assignees(String.t(), String.t(), integer(), map(), keyword()) :: {:ok, GitHub.Issue.t()} | {:error, GitHub.Error.t()}
Add assignees to an issue
resources
Resources
@spec add_labels( String.t(), String.t(), integer(), map() | String.t() | [map()] | [String.t()], keyword() ) :: {:ok, [GitHub.Label.t()]} | {:error, GitHub.Error.t()}
Add labels to an issue
resources
Resources
@spec check_user_can_be_assigned(String.t(), String.t(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Check if a user can be assigned
resources
Resources
check_user_can_be_assigned_to_issue(owner, repo, issue_number, assignee, opts \\ [])
View Source@spec check_user_can_be_assigned_to_issue( String.t(), String.t(), integer(), String.t(), keyword() ) :: :ok | {:error, GitHub.Error.t()}
Check if a user can be assigned to a issue
resources
Resources
@spec create(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Issue.t()} | {:error, GitHub.Error.t()}
Create an issue
resources
Resources
@spec create_comment(String.t(), String.t(), integer(), map(), keyword()) :: {:ok, GitHub.Issue.Comment.t()} | {:error, GitHub.Error.t()}
Create an issue comment
resources
Resources
@spec create_label(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Label.t()} | {:error, GitHub.Error.t()}
Create a label
resources
Resources
@spec create_milestone(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Milestone.t()} | {:error, GitHub.Error.t()}
Create a milestone
resources
Resources
@spec delete_comment(String.t(), String.t(), integer(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Delete an issue comment
resources
Resources
@spec delete_label(String.t(), String.t(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Delete a label
resources
Resources
@spec delete_milestone(String.t(), String.t(), integer(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Delete a milestone
resources
Resources
@spec get(String.t(), String.t(), integer(), keyword()) :: {:ok, GitHub.Issue.t()} | {:error, GitHub.Error.t()}
Get an issue
resources
Resources
@spec get_comment(String.t(), String.t(), integer(), keyword()) :: {:ok, GitHub.Issue.Comment.t()} | {:error, GitHub.Error.t()}
Get an issue comment
resources
Resources
@spec get_event(String.t(), String.t(), integer(), keyword()) :: {:ok, GitHub.Issue.Event.t()} | {:error, GitHub.Error.t()}
Get an issue event
resources
Resources
@spec get_label(String.t(), String.t(), String.t(), keyword()) :: {:ok, GitHub.Label.t()} | {:error, GitHub.Error.t()}
Get a label
resources
Resources
@spec get_milestone(String.t(), String.t(), integer(), keyword()) :: {:ok, GitHub.Milestone.t()} | {:error, GitHub.Error.t()}
Get a milestone
resources
Resources
@spec list(keyword()) :: {:ok, [GitHub.Issue.t()]} | {:error, GitHub.Error.t()}
List issues assigned to the authenticated user
options
Options
filter
(String.t()): Indicates which sorts of issues to return.assigned
means issues assigned to you.created
means issues created by you.mentioned
means issues mentioning you.subscribed
means issues you're subscribed to updates for.all
orrepos
means all issues you can see, regardless of participation or creation.state
(String.t()): Indicates the state of the issues to return.labels
(String.t()): A list of comma separated label names. Example:bug,ui,@high
sort
(String.t()): What to sort results by.direction
(String.t()): The direction to sort the results by.since
(String.t()): Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format:YYYY-MM-DDTHH:MM:SSZ
.collab
(boolean):orgs
(boolean):owned
(boolean):pulls
(boolean):per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_assignees(String.t(), String.t(), keyword()) :: {:ok, [GitHub.User.simple()]} | {:error, GitHub.Error.t()}
List assignees
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_comments(String.t(), String.t(), integer(), keyword()) :: {:ok, [GitHub.Issue.Comment.t()]} | {:error, GitHub.Error.t()}
List issue comments
options
Options
since
(String.t()): Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format:YYYY-MM-DDTHH:MM:SSZ
.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_comments_for_repo(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Issue.Comment.t()]} | {:error, GitHub.Error.t()}
List issue comments for a repository
options
Options
sort
(String.t()): The property to sort the results by.direction
(String.t()): Eitherasc
ordesc
. Ignored without thesort
parameter.since
(String.t()): Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format:YYYY-MM-DDTHH:MM:SSZ
.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_events(String.t(), String.t(), integer(), keyword()) :: {:ok, [ GitHub.AddedToProjectIssueEvent.t() | GitHub.AssignedIssueEvent.t() | GitHub.ConvertedNoteToIssueIssueEvent.t() | GitHub.DemilestonedIssueEvent.t() | GitHub.LabeledIssueEvent.t() | GitHub.LockedIssueEvent.t() | GitHub.MilestonedIssueEvent.t() | GitHub.MovedColumnInProjectIssueEvent.t() | GitHub.RemovedFromProjectIssueEvent.t() | GitHub.RenamedIssueEvent.t() | GitHub.ReviewDismissedIssueEvent.t() | GitHub.ReviewRequestRemovedIssueEvent.t() | GitHub.ReviewRequestedIssueEvent.t() | GitHub.UnassignedIssueEvent.t() | GitHub.UnlabeledIssueEvent.t() ]} | {:error, GitHub.Error.t()}
List issue events
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_events_for_repo(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Issue.Event.t()]} | {:error, GitHub.Error.t()}
List issue events for a repository
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_events_for_timeline(String.t(), String.t(), integer(), keyword()) :: {:ok, [ GitHub.AddedToProjectIssueEvent.t() | GitHub.ConvertedNoteToIssueIssueEvent.t() | GitHub.DemilestonedIssueEvent.t() | GitHub.LabeledIssueEvent.t() | GitHub.LockedIssueEvent.t() | GitHub.MilestonedIssueEvent.t() | GitHub.MovedColumnInProjectIssueEvent.t() | GitHub.RemovedFromProjectIssueEvent.t() | GitHub.RenamedIssueEvent.t() | GitHub.ReviewDismissedIssueEvent.t() | GitHub.ReviewRequestRemovedIssueEvent.t() | GitHub.ReviewRequestedIssueEvent.t() | GitHub.StateChangeIssueEvent.t() | GitHub.Timeline.AssignedIssueEvent.t() | GitHub.Timeline.CommentEvent.t() | GitHub.Timeline.CommitCommentedEvent.t() | GitHub.Timeline.CommittedEvent.t() | GitHub.Timeline.CrossReferencedEvent.t() | GitHub.Timeline.LineCommentedEvent.t() | GitHub.Timeline.ReviewedEvent.t() | GitHub.Timeline.UnassignedIssueEvent.t() | GitHub.UnlabeledIssueEvent.t() ]} | {:error, GitHub.Error.t()}
List timeline events for an issue
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_for_authenticated_user(keyword()) :: {:ok, [GitHub.Issue.t()]} | {:error, GitHub.Error.t()}
List user account issues assigned to the authenticated user
options
Options
filter
(String.t()): Indicates which sorts of issues to return.assigned
means issues assigned to you.created
means issues created by you.mentioned
means issues mentioning you.subscribed
means issues you're subscribed to updates for.all
orrepos
means all issues you can see, regardless of participation or creation.state
(String.t()): Indicates the state of the issues to return.labels
(String.t()): A list of comma separated label names. Example:bug,ui,@high
sort
(String.t()): What to sort results by.direction
(String.t()): The direction to sort the results by.since
(String.t()): Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format:YYYY-MM-DDTHH:MM:SSZ
.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_for_org( String.t(), keyword() ) :: {:ok, [GitHub.Issue.t()]} | {:error, GitHub.Error.t()}
List organization issues assigned to the authenticated user
options
Options
filter
(String.t()): Indicates which sorts of issues to return.assigned
means issues assigned to you.created
means issues created by you.mentioned
means issues mentioning you.subscribed
means issues you're subscribed to updates for.all
orrepos
means all issues you can see, regardless of participation or creation.state
(String.t()): Indicates the state of the issues to return.labels
(String.t()): A list of comma separated label names. Example:bug,ui,@high
sort
(String.t()): What to sort results by.direction
(String.t()): The direction to sort the results by.since
(String.t()): Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format:YYYY-MM-DDTHH:MM:SSZ
.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_for_repo(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Issue.t()]} | {:error, GitHub.Error.t()}
List repository issues
options
Options
milestone
(String.t()): If aninteger
is passed, it should refer to a milestone by itsnumber
field. If the string*
is passed, issues with any milestone are accepted. If the stringnone
is passed, issues without milestones are returned.state
(String.t()): Indicates the state of the issues to return.assignee
(String.t()): Can be the name of a user. Pass innone
for issues with no assigned user, and*
for issues assigned to any user.creator
(String.t()): The user that created the issue.mentioned
(String.t()): A user that's mentioned in the issue.labels
(String.t()): A list of comma separated label names. Example:bug,ui,@high
sort
(String.t()): What to sort results by.direction
(String.t()): The direction to sort the results by.since
(String.t()): Only show results that were last updated after the given time. This is a timestamp in ISO 8601 format:YYYY-MM-DDTHH:MM:SSZ
.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
list_labels_for_milestone(owner, repo, milestone_number, opts \\ [])
View Source@spec list_labels_for_milestone(String.t(), String.t(), integer(), keyword()) :: {:ok, [GitHub.Label.t()]} | {:error, GitHub.Error.t()}
List labels for issues in a milestone
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_labels_for_repo(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Label.t()]} | {:error, GitHub.Error.t()}
List labels for a repository
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_labels_on_issue(String.t(), String.t(), integer(), keyword()) :: {:ok, [GitHub.Label.t()]} | {:error, GitHub.Error.t()}
List labels for an issue
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_milestones(String.t(), String.t(), keyword()) :: {:ok, [GitHub.Milestone.t()]} | {:error, GitHub.Error.t()}
List milestones
options
Options
state
(String.t()): The state of the milestone. Eitheropen
,closed
, orall
.sort
(String.t()): What to sort results by. Eitherdue_on
orcompleteness
.direction
(String.t()): The direction of the sort. Eitherasc
ordesc
.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec lock(String.t(), String.t(), integer(), map() | nil, keyword()) :: :ok | {:error, GitHub.Error.t()}
Lock an issue
resources
Resources
@spec remove_all_labels(String.t(), String.t(), integer(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Remove all labels from an issue
resources
Resources
@spec remove_assignees(String.t(), String.t(), integer(), map(), keyword()) :: {:ok, GitHub.Issue.t()} | {:error, GitHub.Error.t()}
Remove assignees from an issue
resources
Resources
@spec remove_label(String.t(), String.t(), integer(), String.t(), keyword()) :: {:ok, [GitHub.Label.t()]} | {:error, GitHub.Error.t()}
Remove a label from an issue
resources
Resources
@spec set_labels( String.t(), String.t(), integer(), map() | String.t() | [map()] | [String.t()], keyword() ) :: {:ok, [GitHub.Label.t()]} | {:error, GitHub.Error.t()}
Set labels for an issue
resources
Resources
@spec unlock(String.t(), String.t(), integer(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Unlock an issue
resources
Resources
@spec update(String.t(), String.t(), integer(), map(), keyword()) :: {:ok, GitHub.Issue.t()} | {:error, GitHub.Error.t()}
Update an issue
resources
Resources
@spec update_comment(String.t(), String.t(), integer(), map(), keyword()) :: {:ok, GitHub.Issue.Comment.t()} | {:error, GitHub.Error.t()}
Update an issue comment
resources
Resources
@spec update_label(String.t(), String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Label.t()} | {:error, GitHub.Error.t()}
Update a label
resources
Resources
@spec update_milestone(String.t(), String.t(), integer(), map(), keyword()) :: {:ok, GitHub.Milestone.t()} | {:error, GitHub.Error.t()}
Update a milestone