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

Bug#824912: tracker.d.o: add an API for action items



Hello efkin,

I wish you a happy new year!

I have not looked at your changes yet but I just want to reply to two of
your comments.

On Sun, 18 Dec 2016, efkin wrote:
> > Copyright 2016 only for new code. :) Applies on all files.
> 
> I didn't get this bit, so i just dropped it. It can be an additional
> commit if necessary.

No copyright header is even worse... I just wanted to say that
when you add new code in a new file, you put only the current year in the
copyright notice:
# Copyright 2017 The Distro Tracker Developers
And not:
# Copyright 2014-2017 The Distro Tracker Developers

> I'm not a really great fan of viewsets. i think we cannot split hairs
> using viewsets. But i took the idea from them to use the mixins + a
> generic view.

I don't understand what you mean. "split hairs" is something that we
usually want to avoid... so it would be a good sign to not be able
to do that :-)

> > Also, one of the early design decision seems to be whether we use an
> > hyperlinked serializer or not. I don't have a strong opinion on that but it
> > makes it easier to navigate interactively in the data through the browser. So
> > unless we have a reason not to, I believe it would be nice to use it:
> > http://www.django-rest-framework.org/tutorial/5-relationships-and-hyperlinked-apis/#hyperlinking-our-api
> > But even if we use the hyperlinked version of the serializer, I would still
> > include the "id" attribute everywhere.
> 
> Well imho, it makes sense if we are serializing also other models with a
> correspondant URL. So i'm happy to implement this behaviour as the API
> grows. But i guess for this specific issue it is not really a must.

Well, the problem is that changing this later on will break the
backwards-compatibility of the API. So I would suggest to do it
right now.

Also I fully expect that we will export more information over
the API such as maintainers, packages, etc. The former tracker has
full export of RDF data for the "semantic web" which uses heavily
interlinked data and it would likely make it easier to re-implement
this in the new tracker if we have similar URL identifiers used in
the API.

Cheers,
-- 
Raphaël Hertzog ◈ Debian Developer

Support Debian LTS: http://www.freexian.com/services/debian-lts.html
Learn to master Debian: http://debian-handbook.info/get/


Reply to: