GemUtrecht/kennis-api
1
0
Fork 0
mirror of https://github.com/frankmijn/kennis-api.git synced 2026-11-07 16:39:50 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
68 commits 1 branch 2 tags 257 KiB
Find a file
Exact
frankmijn 2f5e0f160b aanpassing van werkdocument content
2026-10-20 16:03:28 +02:00
voorbeelden aantal wijzigingen om v1.3.0. te bereiken 2026-07-13 14:04:17 +02:00
.gitignore voorbeelden toegevoegd, aantal bestanden naar mapje archief gezet, vanuit gebruiker en leveranciers gevalideerd. 2026-07-12 12:10:50 +02:00
content-specificatie.md aanpassing van werkdocument content 2026-10-20 16:03:28 +02:00
kennis-api-documentatie.md Clarify POST endpoint usage in API documentation 2026-07-15 18:02:28 +02:00
kennis-api-erd.md aantal kleine edits naar aanleiding van controle uit consument en publisher perspectief 2026-07-13 18:33:26 +02:00
kennis-api-specificatie.yaml nog een kleine aanpassing: in de voorbeelden zijn de aantallen aangepast omdat deze niet klopten. 2026-07-16 10:56:35 +02:00
README.md Update version history in README.md 2026-07-14 15:32:45 +02:00

README.md

Kennis API

OpenAPI 3.1-specificatie voor de Kennis API: een gemeentelijke kennisbank met kennisartikelen, veelgestelde vragen (VACs), mededelingen en collecties — elk met meertalige namen of inhoud. De API is uitsluitend leesbaar (read-only) en ondersteunt publicatiestatus, vertrouwelijkheidsniveaus, point-in-time opvragen via peildatums, en bulkindexering voor zoekmachines.

Belangrijkste bestanden

Bestand Omschrijving
kennis-api-specificatie.yaml De OpenAPI 3.1-specificatie zelf.
kennis-api-documentatie.md Begeleidende documentatie: endpointoverzicht, gedragsregels (kbr-*) en ontwerpkeuzes.
kennis-api-erd.md Entity-relationship-diagram van het gegevensmodel (Mermaid).
voorbeelden/ Uitgewerkte praktijkvoorbeelden in pseudocode en proza: initiële/incrementele sync, zoeken en tonen, bulk ophalen.
content-specificatie.md Werkdocument over het content-veld (nog niet vastgesteld).

Het archief/-mapje bevat oudere documenten die niet meer worden bijgehouden.

Status

  • v1.1.0 de initiele versie
  • v1.2.0 tussenversie, geen release geworden
  • v1.2.5 tussenversie, geen release geworden
  • v1.3.0 releaseversie als basis voor PoC.