falcon-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Srimanth Gunturi (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (FALCON-184) Select default content-type for API responses and update docs
Date Sat, 09 Nov 2013 08:57:17 GMT

    [ https://issues.apache.org/jira/browse/FALCON-184?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13818080#comment-13818080
] 

Srimanth Gunturi commented on FALCON-184:
-----------------------------------------

I am thinking the default content-type for all API calls should be JSON (not XML), thereby
not requiring additional headers (users forget to add them frequently). Each API call should
document the default content-type and alternate content-types.

For example, {{/api/admin/stack}} would have a default content-type of {{text/plain}} with
no alternative content-types.
{{/api/admin/version}} would provide {{application/json}} by default, and {{text/xml}} as
alternative.


> Select default content-type for API responses and update docs
> -------------------------------------------------------------
>
>                 Key: FALCON-184
>                 URL: https://issues.apache.org/jira/browse/FALCON-184
>             Project: Falcon
>          Issue Type: Bug
>          Components: prism
>    Affects Versions: 0.3
>            Reporter: Srimanth Gunturi
>            Assignee: Srimanth Gunturi
>             Fix For: 0.4
>
>
> Wiki documentation shows output in JSON. However it does not mention that a request header
of {{Accept: application/json}} is required to output JSON content.
> Either we make JSON the default output in API thereby not requiring an {{Accept}} header.
Or we document the header.



--
This message was sent by Atlassian JIRA
(v6.1#6144)

Mime
View raw message