From 287c6570712f10802e7d44d54cf3c10e4b82d6cf Mon Sep 17 00:00:00 2001 From: RobertIdeal Date: Wed, 14 Jan 2026 13:28:25 +0000 Subject: [PATCH 1/5] Openapi update from kds schema --- dist/openapi.json | 402 +++++++++++++++++++++++++++++++++++++++++++++- dist/openapi.yaml | 388 ++++++++++++++++++++++++++++++++++++++++++++ openapi.ts | 214 +++++++++++++++++++++++- 3 files changed, 998 insertions(+), 6 deletions(-) diff --git a/dist/openapi.json b/dist/openapi.json index cb120eb..2fdd10e 100644 --- a/dist/openapi.json +++ b/dist/openapi.json @@ -3780,7 +3780,7 @@ "Dataset": { "title": "Dataset", "type": "string", - "description": "Indicates the provenance of an address.\n\n - `paf` (GBR) Postcode Address File\n - `usps` (USA) USPS Zip+4\n - `mr` (GBR) Multiple Residence File\n - `nyb` (GBR) Not Yet Built File\n - `pafa` (GBR) Alias File\n - `pafw` (GBR) Welsh File\n - `ab` (GBR) AddressBase Core\n - `ecaf` (IRL) Eircode ECAF\n - `ecad` (IRL) Eircode ECAD\n - `herewe` (Western Europe) Western Europe Dataset\n - `heret` (Taiwan) Taiwan Dataset\n - `heresa` (South America) South America Dataset\n - `hereo` (Oceania) Oceania Dataset\n - `herena` (North America) North America Dataset\n - `herei` (India) India Dataset\n - `heremea` (Middle East and Africa) Middle East and Africa Dataset\n - `herem` (Macau) Macau Dataset\n - `herehk` (Hong Kong) Hong Kong Dataset\n - `hereee` (Eastern Europe) Eastern Europe Dataset\n - `hereap` (Asia Pacific) Asia Pacific Dataset\n - `gnaf` (AUS) Geoscape Geocoded National Address File\n - `kadaster` (NLD) Kadaster BAG 2.0 Address File\n - `kartverket` (NOR) Norway Dataset\n - `sdfi` (DNK) Denmark Dataset\n - `cannar` (CAN) Canada National Address Register Dataset\n - `fodbosa` (BEL) Belgium Dataset\n - `mois` (KOR) South Korea Dataset\n - `upujp` (JPN) Japan UPU Address File\n - `bev` (AUT) Austria Dataset", + "description": "Indicates the provenance of an address.\n\n - `paf` (GBR) Postcode Address File\n - `usps` (USA) USPS Zip+4\n - `mr` (GBR) Multiple Residence File\n - `nyb` (GBR) Not Yet Built File\n - `pafa` (GBR) Alias File\n - `pafw` (GBR) Welsh File\n - `ab` (GBR) AddressBase Core\n - `ecaf` (IRL) Eircode ECAF\n - `ecad` (IRL) Eircode ECAD\n - `herewe` (Western Europe) Western Europe Dataset\n - `heret` (Taiwan) Taiwan Dataset\n - `heresa` (South America) South America Dataset\n - `hereo` (Oceania) Oceania Dataset\n - `herena` (North America) North America Dataset\n - `herei` (India) India Dataset\n - `heremea` (Middle East and Africa) Middle East and Africa Dataset\n - `herem` (Macau) Macau Dataset\n - `herehk` (Hong Kong) Hong Kong Dataset\n - `hereee` (Eastern Europe) Eastern Europe Dataset\n - `hereap` (Asia Pacific) Asia Pacific Dataset\n - `gnaf` (AUS) Geoscape Geocoded National Address File\n - `kadaster` (NLD) Kadaster BAG 2.0 Address File\n - `kartverket` (NOR) Norway Dataset\n - `sdfi` (DNK) Denmark Dataset\n - `cannar` (CAN) Canada National Address Register Dataset\n - `fodbosa` (BEL) Belgium Dataset\n - `mois` (KOR) South Korea Dataset\n - `upujp` (JPN) Japan UPU Address File\n - `bev` (AUT) Austria Dataset\n - `kds` (DNK) KDS Dataset", "enum": [ "paf", "pafw", @@ -3811,7 +3811,8 @@ "fodbosa", "mois", "upujp", - "bev" + "bev", + "kds" ] }, "CountryISO": { @@ -9914,6 +9915,384 @@ } } }, + "KdsAddress": { + "required": [ + "id", + "dataset", + "country", + "country_iso", + "country_iso_2", + "language", + "address", + "line_1", + "line_2", + "latitude", + "longitude", + "datafordelerOpdateringstid", + "datafordelerRowId", + "datafordelerRowVersion", + "datafordelerRegisterImportSequenceNumber", + "forretningshændelse", + "forretningsområde", + "forretningsproces", + "id_namespace", + "id_lokalId", + "registreringFra", + "registreringsaktør", + "registreringTil", + "status", + "virkningFra", + "virkningsaktør", + "virkningTil", + "adressebetegnelse", + "dørbetegnelse", + "dørpunkt", + "etagebetegnelse", + "bygning", + "husnummer", + "oprindelse_kilde", + "oprindelse_nøjagtighedsklasse", + "oprindelse_registrering", + "oprindelse_tekniskStandard", + "position", + "adgangsadressebetegnelse", + "adgangspunkt", + "husnummerretning", + "husnummertekst", + "vejpunkt", + "jordstykke", + "placeretPåForeløbigtJordstykke", + "geoDanmarkBygning", + "adgangTilBygning", + "adgangTilTekniskAnlæg", + "afstemningsområde", + "kommuneinddeling", + "menighedsrådsafstemningsområde", + "sogneinddeling", + "navngivenVej", + "administreresAfKommune", + "beskrivelse", + "udtaltVejnavn", + "vejadresseringsnavn", + "vejnavn", + "vejnavnebeliggenhed_oprindelse_kilde", + "vejnavnebeliggenhed_oprindelse_nøjagtighedsklasse", + "vejnavnebeliggenhed_oprindelse_registrering", + "vejnavnebeliggenhed_oprindelse_tekniskStandard", + "vejnavnebeliggenhed_vejnavnelinje", + "vejnavnebeliggenhed_vejnavneområde", + "vejnavnebeliggenhed_vejtilslutningspunkter", + "kommune", + "vejkode", + "postnummer", + "supplerendeBynavn", + "navn", + "postnr", + "postnummerinddeling" + ], + "properties": { + "id": { + "$ref": "#/components/schemas/ID" + }, + "dataset": { + "type": "string", + "enum": [ + "kds" + ] + }, + "country_iso": { + "description": " 3 letter country code (ISO 3166-1)\n", + "enum": [ + "DNK" + ] + }, + "country_iso_2": { + "type": "string", + "description": " 2 letter country code (ISO 3166-1)\n", + "enum": [ + "DK" + ] + }, + "country": { + "type": "string", + "description": " Full country names (ISO 3166)\n", + "enum": [ + "Denmark" + ] + }, + "language": { + "enum": [ + "da" + ], + "description": "Language represented by 2 letter ISO Code (639-1)\n" + }, + "address": { + "type": "string", + "description": "Full address, commonly consisting of street name, house number, (optional floor, door and city name), postal code and postal city name\n", + "example": "Elstedvej 95, Terp, 8200 Aarhus N" + }, + "line_1": { + "type": "string", + "description": "First address line.\nReturns street name, house number, (optional floor, door and city name)\n", + "example": "Elstedvej 95, Terp" + }, + "line_2": { + "type": "string", + "description": "Second address line.\nReturns postal code and postal city name\n", + "example": "8200 Aarhus N" + }, + "longitude": { + "$ref": "#/components/schemas/Longitude" + }, + "latitude": { + "$ref": "#/components/schemas/Latitude" + }, + "datafordelerOpdateringstid": { + "type": "string", + "description": "Data distributor Update Time\n" + }, + "datafordelerRowId": { + "type": "string", + "description": "row ID\n" + }, + "datafordelerRowVersion": { + "type": "string", + "description": "row version\n" + }, + "datafordelerRegisterImportSequenceNumber": { + "type": "string", + "description": "Import sequence number\n" + }, + "forretningshændelse": { + "type": "string", + "description": "The business event that caused the address element to be updated to that version\n" + }, + "forretningsområde": { + "type": "string", + "description": "The business area that has updated the address element to the version in question\n" + }, + "forretningsproces": { + "type": "string", + "description": "The business process that caused the address element to be updated to that version\n" + }, + "id_namespace": { + "type": "string", + "description": "Url of data file\n" + }, + "id_lokalId": { + "type": "string", + "description": "Identification of the address element throughout its entire life cycle\n" + }, + "registreringFra": { + "type": "string", + "description": "The time at which the registration of the relevant version of the address element was made\n" + }, + "registreringsaktør": { + "type": "string", + "description": "The actor who has registered the relevant version of the address element\n" + }, + "registreringTil": { + "type": "string", + "description": "The time when a new registration on the address element has been made, and where this version is therefore no longer the latest\n" + }, + "status": { + "type": "string", + "description": "The status of the address element in the version in question, i.e. the state of the element in the overall lifecycle\n" + }, + "virkningFra": { + "type": "string", + "description": "The time from which the relevant version of the address element takes effect\n" + }, + "virkningsaktør": { + "type": "string", + "description": "The actor who has caused the effect properties for the relevant version of the address element\n" + }, + "virkningTil": { + "type": "string", + "description": "The time when the effect of the relevant version of the address element ceases\n" + }, + "adressebetegnelse": { + "type": "string", + "description": "Full address, commonly consisting of street name, house number, (optional floor, door and city name), postal code and postal city name\n" + }, + "dørbetegnelse": { + "type": "string", + "description": "Door designation/Access point of the address\n" + }, + "dørpunkt": { + "type": "string", + "description": "3D Geographical Point of the location of the door\n" + }, + "etagebetegnelse": { + "type": "string", + "description": "Floor designation of the address\n" + }, + "bygning": { + "type": "string", + "description": "Building related to the address\n" + }, + "husnummer": { + "type": "string", + "description": "House number of the address\n" + }, + "oprindelse_kilde": { + "type": "string", + "description": "Origin source of the data\n" + }, + "oprindelse_nøjagtighedsklasse": { + "type": "string", + "description": "Origin accuracy class of the data\n" + }, + "oprindelse_registrering": { + "type": "string", + "description": "Origin registration date\n" + }, + "oprindelse_tekniskStandard": { + "type": "string", + "description": "Technical standard of the origin\n" + }, + "position": { + "type": "string", + "description": "Geometric postion of the access point using epsg 25832\n" + }, + "adgangsadressebetegnelse": { + "type": "string", + "description": "Full access address, commonly consisting of street name, house number, and additional town names, postal code and postal city name\n" + }, + "adgangspunkt": { + "type": "string", + "description": "Geographic point that represents the location of an address\n" + }, + "husnummerretning": { + "type": "string", + "description": "Geographic point used to indicate the direction of a house number (house number text), relative to the Access Point, when it is to be displayed on a map\n" + }, + "husnummertekst": { + "type": "string", + "description": "The house number of the address including any letters\n" + }, + "vejpunkt": { + "type": "string", + "description": "Geographic point representing the location of the named road that provides access to a particular access point\n" + }, + "jordstykke": { + "type": "string", + "description": "The piece of land on which the house number is located\n" + }, + "placeretPåForeløbigtJordstykke": { + "type": "string", + "description": "The provisional, i.e. unapproved, plot of land on which the house number is located\n" + }, + "geoDanmarkBygning": { + "type": "string", + "description": "The building in which the house number is located\n" + }, + "adgangTilBygning": { + "type": "string", + "description": "The building to which the house number identifies the access\n" + }, + "adgangTilTekniskAnlæg": { + "type": "string", + "description": "The technical facility to which the house number indicates the access road\n" + }, + "afstemningsområde": { + "type": "string", + "description": "The voting area in which the house number is located\n" + }, + "kommuneinddeling": { + "type": "string", + "description": "The municipal division in which the house number is located\n" + }, + "menighedsrådsafstemningsområde": { + "type": "string", + "description": "The parish council voting area in which the house number is located\n" + }, + "sogneinddeling": { + "type": "string", + "description": "The parish in which the house number is located\n" + }, + "supplerendeBynavn": { + "type": "string", + "description": "The additional city name to which the house number is linked\n" + }, + "navngivenVej": { + "type": "string", + "description": "Indicates the named street to which the house number is attached\n" + }, + "postnummer": { + "type": "string", + "description": "The postal code in which the house number is located\n" + }, + "administreresAfKommune": { + "type": "string", + "description": "Indication of the municipality responsible for registering the road name and geometry of the named road\n" + }, + "beskrivelse": { + "type": "string", + "description": "Brief description of the origin or meaning of the road name\n" + }, + "udtaltVejnavn": { + "type": "string", + "description": "The street name written in full, as it is pronounced\n" + }, + "vejadresseringsnavn": { + "type": "string", + "description": "Abbreviated version of the road name of no more than 20 characters\n" + }, + "vejnavn": { + "type": "string", + "description": "The full road name defined as: A proper name that designates and names a part of the road or path network or similar traffic areas and areas\n" + }, + "vejnavnebeliggenhed_oprindelse_kilde": { + "type": "string", + "description": "Description of the approximate geographical location of the named road. The road name location is expressed either by a road name line or a road name area, as well as origin and quality information for the location of the road name location\nRoadname_location_origin_source\n" + }, + "vejnavnebeliggenhed_oprindelse_nøjagtighedsklasse": { + "type": "string", + "description": "Description of the approximate geographical location of the named road. The road name location is expressed either by a road name line or a road name area, as well as origin and quality information for the location of the road name location\nRoadname_location_origin_accuracy_class\n" + }, + "vejnavnebeliggenhed_oprindelse_registrering": { + "type": "string", + "description": "Description of the approximate geographical location of the named road. The road name location is expressed either by a road name line or a road name area, as well as origin and quality information for the location of the road name location\nRoadname_location_origin_registration\n" + }, + "vejnavnebeliggenhed_oprindelse_tekniskStandard": { + "type": "string", + "description": "Description of the approximate geographical location of the named road. The road name location is expressed either by a road name line or a road name area, as well as origin and quality information for the location of the road name location\nRoadname_location_origin_technicalStandard\n" + }, + "vejnavnebeliggenhed_vejnavnelinje": { + "type": "string", + "description": "Description of the approximate geographical location of the named road. The road name location is expressed either by a road name line or a road name area, as well as origin and quality information for the location of the road name location\nRoadname_location_roadnameline\n" + }, + "vejnavnebeliggenhed_vejnavneområde": { + "type": "string", + "description": "Description of the approximate geographical location of the named road. The road name location is expressed either by a road name line or a road name area, as well as origin and quality information for the location of the road name location\nRoadnamelocation_roadnamearea\n" + }, + "vejnavnebeliggenhed_vejtilslutningspunkter": { + "type": "string", + "description": "Description of the approximate geographical location of the named road. The road name location is expressed either by a road name line or a road name area, as well as origin and quality information for the location of the road name location\nRoadnamelocation_roadconnectionpoints\n" + }, + "kommune": { + "type": "string", + "description": "The municipality code of the municipality to which the relevant part of the named road belongs\n" + }, + "vejkode": { + "type": "string", + "description": "Unique identification of the part of a Named Road that affects a single municipality\n" + }, + "postnr": { + "type": "string", + "description": "The postal code number\n" + }, + "postnummerinddeling": { + "type": "string", + "description": "Unique identifier of the postal code area\n" + }, + "navn": { + "type": "string", + "description": "The name of the postal code area\n" + } + } + }, "GbrGlobalAddress": { "title": "Global Address", "description": "Global (non-UK) address in the UK address format", @@ -10066,6 +10445,9 @@ }, { "$ref": "#/components/schemas/BevAddress" + }, + { + "$ref": "#/components/schemas/KdsAddress" } ] }, @@ -10833,7 +11215,8 @@ "fodbosa", "mois", "upujp", - "bev" + "bev", + "kds" ], "properties": { "paf": { @@ -10999,6 +11382,11 @@ "type": "boolean", "description": "Austria: BEV Address File", "example": true + }, + "kds": { + "type": "boolean", + "description": "Denmark: KDS Address File", + "example": true } } }, @@ -11347,6 +11735,11 @@ "type": "boolean", "description": "Austria: BEV Address File", "example": true + }, + "kds": { + "type": "boolean", + "description": "Denmark: KDS Address File", + "example": true } } } @@ -12910,6 +13303,9 @@ }, { "$ref": "#/components/schemas/BevAddress" + }, + { + "$ref": "#/components/schemas/KdsAddress" } ] } diff --git a/dist/openapi.yaml b/dist/openapi.yaml index 83d8583..6121197 100644 --- a/dist/openapi.yaml +++ b/dist/openapi.yaml @@ -3141,6 +3141,7 @@ components: - `mois` (KOR) South Korea Dataset - `upujp` (JPN) Japan UPU Address File - `bev` (AUT) Austria Dataset + - `kds` (DNK) KDS Dataset enum: - paf - pafw @@ -3172,6 +3173,7 @@ components: - mois - upujp - bev + - kds CountryISO: title: ISO Country Code (3) type: string @@ -9562,6 +9564,381 @@ components: type: string description: | Name of the census district + KdsAddress: + required: + - id + - dataset + - country + - country_iso + - country_iso_2 + - language + - address + - line_1 + - line_2 + - latitude + - longitude + - datafordelerOpdateringstid + - datafordelerRowId + - datafordelerRowVersion + - datafordelerRegisterImportSequenceNumber + - forretningshændelse + - forretningsområde + - forretningsproces + - id_namespace + - id_lokalId + - registreringFra + - registreringsaktør + - registreringTil + - status + - virkningFra + - virkningsaktør + - virkningTil + - adressebetegnelse + - dørbetegnelse + - dørpunkt + - etagebetegnelse + - bygning + - husnummer + - oprindelse_kilde + - oprindelse_nøjagtighedsklasse + - oprindelse_registrering + - oprindelse_tekniskStandard + - position + - adgangsadressebetegnelse + - adgangspunkt + - husnummerretning + - husnummertekst + - vejpunkt + - jordstykke + - placeretPåForeløbigtJordstykke + - geoDanmarkBygning + - adgangTilBygning + - adgangTilTekniskAnlæg + - afstemningsområde + - kommuneinddeling + - menighedsrådsafstemningsområde + - sogneinddeling + - navngivenVej + - administreresAfKommune + - beskrivelse + - udtaltVejnavn + - vejadresseringsnavn + - vejnavn + - vejnavnebeliggenhed_oprindelse_kilde + - vejnavnebeliggenhed_oprindelse_nøjagtighedsklasse + - vejnavnebeliggenhed_oprindelse_registrering + - vejnavnebeliggenhed_oprindelse_tekniskStandard + - vejnavnebeliggenhed_vejnavnelinje + - vejnavnebeliggenhed_vejnavneområde + - vejnavnebeliggenhed_vejtilslutningspunkter + - kommune + - vejkode + - postnummer + - supplerendeBynavn + - navn + - postnr + - postnummerinddeling + properties: + id: + $ref: '#/components/schemas/ID' + dataset: + type: string + enum: + - kds + country_iso: + description: |2 + 3 letter country code (ISO 3166-1) + enum: + - DNK + country_iso_2: + type: string + description: |2 + 2 letter country code (ISO 3166-1) + enum: + - DK + country: + type: string + description: |2 + Full country names (ISO 3166) + enum: + - Denmark + language: + enum: + - da + description: | + Language represented by 2 letter ISO Code (639-1) + address: + type: string + description: | + Full address, commonly consisting of street name, house number, (optional floor, door and city name), postal code and postal city name + example: Elstedvej 95, Terp, 8200 Aarhus N + line_1: + type: string + description: | + First address line. + Returns street name, house number, (optional floor, door and city name) + example: Elstedvej 95, Terp + line_2: + type: string + description: | + Second address line. + Returns postal code and postal city name + example: 8200 Aarhus N + longitude: + $ref: '#/components/schemas/Longitude' + latitude: + $ref: '#/components/schemas/Latitude' + datafordelerOpdateringstid: + type: string + description: | + Data distributor Update Time + datafordelerRowId: + type: string + description: | + row ID + datafordelerRowVersion: + type: string + description: | + row version + datafordelerRegisterImportSequenceNumber: + type: string + description: | + Import sequence number + forretningshændelse: + type: string + description: | + The business event that caused the address element to be updated to that version + forretningsområde: + type: string + description: | + The business area that has updated the address element to the version in question + forretningsproces: + type: string + description: | + The business process that caused the address element to be updated to that version + id_namespace: + type: string + description: | + Url of data file + id_lokalId: + type: string + description: | + Identification of the address element throughout its entire life cycle + registreringFra: + type: string + description: | + The time at which the registration of the relevant version of the address element was made + registreringsaktør: + type: string + description: | + The actor who has registered the relevant version of the address element + registreringTil: + type: string + description: | + The time when a new registration on the address element has been made, and where this version is therefore no longer the latest + status: + type: string + description: | + The status of the address element in the version in question, i.e. the state of the element in the overall lifecycle + virkningFra: + type: string + description: | + The time from which the relevant version of the address element takes effect + virkningsaktør: + type: string + description: | + The actor who has caused the effect properties for the relevant version of the address element + virkningTil: + type: string + description: | + The time when the effect of the relevant version of the address element ceases + adressebetegnelse: + type: string + description: | + Full address, commonly consisting of street name, house number, (optional floor, door and city name), postal code and postal city name + dørbetegnelse: + type: string + description: | + Door designation/Access point of the address + dørpunkt: + type: string + description: | + 3D Geographical Point of the location of the door + etagebetegnelse: + type: string + description: | + Floor designation of the address + bygning: + type: string + description: | + Building related to the address + husnummer: + type: string + description: | + House number of the address + oprindelse_kilde: + type: string + description: | + Origin source of the data + oprindelse_nøjagtighedsklasse: + type: string + description: | + Origin accuracy class of the data + oprindelse_registrering: + type: string + description: | + Origin registration date + oprindelse_tekniskStandard: + type: string + description: | + Technical standard of the origin + position: + type: string + description: | + Geometric postion of the access point using epsg 25832 + adgangsadressebetegnelse: + type: string + description: | + Full access address, commonly consisting of street name, house number, and additional town names, postal code and postal city name + adgangspunkt: + type: string + description: | + Geographic point that represents the location of an address + husnummerretning: + type: string + description: | + Geographic point used to indicate the direction of a house number (house number text), relative to the Access Point, when it is to be displayed on a map + husnummertekst: + type: string + description: | + The house number of the address including any letters + vejpunkt: + type: string + description: | + Geographic point representing the location of the named road that provides access to a particular access point + jordstykke: + type: string + description: | + The piece of land on which the house number is located + placeretPåForeløbigtJordstykke: + type: string + description: | + The provisional, i.e. unapproved, plot of land on which the house number is located + geoDanmarkBygning: + type: string + description: | + The building in which the house number is located + adgangTilBygning: + type: string + description: | + The building to which the house number identifies the access + adgangTilTekniskAnlæg: + type: string + description: | + The technical facility to which the house number indicates the access road + afstemningsområde: + type: string + description: | + The voting area in which the house number is located + kommuneinddeling: + type: string + description: | + The municipal division in which the house number is located + menighedsrådsafstemningsområde: + type: string + description: | + The parish council voting area in which the house number is located + sogneinddeling: + type: string + description: | + The parish in which the house number is located + supplerendeBynavn: + type: string + description: | + The additional city name to which the house number is linked + navngivenVej: + type: string + description: | + Indicates the named street to which the house number is attached + postnummer: + type: string + description: | + The postal code in which the house number is located + administreresAfKommune: + type: string + description: | + Indication of the municipality responsible for registering the road name and geometry of the named road + beskrivelse: + type: string + description: | + Brief description of the origin or meaning of the road name + udtaltVejnavn: + type: string + description: | + The street name written in full, as it is pronounced + vejadresseringsnavn: + type: string + description: | + Abbreviated version of the road name of no more than 20 characters + vejnavn: + type: string + description: | + The full road name defined as: A proper name that designates and names a part of the road or path network or similar traffic areas and areas + vejnavnebeliggenhed_oprindelse_kilde: + type: string + description: | + Description of the approximate geographical location of the named road. The road name location is expressed either by a road name line or a road name area, as well as origin and quality information for the location of the road name location + Roadname_location_origin_source + vejnavnebeliggenhed_oprindelse_nøjagtighedsklasse: + type: string + description: | + Description of the approximate geographical location of the named road. The road name location is expressed either by a road name line or a road name area, as well as origin and quality information for the location of the road name location + Roadname_location_origin_accuracy_class + vejnavnebeliggenhed_oprindelse_registrering: + type: string + description: | + Description of the approximate geographical location of the named road. The road name location is expressed either by a road name line or a road name area, as well as origin and quality information for the location of the road name location + Roadname_location_origin_registration + vejnavnebeliggenhed_oprindelse_tekniskStandard: + type: string + description: | + Description of the approximate geographical location of the named road. The road name location is expressed either by a road name line or a road name area, as well as origin and quality information for the location of the road name location + Roadname_location_origin_technicalStandard + vejnavnebeliggenhed_vejnavnelinje: + type: string + description: | + Description of the approximate geographical location of the named road. The road name location is expressed either by a road name line or a road name area, as well as origin and quality information for the location of the road name location + Roadname_location_roadnameline + vejnavnebeliggenhed_vejnavneområde: + type: string + description: | + Description of the approximate geographical location of the named road. The road name location is expressed either by a road name line or a road name area, as well as origin and quality information for the location of the road name location + Roadnamelocation_roadnamearea + vejnavnebeliggenhed_vejtilslutningspunkter: + type: string + description: | + Description of the approximate geographical location of the named road. The road name location is expressed either by a road name line or a road name area, as well as origin and quality information for the location of the road name location + Roadnamelocation_roadconnectionpoints + kommune: + type: string + description: | + The municipality code of the municipality to which the relevant part of the named road belongs + vejkode: + type: string + description: | + Unique identification of the part of a Named Road that affects a single municipality + postnr: + type: string + description: | + The postal code number + postnummerinddeling: + type: string + description: | + Unique identifier of the postal code area + navn: + type: string + description: | + The name of the postal code area GbrGlobalAddress: title: Global Address description: Global (non-UK) address in the UK address format @@ -9674,6 +10051,7 @@ components: - $ref: '#/components/schemas/MoisAddress' - $ref: '#/components/schemas/UpujpAddress' - $ref: '#/components/schemas/BevAddress' + - $ref: '#/components/schemas/KdsAddress' postcode_outward: type: string description: Not available for non-UK addresses @@ -10279,6 +10657,7 @@ components: - mois - upujp - bev + - kds properties: paf: type: boolean @@ -10411,6 +10790,10 @@ components: type: boolean description: 'Austria: BEV Address File' example: true + kds: + type: boolean + description: 'Denmark: KDS Address File' + example: true ApiKeyAutomatedTopup: title: API Key Automated Topup description: Automated topup status @@ -10692,6 +11075,10 @@ components: type: boolean description: 'Austria: BEV Address File' example: true + kds: + type: boolean + description: 'Denmark: KDS Address File' + example: true KeyUsageResult: title: Key Usage type: object @@ -11942,6 +12329,7 @@ components: - $ref: '#/components/schemas/MoisAddress' - $ref: '#/components/schemas/UpujpAddress' - $ref: '#/components/schemas/BevAddress' + - $ref: '#/components/schemas/KdsAddress' UsaResolveAddressResponse: title: Address Retrieve Response (USA) type: object diff --git a/openapi.ts b/openapi.ts index c01fb0d..8598061 100644 --- a/openapi.ts +++ b/openapi.ts @@ -1135,6 +1135,7 @@ export interface components { * - `mois` (KOR) South Korea Dataset * - `upujp` (JPN) Japan UPU Address File * - `bev` (AUT) Austria Dataset + * - `kds` (DNK) KDS Dataset * @enum {string} */ Dataset: @@ -1167,7 +1168,8 @@ export interface components { | "fodbosa" | "mois" | "upujp" - | "bev"; + | "bev" + | "kds"; /** * ISO Country Code (3) * @description 3 letter country code (ISO 3166-1) @@ -5877,6 +5879,200 @@ export interface components { /** @description Name of the census district */ zaehlsprengelname: string; }; + KdsAddress: { + id: components["schemas"]["ID"]; + /** @enum {string} */ + dataset: "kds"; + /** + * @description 3 letter country code (ISO 3166-1) + * + * @enum {undefined} + */ + country_iso: "DNK"; + /** + * @description 2 letter country code (ISO 3166-1) + * + * @enum {string} + */ + country_iso_2: "DK"; + /** + * @description Full country names (ISO 3166) + * + * @enum {string} + */ + country: "Denmark"; + /** + * @description Language represented by 2 letter ISO Code (639-1) + * + * @enum {undefined} + */ + language: "da"; + /** + * @description Full address, commonly consisting of street name, house number, (optional floor, door and city name), postal code and postal city name + * + * @example Elstedvej 95, Terp, 8200 Aarhus N + */ + address: string; + /** + * @description First address line. + * Returns street name, house number, (optional floor, door and city name) + * + * @example Elstedvej 95, Terp + */ + line_1: string; + /** + * @description Second address line. + * Returns postal code and postal city name + * + * @example 8200 Aarhus N + */ + line_2: string; + longitude: components["schemas"]["Longitude"]; + latitude: components["schemas"]["Latitude"]; + /** @description Data distributor Update Time */ + datafordelerOpdateringstid: string; + /** @description row ID */ + datafordelerRowId: string; + /** @description row version */ + datafordelerRowVersion: string; + /** @description Import sequence number */ + datafordelerRegisterImportSequenceNumber: string; + /** @description The business event that caused the address element to be updated to that version */ + forretningshændelse: string; + /** @description The business area that has updated the address element to the version in question */ + forretningsområde: string; + /** @description The business process that caused the address element to be updated to that version */ + forretningsproces: string; + /** @description Url of data file */ + id_namespace: string; + /** @description Identification of the address element throughout its entire life cycle */ + id_lokalId: string; + /** @description The time at which the registration of the relevant version of the address element was made */ + registreringFra: string; + /** @description The actor who has registered the relevant version of the address element */ + registreringsaktør: string; + /** @description The time when a new registration on the address element has been made, and where this version is therefore no longer the latest */ + registreringTil: string; + /** @description The status of the address element in the version in question, i.e. the state of the element in the overall lifecycle */ + status: string; + /** @description The time from which the relevant version of the address element takes effect */ + virkningFra: string; + /** @description The actor who has caused the effect properties for the relevant version of the address element */ + virkningsaktør: string; + /** @description The time when the effect of the relevant version of the address element ceases */ + virkningTil: string; + /** @description Full address, commonly consisting of street name, house number, (optional floor, door and city name), postal code and postal city name */ + adressebetegnelse: string; + /** @description Door designation/Access point of the address */ + dørbetegnelse: string; + /** @description 3D Geographical Point of the location of the door */ + dørpunkt: string; + /** @description Floor designation of the address */ + etagebetegnelse: string; + /** @description Building related to the address */ + bygning: string; + /** @description House number of the address */ + husnummer: string; + /** @description Origin source of the data */ + oprindelse_kilde: string; + /** @description Origin accuracy class of the data */ + oprindelse_nøjagtighedsklasse: string; + /** @description Origin registration date */ + oprindelse_registrering: string; + /** @description Technical standard of the origin */ + oprindelse_tekniskStandard: string; + /** @description Geometric postion of the access point using epsg 25832 */ + position: string; + /** @description Full access address, commonly consisting of street name, house number, and additional town names, postal code and postal city name */ + adgangsadressebetegnelse: string; + /** @description Geographic point that represents the location of an address */ + adgangspunkt: string; + /** @description Geographic point used to indicate the direction of a house number (house number text), relative to the Access Point, when it is to be displayed on a map */ + husnummerretning: string; + /** @description The house number of the address including any letters */ + husnummertekst: string; + /** @description Geographic point representing the location of the named road that provides access to a particular access point */ + vejpunkt: string; + /** @description The piece of land on which the house number is located */ + jordstykke: string; + /** @description The provisional, i.e. unapproved, plot of land on which the house number is located */ + placeretPåForeløbigtJordstykke: string; + /** @description The building in which the house number is located */ + geoDanmarkBygning: string; + /** @description The building to which the house number identifies the access */ + adgangTilBygning: string; + /** @description The technical facility to which the house number indicates the access road */ + adgangTilTekniskAnlæg: string; + /** @description The voting area in which the house number is located */ + afstemningsområde: string; + /** @description The municipal division in which the house number is located */ + kommuneinddeling: string; + /** @description The parish council voting area in which the house number is located */ + menighedsrådsafstemningsområde: string; + /** @description The parish in which the house number is located */ + sogneinddeling: string; + /** @description The additional city name to which the house number is linked */ + supplerendeBynavn: string; + /** @description Indicates the named street to which the house number is attached */ + navngivenVej: string; + /** @description The postal code in which the house number is located */ + postnummer: string; + /** @description Indication of the municipality responsible for registering the road name and geometry of the named road */ + administreresAfKommune: string; + /** @description Brief description of the origin or meaning of the road name */ + beskrivelse: string; + /** @description The street name written in full, as it is pronounced */ + udtaltVejnavn: string; + /** @description Abbreviated version of the road name of no more than 20 characters */ + vejadresseringsnavn: string; + /** @description The full road name defined as: A proper name that designates and names a part of the road or path network or similar traffic areas and areas */ + vejnavn: string; + /** + * @description Description of the approximate geographical location of the named road. The road name location is expressed either by a road name line or a road name area, as well as origin and quality information for the location of the road name location + * Roadname_location_origin_source + */ + vejnavnebeliggenhed_oprindelse_kilde: string; + /** + * @description Description of the approximate geographical location of the named road. The road name location is expressed either by a road name line or a road name area, as well as origin and quality information for the location of the road name location + * Roadname_location_origin_accuracy_class + */ + vejnavnebeliggenhed_oprindelse_nøjagtighedsklasse: string; + /** + * @description Description of the approximate geographical location of the named road. The road name location is expressed either by a road name line or a road name area, as well as origin and quality information for the location of the road name location + * Roadname_location_origin_registration + */ + vejnavnebeliggenhed_oprindelse_registrering: string; + /** + * @description Description of the approximate geographical location of the named road. The road name location is expressed either by a road name line or a road name area, as well as origin and quality information for the location of the road name location + * Roadname_location_origin_technicalStandard + */ + vejnavnebeliggenhed_oprindelse_tekniskStandard: string; + /** + * @description Description of the approximate geographical location of the named road. The road name location is expressed either by a road name line or a road name area, as well as origin and quality information for the location of the road name location + * Roadname_location_roadnameline + */ + vejnavnebeliggenhed_vejnavnelinje: string; + /** + * @description Description of the approximate geographical location of the named road. The road name location is expressed either by a road name line or a road name area, as well as origin and quality information for the location of the road name location + * Roadnamelocation_roadnamearea + */ + vejnavnebeliggenhed_vejnavneområde: string; + /** + * @description Description of the approximate geographical location of the named road. The road name location is expressed either by a road name line or a road name area, as well as origin and quality information for the location of the road name location + * Roadnamelocation_roadconnectionpoints + */ + vejnavnebeliggenhed_vejtilslutningspunkter: string; + /** @description The municipality code of the municipality to which the relevant part of the named road belongs */ + kommune: string; + /** @description Unique identification of the part of a Named Road that affects a single municipality */ + vejkode: string; + /** @description The postal code number */ + postnr: string; + /** @description Unique identifier of the postal code area */ + postnummerinddeling: string; + /** @description The name of the postal code area */ + navn: string; + }; /** * Global Address * @description Global (non-UK) address in the UK address format @@ -5944,7 +6140,8 @@ export interface components { | components["schemas"]["FodbosaAddress"] | components["schemas"]["MoisAddress"] | components["schemas"]["UpujpAddress"] - | components["schemas"]["BevAddress"]; + | components["schemas"]["BevAddress"] + | components["schemas"]["KdsAddress"]; /** * @description Not available for non-UK addresses * @enum {string} @@ -6599,6 +6796,11 @@ export interface components { * @example true */ bev: boolean; + /** + * @description Denmark: KDS Address File + * @example true + */ + kds: boolean; }; /** * API Key Automated Topup @@ -6849,6 +7051,11 @@ export interface components { * @example true */ bev?: boolean; + /** + * @description Denmark: KDS Address File + * @example true + */ + kds?: boolean; }; }; /** Key Usage */ @@ -7798,7 +8005,8 @@ export interface components { | components["schemas"]["FodbosaAddress"] | components["schemas"]["MoisAddress"] | components["schemas"]["UpujpAddress"] - | components["schemas"]["BevAddress"]; + | components["schemas"]["BevAddress"] + | components["schemas"]["KdsAddress"]; }; /** Address Retrieve Response (USA) */ UsaResolveAddressResponse: { From 47686a2d31eb85328141371876afeebf572c69c2 Mon Sep 17 00:00:00 2001 From: RobertIdeal Date: Wed, 28 Jan 2026 09:55:28 +0000 Subject: [PATCH 2/5] Adding region to schema --- dist/openapi.json | 6 ++++++ dist/openapi.yaml | 6 ++++++ openapi.ts | 6 ++++++ 3 files changed, 18 insertions(+) diff --git a/dist/openapi.json b/dist/openapi.json index 2fdd10e..9c3bced 100644 --- a/dist/openapi.json +++ b/dist/openapi.json @@ -9928,6 +9928,7 @@ "line_2", "latitude", "longitude", + "region", "datafordelerOpdateringstid", "datafordelerRowId", "datafordelerRowVersion", @@ -10047,6 +10048,11 @@ "latitude": { "$ref": "#/components/schemas/Latitude" }, + "region": { + "type": "string", + "description": "The region in which the address is located\n", + "example": "Nordjylland" + }, "datafordelerOpdateringstid": { "type": "string", "description": "Data distributor Update Time\n" diff --git a/dist/openapi.yaml b/dist/openapi.yaml index 6121197..8b77eae 100644 --- a/dist/openapi.yaml +++ b/dist/openapi.yaml @@ -9577,6 +9577,7 @@ components: - line_2 - latitude - longitude + - region - datafordelerOpdateringstid - datafordelerRowId - datafordelerRowVersion @@ -9688,6 +9689,11 @@ components: $ref: '#/components/schemas/Longitude' latitude: $ref: '#/components/schemas/Latitude' + region: + type: string + description: | + The region in which the address is located + example: Nordjylland datafordelerOpdateringstid: type: string description: | diff --git a/openapi.ts b/openapi.ts index 8598061..f636d9c 100644 --- a/openapi.ts +++ b/openapi.ts @@ -5929,6 +5929,12 @@ export interface components { line_2: string; longitude: components["schemas"]["Longitude"]; latitude: components["schemas"]["Latitude"]; + /** + * @description The region in which the address is located + * + * @example Nordjylland + */ + region: string; /** @description Data distributor Update Time */ datafordelerOpdateringstid: string; /** @description row ID */ From 11c900d052f3c27e76f6d94c16de14a767869697 Mon Sep 17 00:00:00 2001 From: RobertIdeal Date: Wed, 28 Jan 2026 10:05:07 +0000 Subject: [PATCH 3/5] missing bynavn variable --- dist/openapi.json | 4 ++++ dist/openapi.yaml | 4 ++++ openapi.ts | 2 ++ package-lock.json | 2 +- 4 files changed, 11 insertions(+), 1 deletion(-) diff --git a/dist/openapi.json b/dist/openapi.json index 9c3bced..51602c8 100644 --- a/dist/openapi.json +++ b/dist/openapi.json @@ -10296,6 +10296,10 @@ "navn": { "type": "string", "description": "The name of the postal code area\n" + }, + "bynavn": { + "type": "string", + "description": "The additional city name associated with the address\n" } } }, diff --git a/dist/openapi.yaml b/dist/openapi.yaml index 8b77eae..9142511 100644 --- a/dist/openapi.yaml +++ b/dist/openapi.yaml @@ -9945,6 +9945,10 @@ components: type: string description: | The name of the postal code area + bynavn: + type: string + description: | + The additional city name associated with the address GbrGlobalAddress: title: Global Address description: Global (non-UK) address in the UK address format diff --git a/openapi.ts b/openapi.ts index f636d9c..7819647 100644 --- a/openapi.ts +++ b/openapi.ts @@ -6078,6 +6078,8 @@ export interface components { postnummerinddeling: string; /** @description The name of the postal code area */ navn: string; + /** @description The additional city name associated with the address */ + bynavn?: string; }; /** * Global Address diff --git a/package-lock.json b/package-lock.json index 0307ff5..240d1d1 100644 --- a/package-lock.json +++ b/package-lock.json @@ -6,7 +6,7 @@ "packages": { "": { "name": "@ideal-postcodes/openapi", - "version": "4.14.0", + "version": "4.14.1", "license": "Copyright IDDQD Limited", "devDependencies": { "@cablanchard/semantic-release": "~1.3.4", From 04336d06d48cc6eff9405e99c038f6a184bc3084 Mon Sep 17 00:00:00 2001 From: RobertIdeal Date: Wed, 28 Jan 2026 10:52:25 +0000 Subject: [PATCH 4/5] Adding required value --- dist/openapi.json | 3 ++- dist/openapi.yaml | 1 + openapi.ts | 2 +- 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/dist/openapi.json b/dist/openapi.json index 51602c8..8057479 100644 --- a/dist/openapi.json +++ b/dist/openapi.json @@ -9989,7 +9989,8 @@ "supplerendeBynavn", "navn", "postnr", - "postnummerinddeling" + "postnummerinddeling", + "bynavn" ], "properties": { "id": { diff --git a/dist/openapi.yaml b/dist/openapi.yaml index 9142511..3a6cb5c 100644 --- a/dist/openapi.yaml +++ b/dist/openapi.yaml @@ -9639,6 +9639,7 @@ components: - navn - postnr - postnummerinddeling + - bynavn properties: id: $ref: '#/components/schemas/ID' diff --git a/openapi.ts b/openapi.ts index 7819647..7be263f 100644 --- a/openapi.ts +++ b/openapi.ts @@ -6079,7 +6079,7 @@ export interface components { /** @description The name of the postal code area */ navn: string; /** @description The additional city name associated with the address */ - bynavn?: string; + bynavn: string; }; /** * Global Address From bfd8ba4abeb1b01cd1285a59939d0bfc68822a1f Mon Sep 17 00:00:00 2001 From: RobertIdeal Date: Thu, 5 Feb 2026 10:28:57 +0000 Subject: [PATCH 5/5] Kds Schema Adjustments --- dist/openapi.json | 62 +++++++++++++++++++++++++++++++++++++++++++++-- dist/openapi.yaml | 40 ++++++++++++++++++++++++++++-- openapi.ts | 8 ++++-- 3 files changed, 104 insertions(+), 6 deletions(-) diff --git a/dist/openapi.json b/dist/openapi.json index 8057479..d0a0c30 100644 --- a/dist/openapi.json +++ b/dist/openapi.json @@ -9956,9 +9956,13 @@ "oprindelse_registrering", "oprindelse_tekniskStandard", "position", + "position_x", + "position_y", "adgangsadressebetegnelse", "adgangspunkt", "husnummerretning", + "husnummerretning_x", + "husnummerretning_y", "husnummertekst", "vejpunkt", "jordstykke", @@ -10162,6 +10166,30 @@ "type": "string", "description": "Geometric postion of the access point using epsg 25832\n" }, + "position_x": { + "oneOf": [ + { + "type": "string", + "description": "Empty string `\"\"` if not available" + }, + { + "type": "number", + "description": "X coordinate of the geometric position of the access point using epsg 25832\n" + } + ] + }, + "position_y": { + "oneOf": [ + { + "type": "string", + "description": "Empty string `\"\"` if not available" + }, + { + "type": "number", + "description": "Y coordinate of the geometric position of the access point using epsg 25832\n" + } + ] + }, "adgangsadressebetegnelse": { "type": "string", "description": "Full access address, commonly consisting of street name, house number, and additional town names, postal code and postal city name\n" @@ -10174,6 +10202,30 @@ "type": "string", "description": "Geographic point used to indicate the direction of a house number (house number text), relative to the Access Point, when it is to be displayed on a map\n" }, + "husnummerretning_x": { + "oneOf": [ + { + "type": "string", + "description": "Empty string `\"\"` if not available" + }, + { + "type": "number", + "description": "X coordinate of the geographic point used to indicate the direction of a house number (house number text), relative to the Access Point, when it is to be displayed on a map\n" + } + ] + }, + "husnummerretning_y": { + "oneOf": [ + { + "type": "string", + "description": "Empty string `\"\"` if not available" + }, + { + "type": "number", + "description": "Y coordinate of the geographic point used to indicate the direction of a house number (house number text), relative to the Access Point, when it is to be displayed on a map\n" + } + ] + }, "husnummertekst": { "type": "string", "description": "The house number of the address including any letters\n" @@ -10279,11 +10331,17 @@ "description": "Description of the approximate geographical location of the named road. The road name location is expressed either by a road name line or a road name area, as well as origin and quality information for the location of the road name location\nRoadnamelocation_roadconnectionpoints\n" }, "kommune": { - "type": "string", + "type": "array", + "items": { + "type": "string" + }, "description": "The municipality code of the municipality to which the relevant part of the named road belongs\n" }, "vejkode": { - "type": "string", + "type": "array", + "items": { + "type": "string" + }, "description": "Unique identification of the part of a Named Road that affects a single municipality\n" }, "postnr": { diff --git a/dist/openapi.yaml b/dist/openapi.yaml index 3a6cb5c..9e9ecad 100644 --- a/dist/openapi.yaml +++ b/dist/openapi.yaml @@ -9605,9 +9605,13 @@ components: - oprindelse_registrering - oprindelse_tekniskStandard - position + - position_x + - position_y - adgangsadressebetegnelse - adgangspunkt - husnummerretning + - husnummerretning_x + - husnummerretning_y - husnummertekst - vejpunkt - jordstykke @@ -9803,6 +9807,20 @@ components: type: string description: | Geometric postion of the access point using epsg 25832 + position_x: + oneOf: + - type: string + description: Empty string `""` if not available + - type: number + description: | + X coordinate of the geometric position of the access point using epsg 25832 + position_y: + oneOf: + - type: string + description: Empty string `""` if not available + - type: number + description: | + Y coordinate of the geometric position of the access point using epsg 25832 adgangsadressebetegnelse: type: string description: | @@ -9815,6 +9833,20 @@ components: type: string description: | Geographic point used to indicate the direction of a house number (house number text), relative to the Access Point, when it is to be displayed on a map + husnummerretning_x: + oneOf: + - type: string + description: Empty string `""` if not available + - type: number + description: | + X coordinate of the geographic point used to indicate the direction of a house number (house number text), relative to the Access Point, when it is to be displayed on a map + husnummerretning_y: + oneOf: + - type: string + description: Empty string `""` if not available + - type: number + description: | + Y coordinate of the geographic point used to indicate the direction of a house number (house number text), relative to the Access Point, when it is to be displayed on a map husnummertekst: type: string description: | @@ -9927,11 +9959,15 @@ components: Description of the approximate geographical location of the named road. The road name location is expressed either by a road name line or a road name area, as well as origin and quality information for the location of the road name location Roadnamelocation_roadconnectionpoints kommune: - type: string + type: array + items: + type: string description: | The municipality code of the municipality to which the relevant part of the named road belongs vejkode: - type: string + type: array + items: + type: string description: | Unique identification of the part of a Named Road that affects a single municipality postnr: diff --git a/openapi.ts b/openapi.ts index 7be263f..e6e38ee 100644 --- a/openapi.ts +++ b/openapi.ts @@ -5989,12 +5989,16 @@ export interface components { oprindelse_tekniskStandard: string; /** @description Geometric postion of the access point using epsg 25832 */ position: string; + position_x: string | number; + position_y: string | number; /** @description Full access address, commonly consisting of street name, house number, and additional town names, postal code and postal city name */ adgangsadressebetegnelse: string; /** @description Geographic point that represents the location of an address */ adgangspunkt: string; /** @description Geographic point used to indicate the direction of a house number (house number text), relative to the Access Point, when it is to be displayed on a map */ husnummerretning: string; + husnummerretning_x: string | number; + husnummerretning_y: string | number; /** @description The house number of the address including any letters */ husnummertekst: string; /** @description Geographic point representing the location of the named road that provides access to a particular access point */ @@ -6069,9 +6073,9 @@ export interface components { */ vejnavnebeliggenhed_vejtilslutningspunkter: string; /** @description The municipality code of the municipality to which the relevant part of the named road belongs */ - kommune: string; + kommune: string[]; /** @description Unique identification of the part of a Named Road that affects a single municipality */ - vejkode: string; + vejkode: string[]; /** @description The postal code number */ postnr: string; /** @description Unique identifier of the postal code area */