Skip to content

Commit 0f1e002

Browse files
Docs api (#208)
* docs edits * docs edits roughly done * Update api/openapi-spec/openapi.yaml Co-Authored-By: JC <[email protected]> Co-authored-by: JC <[email protected]>
1 parent 3d88b65 commit 0f1e002

File tree

1 file changed

+7
-12
lines changed

1 file changed

+7
-12
lines changed

api/openapi-spec/openapi.yaml

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
openapi: 3.0.0
22
info:
33
title: Optimizely Agent API
4-
description: Optimizely Agent - Full Stack REST API
4+
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 Full Stack SDKs. Use this API the control experiments (such as a feature tests). For more info, see https://docs.developers.optimizely.com/full-stack/docs/optimizely-agent.
55
termsOfService: http://optimizely.com/terms/
66
license:
77
name: Apache 2.0
@@ -13,7 +13,7 @@ security:
1313
paths:
1414
/v1/config:
1515
get:
16-
summary: Return the Optimizely Config for the given environment
16+
summary: Return the Optimizely config for the given environment
1717
operationId: getConfig
1818
description: Return all available experiment and features definitions for this environment.
1919
responses:
@@ -34,7 +34,7 @@ paths:
3434
post:
3535
summary: Track event for the given user.
3636
operationId: trackEvent
37-
description: Track sends event and user details to Optimizely’s analytics backend for the analysis of a feature test or experiment.
37+
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.
3838
responses:
3939
'204':
4040
description: No content, event received
@@ -56,10 +56,7 @@ paths:
5656
post:
5757
summary: Activate selected features and experiments for the given user.
5858
operationId: activate
59-
description: Activate iterates over all corresponding features
60-
and experiments and returns the decision for the given user.
61-
Optionally an impression event will sent to the Optimizely analytics backend
62-
for any decision made for and experiment or feature test.
59+
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 Full Stack SDKs into one convenient call.
6360
responses:
6461
'200':
6562
description: Valid response
@@ -81,9 +78,7 @@ paths:
8178
post:
8279
summary: Override an experiment decision for a user
8380
operationId: override
84-
description: Override a experiment or feature test decision used in future user based decisions. This override is only stored locally
85-
in memory for debugging and testing purposes and should not be used
86-
for production overrides.
81+
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.
8782
responses:
8883
'200':
8984
description: Valid response
@@ -105,7 +100,7 @@ paths:
105100
post:
106101
summary: Get JWT token to authenticate all requests.
107102
operationId: getToken
108-
description: Generate JWT token for grant_type, client_id and client_secret. It matches the configured values and generates a valid token. Expiration time, and SDK keys to which the token grants access, are provided in configuration.
103+
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.
109104
responses:
110105
'200':
111106
description: Generates a valid token
@@ -120,7 +115,7 @@ components:
120115
in: query
121116
name: disableTracking
122117
required: false
123-
description: Setting to true will disable impression tracking for ab experiments and feature tests.
118+
description: Setting to true will disable impression tracking for experiments.
124119
schema:
125120
type: boolean
126121
enabledParam:

0 commit comments

Comments
 (0)