[Schema Inaccuracy] Get repository content path should not be required

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

Research direction

Start by locating the OpenAPI definition for the get repository content endpoint in this repository and compare its path parameter with the linked GitHub REST API documentation. The work is complete when the schema no longer marks path as required while still describing the endpoint correctly.

Written by the indexing model from the issue text.

Description

feature

Schema Inaccuracy

The get repository content API has path marked as Required but the docs state If you omit the path parameter, you will receive the contents of the repository's root directory. which would indicate path is not Required.

https://docs.github.com/en/rest/repos/contents?apiVersion=2022-11-28#get-repository-content

Expected

path should not be marked as Required

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.