From 071237ede8ba100fae129e7f98603b5595e19d02 Mon Sep 17 00:00:00 2001 From: frances elliott Date: Fri, 27 Mar 2020 16:40:12 -0600 Subject: [PATCH 1/3] docs edits --- api/openapi-spec/openapi.yaml | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/api/openapi-spec/openapi.yaml b/api/openapi-spec/openapi.yaml index 9790b4af..d1814651 100644 --- a/api/openapi-spec/openapi.yaml +++ b/api/openapi-spec/openapi.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: title: Optimizely Agent API - description: Optimizely Agent - Full Stack REST 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 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. termsOfService: http://optimizely.com/terms/ license: name: Apache 2.0 @@ -13,7 +13,7 @@ security: paths: /v1/config: get: - summary: Return the Optimizely Config for the given environment + summary: Return the Optimizely config for the given environment operationId: getConfig description: Return all available experiment and features definitions for this environment. responses: @@ -34,7 +34,7 @@ paths: post: summary: Track event for the given user. operationId: trackEvent - description: Track sends event and user details to Optimizely’s analytics backend for the analysis of a feature test or experiment. + 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. responses: '204': description: No content, event received @@ -56,10 +56,10 @@ paths: post: summary: Activate selected features and experiments for the given user. operationId: activate - description: Activate iterates over all corresponding features - and experiments and returns the decision for the given user. - Optionally an impression event will sent to the Optimizely analytics backend - for any decision made for and experiment or feature test. + 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 wraps up key functionality from + the Full Stack SDKs into one convenient call. responses: '200': description: Valid response @@ -81,9 +81,8 @@ paths: post: summary: Override an experiment decision for a user operationId: override - description: Override a experiment or feature test decision used in future user based decisions. This override is only stored locally - in memory for debugging and testing purposes and should not be used - for production overrides. + description: For debugging or testing, override an experiment and variation decision for a given user in local memory only. + Do not use this endpoint for production overrides. responses: '200': description: Valid response @@ -105,7 +104,7 @@ paths: post: summary: Get JWT token to authenticate all requests. operationId: getToken - 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. + 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. FE QUESTION - don't quite get this, where are you configuring expiration/sdk? is it reflected in the datafile? Is "Optimizely config" endpoint a subset of the datafile, or the datafile itself...? responses: '200': description: Generates a valid token From d4d0821ed151e637aa37fab1b94beac5c2570ee1 Mon Sep 17 00:00:00 2001 From: frances elliott Date: Mon, 30 Mar 2020 14:44:51 -0600 Subject: [PATCH 2/3] docs edits roughly done --- api/openapi-spec/openapi.yaml | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/api/openapi-spec/openapi.yaml b/api/openapi-spec/openapi.yaml index d1814651..d749c9b9 100644 --- a/api/openapi-spec/openapi.yaml +++ b/api/openapi-spec/openapi.yaml @@ -56,10 +56,7 @@ paths: post: summary: Activate selected features and experiments for the given user. operationId: activate - 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 wraps up key functionality from - the Full Stack SDKs into one convenient call. + 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. responses: '200': description: Valid response @@ -81,8 +78,7 @@ paths: post: summary: Override an experiment decision for a user operationId: override - description: For debugging or testing, override an experiment and variation decision for a given user in local memory only. - Do not use this endpoint for production overrides. + 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. responses: '200': description: Valid response @@ -104,7 +100,7 @@ paths: post: summary: Get JWT token to authenticate all requests. operationId: getToken - 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. FE QUESTION - don't quite get this, where are you configuring expiration/sdk? is it reflected in the datafile? Is "Optimizely config" endpoint a subset of the datafile, or the datafile itself...? + 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. responses: '200': description: Generates a valid token @@ -119,7 +115,7 @@ components: in: query name: disableTracking required: false - description: Setting to true will disable impression tracking for ab experiments and feature tests. + description: Setting to true will disable impression tracking for experiments. schema: type: boolean enabledParam: From 9a96724d6c80aa13f64736656950e2efa1386aae Mon Sep 17 00:00:00 2001 From: fscelliott <42477011+fscelliott@users.noreply.github.com> Date: Fri, 10 Apr 2020 10:04:31 -0600 Subject: [PATCH 3/3] Update api/openapi-spec/openapi.yaml Co-Authored-By: JC <40373238+juancarlostong@users.noreply.github.com> --- api/openapi-spec/openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api/openapi-spec/openapi.yaml b/api/openapi-spec/openapi.yaml index d749c9b9..b26000ab 100644 --- a/api/openapi-spec/openapi.yaml +++ b/api/openapi-spec/openapi.yaml @@ -78,7 +78,7 @@ paths: post: summary: Override an experiment decision for a user operationId: override - 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. + 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. responses: '200': description: Valid response