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

Remove method and endpoint_url from 7.1.1 to reduce confusion #202

Open
FragLegs opened this issue Sep 12, 2024 · 1 comment
Open

Remove method and endpoint_url from 7.1.1 to reduce confusion #202

FragLegs opened this issue Sep 12, 2024 · 1 comment
Labels
spec:SSF v1Final Issues that must be fixed before we propose a spec to become a v1 final spec.

Comments

@FragLegs
Copy link
Contributor

FragLegs commented Sep 12, 2024

We describe the delivery field of the Transmitter configuration twice, once in 7.1.1 and again in 10.3.1. In 7.1.1 we point out that it contains a method and an endpoint_url, but we don't mention the optional authorization_header for push based delivery. It would be less confusing to just reference section 10.3.1 (which 7.1.1 already does) and leave off the detailed description of the delivery field. I'm suggesting that 7.1.1 should look something like this

delivery

REQUIRED. A JSON object containing a set of name/value pairs specifying configuration parameters 
for the SET delivery method. The actual delivery method is identified by the special key "method" with 
the value being a URI as defined in 
[Section 10.3.1](https://openid.github.io/sharedsignals/openid-sharedsignals-framework-1_0.html#delivery-meta). 
Depending on the "method" chosen, other fields are required or optional.

leaving off everything that currently follows

@FragLegs
Copy link
Contributor Author

Do this as part of #226

@FragLegs FragLegs added v1Final Issues that must be fixed before we propose a spec to become a v1 final spec. spec:SSF labels Jan 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
spec:SSF v1Final Issues that must be fixed before we propose a spec to become a v1 final spec.
Projects
None yet
Development

No branches or pull requests

1 participant