Skip to content

[Schema Inaccuracy] Example for repositories_parameter is incorrect #5030

Open
@rahulsom

Description

@rahulsom

Schema Inaccuracy

This is the JSON ref

#/paths/~1repos~1{owner}~1{repo}~1code-scanning~1codeql~1variant-analyses/post/responses/201/content/application~1json/examples/repositories_parameter/value

The example has this

   91:   "query_pack_url" : "https://www.example.com",
   92:   "created_at" : "2022-09-12T12:14:32Z",
   93:   "updated_at" : "2022-09-12T12:14:32Z",
   94:   "completed_at" : "2022-09-12T13:15:33Z",
>  95:   "status" : "completed",
   96:   "actions_workflow_run_id" : 3453588,
   97:   "scanned_repositories" : [ {
   98:     "repository" : {
   99:       "id" : 1296269,

Per the schema, status can be one of cancelled, failed, in_progress, succeeded

status comes from #/components/schemas/code-scanning-variant-analysis/properties/status.

Same happens for these JSON refs

#/paths/~1repos~1{owner}~1{repo}~1code-scanning~1codeql~1variant-analyses/post/responses/201/content/application~1json/examples/repository_owners/value
#/paths/~1repos~1{owner}~1{repo}~1code-scanning~1codeql~1variant-analyses/post/responses/201/content/application~1json/examples/repository_lists/value

Reproduction Steps

I found this in ghec and fpt.

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