Documentation
¶
Overview ¶
Package client provides an API client for the arc server.
Index ¶
- type Client
- func (c *Client) AddDependency(wsID, issueID, dependsOnID, depType string) error
- func (c *Client) CloseIssue(wsID, id, reason string) (*types.Issue, error)
- func (c *Client) CreateIssue(wsID string, req CreateIssueRequest) (*types.Issue, error)
- func (c *Client) CreatePlan(wsID, title, content string) (*types.Plan, error)
- func (c *Client) CreateWorkspace(name, prefix, path, description string) (*types.Workspace, error)
- func (c *Client) DeleteIssue(wsID, id string) error
- func (c *Client) DeletePlan(wsID, planID string) error
- func (c *Client) DeleteWorkspace(id string) error
- func (c *Client) GetBlockedIssues(wsID string, limit int) ([]*types.BlockedIssue, error)
- func (c *Client) GetIssue(wsID, id string) (*types.Issue, error)
- func (c *Client) GetIssueDetails(wsID, id string) (*types.IssueDetails, error)
- func (c *Client) GetPlan(wsID, planID string) (*types.Plan, error)
- func (c *Client) GetPlanContext(wsID, issueID string) (*types.PlanContext, error)
- func (c *Client) GetPlanHistory(wsID, issueID string) ([]*types.Comment, error)
- func (c *Client) GetReadyWork(wsID string, limit int, sortPolicy string) ([]*types.Issue, error)
- func (c *Client) GetStatistics(wsID string) (*types.Statistics, error)
- func (c *Client) GetWorkspace(id string) (*types.Workspace, error)
- func (c *Client) Health() error
- func (c *Client) LinkIssuesToPlan(wsID, planID string, issueIDs []string) error
- func (c *Client) ListIssues(wsID string, opts ListIssuesOptions) ([]*types.Issue, error)
- func (c *Client) ListPlans(wsID string) ([]*types.Plan, error)
- func (c *Client) ListWorkspaces() ([]*types.Workspace, error)
- func (c *Client) RemoveDependency(wsID, issueID, dependsOnID string) error
- func (c *Client) SetActor(actor string)
- func (c *Client) SetInlinePlan(wsID, issueID, text string) (*types.Comment, error)
- func (c *Client) UnlinkIssueFromPlan(wsID, planID, issueID string) error
- func (c *Client) UpdateIssue(wsID, id string, updates map[string]interface{}) (*types.Issue, error)
- func (c *Client) UpdatePlan(wsID, planID, title, content string) (*types.Plan, error)
- type CreateIssueRequest
- type ListIssuesOptions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is the API client for arc.
func (*Client) AddDependency ¶
AddDependency adds a dependency.
func (*Client) CloseIssue ¶
CloseIssue closes an issue.
func (*Client) CreateIssue ¶
CreateIssue creates a new issue.
func (*Client) CreatePlan ¶ added in v0.7.0
CreatePlan creates a new shared plan.
func (*Client) CreateWorkspace ¶
CreateWorkspace creates a new workspace.
func (*Client) DeleteIssue ¶
DeleteIssue deletes an issue.
func (*Client) DeletePlan ¶ added in v0.7.0
DeletePlan deletes a shared plan.
func (*Client) DeleteWorkspace ¶
DeleteWorkspace deletes a workspace.
func (*Client) GetBlockedIssues ¶
GetBlockedIssues returns blocked issues.
func (*Client) GetIssueDetails ¶
func (c *Client) GetIssueDetails(wsID, id string) (*types.IssueDetails, error)
GetIssueDetails retrieves an issue with all relational data.
func (*Client) GetPlanContext ¶ added in v0.7.0
func (c *Client) GetPlanContext(wsID, issueID string) (*types.PlanContext, error)
GetPlanContext returns the plan context for an issue.
func (*Client) GetPlanHistory ¶ added in v0.7.0
GetPlanHistory returns the plan version history for an issue.
func (*Client) GetReadyWork ¶
GetReadyWork returns issues ready to work on. sortPolicy can be: "hybrid" (default), "priority", or "oldest".
func (*Client) GetStatistics ¶
func (c *Client) GetStatistics(wsID string) (*types.Statistics, error)
GetStatistics returns workspace statistics.
func (*Client) GetWorkspace ¶
GetWorkspace retrieves a workspace by ID.
func (*Client) LinkIssuesToPlan ¶ added in v0.7.0
LinkIssuesToPlan links one or more issues to a plan.
func (*Client) ListIssues ¶
ListIssues returns issues for a workspace.
func (*Client) ListWorkspaces ¶
ListWorkspaces returns all workspaces.
func (*Client) RemoveDependency ¶
RemoveDependency removes a dependency.
func (*Client) SetInlinePlan ¶ added in v0.7.0
SetInlinePlan sets or updates an inline plan on an issue.
func (*Client) UnlinkIssueFromPlan ¶ added in v0.7.0
UnlinkIssueFromPlan removes a link between an issue and a plan.
func (*Client) UpdateIssue ¶
UpdateIssue updates an issue.
type CreateIssueRequest ¶
type CreateIssueRequest struct {
Title string `json:"title"`
Description string `json:"description,omitempty"`
Priority int `json:"priority,omitempty"`
IssueType string `json:"issue_type,omitempty"`
Assignee string `json:"assignee,omitempty"`
ParentID string `json:"parent_id,omitempty"` // For hierarchical child IDs
}
CreateIssueRequest is the request for creating an issue.
Source Files