Merge pull request #910 from VNG-Realisatie/develop

Versie 1.4 naar de master
kadaster · Nov 9, 2021 · 9df3c91 · 9df3c91
2 parents 9e29c1c + 1203a2d
commit 9df3c91
Show file tree

Hide file tree

Showing 8 changed files with 89 additions and 20 deletions.
diff --git a/.github/workflows/generate-user-stories.yml b/.github/workflows/generate-user-stories.yml
@@ -17,11 +17,11 @@ jobs:
           echo -e '---\nlayout: page-with-side-nav\ntitle: User Stories in Ontwikkeling\n---\n' >> user-stories-dev.md
           echo -e '# User stories\n' >> user-stories-dev.md
 
-      - name: List 'v1.4' user stories
+      - name: List 'v1.5' user stories
         uses: lee-dohm/select-matching-issues@v1.2.0
         with:
           format: list
-          query:  label:"v1.4" label:"User Story"
+          query:  label:"v1.5" label:"User Story"
           token: ${{ secrets.GITHUB_TOKEN }}
           path: issues-tmp.md
       - run: |
@@ -33,6 +33,17 @@ jobs:
           echo -e '---\nlayout: page-with-side-nav\ntitle: User Stories in Productie\n---\n' >> user-stories-prod.md
           echo -e '# User stories\n' >> user-stories-prod.md
           
+      - name: List 'v1.4' user stories
+        uses: lee-dohm/select-matching-issues@v1.2.0
+        with:
+          format: list
+          query:  label:"v1.4" label:"User Story"
+          token: ${{ secrets.GITHUB_TOKEN }}
+          path: issues-tmp.md
+      - run: |
+          cat issues-tmp.md >> user-stories-dev.md
+          echo -e '\n' >> user-stories-dev.md
+        
       - name: List 'v1.3' user stories
         uses: lee-dohm/select-matching-issues@v1.2.0
         with:

diff --git a/docs/_config.yml b/docs/_config.yml
@@ -13,7 +13,7 @@ nav:
         path: /
       - title: Goals canvas
         path: /goals-canvas
-  - title: Specificaties v. 1.3 (Live)
+  - title: Specificaties v. 1.4 (Live)
     subnav:
       - title: Getting started
         path: /getting-started
@@ -26,7 +26,7 @@ nav:
         path: /redoc
       - title: Features
         path: /features
-  - title: Specificaties v. 1.4 (IO)
+  - title: Specificaties v. 1.5 (IO)
     subnav:
       - title: User stories
         url: https://vng-realisatie.github.io/Haal-Centraal-BRK-bevragen/user-stories-dev

diff --git a/docs/features.md b/docs/features.md
@@ -14,6 +14,8 @@ De functionaliteit van de API is gespecificeerd en geillustreerd door middel van
 - [zoeken van Kadaster natuurlijk personen](https://github.com/VNG-Realisatie/Haal-Centraal-BRK-bevragen/blob/master/features/zoeken-kadasternatuurlijkpersoon.feature){:target="_blank" rel="noopener"}
 - [zoeken van Kadaster niet-natuurlijk personen](https://github.com/VNG-Realisatie/Haal-Centraal-BRK-bevragen/blob/master/features/zoeken-kadasternietnatuurlijkpersoon.feature){:target="_blank" rel="noopener"}
 - [levering koopsommen in combinatie met koopjaar en cultuurcode](https://github.com/VNG-Realisatie/Haal-Centraal-BRK-bevragen/blob/master/features/first.feature){:target="_blank" rel="noopener"}
+- [inzicht in de filiatie van Kadastraal onroerende zaken](https://github.com/VNG-Realisatie/Haal-Centraal-BRK-bevragen/blob/master/features/filiatie.feature){:target="_blank" rel="noopener"}
+- [zoeken in relatie tot gorzen en aanwassen](https://github.com/VNG-Realisatie/Haal-Centraal-BRK-bevragen/blob/master/features/gorzen-en-aanwassen.feature){:target="_blank" rel="noopener"}
 
 ## Algemene Haal Centraal features
 Naast specifieke features zijn ook enkele haal Centraal Common features relevant voor de BRK bevragen API. Deze features gelden voor alle Haal Centraal API's:

diff --git a/docs/index.md b/docs/index.md
@@ -11,13 +11,11 @@ title: Haal Centraal BRK bevragingen
 
 API voor het zoeken en raadplegen van gegevens uit de Basisregistratie Kadaster (BRK).
 
-## BRK bevragen v1.3 is live!
+## BRK bevragen v1.4 is live!
 
-Naast zoeken op nummeraanduiding, levert BRK bevragen nu ook:
-* de complete filiatie
-* bij ieder perceel de bijbehorende appartementsrechten
-* bij ieder appartementsrecht het bijbehorend perceel
-* de metadata van alle stukken en stukdelen, eventueel op te halen via KIK Inzage
+BRK bevragen levert nu ook:
+* inzicht in de filiatie van Kadastraal onroerende zaken
+* zoeken in relatie tot gorzen en aanwassen
 
 Bekijk de [release notes](./releasenotes).
 
@@ -31,8 +29,8 @@ Bekijk de [release notes](./releasenotes).
 
 ## Doorontwikkeling van de BRK bevragen API
 
-Komende periode wordt de API uitgebreid met andere erfpachters. Dat zijn de eigenaren van de appartementsrechten die uit erfpacht zijn ontstaan (v1.4). 
-* Bekijk de [voortgang van issues en user stories](https://github.com/VNG-Realisatie/Haal-Centraal-BRK-bevragen/issues?q=is%3Aissue+label%3A%22BRK+bevragen+v1.4%22){:target="_blank" rel="noopener"}
+Komende periode wordt de API uitgebreid met andere erfpachters. Dat zijn de eigenaren van de appartementsrechten die uit erfpacht zijn ontstaan. Ook worden sluimerende appartementsrechten zichtbaar gemaakt (v1.5). 
+* Bekijk de [voortgang van issues en user stories](https://github.com/VNG-Realisatie/Haal-Centraal-BRK-bevragen/issues?q=is%3Aissue+label%3A%22BRK+bevragen+v1.5%22){:target="_blank" rel="noopener"}
 * Bekijk de specificaties in ontwikkeling met [Swagger UI](./swagger-ui-io) of [Redoc](./redoc-io)
 
 ## Bronnen

diff --git a/docs/releasenotes.md b/docs/releasenotes.md
@@ -5,6 +5,11 @@ title: Haal Centraal BRK bevragingen
 
 # Release notes BRK-Bevragen
 
+## **Versie 1.4.0:**
+
+### openapi.yaml
+
+  - Voor het zoeken naar Kadastraal Onroerende Zaken is naast de kadastrale aanduiding met daarin de gemeentenaam nu ook een zoekmogelijkheid toegevoegd om op de kadastrale aanduiding met de gemeentecode te zoeken.
 
 ## **Versie 1.3.0:**
 
@@ -41,7 +46,7 @@ title: Haal Centraal BRK bevragingen
     - adresseerbareObjecten (link naar [Haal-Centraal BAG adresseerbareobjecten endpoint](https://vng-realisatie.github.io/Haal-Centraal-BAG-bevragen/))
     - bijbehorendeGrondpercelen (link naar gerelateerde kadastraalOnroerendeZaken) ([200](https://github.com/VNG-Realisatie/Haal-Centraal-BRK-bevragen/issues/200){:target="_blank"})
     - bijbehorendeAppartementsrechten (links naar gerelateerde kadastraalOnroerendeZaken die als appartementsrecht ontstaan zijn uit deze kadastraalOnroerendeZaak. ([200](https://github.com/VNG-Realisatie/Haal-Centraal-BRK-bevragen/issues/200){:target="_blank"})
- 
+
 
 - hypotheken
   - Properties toegevoegd:
@@ -52,7 +57,7 @@ title: Haal Centraal BRK bevragingen
   - Links toegevoegd:
     - stukken (Uitgestelde functionaliteit. Voornaamste aanleiding versie 1.3)
     - stukdelen (Uitgestelde functionaliteit. Voornaamste aanleiding versie 1.3)
-  - Accept-Crs header en Content-Crs header zijn verwijderd bij: 
+  - Accept-Crs header en Content-Crs header zijn verwijderd bij:
     - /kadastraalonroerendezaken/{kadastraalOnroerendeZaakIdentificatie}/hypotheken
     - /kadastraalonroerendezaken/{kadastraalOnroerendeZaakIdentificatie}/hypotheken/{hypotheekIdentificatie}
 
@@ -65,7 +70,7 @@ title: Haal Centraal BRK bevragingen
    - Links toegevoegd:
      - stukken (Uitgestelde functionaliteit. Voornaamste aanleiding versie 1.3)
      - stukdelen (Uitgestelde functionaliteit. Voornaamste aanleiding versie 1.3)
-   - Property betreftGedeelteVanPerceel is deprecated verklaard. 
+   - Property betreftGedeelteVanPerceel is deprecated verklaard.
    - Accept-Crs header en Content-Crs header zijn verwijderd bij:
      - /kadastraalonroerendezaken/{kadastraalOnroerendeZaakIdentificatie}/beslagen
      - /kadastraalonroerendezaken/{kadastraalOnroerendeZaakIdentificatie}/beslagen/{beslagIdentificatie}
@@ -112,16 +117,16 @@ title: Haal Centraal BRK bevragingen
 
 
 - KadasterNatuurlijkPersoon
-  - Property geheimhoudingPersoonsgegevens is deprecated verklaard. 
-  
+  - Property geheimhoudingPersoonsgegevens is deprecated verklaard.
+
 
 - LocatieKadastraalObject
   - Property adresseerbaarObjectIdentificatie toegevoegd
 
 
 - AantekeningBasis
   - Property betreftGedeelteVanPerceel is deprecated verklaard.
- 
+
 
 - Aantekening
   - Properties toegevoegd:
@@ -141,7 +146,7 @@ title: Haal Centraal BRK bevragingen
   - ZakelijkRecht  
   - Stuk
   - DeelEnNummer
-  - EquivalentieVerklaarder 
+  - EquivalentieVerklaarder
   - Kadasterverzoek
   - RedenVerzoek
   - Stukdeel  

diff --git a/specificatie/genereervariant/openapi.json b/specificatie/genereervariant/openapi.json
@@ -47,7 +47,7 @@
     "/kadastraalonroerendezaken" : {
       "get" : {
         "tags" : [ "Kadastraal Onroerende Zaken" ],
-        "description" : "Het zoeken van kadastraal onroerende zaken door exact één van de volgende categorieën parameters op te geven.\nHet combineren van parameters uit verschillende categorieën is niet toegestaan.\n1.  Kadastrale aanduiding\n    - kadastraleAanduiding\n2.  Ingeschreven persoon als zakelijk gerechtigde\n    -  burgerservicenummer (verplicht)\n    -  zakelijkGerechtigde__type (optioneel)\n3.  Niet ingeschreven persoon of niet natuurlijk persoon als zakelijk gerechtigde\n    -  persoon__identificatie (verplicht)\n    -  zakelijkGerechtigde__type (optioneel)\n4.  Adres\n    -  postcode (verplicht)\n    -  huisnummer (optioneel)\n    -  huisletter (optioneel)\n    -  huisnummertoevoeging (optioneel)\n5.  Nummeraanduiding\n    - nummeraanduidingIdentificatie\n\nMet gebruik van de parameter expand kunnen zakelijkGerechtigden en privaatrechtelijkeBeperkingen direct worden meegeladen.\n\nHet maximale aantal zoekresultaten dat geretourneerd wordt is aan de provider om te bepalen.\nAls het resultaat van de de request dit aantal overtreft worden er geen resultaten geretourneerd en volgt er een foutmelding.\n",
+        "description" : "Het zoeken van kadastraal onroerende zaken door exact één van de volgende categorieën parameters op te geven.\nHet combineren van parameters uit verschillende categorieën is niet toegestaan.\n1.  Kadastrale aanduiding\n    - kadastraleAanduiding\n2.  Ingeschreven persoon als zakelijk gerechtigde\n    -  burgerservicenummer (verplicht)\n    -  zakelijkGerechtigde__type (optioneel)\n3.  Niet ingeschreven persoon of niet natuurlijk persoon als zakelijk gerechtigde\n    -  persoon__identificatie (verplicht)\n    -  zakelijkGerechtigde__type (optioneel)\n4.  Adres\n    -  postcode (verplicht)\n    -  huisnummer (optioneel)\n    -  huisletter (optioneel)\n    -  huisnummertoevoeging (optioneel)\n5.  Nummeraanduiding\n    - nummeraanduidingIdentificatie\n6.  Kadastrale aanduiding met gemeentecode\n    - kadastraleAanduidingMetGemeentecode\n\nMet gebruik van de parameter expand kunnen zakelijkGerechtigden en privaatrechtelijkeBeperkingen direct worden meegeladen.\n\nHet maximale aantal zoekresultaten dat geretourneerd wordt is aan de provider om te bepalen.\nAls het resultaat van de de request dit aantal overtreft worden er geen resultaten geretourneerd en volgt er een foutmelding.\n",
         "operationId" : "GetKadastraalOnroerendeZaken",
         "parameters" : [ {
           "name" : "Accept-Crs",
@@ -155,6 +155,15 @@
             "pattern" : "^[0-9]{16}$",
             "type" : "string"
           }
+        }, {
+          "name" : "kadastraleAanduidingMetGemeentecode",
+          "in" : "query",
+          "description" : "Kadastrale aanduiding is in sommige domeinen opgeslagen met de gemeentecode in plaats van de gemeentenaam.\nDit is een unieke aanduiding van een onroerende zaak. De volgorde waarin deze string wordt opgebouwd is\n\n- [Gemeentecode van de kadastrale gemeente](http://www.kadaster.nl/schemas/waardelijsten/KadastraleGemeente/).\n\n- sectie, 1 of 2 hoofdletters\n\n- perceelnummer, 1 tot 5 cijfers\n\n- appartementsrechtVolgnummer, Hoofdletter A gevolgd door 1 tot 4 cijfers (optioneel)\n\n\ngescheiden door een spatie\"\n",
+          "schema" : {
+            "pattern" : "^([A-Z]{3}[0-9]{2}) ([A-IK-Z]{1,2}) ([1-9][0-9]{0,4})( A[1-9][0-9]{0,3})?$",
+            "type" : "string",
+            "example" : "GVH00 C 1277 A3"
+          }
         } ],
         "responses" : {
           "200" : {

diff --git a/specificatie/genereervariant/openapi.yaml b/specificatie/genereervariant/openapi.yaml
@@ -55,6 +55,8 @@ paths:
             -  huisnummertoevoeging (optioneel)
         5.  Nummeraanduiding
             - nummeraanduidingIdentificatie
+        6.  Kadastrale aanduiding met gemeentecode
+            - kadastraleAanduidingMetGemeentecode
 
         Met gebruik van de parameter expand kunnen zakelijkGerechtigden en privaatrechtelijkeBeperkingen direct worden meegeladen.
 
@@ -177,6 +179,26 @@ paths:
         schema:
           pattern: ^[0-9]{16}$
           type: string
+      - name: kadastraleAanduidingMetGemeentecode
+        in: query
+        description: |
+          Kadastrale aanduiding is in sommige domeinen opgeslagen met de gemeentecode in plaats van de gemeentenaam.
+          Dit is een unieke aanduiding van een onroerende zaak. De volgorde waarin deze string wordt opgebouwd is
+
+          - [Gemeentecode van de kadastrale gemeente](http://www.kadaster.nl/schemas/waardelijsten/KadastraleGemeente/).
+
+          - sectie, 1 of 2 hoofdletters
+
+          - perceelnummer, 1 tot 5 cijfers
+
+          - appartementsrechtVolgnummer, Hoofdletter A gevolgd door 1 tot 4 cijfers (optioneel)
+
+
+          gescheiden door een spatie"
+        schema:
+          pattern: ^([A-Z]{3}[0-9]{2}) ([A-IK-Z]{1,2}) ([1-9][0-9]{0,4})( A[1-9][0-9]{0,3})?$
+          type: string
+          example: GVH00 C 1277 A3
       responses:
         "200":
           description: |

diff --git a/specificatie/kadastraal-onroerende-zaken.yaml b/specificatie/kadastraal-onroerende-zaken.yaml
@@ -26,6 +26,8 @@ paths:
               -  huisnummertoevoeging (optioneel)
           5.  Nummeraanduiding
               - nummeraanduidingIdentificatie
+          6.  Kadastrale aanduiding met gemeentecode
+              - kadastraleAanduidingMetGemeentecode
 
           Met gebruik van de parameter expand kunnen zakelijkGerechtigden en privaatrechtelijkeBeperkingen direct worden meegeladen.
 
@@ -117,6 +119,26 @@ paths:
           schema:
             type: string
             pattern: "^[0-9]{16}$"
+        - in: query
+          name: kadastraleAanduidingMetGemeentecode
+          description: |
+                        Kadastrale aanduiding is in sommige domeinen opgeslagen met de gemeentecode in plaats van de gemeentenaam.
+                        Dit is een unieke aanduiding van een onroerende zaak. De volgorde waarin deze string wordt opgebouwd is
+
+                        - [Gemeentecode van de kadastrale gemeente](http://www.kadaster.nl/schemas/waardelijsten/KadastraleGemeente/).
+
+                        - sectie, 1 of 2 hoofdletters
+
+                        - perceelnummer, 1 tot 5 cijfers
+
+                        - appartementsrechtVolgnummer, Hoofdletter A gevolgd door 1 tot 4 cijfers (optioneel)
+
+
+                        gescheiden door een spatie"
+          schema:
+            type: "string"
+            pattern: "^([A-Z]{3}[0-9]{2}) ([A-IK-Z]{1,2}) ([1-9][0-9]{0,4})( A[1-9][0-9]{0,3})?$"
+            example: "GVH00 C 1277 A3"
       responses:
         '200':
           description: |