openservicebrokerapi / servicebroker

Open Service Broker API Specification
https://openservicebrokerapi.org/
Apache License 2.0
1.19k stars 434 forks source link

What is the change policy across major versions? #536

Closed williammartin closed 6 years ago

williammartin commented 6 years ago

While reading the change policy, it seems to be written as if either each version of the OSBAPI would be a different spec, or that there can be no breaking changes across major version changes?

For example, Existing endpoints and fields MUST NOT be removed or renamed. makes sense for compatibility across minor versions, but I suspect this is not a guarantee the OSBAPI wants to make across major versions?

Do we need to add a small note to this effect?

duglin commented 6 years ago

Hmm, I think it was written with the assumption of just minor version changes - not major. Want to open a PR to clarify that?

williammartin commented 6 years ago

Maybe something as simple as updating the header to Change Policy (minor versions) would be enough to satisfy this?

duglin commented 6 years ago

Yup - sounds reasonable to me