Define breaking changes

[mtrezza]

New Feature / Enhancement Checklist

• [x] I am not disclosing a vulnerability.
• [x] I am not just asking a question.
• [x] I have searched through existing issues.

Current Limitation

It is currently not defined what constitutes a breaking change in Parse Platform org.

Feature / Enhancement Description

Add a section to the docs which defines what's considered a breaking change and - as importantly - what is not.

What is a braking change:

• Changing the name of an API endpoint, method or variable.
• Changing the http response code of an API response.
• Changing the behavior of an endpoint or method.
• Changing the code part of a Parse.Error.

What is not a braking change:

• Changing of unexposed (internal) Parse Server methods and variables.
• Changing the message part of a Parse.Error.

Example Use Case

It is unclear whether changing the "message" part of a Parse.Error is considered a breaking change or not. Developers may sometimes use the error text to get detect the exact error because the "code" part of a Parse.Error may be ambiguous.

Alternatives / Workarounds

n/a

[parse-github-assistant[bot]]

Thanks for opening this issue!

• 🎉 We are excited about your ideas for improvement!