sharedsignals icon indicating copy to clipboard operation
sharedsignals copied to clipboard

Removing transmitter supplied fields from stream config PUT and PATCH…

Open ysarig1 opened this issue 1 year ago • 2 comments

Removed the transmitter supplied fields from the stream config PUT and PATCH examples.

ysarig1 avatar Apr 17 '24 00:04 ysarig1

@FragLegs, @appsdesh, @atultulshi Can you please review the PR and approve/comment?

ysarig1 avatar Apr 22 '24 21:04 ysarig1

The existing language already clarifies -

Transmitter-Supplied properties beside the stream_id MAY be present, but they MUST match the expected value. Missing Transmitter-Supplied properties MUST be ignored by the Transmitter.

There may be reasons for the receiver to send the same values to make sure it's info matches the Tx info (and expect to receive error message, on mismatch)

I don't think this PR is needed. Please let me know your thoughts

The issue addressed by this PR is not if the fields can or can't be in the request but the fact that having a the fields in the examples is confusing. Having transmitter-supplied fields in an update request is an edge case and while it is allowed, it doesn't make sense to do so.

ysarig1 avatar Apr 23 '24 22:04 ysarig1