From 287c6570712f10802e7d44d54cf3c10e4b82d6cf Mon Sep 17 00:00:00 2001 From: RobertIdeal Date: Wed, 14 Jan 2026 13:28:25 +0000 Subject: [PATCH 1/9] 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/9] 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/9] 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/9] 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/9] 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 */ From 7c71c488e83a7eaa62ae91f88a3eb4a7db90d2b3 Mon Sep 17 00:00:00 2001 From: RobertIdeal Date: Mon, 23 Feb 2026 11:13:03 +0000 Subject: [PATCH 6/9] changes from dagi data --- dist/openapi.json | 375 +++++++++++++++++++++------------------------- dist/openapi.yaml | 366 +++++++++++++++++++++----------------------- openapi.ts | 196 +++++++++++------------- 3 files changed, 431 insertions(+), 506 deletions(-) diff --git a/dist/openapi.json b/dist/openapi.json index d0a0c30..774b627 100644 --- a/dist/openapi.json +++ b/dist/openapi.json @@ -9925,14 +9925,8 @@ "language", "address", "line_1", - "line_2", "latitude", "longitude", - "region", - "datafordelerOpdateringstid", - "datafordelerRowId", - "datafordelerRowVersion", - "datafordelerRegisterImportSequenceNumber", "forretningshændelse", "forretningsområde", "forretningsproces", @@ -9945,56 +9939,60 @@ "virkningFra", "virkningsaktør", "virkningTil", - "adressebetegnelse", - "dørbetegnelse", - "dørpunkt", - "etagebetegnelse", - "bygning", - "husnummer", - "oprindelse_kilde", - "oprindelse_nøjagtighedsklasse", - "oprindelse_registrering", - "oprindelse_tekniskStandard", - "position", - "position_x", - "position_y", - "adgangsadressebetegnelse", - "adgangspunkt", - "husnummerretning", - "husnummerretning_x", - "husnummerretning_y", - "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", - "bynavn" + "adresse_adressebetegnelse", + "adresse_dørbetegnelse", + "adresse_etagebetegnelse", + "adressepunkt_oprindelse_kilde", + "adressepunkt_oprindelse_nojagtighedsklasse", + "adressepunkt_oprindelse_registrering", + "adressepunkt_oprindelse_tekniskStandard", + "adressepunkt_position_x", + "adressepunkt_position_y", + "husnummer_adgangsadressebetegnelse", + "husnummer_vejmidte", + "husnummer_husnummertekst", + "afstemningsomraadenummer", + "afstemningsområde_navn", + "afstemningsstedNavn", + "kommuneinddeling_kommunekode", + "kommuneinddeling_navn", + "LAU1vaerdi", + "kommuneinddeling_udenforKommuneinddeling", + "MRafstemningsomraadenummer", + "menighedsradsafstemningsomrade_navn", + "LAU2vaerdi", + "sogneinddeling_sognekode", + "sogneinddeling_navn", + "supplerendebynavn_navn", + "navngivenvej_beskrivelse", + "navngivenvej_udtaltVejnavn", + "navngivenvej_vejadresseringsnavn", + "navngivenvej_vejnavn", + "navngivenvej_vejnavnebeliggenhed_oprindelse_kilde", + "navngivenvej_vejnavnebeliggenhed_oprindelse_nøjagtighedsklasse", + "navngivenvej_vejnavnebeliggenhed_oprindelse_registrering", + "navngivenvej_vejnavnebeliggenhed_oprindelse_tekniskStandard", + "navngivenvejkommunedel_vejkode", + "postnummer_navn", + "postnummer_postnr", + "opstillingskredsnummer", + "opstillingskreds_navn", + "valgkredsnummer", + "storkredsnummer", + "storkreds_navn", + "valglandsdelsbogstav", + "valglandsdels_navn", + "postnummerinddeling_ergadepostnummer", + "nuts2vaerdi", + "regionsinddeling_regionskode", + "regionsinddeling_navn", + "politikredsnummer", + "politikreds_navn", + "myndighedskode", + "retskredsnummer", + "retskreds_navn", + "nuts3vaerdi", + "landsdel_navn" ], "properties": { "id": { @@ -10042,38 +10040,12 @@ "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" }, - "region": { - "type": "string", - "description": "The region in which the address is located\n", - "example": "Nordjylland" - }, - "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" @@ -10122,51 +10094,35 @@ "type": "string", "description": "The time when the effect of the relevant version of the address element ceases\n" }, - "adressebetegnelse": { + "adresse_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": { + "adresse_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": { + "adresse_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": { + "adressepunkt_oprindelse_kilde": { "type": "string", "description": "Origin source of the data\n" }, - "oprindelse_nøjagtighedsklasse": { + "adressepunkt_oprindelse_nojagtighedsklasse": { "type": "string", "description": "Origin accuracy class of the data\n" }, - "oprindelse_registrering": { + "adressepunkt_oprindelse_registrering": { "type": "string", "description": "Origin registration date\n" }, - "oprindelse_tekniskStandard": { + "adressepunkt_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" - }, - "position_x": { + "adressepunkt_position_x": { "oneOf": [ { "type": "string", @@ -10178,7 +10134,7 @@ } ] }, - "position_y": { + "adressepunkt_position_y": { "oneOf": [ { "type": "string", @@ -10190,175 +10146,188 @@ } ] }, - "adgangsadressebetegnelse": { + "husnummer_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": { + "husnummer_vejmidte": { "type": "string", - "description": "Geographic point that represents the location of an address\n" + "description": "Municipality code-road code\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" - }, - "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": { + "husnummer_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": { + "afstemningsomraadenummer": { "type": "string", - "description": "The piece of land on which the house number is located\n" + "description": "Polling district number\n" }, - "placeretPåForeløbigtJordstykke": { + "afstemningsområde_navn": { "type": "string", - "description": "The provisional, i.e. unapproved, plot of land on which the house number is located\n" + "description": "Name of the geographical entity\n" }, - "geoDanmarkBygning": { + "afstemningsstedNavn": { "type": "string", - "description": "The building in which the house number is located\n" + "description": "Polling place name\n" }, - "adgangTilBygning": { + "kommuneinddeling_kommunekode": { "type": "string", - "description": "The building to which the house number identifies the access\n" + "description": "Municipality code\n" }, - "adgangTilTekniskAnlæg": { + "kommuneinddeling_navn": { "type": "string", - "description": "The technical facility to which the house number indicates the access road\n" + "description": "Name of the geographical entity\n" }, - "afstemningsområde": { + "LAU1vaerdi": { "type": "string", - "description": "The voting area in which the house number is located\n" + "description": "LAU1 value (Local Administrative Unit level 1)\n" }, - "kommuneinddeling": { + "kommuneinddeling_udenforKommuneinddeling": { "type": "string", - "description": "The municipal division in which the house number is located\n" + "description": "Outside municipality division (boolean flag)\n" }, - "menighedsrådsafstemningsområde": { + "MRafstemningsomraadenummer": { "type": "string", - "description": "The parish council voting area in which the house number is located\n" + "description": "Municipal/regional polling district number\n" }, - "sogneinddeling": { + "menighedsradsafstemningsomrade_navn": { "type": "string", - "description": "The parish in which the house number is located\n" + "description": "Name of the geographical entity\n" }, - "supplerendeBynavn": { + "LAU2vaerdi": { "type": "string", - "description": "The additional city name to which the house number is linked\n" + "description": "LAU2 value (Local Administrative Unit level 2)\n" }, - "navngivenVej": { + "sogneinddeling_sognekode": { "type": "string", - "description": "Indicates the named street to which the house number is attached\n" + "description": "Parish code\n" }, - "postnummer": { + "sogneinddeling_navn": { "type": "string", - "description": "The postal code in which the house number is located\n" + "description": "Name of the geographical entity\n" }, - "administreresAfKommune": { + "supplerendebynavn_navn": { "type": "string", - "description": "Indication of the municipality responsible for registering the road name and geometry of the named road\n" + "description": "Name of the geographical entity\n" }, - "beskrivelse": { + "navngivenvej_beskrivelse": { "type": "string", "description": "Brief description of the origin or meaning of the road name\n" }, - "udtaltVejnavn": { + "navngivenvej_udtaltVejnavn": { "type": "string", "description": "The street name written in full, as it is pronounced\n" }, - "vejadresseringsnavn": { + "navngivenvej_vejadresseringsnavn": { "type": "string", "description": "Abbreviated version of the road name of no more than 20 characters\n" }, - "vejnavn": { + "navngivenvej_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": { + "navngivenvej_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": { + "navngivenvej_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": { + "navngivenvej_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": { + "navngivenvej_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": { + "navngivenvejkommunedel_vejkode": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Unique identification of the part of a Named Road that affects a single municipality\n" + }, + "postnummer_navn": { "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" + "description": "Name of the city, district, etc. that the postal code includes\n" }, - "vejnavnebeliggenhed_vejnavneområde": { + "postnummer_postnr": { "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" + "description": "Four-digit code that identifies the postal code\n" }, - "vejnavnebeliggenhed_vejtilslutningspunkter": { + "opstillingskredsnummer": { "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" + "description": "Constituency number\n" }, - "kommune": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The municipality code of the municipality to which the relevant part of the named road belongs\n" + "opstillingskreds_navn": { + "type": "string", + "description": "Name of the geographical entity\n" }, - "vejkode": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Unique identification of the part of a Named Road that affects a single municipality\n" + "valgkredsnummer": { + "type": "string", + "description": "National electoral district number\n" }, - "postnr": { + "storkredsnummer": { + "type": "string", + "description": "Regional electoral district number\n" + }, + "storkreds_navn": { + "type": "string", + "description": "Name of the geographical entity\n" + }, + "valglandsdelsbogstav": { + "type": "string", + "description": "National electoral district letter\n" + }, + "valglandsdels_navn": { + "type": "string", + "description": "Name of the geographical entity\n" + }, + "postnummerinddeling_ergadepostnummer": { + "type": "string", + "description": "Whether it is a \"street postal code\"\n" + }, + "nuts2vaerdi": { + "type": "string", + "description": "NUTS2 value (NUTS level 2)\n" + }, + "regionsinddeling_regionskode": { + "type": "string", + "description": "Region code\n" + }, + "regionsinddeling_navn": { + "type": "string", + "description": "Name of the geographical entity\n" + }, + "politikredsnummer": { + "type": "string", + "description": "Police district number\n" + }, + "politikreds_navn": { + "type": "string", + "description": "Name of the geographical entity\n" + }, + "myndighedskode": { + "type": "string", + "description": "Public authority code\n" + }, + "retskredsnummer": { "type": "string", - "description": "The postal code number\n" + "description": "Judicial district number\n" }, - "postnummerinddeling": { + "retskreds_navn": { "type": "string", - "description": "Unique identifier of the postal code area\n" + "description": "Name of the geographical entity\n" }, - "navn": { + "nuts3vaerdi": { "type": "string", - "description": "The name of the postal code area\n" + "description": "NUTS3 value (NUTS level 3)\n" }, - "bynavn": { + "landsdel_navn": { "type": "string", - "description": "The additional city name associated with the address\n" + "description": "Name of the geographical entity\n" } } }, diff --git a/dist/openapi.yaml b/dist/openapi.yaml index 9e9ecad..a9f3545 100644 --- a/dist/openapi.yaml +++ b/dist/openapi.yaml @@ -9574,14 +9574,8 @@ components: - language - address - line_1 - - line_2 - latitude - longitude - - region - - datafordelerOpdateringstid - - datafordelerRowId - - datafordelerRowVersion - - datafordelerRegisterImportSequenceNumber - forretningshændelse - forretningsområde - forretningsproces @@ -9594,56 +9588,60 @@ components: - virkningFra - virkningsaktør - virkningTil - - adressebetegnelse - - dørbetegnelse - - dørpunkt - - etagebetegnelse - - bygning - - husnummer - - oprindelse_kilde - - oprindelse_nøjagtighedsklasse - - oprindelse_registrering - - oprindelse_tekniskStandard - - position - - position_x - - position_y - - adgangsadressebetegnelse - - adgangspunkt - - husnummerretning - - husnummerretning_x - - husnummerretning_y - - 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 - - bynavn + - adresse_adressebetegnelse + - adresse_dørbetegnelse + - adresse_etagebetegnelse + - adressepunkt_oprindelse_kilde + - adressepunkt_oprindelse_nojagtighedsklasse + - adressepunkt_oprindelse_registrering + - adressepunkt_oprindelse_tekniskStandard + - adressepunkt_position_x + - adressepunkt_position_y + - husnummer_adgangsadressebetegnelse + - husnummer_vejmidte + - husnummer_husnummertekst + - afstemningsomraadenummer + - afstemningsområde_navn + - afstemningsstedNavn + - kommuneinddeling_kommunekode + - kommuneinddeling_navn + - LAU1vaerdi + - kommuneinddeling_udenforKommuneinddeling + - MRafstemningsomraadenummer + - menighedsradsafstemningsomrade_navn + - LAU2vaerdi + - sogneinddeling_sognekode + - sogneinddeling_navn + - supplerendebynavn_navn + - navngivenvej_beskrivelse + - navngivenvej_udtaltVejnavn + - navngivenvej_vejadresseringsnavn + - navngivenvej_vejnavn + - navngivenvej_vejnavnebeliggenhed_oprindelse_kilde + - navngivenvej_vejnavnebeliggenhed_oprindelse_nøjagtighedsklasse + - navngivenvej_vejnavnebeliggenhed_oprindelse_registrering + - navngivenvej_vejnavnebeliggenhed_oprindelse_tekniskStandard + - navngivenvejkommunedel_vejkode + - postnummer_navn + - postnummer_postnr + - opstillingskredsnummer + - opstillingskreds_navn + - valgkredsnummer + - storkredsnummer + - storkreds_navn + - valglandsdelsbogstav + - valglandsdels_navn + - postnummerinddeling_ergadepostnummer + - nuts2vaerdi + - regionsinddeling_regionskode + - regionsinddeling_navn + - politikredsnummer + - politikreds_navn + - myndighedskode + - retskredsnummer + - retskreds_navn + - nuts3vaerdi + - landsdel_navn properties: id: $ref: '#/components/schemas/ID' @@ -9684,37 +9682,10 @@ components: 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' - region: - type: string - description: | - The region in which the address is located - example: Nordjylland - 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: | @@ -9763,229 +9734,234 @@ components: type: string description: | The time when the effect of the relevant version of the address element ceases - adressebetegnelse: + adresse_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: + adresse_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: + adresse_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: + adressepunkt_oprindelse_kilde: type: string description: | Origin source of the data - oprindelse_nøjagtighedsklasse: + adressepunkt_oprindelse_nojagtighedsklasse: type: string description: | Origin accuracy class of the data - oprindelse_registrering: + adressepunkt_oprindelse_registrering: type: string description: | Origin registration date - oprindelse_tekniskStandard: + adressepunkt_oprindelse_tekniskStandard: type: string description: | Technical standard of the origin - position: - type: string - description: | - Geometric postion of the access point using epsg 25832 - position_x: + adressepunkt_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: + adressepunkt_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: + husnummer_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: + husnummer_vejmidte: 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: + Municipality code-road code + husnummer_husnummertekst: type: string description: | The house number of the address including any letters - vejpunkt: + afstemningsomraadenummer: type: string description: | - Geographic point representing the location of the named road that provides access to a particular access point - jordstykke: + Polling district number + afstemningsområde_navn: type: string description: | - The piece of land on which the house number is located - placeretPåForeløbigtJordstykke: + Name of the geographical entity + afstemningsstedNavn: type: string description: | - The provisional, i.e. unapproved, plot of land on which the house number is located - geoDanmarkBygning: + Polling place name + kommuneinddeling_kommunekode: type: string description: | - The building in which the house number is located - adgangTilBygning: + Municipality code + kommuneinddeling_navn: type: string description: | - The building to which the house number identifies the access - adgangTilTekniskAnlæg: + Name of the geographical entity + LAU1vaerdi: type: string description: | - The technical facility to which the house number indicates the access road - afstemningsområde: + LAU1 value (Local Administrative Unit level 1) + kommuneinddeling_udenforKommuneinddeling: type: string description: | - The voting area in which the house number is located - kommuneinddeling: + Outside municipality division (boolean flag) + MRafstemningsomraadenummer: type: string description: | - The municipal division in which the house number is located - menighedsrådsafstemningsområde: + Municipal/regional polling district number + menighedsradsafstemningsomrade_navn: type: string description: | - The parish council voting area in which the house number is located - sogneinddeling: + Name of the geographical entity + LAU2vaerdi: type: string description: | - The parish in which the house number is located - supplerendeBynavn: + LAU2 value (Local Administrative Unit level 2) + sogneinddeling_sognekode: 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: + Parish code + sogneinddeling_navn: type: string description: | - The postal code in which the house number is located - administreresAfKommune: + Name of the geographical entity + supplerendebynavn_navn: type: string description: | - Indication of the municipality responsible for registering the road name and geometry of the named road - beskrivelse: + Name of the geographical entity + navngivenvej_beskrivelse: type: string description: | Brief description of the origin or meaning of the road name - udtaltVejnavn: + navngivenvej_udtaltVejnavn: type: string description: | The street name written in full, as it is pronounced - vejadresseringsnavn: + navngivenvej_vejadresseringsnavn: type: string description: | Abbreviated version of the road name of no more than 20 characters - vejnavn: + navngivenvej_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: + navngivenvej_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: + navngivenvej_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: + navngivenvej_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: + navngivenvej_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: + navngivenvejkommunedel_vejkode: + type: array + items: + type: string + description: | + Unique identification of the part of a Named Road that affects a single municipality + postnummer_navn: 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: + Name of the city, district, etc. that the postal code includes + postnummer_postnr: 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: + Four-digit code that identifies the postal code + opstillingskredsnummer: 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: array - items: - type: string + Constituency number + opstillingskreds_navn: + type: string description: | - The municipality code of the municipality to which the relevant part of the named road belongs - vejkode: - type: array - items: - type: string + Name of the geographical entity + valgkredsnummer: + type: string description: | - Unique identification of the part of a Named Road that affects a single municipality - postnr: + National electoral district number + storkredsnummer: + type: string + description: | + Regional electoral district number + storkreds_navn: + type: string + description: | + Name of the geographical entity + valglandsdelsbogstav: + type: string + description: | + National electoral district letter + valglandsdels_navn: + type: string + description: | + Name of the geographical entity + postnummerinddeling_ergadepostnummer: + type: string + description: | + Whether it is a "street postal code" + nuts2vaerdi: + type: string + description: | + NUTS2 value (NUTS level 2) + regionsinddeling_regionskode: + type: string + description: | + Region code + regionsinddeling_navn: + type: string + description: | + Name of the geographical entity + politikredsnummer: + type: string + description: | + Police district number + politikreds_navn: + type: string + description: | + Name of the geographical entity + myndighedskode: + type: string + description: | + Public authority code + retskredsnummer: type: string description: | - The postal code number - postnummerinddeling: + Judicial district number + retskreds_navn: type: string description: | - Unique identifier of the postal code area - navn: + Name of the geographical entity + nuts3vaerdi: type: string description: | - The name of the postal code area - bynavn: + NUTS3 value (NUTS level 3) + landsdel_navn: type: string description: | - The additional city name associated with the address + Name of the geographical entity GbrGlobalAddress: title: Global Address description: Global (non-UK) address in the UK address format diff --git a/openapi.ts b/openapi.ts index e6e38ee..5756222 100644 --- a/openapi.ts +++ b/openapi.ts @@ -5920,29 +5920,8 @@ export interface components { * @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 The region in which the address is located - * - * @example Nordjylland - */ - region: string; - /** @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 */ @@ -5968,122 +5947,123 @@ export interface components { /** @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; + adresse_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; + adresse_dørbetegnelse: 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; + adresse_etagebetegnelse: string; /** @description Origin source of the data */ - oprindelse_kilde: string; + adressepunkt_oprindelse_kilde: string; /** @description Origin accuracy class of the data */ - oprindelse_nøjagtighedsklasse: string; + adressepunkt_oprindelse_nojagtighedsklasse: string; /** @description Origin registration date */ - oprindelse_registrering: string; + adressepunkt_oprindelse_registrering: string; /** @description Technical standard of the origin */ - oprindelse_tekniskStandard: string; - /** @description Geometric postion of the access point using epsg 25832 */ - position: string; - position_x: string | number; - position_y: string | number; + adressepunkt_oprindelse_tekniskStandard: string; + adressepunkt_position_x: string | number; + adressepunkt_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; + husnummer_adgangsadressebetegnelse: string; + /** @description Municipality code-road code */ + husnummer_vejmidte: 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; + husnummer_husnummertekst: string; + /** @description Polling district number */ + afstemningsomraadenummer: string; + /** @description Name of the geographical entity */ + afstemningsområde_navn: string; + /** @description Polling place name */ + afstemningsstedNavn: string; + /** @description Municipality code */ + kommuneinddeling_kommunekode: string; + /** @description Name of the geographical entity */ + kommuneinddeling_navn: string; + /** @description LAU1 value (Local Administrative Unit level 1) */ + LAU1vaerdi: string; + /** @description Outside municipality division (boolean flag) */ + kommuneinddeling_udenforKommuneinddeling: string; + /** @description Municipal/regional polling district number */ + MRafstemningsomraadenummer: string; + /** @description Name of the geographical entity */ + menighedsradsafstemningsomrade_navn: string; + /** @description LAU2 value (Local Administrative Unit level 2) */ + LAU2vaerdi: string; + /** @description Parish code */ + sogneinddeling_sognekode: string; + /** @description Name of the geographical entity */ + sogneinddeling_navn: string; + /** @description Name of the geographical entity */ + supplerendebynavn_navn: string; /** @description Brief description of the origin or meaning of the road name */ - beskrivelse: string; + navngivenvej_beskrivelse: string; /** @description The street name written in full, as it is pronounced */ - udtaltVejnavn: string; + navngivenvej_udtaltVejnavn: string; /** @description Abbreviated version of the road name of no more than 20 characters */ - vejadresseringsnavn: string; + navngivenvej_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; + navngivenvej_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; + navngivenvej_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; + navngivenvej_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; + navngivenvej_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[]; + navngivenvej_vejnavnebeliggenhed_oprindelse_tekniskStandard: 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; - /** @description The additional city name associated with the address */ - bynavn: string; + navngivenvejkommunedel_vejkode: string[]; + /** @description Name of the city, district, etc. that the postal code includes */ + postnummer_navn: string; + /** @description Four-digit code that identifies the postal code */ + postnummer_postnr: string; + /** @description Constituency number */ + opstillingskredsnummer: string; + /** @description Name of the geographical entity */ + opstillingskreds_navn: string; + /** @description National electoral district number */ + valgkredsnummer: string; + /** @description Regional electoral district number */ + storkredsnummer: string; + /** @description Name of the geographical entity */ + storkreds_navn: string; + /** @description National electoral district letter */ + valglandsdelsbogstav: string; + /** @description Name of the geographical entity */ + valglandsdels_navn: string; + /** @description Whether it is a "street postal code" */ + postnummerinddeling_ergadepostnummer: string; + /** @description NUTS2 value (NUTS level 2) */ + nuts2vaerdi: string; + /** @description Region code */ + regionsinddeling_regionskode: string; + /** @description Name of the geographical entity */ + regionsinddeling_navn: string; + /** @description Police district number */ + politikredsnummer: string; + /** @description Name of the geographical entity */ + politikreds_navn: string; + /** @description Public authority code */ + myndighedskode: string; + /** @description Judicial district number */ + retskredsnummer: string; + /** @description Name of the geographical entity */ + retskreds_navn: string; + /** @description NUTS3 value (NUTS level 3) */ + nuts3vaerdi: string; + /** @description Name of the geographical entity */ + landsdel_navn: string; }; /** * Global Address From 1be92996d420ab381fb5aeff3f3395baa43634fd Mon Sep 17 00:00:00 2001 From: RobertIdeal Date: Mon, 23 Feb 2026 11:45:58 +0000 Subject: [PATCH 7/9] fixing oneOf types --- dist/openapi.json | 45 +++++++++++++++++++++++++++++++++------------ dist/openapi.yaml | 38 ++++++++++++++++++++++++-------------- openapi.ts | 13 +++++-------- 3 files changed, 62 insertions(+), 34 deletions(-) diff --git a/dist/openapi.json b/dist/openapi.json index 774b627..76f3289 100644 --- a/dist/openapi.json +++ b/dist/openapi.json @@ -9943,7 +9943,7 @@ "adresse_dørbetegnelse", "adresse_etagebetegnelse", "adressepunkt_oprindelse_kilde", - "adressepunkt_oprindelse_nojagtighedsklasse", + "adressepunkt_oprindelse_nøjagtighedsklasse", "adressepunkt_oprindelse_registrering", "adressepunkt_oprindelse_tekniskStandard", "adressepunkt_position_x", @@ -10110,7 +10110,7 @@ "type": "string", "description": "Origin source of the data\n" }, - "adressepunkt_oprindelse_nojagtighedsklasse": { + "adressepunkt_oprindelse_nøjagtighedsklasse": { "type": "string", "description": "Origin accuracy class of the data\n" }, @@ -10171,8 +10171,16 @@ "description": "Polling place name\n" }, "kommuneinddeling_kommunekode": { - "type": "string", - "description": "Municipality code\n" + "oneOf": [ + { + "type": "boolean", + "description": "Outside municipality division (boolean flag)\n" + }, + { + "type": "string", + "description": "Empty \"\" if null\n" + } + ] }, "kommuneinddeling_navn": { "type": "string", @@ -10183,8 +10191,16 @@ "description": "LAU1 value (Local Administrative Unit level 1)\n" }, "kommuneinddeling_udenforKommuneinddeling": { - "type": "string", - "description": "Outside municipality division (boolean flag)\n" + "oneOf": [ + { + "type": "string", + "description": "Empty \"\" if null\n" + }, + { + "type": "boolean", + "description": "Outside municipality division (boolean flag)\n" + } + ] }, "MRafstemningsomraadenummer": { "type": "string", @@ -10243,10 +10259,7 @@ "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" }, "navngivenvejkommunedel_vejkode": { - "type": "array", - "items": { - "type": "string" - }, + "type": "string", "description": "Unique identification of the part of a Named Road that affects a single municipality\n" }, "postnummer_navn": { @@ -10286,8 +10299,16 @@ "description": "Name of the geographical entity\n" }, "postnummerinddeling_ergadepostnummer": { - "type": "string", - "description": "Whether it is a \"street postal code\"\n" + "oneOf": [ + { + "type": "string", + "description": "Empty string if null\n" + }, + { + "type": "boolean", + "description": "Whether it is a \"street postal code\"\n" + } + ] }, "nuts2vaerdi": { "type": "string", diff --git a/dist/openapi.yaml b/dist/openapi.yaml index a9f3545..c032725 100644 --- a/dist/openapi.yaml +++ b/dist/openapi.yaml @@ -9592,7 +9592,7 @@ components: - adresse_dørbetegnelse - adresse_etagebetegnelse - adressepunkt_oprindelse_kilde - - adressepunkt_oprindelse_nojagtighedsklasse + - adressepunkt_oprindelse_nøjagtighedsklasse - adressepunkt_oprindelse_registrering - adressepunkt_oprindelse_tekniskStandard - adressepunkt_position_x @@ -9750,7 +9750,7 @@ components: type: string description: | Origin source of the data - adressepunkt_oprindelse_nojagtighedsklasse: + adressepunkt_oprindelse_nøjagtighedsklasse: type: string description: | Origin accuracy class of the data @@ -9801,9 +9801,13 @@ components: description: | Polling place name kommuneinddeling_kommunekode: - type: string - description: | - Municipality code + oneOf: + - type: boolean + description: | + Outside municipality division (boolean flag) + - type: string + description: | + Empty "" if null kommuneinddeling_navn: type: string description: | @@ -9813,9 +9817,13 @@ components: description: | LAU1 value (Local Administrative Unit level 1) kommuneinddeling_udenforKommuneinddeling: - type: string - description: | - Outside municipality division (boolean flag) + oneOf: + - type: string + description: | + Empty "" if null + - type: boolean + description: | + Outside municipality division (boolean flag) MRafstemningsomraadenummer: type: string description: | @@ -9877,9 +9885,7 @@ 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 Roadname_location_origin_technicalStandard navngivenvejkommunedel_vejkode: - type: array - items: - type: string + type: string description: | Unique identification of the part of a Named Road that affects a single municipality postnummer_navn: @@ -9919,9 +9925,13 @@ components: description: | Name of the geographical entity postnummerinddeling_ergadepostnummer: - type: string - description: | - Whether it is a "street postal code" + oneOf: + - type: string + description: | + Empty string if null + - type: boolean + description: | + Whether it is a "street postal code" nuts2vaerdi: type: string description: | diff --git a/openapi.ts b/openapi.ts index 5756222..2e2ba1a 100644 --- a/openapi.ts +++ b/openapi.ts @@ -5955,7 +5955,7 @@ export interface components { /** @description Origin source of the data */ adressepunkt_oprindelse_kilde: string; /** @description Origin accuracy class of the data */ - adressepunkt_oprindelse_nojagtighedsklasse: string; + adressepunkt_oprindelse_nøjagtighedsklasse: string; /** @description Origin registration date */ adressepunkt_oprindelse_registrering: string; /** @description Technical standard of the origin */ @@ -5974,14 +5974,12 @@ export interface components { afstemningsområde_navn: string; /** @description Polling place name */ afstemningsstedNavn: string; - /** @description Municipality code */ - kommuneinddeling_kommunekode: string; + kommuneinddeling_kommunekode: boolean | string; /** @description Name of the geographical entity */ kommuneinddeling_navn: string; /** @description LAU1 value (Local Administrative Unit level 1) */ LAU1vaerdi: string; - /** @description Outside municipality division (boolean flag) */ - kommuneinddeling_udenforKommuneinddeling: string; + kommuneinddeling_udenforKommuneinddeling: string | boolean; /** @description Municipal/regional polling district number */ MRafstemningsomraadenummer: string; /** @description Name of the geographical entity */ @@ -6023,7 +6021,7 @@ export interface components { */ navngivenvej_vejnavnebeliggenhed_oprindelse_tekniskStandard: string; /** @description Unique identification of the part of a Named Road that affects a single municipality */ - navngivenvejkommunedel_vejkode: string[]; + navngivenvejkommunedel_vejkode: string; /** @description Name of the city, district, etc. that the postal code includes */ postnummer_navn: string; /** @description Four-digit code that identifies the postal code */ @@ -6042,8 +6040,7 @@ export interface components { valglandsdelsbogstav: string; /** @description Name of the geographical entity */ valglandsdels_navn: string; - /** @description Whether it is a "street postal code" */ - postnummerinddeling_ergadepostnummer: string; + postnummerinddeling_ergadepostnummer: string | boolean; /** @description NUTS2 value (NUTS level 2) */ nuts2vaerdi: string; /** @description Region code */ From cd01555807c44ec65d78edcd5abd4983b5c350e2 Mon Sep 17 00:00:00 2001 From: RobertIdeal Date: Mon, 23 Feb 2026 12:05:40 +0000 Subject: [PATCH 8/9] Adding line_2 --- dist/openapi.json | 8 ++++++-- dist/openapi.yaml | 6 +++++- openapi.ts | 4 ++-- 3 files changed, 13 insertions(+), 5 deletions(-) diff --git a/dist/openapi.json b/dist/openapi.json index 76f3289..0683356 100644 --- a/dist/openapi.json +++ b/dist/openapi.json @@ -9925,6 +9925,7 @@ "language", "address", "line_1", + "line_2", "latitude", "longitude", "forretningshændelse", @@ -10037,8 +10038,11 @@ }, "line_1": { "type": "string", - "description": "First address line.\nReturns street name, house number, (optional floor, door and city name)\n", - "example": "Elstedvej 95, Terp" + "description": "First address line.\nReturns street name, house number, (optional floor, door and city name)\n" + }, + "line_2": { + "type": "string", + "description": "Second address line.\n" }, "longitude": { "$ref": "#/components/schemas/Longitude" diff --git a/dist/openapi.yaml b/dist/openapi.yaml index c032725..f07ab26 100644 --- a/dist/openapi.yaml +++ b/dist/openapi.yaml @@ -9574,6 +9574,7 @@ components: - language - address - line_1 + - line_2 - latitude - longitude - forretningshændelse @@ -9681,7 +9682,10 @@ components: 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. longitude: $ref: '#/components/schemas/Longitude' latitude: diff --git a/openapi.ts b/openapi.ts index 2e2ba1a..fa5af95 100644 --- a/openapi.ts +++ b/openapi.ts @@ -5916,10 +5916,10 @@ export interface components { /** * @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. */ + line_2: string; longitude: components["schemas"]["Longitude"]; latitude: components["schemas"]["Latitude"]; /** @description The business event that caused the address element to be updated to that version */ From 9e886f2f5694a79c82b6b847389123a76eecd740 Mon Sep 17 00:00:00 2001 From: Hugh Evans Date: Fri, 27 Feb 2026 17:02:58 +0000 Subject: [PATCH 9/9] Update KDS schema --- dist/openapi.json | 279 ++++++++++++++++-------- dist/openapi.yaml | 377 ++++++++++++++++++++++++++------- openapi.ts | 527 +++++++++++++++++++++++++++++++++++++++------- 3 files changed, 947 insertions(+), 236 deletions(-) diff --git a/dist/openapi.json b/dist/openapi.json index 0683356..550ba08 100644 --- a/dist/openapi.json +++ b/dist/openapi.json @@ -9987,9 +9987,10 @@ "nuts2vaerdi", "regionsinddeling_regionskode", "regionsinddeling_navn", + "politikreds_myndighedskode", "politikredsnummer", "politikreds_navn", - "myndighedskode", + "retskreds_myndighedskode", "retskredsnummer", "retskreds_navn", "nuts3vaerdi", @@ -10033,16 +10034,18 @@ }, "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" + "description": "Address / House Number uniquely identifying the address along the specified street.\n\nCan be empty string `\"\"` if not present.\n", + "example": "95" }, "line_1": { "type": "string", - "description": "First address line.\nReturns street name, house number, (optional floor, door and city name)\n" + "description": "First address line.\n\nMay include street name, house number, floor number and door number.\n", + "example": "Vænget 19" }, "line_2": { "type": "string", - "description": "Second address line.\n" + "description": "Second address line.\n\nMay include supplementary city name. Can be empty string `\"\"` if not present.\n", + "example": "Benløse" }, "longitude": { "$ref": "#/components/schemas/Longitude" @@ -10052,89 +10055,108 @@ }, "forretningshændelse": { "type": "string", - "description": "The business event that caused the address element to be updated to that version\n" + "description": "Business event type that triggered the record.\n", + "example": "2" }, "forretningsområde": { "type": "string", - "description": "The business area that has updated the address element to the version in question\n" + "description": "Business domain or subject area the record belongs to.\n", + "example": "54.15.10.08" }, "forretningsproces": { "type": "string", - "description": "The business process that caused the address element to be updated to that version\n" + "description": "Business process that produced or last modified the record.\n", + "example": "0" }, "id_namespace": { "type": "string", - "description": "Url of data file\n" + "description": "Namespace URI that qualifies the local identifier.\n", + "example": "http://data.gov.dk/dar/adresse" }, "id_lokalId": { "type": "string", - "description": "Identification of the address element throughout its entire life cycle\n" + "description": "Local unique identifier for the address object within its namespace.\n", + "example": "0000090e-e9f3-4ffe-a0a5-2852666d158c" }, "registreringFra": { "type": "string", - "description": "The time at which the registration of the relevant version of the address element was made\n" + "description": "Start of the registration period (when the record became valid in the register).\n", + "example": "2021-06-21T07:54:04.191Z" }, "registreringsaktør": { "type": "string", - "description": "The actor who has registered the relevant version of the address element\n" + "description": "Actor (authority or system) responsible for the registration of the address record.\n", + "example": "DAR" }, "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" + "description": "End of the registration period.\n\nCan be empty string `\"\"` if the address is still active.\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" + "description": "Current lifecycle status of the object.\n", + "example": "4" }, "virkningFra": { "type": "string", - "description": "The time from which the relevant version of the address element takes effect\n" + "description": "Start of the real-world validity period (when the address record takes effect in reality).\n", + "example": "2021-06-21T07:54:04.191Z" }, "virkningsaktør": { "type": "string", - "description": "The actor who has caused the effect properties for the relevant version of the address element\n" + "description": "Actor (authority or system) responsible for the real-world change that prompted the record.\n", + "example": "AjourføreDarSystem" }, "virkningTil": { "type": "string", - "description": "The time when the effect of the relevant version of the address element ceases\n" + "description": "End of the real-world validity period.\n\nCan be empty string `\"\"` if the address is still valid.\n", + "example": "2026-02-14T00:00:00.000Z" }, "adresse_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" + "description": "Full formatted address.\n\nCommonly consisting of street name, house number, floor, door, supplementary city name, postal code and postal city name.\n", + "example": "Æghøjvej 2, Vandet, 8620 Kjellerup" }, "adresse_dørbetegnelse": { "type": "string", - "description": "Door designation/Access point of the address\n" + "description": "Door/unit designation within a building.\n\nCan be empty string `\"\"` if not present.\n", + "example": "tv" }, "adresse_etagebetegnelse": { "type": "string", - "description": "Floor designation of the address\n" + "description": "Floor designation within a building.\n\nCan be empty string `\"\"` if not present.\n", + "example": "st" }, "adressepunkt_oprindelse_kilde": { "type": "string", - "description": "Origin source of the data\n" + "description": "Source of the address point geometry.\n\nCan be empty string `\"\"` if not present.\n", + "example": "Ekstern" }, "adressepunkt_oprindelse_nøjagtighedsklasse": { "type": "string", - "description": "Origin accuracy class of the data\n" + "description": "Accuracy class of the address point position.\n\nCan be empty string `\"\"` if not present.\n", + "example": "A" }, "adressepunkt_oprindelse_registrering": { "type": "string", - "description": "Origin registration date\n" + "description": "Date the address point geometry was registered in its source system.\n\nCan be empty string `\"\"` if not present.\n", + "example": "2004-08-16T22:00:00.000Z" }, "adressepunkt_oprindelse_tekniskStandard": { "type": "string", - "description": "Technical standard of the origin\n" + "description": "Technical standard used to establish the address point position.\n\nCan be empty string `\"\"` if not present.\n", + "example": "TN" }, "adressepunkt_position_x": { "oneOf": [ { "type": "string", - "description": "Empty string `\"\"` if not available" + "description": "Can be empty string `\"\"` if not present." }, { "type": "number", - "description": "X coordinate of the geometric position of the access point using epsg 25832\n" + "description": "X coordinate of the geometric position of the address point using EPSG 25832.\n", + "example": 691256.48 } ] }, @@ -10142,217 +10164,259 @@ "oneOf": [ { "type": "string", - "description": "Empty string `\"\"` if not available" + "description": "Can be empty string `\"\"` if not present." }, { "type": "number", - "description": "Y coordinate of the geometric position of the access point using epsg 25832\n" + "description": "Y coordinate of the geometric position of the address point using EPSG 25832.\n", + "example": 6191928.04 } ] }, "husnummer_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" + "description": "Full formatted access address.\n\nCommonly consisting of street name, house number, floor, door, supplementary city name, postal code and postal city name.\n\nCan be empty string `\"\"` if not present.\n", + "example": "Sydkajen 16, 3600 Frederikssund" }, "husnummer_vejmidte": { "type": "string", - "description": "Municipality code-road code\n" + "description": "Composite identifier formed by combining the municipality code and the road code, separated by a hyphen.\n\nCan be empty string `\"\"` if not present.\n", + "example": "0250-1248" }, "husnummer_husnummertekst": { "type": "string", - "description": "The house number of the address including any letters\n" + "description": "House number text as it appears on the address.\n\nCan be empty string `\"\"` if not present.\n", + "example": "16" }, "afstemningsomraadenummer": { "type": "string", - "description": "Polling district number\n" + "description": "Polling district number\n\nCan be empty string `\"\"` if not present.\n", + "example": "01" }, "afstemningsområde_navn": { "type": "string", - "description": "Name of the geographical entity\n" + "description": "Name of the polling district\n\nCan be empty string `\"\"` if not present.\n", + "example": "Frederikssund Midt" }, "afstemningsstedNavn": { "type": "string", - "description": "Polling place name\n" + "description": "Name of the polling station\n\nCan be empty string `\"\"` if not present.\n", + "example": "Frederikssundhallen" }, "kommuneinddeling_kommunekode": { - "oneOf": [ - { - "type": "boolean", - "description": "Outside municipality division (boolean flag)\n" - }, - { - "type": "string", - "description": "Empty \"\" if null\n" - } - ] + "type": "string", + "description": "Four-digit municipality code\n\nCan be empty string `\"\"` if not present.\n", + "example": "0250" }, "kommuneinddeling_navn": { "type": "string", - "description": "Name of the geographical entity\n" + "description": "Name of the municipality\n\nCan be empty string `\"\"` if not present.\n", + "example": "Frederikssund" }, "LAU1vaerdi": { "type": "string", - "description": "LAU1 value (Local Administrative Unit level 1)\n" + "description": "LAU level 1 value (EU Local Administrative Unit classification)\n\nCan be empty string `\"\"` if not present.\n", + "example": "250" }, "kommuneinddeling_udenforKommuneinddeling": { "oneOf": [ { "type": "string", - "description": "Empty \"\" if null\n" + "description": "Can be empty string `\"\"` if not present.\n" }, { "type": "boolean", - "description": "Outside municipality division (boolean flag)\n" + "description": "Flag indicating the location falls outside a standard municipality division.\n", + "example": false } ] }, "MRafstemningsomraadenummer": { "type": "string", - "description": "Municipal/regional polling district number\n" + "description": "Parish council polling district number\n\nCan be empty string `\"\"` if not present.\n", + "example": "1" }, "menighedsradsafstemningsomrade_navn": { "type": "string", - "description": "Name of the geographical entity\n" + "description": "Name of the parish council polling district\n\nCan be empty string `\"\"` if not present.\n", + "example": "Gørslev" }, "LAU2vaerdi": { "type": "string", - "description": "LAU2 value (Local Administrative Unit level 2)\n" + "description": "LAU level 2 value (EU Local Administrative Unit classification)\n\nCan be empty string `\"\"` if not present.\n", + "example": "7418" }, "sogneinddeling_sognekode": { "type": "string", - "description": "Parish code\n" + "description": "Parish code\n\nCan be empty string `\"\"` if not present.\n", + "example": "7418" }, "sogneinddeling_navn": { "type": "string", - "description": "Name of the geographical entity\n" + "description": "Name of the parish\n\nCan be empty string `\"\"` if not present.\n", + "example": "Frederikssund" }, "supplerendebynavn_navn": { "type": "string", - "description": "Name of the geographical entity\n" + "description": "Supplementary locality or village name used alongside the postal address.\n\nCan be empty string `\"\"` if not present.\n", + "example": "Blæsbjerg" }, "navngivenvej_beskrivelse": { "type": "string", - "description": "Brief description of the origin or meaning of the road name\n" + "description": "Brief description of the origin or meaning of the road name.\n\nCan be empty string `\"\"` if not present.\n" }, "navngivenvej_udtaltVejnavn": { "type": "string", - "description": "The street name written in full, as it is pronounced\n" + "description": "Phonetic/spoken form of the road name.\n\nCan be empty string `\"\"` if not present.\n", + "example": "Ærteholmsvej" }, "navngivenvej_vejadresseringsnavn": { "type": "string", - "description": "Abbreviated version of the road name of no more than 20 characters\n" + "description": "Abbreviated road name containing no more than 20 characters.\n\nCan be empty string `\"\"` if not present.\n", + "example": "Sydkajen" }, "navngivenvej_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" + "description": "Official full road name\n\nCan be empty string `\"\"` if not present.\n", + "example": "Blåbærheden" }, "navngivenvej_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" + "description": "Source of the road name location geometry.\n\nCan be empty string `\"\"` if not present.\n", + "example": "Ekstern" }, "navngivenvej_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" + "description": "Accuracy class of the road name location geometry.\n\nCan be empty string `\"\"` if not present.\n", + "example": "B" }, "navngivenvej_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" + "description": "Registration date of the road name location geometry.\n\nCan be empty string `\"\"` if not present.\n", + "example": "2018-05-03T15:57:30.356Z" }, "navngivenvej_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" + "description": "Technical standard used for the road name location geometry.\n\nCan be empty string `\"\"` if not present.\n", + "example": "NO" }, "navngivenvejkommunedel_vejkode": { "type": "string", - "description": "Unique identification of the part of a Named Road that affects a single municipality\n" + "description": "Road code identifying the road segment within a municipality.\n\nCan be empty string `\"\"` if not present.\n", + "example": "1248" }, "postnummer_navn": { "type": "string", - "description": "Name of the city, district, etc. that the postal code includes\n" + "description": "Postal district name\n\nCan be empty string `\"\"` if not present.\n", + "example": "Fjenneslev" }, "postnummer_postnr": { "type": "string", - "description": "Four-digit code that identifies the postal code\n" + "description": "Postal code\n\nCan be empty string `\"\"` if not present.\n", + "example": "4173" }, "opstillingskredsnummer": { "type": "string", - "description": "Constituency number\n" + "description": "Nomination constituency number\n\nCan be empty string `\"\"` if not present.\n", + "example": "83" }, "opstillingskreds_navn": { "type": "string", - "description": "Name of the geographical entity\n" + "description": "Name of the nomination constituency\n\nCan be empty string `\"\"` if not present.\n", + "example": "Ringkøbing" }, "valgkredsnummer": { "type": "string", - "description": "National electoral district number\n" + "description": "Electoral constituency number\n\nCan be empty string `\"\"` if not present.\n", + "example": "4" }, "storkredsnummer": { "type": "string", - "description": "Regional electoral district number\n" + "description": "Multi-member constituency number\n\nCan be empty string `\"\"` if not present.\n", + "example": "3" }, "storkreds_navn": { "type": "string", - "description": "Name of the geographical entity\n" + "description": "Name of the multi-member constituency\n\nCan be empty string `\"\"` if not present.\n", + "example": "Nordsjælland" }, "valglandsdelsbogstav": { "type": "string", - "description": "National electoral district letter\n" + "description": "Letter identifying the electoral region\n\nCan be empty string `\"\"` if not present.\n", + "example": "A" }, "valglandsdels_navn": { "type": "string", - "description": "Name of the geographical entity\n" + "description": "Name of the electoral region\n\nCan be empty string `\"\"` if not present.\n", + "example": "Hovedstaden" }, "postnummerinddeling_ergadepostnummer": { "oneOf": [ { "type": "string", - "description": "Empty string if null\n" + "description": "Can be empty string `\"\"` if not present.\n" }, { "type": "boolean", - "description": "Whether it is a \"street postal code\"\n" + "description": "Flag indicating whether the postal code is a street-level code.\n", + "example": false } ] }, "nuts2vaerdi": { "type": "string", - "description": "NUTS2 value (NUTS level 2)\n" + "description": "NUTS level 2 code (EU regional classification)\n\nCan be empty string `\"\"` if not present.\n", + "example": "DK01" }, "regionsinddeling_regionskode": { "type": "string", - "description": "Region code\n" + "description": "Region code\n\nCan be empty string `\"\"` if not present.\n", + "example": "1084" }, "regionsinddeling_navn": { "type": "string", - "description": "Name of the geographical entity\n" + "description": "Name of the region\n\nCan be empty string `\"\"` if not present.\n", + "example": "Region Hovedstaden" + }, + "politikreds_myndighedskode": { + "type": "string", + "description": "Police district code\n\nCan be empty string `\"\"` if not present.\n", + "example": "1468" }, "politikredsnummer": { "type": "string", - "description": "Police district number\n" + "description": "Police district number\n\nCan be empty string `\"\"` if not present.\n", + "example": "9" }, "politikreds_navn": { "type": "string", - "description": "Name of the geographical entity\n" + "description": "Name of the police district\n\nCan be empty string `\"\"` if not present.\n", + "example": "Nordsjællands Politi" }, - "myndighedskode": { + "retskreds_myndighedskode": { "type": "string", - "description": "Public authority code\n" + "description": "Judicial district code\n\nCan be empty string `\"\"` if not present.\n", + "example": "1115" }, "retskredsnummer": { "type": "string", - "description": "Judicial district number\n" + "description": "Judicial district number\n\nCan be empty string `\"\"` if not present.\n", + "example": "18" }, "retskreds_navn": { "type": "string", - "description": "Name of the geographical entity\n" + "description": "Name of the judicial district\n\nCan be empty string `\"\"` if not present.\n", + "example": "Retten i Hillerød" }, "nuts3vaerdi": { "type": "string", - "description": "NUTS3 value (NUTS level 3)\n" + "description": "NUTS level 3 code (EU sub-regional classification)\n\nCan be empty string `\"\"` if not present.\n", + "example": "DK013" }, "landsdel_navn": { "type": "string", - "description": "Name of the geographical entity\n" + "description": "Name of the statistical subdivision\n\nCan be empty string `\"\"` if not present.\n", + "example": "Nordsjælland" } } }, @@ -11201,6 +11265,32 @@ } } }, + "ApiKeyMonthlyLimit": { + "title": "API Key Monthly Limit", + "type": "object", + "required": [ + "limit", + "consumed" + ], + "properties": { + "limit": { + "x-nullable": true, + "nullable": true, + "minimum": 0, + "example": 10000, + "type": "integer", + "description": "`number` or `null`. The monthly lookup limit currently set on your key.\n`null` means the limit is currently disabled.", + "format": "int32" + }, + "consumed": { + "minimum": 0, + "example": 2500, + "type": "integer", + "description": "Number of lookups performed this month which count towards your monthly limit.", + "format": "int32" + } + } + }, "ApiKeyIndividualLimit": { "title": "API Key Individual Limit", "type": "object", @@ -11506,6 +11596,7 @@ "required": [ "lookups_remaining", "daily_limit", + "monthly_limit", "individual_limit", "allowed_urls", "redact_days", @@ -11525,6 +11616,9 @@ "daily_limit": { "$ref": "#/components/schemas/ApiKeyDailyLimit" }, + "monthly_limit": { + "$ref": "#/components/schemas/ApiKeyMonthlyLimit" + }, "individual_limit": { "$ref": "#/components/schemas/ApiKeyIndividualLimit" }, @@ -11609,6 +11703,21 @@ } } }, + "monthly_limit": { + "title": "Monthly Rate Limit", + "type": "object", + "properties": { + "limit": { + "x-nullable": true, + "nullable": true, + "minimum": 0, + "example": 10000, + "type": "integer", + "description": "`number` or `null`. The monthly lookup limit currently set on your key.\n`null` means the limit is currently disabled.", + "format": "int32" + } + } + }, "individual_limit": { "title": "API Key Individual Limit", "type": "object", diff --git a/dist/openapi.yaml b/dist/openapi.yaml index f07ab26..a7f2e71 100644 --- a/dist/openapi.yaml +++ b/dist/openapi.yaml @@ -9636,9 +9636,10 @@ components: - nuts2vaerdi - regionsinddeling_regionskode - regionsinddeling_navn + - politikreds_myndighedskode - politikredsnummer - politikreds_navn - - myndighedskode + - retskreds_myndighedskode - retskredsnummer - retskreds_navn - nuts3vaerdi @@ -9675,17 +9676,24 @@ components: 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 + Address / House Number uniquely identifying the address along the specified street. + + Can be empty string `""` if not present. + example: '95' line_1: type: string description: | First address line. - Returns street name, house number, (optional floor, door and city name) + + May include street name, house number, floor number and door number. + example: Vænget 19 line_2: type: string description: | Second address line. + + May include supplementary city name. Can be empty string `""` if not present. + example: Benløse longitude: $ref: '#/components/schemas/Longitude' latitude: @@ -9693,289 +9701,458 @@ components: forretningshændelse: type: string description: | - The business event that caused the address element to be updated to that version + Business event type that triggered the record. + example: '2' forretningsområde: type: string description: | - The business area that has updated the address element to the version in question + Business domain or subject area the record belongs to. + example: 54.15.10.08 forretningsproces: type: string description: | - The business process that caused the address element to be updated to that version + Business process that produced or last modified the record. + example: '0' id_namespace: type: string description: | - Url of data file + Namespace URI that qualifies the local identifier. + example: http://data.gov.dk/dar/adresse id_lokalId: type: string description: | - Identification of the address element throughout its entire life cycle + Local unique identifier for the address object within its namespace. + example: 0000090e-e9f3-4ffe-a0a5-2852666d158c registreringFra: type: string description: | - The time at which the registration of the relevant version of the address element was made + Start of the registration period (when the record became valid in the register). + example: '2021-06-21T07:54:04.191Z' registreringsaktør: type: string description: | - The actor who has registered the relevant version of the address element + Actor (authority or system) responsible for the registration of the address record. + example: DAR 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 + End of the registration period. + + Can be empty string `""` if the address is still active. 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 + Current lifecycle status of the object. + example: '4' virkningFra: type: string description: | - The time from which the relevant version of the address element takes effect + Start of the real-world validity period (when the address record takes effect in reality). + example: '2021-06-21T07:54:04.191Z' virkningsaktør: type: string description: | - The actor who has caused the effect properties for the relevant version of the address element + Actor (authority or system) responsible for the real-world change that prompted the record. + example: AjourføreDarSystem virkningTil: type: string description: | - The time when the effect of the relevant version of the address element ceases + End of the real-world validity period. + + Can be empty string `""` if the address is still valid. + example: '2026-02-14T00:00:00.000Z' adresse_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 + Full formatted address. + + Commonly consisting of street name, house number, floor, door, supplementary city name, postal code and postal city name. + example: Æghøjvej 2, Vandet, 8620 Kjellerup adresse_dørbetegnelse: type: string description: | - Door designation/Access point of the address + Door/unit designation within a building. + + Can be empty string `""` if not present. + example: tv adresse_etagebetegnelse: type: string description: | - Floor designation of the address + Floor designation within a building. + + Can be empty string `""` if not present. + example: st adressepunkt_oprindelse_kilde: type: string description: | - Origin source of the data + Source of the address point geometry. + + Can be empty string `""` if not present. + example: Ekstern adressepunkt_oprindelse_nøjagtighedsklasse: type: string description: | - Origin accuracy class of the data + Accuracy class of the address point position. + + Can be empty string `""` if not present. + example: A adressepunkt_oprindelse_registrering: type: string description: | - Origin registration date + Date the address point geometry was registered in its source system. + + Can be empty string `""` if not present. + example: '2004-08-16T22:00:00.000Z' adressepunkt_oprindelse_tekniskStandard: type: string description: | - Technical standard of the origin + Technical standard used to establish the address point position. + + Can be empty string `""` if not present. + example: TN adressepunkt_position_x: oneOf: - type: string - description: Empty string `""` if not available + description: Can be empty string `""` if not present. - type: number description: | - X coordinate of the geometric position of the access point using epsg 25832 + X coordinate of the geometric position of the address point using EPSG 25832. + example: 691256.48 adressepunkt_position_y: oneOf: - type: string - description: Empty string `""` if not available + description: Can be empty string `""` if not present. - type: number description: | - Y coordinate of the geometric position of the access point using epsg 25832 + Y coordinate of the geometric position of the address point using EPSG 25832. + example: 6191928.04 husnummer_adgangsadressebetegnelse: type: string description: | - Full access address, commonly consisting of street name, house number, and additional town names, postal code and postal city name + Full formatted access address. + + Commonly consisting of street name, house number, floor, door, supplementary city name, postal code and postal city name. + + Can be empty string `""` if not present. + example: Sydkajen 16, 3600 Frederikssund husnummer_vejmidte: type: string description: | - Municipality code-road code + Composite identifier formed by combining the municipality code and the road code, separated by a hyphen. + + Can be empty string `""` if not present. + example: 0250-1248 husnummer_husnummertekst: type: string description: | - The house number of the address including any letters + House number text as it appears on the address. + + Can be empty string `""` if not present. + example: '16' afstemningsomraadenummer: type: string description: | Polling district number + + Can be empty string `""` if not present. + example: '01' afstemningsområde_navn: type: string description: | - Name of the geographical entity + Name of the polling district + + Can be empty string `""` if not present. + example: Frederikssund Midt afstemningsstedNavn: type: string description: | - Polling place name + Name of the polling station + + Can be empty string `""` if not present. + example: Frederikssundhallen kommuneinddeling_kommunekode: - oneOf: - - type: boolean - description: | - Outside municipality division (boolean flag) - - type: string - description: | - Empty "" if null + type: string + description: | + Four-digit municipality code + + Can be empty string `""` if not present. + example: '0250' kommuneinddeling_navn: type: string description: | - Name of the geographical entity + Name of the municipality + + Can be empty string `""` if not present. + example: Frederikssund LAU1vaerdi: type: string description: | - LAU1 value (Local Administrative Unit level 1) + LAU level 1 value (EU Local Administrative Unit classification) + + Can be empty string `""` if not present. + example: '250' kommuneinddeling_udenforKommuneinddeling: oneOf: - type: string description: | - Empty "" if null + Can be empty string `""` if not present. - type: boolean description: | - Outside municipality division (boolean flag) + Flag indicating the location falls outside a standard municipality division. + example: false MRafstemningsomraadenummer: type: string description: | - Municipal/regional polling district number + Parish council polling district number + + Can be empty string `""` if not present. + example: '1' menighedsradsafstemningsomrade_navn: type: string description: | - Name of the geographical entity + Name of the parish council polling district + + Can be empty string `""` if not present. + example: Gørslev LAU2vaerdi: type: string description: | - LAU2 value (Local Administrative Unit level 2) + LAU level 2 value (EU Local Administrative Unit classification) + + Can be empty string `""` if not present. + example: '7418' sogneinddeling_sognekode: type: string description: | Parish code + + Can be empty string `""` if not present. + example: '7418' sogneinddeling_navn: type: string description: | - Name of the geographical entity + Name of the parish + + Can be empty string `""` if not present. + example: Frederikssund supplerendebynavn_navn: type: string description: | - Name of the geographical entity + Supplementary locality or village name used alongside the postal address. + + Can be empty string `""` if not present. + example: Blæsbjerg navngivenvej_beskrivelse: type: string description: | - Brief description of the origin or meaning of the road name + Brief description of the origin or meaning of the road name. + + Can be empty string `""` if not present. navngivenvej_udtaltVejnavn: type: string description: | - The street name written in full, as it is pronounced + Phonetic/spoken form of the road name. + + Can be empty string `""` if not present. + example: Ærteholmsvej navngivenvej_vejadresseringsnavn: type: string description: | - Abbreviated version of the road name of no more than 20 characters + Abbreviated road name containing no more than 20 characters. + + Can be empty string `""` if not present. + example: Sydkajen navngivenvej_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 + Official full road name + + Can be empty string `""` if not present. + example: Blåbærheden navngivenvej_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 + Source of the road name location geometry. + + Can be empty string `""` if not present. + example: Ekstern navngivenvej_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 + Accuracy class of the road name location geometry. + + Can be empty string `""` if not present. + example: B navngivenvej_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 + Registration date of the road name location geometry. + + Can be empty string `""` if not present. + example: '2018-05-03T15:57:30.356Z' navngivenvej_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 + Technical standard used for the road name location geometry. + + Can be empty string `""` if not present. + example: 'NO' navngivenvejkommunedel_vejkode: type: string description: | - Unique identification of the part of a Named Road that affects a single municipality + Road code identifying the road segment within a municipality. + + Can be empty string `""` if not present. + example: '1248' postnummer_navn: type: string description: | - Name of the city, district, etc. that the postal code includes + Postal district name + + Can be empty string `""` if not present. + example: Fjenneslev postnummer_postnr: type: string description: | - Four-digit code that identifies the postal code + Postal code + + Can be empty string `""` if not present. + example: '4173' opstillingskredsnummer: type: string description: | - Constituency number + Nomination constituency number + + Can be empty string `""` if not present. + example: '83' opstillingskreds_navn: type: string description: | - Name of the geographical entity + Name of the nomination constituency + + Can be empty string `""` if not present. + example: Ringkøbing valgkredsnummer: type: string description: | - National electoral district number + Electoral constituency number + + Can be empty string `""` if not present. + example: '4' storkredsnummer: type: string description: | - Regional electoral district number + Multi-member constituency number + + Can be empty string `""` if not present. + example: '3' storkreds_navn: type: string description: | - Name of the geographical entity + Name of the multi-member constituency + + Can be empty string `""` if not present. + example: Nordsjælland valglandsdelsbogstav: type: string description: | - National electoral district letter + Letter identifying the electoral region + + Can be empty string `""` if not present. + example: A valglandsdels_navn: type: string description: | - Name of the geographical entity + Name of the electoral region + + Can be empty string `""` if not present. + example: Hovedstaden postnummerinddeling_ergadepostnummer: oneOf: - type: string description: | - Empty string if null + Can be empty string `""` if not present. - type: boolean description: | - Whether it is a "street postal code" + Flag indicating whether the postal code is a street-level code. + example: false nuts2vaerdi: type: string description: | - NUTS2 value (NUTS level 2) + NUTS level 2 code (EU regional classification) + + Can be empty string `""` if not present. + example: DK01 regionsinddeling_regionskode: type: string description: | Region code + + Can be empty string `""` if not present. + example: '1084' regionsinddeling_navn: type: string description: | - Name of the geographical entity + Name of the region + + Can be empty string `""` if not present. + example: Region Hovedstaden + politikreds_myndighedskode: + type: string + description: | + Police district code + + Can be empty string `""` if not present. + example: '1468' politikredsnummer: type: string description: | Police district number + + Can be empty string `""` if not present. + example: '9' politikreds_navn: type: string description: | - Name of the geographical entity - myndighedskode: + Name of the police district + + Can be empty string `""` if not present. + example: Nordsjællands Politi + retskreds_myndighedskode: type: string description: | - Public authority code + Judicial district code + + Can be empty string `""` if not present. + example: '1115' retskredsnummer: type: string description: | Judicial district number + + Can be empty string `""` if not present. + example: '18' retskreds_navn: type: string description: | - Name of the geographical entity + Name of the judicial district + + Can be empty string `""` if not present. + example: Retten i Hillerød nuts3vaerdi: type: string description: | - NUTS3 value (NUTS level 3) + NUTS level 3 code (EU sub-regional classification) + + Can be empty string `""` if not present. + example: DK013 landsdel_navn: type: string description: | - Name of the geographical entity + Name of the statistical subdivision + + Can be empty string `""` if not present. + example: Nordsjælland GbrGlobalAddress: title: Global Address description: Global (non-UK) address in the UK address format @@ -10623,6 +10800,29 @@ components: type: integer description: Number of lookups performed today which count towards your daily limit. format: int32 + ApiKeyMonthlyLimit: + title: API Key Monthly Limit + type: object + required: + - limit + - consumed + properties: + limit: + x-nullable: true + nullable: true + minimum: 0 + example: 10000 + type: integer + description: |- + `number` or `null`. The monthly lookup limit currently set on your key. + `null` means the limit is currently disabled. + format: int32 + consumed: + minimum: 0 + example: 2500 + type: integer + description: Number of lookups performed this month which count towards your monthly limit. + format: int32 ApiKeyIndividualLimit: title: API Key Individual Limit type: object @@ -10878,6 +11078,7 @@ components: required: - lookups_remaining - daily_limit + - monthly_limit - individual_limit - allowed_urls - redact_days @@ -10894,6 +11095,8 @@ components: format: int32 daily_limit: $ref: '#/components/schemas/ApiKeyDailyLimit' + monthly_limit: + $ref: '#/components/schemas/ApiKeyMonthlyLimit' individual_limit: $ref: '#/components/schemas/ApiKeyIndividualLimit' allowed_urls: @@ -10957,6 +11160,20 @@ components: `number` or `null`. The daily lookup limit currently set on your key. `null` means the limit is currently disabled. format: int32 + monthly_limit: + title: Monthly Rate Limit + type: object + properties: + limit: + x-nullable: true + nullable: true + minimum: 0 + example: 10000 + type: integer + description: |- + `number` or `null`. The monthly lookup limit currently set on your key. + `null` means the limit is currently disabled. + format: int32 individual_limit: title: API Key Individual Limit type: object diff --git a/openapi.ts b/openapi.ts index fa5af95..af82f73 100644 --- a/openapi.ts +++ b/openapi.ts @@ -5908,158 +5908,516 @@ export interface components { */ language: "da"; /** - * @description Full address, commonly consisting of street name, house number, (optional floor, door and city name), postal code and postal city name + * @description Address / House Number uniquely identifying the address along the specified street. + * + * Can be empty string `""` if not present. * - * @example Elstedvej 95, Terp, 8200 Aarhus N + * @example 95 */ address: string; /** * @description First address line. - * Returns street name, house number, (optional floor, door and city name) + * + * May include street name, house number, floor number and door number. + * + * @example Vænget 19 */ line_1: string; - /** @description Second address line. */ + /** + * @description Second address line. + * + * May include supplementary city name. Can be empty string `""` if not present. + * + * @example Benløse + */ line_2: string; longitude: components["schemas"]["Longitude"]; latitude: components["schemas"]["Latitude"]; - /** @description The business event that caused the address element to be updated to that version */ + /** + * @description Business event type that triggered the record. + * + * @example 2 + */ forretningshændelse: string; - /** @description The business area that has updated the address element to the version in question */ + /** + * @description Business domain or subject area the record belongs to. + * + * @example 54.15.10.08 + */ forretningsområde: string; - /** @description The business process that caused the address element to be updated to that version */ + /** + * @description Business process that produced or last modified the record. + * + * @example 0 + */ forretningsproces: string; - /** @description Url of data file */ + /** + * @description Namespace URI that qualifies the local identifier. + * + * @example http://data.gov.dk/dar/adresse + */ id_namespace: string; - /** @description Identification of the address element throughout its entire life cycle */ + /** + * @description Local unique identifier for the address object within its namespace. + * + * @example 0000090e-e9f3-4ffe-a0a5-2852666d158c + */ id_lokalId: string; - /** @description The time at which the registration of the relevant version of the address element was made */ + /** + * @description Start of the registration period (when the record became valid in the register). + * + * @example 2021-06-21T07:54:04.191Z + */ registreringFra: string; - /** @description The actor who has registered the relevant version of the address element */ + /** + * @description Actor (authority or system) responsible for the registration of the address record. + * + * @example DAR + */ 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 */ + /** + * @description End of the registration period. + * + * Can be empty string `""` if the address is still active. + */ 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 */ + /** + * @description Current lifecycle status of the object. + * + * @example 4 + */ status: string; - /** @description The time from which the relevant version of the address element takes effect */ + /** + * @description Start of the real-world validity period (when the address record takes effect in reality). + * + * @example 2021-06-21T07:54:04.191Z + */ virkningFra: string; - /** @description The actor who has caused the effect properties for the relevant version of the address element */ + /** + * @description Actor (authority or system) responsible for the real-world change that prompted the record. + * + * @example AjourføreDarSystem + */ virkningsaktør: string; - /** @description The time when the effect of the relevant version of the address element ceases */ + /** + * @description End of the real-world validity period. + * + * Can be empty string `""` if the address is still valid. + * + * @example 2026-02-14T00:00:00.000Z + */ virkningTil: string; - /** @description Full address, commonly consisting of street name, house number, (optional floor, door and city name), postal code and postal city name */ + /** + * @description Full formatted address. + * + * Commonly consisting of street name, house number, floor, door, supplementary city name, postal code and postal city name. + * + * @example Æghøjvej 2, Vandet, 8620 Kjellerup + */ adresse_adressebetegnelse: string; - /** @description Door designation/Access point of the address */ + /** + * @description Door/unit designation within a building. + * + * Can be empty string `""` if not present. + * + * @example tv + */ adresse_dørbetegnelse: string; - /** @description Floor designation of the address */ + /** + * @description Floor designation within a building. + * + * Can be empty string `""` if not present. + * + * @example st + */ adresse_etagebetegnelse: string; - /** @description Origin source of the data */ + /** + * @description Source of the address point geometry. + * + * Can be empty string `""` if not present. + * + * @example Ekstern + */ adressepunkt_oprindelse_kilde: string; - /** @description Origin accuracy class of the data */ + /** + * @description Accuracy class of the address point position. + * + * Can be empty string `""` if not present. + * + * @example A + */ adressepunkt_oprindelse_nøjagtighedsklasse: string; - /** @description Origin registration date */ + /** + * @description Date the address point geometry was registered in its source system. + * + * Can be empty string `""` if not present. + * + * @example 2004-08-16T22:00:00.000Z + */ adressepunkt_oprindelse_registrering: string; - /** @description Technical standard of the origin */ + /** + * @description Technical standard used to establish the address point position. + * + * Can be empty string `""` if not present. + * + * @example TN + */ adressepunkt_oprindelse_tekniskStandard: string; adressepunkt_position_x: string | number; adressepunkt_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 */ + /** + * @description Full formatted access address. + * + * Commonly consisting of street name, house number, floor, door, supplementary city name, postal code and postal city name. + * + * Can be empty string `""` if not present. + * + * @example Sydkajen 16, 3600 Frederikssund + */ husnummer_adgangsadressebetegnelse: string; - /** @description Municipality code-road code */ + /** + * @description Composite identifier formed by combining the municipality code and the road code, separated by a hyphen. + * + * Can be empty string `""` if not present. + * + * @example 0250-1248 + */ husnummer_vejmidte: string; - /** @description The house number of the address including any letters */ + /** + * @description House number text as it appears on the address. + * + * Can be empty string `""` if not present. + * + * @example 16 + */ husnummer_husnummertekst: string; - /** @description Polling district number */ + /** + * @description Polling district number + * + * Can be empty string `""` if not present. + * + * @example 01 + */ afstemningsomraadenummer: string; - /** @description Name of the geographical entity */ + /** + * @description Name of the polling district + * + * Can be empty string `""` if not present. + * + * @example Frederikssund Midt + */ afstemningsområde_navn: string; - /** @description Polling place name */ + /** + * @description Name of the polling station + * + * Can be empty string `""` if not present. + * + * @example Frederikssundhallen + */ afstemningsstedNavn: string; - kommuneinddeling_kommunekode: boolean | string; - /** @description Name of the geographical entity */ + /** + * @description Four-digit municipality code + * + * Can be empty string `""` if not present. + * + * @example 0250 + */ + kommuneinddeling_kommunekode: string; + /** + * @description Name of the municipality + * + * Can be empty string `""` if not present. + * + * @example Frederikssund + */ kommuneinddeling_navn: string; - /** @description LAU1 value (Local Administrative Unit level 1) */ + /** + * @description LAU level 1 value (EU Local Administrative Unit classification) + * + * Can be empty string `""` if not present. + * + * @example 250 + */ LAU1vaerdi: string; kommuneinddeling_udenforKommuneinddeling: string | boolean; - /** @description Municipal/regional polling district number */ + /** + * @description Parish council polling district number + * + * Can be empty string `""` if not present. + * + * @example 1 + */ MRafstemningsomraadenummer: string; - /** @description Name of the geographical entity */ + /** + * @description Name of the parish council polling district + * + * Can be empty string `""` if not present. + * + * @example Gørslev + */ menighedsradsafstemningsomrade_navn: string; - /** @description LAU2 value (Local Administrative Unit level 2) */ + /** + * @description LAU level 2 value (EU Local Administrative Unit classification) + * + * Can be empty string `""` if not present. + * + * @example 7418 + */ LAU2vaerdi: string; - /** @description Parish code */ + /** + * @description Parish code + * + * Can be empty string `""` if not present. + * + * @example 7418 + */ sogneinddeling_sognekode: string; - /** @description Name of the geographical entity */ + /** + * @description Name of the parish + * + * Can be empty string `""` if not present. + * + * @example Frederikssund + */ sogneinddeling_navn: string; - /** @description Name of the geographical entity */ + /** + * @description Supplementary locality or village name used alongside the postal address. + * + * Can be empty string `""` if not present. + * + * @example Blæsbjerg + */ supplerendebynavn_navn: string; - /** @description Brief description of the origin or meaning of the road name */ + /** + * @description Brief description of the origin or meaning of the road name. + * + * Can be empty string `""` if not present. + */ navngivenvej_beskrivelse: string; - /** @description The street name written in full, as it is pronounced */ + /** + * @description Phonetic/spoken form of the road name. + * + * Can be empty string `""` if not present. + * + * @example Ærteholmsvej + */ navngivenvej_udtaltVejnavn: string; - /** @description Abbreviated version of the road name of no more than 20 characters */ + /** + * @description Abbreviated road name containing no more than 20 characters. + * + * Can be empty string `""` if not present. + * + * @example Sydkajen + */ navngivenvej_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 */ + /** + * @description Official full road name + * + * Can be empty string `""` if not present. + * + * @example Blåbærheden + */ navngivenvej_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 + * @description Source of the road name location geometry. + * + * Can be empty string `""` if not present. + * + * @example Ekstern */ navngivenvej_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 + * @description Accuracy class of the road name location geometry. + * + * Can be empty string `""` if not present. + * + * @example B */ navngivenvej_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 + * @description Registration date of the road name location geometry. + * + * Can be empty string `""` if not present. + * + * @example 2018-05-03T15:57:30.356Z */ navngivenvej_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 + * @description Technical standard used for the road name location geometry. + * + * Can be empty string `""` if not present. + * + * @example NO */ navngivenvej_vejnavnebeliggenhed_oprindelse_tekniskStandard: string; - /** @description Unique identification of the part of a Named Road that affects a single municipality */ + /** + * @description Road code identifying the road segment within a municipality. + * + * Can be empty string `""` if not present. + * + * @example 1248 + */ navngivenvejkommunedel_vejkode: string; - /** @description Name of the city, district, etc. that the postal code includes */ + /** + * @description Postal district name + * + * Can be empty string `""` if not present. + * + * @example Fjenneslev + */ postnummer_navn: string; - /** @description Four-digit code that identifies the postal code */ + /** + * @description Postal code + * + * Can be empty string `""` if not present. + * + * @example 4173 + */ postnummer_postnr: string; - /** @description Constituency number */ + /** + * @description Nomination constituency number + * + * Can be empty string `""` if not present. + * + * @example 83 + */ opstillingskredsnummer: string; - /** @description Name of the geographical entity */ + /** + * @description Name of the nomination constituency + * + * Can be empty string `""` if not present. + * + * @example Ringkøbing + */ opstillingskreds_navn: string; - /** @description National electoral district number */ + /** + * @description Electoral constituency number + * + * Can be empty string `""` if not present. + * + * @example 4 + */ valgkredsnummer: string; - /** @description Regional electoral district number */ + /** + * @description Multi-member constituency number + * + * Can be empty string `""` if not present. + * + * @example 3 + */ storkredsnummer: string; - /** @description Name of the geographical entity */ + /** + * @description Name of the multi-member constituency + * + * Can be empty string `""` if not present. + * + * @example Nordsjælland + */ storkreds_navn: string; - /** @description National electoral district letter */ + /** + * @description Letter identifying the electoral region + * + * Can be empty string `""` if not present. + * + * @example A + */ valglandsdelsbogstav: string; - /** @description Name of the geographical entity */ + /** + * @description Name of the electoral region + * + * Can be empty string `""` if not present. + * + * @example Hovedstaden + */ valglandsdels_navn: string; postnummerinddeling_ergadepostnummer: string | boolean; - /** @description NUTS2 value (NUTS level 2) */ + /** + * @description NUTS level 2 code (EU regional classification) + * + * Can be empty string `""` if not present. + * + * @example DK01 + */ nuts2vaerdi: string; - /** @description Region code */ + /** + * @description Region code + * + * Can be empty string `""` if not present. + * + * @example 1084 + */ regionsinddeling_regionskode: string; - /** @description Name of the geographical entity */ + /** + * @description Name of the region + * + * Can be empty string `""` if not present. + * + * @example Region Hovedstaden + */ regionsinddeling_navn: string; - /** @description Police district number */ + /** + * @description Police district code + * + * Can be empty string `""` if not present. + * + * @example 1468 + */ + politikreds_myndighedskode: string; + /** + * @description Police district number + * + * Can be empty string `""` if not present. + * + * @example 9 + */ politikredsnummer: string; - /** @description Name of the geographical entity */ + /** + * @description Name of the police district + * + * Can be empty string `""` if not present. + * + * @example Nordsjællands Politi + */ politikreds_navn: string; - /** @description Public authority code */ - myndighedskode: string; - /** @description Judicial district number */ + /** + * @description Judicial district code + * + * Can be empty string `""` if not present. + * + * @example 1115 + */ + retskreds_myndighedskode: string; + /** + * @description Judicial district number + * + * Can be empty string `""` if not present. + * + * @example 18 + */ retskredsnummer: string; - /** @description Name of the geographical entity */ + /** + * @description Name of the judicial district + * + * Can be empty string `""` if not present. + * + * @example Retten i Hillerød + */ retskreds_navn: string; - /** @description NUTS3 value (NUTS level 3) */ + /** + * @description NUTS level 3 code (EU sub-regional classification) + * + * Can be empty string `""` if not present. + * + * @example DK013 + */ nuts3vaerdi: string; - /** @description Name of the geographical entity */ + /** + * @description Name of the statistical subdivision + * + * Can be empty string `""` if not present. + * + * @example Nordsjælland + */ landsdel_navn: string; }; /** @@ -6600,6 +6958,22 @@ export interface components { */ consumed: number; }; + /** API Key Monthly Limit */ + ApiKeyMonthlyLimit: { + /** + * Format: int32 + * @description `number` or `null`. The monthly lookup limit currently set on your key. + * `null` means the limit is currently disabled. + * @example 10000 + */ + limit: number | null; + /** + * Format: int32 + * @description Number of lookups performed this month which count towards your monthly limit. + * @example 2500 + */ + consumed: number; + }; /** API Key Individual Limit */ ApiKeyIndividualLimit: { /** @@ -6833,6 +7207,7 @@ export interface components { */ lookups_remaining: number; daily_limit: components["schemas"]["ApiKeyDailyLimit"]; + monthly_limit: components["schemas"]["ApiKeyMonthlyLimit"]; individual_limit: components["schemas"]["ApiKeyIndividualLimit"]; /** @description A list of allowed URLs. An empty list means that allowed URLs are disabled. */ allowed_urls: string[]; @@ -6875,6 +7250,16 @@ export interface components { */ limit?: number | null; }; + /** Monthly Rate Limit */ + monthly_limit?: { + /** + * Format: int32 + * @description `number` or `null`. The monthly lookup limit currently set on your key. + * `null` means the limit is currently disabled. + * @example 10000 + */ + limit?: number | null; + }; /** API Key Individual Limit */ individual_limit?: { /**