Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

docs inconsistency for environment creation and unreasonable permissions required

Open
#6,745 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
58/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
github, openapi

Research direction

Compare the permissions summary page with the endpoint-specific documentation for PUT /repos/{owner}/{repo}/environments/{environment_name}, then verify the reported GitHub Enterprise Cloud behavior. Done means the documented required permission matches actual behavior, with the rationale recorded if administration: write remains necessary.

Written by the indexing model from the issue text.

Description

feature

Platform: GitHub Enterprise Cloud (*.ghe.com), reproduced 2026-07-11


Documentation inconsistency

The permissions required for GitHub Apps summary page lists PUT /repos/{owner}/{repo}/environments/{environment_name} under the environments permission (write). The endpoint-specific documentation appears to contradicts this, stating administration: write is required.

What I expected

A GitHub App with environments: write should be able to create deployment environments via PUT /repos/{owner}/{repo}/environments/{environment_name}. The environments permission exists specifically to manage deployment environments — granting it at write level implies CRUD access.

Behaviour

PUT /repos/{owner}/{repo}/environments/{environment_name} returns 403 Resource not accessible by integration with an App token that has:

{
  "environments": "write",
  "secrets": "write",
  "actions_variables": "write",
  "metadata": "read"
}

Adding administration: write resolves the 403. Confirmed via direct API test with a minted installation access token.

Why this matters

Least privilege

Requested change

Either

  1. Make environments: write sufficient to create/update environments, or
  2. If administration: write is genuinely required by design, document why and update the permissions summary page to reflect this accurately

I prefer number 1 😄

Related
Dominant language
No language data
Stars
1.6k
Forks
342
Avg merge
2h 23m
Merged PRs (30d)
57

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.