Skip to content

[Schema Inaccuracy] Example and schema mismatch for #/paths/~1orgs~1{org}~1rulesets/get #5602

@rahulsom

Description

@rahulsom

Schema Inaccuracy

This is the json ref for the example

#/components/examples/org-ruleset-items/value

Schema and example mismatch. enabled is not supported. The supported values are

        "enum": [
          "disabled",
          "active",
          "evaluate"
        ]

Here's a snippet

    2:   "id" : 21,
    3:   "name" : "super cool ruleset",
    4:   "source_type" : "Organization",
    5:   "source" : "my-org",
>   6:   "enforcement" : "enabled",
    7:   "node_id" : "RRS_lACkVXNlcgQB",
    8:   "_links" : {
    9:     "self" : {
   10:       "href" : "https://api.github.com/orgs/my-org/rulesets/21"

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