[Schema Inaccuracy] Create a deployment branch not listing defaults & required.

Aperta

#3,841 aperta il 10/8/2024 4 commenti 0 reazioni 1 assegnatario Vedi su GitHub

@nickfloyd ci sta già lavorando.

Dal 6/11/2025.

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

feature

Schema Inaccuracy

https://docs.github.com/en/rest/deployments/branch-policies?apiVersion=2022-11-28#create-a-deployment-branch-policy

Incorret request & response.

Expected

Description of the type parameter when absent to default to branch.
Response to list id, node_id, name and type as required so that they are not emitted as type | undefined in JS.

Reproduction Steps

Execute

gh api \
  --method POST \
  -H "Accept: application/vnd.github+json" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  /repos/OWNER/REPO/environments/ENVIRONMENT_NAME/deployment-branch-policies \
   -f "name=release/*"

Yields

{
  "id": 20029356,
  "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kyMDAyOTM1Ng==",
  "name": "release/*",
  "type": "branch"
}

So omitting type creates a type = branch. Equally there is no way to create a deployment branch policy and not get back and id, node_id, name and a type.

Lingua principale: Nessun dato sulla lingua
Stelle: 1.6k
Fork: 342
Merge medio: 2h 23m
PR unite (30g): 57

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.

Altre issue di github/rest-api-description

[Schema Inaccuracy] Repository security advisory operations name `repository_advisories:read` / `repository_advisories:write` OAuth scopes that do not exist Aperta

feature

Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100

github/rest-api-description#7220 · Aperta il 22/9/2026
[Schema Inaccuracy] Missing Link header from org/security-advisories response description Aperta

feature

Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100

github/rest-api-description#7201 · Aperta il 15/9/2026
Runner deprecations: enterprise scope is in the changelog and the 404 handler but not in the description Aperta

feature

Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100

github/rest-api-description#7163 · Aperta il 9/9/2026
Runner deprecations: registration_deprecates_at is declared on the response but never returned Aperta

feature

Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100

github/rest-api-description#7162 · Aperta il 9/9/2026
configure-pages API endpoint yields anchor that doesn't exist in docs Aperta

feature

Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100

github/rest-api-description#7135 · Aperta il 4/9/2026

Tutte le issue di github/rest-api-description