[Schema Inaccuracy] (GHES 3.18) organization_copilot_seat_management property on the app-permissions schema is missing read

Open Beginner friendly
#6,272 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
75/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Quiet
Tech stack
openapi
Domain
api

Research direction

Locate the app-permissions schema used by the organization installations endpoint and inspect the organization_copilot_seat_management property. Compare it with the documented GHES 3.18 response example, add the missing valid value, and run the repository's schema validation or relevant tests to confirm the response is representable.

Written by the indexing model from the issue text.

Description

documentation

Schema Inaccuracy

The organization_copilot_seat_management property on the app-permissions schema is missing read from its enum values for GHES 3.18.

Expected

The organization_copilot_seat_management property on the app-permissions schema should include read as a valid enum value:

  "organization_copilot_seat_management": {                                                                                         
    "type": "string",                                       
    "enum": ["read", "write"]
  }

Currently the schema only lists:

  "organization_copilot_seat_management": {                                                                                         
    "type": "string",                                       
    "enum": ["write"]
  }

Reproduction Steps

List app installations for an organization that has GitHub Copilot Business. Some installations will have
"organization_copilot_seat_management": "read" in their permissions object, which is not representable by the current schema.

  curl -H "Authorization: Bearer $GITHUB_TOKEN" \           
       -H "Accept: application/vnd.github+json" \                                                                                   
       https://ghes.example.com/api/v3/orgs/{org}/installations

Example response snippet:

  {                                                         
    "installations": [
      {
        "permissions": {
          "organization_copilot_seat_management": "read"                                                                            
        }
      }                                                                                                                             
    ]                                                       
  }
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.