api icon indicating copy to clipboard operation
api copied to clipboard

[FEATURE]: make `X-Super-Client` header required

Open dealloc opened this issue 1 year ago • 3 comments

What problem does it solve

It requires clients using the hosted version of the API to send along a X-Super-Client header that identifies their application, and optionally a X-Super-Contact header with developer contact info.

This allows us to identify applications and contact developers when implementing breaking changes or if their apps are causing problems.

What is the solution

Make the header required (after a grace period)

Existing alternatives

none

Added value

This allows us to identify applications and contact developers when implementing breaking changes or if their apps are causing problems.

Additional notes

Provide a way to disable this check for self-hosted containers

dealloc avatar Apr 29 '24 20:04 dealloc

What kind of grace period are we looking at for mandatory implementation?

chatterchats avatar Apr 30 '24 01:04 chatterchats

mostly depends on how fast I can identify most developers and communicate the changes

We left the Elixir version up and running for approximately 30-50 days

dealloc avatar Apr 30 '24 07:04 dealloc

~~HellCom Support PR #11~~ ~~Helldivers Companion (Organization) PR #8 - Implemented~~ ~~Helldivers Training Manual PR #13 - Implemented~~ ~~Helldivers.Widget Issue #1 - Implemented in c3947584~~ ~~Heckdivers Issue #1 PR #2 - Implemented~~ ~~Dive Stats PR #1 - Implemented~~ ~~Helldivers Help PR #1 - Implemented~~ ~~Bruhbot PR #6 - Implemented~~ ~~Helldivers History - Implemented in 3ea5a78~~ ~~Helldivers Companion (Devpoole) PR #1 - Implemented~~

That's every repo that I could find on github that uses helldivers2.dev or the fly.dev link

chatterchats avatar Apr 30 '24 17:04 chatterchats