Skip to content

Docs: Reference Handling of Custom Terminating Byte Sequences #625

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.

Sign up for GitHub

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 4 commits into from
Oct 3, 2024
Merged

Docs: Reference Handling of Custom Terminating Byte Sequences #625

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
03d8abc
docs: mention non-JSON terminating byte sequences in Useful-OpenAPI-p…
paulhdk Sep 17, 2024
9d536e4
Update doc comment in Sources/swift-openapi-generator/Documentation.d…
paulhdk Oct 3, 2024
a5cd6a0
Update doc comment in Sources/swift-openapi-generator/Documentation.d…
paulhdk Oct 3, 2024
55bc9c7
Merge branch 'main' into customisable-terminating-byte-sequence
paulhdk Oct 3, 2024
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
3 changes: 2 additions & 1 deletion .../swift-openapi-generator/Documentation.docc/Articles/Useful-OpenAPI-patterns.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,9 @@ The returned binary body contains the raw events, and the stream can be split up
- encode: `AsyncSequence<some Encodable>.asEncodedJSONSequence(encoder:)`
- Server-sent Events
- decode (if data is JSON): `AsyncSequence<ArraySlice<UInt8>>.asDecodedServerSentEventsWithJSONData(of:decoder:)`
- decode (if data is JSON with a non-JSON terminating byte sequence): `AsyncSequence<ArraySlice<UInt8>>.asDecodedServerSentEventsWithJSONData(of:decoder:while:)`
- encode (if data is JSON): `AsyncSequence<some Encodable>.asEncodedServerSentEventsWithJSONData(encoder:)`
- decode (for other data): `AsyncSequence<ArraySlice<UInt8>>.asDecodedServerSentEvents()`
- decode (for other data): `AsyncSequence<ArraySlice<UInt8>>.asDecodedServerSentEvents(while:)`
- encode (for other data): `AsyncSequence<some Encodable>.asEncodedServerSentEvents()`

See the `event-streams-*` client and server examples in <doc:Checking-out-an-example-project> to learn how to produce and consume these sequences.