Skip to content

[Schema Inaccuracy] Example and schema mismatch for #/paths/~1repos~1{owner}~1{repo}~1check-runs/post #5615

@rahulsom

Description

@rahulsom

Schema Inaccuracy

This is the json ref for the example

#/components/examples/check-run-example-of-in-progress-conclusion/value

#/components/examples/check-run-example-of-completed-conclusion/value

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

Here's a snippet

   32:     "permissions" : {
   33:       "metadata" : "read",
   34:       "contents" : "read",
   35:       "issues" : "write",
>  36:       "single_file" : "write"
   37:     },
   38:     "events" : [ "push", "pull_request" ]
   39:   },
   40:   "check_suite" : {

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