Skip to content
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

Use of deprecated APIs in documentation without listing an alternative #961

Closed
hemeroc opened this issue Oct 4, 2020 · 1 comment
Closed

Comments

@hemeroc
Copy link

hemeroc commented Oct 4, 2020

Describe the bug
The documentation of how to authenticate as an app
contains calls to deprecated APIs.

To Reproduce
Create a new project and follow the documentation linked above.
The code in question:

GHAppInstallation appInstallation = gitHubApp.getApp().getInstallationById(111111);

Where the call to getApp() and getInstallationById(...) are both marked as deprecated without listing what should be used instead.

Expected behavior

  • The official documentation should not make use of deprecated APIs.
  • The JavaDoc should point you to what should be used instead.
@timja
Copy link
Collaborator

timja commented Oct 22, 2020

It's a weird way that this library works, anything that is classed as a preview feature by GitHub is marked as deprecated. So that you don't use preview apis without being aware...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants