zds-schema

==================================== ZDS-Schema - Schema-generatietooling

ZDS-Schema voorziet een generieke API schema-generatiestrategie die gedeeld wordt tussen verschillende componenten betrokken in zaakgericht werken.

.. contents::

.. section-numbering::

Features

• Centraal beheer van cosntanten die de verschillende componenten overstijgen
• GeoJSON OpenAPI definities
• Support voor Geo CRS negotation
• Ingebouwde support voor nested viewsets met declaratievere syntax voor registratie
• Vaak voorkomende validators:
  • RSIN/BSN validator
  • Numerieke waarde validator
  • Niet-negatieve waarde validator
  • Alfanumerieke waarde (zonder diacritics)
  • URL-validator (test dat URL bestaat) met pluggable link-checker
  • UntilNowValidator - valideer datetimes tot en met nu.
  • UniekeIdentificatieValidator (in combinatie met organisatie)
  • InformatieObjectUniqueValidator om te valideren dat M2M entries slechts eenmalig voorkomen
  • ObjectInformatieObjectValidator om te valideren dat de synchronisatie van een object-informatieobject relatie pas kan nadat deze relatie in het DRC gemaakt is
  • IsImmutableValidator - valideer dat bepaalde velden niet gewijzigd worden bij een (partial) update, maar wel mogen gezet worden bij een create
  • ResourceValidator - valideer dat een URL een bepaalde resource ontsluit
• Custom inspectors voor drf-yasg:
  • Support voor rest_framework_gis GeometryField
  • SUpport voor django-extra-fields Base64FieldMixin
  • URL-based related resource filtering (django-filter support)
  • verzameling van mogelijke error-responses per operation
• Management command generate_swagger overloaded
  • neemt default versie mee en maakt server-informatie domein-agnostisch
  • optie om informatiemodel-resources naar markdown te renderen met backlinks naar gemmaonline.nl
• Support voor ISO 8601 durations
• Custom model fields:
  • RSINField
  • BSNField
  • LanguageField
  • VertrouwelijkheidsAanduidingField
  • DaysDurationField
• Mocks voor de validators die netwerk IO hebben, eenvoudig via @override_settings toe te passen

Installatie

Benodigdheden

• Python 3.6 of hoger
• setuptools 30.3.0 of higher

Installeren

.. code-block:: bash

pip install zds_schema

Gebruik

Zie de referentie-implementaties voor ZRC, DRC, BRC_ en ZTC_.

.. _ZRC: https://github.com/VNG-Realisatie/gemma-zaakregistratiecomponent .. _DRC: https://github.com/VNG-Realisatie/gemma-documentregistratiecomponent .. _ZTC: https://github.com/VNG-Realisatie/gemma-zaaktypecatalogus .. _BRC: https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent