Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GetBoardRequest ¶
type GetBoardRequest struct {
// contains filtered or unexported fields
}
GetBoardRequest holds parameters for a get board ZenHub API request
func NewGetBoardRequest ¶
func NewGetBoardRequest(repositoryID int64, authToken string) GetBoardRequest
NewGetBoardRequest creates a GetBoardRequest
func (GetBoardRequest) Do ¶
func (r GetBoardRequest) Do() ([]ZenHubBoardIssue, error)
Do makes a get board ZenHub API request
type GetDependenciesRequest ¶
type GetDependenciesRequest struct {
// RepositoryID is the ID of the repository to get issue dependencies for
RepositoryID int64
// ZenHubAuthToken is the ZenHub API token
ZenHubAuthToken string
}
GetDependenciesRequest hold the parameters for a get ZenHub dependencies API request
func NewGetDependenciesRequest ¶
func NewGetDependenciesRequest(repositoryID int64, zenhubAuthToken string) GetDependenciesRequest
NewGetDependenciesRequest creates a new GetDependenciesRequest
func (GetDependenciesRequest) Do ¶
func (r GetDependenciesRequest) Do() ([]ZenHubDependency, error)
Do makes the get dependencies ZenHub API request
type ZenHubAPIRequest ¶
type ZenHubAPIRequest struct {
// contains filtered or unexported fields
}
ZenHubAPIRequest holds ZenHub API request details
func NewZenHubAPIRequest ¶
func NewZenHubAPIRequest(url, authToken string) ZenHubAPIRequest
NewZenHubAPIRequest creates a new ZenHubAPIRequest
func (ZenHubAPIRequest) Do ¶
func (r ZenHubAPIRequest) Do(respVar interface{}) error
Do makes a ZenHub API request
type ZenHubBoardIssue ¶
type ZenHubBoardIssue struct {
// Number is the ID of an issue, unique inside of a repository
Number int64 `json:"issue_number"`
// Estimate is a value used to indicate how much work an issue will take to resolve
Estimate struct {
// Value is the estimate value
Value int64 `json:"value"`
} `json:"estimate"`
}
ZenHubBoardIssue holds information about a GitHub issue on a ZenHub board
type ZenHubBoardResponse ¶
type ZenHubBoardResponse struct {
// Pipelines holds a list of ZenHub pipelines on the board
Pipelines []struct {
// Issues holds a list of issues in the pipeline
Issues []ZenHubBoardIssue `json:"issues"`
} `json:"pipelines"`
}
ZenHubBoardResponse is the value returned by a get board ZenHub API request
type ZenHubDependenciesResponse ¶
type ZenHubDependenciesResponse struct {
// Dependencies is a list of issue dependencies from ZenHub
Dependencies []ZenHubDependency `json:"dependencies"`
}
ZenHubDependenciesResponse holds a list of issue dependencies from ZenHub
type ZenHubDependency ¶
type ZenHubDependency struct {
// Blocking holds information about the issue which is doing the blocking
Blocking ZenHubIssueID `json:"blocking"`
// Blocked holds information about the issue being blocked
Blocked ZenHubIssueID `json:"blocked"`
}
ZenHubDependency holds information about an issue dependency from ZenHub
type ZenHubIssueID ¶
type ZenHubIssueID struct {
// RepositoryID is the ID of the repository the issue belongs to
RepositoryID int64 `json:"repo_id"`
// IssueNumber is the ID of the issue
IssueNumber int64 `json:"issue_number"`
}
ZenHubIssueID identifies an issue
Source Files