Add docs for the amazon event stream format #2510
Open
Conversation
This file contains 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
|
Documentation Check is failing!? |
This adds documentation for the `application/vnd.amazon.eventstream` wire format as well as the common protocol semanitcs that are layered on top of it. It does NOT provide tests. Event stream protocol tests are in the works, but are not yet available.
JordonPhillips
force-pushed
the
aws-event-stream-wire-format
branch
from
a920859 to
d39c2d8
Compare
kstich
requested changes
Feb 6, 2025
hpmellema
reviewed
Feb 6, 2025
| This specification describes the ``application/vnd.amazon.eventstream`` | ||
| :ref:`event stream <event-streams>` encoding, a generic data encoding designed | ||
| to support bidirectional datagram-oriented communication on top of an existing, | ||
| reliable, stream-oriented protocol. This is the encoding used by AWS services, |
There was a problem hiding this comment.
Suggested change
| reliable, stream-oriented protocol. This is the encoding used by AWS services, | |
| stream-oriented protocol. This is the encoding used by AWS services, |
There was a problem hiding this comment.
Why remove this? Reliability is important because these are intended to be sent in sequence. In fact, event signing relies on you chaining signatures. (I've not included signing here yet)
| extended to support them: | ||
|
|
||
| * Message fragmentation, or streaming a single payload as multiple messages. | ||
| * Relaying events over an unordered, unreliable transport such as UDP. |
There was a problem hiding this comment.
Suggested change
| * Relaying events over an unordered, unreliable transport such as UDP. | |
| * Relaying events over an unordered transport such as UDP. |
|
|
||
| The ``application/vnd.amazon.eventstream`` wire format is a generic encoding. | ||
| There are additional semantic requirements when using this format with AWS | ||
| protocols. Events are categorized into one of five categories: message events, |
There was a problem hiding this comment.
Suggestion: break out into list with links and abbreviated description.
There was a problem hiding this comment.
The list is the sections below
This adds more narrative information about amazon event stream header layouts, including a diagram taken from Transcribe's docs.
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.
This adds documentation for the
application/vnd.amazon.eventstreamwire format as well as the common protocol semanitcs that are layered on top of it.It does NOT provide tests. Event stream protocol tests are in the works, but are not yet available.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.