Skip to content

API Developer Guidelines

Simon Redfern edited this page Jan 15, 2017 · 8 revisions

API Developers should follow these guidelines:

  1. Don't introduce inconsistencies in names

For instance, View permissions are named can_add_..., can_see_..., can_edit_ , can_delete_... So, whilst it might be tempting to start following Create Read Update Delete (CRUD) names instead, don't - unless we change all of those names everywhere, (say in a new major version of the API)

Clone this wiki locally