Common rules across API space
General conventions
  • all API endpoints start with /api
  • protocol - all APIs exposed using HTTPS protocol
  • entities - camelCase
  • uri paths - camelCase
  • query params names - camelCase

All collections (list of resources) are named by corresponding resource in plural form. Example:workspace -> workspaces

Each collection resource supports paging which can be altered by following query parameters:

  • “size” - a number of objects to be returned, default 20
  • “page” - specify which pagination index will be returned in a collection set