IssuesInterpreter
Attributes
- Graph
- Supertypes
Members list
Value members
Concrete methods
Add the specified labels to an Issue
Add the specified labels to an Issue
Attributes
- headers
optional user headers to include in the request
- labels
the list of labels to add to the issue
- number
Issue number
- owner
of the repo
- repo
name of the repo
- Returns:
a GHResponse with the list of labels added to the Issue.
- Definition Classes
Create a comment
Create a comment
Attributes
- body
Comment body
- headers
optional user headers to include in the request
- number
Issue number
- owner
of the repo
- repo
name of the repo
- Returns:
a GHResponse with the created Comment
- Definition Classes
Create an issue
Create an issue
Attributes
- assignees
Logins for Users to assign to this issue.
- body
The contents of the issue.
- headers
optional user headers to include in the request
- labels
Labels to associate with this issue.
- milestone
The number of the milestone to associate this issue with.
- owner
of the repo
- repo
name of the repo
- title
The title of the issue.
- Definition Classes
Create label in repository
Create label in repository
Attributes
- headers
optional user headers to include in the request
- label
label to create in the repository
- owner
of the repo
- repo
name of the repo
- Returns:
a GHResponse with the created Label.
- Definition Classes
Create a milestone
Create a milestone
Attributes
- description
A description of the milestone.
- due_on
The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
- headers
optional user headers to include in the request
- owner
repo owner
- repo
repo name
- state
The state of the milestone. Either open or closed. Default: open
- title
The title of the milestone.
- Returns:
a GHResponse with the created Milestone
- Definition Classes
Delete a comment
Delete a comment
Attributes
- headers
optional user headers to include in the request
- id
Comment id
- owner
of the repo
- repo
name of the repo
- Returns:
a unit GHResponse
- Definition Classes
Delete label for repository
Delete label for repository
Attributes
- headers
optional user headers to include in the request
- label
the name of the label to delete from the repository
- owner
of the repo
- repo
name of the repo
- Returns:
a Unit GHResponse
- Definition Classes
Delete a milestone
Delete a milestone
Attributes
- headers
optional user headers to include in the request
- milestone_number
number of milestone
- owner
repo owner
- repo
repo name
- Returns:
a Unit GHResponse
- Definition Classes
Edit a comment
Edit a comment
Attributes
- body
Comment body
- headers
optional user headers to include in the request
- id
Comment id
- owner
of the repo
- repo
name of the repo
- Returns:
a GHResponse with the edited Comment
- Definition Classes
Edit an issue
Edit an issue
Attributes
- assignees
Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty list to clear all assignees from the Issue.
- body
The contents of the issue.
- headers
optional user headers to include in the request
- issue
number
- labels
Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty list to clear all Labels from the Issue.
- milestone
The number of the milestone to associate this issue with.
- owner
of the repo
- repo
name of the repo
- state
State of the issue. Either open or closed.
- title
The title of the issue.
- Definition Classes
Get a single issue of a repository
Get a single issue of a repository
Note: In the past, pull requests and issues were more closely aligned than they are now. As far as the API is concerned, every pull request is an issue, but not every issue is a pull request.
This endpoint may also return pull requests in the response. If an issue is a pull request,
the object will include a pull_request
key.
Attributes
- headers
optional user headers to include in the request
- number
Issue number
- owner
of the repo
- repo
name of the repo
- Returns:
a GHResponse with the issue list.
- Definition Classes
Get a single milestone
Get a single milestone
Attributes
- headers
optional user headers to include in the request
- number
Milestone number
- owner
repo owner
- repo
repo name
- Returns:
a GHResponse with a Milestone
- Definition Classes
List available assignees for issues
List available assignees for issues
Attributes
- headers
optional user headers to include in the request
- owner
repo owner
- pagination
Limit and Offset for pagination
- repo
repo name
- Returns:
a GHResponse with the list of available assignees for issues in specified repository
- Definition Classes
List comments to an Issue
List comments to an Issue
Attributes
- headers
optional user headers to include in the request
- number
Issue number
- owner
of the repo
- pagination
Limit and Offset for pagination
- repo
name of the repo
- Returns:
a GHResponse with the comment list of the Issue.
- Definition Classes
List issues for a repository
List issues for a repository
Note: In the past, pull requests and issues were more closely aligned than they are now. As far as the API is concerned, every pull request is an issue, but not every issue is a pull request.
This endpoint may also return pull requests in the response. If an issue is a pull request,
the object will include a pull_request
key.
Attributes
- headers
optional user headers to include in the request
- owner
of the repo
- pagination
Limit and Offset for pagination
- repo
name of the repo
- Returns:
a GHResponse with the issue list.
- Definition Classes
List the labels assigned to an Issue
List the labels assigned to an Issue
Attributes
- headers
optional user headers to include in the request
- number
Issue number
- owner
of the repo
- pagination
Limit and Offset for pagination, optional.
- repo
name of the repo
- Returns:
a GHResponse with the list of labels for the Issue.
- Definition Classes
List the labels assigned to a Repository
List the labels assigned to a Repository
Attributes
- headers
optional user headers to include in the request
- owner
of the repo
- pagination
Limit and Offset for pagination, optional.
- repo
name of the repo
- Returns:
a GHResponse with the list of labels for the Repository.
- Definition Classes
List milestone in specified repository
List milestone in specified repository
Attributes
- direction
The direction of the sort. Either asc or desc. Default: asc
- headers
optional user headers to include in the request
- owner
repo owner
- pagination
Limit and Offset for pagination
- repo
repo name
- sort
What to sort results by. Either due_on or completeness. Default: due_on
- state
filter milestones returned by their state. Can be either
open
,closed
,all
. Default:open
- Returns:
a GHResponse with the list of milestones in specified repository
- Definition Classes
Remove the specified label from an Issue
Remove the specified label from an Issue
Attributes
- headers
optional user headers to include in the request
- label
the name of the label to remove from the issue
- number
Issue number
- owner
of the repo
- repo
name of the repo
- Returns:
a GHResponse with the list of labels removed from the Issue.
- Definition Classes
Search for issues
Search for issues
Note: In the past, pull requests and issues were more closely aligned than they are now. As far as the API is concerned, every pull request is an issue, but not every issue is a pull request.
This endpoint may also return pull requests in the response. If an issue is a pull request,
the object will include a pull_request
key.
Attributes
- headers
optional user headers to include in the request
- pagination
Limit and Offset for pagination
- query
the query string for the search
- searchParams
list of search params
- Returns:
a GHResponse with the result of the search.
- Definition Classes
Update label in repository
Update label in repository
Attributes
- headers
optional user headers to include in the request
- label
label to update in the repository
- owner
of the repo
- repo
name of the repo
- Returns:
a GHResponse with the updated Label.
- Definition Classes
Update a milestone
Update a milestone
Attributes
- description
A description of the milestone.
- due_on
The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
- headers
optional user headers to include in the request
- milestone_number
number of milestone
- owner
repo owner
- repo
repo name
- state
The state of the milestone. Either open or closed. Default: open
- title
The title of the milestone.
- Returns:
a GHResponse with the updated Milestone
- Definition Classes