Created by: magaliruffier
- Filling out the template is required. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion;
- Review the contributing guidelines for this repository; remember in particular:
- do not modify code without testing for regression
- provide simple unit tests to test the changes
- the PR must not fail unit testing
- if you're adding/updating documentation of an endpoint, make sure you add/update the necessary parameters to the (template) configuration files in the ensembl-rest_private repo
Using one or more sentences, describe in detail the proposed changes. The default compara is set to 'vertebrates' instead of 'multi. Under the hood, 'multi' is still allowed for backwards compatibility.
Describe the problem. Please provide an example representing the motivation behind the need for having these changes in place. For 96, we will have a single REST server providing access to all Ensembl divisions. For consistency across divisions, we do not want to have a 'multi' compara database that refers to vertebrates, when all other comparas are identified by their divisions (eg Plants, Fungi...) This change allows us to present all divisions equally to our users while ensuring existing functionality remains unchanged. In particular, the default compara is set to 'vertebrates'. That way, users who did not have to specify a compara database until now because only one was available (which is the case for anyone using vertebrates until release 95) will not have to change any of their queries.
If applicable, describe the advantages the changes will have. When querying the /info/comparas endpoint, users will get an meaningful list of compara databases available based on their division name. This will also match the output of the /info/divisions endpoint. Any other functionality will remain unchanged.
If applicable, describe any possible undesirable consequence of the changes. 'multi' can still be used as an equivalent of 'vertebrates', exposing some of our internal workings
Have you added/modified unit tests to test the changes? Yes
If so, do the tests pass/fail? Yes
Have you run the entire test suite and no regression was detected? Yes
Are you changing the functionality of an endpoint? If so, please give a one line summary for the public facing changelog. No change of functionality
eg. [/xenobiology/orthologs] Added the ability to look up orthologs and paralogs from klingons and andorians