api

Documentation

Index

• func Client(config jira.Config) *jira.Client
• func DefaultClient(debug bool) *jira.Client
• func ProxyAssignIssue(c *jira.Client, key string, user *jira.User, def string) error
• func ProxyCreate(c *jira.Client, cr *jira.CreateRequest) (*jira.CreateResponse, error)
• func ProxyGetIssue(c *jira.Client, key string, opts ...filter.Filter) (*jira.Issue, error)
• func ProxySearch(c *jira.Client, jql string, from, limit uint) (*jira.SearchResult, error)
• func ProxyTransitions(c *jira.Client, key string) ([]*jira.Transition, error)
• func ProxyUserSearch(c *jira.Client, opts *jira.UserSearchOptions) ([]*jira.User, error)
• func ProxyWatchIssue(c *jira.Client, key string, user *jira.User) error

Functions

func Client

func Client(config jira.Config) *jira.Client

Client initializes and returns jira client.

func DefaultClient

func DefaultClient(debug bool) *jira.Client

DefaultClient returns default jira client.

func ProxyAssignIssue

func ProxyAssignIssue(c *jira.Client, key string, user *jira.User, def string) error

ProxyAssignIssue uses either a v2 or v3 version of the PUT /issue/{key}/assignee endpoint to assign an issue to the user. Defaults to v3 if installation type is not defined in the config.

func ProxyCreate

func ProxyCreate(c *jira.Client, cr *jira.CreateRequest) (*jira.CreateResponse, error)

ProxyCreate uses either a v2 or v3 version of the Jira POST /issue endpoint to create an issue based on configured installation type. Defaults to v3 if installation type is not defined in the config.

func ProxyGetIssue

func ProxyGetIssue(c *jira.Client, key string, opts ...filter.Filter) (*jira.Issue, error)

ProxyGetIssue uses either a v2 or v3 version of the Jira GET /issue/{key} endpoint to fetch the issue details based on configured installation type. Defaults to v3 if installation type is not defined in the config.

func ProxySearch

func ProxySearch(c *jira.Client, jql string, from, limit uint) (*jira.SearchResult, error)

ProxySearch uses either a v2 or v3 version of the Jira GET /search endpoint to search for the relevant issues based on configured installation type. Defaults to v3 if installation type is not defined in the config.

func ProxyTransitions

func ProxyTransitions(c *jira.Client, key string) ([]*jira.Transition, error)

ProxyTransitions uses either v2 or v3 version of the GET /issue/{key}/transitions endpoint to fetch valid transitions for an issue. Defaults to v3 if installation type is not defined in the config.

func ProxyUserSearch

func ProxyUserSearch(c *jira.Client, opts *jira.UserSearchOptions) ([]*jira.User, error)

ProxyUserSearch uses either v2 or v3 version of the GET /user/assignable/search endpoint to search for the users assignable to the given issue. Defaults to v3 if installation type is not defined in the config.

func ProxyWatchIssue

func ProxyWatchIssue(c *jira.Client, key string, user *jira.User) error

ProxyWatchIssue uses either a v2 or v3 version of the PUT /issue/{key}/watchers endpoint to assign an issue to the user. Defaults to v3 if installation type is not defined in the config.