Skip to content

[Schema Inaccuracy] Seeming redundancy between status and simple-commit-status #698

Open
@xmo-odoo

Description

@xmo-odoo

The types "status" and "simple-commit-status" seem really similar, and it's quite debatable whether "simple" is any simpler than its colleague:

  • simple has a lot more typing (in that it has format specifiers, which status lacks)
  • simple has an additional required field, whose purpose is unexplained, which is both optional and nullable
  • status has an additional creator (nullable-simple-user)
  • simple flags description is nullable

Seems like the two could (and should) be unified, the divergences are pretty small and don't look like they should exist (especially the undocumented differences in nullability between the two's description field)

Also status should be an enum with the possible values (as far as I can tell "pending", "success", "error", or "failure", these are the statuses specifically enumerated for /repos/{owner}/{repo}/statuses/{sha})

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions