search

BRP-API / Haal-Centraal-BRP-historie-bevragen

https://brp-api.github.io/Haal-Centraal-BRP-historie-bevragen/
Other
2 stars 2 forks source link

Componenten zo inrichten dat het voor beheer duidelijk blijft welke properties zijn toegevoegd? #61

Closed melsk-r closed 2 years ago

melsk-r commented 2 years ago

Een aantal componenten in de openapi.yaml van Haal Centraal BRP Historische bevragingen zijn niet meer dan kopieën van gelijke componenten in de openapi.yaml van Haal Centraal BRP Personen met daaraan toegevoegd enkele properties t.b.v. historie. Is het voor het beheren van deze componenten handig om de componenten uit BRP Personen 1 op 1 over te nemen en in een ander component een 'allOf' te creëren met daarin een referentie naar het gekopieerde component en de toegevoegd componenten. Als we 'VerblijfplaatsBuitenland' als voorbeeld nemen dan wordt de structuur van die componenten dus als volgt:

    VerblijfplaatsBuitenland:
      allOf:
      - $ref : '#/components/schemas/AbstractVerblijfplaats'
      - $ref : '#/components/schemas/VerblijfplaatsBuitenlandHistorie'
    VerblijfplaatsBuitenlandHistorie:
      allOf:
      - $ref : '#/components/schemas/VerblijfplaatsBuitenlandOrigineel'
      - type: object
        properties:
          datumTot:
            $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/develop/specificatie/datum.yaml#/components/schemas/AbstractDatum'
    VerblijfplaatsBuitenlandOrigineel:
      [kopie van inhoud van VerblijfplaatsBuitenland in verblijfplaats.yaml in Haal-Centraal-BRP-bevragen]

Dat maakt het misschien wat eenvoudiger de wijzigende componenten in Haal Centraal BRP Personen te blijven volgen omdat alleen de xxxxxOrigineel componenten up-to-date gehouden hoeven te worden. Ik weet alleen niet of dit tot technische problemen gaat leiden.

melsk-r commented 2 years ago

Op 9-6-2022 is besloten vanuit de specificaties van BRP Historie bevragen niet te verwijzen naar die van BRP Personen bevragen. Deze vraag komt daarmee te vervallen.