Regulation 2024 updates (113)

[pblins]

Description

- Retire Regulation REST API endpoints (ENSINT-1794)

Regulation has endpoints for retrieving regulatory feature activity and for listing epigenome metadata.

GET regulatory/species/:species/id/:id GET regulatory/species/:species/epigenome The schema for these is based on the Perl API, which is closely tied to the current site. However, we are developing new APIs for Ensembl beta, which will use the schema from our new pipeline and RDR (Regulation Data Registry).

As far as we can tell, these endpoints don’t seem heavily used. We would therefore like to retire them to avoid confusion. Users will be redirected to the beta site, the ftp site and/or the regulation subsite for up-to-date data.

For similar reasons, we will be removing the other_regulatory feature type from the overlap endpoints: GET overlap/region/:species/:region and GET overlap/id/:id.

- Retire microarray REST API endpoints (ENSINT-1776)

The Microarray probemapping pipeline has existed for a long time. It continues to run, but its maintenance and running costs outweigh the current importance of microarray technology and current usage numbers. Regulation therefore intends to gradually phase out this pipeline.

The microarray REST endpoints will be removed in 113:

GET regulatory/species/:species/microarray/:microarray/vendor/:vendor GET regulatory/species/:species/microarray GET regulatory/species/:species/microarray/:microarray/probe/:probe: GET regulatory/species/:species/microarray/:microarray/probe_set/:probe_set

For similar reasons, we will be removing the array_probe feature type from the overlap endpoints: GET overlap/region/:species/:region and GET overlap/id/:id.

Changelog

GET regulatory/species/:species/id/:id: ❌ removed GET regulatory/species/:species/epigenome: ❌ removed GET regulatory/species/:species/microarray/:microarray/vendor/:vendor: ❌ removed GET regulatory/species/:species/microarray: ❌ removed GET regulatory/species/:species/microarray/:microarray/probe/:probe:: ❌ removed GET regulatory/species/:species/microarray/:microarray/probe_set/:probe_set: ❌ removed GET overlap/region/:species/:region: ⚠️ updated (_otherregulatory and _arrayprobe removed as possible feature types) GET overlap/id/:id: ⚠️ update (_otherregulatory and _arrayprobe removed as possible feature types)