hub4j
Document process for "Preview" API endpoint usage
We need to document how the project supports using "Preview" API endpoints, including @Preview, @Deprecated, withPreview(), and the Previews 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.
These are preview api: https://docs.github.com/en/free-pro-team@latest/rest/overview/api-previews
API previews let you try out new APIs and changes to existing API methods before they become part of the official GitHub API.
During the preview period, we may change some features based on developer feedback. If we do make changes, we'll announce them on the developer blog without advance notice.
To access an API preview, you'll need to provide a custom media type in the Accept header for your requests. Feature documentation for each preview specifies which custom media type to provide.
To see examples of how previews work in this library, look at any method that uses the withPreview() method such as:
https://github.com/hub4j/github-api/blob/a585b4957fbe5e1753ae03b2f9e822ec74b85e99/src/main/java/org/kohsuke/github/GHApp.java#L200-L220
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.