Metadata question
- Langage dominant
- Go
- Étoiles
- 11.3k
- Forks
- 2.5k
- Merge moyen
- 1 j 20 h
- PR mergées (30 j)
- 53
Description
I happened to be re-implementing some acceptance tests the other day and while doing so I noticed that the signatures for the actions secret functions didn't look right. Tracking this back into the OpenAPI doc shows that the 5 functions below are tracking APIs from GHES v3.7 that are no longer documented (see #4335 for my proposed fix for this specific case).
- `ActionsService.GetEnvPublicKey`
- `ActionsService.ListEnvSecrets`
- `ActionsService.GetEnvSecret`
- `ActionsService.CreateOrUpdateEnvSecret`
- `ActionsService.DeleteEnvSecret`
Looking at the OpenAPI metadata I was expecting these endpoints to be marked as deprecated, but this doesn't appear to be the case. I can also see unused endpoints from old GHES versions still in the metadata.
My primary questions are as follows:
- Should endpoints be removed once they're no longer supported by GitHub and are no longer in use (e.g. there are some projects v1 endpoints still in there)?
- Should endpoints be marked as deprecated once they're no longer supported by GitHub (e.g. deprecated or not in supported GHES versions)?
- If the endpoints were correctly marked as deprecated would this automatically mark the functions as deprecated?
- If this is the case do we have a process for updating functions that just need to change endpoint and/or signature?
Guide de contribution
Ouvrir le guide de contribution
Piste de recherche
Commencez par examiner les métadonnées OpenAPI et les cinq méthodes de ActionsService listées dans l’issue, puis comparez-les à la documentation de GHES v3.7 et au correctif proposé dans #4335. La tâche est terminée lorsque les questions relatives à la suppression et à la dépréciation de l’endpoint ont reçu une réponse et qu’un processus clair de mise à jour des fonctions concernées est documenté.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- go, openapi
- Domaine
- api, backend-api-design
- Type d'issue
- Refactorisation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- Calme
- Clarté
- À clarifier
- Accessibilité débutants
- 35/100