Skip to content
Snippets Groups Projects

Add OpenAPI spec for species search

Merged Andrey Azov requested to merge add-species-search-spec into master
1 unresolved thread

Jira ticket: https://www.ebi.ac.uk/panda/jira/browse/ENSWBSITES-2024

Note that the proposed path, and the name of the query parameter, are different from what is suggested in the description of the ticket.

The typescript equivalent of the proposed schema is:

type SpeciesSearchMatch = {
  genome_id: string;
  genome_tag: string | null;
  common_name: string | null;
  scientific_name: string;
  type: {
    kind: string; // e.g. "population"
    value: string; // e.g. "European"
  } | null;
  is_reference: boolean;
  assembly: {
    accession_id: string;
    name: string;
    url: string;
  };
  coding_genes_count: number;
  contig_n50: number | null; // E.coli doesn't have contig n50 in species stats
  has_variation: boolean;
  has_regulation: boolean;
  annotation_provider: string;
  annotation_method: string;
  rank: number | null; // <-- to know that some matches are more important than others and should be put on top
};

type SpeciesSearchRequest = {
  query: string;
};

type SpeciesSearchResponse = {
  matches: SpeciesSearchMatch[];
  meta: {
    total_count: number;
  }
};

Merge request reports

Pipeline #436063 passed

Pipeline passed for f5f49287 on add-species-search-spec

Deployed to wp-h‎x-dev‎ 1 year ago
Approved by

Merged by Kamal DodiyaKamal Dodiya 1 year ago (Aug 31, 2023 9:22am UTC)

Merge details

  • Changes merged into master with 886cb736 (commits were squashed).
  • Deleted the source branch.

Pipeline #437874 passed

Pipeline passed for 886cb736 on master

9 environments impacted.

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Kamal Dodiya
  • Kamal Dodiya
  • Kamal Dodiya
  • Kamal Dodiya
  • Kamal Dodiya
  • Kamal Dodiya
  • Kamal Dodiya
  • Andrey Azov added 1 commit

    added 1 commit

    Compare with previous version

  • Andrey Azov added 1 commit

    added 1 commit

    Compare with previous version

  • Andrey Azov added 1 commit

    added 1 commit

    • f5f49287 - Remove titles in openapi spec

    Compare with previous version

  • Kamal Dodiya resolved all threads

    resolved all threads

  • Kamal Dodiya
    Kamal Dodiya @kamal started a thread on the diff
  • 9 9 url: http://www.apache.org/licenses/LICENSE-2.0.html
    10 10 version: 1.0.0
    11 11 servers:
    12 - url: http://2020.ensembl.org/api/
    12 - url: http://beta.ensembl.org/api/
    13 13 tags:
    14 14 - name: search
    15 15 description: Search endpoint for in-app search aka gene-search
    16 16 externalDocs:
    17 17 description: Find out more
    18 url: http://2020.ensembl.org
    18 url: http://beta.ensembl.org
    19 19 paths:
    20 20 /search:
  • Kamal Dodiya approved this merge request

    approved this merge request

  • Andres Veidenberg approved this merge request

    approved this merge request

  • Kamal Dodiya mentioned in commit 886cb736

    mentioned in commit 886cb736

  • merged

  • Please register or sign in to reply