)]}'
{"doc/source/index.rst":[{"author":{"_account_id":11564,"name":"Chris Dent","email":"cdent@anticdent.org","username":"chdent"},"change_message_id":"a428eac4de45ff202c10e7d197783664b03db973","unresolved":false,"context_lines":[{"line_number":33,"context_line":"    The API Working Group guidelines are written with the implicit assumption"},{"line_number":34,"context_line":"    that, when discussing data representations in request or response bodies,"},{"line_number":35,"context_line":"    all data is in a JSON-based format. Non-JSON based APIs are acceptable"},{"line_number":36,"context_line":"    but they are out of the scope for these guidelines."},{"line_number":37,"context_line":""},{"line_number":38,"context_line":"Guidelines"},{"line_number":39,"context_line":"----------"}],"source_content_type":"text/x-rst","patch_set":2,"id":"fa7ab95a_57c85255","line":36,"updated":"2016-09-02 09:11:44.000000000","message":"I think we can make this either more specific or more generic depending on which way we want to go.\n\nEither we should say that guidelines related to bodies are oriented towards JSON, thus keeping things like the URI guidelines and general advice about how to do HTTP well in scope for everyone.\n\nOr we should more directly address John\u0027s concerns which were, effectively, that even our HTTP guidelines are only truly applicable when talking about APIs which follow the norms of \"small\" request and response body based apis. All bets are off when things get larger and/or binary.\n\nWhatever we do what we want to make sure is that we don\u0027t turn people away who would find useful info here.","commit_id":"a32e1e7e9b28eecdf591bb63422744a976331810"},{"author":{"_account_id":11564,"name":"Chris Dent","email":"cdent@anticdent.org","username":"chdent"},"change_message_id":"923e3ba02287d58e506ba29c031e327746a46bb6","unresolved":false,"context_lines":[{"line_number":33,"context_line":"    The API Working Group guidelines are written with the implicit assumption"},{"line_number":34,"context_line":"    that, when discussing data representations in request or response bodies,"},{"line_number":35,"context_line":"    all data is in a JSON-based format. Non-JSON based APIs are acceptable"},{"line_number":36,"context_line":"    but they are out of the scope for these guidelines."},{"line_number":37,"context_line":""},{"line_number":38,"context_line":"Guidelines"},{"line_number":39,"context_line":"----------"}],"source_content_type":"text/x-rst","patch_set":2,"id":"7a8ec9b2_564a9884","line":36,"in_reply_to":"9a89bdaa_c479be94","updated":"2016-09-14 09:56:23.000000000","message":"How about something like\n\nThese documents from the API Working Group are primarily focused on providing advice and guidelines for JSON-based APIs. While other representations have their place in the OpenStack ecosystem, they present such a diversity of challenges and edge cases, especially with large and/or binary request and response bodies, it is impossible to provide guidance that is complete. Where there is doubt refer to the HTTP RFCs, 7230 through 7235, as the ultimate authority.","commit_id":"a32e1e7e9b28eecdf591bb63422744a976331810"},{"author":{"_account_id":10670,"name":"Michael McCune","email":"elmiko@redhat.com","username":"mimccune"},"change_message_id":"84097fe2a699162e991d3e2625b019c55a58e7e5","unresolved":false,"context_lines":[{"line_number":33,"context_line":"    The API Working Group guidelines are written with the implicit assumption"},{"line_number":34,"context_line":"    that, when discussing data representations in request or response bodies,"},{"line_number":35,"context_line":"    all data is in a JSON-based format. Non-JSON based APIs are acceptable"},{"line_number":36,"context_line":"    but they are out of the scope for these guidelines."},{"line_number":37,"context_line":""},{"line_number":38,"context_line":"Guidelines"},{"line_number":39,"context_line":"----------"}],"source_content_type":"text/x-rst","patch_set":2,"id":"9a89bdaa_c479be94","line":36,"in_reply_to":"fa7ab95a_57c85255","updated":"2016-09-08 16:15:12.000000000","message":"those are excellent points, and yes, i would like to address John\u0027s concerns.\n\ni think i prefer the latter suggestion, but i\u0027m not sure on the best wording to use here.","commit_id":"a32e1e7e9b28eecdf591bb63422744a976331810"}]}