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

[Schema Inaccuracy] Example and schema mismatch for `#/paths/~1repos~1{owner}~1{repo}~1environments/get`

Open
#5,629 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Locate the #/components/examples/environments/value example referenced by the issue and inspect the deployment_branch_policy.custom_branch_policies value alongside its schema. Correct the example so the value matches the declared boolean type, then verify the schema and example are in sync for the environments GET response.

Written by the indexing model from the issue text.

Description

Schema Inaccuracy

This is the json ref for the example

#/components/examples/environments/value

Schema and example mismatch. The expected type is boolean, but the value is "trues".

Here's a snippet

   62:       "type" : "branch_policy"
   63:     } ],
   64:     "deployment_branch_policy" : {
   65:       "protected_branches" : false,
>  66:       "custom_branch_policies" : "trues"
   67:     }
   68:   } ],
   69:   "total_count" : 1
   70: }

Expected

The schema and example are in sync

Reproduction Steps

I could reproduce this in

  • ghes-3.14
  • ghes-3.15
  • ghes-3.16
  • ghes-3.17
  • ghes-3.18
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.