Skip to content

[Schema Inaccuracy] Wordy Plan availability prefix in branch protection endpoint descriptions #6235

@konradzagozda

Description

@konradzagozda

Schema Inaccuracy

I’ve noticed that the documentation for the /repos/{owner}/{repo}/branches/{branch}/protection endpoints is a bit difficult to read. Currently, 34 different descriptions begin with a boilerplate sentence regarding plan availability:

"Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server."

The actual functional description of the endpoint is buried after this paragraph, which makes it hard to quickly understand what each specific operation does when browsing the spec.

Expected

The documentation could emhpasize the functional description of the endpoint. If the plan availability information is necessary, it would be much more readable if it were:

  • Moved to the end of the description.
  • Included as a "Note" or metadata field.
  • Defined once at the top-level "Branch Protection" category rather than repeated for every sub-operation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions