Skip to content

[Schema Inaccuracy] Example and schema mismatch for #/paths/~1repos~1{owner}~1{repo}~1code-scanning~1alerts~1{alert_number}~1instances/get #5622

@rahulsom

Description

@rahulsom

Schema Inaccuracy

This is the json ref for the example

#/components/examples/code-scanning-alert-instances/value

The field fixed_at doesn't exist in the schema, but exists in the example.

Here's a snippet

    3:   "analysis_key" : ".github/workflows/codeql-analysis.yml:CodeQL-Build",
    4:   "environment" : "",
    5:   "category" : ".github/workflows/codeql-analysis.yml:CodeQL-Build",
    6:   "state" : "open",
>   7:   "fixed_at" : null,
    8:   "commit_sha" : "39406e42cb832f683daa691dd652a8dc36ee8930",
    9:   "message" : {
   10:     "text" : "This path depends on a user-provided value."
   11:   },

Expected

The schema and example are in sync

Reproduction Steps

I could reproduce this in

  • fpt
  • ghec
  • ghes-3.14
  • ghes-3.15
  • ghes-3.16
  • ghes-3.17
  • ghes-3.18

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions