[VRAAG] Kan gerelateerde data bij elkaar gestopt worden?

[joeribekker]

Ik zie een aantal keer de volgende constructie langs komen (screenshot Catalogi API 1.2.1 specificatie van VNG):

Ofwel, er zijn 2 of meer attributen die, van dezelfde gerelateerde resource, informatie terug geven. Ter illustratie, JSON responses komt dus dit terug:

{
   "informatieobjecttypen": [
       "https://example.com/ztc/api/v1/informatieobjecttypen/123"
   ],
   "informatieobjecttypeOmschrijving": [
       "Dit is de omschrijving van 123"
   ]
}

Dit kan, naar mijn mening, beter genest worden opgenomen. Wellicht wil je wel meer informatie dan omschrijving teruggeven uiteindelijk. Dit maakt de informatie veel meer gerelateerde aan elkaar, want als het losse arrays zijn staat er niet in de specificatie dat de volgorde van elementen gelijk moet zijn. Dat voorkom je uberhaupt met deze constructie:

{
   "informatieobjecttypen": [
       { 
           "url": "https://example.com/ztc/api/v1/informatieobjecttypen/123",
           "omschrijving": "Dit is de omschrijving van 123"
       }
   ]
}

Verdere gedachten:

1. Is dit nog nodig met expand in de volgende versies?
2. Waarom het is het attribuut niet meervoudig ( informatieobjecttypeOmschrijvingen )?

[michielverhoef]

@HenriKorver hier eens naar kijken of/hoe we dit handig kunnen inpassen?