[OTDev] API change - drop [] from query strings - what do you think?

Nina Jeliazkova jeliazkova.nina at gmail.com
Mon Nov 8 17:56:41 CET 2010


On 8 November 2010 18:33, Tobias Girschick <tobias.girschick at in.tum.de>wrote:

> Hi Nina, All,
>
> I am totally in favour of this proposal.


Good :)


> And I think this has been
> discussed once or twice already...
>

Yes, but I can't recall if a decision had been made.  Hopefully we can
decide for API 1.2.

Nina


>
> Tobias
>
> On Mon, 2010-11-08 at 18:23 +0200, Nina Jeliazkova wrote:
> > Hello All ,
> >
> > I would like to propose to drop square brackets from query parameter
> names
> > throughout OpenTox API , e.g. parameters like feature_uris[] to become
> > feature_uris.
> >
> > The reasons are
> >
> > 1) Some implementations (rightly) URL encode the parameter names in URL
> > query string, however, this is not correctly understood by all clients.
> >
> >
> http://localhost:8181/dataset/1?feature_uris%5B%5D=http%3A%2F%2Flocalhost%3A8181%2Ffeature%2F3
> >
> > 2) Not sure what was the original idea behind [] , but they don't really
> > impose any control on how many instances of particular parameter should
> be
> > there, so it's more of a syntax headache.
> >
> > 3) Finally, parameters like ?feature_uris%5B%5D=..  are not quite
> readable,
> > even if interpreted correctly.
> >
> > What do you think?
> >
> > Nina
> > _______________________________________________
> > Development mailing list
> > Development at opentox.org
> > http://www.opentox.org/mailman/listinfo/development
>
> --
> Dipl.-Bioinf. Tobias Girschick
>
> Technische Universität München
> Institut für Informatik
> Lehrstuhl I12 - Bioinformatik
> Bolzmannstr. 3
> 85748 Garching b. München, Germany
>
> Room: MI 01.09.042
> Phone: +49 (89) 289-18002
> Email: tobias.girschick at in.tum.de
> Web: http://wwwkramer.in.tum.de/girschick
>
> _______________________________________________
> Development mailing list
> Development at opentox.org
> http://www.opentox.org/mailman/listinfo/development
>



More information about the Development mailing list