-
Notifications
You must be signed in to change notification settings - Fork 13
Content Formatting
Every API endpoint will accept AND respond using Protocol Buffers (protobuf) unless otherwise specified in request headers.
For debugging purposes, you may also use JSON; however, this is only recommended for testing the API. Protobufs are much more efficient than JSON and will provide dramatic performance and latency improvements at scale. Unless JSON is a hard requirement, please do not adjust this behavior.
Specified on every API request where protobuf content is desired.
application/x-protobuf
Specified on any API request where protobuf content is provided in the request body.
application/x-protobuf
Because protobuf is the default, these headers need to be provided with all requests.
Specified on every API request where JSON formatted content is desired.
application/json
Specified on any API request where JSON formatted content is provided in the request body.
application/json
Please see the 'proto' project within this GitHub organization for the latest data model used in this project (interactions.proto).
A copy will always be kept in this repository to convey the exact proto file used to generate Interactions.cs. However, both projects will not merge proto changes into master until the Backend has been updated to reflect them.