Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ZTC: problemen relatie resultaattype-besluittype en resultaattype-informatieobjecttype oplossen #2467

Open
johannesbattjes opened this issue Aug 28, 2024 · 7 comments
Labels
2024 bug Iets werkt niet zoals bedoeld catalogi-api voorstel

Comments

@johannesbattjes
Copy link

johannesbattjes commented Aug 28, 2024

In ZTC 1.3 staat dit:

image

  1. Het veld is verplicht maar was dit niet in versie 1.2.1. Het is dus een breaking change.
    => voorstel: required weghalen
  2. De besluittypen hebben als formaat een array of type strings () en informatieobjecttypen array of type uri.
    => Voorstel: gelijk trekken (bij beide "omschrijving")
  3. Bij IOT staat er een toelichting waarvoor het gebruikt moet worden maar bij BT niet
    => Voorstel bij BT ook vertellen waarvoor de relatie gebruikt moet worden. Daarbij ook het woord omschrijvingen noemen.
  4. Het is onduidelijk welke applicatie de regel moet afdwingen bij IOT. Is dat de ZRC of de Client Applicatie die het resultaat toevoegt?
    => Voorstel: maak dit duidelijk
  5. In de response is sprake van
    "besluittypen": [ "http://example.com/" ], "besluittypeOmschrijving": [ "string" ], "informatieobjecttypen": [ "http://example.com/" ], "informatieobjecttypeOmschrijving": [ "string"
    Maar dit is de enige plek waar twee arrays voor één type worden gegeven. Bij zaaktypes bijvoorbeeld worden alleen url's van besluittypen en resultaattypen in de (GET) response teruggegeven.
    => Voorstel: laat besluittypeOmschrijving en informatieobjecttypeOmschrijving vervallen (of pas dit patroon overal toe dus ook bij zaaktypen).
@HenriKorver
Copy link
Collaborator

  1. Het veld is verplicht maar was dit niet in versie 1.2.1. Het is dus een breaking change.
    => voorstel: required weghalen

Eens

@HenriKorver
Copy link
Collaborator

  1. De besluittypen hebben als formaat een array of type strings () en informatieobjecttypen array of type uri.
    => Voorstel: gelijk trekken (bij beide "omschrijving")

Eens. Ik neem aan dat je bij informatieobjecttypen geen "array van uri's" meer wilt maar een "array van strings" waarbij de strings refereren naar de omschrijving van een informatieobjecttype.

@HenriKorver
Copy link
Collaborator

  1. Bij IOT staat er een toelichting waarvoor het gebruikt moet worden maar bij BT niet
    => Voorstel bij BT ook vertellen waarvoor de relatie gebruikt moet worden. Daarbij ook het woord omschrijvingen noemen.

Eens

@HenriKorver
Copy link
Collaborator

  1. Het is onduidelijk welke applicatie de regel moet afdwingen bij IOT. Is dat de ZRC of de Client Applicatie die het resultaat toevoegt?
    => Voorstel: maak dit duidelijk

Je bedoelt deze regel neem ik aan:

afbeelding

Het mooist is als deze regel wordt afgedwongen door de Zaken API. Echter dat doet ie niet (lees: deze regel zit niet in de aanvullende spec van Zaken API). Dus vooralsnog zal deze eis afgedwongen moeten worden in de Client Applicatie.

@HenriKorver HenriKorver added 2024 bug Iets werkt niet zoals bedoeld voorstel catalogi-api labels Aug 30, 2024
@HenriKorver
Copy link
Collaborator

  1. In de response is sprake van
    "besluittypen": [ "http://example.com/" ], "besluittypeOmschrijving": [ "string" ], "informatieobjecttypen": [ "http://example.com/" ], "informatieobjecttypeOmschrijving": [ "string"
    Maar dit is de enige plek waar twee arrays voor één type worden gegeven. Bij zaaktypes bijvoorbeeld worden alleen url's van besluittypen en resultaattypen in de (GET) response teruggegeven.
    => Voorstel: laat besluittypeOmschrijving en informatieobjecttypeOmschrijving vervallen (of pas dit patroon overal toe dus ook bij zaaktypen).

Eens dat het mechanisme overal consequent moet worden toegepast. Mijn eerste voorkeur gaat uit naar het overal toepassen van het patroon met twee arrays omdat het dan backwards compatible blijft en het geeft ook meer conveniance omdat je niet de omschrijving van het type hoeft op te halen met extra calls.

@michielverhoef
Copy link
Collaborator

De besluittypen hebben als formaat een array of type strings () en informatieobjecttypen array of type uri.
=> Voorstel: gelijk trekken (bij beide "omschrijving")

De verschillen zitten hem in de operatie: De schrijfacties (POST, PATCH, PUT) worden gedaan met omschrijvingen om geen harde koppelingen tussen versies van Zaaktype en Informatieobjecttype/Besluittype te leggen. De vraagacties (GET) geven juist wel de urls naar de exacte versies van de gerelateerde Informatieobjecttypen/Besluittypen ten tijde van de datumgeldigheid (vaak aanmaakdatum van de Zaak).

Op zich hoeft dit geen probleem te zijn, immers schrijven en bevragen wordt gedaan door totaal andere consumers. Bevragen gebeurt door taakspecifieke vakapplicaties, schrijven door de beheerschermen van de zaaktypecatalogus. Een normale taakspecifieke vakapplicatie schrijft niet in de zaaktypecatalogus.

Dus ik zou dit niet gelijk trekken maar op deze manier beide soorten acties optimaliseren.

@michielverhoef
Copy link
Collaborator

  1. In de response is sprake van
    "besluittypen": [ "http://example.com/" ], "besluittypeOmschrijving": [ "string" ], "informatieobjecttypen": [ "http://example.com/" ], "informatieobjecttypeOmschrijving": [ "string"
    Maar dit is de enige plek waar twee arrays voor één type worden gegeven. Bij zaaktypes bijvoorbeeld worden alleen url's van besluittypen en resultaattypen in de (GET) response teruggegeven.
    => Voorstel: laat besluittypeOmschrijving en informatieobjecttypeOmschrijving vervallen (of pas dit patroon overal toe dus ook bij zaaktypen).

Eens dat het mechanisme overal consequent moet worden toegepast. Mijn eerste voorkeur gaat uit naar het overal toepassen van het patroon met twee arrays omdat het dan backwards compatible blijft en het geeft ook meer conveniance omdat je niet de omschrijving van het type hoeft op te halen met extra calls.

Kan dat niet beter opgelost worden met expand?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2024 bug Iets werkt niet zoals bedoeld catalogi-api voorstel
Projects
None yet
Development

No branches or pull requests

3 participants