ODRC: Koppelen organisaties aan publicaties

GeneriekPublicatiePlatformWoo / registratie-component

A registration providing the functionalities for a "public documents" storage.

https://odrc.readthedocs.io

Other

1 stars 1 forks source link

ODRC: Koppelen organisaties aan publicaties #66

Open MarcoKlerks opened 3 weeks ago

MarcoKlerks commented 3 weeks ago

Als gemeente wil ik organisaties aan publicaties kunnen koppelen, zodat we kunnen voldoen aan de Diwoo-standaard

Let op! #26 is randvoorwaardelijk.

Acceptatie criteria

Aan een publicatie kunnen de volgende attributen worden toegekend:
- publisher
- Verplicht; moet exact één organisatie als waarde hebben.
- verantwoordelijke
- Optioneel; mag max één organisatie als waarde hebben.
- opsteller
- Optioneel; mag max één organisatie als waarde hebben.
De API specificatie is bijgewerkt (ReDoc, Swagger)
De documentatie is bijgewerkt (Read the Docs)

Laat 'medeverantwoordelijken' nog maar even zitten. Ik kan niet verzinnen wanneer dat in de praktijk daadwerkelijk voorkomt.

Taken

sergei-maertens commented 2 weeks ago

API design decision to make: use URI or just UUID of the organisation in create/update calls (I'm leaning towards the latter for simplicity).

MarcoKlerks commented 2 weeks ago

Voor de sitemap-generatie hebben we straks de URI's nodig. Als je de URI's dus gebruikt i.p.v. UUID's, dan hoeft het ODBP dus minder API-calls te maken bij het genereren van de sitemaps. Gebruik je UUID's om de link te leggen tussen publicaties en organisaties, dan moet het ODBP na het opvragen (GET) van de publicaties alsnog de organisaties ovragen (GET) om aan de juiste URI's te komen.

Ook wanneer KOOP ooit API's gaat ondersteunen, dan gaat het handig zijn dat op een publicatie de links met organisaties is gelegd via URI's i.p.v. UUID's.

Ik vermoed dus dat gebruik van URI's op de langere termijn de betere keuze is. Ik kan echter niet inschatten hoe veel complexer dat is dan gebruik van UUID's.

sergei-maertens commented 2 weeks ago

dan hoeft het ODBP dus minder API-calls te maken bij het genereren van de sitemaps.

dit is sowieso niet aan de orde omdat we een bruikbaarder formaat willen weergeven bij de lees-acties, mijn opmerking gaat om de schrijf-acties en dan met name om het voor onszelf + ODBP het eenvoudigst te maken om te koppelen. En daarvoor neig ik naar de UUID (die sowieso onderdeel is van de URI).

Er is wel echt een technisch onderscheid tussen de eigen API en de identifiers/URL's gebruikt door KOOP/TOOI. Die specifieke URI is langs onze zijde gewoon "extra informatie" waar we de eigen resources niet aan ophangen, want als er extern iets verandert in een volgende versie, dan hebben wij een hoop extra werk wat we nu vermijden.

MarcoKlerks commented 2 weeks ago

oke