[Schema Inaccuracy] organization-full should be one of the installation.account types

Open
#5,421 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
48/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
openapi
Domain
api

Research direction

Start with the OpenAPI schema for GET /user/installations and inspect the installation.account type shown in the issue. Compare it with the API response and update the schema so organization-full is represented, then validate the affected schema or generated description.

Written by the indexing model from the issue text.

Description

documentation

Schema Inaccuracy

    installation: {
      /**
       * @description The ID of the installation.
       * @example 1
       */
      id: number;
      account:
        | (
            | components["schemas"]["simple-user"]
            | components["schemas"]["enterprise"]
          )
        | null;

Expected

I'm not 100% sure, but I do know that "organization-full" is missing from this list.

Reproduction Steps

curl https://api.github.com/user/installations -H "Authorization: Bearer "

Dominant language
No language data
Stars
1.6k
Forks
342
Avg merge
3h 33m
Merged PRs (30d)
51

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/rest-api-description

All issues in github/rest-api-description

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.