-
Notifications
You must be signed in to change notification settings - Fork 736
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Document process for "Preview" API endpoint usage #816
Comments
These are preview api:
To see examples of how previews work in this library, look at any method that uses the github-api/src/main/java/org/kohsuke/github/GHApp.java Lines 200 to 220 in a585b49
|
Related #1003 |
Almost all previews have be graduated. There is a new system for API versioning in GithHub. We will need to do something similar to this issue for the new scheme. |
We need to document how the project supports using "Preview" API endpoints, including
@Preview
,@Deprecated
,withPreview()
, and thePreviews
class.Also all
@Preview
items should include a link of GitHub documentation of what they are previewing and@deprectated
JavaDoc field with boiler plate explaining that this feature is still in preview and a link to the same documentation.The text was updated successfully, but these errors were encountered: