OSDir


[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Default API response type: XML -> JSON


This can possibly fail some environments, but it depends on feedback from users.

One option is to introduce global settings, (but we've got many of those) such that it's set to XML set in ConfigKey, but when a new env is installed (as part of server xml/sql) we set it to JSON.


Another option is, do a survey, leave it open for few months and based on the feedback decide to accept the PR.


- Rohit

<https://cloudstack.apache.org>



________________________________
From: Rafael Weingärtner <rafaelweingartner@xxxxxxxxx>
Sent: Tuesday, April 24, 2018 4:05:30 PM
To: users
Cc: dev
Subject: Re: Default API response type: XML -> JSON

No problem Marc, but I still do not think that having a parameter is an
overkill. My view is that if there is a decision to be made (regarding the
default response type for requests), if we (as developers) take this
decision (hardcode it), why not externalize it? I do not see as overkill,
it is a matter of having a flexible tool.

I do not think that forcing to have a response type would be a good thing
now. It would break requests that do not have it.


On Tue, Apr 24, 2018 at 7:14 AM, Marc-Aurèle Brothier <marco@xxxxxxxxxxx>
wrote:

> @rafael - I think it's overkill to have this as a configuration option. We
> should have one default response type, or maybe not have a default one and
> enforce the use of the response type the client is willing to receive.
>
> On Mon, Apr 23, 2018 at 3:39 PM, Rafael Weingärtner <
> rafaelweingartner@xxxxxxxxx> wrote:
>
> > I do think it is an interesting proposal. I have been thinking, and what
> if
> > we do something different; what about a global parameter where the root
> > admin can define the default serialization mechanism (XML, JSON, RDF,
> > others...)? The default value could be XML to maintain backward
> > compatibility. Then, it is up to the root admin to define this behavior.
> >
> >
> > On Mon, Apr 23, 2018 at 10:34 AM, Marc-Aurèle Brothier <
> marco@xxxxxxxxxxx>
> > wrote:
> >
> > > Hi everyone,
> > >
> > > I thought it would be good to move from XML to JSON by default in the
> > > response of the API if no response type is sent to the server along
> with
> > > the request. I'm wondering that's the opinion of people on the mailing
> > > list.
> > >
> > > Moreover, if anyone knows a tool working with the API in XML can you
> list
> > > them, so I could check the code and see if the change can be done
> without
> > > breaking it.
> > >
> > > PR to change default response type: (
> > > https://github.com/apache/cloudstack/pull/2593).
> > > If this change would cause more trouble, or is not needed in your
> > opinion,
> > > I don't mind to close the PR.
> > >
> > > Kind regards,
> > > Marc-Aurèle
> > >
> >
> >
> >
> > --
> > Rafael Weingärtner
> >
>



--
Rafael Weingärtner

rohit.yadav@xxxxxxxxxxxxx 
www.shapeblue.com
53 Chandos Place, Covent Garden, London  WC2N 4HSUK
@shapeblue