-
Notifications
You must be signed in to change notification settings - Fork 294
Open
Description
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:
mergeableis 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?).draftis 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 justfalse?)rebaseableis both nullable and optional, same remarks as above.mergeable_stateis completely undocumented aside from knowing it's a string. Looking at the GraphQL API, it the example value ("clean") matches theMergeStateStatusenum. If this is the right conversion,mergeable_stateshould be defined as an enum with those values provided (and documented as they are in the graphql schema, maybe).