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

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

Closed
ysarig1 opened this issue Apr 2, 2024 · 3 comments · Fixed by #152
Labels
bug Something isn't working spec:SSF vID-03 Address this issue before the v3 cutoff (June 15, 2024)

Comments

@ysarig1
Copy link
Collaborator

ysarig1 commented Apr 2, 2024

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.

@FragLegs
Copy link
Contributor

FragLegs commented Apr 3, 2024

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.

@ysarig1
Copy link
Collaborator Author

ysarig1 commented Apr 3, 2024

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.

@tulshi tulshi added spec:SSF bug Something isn't working labels Apr 20, 2024
@FragLegs FragLegs added the vID-03 Address this issue before the v3 cutoff (June 15, 2024) label May 9, 2024
@FragLegs
Copy link
Contributor

This is being worked on in #152

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working spec:SSF vID-03 Address this issue before the v3 cutoff (June 15, 2024)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants