Skip to content

Improve API Specification #13461

Open
Open
@dcramer

Description

@dcramer

The exposed interfaces in the API have unfortunately become far too varied over the years, and part of this can be blamed on our lack of intentional design behind them. It was always implicit: design it like it was before. Unfortunately implicit design doesn't scale as more people work on a system, so lets spend some time building more standards that can help educate future Sentaurs.

Some topics that need addressed (problems today):

  • Consistency of parameters (e.g. project=1 vs project=slug)
  • Lack of standards around serialization (responses)
  • Some endpoints have gotten extremely large and complex
  • Inconsistency in filesystem (where routes live, naming of routes)

Let's add to this list and just treat this as a master ticket.

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