Conventions

Common rules across the API space

General Conventions

  • API endpoints start with /api.
  • APIs are exposed using the HTTPS protocol.
  • camelCase is used for entities, URI paths, and the names of the query parameters.

Paging

All collections (resource lists) are named with the corresponding resource in plural form. For example, workspace is named workspaces when it appears in a collection.

Collection resources support paging. The behavior of paging can be altered by the following query parameters:

  • size
    The number of objects to be returned. The default is 20.
  • page
    Specifies which pagination index will be returned in a collection set. The index starts at 0.
Authentication
Errors