search

github / docs

The open-source repo for docs.github.com
https://docs.github.com
Creative Commons Attribution 4.0 International
16.31k stars 59.8k forks source link

Missing examples in "Authenticating with a GitHub App on behalf of a user" #31006

Open NatoBoram opened 10 months ago

NatoBoram commented 10 months ago

Code of Conduct

What article on docs.github.com is affected?

What part(s) of the article would you like to see updated?

Authenticating with a GitHub App on behalf of a user is missing an example for how to do this with cURL. It's also missing an example on how to do this with Octokit.js.

Generating a user access token for a GitHub App#Generating a user access token when a user installs your app is missing examples for how to login after you've obtained the token.

There's no way to tell how to do this by looking at octokit/authentication-strategies.js#GitHub App or installation authentication since it redirects to Web application flow, which doesn't mention refresh tokens.

Speaking of refresh tokens, Refreshing user access tokens#Refreshing a user access token with a refresh token is missing an example on how to do this with Octokit.js.

Additional information

The previous page, "Authenticating as a GitHub App installation", has examples on how to do it with both cURL and Octokit.js.

nguyenalex836 commented 10 months ago

@NatoBoram Thanks so much for opening this issue! You, or anyone else, are welcome to submit a PR for updating these docs with examples 💛

GR7-4444 commented 4 months ago

[maintainer edit for spammy content]