package
1.5.1
Repository: https://github.com/ankitpokhrel/jira-cli.git
Documentation: pkg.go.dev

# Packages

Package filter provides a way to pass optional parameters to client methods.

# Functions

NewClient instantiates new jira client.
WithInsecureTLS is a functional opt that allow you to skip TLS certificate verification.
WithTimeout is a functional opt to attach timeout to the client.

# Constants

AssigneeDefault is a default assignee.
AssigneeNone is an empty assignee.
AuthTypeBasic is a basic auth.
AuthTypeBearer is a bearer auth.
AuthTypeMTLS is a mTLS auth.
BoardTypeAll represents all board types.
BoardTypeScrum represents a scrum board type.
EpicFieldLink represents epic link field in create metadata.
EpicFieldName represents epic name field in create metadata.
InstallationTypeCloud represents Jira cloud server.
InstallationTypeLocal represents on-premise Jira servers.
IssueTypeEpic is an epic issue type.
IssueTypeSubTask is a sub-task issue type.
ProjectTypeClassic is a classic project type.
ProjectTypeNextGen is a next gen project type.
RFC3339 is jira datetime format.
RFC3339MilliLayout is jira datetime format with milliseconds.
Sprint states.
Sprint states.
Sprint states.

# Variables

ErrEmptyResponse denotes empty response from the server.
ErrInvalidSearchOption denotes invalid search option was given.
ErrNoResult denotes no results.

# Structs

Board holds board info.
BoardResult holds response from /board endpoint.
Client is a jira client.
Config is a jira config.
CreateMetaIssueType struct holds issue types from GET /issue/createmeta endpoint.
CreateMetaRequest struct holds request data for createmeta request.
CreateMetaResponse struct holds response from GET /issue/createmeta endpoint.
CreateMetaResponseJiraServerV9 struct holds response from GET /issue/createmeta endpoint for jira server 9 and above.
CreateRequest struct holds request data for create request.
CreateResponse struct holds response from POST /issue endpoint.
EditRequest struct holds request data for edit request.
EditResponse struct holds response from POST /issue endpoint.
Epic holds epic info.
ErrMultipleFailed represents a grouped error, usually when multiple request fails when running them in a loop.
Errors is a jira error type.
ErrUnexpectedResponse denotes response code other than the expected one.
Field holds field info.
Issue holds issue info.
IssueFields holds issue fields.
IssueLinkType holds issue link type info.
IssueType holds issue type info.
IssueTypeField holds issue field info.
Me struct holds response from /myself endpoint.
MTLSConfig is MTLS authtype specific config.
Project holds project info.
SearchResult struct holds response from /search endpoint.
ServerInfo struct holds response from /serverInfo endpoint.
Sprint holds sprint info.
SprintResult holds response from /board/{boardID}/sprint endpoint.
Transition holds issue transition info.
TransitionRequest struct holds request data for issue transition request.
TransitionRequestData is a transition request data.
TransitionRequestFields struct holds a list of issue screen fields to update along with sub-fields.
TransitionRequestUpdate struct holds a list of operations to perform on the issue screen field.
User holds user info.
UserSearchOptions holds options to search for user.

# Type aliases

AuthType is a jira authentication type.
ClientFunc decorates option for client.
Header is a key, value pair for request headers.