Files
worldmonitor/docs/api/NaturalService.openapi.yaml
Elie Habib 4de2f74210 feat: move EONET/GDACS to server-side with Redis caching (#983)
* feat: move EONET/GDACS to server-side with Redis caching and bootstrap hydration

Browser-direct fetches to eonet.gsfc.nasa.gov and gdacs.org caused CORS
errors and had no server-side caching. This moves both to the standard
Vercel edge → cachedFetchJson → Redis → bootstrap hydration pattern.

- Add proto definitions for NaturalService with ListNaturalEvents RPC
- Create server handler merging EONET + GDACS with 30min Redis TTL
- Add Vercel edge function at /api/natural/v1/list-natural-events
- Register naturalEvents in bootstrap SLOW_KEYS for CDN hydration
- Replace browser-direct fetches with RPC client + circuit breaker
- Delete src/services/gdacs.ts (logic moved server-side)

* fix: restore @ts-nocheck on generated files stripped by buf generate
2026-03-04 15:02:03 +04:00

118 lines
4.2 KiB
YAML

openapi: 3.1.0
info:
title: NaturalService API
version: 1.0.0
paths:
/api/natural/v1/list-natural-events:
get:
tags:
- NaturalService
summary: ListNaturalEvents
operationId: ListNaturalEvents
parameters:
- name: days
in: query
required: false
schema:
type: integer
format: int32
responses:
"200":
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/ListNaturalEventsResponse'
"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.
ListNaturalEventsRequest:
type: object
properties:
days:
type: integer
format: int32
ListNaturalEventsResponse:
type: object
properties:
events:
type: array
items:
$ref: '#/components/schemas/NaturalEvent'
NaturalEvent:
type: object
properties:
id:
type: string
title:
type: string
description:
type: string
category:
type: string
categoryTitle:
type: string
lat:
type: number
format: double
lon:
type: number
format: double
date:
type: integer
format: int64
description: 'Warning: Values > 2^53 may lose precision in JavaScript'
magnitude:
type: number
format: double
magnitudeUnit:
type: string
sourceUrl:
type: string
sourceName:
type: string
closed:
type: boolean