# README
Compatibility • Usage example • CI Status • License
go-jira
is a Go package for working with Jira REST API.
[!IMPORTANT] Please note that this package only supports retrieving data from the Jira API (i.e. you cannot create or modify data with this package).
Compatibility
Version | 6.x | 7.x | 8.x | 9.x | cloud |
---|---|---|---|---|---|
1.x | Full | Partial | Partial | Partial | No |
2.x | Full | Full | Full | Partial | No |
Usage example
package main
import (
"fmt"
"github.com/essentialkaos/go-jira/v3"
)
func main() {
// Create API instance with basic auth
api, err := jira.NewAPI("https://jira.domain.com", jira.AuthBasic{"john", "MySuppaPAssWOrd"})
// or with personal token auth
api, err = jira.NewAPI("https://jira.domain.com", jira.AuthToken{"avaMTxxxqKaxpFHpmwHPXhjmUFfAJMaU3VXUji73EFhf"})
api.SetUserAgent("MyApp", "1.2.3")
if err != nil {
fmt.Printf("Error: %v\n", err)
return
}
issue, err := api.GetIssue(
"SAS-1956", jira.IssueParams{
Expand: []string{"changelog"},
},
)
if err != nil {
fmt.Printf("Error: %v\n", err)
return
}
fmt.Printf("%-v\n", issue)
}
CI Status
Branch | Status |
---|---|
master (Stable) | |
develop (Unstable) |
License
# Functions
NewAPI create new API struct.
# Constants
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
User permissions.
Roles actors.
Roles actors.
# Variables
No description provided by the author
No description provided by the author
API errors.
No description provided by the author
API errors.
API errors.
API errors.
API errors.
API errors.
No description provided by the author
API errors.
# Structs
Actor contains info about role actor.
API is Jira API struct.
Attachment contains info about attachment.
AuthBasic is struct with data for basic authorization.
AuthToken is struct with data for personal token authorization.
AutocompleteData contains autocomplete data.
Avatar contains info about project/user avatar.
Avatars contains info about project/user avatars.
AvatarURL contains avatars urls.
Column contains info about column.
Comment contains info about comment.
CommentCollection is comment collection.
Component contains info about component.
Configuration contains info about optional features.
CreateMetaParams params for fetching metadata for creating issues.
Dashboard contains info about dashboard.
DashboardCollection is dashboard collection.
DashboardParams is params for fetching dashboards.
Date is RFC3339 encoded date.
EmptyParameters is empty parameters.
ErrorCollection is JIRA error struct.
ExpandParameters is params with field expand info.
Field contains info about field.
FieldMeta contains field meta.
FieldMetaValue contains field meta value.
FieldSchema contains field schema.
Filter contains info about filter.
FilterSharePermission contains info about share permission.
FilterSubscription contains info about filter subscription.
FilterSubscriptions contains info about filter subscriptions.
Group contains info about user group.
GroupInfo contains simple info about group.
GroupParams is params for fetching groups info.
GroupPickerParams is params for fetching data from group picker.
GroupPickerResults contains group picker response data.
GroupUserPickerParams is params for fetching data from user/group picker.
GroupUserPickerResults contains user/group picker response data.
HealthCheck contains info about health check.
Issue is basic issue struct.
IssueFields contains all available issue fields.
IssueInfo contains simple info about issue.
IssueMeta contains meta data for editing an issue.
IssueParams is params for fetching issue info.
IssuePickerParams is params for fetching data from issue picker.
IssuePickerResults contains issue picker response data.
IssueType contains info about issue type.
JQLField contains info about JQL field.
JQLFunction contains info about JQL function.
Link contains info about link.
LinkType contains info about link type.
Permission contains info about permission.
PermissionsParams is params for fetching parmissions info.
Priority contains priority info.
Progress contains info about issue progress.
Project contains info about project.
ProjectCategory contains info about project category.
Property contains info about property.
RemoteLink contains info about remote link.
RemoteLinkApp contains info about link app.
RemoteLinkIcon contains icon URL.
RemoteLinkInfo contains basic info about remote link.
RemoteLinkParams is params for fetching remote link info.
Resolution contains resolution info.
Role contains info about role.
ScreenField contains info about screen field.
ScreenParams is params for fetching info about screen.
ScreenTab contains info about screen tab.
SearchParams is params for fetching search results.
SearchResults contains search result.
SecurityLevel contains info about security level.
ServerInfo contains info about JIRA instance.
Status contains info about issue status.
StatusCategory contains info about status category.
Suggestion contains suggestion info.
SuggestionParams is params for fetching suggestions.
TimeTracking contains info about time tracking.
TimeTrackingConfiguration contains detailed info about time tracking configuration.
Transition contains info about transition.
TransitionsParams is params for fetching transitions info.
User contains user info.
UserCollection is users collection.
UserGroups contains info about user groups.
UserInfo contains simple info about user.
UserParams is params for fetching user info.
UserPermissionParams is permissions for fetching users by permissions.
UserPickerParams is params for fetching data from user picker.
UserPickerResults contains user picker response data.
UserSearchParams is permissions for searching users.
Version contains version info.
VersionCollection is version collection.
VersionCounts contains info about issues counts.
VersionParams contains params for fetching version data.
VotesInfo contains info about votes.
WatchersInfo contains info about watchers.
Watches contains info about watches.
Workflow contains info about workflow.
WorkflowInfo contains basic info about workflow.
WorkflowScheme contains info about workflow scheme.
Worklog is worklog record.
WorklogCollection is worklog collection.
# Interfaces
Auth is interface for authorization method.
Parameters is interface for params structs.
# Type aliases
CustomFieldsStore is store for custom fields data.