euroargodev / argopy

A python library for Argo data beginners and experts
https://argopy.readthedocs.io
European Union Public License 1.2
178 stars 40 forks source link

New breaking argovis API version 2 #246

Closed gmaze closed 3 weeks ago

gmaze commented 1 year ago

I've noticed this morning that argovis has moved to API version 2 and it's not backward compatible, hence it's breaking argopy ds='argovis' data source and it now requires to register and get an API key

That's a lot to handle to keep it working with argopy any will from your team @donatagiglio to make a PR and keep argovis available in argopy ?

https://argovis.colorado.edu/ https://argovis-api.colorado.edu/docs/

Example of request for a float:

curl -H "x-argokey: <KEY>" -H "accept: application/json" -X GET "https://argovis-api.colorado.edu/argo?platform=6902915&data=all"
gmaze commented 1 year ago

And because the old API is not turned off, our method to check if argovis is alive was misleading: We check if the url "https://argovis.colorado.edu/selection/overview" is responding. if it is, argovis is considered alive. But this url is indeed responding but returning nothing.

donatagiglio commented 1 year ago

Dear Guillaume,Thanks for your message. When you have a moment, could you please point Argopy to the legacy version of Argovis (https://argovisbeta02.colorado.edu/) as described in the email I sent you and Kevin earlier? As described in the message, we will be in touch again about a transition to the new version of Argovis.Thanks,DonataDonata Giglio (She/Her)Assistant ProfessorDepartment of Atmospheric and Oceanic SciencesUniversity of Colorado BoulderMail: 311 UCB | Boulder, CO 80309-0311 Phone: +1-303-735-4354Office:  SEEC N253HomepageOn Feb 15, 2023, at 4:42 AM, Guillaume Maze @.***> wrote: I've noticed this morning that argovis has moved to API version 2 and it's not backward compatible, hence it's breaking argopy ds='argovis' data source and it now requires to register and get an API key That's a lot to handle to keep it working with argopy any will from your team @donatagiglio to make a PR and keep argovis available in argopy ? https://argovis.colorado.edu/ https://argovis-api.colorado.edu/docs/

—Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you were mentioned.Message ID: @.***>

gmaze commented 1 year ago

hi @donatagiglio Sorry your email found its way to my SPAM folder ... I noticed the legacy version change of url, I'm updating argopy to work with it (#247 ) But in the argovis website, it's mentioned to be valid only to March 31st So I'll be happy to work with @billmills to make argopy ready for the new API v2

gmaze commented 1 year ago

for the future PR, the way to pass a key in the request header using our filesystem would be something like:

client_kwargs = {'headers': {'x-argokey': apikey}}
fs = argopy.stores.httpstore(client_kwargs=client_kwargs)
fs.open_json('https://argovis-api.colorado.edu/argo?platform=6902915&data=all')
github-actions[bot] commented 1 year ago

This issue was marked as staled automatically because it has not seen any activity in 90 days

gmaze commented 3 weeks ago

This should be fixed with release v0.1.16