update doc comments for create/update with regards to return values

This commit is contained in:
Gered 2014-08-01 15:12:04 -04:00
parent 00350cfccc
commit 30aaf2a16c

View file

@ -299,8 +299,11 @@
(search base-url type where params))) (search base-url type where params)))
(defn create (defn create
"creates a new resource. returns the created resource if successful and the server response "creates a new resource. if the creation succeeded, then the new resource is returned,
contained a 'Location' header, otherwise returns nil. throws an exception otherwise. unless the return-resource? argument is false, in which case the url to the new
resource is returned (which will contain the resource id). if a 'Location' header
was not set in the response, nil is returned on success. throws an exception if an
error was received.
reference: reference:
create: http://hl7.org/implement/standards/fhir/http.html#create" create: http://hl7.org/implement/standards/fhir/http.html#create"
@ -317,9 +320,11 @@
:follow-location? return-resource?))) :follow-location? return-resource?)))
(defn update (defn update
"updates an existing resource. returns the updated resource if successful and the server "updates an existing resource. if the update succeeded, then the updated resource is
response contained a 'Location' header, otherwise returns nil. throws an exception if returned, unless the return-resource? argument is false, in which case the url to
an error response was received. the updated resource is returned (which will contain the resource id and version
number). if a 'Location' header was not set in the response, nil is returned on
success. throws an exception if an error response was received.
reference: reference:
update: http://hl7.org/implement/standards/fhir/http.html#update" update: http://hl7.org/implement/standards/fhir/http.html#update"