ADD upsert operation #3217
ADD upsert operation #3217
Conversation
|
|
||
| + Response 201 | ||
| + Response 201 204 |
There was a problem hiding this comment.
Not sure how this should be included in the .apib
- Enumerating the possible 2xx codes? (as it is now)
- Using two
+ Responseblocks, one for 201 the other for 204? - Using only 201 as an example (as it was before)?
@jmcanterafonseca some advice on this would be great, please.
There was a problem hiding this comment.
Better to add a new response code
There was a problem hiding this comment.
Does .apib accept to have something like this?
+ Response 201
...
+ Response 204
...
(Maybe is a naïve question, but we haven't used that pattern in the .apib up to now :)
There was a problem hiding this comment.
New block added in 6566b8a... although I'm not sure if works this way (as asked in my previous comment).
| @@ -1074,7 +1074,8 @@ the JSON entity representation format (described in a "JSON Entity Representatio | |||
|
|
|||
| Response: | |||
|
|
|||
| * Successful operation uses 201 Created. Reponse includes a `Location` header with the URL of the | |||
| * Successful operation uses 201 Created (if upsert option is not used) or 204 No Content (if | |||
| upsert option is used). Reponse includes a `Location` header with the URL of the | |||
There was a problem hiding this comment.
Only Location header will be present when there was actually an entity creation
There was a problem hiding this comment.
I think is better to include always the Location heaader. It will be redudant in the case of update, but at the same time it offerst a less variable response interface for clients. It doesn't hurt.
| @@ -1106,8 +1107,10 @@ Response: | |||
| + Members | |||
| + keyValues - when used, the request payload uses the `keyValues` simplified entity | |||
| representation. See "Simplified Entity Representation" section for details. | |||
| + upsert - when used, entity is updated if already exits (otherwise this situation causes | |||
| a 422 Unprocessable Entity error). | |||
There was a problem hiding this comment.
clarify this better, perhaps putting that sentence separate
There was a problem hiding this comment.
Trying to clarify in 6566b8a
|
|
||
| + Response 201 | ||
| + Response 201 204 |
There was a problem hiding this comment.
Better to add a new response code
| @@ -1106,13 +1107,21 @@ Response: | |||
| + Members | |||
| + keyValues - when used, the request payload uses the `keyValues` simplified entity | |||
| representation. See "Simplified Entity Representation" section for details. | |||
| + upsert - when used, entity is updated if already exits. If upsert is not used and | |||
There was a problem hiding this comment.
use backtick for 422 Unprocessable Entity
Implements #3215
Requested LGTMs: @kzangeli (mainly for the code and test parts) @jmcanterafonseca (mainly for the .apib parts)