Skip to content

Document coding guidelines for structuring endpoints

In Contributing.md, document:

  • All paths should be scoped under /v1 to make future versioning efforts easier.
  • Use flat paths, e.g. even though builds are "contained" in iterations and namespaces, their URL should be /v1/builds/<UUID>.
  • Always use plural resource names.
Edited by Rafael Epplée
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information