Skip to content

Commit 6619a08

Browse files
committed
update swagger examples
1 parent 2f09120 commit 6619a08

1 file changed

Lines changed: 9 additions & 11 deletions

File tree

backend/packages/Upgrade/src/api/controllers/ExperimentClientController.v6.ts

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -865,22 +865,22 @@ export class ExperimentClientController {
865865
* description: The binary reward value indicating success or failure of the assigned condition
866866
* experimentId:
867867
* type: string
868-
* example: exp_adaptive_123
868+
* example: uuid-of-adaptive-experiment
869869
* description: The ID of the adaptive experiment. Required if context and decisionPoint are not provided.
870870
* context:
871871
* type: string
872-
* example: learning-module
872+
* example: upgrade-internal
873873
* description: The context for the decision point. Required with decisionPoint if experimentId is not provided.
874874
* decisionPoint:
875875
* type: object
876876
* properties:
877877
* site:
878878
* type: string
879-
* example: math-course
879+
* example: fakesite
880880
* description: The site of the decision point
881881
* target:
882882
* type: string
883-
* example: problem-set-1
883+
* example: faketarget
884884
* description: The target of the decision point
885885
* description: The decision point information. Required with context if experimentId is not provided.
886886
* description: Reward data for the adaptive experiment
@@ -890,16 +890,16 @@ export class ExperimentClientController {
890890
* description: Send reward using the experiment ID directly
891891
* value:
892892
* rewardValue: SUCCESS
893-
* experimentId: exp_adaptive_123
893+
* experimentId: uuid-of-adaptive-experiment
894894
* decision_point_lookup:
895895
* summary: Decision Point Lookup - Using context and decisionPoint
896896
* description: Send reward by identifying the experiment through decision point
897897
* value:
898898
* rewardValue: FAILURE
899-
* context: learning-module
899+
* context: upgrade-internal
900900
* decisionPoint:
901-
* site: math-course
902-
* target: problem-set-1
901+
* site: fakesite
902+
* target: faketarget
903903
* tags:
904904
* - Client Side SDK
905905
* produces:
@@ -939,10 +939,8 @@ export class ExperimentClientController {
939939
* description: BadRequestError - Invalid parameters (e.g., missing required fields, invalid rewardValue)
940940
* '401':
941941
* description: AuthorizationRequiredError
942-
* '404':
943-
* description: Experiment User not defined or experiment not found
944942
* '409':
945-
* description: Conflict - Data conflict (e.g., user not enrolled in experiment, experiment not in correct state)
943+
* description: Conflict - Data conflict (e.g., site or target not found, enrollment data not found, etc)
946944
* '500':
947945
* description: Internal Server Error
948946
*/

0 commit comments

Comments
 (0)