Skip to content

Add docs for the amazon event stream format#2510

Merged
JordonPhillips merged 1 commit intomainfrom
aws-event-stream-wire-format
Feb 26, 2025
Merged

Add docs for the amazon event stream format#2510
JordonPhillips merged 1 commit intomainfrom
aws-event-stream-wire-format

Conversation

@JordonPhillips
Copy link
Contributor

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.


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@JordonPhillips JordonPhillips requested a review from a team as a code owner February 6, 2025 16:40
@yasmewad
Copy link
Contributor

yasmewad commented Feb 6, 2025

Documentation Check is failing!?
/home/runner/work/smithy/smithy/docs/source-2.0/aws/amazon-eventstream.rst:50: WARNING: undefined label: '_amazon-eventstream-headers-format'

@JordonPhillips JordonPhillips force-pushed the aws-event-stream-wire-format branch from a920859 to d39c2d8 Compare February 6, 2025 16:54
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 JordonPhillips force-pushed the aws-event-stream-wire-format branch from 1497b8d to abbeb6f Compare February 26, 2025 11:40
@JordonPhillips JordonPhillips merged commit 328c7d3 into main Feb 26, 2025
8 checks passed
@JordonPhillips JordonPhillips deleted the aws-event-stream-wire-format branch February 26, 2025 18:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants