Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

[Schema Inaccuracy] Code Scanning Alert

Open
#4,728 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
Mostly clear
Activity status
Stale
Tech stack
github, openapi
Domain
api, documentation

Research direction

Start with the organization code scanning alerts endpoint schema linked in the issue and inspect how its response classification enum is defined. Confirm that "documentation" is a valid observed value, then update the schema so the enum includes it and verify the endpoint description remains consistent.

Written by the indexing model from the issue text.

Description

documentation

Schema Inaccuracy

The Response Schema for the code scanning alert endpoint(for organizations) defines 4 valid values for classifications. When using this endpoint we sometimes get the value "documentation" which is not listed.

"code-scanning-alert-classification": {
        "type": "string",
        "description": "A classification of the file. For example to identify it as generated.",
        "nullable": true,
        "enum": [
          "source",
          "generated",
          "test",
          "library"
        ]
      },

Expected

The schema should include all values

"code-scanning-alert-classification": {
        "type": "string",
        "description": "A classification of the file. For example to identify it as generated.",
        "nullable": true,
        "enum": [
          "source",
          "generated",
          "test",
          "library",
          "documentation"
        ]
      },

Reproduction Steps

Due to the sensitive nature of the alerts I cannot provide an explicit example.

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.