Metadata question

Abierto

#4,334 abierto el 26/6/2026 11 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad: 5/5
Tiempo estimado: Más de una semana
Aptitud para principiantes: 35/100

Tipo de issue: Refactorización
Claridad: Necesita aclaración
Estado de actividad: Tranquilo
Stack tecnológico: go, openapi
Área: api, backend-api-design

Línea de trabajo

Comienza revisando los metadatos de OpenAPI y los cinco métodos de ActionsService enumerados en el issue; después, compáralos con la documentación de GHES v3.7 y la solución propuesta en #4335. La tarea estará terminada cuando se hayan respondido las preguntas sobre la eliminación y la obsolescencia del endpoint y se haya documentado un proceso claro para actualizar las funciones afectadas.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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?

Lenguaje dominante: Go
Estrellas: 11.3k
Forks: 2.5k
Merge medio: 1 d 16 h
PR fusionados (30 d): 51