Versions Compared

Old Version 5

changes.mady.by.user Jonathan Pugsley

Saved on

compared with

New Version Current

changes.mady.by.user Jonathan Pugsley

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Properties are named in camelCase

  • Any property that is for the right eye will have the prefix rt

  • Any property that is for the left eye will have the prefix lt

  • Any occurrence of a property for a particular resource will be the same no matter which endpoint returns it across different endpoints (so trayNumber is the tray number of an order is in whether you use GET /orders/123456 or GET /orders/123456/status or POST /orders

Validations

  • All incoming string parameters have a maximum length that will be documented in their description

  • All incoming number parameters have a maximum and minimum value that will be documented in their description

  • All incoming array parameters have a maximum length that will be documented in their description

  • If a parameter is not flagged as required it can be omitted to use default behavior particular to that field - for example, not specifying trayNumber when creating a new order will result in one being automatically generated.