Create feedURLscheme.json #238
Conversation
Create a URL scheme for feeds and feed management (storage, rations, intake). Support GET, batch and single POST. Along with other commits, resolves adewg#154.
cookeac
requested review from
ahokkonen,
alamers and
AndreasSchultzGEA
and removed request for
AndreasSchultzGEA
url-schemes/feedURLscheme.json
Outdated
| } | ||
| } | ||
| }, | ||
| "/batches/{location-scheme}/{location-id}/feeds": { |
There was a problem hiding this comment.
Should "locations" path be added after /batches -> "/batches/locations/{location-scheme}/{location-id}/diagnoses"? This question also applies to all the other "batches" endpoints in feedURLScheme.json.
There was a problem hiding this comment.
@ahokkonen I felt this wasn't necessary. It makes sense for locations to be part of the URL when you are using REST semantics (GET, collection GET, single POST) because you are describing resources.
The batches semantics is really a form of RPC (here's a batch of stuff I'm sending you; do something useful with it and send back a specialised result message), so the /locations/ path could mislead about the way the message works.
There was a problem hiding this comment.
I think we had a thought somewhere that even for batches, they would be limited per location.
For us, having the location in the url means that we can assume that the batch concerns only that location and validate against that.
There was a problem hiding this comment.
We do have the location filters in the URL so they can be limited per location.
However, given we are not really doing REST at this stage, the URL can have any set of strings in its fixed text that we would like. Are we saying we would like to imply location - and if so, is it locations/batches or batches/locations? It doesn't make a lot of sense to me when it is really just batch posting endpoints, but clearly we can do either.
There was a problem hiding this comment.
For me it could work without "locations" -prefix/suffix all well, but as @alamers mentioned it is still batch per-location posting. I agree that this case is out off the REST specs.
There was a problem hiding this comment.
For symmetry reasons i'd suggest to keep the 'locations' suffix in; this is then similar to other endpoints. Also, it may open up other groupings (other than locations) that can be validated (although that probably is a bit theoretical...)
There was a problem hiding this comment.
Ok. I think we could define the semantics for batches, but I have replaced /batches/ with /batches/locations/ in the URL scheme. I can do this in due course to the other PRs.
Addressing comments on PR adewg#238
In response to comments to adewg#238
To address feedback in adewg#238
Replace /batches/ with /batches/locations as per comments in PR adewg#238
Create a URL scheme for feeds and feed management (storage, rations, intake). Support GET, batch and single POST.
Along with other PRs, resolves #154.