diff --git a/API_DOCS.md b/API_DOCS.md index 03d5a4f..a2860b1 100644 --- a/API_DOCS.md +++ b/API_DOCS.md @@ -155,6 +155,7 @@ resources: isBatchKeyASet: ?boolean (can only use if isBatchResource=true) propertyBatchKey: ?string (can only use if isBatchResource=true) responseKey: ?string (non-optional when propertyBatchKey is used) + maxBatchSize: ?integer (can only use if isBatchResource=true) typings: language: flow diff --git a/schema.json b/schema.json index d8e834e..54cdfa1 100644 --- a/schema.json +++ b/schema.json @@ -105,6 +105,10 @@ "responseKey": { "type": "string", "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." + }, + "maxBatchSize": { + "type": "integer", + "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." } }, "dependencies": {