Skip to content

[Schema Inaccuracy] Code Scanning Alert #4728

Open
@BenedictStrunk-otto

Description

@BenedictStrunk-otto

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.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions