Feature review pre-migration of Drupal functionality

This API is already available on production, but in what I call a dark launch, in that nothing knows of it or uses it yet. There are some small changes to the API for cleaner URLs and filters, but there are some legacy endpoints still available as well.

Legacy:
https://api.eclipse.org/downloads/file
https://api.eclipse.org/downloads/file/17836060
https://api.eclipse.org/downloads/release/epp?release_name=2022-03&release_version=r

New:
https://api.eclipse.org/downloads/releases/active
https://api.eclipse.org/downloads/releases/epp/2022-03
https://api.eclipse.org/downloads/releases/epp/2022-03/r

These endpoints should help serve downloads much more cleanly and without fuss. We will need to consider how to support Adoptium into this API in the future, but that isn't part of the current state, and is not even planned at this point.

cc @epoirier @cguindon

changed the description

I will let @epoirier take the first pass at reviewing. Once we get his +1 I will doubble check.

assigned to @epoirier

For clarity as it was asked in slack, the legacy endpoints exist in the API as well as the modern URLs. I was attempting to differentiate between URLs that existed previously and the new URLs

changed the description

@malowe

I'm comparing with the documentation on api.eclipse.org and i'm seeing small differences for Download File:

https://api.eclipse.org/downloads/file/17836060

• missing "sha512sum". Was that intended?
• Duplicate id value (file_id and id)

Releases looks good in both legacy and new urls

https://api.eclipse.org/downloads/releases/epp/2022-03

• missing "sha512sum". Was that intended?

Good catch. I would expect to see both in the new API. We need to add it.

Duplicate id value (file_id and id)

Good catch. We don't need the duplicate id. Let's use file_id since it's what we've been using.

My DB instance doesn't have the field, so I can add it and patch that! I can also hide ID easily

assigned to @malowe

added #10 (closed) as child task

@epoirier the changes are live on production: https://api.eclipse.org/downloads/file/17836060

Are we good to close this issue? The assumption is once this issue is closed it is ready for the changes to remove the existing API to be staged. Once that is done I can make the change to nginx to proxy the URL to the new endpoint with a 301.

To me the endpoints looks good but @cguindon wanted to have a look at them before we update nginx.

+1 from me

added team:webdev label

added MBO prioritymedium severitynormal labels

added statewip label

unassigned @epoirier

@malowe this is back in your hands.

I'll do a staging rewrite first and we can go from there.

added statedone label and removed statewip label

This is live and complete, so I'm going to close this issue.

closed