[Schema Inaccuracy] Example and schema mismatch for `#/paths/~1advisories/get`

Open
#5,479 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
55/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
openapi
Domain
api

Research direction

Compare the schema for #/paths/~1advisories/get with the example at #/components/examples/global-advisory-items/value, focusing on the missing id field. The work is done when the schema and example agree for the reported fpt, ghec, and GHES versions.

Written by the indexing model from the issue text.

Description

documentation

Schema Inaccuracy

This is the json ref for the example

#/components/examples/global-advisory-items/value

The field id doesn't exist in the schema, but exists in the example.

Here's a snippet

    1: [ {
>   2:   "id" : 1,
    3:   "ghsa_id" : "GHSA-abcd-1234-efgh",
    4:   "cve_id" : "CVE-2050-00000",
    5:   "url" : "https://api.github.com/advisories/GHSA-abcd-1234-efgh",
    6:   "html_url" : "https://github.com/advisories/GHSA-abcd-1234-efgh",

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
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.