[Schema Inaccuracy] Example and schema mismatch for `#/paths/~1repos~1{owner}~1{repo}~1environments/get`
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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from github/rest-api-description
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
github/rest-api-description#7220 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
github/rest-api-description#7201 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
github/rest-api-description#7163 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
github/rest-api-description#7162 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
github/rest-api-description#7135 ·
All issues in github/rest-api-description
Similar issues
-
Area: Excel support
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
orbeon/orbeon-forms#7893 ·
-
essnmx good first issue
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
yeti-platform/yeti#1380 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
modelcontextprotocol/python-sdk#3566 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
griptape-ai/griptape#2353 ·