[Schema Inaccuracy] Wordy Plan availability prefix in branch protection endpoint descriptions

Aperta

#6,235 aperta il 4/4/2026 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà: 3/5
Tempo stimato: 1-2 giorni
Idoneità per principianti: 48/100

Tipo di issue: Documentazione
Chiarezza: Abbastanza chiara
Stato di attività: Tranquilla
Stack tecnologico: openapi
Ambito: api, documentation

Direzione di ricerca

Cerca nelle descrizioni OpenAPI le operazioni di /repos/{owner}/{repo}/branches/{branch}/protection e la frase ripetuta sulla disponibilità in base al piano. Esamina la struttura delle 34 descrizioni, quindi determina la posizione concordata o il riutilizzo di queste informazioni. Il lavoro è completato quando la descrizione funzionale di ogni endpoint è in evidenza e la formulazione sulla disponibilità non viene più ripetuta inutilmente.

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

Descrizione

feature

Schema Inaccuracy

I’ve noticed that the documentation for the /repos/{owner}/{repo}/branches/{branch}/protection endpoints is a bit difficult to read. Currently, 34 different descriptions begin with a boilerplate sentence regarding plan availability:

"Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server."

The actual functional description of the endpoint is buried after this paragraph, which makes it hard to quickly understand what each specific operation does when browsing the spec.

Expected

The documentation could emhpasize the functional description of the endpoint. If the plan availability information is necessary, it would be much more readable if it were:

Moved to the end of the description.
Included as a "Note" or metadata field.
Defined once at the top-level "Branch Protection" category rather than repeated for every sub-operation.

Lingua principale: Nessun dato sulla lingua
Stelle: 1.6k
Fork: 342
Merge medio: 3h 33m
PR unite (30g): 51

Guida per i contributori

Apri la guida per i contributori

Come iniziare

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