[Schema Inaccuracy] Example and schema mismatch for `#/paths/~1orgs~1{org}~1rulesets/get`
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 52/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- openapi
- Domain
- api
Research direction
Compare the example at #/components/examples/org-ruleset-items/value with the schema for #/paths/1orgs1{org}~1rulesets/get. Check the enforcement value against the schema's supported enum, then confirm the example and schema are in sync across the listed GitHub environments.
Written by the indexing model from the issue text.
Description
Schema Inaccuracy
This is the json ref for the example
#/components/examples/org-ruleset-items/value
Schema and example mismatch. enabled is not supported. The supported values are
"enum": [
"disabled",
"active",
"evaluate"
]
Here's a snippet
2: "id" : 21,
3: "name" : "super cool ruleset",
4: "source_type" : "Organization",
5: "source" : "my-org",
> 6: "enforcement" : "enabled",
7: "node_id" : "RRS_lACkVXNlcgQB",
8: "_links" : {
9: "self" : {
10: "href" : "https://api.github.com/orgs/my-org/rulesets/21"
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 clawsweeper:linked-pr-open clawsweeper:needs-live-repro clawsweeper:no-new-fix-pr impact:message-loss issue-rating: 🐚 platinum hermit P2 regression
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
AXERA-TECH/ax-llm#77 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
games-on-whales/wolf#509 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100