Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Metadata question

Aperta
#4,334 11 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

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

Direzione di ricerca

Inizia esaminando i metadati OpenAPI e i cinque metodi di ActionsService elencati nell’issue, quindi confrontali con la documentazione di GHES v3.7 e con la correzione proposta in #4335. Il lavoro è completo quando sono state risposte le domande sulla rimozione e sulla deprecazione dell’endpoint ed è stato documentato un processo chiaro per aggiornare le funzioni interessate.

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

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?
Lingua principale
Go
Stelle
11.3k
Fork
2.5k
Merge medio
1g 16h
PR unite (30g)
51

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di google/go-github

Tutte le issue di google/go-github

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.