GitHub Community
PullRequest mergeable_state possible values #24299
-
|
What are the possible values for mergeable_state and associated descriptions? There are some mentioned here: octokit/octokit.net#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 |
Beta Was this translation helpful? Give feedback.
Replies: 3 comments 1 reply
-
|
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! |
Beta Was this translation helpful? Give feedback.
-
|
lee-dohm:
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 Thanks for any information you can provide. |
Beta Was this translation helpful? Give feedback.
-
|
Just FYI, the fields are documented on the GraphQL API: Enums - GitHub Docs |
Beta Was this translation helpful? Give feedback.
-
|
This might be worse, several possible responses are documented in the GraphQL docs with no mention of the field being I am seeing If it is undocumented, the documentation needs to reflect that it is |
Beta Was this translation helpful? Give feedback.
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!