[Schema Inaccuracy] schema `content-directory` should have enum limited to `dir` value in gh-3.18

Open
#5,571 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Read the gh-3.18 schema at the linked gh.yaml URL and locate the content-directory definition. Compare its type enum with the Expected block, then verify the schema contains only the intended value. Done means the gh-3.18 description reflects the requested enum restriction.

Written by the indexing model from the issue text.

Description

feature

Schema Inaccuracy

In the latest version of gh.yaml (3.18) the type content-directory has an incorrect type property.

    content-directory:
      title: Content Directory
      description: A list of directory items
      type: array
      items:
        type: object
        properties:
          type:
            type: string
            enum:
            - dir
            - file
            - submodule
            - symlink
...

Expected

    content-directory:
      title: Content Directory
      description: A list of directory items
      type: array
      items:
        type: object
        properties:
          type:
            type: string
            enum:
            - dir
...
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.