study_list method needs to be part of the API, and documented

[jar398]

It's needed by the script that initializes the OTI database. Was there in early versions of the API(s), but it's not in the v3 API documentation, although there's probably a way to call it (trying to find that now).

It appears to be part of phylesystem-api.

[jar398]

Current URL is https://devapi.opentreeoflife.org/v3/study_list, which is not in the usual /v3/api/method form. This can be fixed in apache routing (deploy/setup/opentree-shared.conf). What should the 'api' in /api/ be? studies ? (which usually would go to oti, but could be made to go to phylesystem-api as a special case.)

[jar398]

For a moment I thought this method was deprecated in favor of studies/find_studies, but that makes no sense - the study_list method is used by the script that initialized oti, and the script has to run before find_studies can work at all! This initialization step is the only reason this method (otherwise redundant with find_studies) is needed.

[jar398]

This issue is waiting for a decision on what to call the method, i.e. what X goes after /v3/, and what Y goes after /v3/X/. I tried very hard to set it up with X = studies, and this is just not possible in apache (see http://lifeonubuntu.com/what-is-the-apache-directive-order-of-precedence/).

I don't consider this high priority and may put it off indefinitely. The method only has one purpose, and that is the initialization of the OTI database. Any ordinary client that wants the list of studies can simply use /v3/studies/find_studies.

Anyone object to closing the issue with 'wontfix'?

[jimallman]

Update as of Feb 2022: I see that this method is currently responding at /v3/study_list, so I'll keep it there in the upcoming Pyramid version. The URL structure is odd (vs. /v3/studies/...), but I think that might be a good place to put "internal-use" utility methods that aren't intended for other API consumers.