Release candidate tag
- Bumped to vng-api-common 1.0.0
- Bumped version numbers to 1.0.0-rc
- Changed
dut
intonld
for correct language identifier in tests - Added
EnkelvoudigInformatieObject.versie
andEnkelvoudigInformatieObject.beginRegitratie
attributes - Fixed attibutes showing as snake_case in API docs instead of camelCase
More updates towards release candidate
- Updated docs
- Changed
taal
attribute into a 3-char string field instead of an enum - Turned all enum values into
snake_case
for consistency between APIs - Bumped to latest vng-api-common
Updates towards release candidate
- Use human readable auto-generated document identifications
- Improved admin usability
- Improved documentation of
EnkelvoudigInformatieObject.inhoud
attribute - Build
develop
docker images for test environment - Documented
EnkelvoudigInformatieObject.formaat
- needs to be a MIME-type - Improved OAS consistency
- Added management command to migrate to new domains
- Added pagination to
EnkelvoudigInformatieObject
list endpoint
Added more logging to debug SSL issues
Bugfixes
- Enabled /api/v1/callbacks webhook endpoint
- Fixed SSL detection behind reverse proxy, causing ZaakinformatieObject create to fail because of bad resource URLs
Added a data migration to handle the flattened ZTC urls.
Fixed bug in docker start script preventing fixtures from being loaded.
Small feature release
- Added
EnkelvoudigInformatieObject.locked
to indicate if an EIO is locked or not. This boolean is consumed by ZRC validation. - Adapted tests for explicit OAS 3.x checks so that no OAS 2.x is served anymore
Second release towards release candidate
- Added support for a minimal plugin system
- Added versioning of
EnkelvoudigInformatieObject
: - endpoints support
versie
andregistratieOp
querystring params (mutually exclusive) - if not provided, the most recent version is returned
- endpoints support
- Added versioning of
- Update (API schema) translations
EnkelvoudigInformatieObject
can no longer be deleted if there are still relatedObjectInformatieObject
instances.ObjectInformatieObject
can no longer be deleted if the remote, canonical relation still exists. This means that you need to destroyZaakInformatieObject
/BesluitInformatieObject
first, which triggers the destruction ofObjectInformatieObject
and then finally you can destroy theEnkelvoudigInformatieObject
. Requires ZRC >= 0.17.0 and BRC >= 0.11.3
Small QoL fixes
- Added audit-trail related tests
- Added ability to load fixtures during startup
- Make sendfile backend configurable through envvar
Forgot to enable view-config view
First release towards a release candidate
- added
download
operation/endpoint to the API spec - added authorization to the download of actual binary files
(
EnkelvoudigInformatieObject.inhoud
) - 🔒 replaced the file storage with private media storage
- Added locking and unlocking of documents
- Added unlock-override mechanism for administrators
- Updated to latest Django 2.2 (LTS)
ObjectInformatieObject
is no longer the primary relation, it is now created by ZRC/BRC instead of directly by consumersObjectInformatieObject
no longer contains the relation information specific to theobjectType
- 🐋 Added nginx to the stack to facilitate sendfile download acceleration. Existing deployments directly connecting to uwsgi need to put nginx in front
EnkelvoudingInformatieObject
can no longer be updated (patch
,put
) without providing a lock ID, requiring you to lock it before updating
Update API-spec - forgotten after 0.12.0
Authorizations V2 and audit trail release - breaking changes!
- Authorizations are checked against authorizations component (AC), use the token tool to configure these.
- Added scopes for actions/resources that were not protected yet
- Renamed scopes for consistency and brevity, the
zds.scopes
prefix is dropped. - changed
invalid-params
toinvalidParams
in validation errors, following KP-API strategy - Added audit trails on documents (
informatieobject
) - Added unique-representation for resources
- Bumped dependency versions to latest security releases
Added filtering to EnkelvoudingInformatieObject
resource
- Filter on
bronorganisatie
(RSIN) - Filter on
identificatie
Both are exact matches.
API-lab release
- Improved homepage layout, using vng-api-common boilerplate
- Bumped to latest bugfix release of gemma-zds-client
Flattened the
kenmerken
in notifications sent from a list of objects with one key-value to a single object with multiple key-value pairs. Requires the NC to be at version 0.4.0 or higher.Old:
- {
- "kenmerken": [
{"key1": "value1"}, {"key2": "value2"},
]
}
New:
- {
- "kenmerken": {
"key1": "value1", "key2": "value2",
}
}
Removed the zds-schema compatibility. Upgrade to 0.9.1 first if you haven't done so yet.
vng-api-common notifications bugfixes
Feature release for notifications
- added notifications machinery. Configure the NC to use in the admin and then
run
python src/manage.py register_kanaal
to register the notifications exchange and be able to publish events. - added notifications documentation.
- renamed
EnkelvoudigInformatieObject.vertrouwelijkaanduiding
toEnkelvoudigInformatieObject.vertrouwelijkheidaanduiding
- replaced zds-schema with vng-api-common. Run
python src/manage.py migrate_from_zds_schema
on existing installs to complete the migration.
- added URL to EUPL 1.2 license in API spec
- added contributing guidelines
- removed some unused sample templates
Bugfix release
- Fixed #40 -- the required gemma-zds-client version had a bug leading to
double slashes in generated URLs, thereby breaking the
ObjectInformatieObject
sync operation
Security release
- Bumped version of Django to latest security release
Fix operation -> scopes mapping
- Enforced required scopes
- Ensured scopes end up in OAS
Archiving feature release
- added support for
DELETE
requests toEnkelvoudigInformatieObject
resource - added support for
DELETE
requests toObjectInformatieObject
resource
Documentation improvements
- #620 - improve API documentation
- Bump Django and zds-schema to new patch versions
- Ship non-api documentation in Docker image
API maturity release
- Attributes added (#549)
EnkelvoudingInformatieObject.bestandsomvang
(read-only)EnkelvoudingInformatieObject.bestandsnaam
(NOT as a group attribute)EnkelvoudingInformatieObject.integriteit
as nested object, possible checksum algorithm values are defined in enumEnkelvoudingInformatieObject.ontvangstdatum
EnkelvoudingInformatieObject.verzenddatum
EnkelvoudingInformatieObject.indicatieGebruiksrecht
- valuesnull
andfalse
are writable, fortrue
you need to leverage theGebruiksrechten
resourceEnkelvoudingInformatieObject.ondertekening
as nested objectEnkelvoudingInformatieObject.status
with business logic and interaction withontvangstdatum
- (Partial) updates enabled for
EnkelvoudingInformatieObject
- Added
Gebruiksrechten
resource with interaction onindicatieGebruiksrecht
- Updated to latest zds-schema version
Bump Django and urllib
- urllib3<=1.22 has a CVE
- use latest patch release of Django 2.0
Small bugfixes
- Fixed validator using newer gemma-zds-client
- Fixed reverting the
ObjectInformatieObject
creation if the remote relation cannot be created to prevent inconsistency - Fixed url-to-object resolution in filter params when hosted on a subpath
- Fixed validation of mismatching
object
andobjectType
when relating a document to an object - Added a name for the session cookie to preserve sessions on the same domain between components.
- Added missing Api-Version header
- Added missing Location header to OAS
Stap naar volwassenere API
- Update naar recente zds-schema versie
- HTTP 400 errors op onbekende/invalide filter-parameters
- Docker container beter te customizen via environment variables
De Authorization
headers is veranderd van formaat. In plaats van <jwt>
is het nu Bearer <jwt>
geworden.
Updated to zds-schema 0.14.0 to handle JWT decoding issues properly
DSO API-srategie fix
Foutberichten bevatten een type
key. De waarde van deze key begint niet
langer incorrect met "URI: "
.
Fix missing auth configuration from 0.5.0
Autorisatie-feature release
- Maak authenticated calls naar ZTC en ZRC
- Voeg JWT client/secret management toe
- Opzet credentialstore om URLs te kunnen valideren met auth/autz
- Support toevoegd om direct OAS 3.0 te serven op
http://localhost:8000/api/v1/schema/openapi.yaml?v=3
. Zonder querystring parameter krijg je Swagger 2.0.
Added CORS-headers
Toevoeging van aardRelatie
aan ObjectInformatieObject
resource
aardRelatie
(hoort_bij
,legt_vast
) toegevoegd- implementatie waarbij
aardRelatie
gezet wordt op basis vanobjectType
Tweaks aan ObjectInformatieObject
resource
registratiedatum
wordt door het systeem gegenereerd en is read-only- wijzigen van relatie (
object
,informatieobject
enobjectType
) is niet toegestaan
Fix openapi schema
- Onderscheid tussen request body & response body is nu duidelijk
Fixes in omgang met informatieobjectrelaties
- Serializer aangepast naar runtime gedrag. De relatie informatieobject-besluit heeft geen relatiegegevens. Deze worden nu ook genegeerd.
- Update van ZDS-client met betere logging.
- Nieuwe setting/envvar
IS_HTTPS
om URL-constructie van eigen resources robuuster te maken. Dit was voordien gebaseerd op deDEBUG
setting. - Concurrency in application server ingeschakeld
Herwerking van informatieobjectrelaties.
- Mogelijke foutantwoorden in OAS 3.0 spec opgenomen
- Validatie toegevoegd op
informatieobjecttype
URL - Licentie toegevoegd (Boris van Hoytema <[email protected]>)
- Datamodel & API aangepast op generieke relatie tussen
InformatieObject
en gerelateerd object (zie hieronder) - Synchronisatie-actie gebouwd van DRC naar xRC zodat de relatie aan beide kanten bekend is.
De volgende aanpassingen zijn backwards-incompatible:
- endpoints
/zaakinformatieobjecten/...
zijn verdwenen en vervangen door/objectinformatieobjecten
registratiedatum
is een nieuw, verplicht veld bij eenObjectInformatieObject
objectType
is een nieuw, verplicht veld bij eenObjectInformatieObject
Uitbreiding API spec
- verduidelijking oorsprong taal enum (ISO 639-2/B)
InformatieObject
velden toegevoegd:link
beschrijving
informatieobjecttype
- Filter toegevoegd aan
ZaakInformatieObject
voor zaak en informatieobject
OAS 3.0 spec bijgewerkt voor VNG-Realisatie/gemma-zaken#169
- toevoeging van vertrouwelijkheidsaanduidding
- standardisering van formaat om taal te specificeren
LIST operations toegevoegd aan DRC
GET /api/v1/enkelvoudige-informatieobjecten
geeft nu een lijst van resources terugGET /api/v1/zaakinformatieobjecten
geeft nu een lijst van resources terug
Daarnaast is er ook een schema validator toegevoegd.
Gebruik UUIDs in de API urls in plaats van database primary keys
- Dev tooling
- Documentation update
- Project hygiene improved