[Possible Schema Inaccuracy] multiple PR fields have odd description

Abierto

#691 abierto el 22/11/2021 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad: 4/5
Tiempo estimado: 3-5 días
Aptitud para principiantes: 35/100

Tipo de issue: Documentación
Claridad: Bastante claro
Estado de actividad: Estancado
Stack tecnológico: openapi
Área: api, documentation

Línea de trabajo

Comienza localizando la respuesta/el esquema de "pull-request" e inspecciona las definiciones de mergeable, draft, rebaseable y mergeable_state. Compara su comportamiento opcional y nullable con el enum MergeStateStatus de la API de GraphQL; se considera terminado cuando el esquema documenta claramente estos comportamientos o representa correctamente los campos y los valores del enum.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

feature fundamentals-and-support inaccuracy P4 shield waiting for review

I'm not entirely sure that these are schema inaccuracies but multiple fields of PRs (specifically the "pull-request" response / schema) have an odd definition:

mergeable is a nullable boolean field,it is not otherwise documented, it's hard to fathom why a PR would be something other than "mergeable" and "not mergeable". Either the field should be marked required, or the behaviour should be explained (I guess "we don't know if it's mergeable yet" is possible but in that case why not just set it to non-mergeable?).
draft is somewhat similarly an optional boolean, it's not clear when it would be absent (possibly projects which don't support / allow draft PRs? still why have that in the response rather than just false?)
rebaseable is both nullable and optional, same remarks as above.
mergeable_state is completely undocumented aside from knowing it's a string. Looking at the GraphQL API, it the example value ("clean") matches the MergeStateStatus enum. If this is the right conversion, mergeable_state should be defined as an enum with those values provided (and documented as they are in the graphql schema, maybe).

Lenguaje dominante: Sin datos de lenguaje
Estrellas: 1.6k
Forks: 342
Merge medio: 2 h 23 min
PR fusionados (30 d): 57