[Schema Inaccuracy] Invalid example for `/repos/{owner}/{repo}/security-advisories/{ghsa_id}` requestBody

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

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
45/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
openapi
Domain
api, documentation

Research direction

Start at the JSON Ref for the update_vvrs value under the security-advisories patch request body, and inspect the example for the /repos/{owner}/{repo}/security-advisories/{ghsa_id} endpoint. Confirm the parameter's expected shape and verify the corrected example applies to both ghec and fpt.

Written by the indexing model from the issue text.

Description

documentation

Schema Inaccuracy

The JSON Ref is

#/paths/~1repos~1{owner}~1{repo}~1security-advisories~1{ghsa_id}/patch/requestBody/content/application~1json/examples/update_vvrs/value

It contains an array where the param accepts a single element.

Reproduction Steps

I found this in

  • ghec
  • fpt
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.