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

Specify whether to get WRP or Payload when registering #19

Open
kristinapathak opened this issue Jul 29, 2020 · 1 comment
Open

Specify whether to get WRP or Payload when registering #19

kristinapathak opened this issue Jul 29, 2020 · 1 comment

Comments

@kristinapathak
Copy link
Contributor

https://github.com/xmidt-org/webpa-common/blob/main/webhook/webhook.go#L25

Currently, if a specific ContentType is specified in the WRP webhook registration, the full WRP encoded as Msgpack is sent instead of just the WRP's payload field. This functionality is not straightfoward to webhook clients, so we are proposing an additional field that would specify whether Caduceus sends the full WRP. The ContentType would no longer be involved in this logic.

Some name options for this new field:

  • SendFullWRP
  • IncludeFullWRP
  • IncludeWRP
@kristinapathak
Copy link
Contributor Author

kristinapathak commented Jul 30, 2020

Further discussion with @schmidtw led us to having this field as an enum rather than a boolean. The example given

Provide: wrp
Provide: wrp.payload

This could also be structured in such a way as to allow webhook registrations to opt into multiple fields (such as payload+spans or payload+metadata).

@joe94 joe94 transferred this issue from xmidt-org/webpa-common Feb 18, 2021
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

No branches or pull requests

1 participant