...
| Description | Backwards Compatible | Convention Impacts | Overall CPS Convention impact | Consistency between yang model and JSON | Cost | Comments | |
|---|---|---|---|---|---|---|---|
| 1 | Change OpenApi to kebab-casing | No - This would involve changing what is in red above. So changes to cmhandle registration and JSON responses. |
| Would expect all endpoints to use kebab-casing: dataspace-name, schema-set. | Solved | Some endpoints effected Version management needed | Not backwards compatible is a big issue |
| 2 | Change dmi-registry to camelCasing | No - Would involve internal changes. Only changes to CM Handle API. | IEEE Guidelines state yang identifiers should be in kebab casing https://1.ieee802.org/yang-guidelines/ | Would expect all endpoints to use camel-casing: dataspaceName, schemaSet. Not what we do now | Solved | Liquibase updates | Not even considering, too many impacts to codebase and breaks yang convention. |
| 3 | Do nothing / Document | Nothing changes | Conforms to conventions | Would expect all endpoints to use kebab-casing: dataspace-name, schema-set. Is what we do have now | Inconsistencies not addressed | Describe in RTD | Team recommends |
Foreseen Impacts
Change OpenApi to kebab-casing
...