Clarify text on HTTP API batch endpoint limits #1042
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -33,7 +33,7 @@ There is no hard rate limit at which point Segment will drop your data. We ask t | |||
|
|
|||
| ## Max Request Size | |||
|
|
|||
| There is a maximum of `32KB` per call (our `batch` endpoint accepts a maximum of `500KB` per batch and `32KB` per call). Server-side, Segment's API will respond with `400 Bad Request` if these limits are exceeded. | |||
| There is a maximum of `32KB` per call (our `batch` endpoint accepts a maximum of `500KB` per batch and `32KB` per contained event). Server-side, Segment's API will respond with `400 Bad Request` if these limits are exceeded. | |||
There was a problem hiding this comment.
Change the first call to event too?
There was a problem hiding this comment.
We could. The first "per call" didn't bother me since the title is "max request size". Maybe "per request" would be even better? I'm thinking we should also change "per batch" to get consistency with the unit. Maybe something like:
There is a maximum of
32KBper request. The one exception is ourbatchendpoint which accepts a maximum of500KBper request with a limit of32KBper event in the batch. Server-side, Segment's API will respond with400 Bad Requestif these limits are exceeded.
Could probably be made more concise. WDYT?
There was a problem hiding this comment.
I like the proposed new wording with request.
erikdw
approved these changes
Aug 5, 2020
sanscontext
reviewed
Aug 5, 2020
src/connections/sources/catalog/libraries/server/http-api/index.md
Outdated
Show resolved
Hide resolved
…x.md Co-authored-by: LRubin <sanscontext@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
I was looking at the docs on the site, and I found the language on batch limits confusing since, by definition, the batch is a single call. This is my attempt to clarify, but I will happily accept other suggestions. 😄
Merge timing
No rush.
Related issues (optional)
n/a