jira

Documentation

Overview

Package jira provides request/response/payload types, and Timpani activity names and wrapper functions, for interacting with Jira Cloud.

Index

• Constants
• type User
  • func UsersGet(ctx workflow.Context, accountID string) (*User, error)
  • func UsersSearchActivity(ctx workflow.Context, query string) ([]User, error)
• type UsersGetRequest
• type UsersGetResponse
• type UsersSearchRequest

Constants

const (
	UsersGetActivityName    = "jira.users.get"
	UsersSearchActivityName = "jira.users.search"
)

Types

type User

type User struct {
	Self        string `json:"self"`
	AccountID   string `json:"accountId"`
	AccountType string `json:"accountType"`
	Active      bool   `json:"active"`

	DisplayName string `json:"displayName"`
	Email       string `json:"emailAddress"`
	TimeZone    string `json:"timeZone"`
	Locale      string `json:"locale"`

	AvatarURLs map[string]string `json:"avatarUrls"`
}

User is based on:

• https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users/#api-rest-api-3-user-get
• https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search/#api-rest-api-3-user-search-get

func UsersGet

func UsersGet(ctx workflow.Context, accountID string) (*User, error)

UsersGet is based on: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users/#api-rest-api-3-user-get

func UsersSearchActivity

func UsersSearchActivity(ctx workflow.Context, query string) ([]User, error)

UsersSearchActivity is based on: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search/#api-rest-api-3-user-search-get

type UsersGetRequest

type UsersGetRequest struct {
	AccountID string `json:"account_id"`
}

UsersGetRequest is based on: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users/#api-rest-api-3-user-get

type UsersGetResponse

type UsersGetResponse = User

UsersGetResponse is based on: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users/#api-rest-api-3-user-get

type UsersSearchRequest

type UsersSearchRequest struct {
	Query string `json:"query"`
}

UsersSearchRequest is based on: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search/#api-rest-api-3-user-search-get