[Schema Inaccuracy] verification.verified_at marked as required but not present in API response
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 45/100
- Tipo de issue
- Error
- Claridad
- Bien especificado
- Estado de actividad
- Estancado
- Stack tecnológico
- json, openapi
- Área
- api
Línea de trabajo
Comienza en api.github.com.2022-11-28.json e inspecciona las properties y el array required del esquema Verification. Compáralo con los objetos verification devueltos por los endpoints commits y git commits descritos en el issue. Se considera terminado cuando el esquema coincide con la respuesta documentada de la API y los clientes generados ya no rechazan una respuesta que no incluya verified_at.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Schema Inaccuracy
The verification schema incorrectly lists verified_at as a required field, but GitHub's API does not return this field in the actual response. This causes validation errors in generated client libraries that strictly enforce the schema.
Expected
The verified_at property in the verification schema should either:
- Be removed from the
requiredarray (since it's not actually returned by the API), or - Be removed entirely from the schema properties if it's not part of the API response
Current schema definition in api.github.com.2022-11-28.json:
{
"title": "Verification",
"type": "object",
"properties": {
"verified": {
"type": "boolean"
},
"reason": {
"type": "string"
},
"payload": {
"type": "string",
"nullable": true
},
"signature": {
"type": "string",
"nullable": true
},
"verified_at": {
"type": "string",
"nullable": true
}
},
"required": [
"verified",
"reason",
"payload",
"signature",
"verified_at" // <-- This field is not returned by the API
]
}
Reproduction Steps
- Make a request to get commit details with verification information:
$ curl -H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://api.github.com/repos/OWNER/REPO/commits/COMMIT_SHA
- Observe the actual verification object returned:
{
"sha": "example_sha",
"commit": {
"message": "Example commit message",
"author": {...},
"verification": {
"verified": false,
"reason": "unsigned",
"signature": null,
"payload": null
// Note: No "verified_at" field is present
}
}
}
- The same issue occurs when using the git commits endpoint:
$ curl -H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
https://api.github.com/repos/OWNER/REPO/git/commits/COMMIT_SHA
Impact
This schema inaccuracy causes validation errors in strongly-typed client libraries generated from the OpenAPI specification. For example, Python libraries using Pydantic validation will fail with:
pydantic.error_wrappers.ValidationError: 1 validation error for Verification
verified_at
field required (type=value_error.missing)
- Lenguaje dominante
- Sin datos de lenguaje
- Estrellas
- 1.6k
- Forks
- 342
- Merge medio
- 3 h 33 min
- PR fusionados (30 d)
- 51
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 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 ·
-
feature
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
github/rest-api-description#7111 · 1 comentario ·
Todos los issues de github/rest-api-description
Issues similares
-
area/sessions comp/cron comp/gateway P2 sweeper:risk-message-delivery sweeper:risk-session-state type/bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
NousResearch/hermes-agent#118863 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
use-agent-os/agent-os#3312 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
-
needs-acceptance wg/data-plane-networking
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
vllm-project/semantic-router#4024 · 1 comentario ·