sharedsignals icon indicating copy to clipboard operation
sharedsignals copied to clipboard

The examples for stream update requests should not include Transmitter-Supplied fields in the request

Open ysarig1 opened this issue 1 year ago • 2 comments

The current examples for stream update requests (both PUT and PATCH) include fields that are Transmitter-Supplied ("iss" for PATCH, "iss" and "aud" for PUT) and they should be removed from the examples.

ysarig1 avatar Apr 02 '24 18:04 ysarig1

Transmitter-Supplied properties are perfectly acceptable in both PUT and PATCH. The only restriction is that if they do not match the Transmitter's expectation for those values, the Transmitter should return an error. In fact, the stream_id, which is Transmitter-Supplied, MUST be present in the request.

FragLegs avatar Apr 03 '24 12:04 FragLegs

Including those values in the examples is confusing, especially in the PATCH case. While they may be accepted in the request, there is no reason for them to be there in PATCH case.

ysarig1 avatar Apr 03 '24 18:04 ysarig1

This is being worked on in #152

FragLegs avatar May 10 '24 14:05 FragLegs