Versions Compared

Key

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

...

The main rule is - all APIs should remain backwards compatible. It means that:

  1. In the Request: Don't change the parameter from optional to required.
  2. In the Request: Don't add a new parameter to an existing command with required=true option.
  3. In the Request: Don't reduce the command permission from being available to normal user to becoming available to Admin only.
  4. In the Request/Response: Don't rename existing parameters.
  5. In the Request/Response: Don't change the parameter type (from String to Map for example).
  6. In the Response: Don't remove the parameter from the response as the third party software can rely on its presence. 

...