[Schema Inaccuracy] Missing `allow_update_branch` property on `POST /user/repos`

Open Beginner friendly
#5,857 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
openapi
Domain
api

Research direction

Start by locating the OpenAPI schema for POST /user/repos and compare it with PATCH /repos/{owner}/{repo}, where allow_update_branch is already documented. The work is done when the property appears in the POST request body and the provided gh api commands still produce true and false as expected.

Written by the indexing model from the issue text.

Description

feature

Schema Inaccuracy

The POST /user/repos endpoint does not list the property allow_update_branch in the request body, however it can be used to set this repository setting on creation.

The allow_update_branch request body property can be seen in the PATCH /repos/{owner}/{repo} endpoint.

Expected

The allow_update_branch property should be listed in the request body of POST /user/repos.

Reproduction Steps

Create two repositories and print the value of allow_update_branch of the created repositories:

$ gh api -X POST /user/repos -f name=test_allow_update_branch_1 -f allow_update_branch=true -q .allow_update_branch
true
$ gh api -X POST /user/repos -f name=test_allow_update_branch_2 -f allow_update_branch=false -q .allow_update_branch
false
Dominant language
No language data
Stars
1.6k
Forks
342
Avg merge
3h 33m
Merged PRs (30d)
51

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/rest-api-description

All issues in github/rest-api-description

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.