Skip to content
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

Jump to bottom

Enveloped event payloads has content-type included twice #919

Closed
tomczoink opened this issue Jul 6, 2020 · 4 comments · Fixed by #929
Closed

Enveloped event payloads has content-type included twice #919

tomczoink opened this issue Jul 6, 2020 · 4 comments · Fixed by #929
Assignees
@MarkWoulfeAbly
Labels
api-reference Anything that appears below the API reference blue fold

Comments

@tomczoink
Copy link
Contributor

Issue raised by Paul:

the enveloped event payloads have content-type listed twice https://www.ably.io/documentation/general/events#envelope-examples and I think the second one is correct.
@tomczoink tomczoink added the api-reference Anything that appears below the API reference blue fold label Jul 6, 2020
@MarkWoulfeAbly
Copy link
Contributor

@SimonWoolf can you confirm which is the correct description here?

@SimonWoolf
Copy link
Member

The second is correct for enveloped payloads. The first is for unenveloped.

Batched event payloads section also incorrectly has both. It's the same as for enveloped (json or msgpack).

x-ably-envelope-appid also seems to have wrongly made it into the headers for enveloped & batched rules.

@MarkWoulfeAbly MarkWoulfeAbly self-assigned this Jul 22, 2020
@MarkWoulfeAbly
Copy link
Contributor

So just to clarify, the work that needs to be done here is:

  1. Remove the first content-type entry from https://www.ably.io/documentation/general/events#envelope-examples and https://www.ably.io/documentation/general/events#batch-examples
  2. Remove x-ably-envelope-appid from both https://www.ably.io/documentation/general/events#batch-examples and https://www.ably.io/documentation/general/events#envelope-examples

Is this correct @SimonWoolf ?

@SimonWoolf
Copy link
Member

yes

@mattheworiordan mattheworiordan changed the title Evenloped event payloads has content-type included twice Enveloped event payloads has content-type included twice Jul 27, 2020
@MarkWoulfeAbly MarkWoulfeAbly linked a pull request Jul 31, 2020 that will close this issue
Updated reactor events to address issues #864, #865 and #919 #929
Merged
MarkWoulfeAbly added a commit that referenced this issue Aug 21, 2020
@MarkWoulfeAbly
Updated reactor events to address issues #864, #865 and #919 (#929)
6b7ee66 
* Removed versioning for events/functions

* Fixed broken links

* re-added missing sections

* removed incorrect content-type entry

* removed x-ably-envelope-appid from headers

* removed old warning

* Removed messages, presence and channel lifecycle

* removed versions from partials

* Added decoding sections for messages

* adressed message comments

* Added presence decoding sections

Co-authored-by: Mark Woulfe <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MarkWoulfeAbly MarkWoulfeAbly

Labels
api-reference Anything that appears below the API reference blue fold
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Updated reactor events to address issues #864, #865 and #919 ably/docs
3 participants
@SimonWoolf @tomczoink @MarkWoulfeAbly