[Schema Inaccuracy] Missing allow_auto_merge in repos/update request body on GHES
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 84/100
- Tipo de issue
- Error
- Claridad
- Bien especificado
- Estado de actividad
- Tranquilo
- Stack tecnológico
- github, json
- Área
- api, documentation
Línea de trabajo
Actualiza los esquemas del cuerpo de la solicitud PATCH en descriptions-next/ghes-3.17 a descriptions-next/ghes-3.21. Compara el esquema correspondiente de fpt o ghec y verifica cada archivo GHES con jq, incluida la comprobación de propiedad proporcionada. Se considera completado cuando cada descripción de GHES incluye allow_auto_merge con el tipo booleano, la descripción y el valor predeterminado indicados.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Schema Inaccuracy
This is the API
#/paths/~1repos~1{owner}~1{repo}/patch
The request body schema
#/paths/~1repos~1{owner}~1{repo}/patch/requestBody/content/application~1json/schema
is missing the allow_auto_merge property on every GHES description. It is present on fpt and ghec, but absent from ghes-3.17 through ghes-3.21.
GHES does accept the field. Two things in the same GHES descriptions already imply it:
#/paths/~1orgs~1{org}~1repos/post/requestBody/content/application~1json/schema/properties/allow_auto_merge— you can set it at repository creation.#/components/schemas/full-repository/properties/allow_auto_merge— it is reported back on reads, including in the200response of this veryPATCH.
So a repository can be created with auto-merge enabled and its current value can be read, but per the description there is no documented way to change it afterwards. The GHES web documentation for "Update a repository" does list allow_auto_merge as a body parameter, e.g. https://docs.github.com/en/enterprise-server@3.18/rest/repos/repos#update-a-repository
Expected
allow_auto_merge is present in the PATCH /repos/{owner}/{repo} request body schema for the GHES descriptions, matching fpt and ghec:
"allow_auto_merge": {
"type": "boolean",
"description": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.",
"default": false
}
Reproduction Steps
With GH CLI, run this against GHES. The response shows "allowAutoMerge": true, i.e. the undocumented field took effect.
gh api --method PATCH /repos/OWNER/REPO -F allow_auto_merge=true --jq .allow_auto_merge
To confirm the gap in the description itself:
jq '.paths["/repos/{owner}/{repo}"].patch.requestBody.content["application/json"].schema.properties | has("allow_auto_merge")' \
descriptions-next/ghes-3.21/ghes-3.21.2022-11-28.json
# false
jq '.paths["/repos/{owner}/{repo}"].patch.requestBody.content["application/json"].schema.properties | has("allow_auto_merge")' \
descriptions-next/ghec/ghec.2022-11-28.json
# true
- Lenguaje dominante
- Sin datos de lenguaje
- Estrellas
- 1.6k
- Forks
- 342
- Merge medio
- 2 h 23 min
- PR fusionados (30 d)
- 57
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de github/rest-api-description
-
feature
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
github/rest-api-description#7220 ·
-
feature
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
github/rest-api-description#7201 ·
-
feature
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
github/rest-api-description#7163 ·
-
Runner deprecations: registration_deprecates_at is declared on the response but never returned Abiertofeature
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
github/rest-api-description#7162 ·
-
feature
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
github/rest-api-description#7135 ·
Todos los issues de github/rest-api-description
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
-
external-issue to-triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
googleapis/google-cloud-swift#1151 ·
-
SqliteSaver.list(filter=...) silently misses nested metadata values containing non-ASCII text Abiertoexternal
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
langchain-ai/langgraph#9074 · 1 comentario ·
-
documentation specification
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
openai/openai-openapi#584 ·