vng-realisatie/documenten-api

Documenten API ontsloten in een Documentregistratiecomponent (DRC)

Documenten API

Version

1.5.0

Source

https://github.com/VNG-Realisatie/documenten-api

Keywords

zaken, zaakgericht werken, GEMMA, RGBZ, DRC

Introductie

Binnen het Nederlandse gemeentelandschap wordt zaakgericht werken nagestreefd. Om dit mogelijk te maken is er gegevensuitwisseling nodig. Er is een behoefte om informatieobjecten (documenten) te relateren aan bijvoorbeeld zaken.

API specificaties

Versie	Release datum	API specificatie	Autorisaties	Notificaties
master	n.v.t.	ReDoc, Swagger (verschillen)	Scopes	Berichtkenmerken
1.5.0	2024-03-25	ReDoc, Swagger	Scopes	Berichtkenmerken
1.4.3	2023-10-24	ReDoc, Swagger	Scopes	Berichtkenmerken
1.4.1	2023-08-29	ReDoc, Swagger	Scopes	Berichtkenmerken
1.4.0	2023-08-22	ReDoc, Swagger	Scopes	Berichtkenmerken
1.3.0	2023-03-29	ReDoc, Swagger (verschillen)	Scopes	Berichtkenmerken
1.2.0	2022-12-19	ReDoc, Swagger (verschillen)	Scopes	Berichtkenmerken
1.1.0	2022-06-30	ReDoc, Swagger (verschillen)	Scopes	Berichtkenmerken
1.0.0	n.v.t.	ReDoc, Swagger (verschillen)	Scopes	Berichtkenmerken
1.0.1	2019-12-16	ReDoc, Swagger (verschillen)	Scopes	Berichtkenmerken
1.0.0	2019-11-18	ReDoc, Swagger	Scopes	Berichtkenmerken

Zie ook: Alle versies en wijzigingen

Ondersteuning

Versie	Release datum	Einddatum ondersteuning	Documentatie
1.1.x	2022-06-30	(nog niet bekend)	Documentatie
1.x	2019-11-18	(nog niet bekend)	Documentatie

Referentie implementatie

Referentieimplementatie van de Documenten API. Ook wel Documentregistratiecomponent (DRC) genoemd.

Ontwikkeld door Maykin Media B.V. in opdracht van VNG Realisatie.

Deze referentieimplementatie toont aan dat de API specificatie voor de Documenten API implementeerbaar is, en vormt een voorbeeld voor andere implementaties indien ergens twijfel bestaat.

Deze component heeft ook een demo omgeving waar leveranciers tegenaan kunnen testen.

Links

• Deze API is onderdeel van de VNG standaard "API's voor Zaakgericht werken".
• Lees de functionele specificatie bij de API specificatie.
• Bekijk de demo omgeving met de laatst gepubliceerde versie.
• Bekijk de test omgeving met de laatste ontwikkel versie.
• Rapporteer issues bij vragen, fouten of wensen.
• Bekijk de code van de referentie implementatie.

Licentie

Copyright © VNG Realisatie 2018 - 2020

Licensed under the EUPL

documenten-api's Issues

Bug in OAS - response of EIO create should return the retrieve serializer

Indentation messed up

https://github.com/maykinmedia/gemma-documentregistratiecomponent/blob/1681957f3d58f46f3e75a2d185952d1e975da53d/src/drc/api/serializers.py#L10

8 space indent should be 4 spaces

URLs should expose resources in plural

in drc.api.urls:

router.register('enkelvoudiginformatieobject', EnkelvoudigInformatieObjectViewSet)

should be

router.register('enkelvoudiginformatieobjecten', EnkelvoudigInformatieObjectViewSet)

Formaat attribuut moet beter gevalideerd worden

• verplicht indien inhoud gezet is (=altijd in huidige vorm)

• bestandsnaam gezet is, en uit de extensie kan niet het formaat worden afgeleid

• moet valide MIME-type (of subtype) zijn

Verschil tussen DRC 1.1 en voorgaande versie beschrijven

Besproken met Michiel dat we op korte termijn de verschillen tussen de 1.1 en de voorgaande versie in kaart brengen zodat verschillende test-suites geupdate kunnen worden.
Bijv. https://github.com/open-zaak/drc-tas-restapi

Create requirement file layout like in the other ZGW components

File upload should allow all file types

I know it's in the library - the check happens here:

        if file_extension not in self.ALLOWED_TYPES:
                raise ValidationError(self.INVALID_TYPE_MESSAGE)

A clever workaround would be:

class AnyFileType:
    def __contains__(self, item):
        return True

...
class SomeField(...):
    ALLOWED_TYPES = AnyFileType()

CustomBase64File as a field name is a bit weird too - maybe name it AnyBase64File?

Verkeerde titel op landingspage, moet zijn 'Documentregistratiecomponent'

https://github.com/VNG-Realisatie/gemma-documentregistratiecomponent/blob/9deb535ad94b93c652a9f77efdeff59a648de8bc/src/drc/templates/demo.html#L12

Betreft de Admin page

Media bestanden alleen downloadbaar maken met een valide JWT

I want to register a case with an information object

I'm missing the model and API interface to create ZaakInformatieObject. When I register those, I need to supply the URL to an EnkelvoudigInformatieObject and the URL to a Zaak.

File uploads should not all end up in the same directory

Specifically - you need an upload_to argument for models.FileField, because at some point you'll run into the limit of how many files you can actually keep in one directory (settings.MEDIA_ROOT in this case). Using year/month subfolders should be sufficient

404 Client Error bij verzoek naar ZRC voor informatieobjecten

Ik probeer een nieuwe Melding Openbare Ruimte toe te voegen met de gemma-zaken-demo applicatie. Het werkt prima zonder bijlage, maar met bijlage krijg ik de volgende foutmelding op de demo applicatie:

Verzoek / antwoord ziet er als volgt uit:

Wanneer ik handmatig in de admin van gemma-drc een objectinformatieobject probeer aan te maken dan krijg ik ook de foutmelding: "Could not create remote relation":

Het interessante is dat in de stack trace de volgende foutmelding staat:

Let met name op de dubbel slash: /api/v1//zaken/..., dat klopt inderdaad niet, hier krijg ik ook een 404 op. Met enkele slash kan ik de URL vanuit mijn browser benaderen.

Wat meer stack trace:

Waar komt deze dubbele slash vandaan?

Site-configuratie moet makkelijker/duidelijker zijn

Nu is er de (verborgen) IS_HTTPS envvar die gebruikt wordt om interne URLs op te bouwen buiten de request-response cycle. Het zou handig zijn als dit op de site (in de DB) kan geconfigureerd worden.

Verder is getting-started documentatie wel handig om het onboarden te versoepelen.

(cc/ @bartjkdp)

Bugs in stable/1.0.x branch

• In various places, the content type of application/problem+json has turned into application/json
• The release notes include 1.1.x features for the 1.0.2 version

Missing tests

I'm missing tests that show it's possible to create/retrieve uploaded files. These tests should go in the src/drc/api/tests/ directory

Add the Authentication middleware + scopes

Currently scopes/auth aren't enforced for DRC, which they should be.

A similar setup to https://github.com/vng-Realisatie/gemma-zaakregistratiecomponent should be used.

Omschrijving toevoegen dat inhoud van een EnkelvoudigInformatieObject base64 encoded moet zijn.