Add OpenAPI spec for species search
1 unresolved thread
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
Activity
Filter activity
requested review from @kamal, @mcharkhchi, and @andres
- Resolved by Kamal Dodiya
- Resolved by Kamal Dodiya
- Resolved by Kamal Dodiya
- Resolved by Kamal Dodiya
- Resolved by Kamal Dodiya
- Resolved by Kamal Dodiya
- Resolved by Kamal Dodiya
- Resolved by Kamal Dodiya
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: As agreed during Daily scrum this should be a separate task and should not be included along with this PR. Approving.
Edited by Kamal Dodiya
mentioned in commit 886cb736