search

VNG-Realisatie / gemma-zaken

Samen ontwikkelen van API's voor Zaakgericht werken
https://vng-realisatie.github.io/gemma-zaken/
Other
41 stars 26 forks source link

Hoe om te gaan met requestId binnen audit trail? #2387

Open basretera opened 5 months ago

basretera commented 5 months ago

Binnen de API specificaties is niets beschreven van een requestId attribuut dat in de response van bijv. "Alle audit trail regels behorend bij het INFORMATIEOBJECT" aanwezig kan zijn.

Op de thema pagina m.b.t. Audit trail (https://vng-realisatie.github.io/gemma-zaken/themas/achtergronddocumentatie/audit-trail) staat wel degelijk dat dit attribuut optioneel kan/mag voorkomen.

Wat moeten we aanhouden? En als het attribuut kan/mag voorkomen dan moeten we het vullen met "X-NLX-Logrecord-ID" of klopt dat niet?

basretera commented 1 month ago

Deze melding staat sinds 17 januari open. Kan ik nog een antwoord krijgen wat precies verwacht wordt?

HenriKorver commented 1 month ago

Goede vraag. Ik weet niet waarom requestId wel wordt genoemd op de themapagina maar niet is opgenomen in de API specificatie. Ik zal dit proberen na te gaan bij de vroegere auteurs. De API specificatie is leidend dus voor nu kun je wat mij betreft het attribuut requestId skippen.

HenriKorver commented 1 month ago

@joeribekker @sergei-maertens Weten jullie wat de geschiedenis is van het attribuut requestId in de respons van een audit trail?

joeribekker commented 1 month ago

Volgens mij is dit later ooit eens conceptueel toegevoegd om de verbinding met NLX te maken. Blijkbaar is dit daarna nooit doorgevoerd in de specificatie.

Ik denk dat je antwoord om de spec te volgen het beste is, onafhankelijk van of dit nu wel of niet verstandig is om op te nemen. Inhoudelijk zou ik er weer moeten induiken. Zelf zou ik het enkel toevoegen als er nog behoefte aan is.