mirror of
https://github.com/interviewstreet/go-jira.git
synced 2025-03-23 21:09:19 +02:00
146229d2ab
Atlassian names the product "Jira". In this library, the product name is used different (JIRA) and inconsistent (sometimes JIRA, sometimes Jira). closes issue #284
88 lines
2.7 KiB
Go
88 lines
2.7 KiB
Go
package jira
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
)
|
|
|
|
// RoleService handles roles for the Jira instance / API.
|
|
//
|
|
// Jira API docs: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-group-Role
|
|
type RoleService struct {
|
|
client *Client
|
|
}
|
|
|
|
// Role represents a Jira product role
|
|
type Role struct {
|
|
Self string `json:"self" structs:"self"`
|
|
Name string `json:"name" structs:"name"`
|
|
ID int `json:"id" structs:"id"`
|
|
Description string `json:"description" structs:"description"`
|
|
Actors []*Actor `json:"actors" structs:"actors"`
|
|
}
|
|
|
|
// Actor represents a Jira actor
|
|
type Actor struct {
|
|
ID int `json:"id" structs:"id"`
|
|
DisplayName string `json:"displayName" structs:"displayName"`
|
|
Type string `json:"type" structs:"type"`
|
|
Name string `json:"name" structs:"name"`
|
|
AvatarURL string `json:"avatarUrl" structs:"avatarUrl"`
|
|
ActorUser *ActorUser `json:"actorUser" structs:"actoruser"`
|
|
}
|
|
|
|
// ActorUser contains the account id of the actor/user
|
|
type ActorUser struct {
|
|
AccountID string `json:"accountId" structs:"accountId"`
|
|
}
|
|
|
|
// GetListWithContext returns a list of all available project roles
|
|
//
|
|
// Jira API docs: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-api-3-role-get
|
|
func (s *RoleService) GetListWithContext(ctx context.Context) (*[]Role, *Response, error) {
|
|
apiEndpoint := "rest/api/3/role"
|
|
req, err := s.client.NewRequestWithContext(ctx, "GET", apiEndpoint, nil)
|
|
if err != nil {
|
|
return nil, nil, err
|
|
}
|
|
roles := new([]Role)
|
|
resp, err := s.client.Do(req, roles)
|
|
if err != nil {
|
|
jerr := NewJiraError(resp, err)
|
|
return nil, resp, jerr
|
|
}
|
|
return roles, resp, err
|
|
}
|
|
|
|
// GetList wraps GetListWithContext using the background context.
|
|
func (s *RoleService) GetList() (*[]Role, *Response, error) {
|
|
return s.GetListWithContext(context.Background())
|
|
}
|
|
|
|
// GetWithContext retreives a single Role from Jira
|
|
//
|
|
// Jira API docs: https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-api-3-role-id-get
|
|
func (s *RoleService) GetWithContext(ctx context.Context, roleID int) (*Role, *Response, error) {
|
|
apiEndpoint := fmt.Sprintf("rest/api/3/role/%d", roleID)
|
|
req, err := s.client.NewRequestWithContext(ctx, "GET", apiEndpoint, nil)
|
|
if err != nil {
|
|
return nil, nil, err
|
|
}
|
|
role := new(Role)
|
|
resp, err := s.client.Do(req, role)
|
|
if err != nil {
|
|
jerr := NewJiraError(resp, err)
|
|
return nil, resp, jerr
|
|
}
|
|
if role.Self == "" {
|
|
return nil, resp, fmt.Errorf("no role with ID %d found", roleID)
|
|
}
|
|
|
|
return role, resp, err
|
|
}
|
|
|
|
// Get wraps GetWithContext using the background context.
|
|
func (s *RoleService) Get(roleID int) (*Role, *Response, error) {
|
|
return s.GetWithContext(context.Background(), roleID)
|
|
}
|