/
field_context_impl.go
463 lines (361 loc) · 16.2 KB
/
field_context_impl.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
package internal
import (
"context"
"fmt"
model "github.com/ctreminiom/go-atlassian/pkg/infra/models"
"github.com/ctreminiom/go-atlassian/service"
"github.com/ctreminiom/go-atlassian/service/jira"
"net/http"
"net/url"
"strconv"
)
func NewIssueFieldContextService(client service.Connector, version string, option *IssueFieldContextOptionService) (*IssueFieldContextService, error) {
if version == "" {
return nil, model.ErrNoVersionProvided
}
return &IssueFieldContextService{
internalClient: &internalIssueFieldContextServiceImpl{c: client, version: version},
Option: option,
}, nil
}
type IssueFieldContextService struct {
internalClient jira.FieldContextConnector
Option *IssueFieldContextOptionService
}
// Gets returns a paginated list of contexts for a custom field. Contexts can be returned as follows:
//
// 1. By defining id only, all contexts from the list of IDs.
//
// 2. By defining isAnyIssueType
//
// 3. By defining isGlobalContext
//
// GET /rest/api/{2-3}/field/{fieldId}/context
//
// https://docs.go-atlassian.io/jira-software-cloud/issues/fields/context#get-custom-field-contexts
func (i *IssueFieldContextService) Gets(ctx context.Context, fieldId string, options *model.FieldContextOptionsScheme, startAt, maxResults int) (*model.CustomFieldContextPageScheme, *model.ResponseScheme, error) {
return i.internalClient.Gets(ctx, fieldId, options, startAt, maxResults)
}
// Create creates a custom field context.
//
// 1. If projectIds is empty, a global context is created. A global context is one that applies to all project.
//
// 2. If issueTypeIds is empty, the context applies to all issue types.
//
// POST /rest/api/{2-3}/field/{fieldId}/context
//
// https://docs.go-atlassian.io/jira-software-cloud/issues/fields/context#create-custom-field-context
func (i *IssueFieldContextService) Create(ctx context.Context, fieldId string, payload *model.FieldContextPayloadScheme) (*model.FieldContextScheme, *model.ResponseScheme, error) {
return i.internalClient.Create(ctx, fieldId, payload)
}
// GetDefaultValues returns a paginated list of defaults for a custom field.
//
// The results can be filtered by contextId, otherwise all values are returned. If no defaults are set for a context, nothing is returned.
//
// GET /rest/api/{2-3}/field/{fieldId}/context/defaultValue
//
// https://docs.go-atlassian.io/jira-software-cloud/issues/fields/context#get-custom-field-contexts-default-values
func (i *IssueFieldContextService) GetDefaultValues(ctx context.Context, fieldId string, contextIds []int, startAt, maxResults int) (*model.CustomFieldDefaultValuePageScheme, *model.ResponseScheme, error) {
return i.internalClient.GetDefaultValues(ctx, fieldId, contextIds, startAt, maxResults)
}
// SetDefaultValue sets default for contexts of a custom field.
//
// PUT /rest/api/{2-3}/field/{fieldId}/context/defaultValue
//
// https://docs.go-atlassian.io/jira-software-cloud/issues/fields/context#set-custom-field-contexts-default-values
func (i *IssueFieldContextService) SetDefaultValue(ctx context.Context, fieldId string, payload *model.FieldContextDefaultPayloadScheme) (*model.ResponseScheme, error) {
return i.internalClient.SetDefaultValue(ctx, fieldId, payload)
}
// IssueTypesContext returns a paginated list of context to issue type mappings for a custom field.
//
// 1. Mappings are returned for all contexts or a list of contexts.
//
// 2. Mappings are ordered first by context ID and then by issue type ID.
//
// GET /rest/api/{2-3}/field/{fieldId}/context/issuetypemapping
//
// Docs: TODO: The documentation needs to be created, raise a ticket here: https://github.com/ctreminiom/go-atlassian/issues
func (i *IssueFieldContextService) IssueTypesContext(ctx context.Context, fieldId string, contextIds []int, startAt, maxResults int) (*model.IssueTypeToContextMappingPageScheme, *model.ResponseScheme, error) {
return i.internalClient.IssueTypesContext(ctx, fieldId, contextIds, startAt, maxResults)
}
// ProjectsContext returns a paginated list of context to project mappings for a custom field.
//
// 1. The result can be filtered by contextId, or otherwise all mappings are returned.
//
// 2. Invalid IDs are ignored.
//
// GET /rest/api/{2-3}/field/{fieldId}/context/projectmapping
//
// Docs: TODO: The documentation needs to be created, raise a ticket here: https://github.com/ctreminiom/go-atlassian/issues
func (i *IssueFieldContextService) ProjectsContext(ctx context.Context, fieldId string, contextIds []int, startAt, maxResults int) (*model.CustomFieldContextProjectMappingPageScheme, *model.ResponseScheme, error) {
return i.internalClient.ProjectsContext(ctx, fieldId, contextIds, startAt, maxResults)
}
// Update updates a custom field context
//
// PUT /rest/api/{2-3}/field/{fieldId}/context/{contextId}
//
// https://docs.go-atlassian.io/jira-software-cloud/issues/fields/context#update-custom-field-context
func (i *IssueFieldContextService) Update(ctx context.Context, fieldId string, contextId int, name, description string) (*model.ResponseScheme, error) {
return i.internalClient.Update(ctx, fieldId, contextId, name, description)
}
// Delete deletes a custom field context.
//
// DELETE /rest/api/{2-3}/field/{fieldId}/context/{contextId}
//
// https://docs.go-atlassian.io/jira-software-cloud/issues/fields/context#delete-custom-field-context
func (i *IssueFieldContextService) Delete(ctx context.Context, fieldId string, contextId int) (*model.ResponseScheme, error) {
return i.internalClient.Delete(ctx, fieldId, contextId)
}
// AddIssueTypes adds issue types to a custom field context, appending the issue types to the issue types list.
//
// PUT /rest/api/{2-3}/field/{fieldId}/context/{contextId}/issuetype
//
// https://docs.go-atlassian.io/jira-software-cloud/issues/fields/context#add-issue-types-to-context
func (i *IssueFieldContextService) AddIssueTypes(ctx context.Context, fieldId string, contextId int, issueTypesIds []string) (*model.ResponseScheme, error) {
return i.internalClient.AddIssueTypes(ctx, fieldId, contextId, issueTypesIds)
}
// RemoveIssueTypes removes issue types from a custom field context. A custom field context without any issue types applies to all issue types.
//
// POST /rest/api/{2-3}/field/{fieldId}/context/{contextId}/issuetype/remove
//
// https://docs.go-atlassian.io/jira-software-cloud/issues/fields/context#remove-issue-types-from-context
func (i *IssueFieldContextService) RemoveIssueTypes(ctx context.Context, fieldId string, contextId int, issueTypesIds []string) (*model.ResponseScheme, error) {
return i.internalClient.RemoveIssueTypes(ctx, fieldId, contextId, issueTypesIds)
}
// Link assigns a custom field context to projects. If any project in the request is assigned to any context of the custom field, the operation fails.
//
// PUT /rest/api/{2-3}/field/{fieldId}/context/{contextId}/project
//
// https://docs.go-atlassian.io/jira-software-cloud/issues/fields/context#assign-custom-field-context-to-projects
func (i *IssueFieldContextService) Link(ctx context.Context, fieldId string, contextId int, projectIds []string) (*model.ResponseScheme, error) {
return i.internalClient.Link(ctx, fieldId, contextId, projectIds)
}
// UnLink removes a custom field context from projects.
//
// 1. A custom field context without any projects applies to all projects.
//
// 2. Removing all projects from a custom field context would result in it applying to all projects.
//
// POST /rest/api/{2-3}/field/{fieldId}/context/{contextId}/project/remove
//
// https://docs.go-atlassian.io/jira-software-cloud/issues/fields/context#remove-custom-field-context-from-projects
func (i *IssueFieldContextService) UnLink(ctx context.Context, fieldId string, contextId int, projectIds []string) (*model.ResponseScheme, error) {
return i.internalClient.UnLink(ctx, fieldId, contextId, projectIds)
}
type internalIssueFieldContextServiceImpl struct {
c service.Connector
version string
}
func (i *internalIssueFieldContextServiceImpl) Gets(ctx context.Context, fieldId string, options *model.FieldContextOptionsScheme, startAt, maxResults int) (*model.CustomFieldContextPageScheme, *model.ResponseScheme, error) {
if fieldId == "" {
return nil, nil, model.ErrNoFieldIDError
}
params := url.Values{}
params.Add("startAt", strconv.Itoa(startAt))
params.Add("maxResults", strconv.Itoa(maxResults))
if options != nil {
params.Add("isAnyIssueType", fmt.Sprintf("%v", options.IsAnyIssueType))
params.Add("isGlobalContext", fmt.Sprintf("%v", options.IsGlobalContext))
for _, id := range options.ContextID {
params.Add("contextId", strconv.Itoa(id))
}
}
endpoint := fmt.Sprintf("rest/api/%v/field/%v/context?%v", i.version, fieldId, params.Encode())
request, err := i.c.NewRequest(ctx, http.MethodGet, endpoint, "", nil)
if err != nil {
return nil, nil, err
}
contexts := new(model.CustomFieldContextPageScheme)
response, err := i.c.Call(request, contexts)
if err != nil {
return nil, response, err
}
return contexts, response, nil
}
func (i *internalIssueFieldContextServiceImpl) Create(ctx context.Context, fieldId string, payload *model.FieldContextPayloadScheme) (*model.FieldContextScheme, *model.ResponseScheme, error) {
if fieldId == "" {
return nil, nil, model.ErrNoFieldIDError
}
endpoint := fmt.Sprintf("rest/api/%v/field/%v/context", i.version, fieldId)
request, err := i.c.NewRequest(ctx, http.MethodPost, endpoint, "", payload)
if err != nil {
return nil, nil, err
}
newContext := new(model.FieldContextScheme)
response, err := i.c.Call(request, newContext)
if err != nil {
return nil, response, err
}
return newContext, response, nil
}
func (i *internalIssueFieldContextServiceImpl) GetDefaultValues(ctx context.Context, fieldId string, contextIds []int, startAt, maxResults int) (*model.CustomFieldDefaultValuePageScheme, *model.ResponseScheme, error) {
if fieldId == "" {
return nil, nil, model.ErrNoFieldIDError
}
params := url.Values{}
params.Add("startAt", strconv.Itoa(startAt))
params.Add("maxResults", strconv.Itoa(maxResults))
for _, id := range contextIds {
params.Add("contextId", strconv.Itoa(id))
}
endpoint := fmt.Sprintf("rest/api/%v/field/%v/context/defaultValue?%s", i.version, fieldId, params.Encode())
request, err := i.c.NewRequest(ctx, http.MethodGet, endpoint, "", nil)
if err != nil {
return nil, nil, err
}
values := new(model.CustomFieldDefaultValuePageScheme)
response, err := i.c.Call(request, values)
if err != nil {
return nil, response, err
}
return values, response, nil
}
func (i *internalIssueFieldContextServiceImpl) SetDefaultValue(ctx context.Context, fieldId string, payload *model.FieldContextDefaultPayloadScheme) (*model.ResponseScheme, error) {
if fieldId == "" {
return nil, model.ErrNoFieldIDError
}
endpoint := fmt.Sprintf("rest/api/%v/field/%v/context/defaultValue", i.version, fieldId)
request, err := i.c.NewRequest(ctx, http.MethodPut, endpoint, "", payload)
if err != nil {
return nil, err
}
return i.c.Call(request, nil)
}
func (i *internalIssueFieldContextServiceImpl) IssueTypesContext(ctx context.Context, fieldId string, contextIds []int, startAt, maxResults int) (*model.IssueTypeToContextMappingPageScheme, *model.ResponseScheme, error) {
if fieldId == "" {
return nil, nil, model.ErrNoFieldIDError
}
params := url.Values{}
params.Add("startAt", strconv.Itoa(startAt))
params.Add("maxResults", strconv.Itoa(maxResults))
for _, id := range contextIds {
params.Add("contextId", strconv.Itoa(id))
}
endpoint := fmt.Sprintf("rest/api/%v/field/%v/context/issuetypemapping?%v", i.version, fieldId, params.Encode())
request, err := i.c.NewRequest(ctx, http.MethodGet, endpoint, "", nil)
if err != nil {
return nil, nil, err
}
mapping := new(model.IssueTypeToContextMappingPageScheme)
response, err := i.c.Call(request, mapping)
if err != nil {
return nil, response, err
}
return mapping, response, nil
}
func (i *internalIssueFieldContextServiceImpl) ProjectsContext(ctx context.Context, fieldId string, contextIds []int, startAt, maxResults int) (*model.CustomFieldContextProjectMappingPageScheme, *model.ResponseScheme, error) {
if fieldId == "" {
return nil, nil, model.ErrNoFieldIDError
}
params := url.Values{}
params.Add("startAt", strconv.Itoa(startAt))
params.Add("maxResults", strconv.Itoa(maxResults))
for _, id := range contextIds {
params.Add("contextId", strconv.Itoa(id))
}
endpoint := fmt.Sprintf("rest/api/%v/field/%v/context/projectmapping?%v", i.version, fieldId, params.Encode())
request, err := i.c.NewRequest(ctx, http.MethodGet, endpoint, "", nil)
if err != nil {
return nil, nil, err
}
mapping := new(model.CustomFieldContextProjectMappingPageScheme)
response, err := i.c.Call(request, mapping)
if err != nil {
return nil, response, err
}
return mapping, response, nil
}
func (i *internalIssueFieldContextServiceImpl) Update(ctx context.Context, fieldId string, contextId int, name, description string) (*model.ResponseScheme, error) {
if fieldId == "" {
return nil, model.ErrNoFieldIDError
}
if contextId == 0 {
return nil, model.ErrNoFieldContextIDError
}
payload := map[string]interface{}{"name": name}
if description != "" {
payload["description"] = description
}
endpoint := fmt.Sprintf("rest/api/%v/field/%v/context/%v", i.version, fieldId, contextId)
request, err := i.c.NewRequest(ctx, http.MethodPut, endpoint, "", payload)
if err != nil {
return nil, err
}
return i.c.Call(request, nil)
}
func (i *internalIssueFieldContextServiceImpl) Delete(ctx context.Context, fieldId string, contextId int) (*model.ResponseScheme, error) {
if fieldId == "" {
return nil, model.ErrNoFieldIDError
}
if contextId == 0 {
return nil, model.ErrNoFieldContextIDError
}
endpoint := fmt.Sprintf("rest/api/%v/field/%v/context/%v", i.version, fieldId, contextId)
request, err := i.c.NewRequest(ctx, http.MethodDelete, endpoint, "", nil)
if err != nil {
return nil, err
}
return i.c.Call(request, nil)
}
func (i *internalIssueFieldContextServiceImpl) AddIssueTypes(ctx context.Context, fieldId string, contextId int, issueTypesIds []string) (*model.ResponseScheme, error) {
if fieldId == "" {
return nil, model.ErrNoFieldIDError
}
if len(issueTypesIds) == 0 {
return nil, model.ErrNoIssueTypesError
}
endpoint := fmt.Sprintf("rest/api/%v/field/%v/context/%v/issuetype", i.version, fieldId, contextId)
request, err := i.c.NewRequest(ctx, http.MethodPut, endpoint, "", map[string]interface{}{"issueTypeIds": issueTypesIds})
if err != nil {
return nil, err
}
return i.c.Call(request, nil)
}
func (i *internalIssueFieldContextServiceImpl) RemoveIssueTypes(ctx context.Context, fieldId string, contextId int, issueTypesIds []string) (*model.ResponseScheme, error) {
if fieldId == "" {
return nil, model.ErrNoFieldIDError
}
if len(issueTypesIds) == 0 {
return nil, model.ErrNoIssueTypesError
}
endpoint := fmt.Sprintf("rest/api/%v/field/%v/context/%v/issuetype/remove", i.version, fieldId, contextId)
request, err := i.c.NewRequest(ctx, http.MethodPost, endpoint, "", map[string]interface{}{"issueTypeIds": issueTypesIds})
if err != nil {
return nil, err
}
return i.c.Call(request, nil)
}
func (i *internalIssueFieldContextServiceImpl) Link(ctx context.Context, fieldId string, contextId int, projectIds []string) (*model.ResponseScheme, error) {
if fieldId == "" {
return nil, model.ErrNoFieldIDError
}
if contextId == 0 {
return nil, model.ErrNoFieldContextIDError
}
if len(projectIds) == 0 {
return nil, model.ErrNoProjectIDsError
}
endpoint := fmt.Sprintf("rest/api/%v/field/%v/context/%v/project", i.version, fieldId, contextId)
request, err := i.c.NewRequest(ctx, http.MethodPut, endpoint, "", map[string]interface{}{"projectIds": projectIds})
if err != nil {
return nil, err
}
return i.c.Call(request, nil)
}
func (i *internalIssueFieldContextServiceImpl) UnLink(ctx context.Context, fieldId string, contextId int, projectIds []string) (*model.ResponseScheme, error) {
if fieldId == "" {
return nil, model.ErrNoFieldIDError
}
if contextId == 0 {
return nil, model.ErrNoFieldContextIDError
}
if len(projectIds) == 0 {
return nil, model.ErrNoProjectIDsError
}
endpoint := fmt.Sprintf("rest/api/%v/field/%v/context/%v/project/remove", i.version, fieldId, contextId)
request, err := i.c.NewRequest(ctx, http.MethodPost, endpoint, "", map[string]interface{}{"projectIds": projectIds})
if err != nil {
return nil, err
}
return i.c.Call(request, nil)
}