Merge pull request #465 from VNG-Realisatie/features/fuzzy-search

Features/fuzzy search

specificatie/openapi.yaml

@@ -28,6 +28,7 @@ paths:
 
   /adressen/zoek:
     get:
+      deprecated: true
       security:
         - apiKeyBAG: []
       operationId: zoek
@@ -81,13 +82,13 @@ paths:
       description: >-
         Vind een actueel adres met:
         
-        1. De identificatie van het zoekresultaat uit de operatie get /adressen/zoek of
-        
-        2. Een pandidentificatie of 
-        
-        3. Een adresseerbaarobjectidentificatie of
-        
-        4. Een postcode, huisnummer en optioneel huisletter, huisnummertoevoeging en/of exacteMatch.
+        1. Een pandidentificatie of
+
+        2. Een adresseerbaarobjectidentificatie of
+
+        3. Een postcode, huisnummer en optioneel huisletter, huisnummertoevoeging en/of exacteMatch.
+
+        4. Een zoekterm.
 
         
         Gebruik de fields-parameter als je alleen specifieke velden in het antwoord wil zien, 
@@ -111,6 +112,7 @@ paths:
         - $ref: '#/components/parameters/huisletter'
         - $ref: '#/components/parameters/huisnummertoevoeging'
         - $ref: '#/components/parameters/exacteMatch'
+        - $ref: '#/components/parameters/q'
       responses:
         '200':
           description: "Geslaagd"
@@ -559,7 +561,18 @@ components:
       schema:
         type: string
 
+    q:
+      description: "Zoekterm op postcode, woonplaats, straatnaam, huisnummer, huisletter, huisnummertoevoeging."
+      name: q
+      in: query
+      required: false
+      schema:
+        type: string
+        minLength: 1
+        maxLength: 255
+
     zoekresultaatIdentificatie:
+      deprecated: true
       description: "De identificatie van een zoekresultaat van het endpoint get /adressen/zoek."
       name: zoekresultaatIdentificatie
       in: query
@@ -738,6 +751,7 @@ components:
   schemas:
 
     ZoekResultaat:
+      deprecated: true
       type: object
       description: "Resultaat van een zoekoperatie dat je kunt gebruiken om een adres te vinden met /adressen."
       properties:
@@ -749,17 +763,20 @@ components:
           type: string
 
     ZoekResultaatHal:
+      deprecated: true
       allOf:
         - $ref: '#/components/schemas/ZoekResultaat'
         - properties:
             _links:
               $ref: '#/components/schemas/ZoekResultaatLinks'
     ZoekResultaatLinks:
+      deprecated: true
       type: object
       properties:
         adres:
           $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.3.0/api-specificatie/common.yaml#/components/schemas/HalLink'
     ZoekResultaatHalCollectie:
+      deprecated: true
       type: object
       description: "Resultaten als lijst."
       properties:
@@ -1476,4 +1493,4 @@ components:
         vlak:
           $ref: 'http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/polygonGeoJSON.yaml'
         multivlak:
-          $ref: 'http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/multipolygonGeoJSON.yaml'
+          $ref: 'http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/multipolygonGeoJSON.yaml'