[Schema Inaccuracy] Example and schema mismatch at patch-schema
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 65/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- json, openapi
- Domain
- api
Research direction
Open descriptions-next/ghes-3.13/ghes-3.13.json and inspect the schema and example locations given in the report. Compare the patch operation value definition with the addMembers example, update either side so they agree, and verify that the example parses against the schema.
Written by the indexing model from the issue text.
Description
Schema Inaccuracy
The schema at this location is
#/components/schemas/patch-schema/properties/Operations/items/properties/value
"value": {
"type": "string",
"description": "Corresponding 'value' of that field specified by 'path'"
}
The example at is
#/paths/~1scim~1v2~1enterprises~1{enterprise}~1Groups~1{scim_group_id}/patch/requestBody/content/application~1json/examples/addMembers/value
{
"Operations" : [ {
"op" : "add",
"path" : "members",
"value" : [ {
"value" : "879db59-3bdf-4490-ad68-ab880a2694745"
}, {
"value" : "0db508eb-91e2-46e4-809c-30dcbda0c685"
} ]
} ],
"schemas" : [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ]
}
The value cannot be parsed.
Expected
Either the example or schema is updated to match the other.
Reproduction Steps
This has been observed on
https://github.com/github/rest-api-description/raw/main/descriptions-next/ghes-3.13/ghes-3.13.json
I've checked for this in 3.10, 3.11, 3.12, 3.13, 3.14.
- 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
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
AXERA-TECH/ax-llm#77 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
kind/cleanup
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
kubernetes-sigs/kueue#15937 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
sympozium-ai/sympozium#627 ·