updated compara endpoints documentation

Created by: waakanni

Requirements

• 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

Description

One or more sentences describing in detail the proposed changes.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut feugiat ligula vel enim congue, nec faucibus turpis ornare. Integer nulla massa, fermentum nec elit a, dapibus luctus ante. Vestibulum eleifend enim et consectetur convallis.

Use case

Describe the problem. Please provide an example representing the motivation behind the need for having these changes in place.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas lobortis aliquet risus id dapibus. In vulputate porta justo. Vestibulum in arcu varius, laoreet urna a, egestas dui.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam ultrices egestas urna, vel mollis felis viverra iaculis. Phasellus ac nisi imperdiet ipsum viverra porta.

Benefits

If applicable, describe the advantages the changes will have.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean eget diam quis leo faucibus sagittis. Sed dapibus, magna ut porttitor malesuada, lorem purus tincidunt magna, ut dignissim mi quam et elit.

Possible Drawbacks

If applicable, describe any possible undesirable consequence of the changes.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Cras molestie tincidunt quam, id dapibus mauris consequat eu. Phasellus in neque quis purus laoreet malesuada in sit amet tellus.

Testing

Have you added/modified unit tests to test the changes?

Yes.

If so, do the tests pass/fail?

Pass, of course.

Have you run the entire test suite and no regression was detected?

Yes.

Changelog

Are you changing the functionality of an endpoint? If so, please give a one line summary for the public facing changelog.

eg. [/xenobiology/orthologs] Added the ability to look up orthologs and paralogs from klingons and andorians