HSLynk API conventions

Jump to bottom

Eric Jahn edited this page Mar 23, 2020 · 4 revisions

populate all models and examples in the API methods
collection members in braces to lower case, eg. {ClientID} -> {clientid}
url segments to lower case (and optionally kebab-case where the words are long)

example:

GET /globalprojects/{globalprojectid}

Request and response bodies should be in lower camel case.

example:

 {
  "client": {
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    ...
  }
 }

all changes will only cause the prior API signature to be marked as "deprecated", so no existing system will be impacted by these changes, until they attempt to upgrade their APIs.