Skip to content

Commit ab070f6

Browse files
authored
Merge pull request #353 from Yelp/add-maxBatchSize-to-schema
Add missing maxBatchSize field in schema
2 parents 8b894e8 + 6ef0034 commit ab070f6

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

API_DOCS.md

+1
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,7 @@ resources:
155155
isBatchKeyASet: ?boolean (can only use if isBatchResource=true)
156156
propertyBatchKey: ?string (can only use if isBatchResource=true)
157157
responseKey: ?string (non-optional when propertyBatchKey is used)
158+
maxBatchSize: ?integer (can only use if isBatchResource=true)
158159
159160
typings:
160161
language: flow

schema.json

+4
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,10 @@
105105
"responseKey": {
106106
"type": "string",
107107
"description": "(Non-optional when propertyBatchKey is used) The key in the response objects corresponds to `batchKey`. This should be the only field that are marked as required in your swagger endpoint response, except nestedPath."
108+
},
109+
"maxBatchSize": {
110+
"type": "integer",
111+
"description": "(Optional) Limits the number of items that can be batched together in a single request. When more items are requested than this limit, multiple requests will be made. This can help prevent hitting URI length limits or timeouts for large batches."
108112
}
109113
},
110114
"dependencies": {

0 commit comments

Comments
 (0)