Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Features/fuzzy search #465

Merged
merged 7 commits into from
Oct 13, 2021
Merged

Features/fuzzy search #465

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a08f9b7
Zoek op adres restful (zonder zoekresultaat als tussenstap)
JohanBoer Apr 1, 2021
8e90b11
Aparte parameter toiegevoegd n.a.v discussie in https://github.com/VN…
JohanBoer Oct 4, 2021
842bf4d
Minlength van "q"op 1 gezet
JohanBoer Oct 4, 2021
655441f
Merge branch 'features/fuzzy-search' into features/restfull-fuzzy-adres
JohanBoer Oct 4, 2021
7047c6e
Merge pull request #463 from JohanBoer/features/restfull-fuzzy-adres
JohanBoer Oct 4, 2021
d27a3fc
Aanpassing description /adressen n.a.v. opmerking Mark
JohanBoer Oct 5, 2021
a56a20f
Merge pull request #466 from JohanBoer/features/restfull-fuzzy-adres
JohanBoer Oct 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 25 additions & 8 deletions specificatie/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ paths:

/adressen/zoek:
get:
deprecated: true
security:
- apiKeyBAG: []
operationId: zoek
Expand Down Expand Up @@ -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,
Expand All @@ -111,6 +112,7 @@ paths:
- $ref: '#/components/parameters/huisletter'
- $ref: '#/components/parameters/huisnummertoevoeging'
- $ref: '#/components/parameters/exacteMatch'
- $ref: '#/components/parameters/q'
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Punt 1 onder description mag weg.
Punt 4 (wat punt 3 wordt) zou ik van maken: "Een zoekterm op postcode...."

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Description aangepast. Punt 3 vervalt niet (want nog steeds valide) en ik heb punt "4. Een zoekterm." toegevoegd.

responses:
'200':
description: "Geslaagd"
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand All @@ -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:
Expand Down Expand Up @@ -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'