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.

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

updated note part of the Webhook Accept field #73

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

maurafortino
Copy link
Contributor

Discussed with Wes regarding the multipart response for the new Webhook struct.

Wes said we should not do multipart response. We updated the Note portion of the Accept field description. Any feedback/questions/discussions on the note or whether or not to do multipart responses are welcome.

@maurafortino maurafortino added the documentation Improvements or additions to documentation label Feb 18, 2025
@maurafortino maurafortino self-assigned this Feb 18, 2025
Copy link

codecov bot commented Feb 18, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.98%. Comparing base (e75573a) to head (5e0ae69).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #73   +/-   ##
=======================================
  Coverage   81.98%   81.98%           
=======================================
  Files           3        3           
  Lines         333      333           
=======================================
  Hits          273      273           
  Misses         60       60           
Flag Coverage Δ
unittests 81.98% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Comment on lines +104 to +105
An `Accept` of application/octet-stream supports single message return with payload of WRP
An `Accept` of application/json supports single message return with json form of WRP
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sounds like batching will only be available for application/jsonl and application/msgpack, that works 👍

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I spoke to John about this & he suggested this set of values for better clarity:
application/wrp+json - one json encoded wrp message
application/wrp+msgpack - one msgpack encoded wrp message
application/wrp+octet-stream - one message with the wrp payload in the http payload
application/wrp+jsonl - multiple jsonl encoded wrp messages
application/wrp+msgpackl - multiple msgpackl encoded wrp messages

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice! I really like this idea

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants