microsoft / CCF

Confidential Consortium Framework
https://microsoft.github.io/CCF/
Apache License 2.0
777 stars 211 forks source link

Expose option in `GET /gov/service/javascript-app` to return endpoint details in the original format/casing as was in the bundle #6433

Open gaurav137 opened 2 months ago

gaurav137 commented 2 months ago

With gov/service/javascript-app the modification of endpoint schema from snake_case inputs to camelCase in output breaks validations logic we have. Eg js_module in the bundle is jsModule in the javascript-app ouptut. We query CCF to know its endpoint and modules and compare it with bundle.json to know if the same exact bundle is already deployed. With the snake vs camel case change it will become more difficult if we have to massage the gov/service/javascript-app output at our end. Is it possible that CCF also exposes the endpoint and module schema in the same structure/casing as the bundle schema?

achamayou commented 2 months ago

@gaurav137 versioned APIs follow Azure guidelines, which specify camelCase, hence the conversion. We have kept the bundle format stable though, because it is signed. We will probably start accepting camelCase bundles as well in the future.

For now I think the best thing to do is to add an optional ?case=original to gov/service/javascript-app, which would allow you to get the original submission back easily. That would also address #6434.