module Octokit::Client::Issues
Overview
Methods for the Issues API
See Also:
Direct including types
Defined in:
octokit/client/issues.crConstant Summary
-
DIRECTIONS =
["asc", "desc"]
-
Valid directions in which to sort Issues
-
FILTERS =
["all", "assigned", "created", "mentioned", "subscribed"]
-
Valid filters for Issues
-
SORTS =
["created", "updated", "comments"]
-
Valid sort for Issues
-
STATES =
["all", "open", "closed"]
-
Valid states for Issues
Instance Method Summary
-
#add_assignees(repo, number : Int32, assignees : Array(String | User))
Add assignees to an issue.
-
#add_comment(repo, number : Int32, comment : String)
Get a single comment attached to an issue.
-
#close_issue(repo, number : Int32, **options)
Close an issue
-
#create_issue(repo, title, body, **options)
Create an issue for a repository.
-
#delete_comment(repo, number : Int32)
Delete a single comment.
-
#issue(repo, number : Int32)
Get a single issue from a repository
-
#issue_comment(repo, number : Int32)
Get a single comment attached to an issue.
-
#issue_comments(repo, number : Int32)
Get all comments attached to an issue.
-
#issue_timeline(repo, number : Int32)
Get the timeline for an issue.
-
#issues_comments(repo, number : Int32, **options)
Get all comments attached to issues for the repository.
-
#list_assignees(repo)
List the available assignees for issues in a repository.
-
#list_issues(repo = nil, **options)
List issues for the authenticated user or repository
-
#lock_issue(repo, number : Int32, **options)
Lock an issue's conversation, limiting it to collaborators
-
#org_issues(org, **options)
List all user issues for a given organization for the authenticated user.
-
#remove_assignees(repo, number : Int32, assignees : Array(String | User))
Remove assignees from an issue.
-
#reopen_issue(repo, number : Int32, **options)
Repoen an issue
-
#unlock_issue(repo, number : Int32, **options)
Unlock an issue's conversation, opening it to all viewers
-
#update_comment(repo, number : Int32, comment : String)
Update a single comment on an issue.
-
#update_issue(repo, number : Int32, **options)
Update an issue
-
#user_issues(**options)
List all user issues across owned and member repositories for the authenticated user.
Instance Method Detail
Add assignees to an issue.
See Also:
Examples:
Add assignees "watzon" and "asterite" to issue #4 on watzon/cadmium
Octokit.client.add_assignees("watzon/cadmium", 4, ["watzon", "asterite"])
Get a single comment attached to an issue.
See Also:
Examples:
Add a comment to issue #4 on watzon/cadmium
Octokit.client.add_comment("watzon/cadmium", 4, "Plenty of awesome")
Close an issue
See Also:
Example:
Close issue #4 from watzon/cadmium
@client.close_issue("watzon/cadmium", 4)
Create an issue for a repository.
See Also:
Example:
Create a new Issues for a repository
@client = Octokit::Client.new(login: "foo", password: "bar")
@client.create_issue("watzon/cadmium", "Not enough awesome", "You heard me.")
Delete a single comment.
See Also:
Examples:
Delete comment #495536069
Octokit.client.delete_comment("watzon/cadmium", 495536069)
Get a single issue from a repository
See Also:
Example:
Get issue #4 from watzon/cadmium
Octokit.client.issue("watzon/cadmium", 4)
Get a single comment attached to an issue.
See Also:
Examples:
Get comment #495536069 from an issue on watzon/cadmium
Octokit.client.issue_comment("watzon/cadmium", 495536069)
Get all comments attached to an issue.
See Also:
Examples:
Get the comments for issue #4 from watzon/cadmium
Octokit.client.issue_comments("watzon/cadmium", 4)
Get the timeline for an issue.
See Also:
Examples:
Get timeline for issue #4 on watzon/cadmium
Octokit.client.issue_timeline("watzon/cadmium", 4)
Get all comments attached to issues for the repository.
By default, Issue Comments are ordered by ascending ID.
See Also:
Examples:
Get the comments for issues in the cadmium repository
@client.issues_comments("watzon/cadmium")
Get issues comments, sort by updated descending since a time
@client.issues_comments("watzon/cadmium", sort: :desc, direction: :asc, since: "2010-05-04T23:45:02Z")
List the available assignees for issues in a repository.
See Also:
Examples:
Get avaialble assignees on repository watzon/cadmium
Octokit.client.list_assignees("watzon/cadmium")
List issues for the authenticated user or repository
See Also:
- https://developer.github.com/v3/issues/#list-issues-for-a-repository
- https://developer.github.com/v3/issues/#list-issues
Example:
List issues for a repository
Octokit.client.list_issues("watzon/cadmium")
List issues for the authenticated user across repositories
@client = Octokit::Client.new(login: "foo", password: "bar")
@client.list_issues
Lock an issue's conversation, limiting it to collaborators
See Also:
Example:
Lock issue #4 from watzon/cadmium
@client.lock_issue("watzon/cadmium", 4)
List all user issues for a given organization for the authenticated user.
See Also:
Example:
List all issues for a given organization for the authenticated user
@client = Octokit::Client.new(login: "foo", password: "bar")
@client.org_issues
Remove assignees from an issue.
See Also:
Examples:
Remove assignee "asterite" from issue #4 on watzon/cadmium
Octokit.client.remove_assignees("watzon/cadmium", 4, ["asterite"])
Repoen an issue
See Also:
Example:
Repoen issue #4 from watzon/cadmium
@client.reopen_issue("watzon/cadmium", 4)
Unlock an issue's conversation, opening it to all viewers
See Also:
Example:
Lock issue #4 from watzon/cadmium
@client.unlock_issue("watzon/cadmium", 4)
Update a single comment on an issue.
See Also:
Examples:
Update comment #495536069
Octokit.client.update_comment("watzon/cadmium", 495536069, "Plenty of awesome!")
Update an issue
See Also:
Examples:
Change the title of issue #4
@client.update_issue("watzon/cadmium", 4, title: "New title")
Change only the assignee of issue #4
@client.update_issue("watzon/cadmium", 4, assignee: "watzon")
List all user issues across owned and member repositories for the authenticated user.
See Also:
Example:
List issues for the authenticated user across owned and member repositories.
@client = Octokit::Client.new(login: "foo", password: "bar")
@client.user_issues