Developer friend field naming for x-osb-cmdb

[gberche-orange]

Expected behavior

As a service broker author

• in order to consume the osb api extension x-osb-cmdb with automatic field mapping
• I need the field name to be valid in my programming language

Observed behavior

x-osb-cmdb uses dash character which is not supported in field name in

• python: requires a custom decoder see https://docs.python.org/3/library/json.html#json.JSONDecoder
• javascript: https://stackoverflow.com/questions/29482226/json-object-with-dash-character-on-element-name

Use of _ would be more developer friendly.

Affected release

Reproduced on version 1.4.0

Alternative fixes

1. introduce a new field x_osb_cmdb. Document x-osb-cmdb as deprecated but keep it.
2. introduce a new field x_osb_cmdb. Remove x-osb-cmdb field from requests (breaking change)
3. introduce a new field x_osb_cmdb. add opt-in to keep x-osb-cmdb (likely as user-facing a catalog tag/metadata)

Impacts of 1) :

• more verbose payload
• confusions for service broker authors to see duplicated fields

Impacts of 2) :

• service brokers with existing updateable service instances need to support both variations x_osb_cmdb and x-osb-cmdb (since once the breaking change is deployed they will receive updates including x_osb_cmdb param

Impacts of 3)

• user-facing opt-in somewhat damages UX
• implementation complexity for osb-cmdb