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

Fields that probably should not be (such as X-fledge-bidding-signals-format-version) #932

Open
martinthomson opened this issue Nov 28, 2023 · 3 comments

Comments

@martinthomson
Copy link

Signaling content version information in HTTP headers is not generally recommended. A more generally acceptable approach is to use content types. Using content types allows for version negotiation with Accept fields in the request.

For instance, the response could use application/protected-audience-kv+json or something along those lines.

If there is a need to make a breaking change to the format, a new content type can be minted. They are cheap.

See also RFC 6648.

@JensenPaul
Copy link
Collaborator

We agree that X-fledge-bidding-signals-format-version is not a particularly ergonomic mechanism, but rather than graduate it to a content type, we were planning to simply deprecate and remove it as it was meant to only be temporary; see comment here: #772 (comment)

@martinthomson
Copy link
Author

Add the following to the list of fields that probably should not be fields: X-kv-query-request-version, x-kv-query-response-version, data-version.

@martinthomson martinthomson changed the title X-fledge-bidding-signals-format-version Fields that probably should not be (such as X-fledge-bidding-signals-format-version) Dec 8, 2023
@peiwenhu
Copy link
Contributor

peiwenhu commented Dec 8, 2023

X-kv-query-request-version and x-kv-query-response-version are intended for things that will stick for longer so we'll take it as a work item to use content-type instead.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants