Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

BREAKING CHANGE: Use create request body instead of custom parameters #459

Closed
wants to merge 1 commit into from
Closed

BREAKING CHANGE: Use create request body instead of custom parameters #459

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 15 additions & 21 deletions request.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package jira
import (
"context"
"fmt"
"net/http"
)

// RequestService handles ServiceDesk customer requests for the Jira instance / API.
Expand All @@ -27,7 +28,7 @@ type Request struct {
type RequestFieldValue struct {
FieldID string `json:"fieldId,omitempty" structs:"fieldId,omitempty"`
Label string `json:"label,omitempty" structs:"label,omitempty"`
Value string `json:"value,omitempty" structs:"value,omitempty"`
Value any `json:"value,omitempty" structs:"value,omitempty"`
}

// RequestDate is the date format used in requests.
Expand Down Expand Up @@ -56,29 +57,22 @@ type RequestComment struct {
Expands []string `json:"_expands,omitempty" structs:"_expands,omitempty"`
}

// CreateRequest represents a ServiceDesk customer request.
type CreateRequest struct {
ServiceDeskID string `json:"serviceDeskId,omitempty" structs:"serviceDeskId,omitempty"`
TypeID string `json:"requestTypeId,omitempty" structs:"requestTypeId,omitempty"`
FieldValues map[string]any `json:"requestFieldValues,omitempty" structs:"requestFieldValues,omitempty"`
Participants []string `json:"requestParticipants,omitempty" structs:"requestParticipants,omitempty"`
Requester string `json:"raiseOnBehalfOf,omitempty" structs:"raiseOnBehalfOf,omitempty"`
}

// CreateWithContext creates a new request.
//
// https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request/#api-rest-servicedeskapi-request-post
func (r *RequestService) CreateWithContext(ctx context.Context, requester string, participants []string, request *Request) (*Request, *Response, error) {
func (r *RequestService) CreateWithContext(ctx context.Context, request *CreateRequest) (*Request, *Response, error) {
apiEndpoint := "rest/servicedeskapi/request"

payload := struct {
*Request
FieldValues map[string]string `json:"requestFieldValues,omitempty"`
Requester string `json:"raiseOnBehalfOf,omitempty"`
Participants []string `json:"requestParticipants,omitempty"`
}{
Request: request,
FieldValues: make(map[string]string),
Requester: requester,
Participants: participants,
}

for _, field := range request.FieldValues {
payload.FieldValues[field.FieldID] = field.Value
}

req, err := r.client.NewRequestWithContext(ctx, "POST", apiEndpoint, payload)
req, err := r.client.NewRequestWithContext(ctx, http.MethodPost, apiEndpoint, request)
if err != nil {
return nil, nil, err
}
Expand All @@ -93,8 +87,8 @@ func (r *RequestService) CreateWithContext(ctx context.Context, requester string
}

// Create wraps CreateWithContext using the background context.
func (r *RequestService) Create(requester string, participants []string, request *Request) (*Request, *Response, error) {
return r.CreateWithContext(context.Background(), requester, participants, request)
func (r *RequestService) Create(request *CreateRequest) (*Request, *Response, error) {
return r.CreateWithContext(context.Background(), request)
}

// CreateCommentWithContext creates a comment on a request.
Expand Down