[Schema Inaccuracy] GET method for issues has requestBody

Open
#5,995 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
48/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
openapi
Domain
api

Research direction

Locate the OpenAPI description for GET /repos/{owner}/{repo}/issues/{issue_number} and inspect its requestBody definition and example. Remove the requestBody from the GET method, then validate the affected descriptions across the listed deployment versions to confirm the schema no longer contains it.

Written by the indexing model from the issue text.

Description

documentation

Schema Inaccuracy

Path "/repos/{owner}/{repo}/issues/{issue_number}" has a get with a requestBody.
It has an example, but no schema.
This started happening with 8c2a804.

Expected

GET method has no requestBody

Reproduction Steps

This happens in:

  • fpt
  • ghec
  • ghes-3.14
  • ghes-3.15
  • ghes-3.16
  • ghes-3.17
  • ghes-3.18
  • ghes-3.19
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.