Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
xmo-odoo opened this issue Nov 24, 2021 · 0 comments

Comments

@xmo-odoo
Copy link

xmo-odoo commented Nov 24, 2021

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})

@xmo-odoo xmo-odoo changed the title [Schema Inaccuracy] Seeming redundancy between status and simpl-commit-status [Schema Inaccuracy] Seeming redundancy between status and simple-commit-status Jul 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants