Hi guys
In preparation for the call today, I have quickly gone through the spec at facilityregistry.org and have some comments, some are just simple mistakes that needs to be fixed, and others could be points for disussion…
-
It says 1.0 on http://facilityregistry.org/ already, maybe it should say DRAFT?
-
HTTP Status Codes: I don’t like that we are specifying what the codes mean, but if we do
lets at least update them so that they are correct with regards to responses, e.g.
201 Created should return the body.
(I really don’t like that it in the spec)
-
Success: Again we are saying that it return 200 OK for success?
-
Authentication: Please stop saying ‘token’
-
Authentication: Please just point to where basic auth is defined, don’t give a step-by-step
instruction on how to do it.
-
Versioning: We are linking to http://semver.org, but which version are we targetting? there are
multiple versions. If we are linking to a page describing it, do we need to also describe it ourselves?
-
Facility Object: single quotes are not legal JSON!
-
Extended Properties: I’m very confused what we should do about merging here. Should we also store
potentially stale data from other providers? I assume not?
-
Identifier Properties: Same here. Are we suppose to merge this data? if new identifiers are included in
stream? or do we only care about those that are important to us? If registry A added the identifier, is
registry B allowed to change it?
-
SORTING: Is /facilities.json?sortAsc=properties.MySuperProperty allowed here? or only core props?
-
PAGINATION: I think ?limit=off looks horrible. We are giving another meaning to the limit field, does
this mean paging is off? what about offset? is ?limit=off&offset=10 allowed? if we want to re-use the
limit field, maybe limit=0 would be better?
-
FILTERING FACILITIES: I assume people have agreed on this format? it doesn’t look very nice.
-
FILTER BY ACTIVE STATUS: why is this needed? isn’t this implied by the previous section?
-
Response: Status: 200 OK??? Is this suppose to represent a header? There is no status header.
It should be written in text so its not confusing (or even HTTP/1.1 200 OK, but thats look weird and
assumes HTTP 1.1)
-
“Facility resource not found or unavailable”: how is ‘unavailable’ defined, and how does it differ
from not found… should 404 be used for both? or maybe just remove ‘unavailable’?
-
I think this has been mentioned already. Do we want ‘{ “facility”: { … }’ ? I haven’t seen it used
anywhere else.
-
Update a facility: We don’t need to say “not a partial update”, people are not expecting it to be.
If we were doing partial updates, then we could have mentioned it.
-
“The body can’t be empty and must include at least the name attribute”: I’m not sure about this.
Is ID not required? Should it be assigned if not present?
-
It seems we are using RFC 2119 some places, and other places not. Lets decide if we want it.
(hint: we want it).