chore(oas): herbruikbare BRP schema componenten

BRP-API / brp-shared

0 stars 0 forks source link

chore(oas): herbruikbare BRP schema componenten #1

Open MelvLee opened 7 months ago

MelvLee commented 7 months ago

Opzetten structuur voor het vergemakkelijken van hergebruiken van BRP schema componenten gespecificeerd m.b.v. OAS

Design keuzes:

uit de bestandsnamen moet kunnen worden afgeleid welke definities er al zijn
uit de bestandsnamen moet kunnen worden afgeleid hoeveel versies er voor een definitie zijn en wat de laatste versie is
een breaking change in een definitie wordt gespecificeerd in een nieuw bestand waardoor een API provider zelf kan bepalen wanneer hij zal upgraden

MelvLee commented 7 months ago

fields wordt nu alleen in de personen bevragen API gebruikt. hoort die dan wel in een shared repo?

Fields wordt ook gebruikt in de reisdocumenten API.

MelvLee commented 7 months ago

Ik zou graag een aantal descriptions editen, dat lukt nu niet :-).

Het gaat om enkele typo's, maar ook om een goede definitie van wat wij nu "LO GBA" noemen. Ik wil toe naar een onderscheid tussen "zoals geregistreerd" en "zoals verstrekt in BRP API". Ga ik nog even met Frans bespreken.

Je zou nu write rechten moeten hebben