WICG / turtledove

TURTLEDOVE
https://wicg.github.io/turtledove/
Other
526 stars 228 forks source link

inconsistent references to the renderUrls parameter in the documentation for SSP K/V call #882

Open rdgordon-index opened 11 months ago

rdgordon-index commented 11 months ago

renderUrls (camel case) is mentioned https://github.com/WICG/turtledove/blob/main/FLEDGE_Key_Value_Server_API.md#examples:

https://www.ssp-kv-server.example/v1/getvalues?renderUrls=url1,url2&adComponentRenderUrls=url3,url4

And that's in fact what we see in the network tab for the SSP K/V call: image

However, both the explainer and the spec make mention of renderURLs -- where URL is all-uppercase -- which doesn't match Chrome's behaviour.

Can the docs & spec be updated accordingly?

rdgordon-index commented 9 months ago

@MattMenke2 -- I saw you recently opened https://github.com/WICG/turtledove/pull/991 -- would this cover all the instances noted above?

MattMenke2 commented 9 months ago

Yes. The issue here is that we started with renderUrl, but Web Javascript standards use renderURL. So currently, we support both, but we want to get everyone over to using renderURL, and then (eventually) remove renderUrl, probably displaying some sort of warning for quite some time until we finally remove it.

MattMenke2 commented 9 months ago

Oops, my PR only updates the explainer, not the other files.