mirror of
https://github.com/koala73/worldmonitor.git
synced 2026-04-26 01:24:59 +02:00
3321069fb3
* feat(sanctions): entity lookup index + OpenSanctions search (#2042) * fix: guard tokens[0] access in sanctions lookup * fix: use createIpRateLimiter pattern in sanctions-entity-search * fix: add sanctions-entity-search to allowlist and cache tier * fix: add LookupSanctionEntity RPC to service.proto, regenerate * fix(sanctions): strip _entityIndex/_state from main key publish, guard limit NaN P0: seed-sanctions-pressure was writing the full _entityIndex array and _state snapshot into sanctions:pressure:v1 because afterPublish runs after atomicPublish. Add publishTransform to strip both fields before the main key write so the pressure payload stays compact; afterPublish and extraKeys still receive the full data object and write the correct separate keys. P1: limit param in sanctions-entity-search edge function passed NaN to OpenSanctions when a non-numeric value was supplied. Fix with Number.isFinite guard. P2: add 200-char max length on q param to prevent oversized upstream requests. * fix(sanctions): maxStaleMin 2x interval, no-store on entity search health.js: 720min (1x) → 1440min (2x) for both sanctionsPressure and sanctionsEntities. A single missed 12h cron was immediately flagging stale. sanctions-entity-search.js: Cache-Control public → no-store. Sanctions lookups include compliance-sensitive names in the query string; public caching would have logged/stored these at CDN/proxy layer.
269 lines
10 KiB
YAML
269 lines
10 KiB
YAML
openapi: 3.1.0
|
|
info:
|
|
title: SanctionsService API
|
|
version: 1.0.0
|
|
paths:
|
|
/api/sanctions/v1/list-sanctions-pressure:
|
|
get:
|
|
tags:
|
|
- SanctionsService
|
|
summary: ListSanctionsPressure
|
|
description: ListSanctionsPressure retrieves normalized OFAC designation summaries and recent additions.
|
|
operationId: ListSanctionsPressure
|
|
parameters:
|
|
- name: max_items
|
|
in: query
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
format: int32
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListSanctionsPressureResponse'
|
|
"400":
|
|
description: Validation error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ValidationError'
|
|
default:
|
|
description: Error response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
/api/sanctions/v1/lookup-sanction-entity:
|
|
get:
|
|
tags:
|
|
- SanctionsService
|
|
summary: LookupSanctionEntity
|
|
description: LookupSanctionEntity searches the OFAC entity index by name, vessel, or aircraft.
|
|
operationId: LookupSanctionEntity
|
|
parameters:
|
|
- name: q
|
|
in: query
|
|
required: false
|
|
schema:
|
|
type: string
|
|
- name: max_results
|
|
in: query
|
|
required: false
|
|
schema:
|
|
type: integer
|
|
format: int32
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/LookupSanctionEntityResponse'
|
|
"400":
|
|
description: Validation error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ValidationError'
|
|
default:
|
|
description: Error response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
components:
|
|
schemas:
|
|
Error:
|
|
type: object
|
|
properties:
|
|
message:
|
|
type: string
|
|
description: Error message (e.g., 'user not found', 'database connection failed')
|
|
description: Error is returned when a handler encounters an error. It contains a simple error message that the developer can customize.
|
|
FieldViolation:
|
|
type: object
|
|
properties:
|
|
field:
|
|
type: string
|
|
description: The field path that failed validation (e.g., 'user.email' for nested fields). For header validation, this will be the header name (e.g., 'X-API-Key')
|
|
description:
|
|
type: string
|
|
description: Human-readable description of the validation violation (e.g., 'must be a valid email address', 'required field missing')
|
|
required:
|
|
- field
|
|
- description
|
|
description: FieldViolation describes a single validation error for a specific field.
|
|
ValidationError:
|
|
type: object
|
|
properties:
|
|
violations:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/FieldViolation'
|
|
description: List of validation violations
|
|
required:
|
|
- violations
|
|
description: ValidationError is returned when request validation fails. It contains a list of field violations describing what went wrong.
|
|
ListSanctionsPressureRequest:
|
|
type: object
|
|
properties:
|
|
maxItems:
|
|
type: integer
|
|
format: int32
|
|
description: ListSanctionsPressureRequest retrieves recent OFAC sanctions pressure state.
|
|
ListSanctionsPressureResponse:
|
|
type: object
|
|
properties:
|
|
entries:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/SanctionsEntry'
|
|
countries:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/CountrySanctionsPressure'
|
|
programs:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ProgramSanctionsPressure'
|
|
fetchedAt:
|
|
type: string
|
|
format: int64
|
|
datasetDate:
|
|
type: string
|
|
format: int64
|
|
totalCount:
|
|
type: integer
|
|
format: int32
|
|
sdnCount:
|
|
type: integer
|
|
format: int32
|
|
consolidatedCount:
|
|
type: integer
|
|
format: int32
|
|
newEntryCount:
|
|
type: integer
|
|
format: int32
|
|
vesselCount:
|
|
type: integer
|
|
format: int32
|
|
aircraftCount:
|
|
type: integer
|
|
format: int32
|
|
description: ListSanctionsPressureResponse contains normalized OFAC pressure summaries and recent entries.
|
|
SanctionsEntry:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
name:
|
|
type: string
|
|
entityType:
|
|
type: string
|
|
enum:
|
|
- SANCTIONS_ENTITY_TYPE_UNSPECIFIED
|
|
- SANCTIONS_ENTITY_TYPE_ENTITY
|
|
- SANCTIONS_ENTITY_TYPE_INDIVIDUAL
|
|
- SANCTIONS_ENTITY_TYPE_VESSEL
|
|
- SANCTIONS_ENTITY_TYPE_AIRCRAFT
|
|
description: SanctionsEntityType classifies the designated party.
|
|
countryCodes:
|
|
type: array
|
|
items:
|
|
type: string
|
|
countryNames:
|
|
type: array
|
|
items:
|
|
type: string
|
|
programs:
|
|
type: array
|
|
items:
|
|
type: string
|
|
sourceLists:
|
|
type: array
|
|
items:
|
|
type: string
|
|
effectiveAt:
|
|
type: string
|
|
format: int64
|
|
isNew:
|
|
type: boolean
|
|
note:
|
|
type: string
|
|
description: SanctionsEntry is a normalized OFAC sanctions designation.
|
|
CountrySanctionsPressure:
|
|
type: object
|
|
properties:
|
|
countryCode:
|
|
type: string
|
|
countryName:
|
|
type: string
|
|
entryCount:
|
|
type: integer
|
|
format: int32
|
|
newEntryCount:
|
|
type: integer
|
|
format: int32
|
|
vesselCount:
|
|
type: integer
|
|
format: int32
|
|
aircraftCount:
|
|
type: integer
|
|
format: int32
|
|
description: CountrySanctionsPressure summarizes designation volume and recent additions by country.
|
|
ProgramSanctionsPressure:
|
|
type: object
|
|
properties:
|
|
program:
|
|
type: string
|
|
entryCount:
|
|
type: integer
|
|
format: int32
|
|
newEntryCount:
|
|
type: integer
|
|
format: int32
|
|
description: ProgramSanctionsPressure summarizes designation volume and recent additions by OFAC program.
|
|
LookupSanctionEntityRequest:
|
|
type: object
|
|
properties:
|
|
q:
|
|
type: string
|
|
maxResults:
|
|
type: integer
|
|
format: int32
|
|
description: LookupSanctionEntityRequest searches the OFAC entity index by name, vessel, or aircraft.
|
|
LookupSanctionEntityResponse:
|
|
type: object
|
|
properties:
|
|
results:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/SanctionEntityMatch'
|
|
total:
|
|
type: integer
|
|
format: int32
|
|
source:
|
|
type: string
|
|
description: LookupSanctionEntityResponse contains matched entities from OFAC + OpenSanctions.
|
|
SanctionEntityMatch:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
name:
|
|
type: string
|
|
entityType:
|
|
type: string
|
|
countryCodes:
|
|
type: array
|
|
items:
|
|
type: string
|
|
programs:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: SanctionEntityMatch is a compact entity match from the lookup index.
|