Re: [ietf-types] Request for review: application/json-patch

[mike amundsen <[e-mail]>]

Paul:

checking the I-D document itself:

Sec #4 Operations:
"It is an error condition if an operation object contains more than
one operation member."

I am not clear on what this is telling me:
- the same JSON Pointer expression cannot appear more than once in a document
- something else?

possibly consider adding an example of a document that should be
rejected as it is malformed.

Sec #5 Error Handling
"In the event of an error condition, evaluation of the JSON Patch
document terminates and modification of the target document fails to
complete."

Does this mean the server should treat the document as an
"all-or-nothing" case? when an error occurs is the document left in a
"partial state" or left at the "initial state" before the request? is
this something you want to detail in the spec? if yes, you might want
to use RFC 2119 words here (MAY, SHOULD, MUST, etc.) .

It looks like your operations account for an error condition at the
individual "node" level:
"It is an error condition if the value to be replaced does not exist.", etc.

Are there error conditions that might occur at the "document" level
(or some other node above the target?

You do not indicate any use of 4xx codes here (i.e. mapping 4xx codes
to common error conditions in processing the patch); is this something
you want to include here or leave that up to the server to decide?

mca
http://amundsen.com/blog/
http://twitter.com@mamund
http://mamund.com/foaf.rdf#me





On Mon, Oct 24, 2011 at 17:02, Paul C. Bryan <[e-mail]> wrote:
> I'm preparing for possibly taking an informational Internet-Draft [1]
> toward a proposed standard. I'm requesting review and feedback on the
> "application/json-patch" media type. To wit:
>
> -----
>
> The Internet media type for a JSON Patch document is application/
> json-patch.
>
> Type name:  application
>
> Subtype name:  json-patch
>
> Required parameters:  none
>
> Optional parameters:   none
>
> Encoding considerations:
>   Per JSON [RFC4627]: 8bit if UTF-8; binary if UTF-16 or UTF-32.
>
> Security considerations:
>   See Security Considerations in section 8.
>
> Interoperability considerations:  N/A
>
> Published specification:
>   draft-pbryan-json-patch-02
>
> Applications that use this media type:
>   HTTP clients and servers.
>
> Additional information:
>
>   Magic number(s):  N/A
>
>   File extension(s):  .json-patch
>
>   Macintosh file type code(s):  TEXT
>
> Person & email address to contact for further information:
>   Paul C. Bryan <[e-mail]>
>
> Intended usage:  COMMON
>
> Restrictions on usage:  none
>
> Author:  Paul C. Bryan <[e-mail]>
>
> Change controller:  Paul C. Bryan <[e-mail]>
>
> -----
>
> Thank you for your consideration.
>
> Paul C. Bryan
> [e-mail]
>
> [1] http://www.ietf.org/id/draft-pbryan-json-patch-02.txt
>
>
> _______________________________________________
> ietf-types mailing list
> [e-mail]
> https://www.ietf.org/mailman/listinfo/ietf-types
>