Skip to content

OpenAPI Specification for Metadata API for new site

Jyothish Bhai requested to merge openapispec into main

Created by: kamaldodiya

This PR is to write the OpenAPI Specification for the Metadata API going to be used new website and it will replace some endpoints from genome-search API.

When ready it will replace following endpoints

https://beta.ensembl.org/api/genomesearch/popular_genomes https://beta.ensembl.org/api/genomesearch/genome/info?genome_id=homo_sapiens_GCA_000001405_28

with

https://beta.ensembl.org/api/metadata/popular_genomes https://beta.ensembl.org/api/metadata/genome/info?genome_id=a7335667-93e7-11ec-a39d-005056b38ce3

Note that

  • the metadata API uses genome_uuid.
  • Some fields which were not used in the current endpoints are removed from the metadata API. for example divisions, reference_genome_id etc.

JIRA

https://www.ebi.ac.uk/panda/jira/secure/RapidBoard.jspa?rapidView=628&view=detail&selectedIssue=EWB-49

View in Browser

https://editor.swagger.io/?url=https://raw.githubusercontent.com/Ensembl/ensembl-web-metadata-api/openapispec/APISpecification.yaml

Other Actions

Reitre /api/genomesearch/popular_genomes and /api/genomesearch/genome/info endpoints from the genome-search API when FE/BE is migrated to use genome_uuid.

Edited by Andres Veidenberg

Merge request reports