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

Rename HTTP headers without the deprecated X- prefix #1737

Closed
kevin-dp opened this issue Sep 19, 2024 · 0 comments · Fixed by #1739
Closed

Rename HTTP headers without the deprecated X- prefix #1737

kevin-dp opened this issue Sep 19, 2024 · 0 comments · Fixed by #1739
Labels

Comments

@kevin-dp
Copy link
Contributor

The sync service uses custom headers starting with x-, however, this convention has been deprecated since 2012 and is actually advised against doing that (cf. https://datatracker.ietf.org/doc/html/rfc6648#page-4).

  1. Recommendations for Creators of New Parameters

Creators of new parameters to be used in the context of application
protocols:

  1. SHOULD assume that all parameters they create might become standardized, public, commonly deployed, or usable across multiple implementations.
  2. SHOULD employ meaningful parameter names that they have reason to believe are currently unused.
  3. SHOULD NOT prefix their parameter names with "X-" or similar constructs.

Note: If the relevant parameter name space has conventions about associating parameter names with those who create them, a parameter name could incorporate the organization's name or primary domain name (see Appendix B for examples).

We already follow their advise of incorporating our organisation name, so we should rename headers like x-electric-shape-id to electric-shape-id.

KyleAMathews pushed a commit that referenced this issue Nov 1, 2024
This PR removes the x- prefix from Electric's custom headers, as
essentially the x- prefix has been deprecated for a while. **This is a
breaking change** as it changes the names of the headers. Fixes
#1737.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant