search

facilityregistry / fred-api

Facility Registry API Documentation Website
11 stars 4 forks source link

Errors - Question / Clarification #53

Open ghost opened 11 years ago

ghost commented 11 years ago

Hello,

Just a quick question / clarification on the document (perhaps this might lead to an update). What is the cardinality of errors in the response from a facility registry? Is it 0..1 or 0..*?

If it is 0..* could we update the samples in the docs to be arrays? If it is just one, I'd like to make a request to increase it (from a user/developer experience standpoint).

Also, is there any need to distinguish between syntactical errors and semantic errors in the HTTP response code? Currently syntax and semantic errors are represented using the 400 error. In some stacks a 400 error is returned when the framework couldn't marshal the request and no additional errors are provided (beyond "HTTP/1.1 400 Invalid"). I realize this may be splitting hairs, but is there any will in the group to distinguish syntax (via 400) and semantics (via 422) in the HTTP code?

edjez commented 11 years ago

Suggest to make support of arrays it a 1.1 addition. Http response codes are well documented codes - each one has its own meaning and implied client interpretation/guarantees; I don't think it adds tangible value to try to classify those on our side.