-
Notifications
You must be signed in to change notification settings - Fork 26
/
openapi.yaml
1030 lines (1030 loc) · 28.7 KB
/
openapi.yaml
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
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.1.0
info:
title: Optimizely Agent API
description: Optimizely Agent is a stand-alone, open-source microservice that provides major benefits over using Optimizely SDKs in certain use cases. Its REST API offers consolidated and simplified endpoints for accessing all the functionality of Optimizely Feature Experimentation SDKs. Use this API the control experiments (such as a feature tests). For more info, see https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/optimizely-agent
termsOfService: https://www.optimizely.com/legal/terms/
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: '0.12.0'
paths:
/v1/config:
get:
summary: Return the Optimizely config for the given environment
description: Return all available experiment and features definitions for this environment.
operationId: getConfig
responses:
'200':
description: Valid response
content:
application/json:
schema:
$ref: '#/components/schemas/OptimizelyConfig'
'401':
description: Unauthorized, invalid JWT
content:
application/json: {}
'403':
description: You do not have necessary permissions for the resource
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
deprecated: false
/v1/datafile:
get:
summary: Return the datafile for the given environment. If you need strict consistency, you can pass the datafile to other Optimizely instances. so that all initialize from exactly the same datafile version (rather than each fetching the datafile separately from the Optimizely CDN).
description: Returns the json datafile for the given environment.
operationId: getDatafile
responses:
'200':
description: Valid response
content:
application/json:
schema:
type: object
description: Optimizely Datafile
contentMediaType: application/json
'401':
description: Unauthorized, invalid JWT
content:
application/json: {}
'403':
description: You do not have necessary permissions for the resource
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
deprecated: false
/v1/decide:
post:
summary: Decide makes feature decisions for the selected query parameters.
description: Returns decision results for flag keys for a user. The result for a single key is returned as an OptimizelyDecision object whereas the result for multiple keys is returned as an array of OptimizelyDecision objects. If no flag key is provided, decision is made for all flag keys. OptimizelyDecision object contains all data required to deliver the flag rule.
operationId: decide
parameters:
- name: keys
in: query
description: Flag keys for decision
style: form
explode: true
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/DecideContext'
required: true
responses:
'200':
description: Valid response
content:
application/json:
schema:
oneOf:
- type: array
items:
$ref: '#/components/schemas/OptimizelyDecision'
- $ref: '#/components/schemas/OptimizelyDecision'
contentMediaType: application/json
'400':
description: Missing required parameters
content:
application/json: {}
'401':
description: Unauthorized, invalid JWT
content:
application/json: {}
'403':
description: You do not have necessary permissions for the resource
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Failed to fetch qualified segments
content:
application/json: {}
deprecated: false
/v1/lookup:
post:
summary: Lookup returns saved user profile.
description: Returns the saved user profile for a user.
operationId: lookup
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/LookupContext'
required: true
responses:
'200':
description: Valid response
content:
application/json:
schema:
$ref: '#/components/schemas/UserProfile'
'400':
description: Missing required parameters
content:
application/json: {}
'401':
description: Unauthorized, invalid JWT
content:
application/json: {}
'403':
description: You do not have necessary permissions for the resource
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: User Profile Service not found
content:
application/json: {}
deprecated: false
/v1/save:
post:
summary: Save saves user profile.
description: Saves user profile for a user.
operationId: save
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SaveContext'
required: true
responses:
'200':
description: Valid response, Profile saved.
'400':
description: Missing required parameters
'401':
description: Unauthorized, invalid JWT
'403':
description: You do not have necessary permissions for the resource
content:
application/json:
schema:
$ref: '#/components/responses/Forbidden'
'500':
description: User Profile Service not found
deprecated: false
/v1/track:
post:
summary: Track event for the given user.
description: Send event and user details to Optimizely analytics backend, so you can see metrics for an experiment. You can view metrics either on your Results page or as a data export.
operationId: trackEvent
parameters:
- name: eventKey
in: query
description: Key of the event we're tracking
required: true
style: form
explode: true
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/TrackContext'
required: true
responses:
'200':
description: Valid response, event received
content:
application/json: {}
'400':
description: Missing required parameters
content:
application/json: {}
'401':
description: Unauthorized, invalid JWT
content:
application/json: {}
'403':
description: You do not have necessary permissions for the resource
content:
application/json:
schema:
$ref: '#/components/responses/Forbidden'
deprecated: false
/v1/send-odp-event:
post:
summary: Send event to Optimizely Data Platform (ODP).
description: Send ODP event to Optimizely Data Platform. Clients can send arbitrary events to the ODP server. For instance, they can bind an email to the FS userId via this API.
operationId: sendOdpEvent
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SendOdpEventContext'
required: true
responses:
'200':
description: Valid response, event received
content:
application/json: {}
'400':
description: Missing required parameters
content:
application/json: {}
'401':
description: Unauthorized, invalid JWT
content:
application/json: {}
'403':
description: You do not have necessary permissions for the resource
content:
application/json:
schema:
$ref: '#/components/responses/Forbidden'
'500':
description: Failed to send odp event
content:
application/json: {}
deprecated: false
/v1/activate:
post:
summary: Activate selected features and experiments for the given user.
description: Returns Optimizely's decision about which features and experiments a given user is exposed to. Optionally sends an impression event to the Optimizely analytics backend for any decision made for an experiment. This endpoint consolidates key functionality from the Feature Experimentation SDKs into one convenient call.
operationId: activate
parameters:
- name: featureKey
in: query
description: Key for the Optimizely Feature
style: form
explode: true
schema:
type: array
items:
type: string
- name: experimentKey
in: query
description: Key for the Optimizely Experiment
style: form
explode: true
schema:
type: array
items:
type: string
- name: disableTracking
in: query
description: Setting to true will disable impression tracking for experiments.
style: form
explode: true
schema:
type: boolean
- name: type
in: query
description: Limit the decisions to either experiment or features
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/Type'
- description: Limit the decisions to either experiment or features
- name: enabled
in: query
description: Filter the activation response to return only enabled decisions.
style: form
explode: true
schema:
type: boolean
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ActivateContext'
required: true
responses:
'200':
description: Valid response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Decision'
description: ''
contentMediaType: application/json
'400':
description: Bad request, invalid parameters
content:
application/json: {}
'401':
description: Unauthorized, invalid JWT
content:
application/json: {}
'403':
description: You do not have necessary permissions for the resource
content:
application/json:
schema:
$ref: '#/components/responses/Forbidden'
deprecated: false
/v1/override:
post:
summary: Override an experiment decision for a user
description: For debugging or testing. Overrides an experiment and variation decision for a given user, in local memory only. Do not use this endpoint for production overrides.
operationId: override
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/OverrideContext'
required: true
responses:
'200':
description: Valid response
content:
application/json:
schema:
type: object
items:
$ref: '#/components/schemas/Override'
description: ''
contentMediaType: application/json
'400':
description: Invalid payload
content:
application/json: {}
'401':
description: Unauthorized, invalid JWT
content:
application/json: {}
'403':
description: You do not have necessary permissions for the resource
content:
application/json:
schema:
$ref: '#/components/responses/Forbidden'
deprecated: false
/oauth/token:
post:
summary: Get JWT token to authenticate all requests.
description: Generates valid JWT token for grant_type, client_id, and client_secret, using the values you pass in the request body. Configure expiration time and SDK keys (to which the token grants access) in Optimizely config.
operationId: getToken
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/TokenContext'
required: true
responses:
'200':
description: Generates a valid token
content:
application/json: {}
'401':
description: Unable to match credentials
content:
application/json:
schema:
$ref: '#/components/schemas/TokenError'
deprecated: false
/v1/batch:
post:
summary: Batch multiple API endpoints into one request.
description: "You can use the Batch endpoint to do things like \n1. Make activate decisions for a batch of users in a short timeframe for testing purposes\n2. Gather responses from a bunch of activate calls into one response for comparison or analysis\n"
operationId: BatchmultipleAPIendpointsintoonerequest.
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BatchContext'
required: true
responses:
'200':
description: responses for each endpoint called in the batch request
content:
application/json:
schema:
$ref: '#/components/schemas/BatchResponse'
'400':
description: Bad request, invalid parameters.
content:
application/json: {}
'422':
description: Unprocessable Entity, too many operations
content:
application/json: {}
deprecated: false
components:
requestBodies:
ActivateContext:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ActivateContext'
OverrideContext:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/OverrideContext'
TrackContext:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TrackContext'
SendOdpEventContext:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SendOdpEventContext'
LookupContext:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LookupContext'
SaveContext:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SaveContext'
DecideContext:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DecideContext'
TokenContext:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TokenContext'
BatchContext:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BatchContext'
responses:
Forbidden:
description: You do not have necessary permissions for the resource
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
UnauthorizedToken:
description: Unable to match credentials
content:
application/json:
schema:
$ref: '#/components/schemas/TokenError'
BatchResponse:
description: responses for each endpoint called in the batch request
content:
application/json:
schema:
$ref: '#/components/schemas/BatchResponse'
schemas:
Error:
title: Error
type: object
properties:
error:
type: string
TokenError:
title: TokenError
type: object
properties:
error:
type: string
error_description:
type: string
OptimizelyExperiment:
title: OptimizelyExperiment
required:
- id
- key
type: object
properties:
id:
type: string
key:
type: string
audiences:
type: string
variationsMap:
type: object
additionalProperties:
$ref: '#/components/schemas/OptimizelyVariation'
OptimizelyAttribute:
title: OptimizelyAttribute
type: object
properties:
id:
type: string
key:
type: string
OptimizelyAudience:
title: OptimizelyAudience
type: object
properties:
id:
type: string
name:
type: string
conditions:
type: string
OptimizelyEvent:
title: OptimizelyEvent
type: object
properties:
id:
type: string
key:
type: string
experimentIds:
type: array
items:
type: string
description: ''
OptimizelyFeature:
title: OptimizelyFeature
required:
- id
- key
type: object
properties:
id:
type: string
key:
type: string
experimentRules:
type: array
items:
$ref: '#/components/schemas/OptimizelyExperiment'
description: ''
deliveryRules:
type: array
items:
$ref: '#/components/schemas/OptimizelyExperiment'
description: ''
variablesMap:
type: object
additionalProperties:
$ref: '#/components/schemas/OptimizelyVariable'
experimentsMap:
type: object
additionalProperties:
$ref: '#/components/schemas/OptimizelyExperiment'
UserProfile:
title: UserProfile
type: object
properties:
experimentBucketMap:
$ref: '#/components/schemas/ExperimentBucketMap'
userId:
type: string
Decision:
title: Decision
type: object
properties:
featureKey:
type: string
experimentKey:
type: string
variationKey:
type: string
type:
$ref: '#/components/schemas/Type'
enabled:
type: boolean
variables:
type: object
error:
type: string
OptimizelyDecision:
title: OptimizelyDecision
required:
- ruleKey
- flagKey
- userContext
type: object
properties:
variables:
type: object
variationKey:
type: string
enabled:
type: boolean
ruleKey:
type: string
flagKey:
type: string
userContext:
$ref: '#/components/schemas/UserContext'
reasons:
type: array
items:
type: string
description: ''
ActivateContext:
title: ActivateContext
type: object
properties:
userId:
type: string
userAttributes:
type: object
Override:
title: Override
type: object
properties:
userId:
type: string
experimentKey:
type: string
variationKey:
type: string
prevVariationKey:
type: string
messages:
type: array
items:
type: string
description: ''
OverrideContext:
title: OverrideContext
type: object
properties:
userId:
type: string
experimentKey:
type: string
variationKey:
type: string
OptimizelyConfig:
title: OptimizelyConfig
type: object
properties:
environmentKey:
type: string
sdkKey:
type: string
revision:
type: string
experimentsMap:
type: object
additionalProperties:
$ref: '#/components/schemas/OptimizelyExperiment'
featuresMap:
type: object
additionalProperties:
$ref: '#/components/schemas/OptimizelyFeature'
attributes:
type: array
items:
$ref: '#/components/schemas/OptimizelyAttribute'
description: ''
audiences:
type: array
items:
$ref: '#/components/schemas/OptimizelyAudience'
description: ''
events:
type: array
items:
$ref: '#/components/schemas/OptimizelyEvent'
description: ''
TrackContext:
title: TrackContext
type: object
properties:
eventTags:
type: object
userId:
type: string
userAttributes:
type: object
SendOdpEventContext:
title: SendOdpEventContext
required:
- action
- identifiers
type: object
properties:
action:
type: string
type:
type: string
identifiers:
type: object
additionalProperties:
type: string
data:
type: object
additionalProperties:
oneOf:
- type: string
- type: integer
format: int32
- type: number
- type: boolean
LookupContext:
title: LookupContext
required:
- userId
type: object
properties:
userId:
type: string
SaveContext:
title: SaveContext
type: object
properties:
experimentBucketMap:
$ref: '#/components/schemas/ExperimentBucketMap'
userId:
type: string
DecideContext:
title: DecideContext
required:
- userId
type: object
properties:
decideOptions:
type: array
items:
$ref: '#/components/schemas/DecideOption'
description: ''
userId:
type: string
userAttributes:
type: object
forcedDecisions:
type: array
items:
$ref: '#/components/schemas/ForcedDecision'
description: ''
fetchSegments:
type: boolean
fetchSegmentsOptions:
type: array
items:
$ref: '#/components/schemas/FetchSegmentsOption'
description: ''
ForcedDecision:
title: ForcedDecision
required:
- flagKey
- variationKey
type: object
properties:
flagKey:
type: string
ruleKey:
type: string
variationKey:
type: string
OptimizelyVariation:
title: OptimizelyVariation
required:
- id
- key
type: object
properties:
id:
type: string
key:
type: string
featureEnabled:
type: boolean
variablesMap:
type: object
additionalProperties:
$ref: '#/components/schemas/OptimizelyVariable'
OptimizelyVariable:
title: OptimizelyVariable
required:
- id
- key
type: object
properties:
id:
type: string
key:
type: string
type:
type: string
value:
type: string
TokenContext:
title: TokenContext
type: object
properties:
grant_type:
type: string
client_id:
type: string
client_secret:
type: string
BatchContext:
title: BatchContext
required:
- operations
type: object
properties:
operations:
type: array
items:
$ref: '#/components/schemas/BatchOperation'
description: Array of requests to Agent endpoints, batched into one request
BatchOperation:
title: BatchOperation
type: object
properties:
method:
allOf:
- $ref: '#/components/schemas/Method'
- description: The REST request method
url:
type: string
description: The base and endpoint components of the API request's path
operationID:
type: string
description: Index of the request in the batch
body:
type: object
description: The body for the request as JSON
parameters:
type: object
description: The parameters for the request as JSON
headers:
type: object
description: The headers for the request as JSON
examples:
- method: POST
url: /v1/activate
operationID: '1'
body:
userId: user1
parameters:
type: feature
experimentKey: ab_test_experiment
headers:
X-Optimizely-SDK-Key: <sdk_key>
Content-Type: application/json
BatchResponse:
title: BatchResponse
type: object
properties:
startedAt:
type: string
endedAt:
type: string
errorCount:
type: integer
contentEncoding: int32
response:
type: array
items:
$ref: '#/components/schemas/BatchResponseItem'
description: ''
BatchResponseItem:
title: BatchResponseItem
type: object
properties:
status:
$ref: '#/components/schemas/Status'
requestID:
type: string
operationID:
type: string
method:
$ref: '#/components/schemas/Method1'
url:
type: string
body:
oneOf:
- type: array
items:
type: object
- type: object
startedAt:
type: string
endedAt:
type: string
examples:
- status: 200
requestID: abee6bdf-6d14-4fac-8357-769f5fd07e7c
operationID: '1'
method: POST
url: /v1/activate
body:
- enabled: true
experimentKey: new_feature_test
featureKey: new_feature
type: feature
userId: user1
variables:
bool_var: true
double_var: 5.6
int_var: 1
variationKey: variation_2
- enabled: false
experimentKey: flag_test_2
featureKey: test_feature
type: feature
userId: user1
variables:
double: 0
json_key: {}
variationKey: ""
startedAt: 2020-09-10T10:50:37.466121-07:00
endedAt: 2020-09-10T10:50:37.466192-07:00
DecideOption:
title: DecideOption
enum:
- DISABLE_DECISION_EVENT
- ENABLED_FLAGS_ONLY
- IGNORE_USER_PROFILE_SERVICE
- EXCLUDE_VARIABLES
- INCLUDE_REASONS
type: string
ExperimentBucketMap:
title: ExperimentBucketMap
type: object
properties:
your_experiment_id:
$ref: '#/components/schemas/YourExperimentId'
FetchSegmentsOption:
title: FetchSegmentsOption
enum:
- IGNORE_CACHE
- RESET_CACHE
type: string
Method:
title: Method
enum:
- GET
- POST
type: string
description: The REST request method
Method1:
title: Method1
enum:
- GET
- POST
type: string
Status:
title: Status
enum:
- 200
- 400
type: integer
Type:
title: Type
enum:
- feature
- experiment
- ""