Gene Rest API Endpoint to Get Gene related Data

[sprintell]

As developer I want an api endpoint such that that when I send a GET request to the URL, hateoas compliant, paginated list of all mapped genes in the database is returned in JSON Format. Corresponding endpoints {base_url}/v2/genes/HBS1L for retrieving one gene accordingly should be added as well

{
          "geneName": "HBS1L",
          "geneDescription": "HBS1 like translational GTPase",
          "location": "6:134960378-135103056",
          "cytogenetic region": "6q23.3",
          "biotype": "protein_coding",
          "_links": {
            "self": {
              "href": "{base_url}/v2/genes/HBS1L"
            },
            "search": {
              "href": "{base_url}/v2/genes?"
            }
          }
 }

Management Rules

• Rule 1: Endpoint - /v2/genes
• Rule 2: HTTP Request Method - GET
• Rule 3: Endpoint should accept search page and sort parameters as in /v2/genes?page=0&size=20&sort=name,desc
• Rule 4: HATEOAS, sorting, pagination, and some search and filter specification

Acceptance Tests

• Given no parameter, when the front end sends a GET request to the endpoint
• Hateoas compliant list of publications is returned in JSON Format
• Given sorting, pagination, and/or some search and filter parameters
• When the front end sends a GET request to the same endpoint
• Hateoas compliant filtered list of publications satisfying the conditions in the url parameter must be returned

Additional details here

[ala-ebi]

Discussed with the team and we decided to use slim Solr to get the data as it has the field enrichments needed (from Ensembl), avoiding extra processing and Ensembl data caching.