Proposal: Make preview features configurable
Les mainteneurs répondent en général sous 1 jour
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 25/100
Piste de recherche
Commencez par retracer la manière dont les en-têtes Accept de preview par défaut et ListOptions sont gérés ; l’issue ne mentionne aucun fichier ni test. Définissez l’API RequestOptions et déterminez comment les nouvelles APIs doivent gérer les en-têtes de preview, puis vérifiez que les requêtes de liste des dépôts peuvent omettre l’en-tête indésirable.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
Problem
A project I'm working on has an issue where a list of repos is returning a Server Error due to an additional Accept header being added (The "mediaTypeCodesOfConductPreview" header).
Removing this header fixes the problem but I can't do this with the current library implementation.
Solution
Instead of adding these headers by default, we could move them to an Options parameter similar to ListOptions.
type RequestOptions {
acceptHeaders []string
}
Pros
- Allows developers to control which headers to add (including headers the library may not control)
- Removes the maintenance of adding / removing headers from library owners
- Opens the door for any additional request options in the future.
- This will remove the need for comments like
// TODO: remove custom Accept headers when APIs fully launch.
Cons
- Forces users to care about headers
- While a con, users should know if a feature they are using is preview or not and subject to change
Concerns
The only major concern I have with this is approach is that it gets fuzzy what to do with entirely new API's (for example the checks API).
For consistency the API could still require the developer to add the header.
For a sane API the API could add the header with the expectation that the header is removed as soon as possible, but again moves the burden on to the library.
- Langage dominant
- Go
- Étoiles
- 11.3k
- Forks
- 2.5k
- Merge moyen
- 1 j 16 h
- PR mergées (30 j)
- 51
Préparer son environnement
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de google/go-github
-
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 3/5 1-2 jours Accessibilité débutants 68/100
Les mainteneurs répondent en général sous 1 jour
-
Add actions policies endpointsPeut-être pris @jndz2 l’a pris il y a 5 jours. Ouverte
google/go-github#4583 · 2 commentaires · 1 réaction · 1 personne assignée ·
Les mainteneurs répondent en général sous 1 jour
-
Add Copilot content exclusion set/get enterprise and org set endpointsPeut-être pris @Tens1des l’a pris il y a 19 jours. Ouverte
google/go-github#4526 · 1 commentaire · 1 réaction · 1 personne assignée ·
Les mainteneurs répondent en général sous 1 jour
-
Add Copilot custom agents enterprise endpointsPeut-être pris @Tens1des l’a pris il y a 19 jours. Ouverte
google/go-github#4524 · 1 réaction · 1 personne assignée ·
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de google/go-github
Issues similaires
-
enhancement
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
volodya-lombrozo/aidy#333 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 85/100
rossoctl/context-guru#314 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 86/100
OwO-Network/DLX#236 · 1 commentaire · 1 réaction ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 84/100