openservicebrokerapi / servicebroker

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

Spec should be uniform in naming entities #455

Closed DevasiaThomas closed 6 years ago

DevasiaThomas commented 6 years ago

This is with respect to Provisioning and Updating. For eg: in Provisioning its called space_guid but when it comes to Updating for previous values its called space_id. Can we make this uniform please?

mattmcneeney commented 6 years ago

@DevasiaThomas I totally agree. However thespace_id field in the previous_values object has been deprecated and will be removed in a future version of the spec. This will remove this inconsistency and so I don't think there is much else we can do at this time.

DevasiaThomas commented 6 years ago

@mattmcneeney Yes, I saw that for associated fields as well. I had this cool construct in Java using inheritance and a contains relationship to deal with the json request body for Update. And when things didn't map I was like "duh..." XD. Btw at the moment context's fields aren't defined properly - will it be left platform dependent or will you be defining it in the next version? I would like it if you guys defined it.

mattmcneeney commented 6 years ago

You may have seen this, but we have some of the context fields defined in profile.md. It's platform dependent and subject to change, hence it is in a separate 'spec' for now.

DevasiaThomas commented 6 years ago

Yeah I saw that. Thanks.