Referentielijsten worden in klantinteracties gebruikt bij het lezen en bij het schrijven. Om te borgen dat bij het schrijven van resources (POST en PATCH) alleen de code van de referentielijst wordt opgenomen in de requestbody worden in de API-specificatie alle andere properties van de referentielijsten read-only gemaakt.
Dat brengt 3 issues met zich mee waarop we een besluit moeten nemen (Op zijn minst voor deze API, maar misschien we een structureel design-pattern)
Door op bovenstaande wijze het gebruik van referentielijsten in te richten is er een aparte API-specificatie vereist die als basis geldt voor het inrichten van het beheer van de referentielijsten zelf. Immers door het readOnly maken van de properties zou je binnen de Klantinteracties API-specificatie geen schrijf-acties op de Referentielijsten kunnen toevoegen.
Nu zijn de properties van de referentielijsten in de lees-acties van verplicht. Willen we de providers verplichten om deze waarden altijd mee te leveren ? Volgens mij ontzorg je daarmee de consumers aanzienlijk, maar het is wel goed hier even bij stil te staan en dit expliciet als besluit te documenteren.
Leiden bovenstaande keuzes er toe dat de lees-acties op de referentielijsten ook toegevoegd worden aan de API-specificatie voor klantinteracties ? De consumer van de klantinteracties-API heeft deze lees-acties niet meer nodig omdat de waarden van alle properties van de referentielijsten worden meegeleverd door de provider.
Referentielijsten worden in klantinteracties gebruikt bij het lezen en bij het schrijven. Om te borgen dat bij het schrijven van resources (POST en PATCH) alleen de code van de referentielijst wordt opgenomen in de requestbody worden in de API-specificatie alle andere properties van de referentielijsten read-only gemaakt.
Dat brengt 3 issues met zich mee waarop we een besluit moeten nemen (Op zijn minst voor deze API, maar misschien we een structureel design-pattern)
Door op bovenstaande wijze het gebruik van referentielijsten in te richten is er een aparte API-specificatie vereist die als basis geldt voor het inrichten van het beheer van de referentielijsten zelf. Immers door het readOnly maken van de properties zou je binnen de Klantinteracties API-specificatie geen schrijf-acties op de Referentielijsten kunnen toevoegen.
Nu zijn de properties van de referentielijsten in de lees-acties van verplicht. Willen we de providers verplichten om deze waarden altijd mee te leveren ? Volgens mij ontzorg je daarmee de consumers aanzienlijk, maar het is wel goed hier even bij stil te staan en dit expliciet als besluit te documenteren.
Leiden bovenstaande keuzes er toe dat de lees-acties op de referentielijsten ook toegevoegd worden aan de API-specificatie voor klantinteracties ? De consumer van de klantinteracties-API heeft deze lees-acties niet meer nodig omdat de waarden van alle properties van de referentielijsten worden meegeleverd door de provider.