Skip to content

Add missing maxBatchSize field in schema #353

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
May 7, 2025
Merged
Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions API_DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down