-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathapi_feature_flag_setting_values.go
806 lines (684 loc) · 30.5 KB
/
api_feature_flag_setting_values.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
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
/*
ConfigCat Public Management API
The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. **Base API URL**: https://test-api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger). The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON format. **Important:** Do not use this API for accessing and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview) or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/) instead. # OpenAPI Specification The complete specification is publicly available in the following formats: - [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json) - [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json) You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). <!-- ReDoc-Inject: <security-definitions> --> # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header.
API version: v1
Contact: support@configcat.com
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package configcatpublicapi
import (
"bytes"
"context"
"io"
"net/http"
"net/url"
"strings"
)
// FeatureFlagSettingValuesAPIService FeatureFlagSettingValuesAPI service
type FeatureFlagSettingValuesAPIService service
type FeatureFlagSettingValuesAPIGetSettingValueRequest struct {
ctx context.Context
ApiService *FeatureFlagSettingValuesAPIService
environmentId string
settingId int32
}
func (r FeatureFlagSettingValuesAPIGetSettingValueRequest) Execute() (*SettingValueModel, *http.Response, error) {
return r.ApiService.GetSettingValueExecute(r)
}
/*
GetSettingValue Get value
This endpoint returns the value of a Feature Flag or Setting
in a specified Environment identified by the `environmentId` parameter.
The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`.
The `value` represents what the clients will get when the evaluation requests of our SDKs
are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate.
The `rolloutRules` and `percentageRules` attributes are representing the current
Targeting and Percentage Rules configuration of the actual Feature Flag or Setting
in an **ordered** collection, which means the order of the returned rules is matching to the
evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview).
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param environmentId The identifier of the Environment.
@param settingId The id of the Setting.
@return FeatureFlagSettingValuesAPIGetSettingValueRequest
*/
func (a *FeatureFlagSettingValuesAPIService) GetSettingValue(ctx context.Context, environmentId string, settingId int32) FeatureFlagSettingValuesAPIGetSettingValueRequest {
return FeatureFlagSettingValuesAPIGetSettingValueRequest{
ApiService: a,
ctx: ctx,
environmentId: environmentId,
settingId: settingId,
}
}
// Execute executes the request
// @return SettingValueModel
func (a *FeatureFlagSettingValuesAPIService) GetSettingValueExecute(r FeatureFlagSettingValuesAPIGetSettingValueRequest) (*SettingValueModel, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *SettingValueModel
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FeatureFlagSettingValuesAPIService.GetSettingValue")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/environments/{environmentId}/settings/{settingId}/value"
localVarPath = strings.Replace(localVarPath, "{"+"environmentId"+"}", url.PathEscape(parameterValueToString(r.environmentId, "environmentId")), -1)
localVarPath = strings.Replace(localVarPath, "{"+"settingId"+"}", url.PathEscape(parameterValueToString(r.settingId, "settingId")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type FeatureFlagSettingValuesAPIGetSettingValuesRequest struct {
ctx context.Context
ApiService *FeatureFlagSettingValuesAPIService
configId string
environmentId string
}
func (r FeatureFlagSettingValuesAPIGetSettingValuesRequest) Execute() (*ConfigSettingValuesModel, *http.Response, error) {
return r.ApiService.GetSettingValuesExecute(r)
}
/*
GetSettingValues Get values
This endpoint returns the value of a specified Config's Feature Flags or Settings identified by the `configId` parameter
in a specified Environment identified by the `environmentId` parameter.
The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`.
The `value` represents what the clients will get when the evaluation requests of our SDKs
are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate.
The `rolloutRules` and `percentageRules` attributes are representing the current
Targeting and Percentage Rules configuration of the actual Feature Flag or Setting
in an **ordered** collection, which means the order of the returned rules is matching to the
evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/).
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param configId The identifier of the Config.
@param environmentId The identifier of the Environment.
@return FeatureFlagSettingValuesAPIGetSettingValuesRequest
*/
func (a *FeatureFlagSettingValuesAPIService) GetSettingValues(ctx context.Context, configId string, environmentId string) FeatureFlagSettingValuesAPIGetSettingValuesRequest {
return FeatureFlagSettingValuesAPIGetSettingValuesRequest{
ApiService: a,
ctx: ctx,
configId: configId,
environmentId: environmentId,
}
}
// Execute executes the request
// @return ConfigSettingValuesModel
func (a *FeatureFlagSettingValuesAPIService) GetSettingValuesExecute(r FeatureFlagSettingValuesAPIGetSettingValuesRequest) (*ConfigSettingValuesModel, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *ConfigSettingValuesModel
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FeatureFlagSettingValuesAPIService.GetSettingValues")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/configs/{configId}/environments/{environmentId}/values"
localVarPath = strings.Replace(localVarPath, "{"+"configId"+"}", url.PathEscape(parameterValueToString(r.configId, "configId")), -1)
localVarPath = strings.Replace(localVarPath, "{"+"environmentId"+"}", url.PathEscape(parameterValueToString(r.environmentId, "environmentId")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type FeatureFlagSettingValuesAPIPostSettingValuesRequest struct {
ctx context.Context
ApiService *FeatureFlagSettingValuesAPIService
configId string
environmentId string
updateSettingValuesWithIdModel *UpdateSettingValuesWithIdModel
reason *string
}
func (r FeatureFlagSettingValuesAPIPostSettingValuesRequest) UpdateSettingValuesWithIdModel(updateSettingValuesWithIdModel UpdateSettingValuesWithIdModel) FeatureFlagSettingValuesAPIPostSettingValuesRequest {
r.updateSettingValuesWithIdModel = &updateSettingValuesWithIdModel
return r
}
// The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on.
func (r FeatureFlagSettingValuesAPIPostSettingValuesRequest) Reason(reason string) FeatureFlagSettingValuesAPIPostSettingValuesRequest {
r.reason = &reason
return r
}
func (r FeatureFlagSettingValuesAPIPostSettingValuesRequest) Execute() (*ConfigSettingValuesModel, *http.Response, error) {
return r.ApiService.PostSettingValuesExecute(r)
}
/*
PostSettingValues Post values
This endpoint replaces the values of a specified Config's Feature Flags or Settings identified by the `configId` parameter
in a specified Environment identified by the `environmentId` parameter.
Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint.
**Important:** As this endpoint is doing a complete replace, it's important to set every other attribute that you don't
want to change in its original state. Not listing one means it will reset.
For example: We have the following resource.
```json
{
"settingValues": [
{
"rolloutPercentageItems": [
{
"percentage": 30,
"value": true
},
{
"percentage": 70,
"value": false
}
],
"rolloutRules": [],
"value": false,
"settingId": 1
}
]
}
```
If we send a replace request body as below:
```json
{
"settingValues": [
{
"value": true,
"settingId": 1
}
]
}
```
Then besides that the default value is set to `true`, all the Percentage Rules are deleted.
So we get a response like this:
```json
{
"settingValues": [
{
"rolloutPercentageItems": [],
"rolloutRules": [],
"value": true,
"setting":
{
"settingId": 1
}
}
]
}
```
The `rolloutRules` property describes two types of rules:
- **Targeting rules**: When you want to add or update a targeting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required.
- **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param configId The identifier of the Config.
@param environmentId The identifier of the Environment.
@return FeatureFlagSettingValuesAPIPostSettingValuesRequest
*/
func (a *FeatureFlagSettingValuesAPIService) PostSettingValues(ctx context.Context, configId string, environmentId string) FeatureFlagSettingValuesAPIPostSettingValuesRequest {
return FeatureFlagSettingValuesAPIPostSettingValuesRequest{
ApiService: a,
ctx: ctx,
configId: configId,
environmentId: environmentId,
}
}
// Execute executes the request
// @return ConfigSettingValuesModel
func (a *FeatureFlagSettingValuesAPIService) PostSettingValuesExecute(r FeatureFlagSettingValuesAPIPostSettingValuesRequest) (*ConfigSettingValuesModel, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *ConfigSettingValuesModel
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FeatureFlagSettingValuesAPIService.PostSettingValues")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/configs/{configId}/environments/{environmentId}/values"
localVarPath = strings.Replace(localVarPath, "{"+"configId"+"}", url.PathEscape(parameterValueToString(r.configId, "configId")), -1)
localVarPath = strings.Replace(localVarPath, "{"+"environmentId"+"}", url.PathEscape(parameterValueToString(r.environmentId, "environmentId")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.updateSettingValuesWithIdModel == nil {
return localVarReturnValue, nil, reportError("updateSettingValuesWithIdModel is required and must be specified")
}
if r.reason != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "reason", r.reason, "form", "")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{"application/json", "text/json", "application/*+json"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
localVarPostBody = r.updateSettingValuesWithIdModel
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type FeatureFlagSettingValuesAPIReplaceSettingValueRequest struct {
ctx context.Context
ApiService *FeatureFlagSettingValuesAPIService
environmentId string
settingId int32
updateSettingValueModel *UpdateSettingValueModel
reason *string
}
func (r FeatureFlagSettingValuesAPIReplaceSettingValueRequest) UpdateSettingValueModel(updateSettingValueModel UpdateSettingValueModel) FeatureFlagSettingValuesAPIReplaceSettingValueRequest {
r.updateSettingValueModel = &updateSettingValueModel
return r
}
// The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on.
func (r FeatureFlagSettingValuesAPIReplaceSettingValueRequest) Reason(reason string) FeatureFlagSettingValuesAPIReplaceSettingValueRequest {
r.reason = &reason
return r
}
func (r FeatureFlagSettingValuesAPIReplaceSettingValueRequest) Execute() (*SettingValueModel, *http.Response, error) {
return r.ApiService.ReplaceSettingValueExecute(r)
}
/*
ReplaceSettingValue Replace value
This endpoint replaces the whole value of a Feature Flag or Setting in a specified Environment.
Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint.
**Important:** As this endpoint is doing a complete replace, it's important to set every other attribute that you don't
want to change in its original state. Not listing one means it will reset.
For example: We have the following resource.
```json
{
"rolloutPercentageItems": [
{
"percentage": 30,
"value": true
},
{
"percentage": 70,
"value": false
}
],
"rolloutRules": [],
"value": false
}
```
If we send a replace request body as below:
```json
{
"value": true
}
```
Then besides that the default value is set to `true`, all the Percentage Rules are deleted.
So we get a response like this:
```json
{
"rolloutPercentageItems": [],
"rolloutRules": [],
"value": true
}
```
The `rolloutRules` property describes two types of rules:
- **Targeting rules**: When you want to add or update a targeting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required.
- **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param environmentId The identifier of the Environment.
@param settingId The id of the Setting.
@return FeatureFlagSettingValuesAPIReplaceSettingValueRequest
*/
func (a *FeatureFlagSettingValuesAPIService) ReplaceSettingValue(ctx context.Context, environmentId string, settingId int32) FeatureFlagSettingValuesAPIReplaceSettingValueRequest {
return FeatureFlagSettingValuesAPIReplaceSettingValueRequest{
ApiService: a,
ctx: ctx,
environmentId: environmentId,
settingId: settingId,
}
}
// Execute executes the request
// @return SettingValueModel
func (a *FeatureFlagSettingValuesAPIService) ReplaceSettingValueExecute(r FeatureFlagSettingValuesAPIReplaceSettingValueRequest) (*SettingValueModel, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPut
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *SettingValueModel
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FeatureFlagSettingValuesAPIService.ReplaceSettingValue")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/environments/{environmentId}/settings/{settingId}/value"
localVarPath = strings.Replace(localVarPath, "{"+"environmentId"+"}", url.PathEscape(parameterValueToString(r.environmentId, "environmentId")), -1)
localVarPath = strings.Replace(localVarPath, "{"+"settingId"+"}", url.PathEscape(parameterValueToString(r.settingId, "settingId")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.updateSettingValueModel == nil {
return localVarReturnValue, nil, reportError("updateSettingValueModel is required and must be specified")
}
if r.reason != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "reason", r.reason, "form", "")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{"application/json", "text/json", "application/*+json"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
localVarPostBody = r.updateSettingValueModel
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type FeatureFlagSettingValuesAPIUpdateSettingValueRequest struct {
ctx context.Context
ApiService *FeatureFlagSettingValuesAPIService
environmentId string
settingId int32
jsonPatchOperation *[]JsonPatchOperation
reason *string
}
func (r FeatureFlagSettingValuesAPIUpdateSettingValueRequest) JsonPatchOperation(jsonPatchOperation []JsonPatchOperation) FeatureFlagSettingValuesAPIUpdateSettingValueRequest {
r.jsonPatchOperation = &jsonPatchOperation
return r
}
// The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on.
func (r FeatureFlagSettingValuesAPIUpdateSettingValueRequest) Reason(reason string) FeatureFlagSettingValuesAPIUpdateSettingValueRequest {
r.reason = &reason
return r
}
func (r FeatureFlagSettingValuesAPIUpdateSettingValueRequest) Execute() (*SettingValueModel, *http.Response, error) {
return r.ApiService.UpdateSettingValueExecute(r)
}
/*
UpdateSettingValue Update value
This endpoint updates the value of a Feature Flag or Setting
with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Environment.
Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint.
The advantage of using JSON Patch is that you can describe individual update operations on a resource
without touching attributes that you don't want to change. It supports collection reordering, so it also
can be used for reordering the targeting rules of a Feature Flag or Setting.
For example: We have the following resource.
```json
{
"rolloutPercentageItems": [
{
"percentage": 30,
"value": true
},
{
"percentage": 70,
"value": false
}
],
"rolloutRules": [],
"value": false
}
```
If we send an update request body as below:
```json
[
{
"op": "replace",
"path": "/value",
"value": true
}
]
```
Only the default value is going to be set to `true` and all the Percentage Rules are remaining unchanged.
So we get a response like this:
```json
{
"rolloutPercentageItems": [
{
"percentage": 30,
"value": true
},
{
"percentage": 70,
"value": false
}
],
"rolloutRules": [],
"value": true
}
```
The `rolloutRules` property describes two types of rules:
- **Targeting rules**: When you want to add or update a targeting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required.
- **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param environmentId The identifier of the Environment.
@param settingId The id of the Setting.
@return FeatureFlagSettingValuesAPIUpdateSettingValueRequest
*/
func (a *FeatureFlagSettingValuesAPIService) UpdateSettingValue(ctx context.Context, environmentId string, settingId int32) FeatureFlagSettingValuesAPIUpdateSettingValueRequest {
return FeatureFlagSettingValuesAPIUpdateSettingValueRequest{
ApiService: a,
ctx: ctx,
environmentId: environmentId,
settingId: settingId,
}
}
// Execute executes the request
// @return SettingValueModel
func (a *FeatureFlagSettingValuesAPIService) UpdateSettingValueExecute(r FeatureFlagSettingValuesAPIUpdateSettingValueRequest) (*SettingValueModel, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPatch
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *SettingValueModel
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FeatureFlagSettingValuesAPIService.UpdateSettingValue")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/v1/environments/{environmentId}/settings/{settingId}/value"
localVarPath = strings.Replace(localVarPath, "{"+"environmentId"+"}", url.PathEscape(parameterValueToString(r.environmentId, "environmentId")), -1)
localVarPath = strings.Replace(localVarPath, "{"+"settingId"+"}", url.PathEscape(parameterValueToString(r.settingId, "settingId")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.jsonPatchOperation == nil {
return localVarReturnValue, nil, reportError("jsonPatchOperation is required and must be specified")
}
if r.reason != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "reason", r.reason, "form", "")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{"application/json", "text/json", "application/*+json"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
localVarPostBody = r.jsonPatchOperation
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}