PullRequest mergeable_state possible values

What are the possible values for mergeable_state and associated descriptions?

There are some mentioned here: https://github.com/octokit/octokit.net/issues/1763 but is that all of them? And are the descriptions accurate?

Mergeable is mentioned https://developer.github.com/v3/pulls/#response-1 but nothing about mergable_state

5 Likes

As it says in the issue you linked to, it’s an undocumented field. Sometimes our APIs will have undocumented fields but until they’re officially documented, they should be considered unofficial, in flux, may possibly go away, and could change at any time.

I’ll suggest to the engineering team that people are interested in documentation for the field being published, but I can’t promise a timeline or even if it will be officially documented.

Thanks for the question and feedback!

1 Like

Stumbled upon this page searching for the same request. But I’m not sure if this response is entirely helpful. Public fields exposed by APIs are assumed to always continue to fulfill their contracts regardless of whether or not those fields are documented. So I’d find it quite surprising that this is GitHub’s policy. Can you point me to where this policy is documented?

Another thing I’d like to point out is that while the mergable_state values aren’t documented, the field itself is documented because it shows up on the API documentation for the response to Get a pull request. If the field is documented but the values aren’t, it’s misleading for it to even show up as an option in the API docs.

Thanks for any information you can provide.