Skip to content

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

Open
@HiteshMah-Jan

Description

@HiteshMah-Jan

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @ahoglund@HiteshMah-Jan

        Issue actions

          Confusing Header in code-samples for `Create a GitHub App from a manifest` · Issue #1674 · github/rest-api-description