helldivers-2 / api

A community driven API for Helldivers 2
https://helldivers-2.github.io/api/
MIT License
207 stars 19 forks source link

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

Open dealloc opened 2 months ago

dealloc commented 2 months ago

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

chatterchats commented 2 months ago

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

dealloc commented 2 months ago

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

chatterchats commented 2 months ago

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