Skip to content

Commit 04ee230

Browse files
cblanccblanc
committed
feat(API Key): Add monthly limits
1 parent d149420 commit 04ee230

File tree

3 files changed

+124
-1
lines changed

3 files changed

+124
-1
lines changed

‎dist/openapi.json‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4807,6 +4807,8 @@
48074807
"title": "Ireland ECAD Address",
48084808
"description": "The ECAD contains additional data for each ECAF address.",
48094809
"required": [
4810+
"dataset",
4811+
"ecad_id",
48104812
"organisation_id",
48114813
"address_point_id",
48124814
"building_id",
@@ -4926,6 +4928,7 @@
49264928
},
49274929
"post_county_id": {
49284930
"type": "string",
4931+
"nullable": true,
49294932
"description": "Post County ID",
49304933
"example": "10098783",
49314934
"maxLength": 10,
@@ -5068,6 +5071,7 @@
50685071
"title": "Ireland ECAF Address",
50695072
"description": "ECAF is the Eircode Address File which contains one record for each Postal Address. English language and Irish language versions are available. It is distributed as a flat file, details of data provision and updates are provided in section 2.",
50705073
"required": [
5074+
"dataset",
50715075
"ecaf_id"
50725076
],
50735077
"allOf": [
@@ -10756,6 +10760,32 @@
1075610760
}
1075710761
}
1075810762
},
10763+
"ApiKeyMonthlyLimit": {
10764+
"title": "API Key Monthly Limit",
10765+
"type": "object",
10766+
"required": [
10767+
"limit",
10768+
"consumed"
10769+
],
10770+
"properties": {
10771+
"limit": {
10772+
"x-nullable": true,
10773+
"nullable": true,
10774+
"minimum": 0,
10775+
"example": 10000,
10776+
"type": "integer",
10777+
"description": "`number` or `null`. The monthly lookup limit currently set on your key.\n`null` means the limit is currently disabled.",
10778+
"format": "int32"
10779+
},
10780+
"consumed": {
10781+
"minimum": 0,
10782+
"example": 2500,
10783+
"type": "integer",
10784+
"description": "Number of lookups performed this month which count towards your monthly limit.",
10785+
"format": "int32"
10786+
}
10787+
}
10788+
},
1075910789
"ApiKeyIndividualLimit": {
1076010790
"title": "API Key Individual Limit",
1076110791
"type": "object",
@@ -11055,6 +11085,7 @@
1105511085
"required": [
1105611086
"lookups_remaining",
1105711087
"daily_limit",
11088+
"monthly_limit",
1105811089
"individual_limit",
1105911090
"allowed_urls",
1106011091
"redact_days",
@@ -11074,6 +11105,9 @@
1107411105
"daily_limit": {
1107511106
"$ref": "#/components/schemas/ApiKeyDailyLimit"
1107611107
},
11108+
"monthly_limit": {
11109+
"$ref": "#/components/schemas/ApiKeyMonthlyLimit"
11110+
},
1107711111
"individual_limit": {
1107811112
"$ref": "#/components/schemas/ApiKeyIndividualLimit"
1107911113
},
@@ -11158,6 +11192,21 @@
1115811192
}
1115911193
}
1116011194
},
11195+
"monthly_limit": {
11196+
"title": "Monthly Rate Limit",
11197+
"type": "object",
11198+
"properties": {
11199+
"limit": {
11200+
"x-nullable": true,
11201+
"nullable": true,
11202+
"minimum": 0,
11203+
"example": 10000,
11204+
"type": "integer",
11205+
"description": "`number` or `null`. The monthly lookup limit currently set on your key.\n`null` means the limit is currently disabled.",
11206+
"format": "int32"
11207+
}
11208+
}
11209+
},
1116111210
"individual_limit": {
1116211211
"title": "API Key Individual Limit",
1116311212
"type": "object",

‎dist/openapi.yaml‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4164,6 +4164,8 @@ components:
41644164
title: Ireland ECAD Address
41654165
description: The ECAD contains additional data for each ECAF address.
41664166
required:
4167+
- dataset
4168+
- ecad_id
41674169
- organisation_id
41684170
- address_point_id
41694171
- building_id
@@ -4269,6 +4271,7 @@ components:
42694271
minLength: 1
42704272
post_county_id:
42714273
type: string
4274+
nullable: true
42724275
description: Post County ID
42734276
example: '10098783'
42744277
maxLength: 10
@@ -4461,6 +4464,7 @@ components:
44614464
title: Ireland ECAF Address
44624465
description: ECAF is the Eircode Address File which contains one record for each Postal Address. English language and Irish language versions are available. It is distributed as a flat file, details of data provision and updates are provided in section 2.
44634466
required:
4467+
- dataset
44644468
- ecaf_id
44654469
allOf:
44664470
- $ref: '#/components/schemas/EircBase'
@@ -10208,6 +10212,29 @@ components:
1020810212
type: integer
1020910213
description: Number of lookups performed today which count towards your daily limit.
1021010214
format: int32
10215+
ApiKeyMonthlyLimit:
10216+
title: API Key Monthly Limit
10217+
type: object
10218+
required:
10219+
- limit
10220+
- consumed
10221+
properties:
10222+
limit:
10223+
x-nullable: true
10224+
nullable: true
10225+
minimum: 0
10226+
example: 10000
10227+
type: integer
10228+
description: |-
10229+
`number` or `null`. The monthly lookup limit currently set on your key.
10230+
`null` means the limit is currently disabled.
10231+
format: int32
10232+
consumed:
10233+
minimum: 0
10234+
example: 2500
10235+
type: integer
10236+
description: Number of lookups performed this month which count towards your monthly limit.
10237+
format: int32
1021110238
ApiKeyIndividualLimit:
1021210239
title: API Key Individual Limit
1021310240
type: object
@@ -10458,6 +10485,7 @@ components:
1045810485
required:
1045910486
- lookups_remaining
1046010487
- daily_limit
10488+
- monthly_limit
1046110489
- individual_limit
1046210490
- allowed_urls
1046310491
- redact_days
@@ -10474,6 +10502,8 @@ components:
1047410502
format: int32
1047510503
daily_limit:
1047610504
$ref: '#/components/schemas/ApiKeyDailyLimit'
10505+
monthly_limit:
10506+
$ref: '#/components/schemas/ApiKeyMonthlyLimit'
1047710507
individual_limit:
1047810508
$ref: '#/components/schemas/ApiKeyIndividualLimit'
1047910509
allowed_urls:
@@ -10537,6 +10567,20 @@ components:
1053710567
`number` or `null`. The daily lookup limit currently set on your key.
1053810568
`null` means the limit is currently disabled.
1053910569
format: int32
10570+
monthly_limit:
10571+
title: Monthly Rate Limit
10572+
type: object
10573+
properties:
10574+
limit:
10575+
x-nullable: true
10576+
nullable: true
10577+
minimum: 0
10578+
example: 10000
10579+
type: integer
10580+
description: |-
10581+
`number` or `null`. The monthly lookup limit currently set on your key.
10582+
`null` means the limit is currently disabled.
10583+
format: int32
1054010584
individual_limit:
1054110585
title: API Key Individual Limit
1054210586
type: object

‎openapi.ts‎

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2141,7 +2141,7 @@ export interface components {
21412141
* @description Post County ID
21422142
* @example 10098783
21432143
*/
2144-
post_county_id?: string;
2144+
post_county_id?: string | null;
21452145
/**
21462146
* @description NUA means "non-unique address".
21472147
*
@@ -2297,6 +2297,8 @@ export interface components {
22972297
/** @description An Post publicity post zone information. */
22982298
publicity_post_zone?: string;
22992299
} & {
2300+
dataset: unknown;
2301+
ecad_id: unknown;
23002302
organisation_id: unknown;
23012303
address_point_id: unknown;
23022304
building_id: unknown;
@@ -2342,6 +2344,7 @@ export interface components {
23422344
/** @description The unique identifier in the ECAF is the `ecaf_id`. This unique identifier allows each address in the ECAF to be uniquely identified. It can also be used as index once the data has been imported into a relational database. This is a numeric field that can store values from 0 to 2,147,483,647. It is represented as a number up to 10 digits long. All other fields in ECAF are alphanumeric. */
23432345
ecaf_id?: string;
23442346
} & {
2347+
dataset: unknown;
23452348
ecaf_id: unknown;
23462349
};
23472350
/**
@@ -6414,6 +6417,22 @@ export interface components {
64146417
*/
64156418
consumed: number;
64166419
};
6420+
/** API Key Monthly Limit */
6421+
ApiKeyMonthlyLimit: {
6422+
/**
6423+
* Format: int32
6424+
* @description `number` or `null`. The monthly lookup limit currently set on your key.
6425+
* `null` means the limit is currently disabled.
6426+
* @example 10000
6427+
*/
6428+
limit: number | null;
6429+
/**
6430+
* Format: int32
6431+
* @description Number of lookups performed this month which count towards your monthly limit.
6432+
* @example 2500
6433+
*/
6434+
consumed: number;
6435+
};
64176436
/** API Key Individual Limit */
64186437
ApiKeyIndividualLimit: {
64196438
/**
@@ -6642,6 +6661,7 @@ export interface components {
66426661
*/
66436662
lookups_remaining: number;
66446663
daily_limit: components["schemas"]["ApiKeyDailyLimit"];
6664+
monthly_limit: components["schemas"]["ApiKeyMonthlyLimit"];
66456665
individual_limit: components["schemas"]["ApiKeyIndividualLimit"];
66466666
/** @description A list of allowed URLs. An empty list means that allowed URLs are disabled. */
66476667
allowed_urls: string[];
@@ -6684,6 +6704,16 @@ export interface components {
66846704
*/
66856705
limit?: number | null;
66866706
};
6707+
/** Monthly Rate Limit */
6708+
monthly_limit?: {
6709+
/**
6710+
* Format: int32
6711+
* @description `number` or `null`. The monthly lookup limit currently set on your key.
6712+
* `null` means the limit is currently disabled.
6713+
* @example 10000
6714+
*/
6715+
limit?: number | null;
6716+
};
66876717
/** API Key Individual Limit */
66886718
individual_limit?: {
66896719
/**

0 commit comments

Comments
 (0)