Swirrl / datahost-prototypes

Eclipse Public License 1.0
0 stars 0 forks source link

Breaking API change: distinguish many from singular in routes #277

Closed RickMoynihan closed 1 year ago

RickMoynihan commented 1 year ago

e.g.

/data/series/:series-slug/releases/:release-slug should be /data/series/:series-slug/release/:release-slug because we are talking about a single release, whilst:

/data/:series-slug/releases should be plural because we are returning many releases.

Similarly we should rename revisions in the URI's to be revision.

changes in the URI should be renamed to commit in the singular and commits in the plural.

This would mean that for example:

/data/the-census/releases/2020/revisions/1/changes/2 becomes: /data/the-census/release/2020/revision/1/commit/2