[Schema Inaccuracy] Example and schema mismatch for `#/paths/~1user~1migrations~1{migration_id}/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 by locating the OpenAPI schema and the example at #/components/examples/migration/value, then inspect the GET operation at #/paths/1user1migrations~1{migration_id}/get. Reconcile the template_repository field so the schema and example match, and verify the generated or checked API description for both fpt and ghec.
Written by the indexing model from the issue text.
Description
Schema Inaccuracy
This is the json ref for the example
#/components/examples/migration/value
The field template_repository doesn't exist in the schema, but exists in the example.
Here's a snippet
125: "push" : false,
126: "pull" : true
127: },
128: "allow_rebase_merge" : true,
> 129: "template_repository" : null,
130: "temp_clone_token" : "ABTLWHOULUVAXGTRYU7OC2876QJ2O",
131: "allow_squash_merge" : true,
132: "allow_auto_merge" : false,
133: "delete_branch_on_merge" : true,
Expected
The schema and example are in sync
Reproduction Steps
I could reproduce this in
- fpt
- ghec
- 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 2/5 1-3 hours Newbie friendliness 78/100
use-agent-os/agent-os#3312 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
-
needs-acceptance wg/data-plane-networking
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
vllm-project/semantic-router#4024 · 1 comment ·
-
bug good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
amponce/archive-movie-browser#165 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100