Help
cancel
Showing results for 
Search instead for 
Did you mean: 
Highlighted
Copilot Lvl 3
Message 1 of 3

Need clarification on API warning

Solved! Go to Solution.

 

Hello,

 

in the page Authenticating with GitHub Apps we can read

 

> Warning: The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact GitHub Support.

 

which is a warning very common in the API documentation.

 

Does this warning mean that the corresponding API endpoints cannot be used in a production GitHub or OAuth app?

 

Or does it mean that they can be used in a production app, but because they are in preview mode, they may change, and in that case, we may contact GitHub support to fix related issues with their use or find recommended alternatives?

 

Thanks in advance

2 Replies
Solution
Community Manager
Message 2 of 3

Re: Need clarification on API warning

Hi @mljrg!

I think that largely it's a personal decision in a lot of ways. You absolutely can use Preview features in production apps with the understanding that things may change suddenly which might break things in ways that we can't fix for you. You can always contact GitHub Support for advice and workaround options if things do change on you, but there's no guarantee that we'll be able to get things working the way that you had them.

 

Does that help to clarify?

Copilot Lvl 3
Message 3 of 3

Re: Need clarification on API warning

Hi @that-pat

 

That clarifies a lot, thanks!