search

ODM2 / ODM2RESTfulWebServices

A Python RESTful web service inteface for accessing data in an ODM2 database via Django rest swagger APIs.
http://odm2.github.io/ODM2RESTfulWebServices/
BSD 3-Clause "New" or "Revised" License
3 stars 4 forks source link

Update /resultvalues endpoint #75

Closed lsetiawan closed 6 years ago

lsetiawan commented 6 years ago

Once PR https://github.com/ODM2/ODM2PythonAPI/pull/136 is merged /resultvalues need to be updated.

emiliom commented 6 years ago

Thanks for staying on top of this :smiley:

I'll repeat (and tweak) the comment I made on https://github.com/ODM2/ODM2PythonAPI/pull/136:

Let's make sure Jeff et al are very aware of this change. Correct me if I'm wrong, but all existing code that uses output from this API endpoint will need to be upgraded to the case-sensitive names, right?

lsetiawan commented 6 years ago

but all existing code that uses output from this API endpoint will need to be upgraded to the case-sensitive names, right?

Yes indeed :smile:

lsetiawan commented 6 years ago

This Issue was addressed in #76

lsetiawan commented 6 years ago

I'm reopening this issue. @emiliom My question now is, should the endpoint also default to lowercase or not?

emiliom commented 6 years ago

My question now is, should the endpoint also default to lowercase or not?

Unlike odm2api, the REST API is very new and experimental, and has very few "live" uses yet. For that reason, we should be more confident in marching ahead with disruptive changes if they result in doing what's best in the long run.

So, I suggest you should stick with having the REST API return CamelCase responses. But please work with whoever is actively using the REST API code to give them (him?) a heads up. If I remember correctly, it's mainly one person in Jeff's team who is working on the "Sample Data Viewer", right?

horsburgh commented 6 years ago

@Elijahwalkerwest would need to do a new deployment for us, and @Maurier would need to update his specimen data viewer code to make sure it works if you change the casing.

emiliom commented 6 years ago

Thanks, @horsburgh! @lsetiawan please work with them in laying out a workable transition timeframe.

BTW, I see no tagged released has ever been issued for ODM2 REST API. See #59. Maybe we (meaning @lsetiawan :smiley_cat: ) should first work towards a first release that freezes the current state of the ODM2 REST API? Then it'll be cleaner to roll out these enhancements as a new release.

lsetiawan commented 6 years ago

This endpoint has been resolved, Preparing for release... Closing.