Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add releases endpoint #65

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Add releases endpoint #65

wants to merge 5 commits into from

Conversation

bilalebi
Copy link
Contributor

@bilalebi bilalebi commented Mar 5, 2025

Description

Add /releases endpoint which returns all the releases (for now)

Related JIRA Issue(s)

https://www.ebi.ac.uk/panda/jira/browse/ENSWBSITES-2908

Example(s)

Request

/api/metadata/releases

Response

[
  {
    "name": "2023-10-18",
    "type": "partial",
    "is_current": false
  },
  {
    "name": "2024-09-18",
    "type": "partial",
    "is_current": false
  },
  {
    "name": "2024-10-28",
    "type": "partial",
    "is_current": false
  },
  {
    "name": "2023-10",
    "type": "integrated",
    "is_current": true
  },
  {
    "name": "2025-01-16",
    "type": "partial",
    "is_current": true
  },
  {
    "name": "2025-02-28",
    "type": "partial",
    "is_current": false
  }
]

Dependencies

This PR needs to be merged and deployed first: Ensembl/ensembl-metadata-api#128

@bilalebi bilalebi added the enhancement New feature or request label Mar 5, 2025
@bilalebi bilalebi self-assigned this Mar 5, 2025
example: 2023-10-18
is_current:
type: boolean
example: true
Copy link
Contributor

@azangru azangru Mar 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • If the shape of release here is the same as the shape of release coming out of the /releases endpoint, then shouldn't line 444 just reference the release object on line 1076?
  • I am confused about the meaning of the is_current field here. It may mean:
    • that the release itself is current (i.e. latest integrated/partial), or
    • that the genome/release combination is current

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the shape of release here is the same as the shape of release coming out of the /releases endpoint, then shouldn't line 444 just reference the release object on line 1076?

Yes, you're right, thank you for pointing that out, I've done the changes

I am confused about the meaning of the is_current field here.

It's the one attached to a release, would you like me to call it somthing more explicit like release_is_current?

@bilalebi
Copy link
Contributor Author

bilalebi commented Mar 6, 2025

@azangru as we agreed, this commit cad0c07 removes release is_current from /explain and /details.

FFR: We agreed to remove is_current from those two endpoints for the following reason

  • release is_current form a genome perspspective doesn't provide any useful inforrmation
  • It's confusing, see the seconfbullet point in the comment above

@bilalebi bilalebi requested a review from veidenberg March 6, 2025 11:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants