Skip to content

Commit

Permalink
address comment
Browse files Browse the repository at this point in the history
  • Loading branch information
hihihuhu committed Apr 17, 2024
1 parent bd86c14 commit 4d4e7a4
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2424,10 +2424,12 @@ paths:
required: false
schema:
type: string
description: Identifier for the last batch from the previous pagination request.
description: &pagination_after_param_description |
A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
- name: limit
in: query
description: Number of batches to retrieve.
description: &pagination_limit_param_description |
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
required: false
schema:
type: integer
Expand All @@ -2449,7 +2451,7 @@ paths:
curl https://api.openai.com/v1/batches?limit=2 \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-H "Content-Type: application/json"
response: &batch_object |
response:
{
"object": "list",
"data": [
Expand Down Expand Up @@ -2484,6 +2486,8 @@ paths:
},
{ ... },
],
"first_id": "batch_abc123",
"last_id": "batch_abc456",
"has_more": true
}

Expand Down Expand Up @@ -2878,8 +2882,7 @@ paths:
parameters:
- name: limit
in: query
description: &pagination_limit_param_description |
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
description: *pagination_limit_param_description
required: false
schema:
type: integer
Expand All @@ -2894,8 +2897,7 @@ paths:
enum: ["asc", "desc"]
- name: after
in: query
description: &pagination_after_param_description |
A cursor for use in pagination. `after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
description: *pagination_after_param_description
schema:
type: string
- name: before
Expand Down Expand Up @@ -11615,6 +11617,12 @@ components:
type: array
items:
$ref: "#/components/schemas/Batch"
first_id:
type: string
example: "batch_abc123"
last_id:
type: string
example: "batch_abc456"
has_more:
type: boolean
object:
Expand Down

0 comments on commit 4d4e7a4

Please sign in to comment.