Skip to content

Confusing Header in code-samples for Create a GitHub App from a manifest #1674

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

Open
HiteshMah-Jan opened this issue Oct 13, 2022 · 0 comments

Comments

@HiteshMah-Jan
Copy link

HiteshMah-Jan commented Oct 13, 2022

Schema Inaccuracy

The "Code Samples" widget at Create a GitHub App from a manifest shows an extra Authorization Header under samples for cURL and JavaScript.
Adding an auth token in place of YOUR-TOKEN does work, but for the API to work it is not required. The documentation does not state/describe the Authorization Header, thus leaves developers to wonder what value is needed to be passed in it.

Expected

The Authorization Header in this code sample needs to be removed or ignored in the API itself. The API should not raise a 401 status if an incorrect header is passed.

Reproduction Steps

  1. Generate a temporary code using a Github App manifest
  2. Use this code in the cURL call copied from Github Rest Documentation for Create a GitHub App from a manifest
curl \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://api.github.com/app-manifests/<code-from-step-2>/conversions
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants