[Schema Inaccuracy] Wrong reference in `ghec` schema

Open
#5,331 1 comment 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 in the descriptions/ghec schemas and inspect components.examples.server-statistics.value, including the references to server-statistics-actions.yaml, server-statistics-packages.yaml, and server-statistics-advisory-db.yaml. Compare these entries with the server-statistics-* schemas and the ghec.json and ghec.2022-11-28.json outputs; done means the faulty references are absent and a valid example is present.

Written by the indexing model from the issue text.

Description

documentation

Schema Inaccuracy

For the ghec JSON schemas, there seems to be a faulty example in components.examples.server-statistics.value:

"actions_stats": {
  "$ref": "server-statistics-actions.yaml"
},
"packages_stats": {
  "$ref": "server-statistics-packages.yaml"
},
"advisory_db_stats": {
  "$ref": "server-statistics-advisory-db.yaml"
}

These shouldn't be referenced.

Expected

Some valid example pertaining to components.schemas.server-statistics-* or those yaml files to be present somewhere.

Reproduction Steps

Check the ghec JSON schemas. I've checked for ghec.json and ghec.2022-11-28.json. I've checked the dereferenced schemas as well.

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.