mirror of
https://github.com/koala73/worldmonitor.git
synced 2026-04-25 17:14:57 +02:00
363cf5e71c
* perf(api): convert classify-event to GET and add summarize-article cache endpoint for CDN caching classify-event (7.9M calls/wk) was POST — bypassing all CDN caching. Converting to GET with static cache tier (1hr) enables Cloudflare edge caching. Degraded responses (no API key, empty title, errors) are marked no-cache to prevent caching error states. summarize-article has repeated headlines too large for URL params. Added a new GetSummarizeArticleCache GET endpoint that looks up Redis by a deterministic cache key. Client computes key via shared buildSummaryCacheKey(), tries GET first (CDN-cacheable), falls back to existing POST on miss. Shared module ensures client/server key parity. * fix(types): wire missing DeductSituation and ListGulfQuotes RPCs, fix tsc errors - Added DeductSituation RPC to intelligence/v1/service.proto (messages existed, RPC declaration was missing) - Added ListGulfQuotes proto + RPC to market/v1/service.proto (handler existed, proto was missing) - Fixed scrapedAt type mismatch in conflict/index.ts (int64 → string) - Added @ts-nocheck to generated files with codegen type bugs - Regenerated all sebuf client/server code * fix(types): fix int64→string type mismatch in list-iran-events.ts
333 lines
13 KiB
YAML
333 lines
13 KiB
YAML
openapi: 3.1.0
|
|
info:
|
|
title: NewsService API
|
|
version: 1.0.0
|
|
paths:
|
|
/api/news/v1/summarize-article:
|
|
post:
|
|
tags:
|
|
- NewsService
|
|
summary: SummarizeArticle
|
|
description: SummarizeArticle generates an LLM summary with provider selection and fallback support.
|
|
operationId: SummarizeArticle
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/SummarizeArticleRequest'
|
|
required: true
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/SummarizeArticleResponse'
|
|
"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/news/v1/summarize-article-cache:
|
|
get:
|
|
tags:
|
|
- NewsService
|
|
summary: GetSummarizeArticleCache
|
|
description: GetSummarizeArticleCache looks up a cached summary by deterministic key (CDN-cacheable GET).
|
|
operationId: GetSummarizeArticleCache
|
|
parameters:
|
|
- name: cache_key
|
|
in: query
|
|
description: Deterministic cache key computed by buildSummaryCacheKey().
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/SummarizeArticleResponse'
|
|
"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/news/v1/list-feed-digest:
|
|
get:
|
|
tags:
|
|
- NewsService
|
|
summary: ListFeedDigest
|
|
description: ListFeedDigest returns a pre-aggregated digest of all RSS feeds for a site variant.
|
|
operationId: ListFeedDigest
|
|
parameters:
|
|
- name: variant
|
|
in: query
|
|
description: 'Site variant: full, tech, finance, happy'
|
|
required: false
|
|
schema:
|
|
type: string
|
|
- name: lang
|
|
in: query
|
|
description: ISO 639-1 language code (en, fr, ar, etc.)
|
|
required: false
|
|
schema:
|
|
type: string
|
|
responses:
|
|
"200":
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/ListFeedDigestResponse'
|
|
"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.
|
|
SummarizeArticleRequest:
|
|
type: object
|
|
properties:
|
|
provider:
|
|
type: string
|
|
minLength: 1
|
|
description: 'LLM provider: "ollama", "groq", "openrouter"'
|
|
headlines:
|
|
type: array
|
|
items:
|
|
type: string
|
|
minItems: 1
|
|
description: Headlines to summarize (max 8 used).
|
|
minItems: 1
|
|
mode:
|
|
type: string
|
|
description: 'Summarization mode: "brief", "analysis", "translate", "" (default).'
|
|
geoContext:
|
|
type: string
|
|
description: Geographic signal context to include in the prompt.
|
|
variant:
|
|
type: string
|
|
description: 'Variant: "full", "tech", or target language for translate mode.'
|
|
lang:
|
|
type: string
|
|
description: Output language code, default "en".
|
|
required:
|
|
- provider
|
|
description: SummarizeArticleRequest specifies parameters for LLM article summarization.
|
|
SummarizeArticleResponse:
|
|
type: object
|
|
properties:
|
|
summary:
|
|
type: string
|
|
description: The generated summary text.
|
|
model:
|
|
type: string
|
|
description: Model identifier used for generation.
|
|
provider:
|
|
type: string
|
|
description: Provider that produced the result (or "cache").
|
|
cached:
|
|
type: boolean
|
|
description: Whether the result came from Redis cache.
|
|
tokens:
|
|
type: integer
|
|
format: int32
|
|
description: Token count from the LLM response.
|
|
fallback:
|
|
type: boolean
|
|
description: Whether the client should try the next provider in the fallback chain.
|
|
skipped:
|
|
type: boolean
|
|
description: Whether this provider was skipped (credentials missing).
|
|
reason:
|
|
type: string
|
|
description: Human-readable skip/error reason.
|
|
error:
|
|
type: string
|
|
description: Error message if the request failed.
|
|
errorType:
|
|
type: string
|
|
description: Error type/name (e.g. "TypeError").
|
|
description: SummarizeArticleResponse contains the LLM summarization result.
|
|
GetSummarizeArticleCacheRequest:
|
|
type: object
|
|
properties:
|
|
cacheKey:
|
|
type: string
|
|
description: Deterministic cache key computed by buildSummaryCacheKey().
|
|
description: GetSummarizeArticleCacheRequest looks up a pre-computed summary by cache key.
|
|
ListFeedDigestRequest:
|
|
type: object
|
|
properties:
|
|
variant:
|
|
type: string
|
|
description: 'Site variant: full, tech, finance, happy'
|
|
lang:
|
|
type: string
|
|
description: ISO 639-1 language code (en, fr, ar, etc.)
|
|
ListFeedDigestResponse:
|
|
type: object
|
|
properties:
|
|
categories:
|
|
type: object
|
|
additionalProperties:
|
|
$ref: '#/components/schemas/CategoryBucket'
|
|
description: Per-category buckets — keys match category names from feed config
|
|
feedStatuses:
|
|
type: object
|
|
additionalProperties:
|
|
type: string
|
|
description: Per-feed status (ok/error/timeout)
|
|
generatedAt:
|
|
type: string
|
|
description: ISO 8601 timestamp of when this digest was generated
|
|
CategoriesEntry:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
value:
|
|
$ref: '#/components/schemas/CategoryBucket'
|
|
FeedStatusesEntry:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
value:
|
|
type: string
|
|
CategoryBucket:
|
|
type: object
|
|
properties:
|
|
items:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/NewsItem'
|
|
NewsItem:
|
|
type: object
|
|
properties:
|
|
source:
|
|
type: string
|
|
minLength: 1
|
|
description: Source feed name.
|
|
title:
|
|
type: string
|
|
minLength: 1
|
|
description: Article headline.
|
|
link:
|
|
type: string
|
|
description: Article URL.
|
|
publishedAt:
|
|
type: integer
|
|
format: int64
|
|
description: 'Publication time, as Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript'
|
|
isAlert:
|
|
type: boolean
|
|
description: Whether this article triggered an alert condition.
|
|
threat:
|
|
$ref: '#/components/schemas/ThreatClassification'
|
|
location:
|
|
$ref: '#/components/schemas/GeoCoordinates'
|
|
locationName:
|
|
type: string
|
|
description: Human-readable location name.
|
|
required:
|
|
- source
|
|
- title
|
|
description: NewsItem represents a single news article from RSS feed aggregation.
|
|
ThreatClassification:
|
|
type: object
|
|
properties:
|
|
level:
|
|
type: string
|
|
enum:
|
|
- THREAT_LEVEL_UNSPECIFIED
|
|
- THREAT_LEVEL_LOW
|
|
- THREAT_LEVEL_MEDIUM
|
|
- THREAT_LEVEL_HIGH
|
|
- THREAT_LEVEL_CRITICAL
|
|
description: ThreatLevel represents the assessed threat level of a news event.
|
|
category:
|
|
type: string
|
|
description: Event category.
|
|
confidence:
|
|
type: number
|
|
maximum: 1
|
|
minimum: 0
|
|
format: double
|
|
description: Confidence score (0.0 to 1.0).
|
|
source:
|
|
type: string
|
|
description: Classification source — "keyword", "ml", or "llm".
|
|
description: ThreatClassification represents an AI-assessed threat level for a news item.
|
|
GeoCoordinates:
|
|
type: object
|
|
properties:
|
|
latitude:
|
|
type: number
|
|
maximum: 90
|
|
minimum: -90
|
|
format: double
|
|
description: Latitude in decimal degrees (-90 to 90).
|
|
longitude:
|
|
type: number
|
|
maximum: 180
|
|
minimum: -180
|
|
format: double
|
|
description: Longitude in decimal degrees (-180 to 180).
|
|
description: GeoCoordinates represents a geographic location using WGS84 coordinates.
|