[Schema Inaccuracy] Example and schema mismatch for `#/paths/~1repos~1{owner}~1{repo}~1keys/get`

Open
#5,633 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
50/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
openapi
Domain
api

Research direction

Start by locating the OpenAPI definition for #/paths/1repos1{owner}~1{repo}~1keys/get and the referenced example #/components/examples/deploy-key-items/value. Compare the schema's array shape with the example's element shape; done means the schema and example are consistent.

Written by the indexing model from the issue text.

Description

feature

Schema Inaccuracy

This is the json ref for the example

#/components/examples/deploy-key-items/value

Schema and example mismatch. The schema has an array. The example has an element.

Here's a snippet

>   1: {
    2:   "enabled" : [ {
    3:     "id" : 1,
    4:     "key" : "ssh-rsa AAA...",
    5:     "url" : "https://api.github.com/repos/octocat/Hello-World/keys/1",

Expected

The schema and example are in sync

Reproduction Steps

I could reproduce this in

  • ghes-3.14
  • ghes-3.15
Dominant language
No language data
Stars
1.6k
Forks
342
Avg merge
3h 33m
Merged PRs (30d)
51

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/rest-api-description

All issues in github/rest-api-description

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.