Skip to content

docs:adding more descriptions #281

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 22, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 17 additions & 6 deletions api/openapi-spec/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -373,6 +373,7 @@ components:
BatchContext:
properties:
operations:
description: Array of requests to Agent endpoints, batched into one request
type: array
items:
$ref: '#/components/schemas/BatchOperation'
Expand All @@ -382,27 +383,37 @@ components:
BatchOperation:
properties:
method:
description: The REST request method
type: string
enum:
- GET
- POST
url:
description: The base and endpoint components of the API request's path
type: string
operationID:
operationID:
description: Index of the request in the batch
type: string
body:
description: The body for the request as JSON
type: object
parameters:
description: The parameters for the request as JSON
type: object
headers:
description: The headers for the request as JSON
type: object
example:
method: "GET"
url: "/v1/config"
method: "POST"
url: "/v1/activate"
operationID: 1
body: {}
parameters: {}
headers: {"X-Optimizely-SDK-Key": "<sdk_key>"}
body: {"userId": "user1"}
parameters: {
"type": "feature",
"experimentKey": "ab_test_experiment"}
headers: {
"X-Optimizely-SDK-Key": "<sdk_key>",
"Content-Type": "application/json"}

BatchResponse:
properties:
Expand Down