Skip to content

Commit 6878fef

Browse files
authored
adding more descriptions (#281)
* adding more descriptions * fixed activate->post
1 parent b682d80 commit 6878fef

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

api/openapi-spec/openapi.yaml

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -373,6 +373,7 @@ components:
373373
BatchContext:
374374
properties:
375375
operations:
376+
description: Array of requests to Agent endpoints, batched into one request
376377
type: array
377378
items:
378379
$ref: '#/components/schemas/BatchOperation'
@@ -382,27 +383,37 @@ components:
382383
BatchOperation:
383384
properties:
384385
method:
386+
description: The REST request method
385387
type: string
386388
enum:
387389
- GET
388390
- POST
389391
url:
392+
description: The base and endpoint components of the API request's path
390393
type: string
391-
operationID:
394+
operationID:
395+
description: Index of the request in the batch
392396
type: string
393397
body:
398+
description: The body for the request as JSON
394399
type: object
395400
parameters:
401+
description: The parameters for the request as JSON
396402
type: object
397403
headers:
404+
description: The headers for the request as JSON
398405
type: object
399406
example:
400-
method: "GET"
401-
url: "/v1/config"
407+
method: "POST"
408+
url: "/v1/activate"
402409
operationID: 1
403-
body: {}
404-
parameters: {}
405-
headers: {"X-Optimizely-SDK-Key": "<sdk_key>"}
410+
body: {"userId": "user1"}
411+
parameters: {
412+
"type": "feature",
413+
"experimentKey": "ab_test_experiment"}
414+
headers: {
415+
"X-Optimizely-SDK-Key": "<sdk_key>",
416+
"Content-Type": "application/json"}
406417

407418
BatchResponse:
408419
properties:

0 commit comments

Comments
 (0)