search

openid / sharedsignals

OpenID Shared Signals Working Group Repository
45 stars 11 forks source link

Breaking change introduced in the latest draft - `endpoint_url` is renamed to `url` #79

Closed appsdesh closed 11 months ago

appsdesh commented 1 year ago

Hello,

I am noticing a breaking change introduced in this commit related to the delivery object, that is renaming endpoint_url from the approved spec 11.2.1.1 to url. We will have to revert this before approving the draft

tulshi commented 11 months ago

I'm trying to understand the impact of this change, since it is only related to the metadata and it is used in the examples in the previous implementer's draft (although the section defined it as "endpoint_url"). Could you please comment on whether this is impactful to existing implementations or hard to update?

appsdesh commented 11 months ago

I'm trying to understand the impact of this change, since it is only related to the metadata and it is used in the examples in the previous implementer's draft (although the section defined it as "endpoint_url"). Could you please comment on whether this is impactful to existing implementations or hard to update?

@atultulshi summarizing our offline discussions -

  1. This PR will fix the ambiguity between attribute names between metadata and examples from the last implementers draft.
  2. https://sharedsignals.guide/ is a great guide that also uses endpoint_url in configuring the streams, without this PR's fix we are burdening existing transmitters to change the implementation (for no reason whatsoever). This is a breaking change that got introduced in the current draft and we should fix it.
  3. Since url over enpoint_url does not add any functional value but only adds brevity in naming, we should stick to the previous implementer's draft and NOT introduce any breaking changes.