google / google/go-github

Metadata question

Aperta
#4,334 11 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Go
Stelle
11.3k
Fork
2.5k
Merge medio
1g 22h
PR unite (30g)
49

Descrizione

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?

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Start by reviewing the OpenAPI metadata and the five ActionsService methods listed in the issue, then compare them with the GHES v3.7 documentation and the proposed fix in #4335. Done means answering the endpoint removal and deprecation questions and documenting a clear process for updating affected functions.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
go, openapi
Ambito
api, backend-api-design
Tipo di issue
Refactoring
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Tranquilla
Chiarezza
Da chiarire
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.