Changes in API not appearing in the documentation

[michalu]

Dear developers,
We are using Indico API to import agenda to Conference4me. We have a problem to maintain the import scripts because there are a lot of changes and version of API on Indico 0.98, 0.99 and 1.x . Could you please publish documentation for the current API?

By the way,
1) Did you think about adding breaks to exported data?
2) Why are you adding a new conference (with metadata about the event) object to every exported session (JSON)?

....
sessions: [

{

conference: {

startDate: {

date: "2014-05-18",
tz: "Europe/Zurich?",
time: "08:00:00"

},
_type: "Conference",
endDate: {

date: "2014-05-24",
tz: "Europe/Zurich?",
time: "13:40:00"

},
description: "<div style="text-align: justify;"> The Quark Matter 2014 conference is the twenty-fourth edition of the most prestigious series of international meetings in the field of ultrarelativistic heavy-ion collisions. The meetings bring together theorists and experimentalists committed to understanding the fundamental properties of strongly interacting matter at extreme energy densities. The conditions reached in head-on nuclear collisions at the highest currently available energies correspond to those in primordial matter a few tens of microseconds after the Big Bang. Thus, this type of laboratory research improves our understanding of the early phase of the Universe.<br /> &nbsp;</div> <div style="text-align: justify;"> The first Quark Matter conference took place in 1980 in Darmstadt. Since then, the meetings of this series have been organized approximately every 1.5 years. The recent instances were in Jaipur, India (2008), Knoxville, USA (2009), Annecy, France (2011), and Washington DC, USA (2012). The current meeting brings the conference to Darmstadt again, a place with a long-standing tradition of heavy-ion research and is jointly organized by GSI Helmholtzzentrum f&uuml;r Schwerionenforschung GmbH, Technische Universit&auml;t Darmstadt, and Universit&auml;t Heidelberg.</div> ",
title: "Quark Matter 2014 - XXIV International Conference on Ultrarelativistic Nucleus-Nucleus Collisions",
adjustedEndDate: {

date: "2014-05-24",
tz: "Europe/Zurich?",
time: "13:40:00"

},
bookedRooms: {

},
location: "darmstadtium",
address: "Schlossgraben 1 64283 Darmstadt Germany",
_fossil: "conference",
timezone: "Europe/Zurich?",
supportInfo: {

_fossil: "supportInfo",
caption: "Email QM2014",
_type: "SupportInfo?",
email: "qm2014@…",
telephone: ""

},
adjustedStartDate: {

date: "2014-05-18",
tz: "Europe/Zurich?",
time: "08:00:00"

},
type: "conference",
id: "219436",
room: ""

},

...

3) Why have you added a second level of object session to .. session object in results (JSON) ?
...
sessions: [

{

conference: {

},
startDate: {

date: "2014-05-18",
tz: "Europe/Zurich?",
time: "13:45:00"

},
_type: "SessionSlot?",
endDate: {

date: "2014-05-18",
tz: "Europe/Zurich?",
time: "15:30:00"

},
description: "",
title: "Observables and concepts",
url: "​http://indico.cern.ch/event/219436/session/24/?slotId=0",
contributions: [...,
inheritLoc: false,
roomFullname: null,
session: {

startDate: {

date: "2014-05-18",
tz: "Europe/Zurich?",
time: "13:45:00"

},
_type: "Session",
material: [

],
endDate: {

date: "2014-05-18",
tz: "Europe/Zurich?",
time: "15:30:00"

},
sessionConveners: [

],
numSlots: 1,
color: "#4863a0",
description: "",
title: "Observables and concepts",
isPoster: false,
url: "​http://indico.cern.ch/event/219436/session/24/",
roomFullname: null,
location: "darmstadtium",
address: "Schlossgraben 1 64283 Darmstadt Germany",
_fossil: "session",
protectionURL: "​http://indico.cern.ch/event/219436/manage/session/24/access/",
textColor: "#FFFFFF",
id: "24",
room: ""

},

...

4) Did you think about introducing versioning Indico API?

Regards,
Michal

[pferreir]

The HTTP API docs are available from ReadTheDocs?:

​http://indico.readthedocs.org/en/latest/http_api/

[pferreir]

1. AFAIK, the ​timetable resource should do that
2. Which URL is this?
3. Same as above :)
4. No, right now we are focusing on keeping backwards-compatibility and avoiding removing things. We are publicising breaking changes on our "news" page (CERN instance). The documentation is also properly updated. Versioning would be nice but it's not in our short term plan