[Schema Inaccuracy] Example and schema mismatch for `#/paths/~1repos~1{owner}~1{repo}~1rulesets/get`
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- openapi
- Domain
- api
Research direction
Start with the OpenAPI definition for GET #/repos/{owner}/{repo}/rulesets and follow the reference to components/examples/repository-ruleset-items/value. Compare the enforcement value in the example with the schema's supported values, then validate that the schema and example are in sync across the reported environments.
Written by the indexing model from the issue text.
Description
Schema Inaccuracy
This is the json ref for the example
#/components/examples/repository-ruleset-items/value
Schema and example mismatch. Supported values are evaluate, disabled, active
Here's a snippet
2: "id" : 42,
3: "name" : "super cool ruleset",
4: "source_type" : "Repository",
5: "source" : "monalisa/my-repo",
> 6: "enforcement" : "enabled",
7: "node_id" : "RRS_lACkVXNlcgQB",
8: "_links" : {
9: "self" : {
10: "href" : "https://api.github.com/repos/monalisa/my-repo/rulesets/42"
Expected
The schema and example are in sync
Reproduction Steps
I could reproduce this in
- fpt
- ghec
- 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
- 3h 33m
- Merged PRs (30d)
- 51
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 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 ·
-
feature
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
github/rest-api-description#7111 · 1 comment ·
All issues in github/rest-api-description
Similar issues
-
bug customer-eng Durable Agents Inngest status: needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
-
integration: elevenlabs
Difficulty 1/5 Under an hour Newbie friendliness 88/100
home-assistant/core#182944 · 1 comment ·
-
ai-observability bug team/ai-observability
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
vicharanashala/fln#563 ·