mirror of
https://github.com/koala73/worldmonitor.git
synced 2026-04-25 17:14:57 +02:00
fcbb8bc0a1
* feat(proto): generate unified worldmonitor.openapi.yaml bundle Adds a third protoc-gen-openapiv3 invocation that merges every service into a single docs/api/worldmonitor.openapi.yaml spanning all 68 RPCs, using the new bundle support shipped in sebuf 0.11.0 (SebastienMelki/sebuf#158). Per-service YAML/JSON files are untouched and continue to back the Mintlify docs in docs/docs.json. The bundle runs with strategy: all and bundle_only=true so only the aggregate file is emitted, avoiding duplicate-output conflicts with the existing per-service generator. Requires protoc-gen-openapiv3 >= v0.11.0 locally: go install github.com/SebastienMelki/sebuf/cmd/protoc-gen-openapiv3@v0.11.0 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs(proto): bump sebuf to v0.11.0 and document unified OpenAPI bundle - Makefile: SEBUF_VERSION v0.7.0 → v0.11.0 (required for bundle support). - proto/buf.gen.yaml: point bundle_server at https://api.worldmonitor.app. - CONTRIBUTING.md: new "OpenAPI Output" section covering per-service specs vs the unified worldmonitor.openapi.yaml bundle, plus a note that all three sebuf plugins must be installed from the pinned version. - AGENTS.md: clarify that `make generate` also produces the unified spec and requires sebuf v0.11.0. - CHANGELOG.md: Unreleased entry announcing the bundle and version bump. Also regenerates the bundle with the updated server URL. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * chore(codegen): regenerate TS client/server with sebuf v0.11.0 Mechanical output of the bumped protoc-gen-ts-client and protoc-gen-ts-server. Two behavioral improvements roll in from sebuf: - Proto enum fields now use the proper `*_UNSPECIFIED` sentinel in default-value checks instead of the empty string, so generated query-string serializers correctly omit enum params only when they actually equal the proto default. - `repeated string` query params now serialize via `forEach(v => params.append(...))` instead of being coerced through `String(req.field)`, matching the existing `parseStringArray()` contract on the server side. All files also drop the `// @ts-nocheck` header that earlier sebuf versions emitted — 0.11.0 output type-checks cleanly under our tsconfig. No hand edits. Reproduce with `make install-plugins && make generate`. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * fix(proto): bump sebuf v0.11.0 → v0.11.1, realign tests with repeated-param wire format - Bump SEBUF_VERSION to v0.11.1, pulling in the OpenAPI fix for repeated scalar query params (SebastienMelki/sebuf#161). `repeated string` fields now emit `type: array` + `items.type: string` + `style: form` + `explode: true` instead of `type: string`, so SDK generators consuming the unified bundle produce correct array clients. - Regenerate all 12 OpenAPI specs (unified bundle + Aviation, Economic, Infrastructure, Market, Trade per-service). TS client/server codegen is byte-identical to v0.11.0 — only the OpenAPI emitter was out of sync. - Update three tests that asserted the pre-v0.11 comma-joined wire format (`symbols=AAPL,MSFT`) to match the current repeated-param form (`symbols=AAPL&symbols=MSFT`) produced by `params.append(...)`: - tests/market-service-symbol-casing.test.mjs (2 cases: getAll) - tests/stock-analysis-history.test.mts - tests/stock-backtest.test.mts Locally: test:data 6619/6619 pass, typecheck clean, lint exit 0. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * Apply suggestions from code review Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
999 lines
41 KiB
YAML
999 lines
41 KiB
YAML
openapi: 3.1.0
|
||
info:
|
||
title: InfrastructureService API
|
||
version: 1.0.0
|
||
paths:
|
||
/api/infrastructure/v1/list-internet-outages:
|
||
get:
|
||
tags:
|
||
- InfrastructureService
|
||
summary: ListInternetOutages
|
||
description: ListInternetOutages retrieves detected internet outages from Cloudflare Radar.
|
||
operationId: ListInternetOutages
|
||
parameters:
|
||
- name: start
|
||
in: query
|
||
description: Start of time range (inclusive), Unix epoch milliseconds.
|
||
required: false
|
||
schema:
|
||
type: string
|
||
format: int64
|
||
- name: end
|
||
in: query
|
||
description: End of time range (inclusive), Unix epoch milliseconds.
|
||
required: false
|
||
schema:
|
||
type: string
|
||
format: int64
|
||
- name: page_size
|
||
in: query
|
||
description: Maximum items per page.
|
||
required: false
|
||
schema:
|
||
type: integer
|
||
format: int32
|
||
- name: cursor
|
||
in: query
|
||
description: Cursor for next page.
|
||
required: false
|
||
schema:
|
||
type: string
|
||
- name: country
|
||
in: query
|
||
description: Optional country filter (ISO 3166-1 alpha-2).
|
||
required: false
|
||
schema:
|
||
type: string
|
||
responses:
|
||
"200":
|
||
description: Successful response
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: '#/components/schemas/ListInternetOutagesResponse'
|
||
"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/infrastructure/v1/list-service-statuses:
|
||
get:
|
||
tags:
|
||
- InfrastructureService
|
||
summary: ListServiceStatuses
|
||
description: ListServiceStatuses retrieves operational status of monitored external services.
|
||
operationId: ListServiceStatuses
|
||
parameters:
|
||
- name: status
|
||
in: query
|
||
description: Optional status filter. Returns only services in this state.
|
||
required: false
|
||
schema:
|
||
type: string
|
||
responses:
|
||
"200":
|
||
description: Successful response
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: '#/components/schemas/ListServiceStatusesResponse'
|
||
"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/infrastructure/v1/get-temporal-baseline:
|
||
get:
|
||
tags:
|
||
- InfrastructureService
|
||
summary: GetTemporalBaseline
|
||
description: GetTemporalBaseline retrieves historical baseline data for a specific signal.
|
||
operationId: GetTemporalBaseline
|
||
parameters:
|
||
- name: type
|
||
in: query
|
||
description: 'Activity type: "military_flights", "vessels", "protests", "news", "ais_gaps", "satellite_fires".'
|
||
required: false
|
||
schema:
|
||
type: string
|
||
- name: region
|
||
in: query
|
||
description: Geographic region key, defaults to "global".
|
||
required: false
|
||
schema:
|
||
type: string
|
||
- name: count
|
||
in: query
|
||
description: Current observed count to compare against baseline.
|
||
required: false
|
||
schema:
|
||
type: number
|
||
format: double
|
||
responses:
|
||
"200":
|
||
description: Successful response
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: '#/components/schemas/GetTemporalBaselineResponse'
|
||
"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/infrastructure/v1/get-ip-geo:
|
||
get:
|
||
tags:
|
||
- InfrastructureService
|
||
summary: GetIpGeo
|
||
description: GetIpGeo retrieves geographic information based on the caller's IP address.
|
||
operationId: GetIpGeo
|
||
responses:
|
||
"200":
|
||
description: Successful response
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: '#/components/schemas/GetIpGeoResponse'
|
||
"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/infrastructure/v1/reverse-geocode:
|
||
get:
|
||
tags:
|
||
- InfrastructureService
|
||
summary: ReverseGeocode
|
||
description: ReverseGeocode resolves geographic coordinates to a postal address/country.
|
||
operationId: ReverseGeocode
|
||
parameters:
|
||
- name: lat
|
||
in: query
|
||
required: false
|
||
schema:
|
||
type: number
|
||
format: double
|
||
- name: lon
|
||
in: query
|
||
required: false
|
||
schema:
|
||
type: number
|
||
format: double
|
||
responses:
|
||
"200":
|
||
description: Successful response
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: '#/components/schemas/ReverseGeocodeResponse'
|
||
"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/infrastructure/v1/get-bootstrap-data:
|
||
get:
|
||
tags:
|
||
- InfrastructureService
|
||
summary: GetBootstrapData
|
||
description: GetBootstrapData fetches multiple data points from the system cache in a single call.
|
||
operationId: GetBootstrapData
|
||
parameters:
|
||
- name: tier
|
||
in: query
|
||
description: Predefined tiers or specific keys.
|
||
required: false
|
||
schema:
|
||
type: string
|
||
- name: keys
|
||
in: query
|
||
required: false
|
||
style: form
|
||
explode: true
|
||
schema:
|
||
type: array
|
||
items:
|
||
type: string
|
||
responses:
|
||
"200":
|
||
description: Successful response
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: '#/components/schemas/GetBootstrapDataResponse'
|
||
"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/infrastructure/v1/record-baseline-snapshot:
|
||
post:
|
||
tags:
|
||
- InfrastructureService
|
||
summary: RecordBaselineSnapshot
|
||
description: RecordBaselineSnapshot batch-updates baseline statistics using Welford's online algorithm.
|
||
operationId: RecordBaselineSnapshot
|
||
requestBody:
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: '#/components/schemas/RecordBaselineSnapshotRequest'
|
||
required: true
|
||
responses:
|
||
"200":
|
||
description: Successful response
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: '#/components/schemas/RecordBaselineSnapshotResponse'
|
||
"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/infrastructure/v1/get-cable-health:
|
||
get:
|
||
tags:
|
||
- InfrastructureService
|
||
summary: GetCableHealth
|
||
description: GetCableHealth computes health status for submarine cables from NGA maritime warning signals.
|
||
operationId: GetCableHealth
|
||
responses:
|
||
"200":
|
||
description: Successful response
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: '#/components/schemas/GetCableHealthResponse'
|
||
"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/infrastructure/v1/list-temporal-anomalies:
|
||
get:
|
||
tags:
|
||
- InfrastructureService
|
||
summary: ListTemporalAnomalies
|
||
description: ListTemporalAnomalies returns server-computed temporal anomalies for news and satellite_fires.
|
||
operationId: ListTemporalAnomalies
|
||
responses:
|
||
"200":
|
||
description: Successful response
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: '#/components/schemas/ListTemporalAnomaliesResponse'
|
||
"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/infrastructure/v1/list-internet-ddos-attacks:
|
||
get:
|
||
tags:
|
||
- InfrastructureService
|
||
summary: ListInternetDdosAttacks
|
||
description: ListInternetDdosAttacks retrieves L3/L4 DDoS attack summaries from Cloudflare Radar.
|
||
operationId: ListInternetDdosAttacks
|
||
responses:
|
||
"200":
|
||
description: Successful response
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: '#/components/schemas/ListInternetDdosAttacksResponse'
|
||
"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/infrastructure/v1/list-internet-traffic-anomalies:
|
||
get:
|
||
tags:
|
||
- InfrastructureService
|
||
summary: ListInternetTrafficAnomalies
|
||
description: ListInternetTrafficAnomalies retrieves traffic anomaly events from Cloudflare Radar.
|
||
operationId: ListInternetTrafficAnomalies
|
||
parameters:
|
||
- name: country
|
||
in: query
|
||
description: Optional ISO 3166-1 alpha-2 country code filter.
|
||
required: false
|
||
schema:
|
||
type: string
|
||
responses:
|
||
"200":
|
||
description: Successful response
|
||
content:
|
||
application/json:
|
||
schema:
|
||
$ref: '#/components/schemas/ListInternetTrafficAnomaliesResponse'
|
||
"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.
|
||
ListInternetOutagesRequest:
|
||
type: object
|
||
properties:
|
||
start:
|
||
type: integer
|
||
format: int64
|
||
description: 'Start of time range (inclusive), Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript'
|
||
end:
|
||
type: integer
|
||
format: int64
|
||
description: 'End of time range (inclusive), Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript'
|
||
pageSize:
|
||
type: integer
|
||
format: int32
|
||
description: Maximum items per page.
|
||
cursor:
|
||
type: string
|
||
description: Cursor for next page.
|
||
country:
|
||
type: string
|
||
description: Optional country filter (ISO 3166-1 alpha-2).
|
||
description: ListInternetOutagesRequest specifies filters for retrieving internet outages.
|
||
ListInternetOutagesResponse:
|
||
type: object
|
||
properties:
|
||
outages:
|
||
type: array
|
||
items:
|
||
$ref: '#/components/schemas/InternetOutage'
|
||
pagination:
|
||
$ref: '#/components/schemas/PaginationResponse'
|
||
description: ListInternetOutagesResponse contains internet outages matching the request.
|
||
InternetOutage:
|
||
type: object
|
||
properties:
|
||
id:
|
||
type: string
|
||
minLength: 1
|
||
description: Unique outage identifier.
|
||
title:
|
||
type: string
|
||
description: Outage title.
|
||
link:
|
||
type: string
|
||
description: URL to the outage report.
|
||
description:
|
||
type: string
|
||
description: Outage description.
|
||
detectedAt:
|
||
type: integer
|
||
format: int64
|
||
description: 'Detection time, as Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript'
|
||
country:
|
||
type: string
|
||
description: Affected country (ISO 3166-1 alpha-2).
|
||
region:
|
||
type: string
|
||
description: Affected region within the country.
|
||
location:
|
||
$ref: '#/components/schemas/GeoCoordinates'
|
||
severity:
|
||
type: string
|
||
enum:
|
||
- OUTAGE_SEVERITY_UNSPECIFIED
|
||
- OUTAGE_SEVERITY_PARTIAL
|
||
- OUTAGE_SEVERITY_MAJOR
|
||
- OUTAGE_SEVERITY_TOTAL
|
||
description: |-
|
||
OutageSeverity represents the severity of an internet outage.
|
||
Maps to TS union: 'partial' | 'major' | 'total'.
|
||
categories:
|
||
type: array
|
||
items:
|
||
type: string
|
||
description: Affected infrastructure categories.
|
||
cause:
|
||
type: string
|
||
description: Root cause, if determined.
|
||
outageType:
|
||
type: string
|
||
description: Outage type classification.
|
||
endedAt:
|
||
type: integer
|
||
format: int64
|
||
description: 'End time of the outage, as Unix epoch milliseconds. Zero if ongoing.. Warning: Values > 2^53 may lose precision in JavaScript'
|
||
required:
|
||
- id
|
||
description: InternetOutage represents a detected internet outage event from Cloudflare Radar.
|
||
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.
|
||
PaginationResponse:
|
||
type: object
|
||
properties:
|
||
nextCursor:
|
||
type: string
|
||
description: Cursor for fetching the next page. Empty string indicates no more pages.
|
||
totalCount:
|
||
type: integer
|
||
format: int32
|
||
description: Total count of items matching the query, if known. Zero if the total is unknown.
|
||
description: PaginationResponse contains pagination metadata returned alongside list results.
|
||
ListServiceStatusesRequest:
|
||
type: object
|
||
properties:
|
||
status:
|
||
type: string
|
||
enum:
|
||
- SERVICE_OPERATIONAL_STATUS_UNSPECIFIED
|
||
- SERVICE_OPERATIONAL_STATUS_OPERATIONAL
|
||
- SERVICE_OPERATIONAL_STATUS_DEGRADED
|
||
- SERVICE_OPERATIONAL_STATUS_PARTIAL_OUTAGE
|
||
- SERVICE_OPERATIONAL_STATUS_MAJOR_OUTAGE
|
||
- SERVICE_OPERATIONAL_STATUS_MAINTENANCE
|
||
description: ServiceOperationalStatus represents the current status of a service.
|
||
description: ListServiceStatusesRequest specifies filters for retrieving service statuses.
|
||
ListServiceStatusesResponse:
|
||
type: object
|
||
properties:
|
||
statuses:
|
||
type: array
|
||
items:
|
||
$ref: '#/components/schemas/ServiceStatus'
|
||
description: ListServiceStatusesResponse contains service operational statuses.
|
||
ServiceStatus:
|
||
type: object
|
||
properties:
|
||
id:
|
||
type: string
|
||
description: Service identifier.
|
||
name:
|
||
type: string
|
||
description: Service display name.
|
||
status:
|
||
type: string
|
||
enum:
|
||
- SERVICE_OPERATIONAL_STATUS_UNSPECIFIED
|
||
- SERVICE_OPERATIONAL_STATUS_OPERATIONAL
|
||
- SERVICE_OPERATIONAL_STATUS_DEGRADED
|
||
- SERVICE_OPERATIONAL_STATUS_PARTIAL_OUTAGE
|
||
- SERVICE_OPERATIONAL_STATUS_MAJOR_OUTAGE
|
||
- SERVICE_OPERATIONAL_STATUS_MAINTENANCE
|
||
description: ServiceOperationalStatus represents the current status of a service.
|
||
description:
|
||
type: string
|
||
description: Status description.
|
||
url:
|
||
type: string
|
||
description: Service URL or homepage.
|
||
checkedAt:
|
||
type: integer
|
||
format: int64
|
||
description: 'Last status check time, as Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript'
|
||
latencyMs:
|
||
type: integer
|
||
format: int32
|
||
description: Response latency in milliseconds.
|
||
description: ServiceStatus represents the operational status of a monitored external service.
|
||
GetTemporalBaselineRequest:
|
||
type: object
|
||
properties:
|
||
type:
|
||
type: string
|
||
minLength: 1
|
||
description: 'Activity type: "military_flights", "vessels", "protests", "news", "ais_gaps", "satellite_fires".'
|
||
region:
|
||
type: string
|
||
description: Geographic region key, defaults to "global".
|
||
count:
|
||
type: number
|
||
format: double
|
||
description: Current observed count to compare against baseline.
|
||
required:
|
||
- type
|
||
description: GetTemporalBaselineRequest checks current activity count against stored baseline.
|
||
GetTemporalBaselineResponse:
|
||
type: object
|
||
properties:
|
||
anomaly:
|
||
$ref: '#/components/schemas/BaselineAnomaly'
|
||
baseline:
|
||
$ref: '#/components/schemas/BaselineStats'
|
||
learning:
|
||
type: boolean
|
||
description: True if insufficient samples have been collected.
|
||
sampleCount:
|
||
type: integer
|
||
format: int32
|
||
description: Current number of samples stored.
|
||
samplesNeeded:
|
||
type: integer
|
||
format: int32
|
||
description: Minimum samples required before anomaly detection activates.
|
||
error:
|
||
type: string
|
||
description: Error message if request was invalid.
|
||
description: GetTemporalBaselineResponse returns anomaly info or learning status.
|
||
BaselineAnomaly:
|
||
type: object
|
||
properties:
|
||
zScore:
|
||
type: number
|
||
format: double
|
||
description: Number of standard deviations from the mean.
|
||
severity:
|
||
type: string
|
||
description: 'Severity label: "critical", "high", "medium", "normal".'
|
||
multiplier:
|
||
type: number
|
||
format: double
|
||
description: Ratio of current count to baseline mean.
|
||
description: BaselineAnomaly describes a detected deviation from historical baseline.
|
||
BaselineStats:
|
||
type: object
|
||
properties:
|
||
mean:
|
||
type: number
|
||
format: double
|
||
description: Running mean of observed counts.
|
||
stdDev:
|
||
type: number
|
||
format: double
|
||
description: Standard deviation derived from Welford's M2.
|
||
sampleCount:
|
||
type: integer
|
||
format: int32
|
||
description: Number of samples incorporated so far.
|
||
description: BaselineStats contains the running statistics for a baseline key.
|
||
GetIpGeoRequest:
|
||
type: object
|
||
description: GetIpGeoRequest defined for future parameters (e.g., specific IP).
|
||
GetIpGeoResponse:
|
||
type: object
|
||
properties:
|
||
country:
|
||
type: string
|
||
description: ISO 3166-1 alpha-2 country code.
|
||
region:
|
||
type: string
|
||
description: Region or city (if available).
|
||
city:
|
||
type: string
|
||
description: GetIpGeoResponse contains geographic information derived from the request IP.
|
||
ReverseGeocodeRequest:
|
||
type: object
|
||
properties:
|
||
lat:
|
||
type: number
|
||
format: double
|
||
lon:
|
||
type: number
|
||
format: double
|
||
description: ReverseGeocodeRequest parameters for coordinate-to-address lookups.
|
||
ReverseGeocodeResponse:
|
||
type: object
|
||
properties:
|
||
country:
|
||
type: string
|
||
description: Human-readable country name.
|
||
code:
|
||
type: string
|
||
description: ISO country code.
|
||
displayName:
|
||
type: string
|
||
description: Full display name/address.
|
||
error:
|
||
type: string
|
||
description: Optional error message.
|
||
description: ReverseGeocodeResponse containing the resolved location details.
|
||
GetBootstrapDataRequest:
|
||
type: object
|
||
properties:
|
||
tier:
|
||
type: string
|
||
description: Predefined tiers or specific keys.
|
||
keys:
|
||
type: array
|
||
items:
|
||
type: string
|
||
description: GetBootstrapDataRequest parameters for multi-key fetching.
|
||
GetBootstrapDataResponse:
|
||
type: object
|
||
properties:
|
||
data:
|
||
type: object
|
||
additionalProperties:
|
||
type: string
|
||
description: Map of keys to JSON-encoded data strings.
|
||
missing:
|
||
type: array
|
||
items:
|
||
type: string
|
||
description: List of keys that were not found in cache.
|
||
description: GetBootstrapDataResponse containing pooled data objects.
|
||
DataEntry:
|
||
type: object
|
||
properties:
|
||
key:
|
||
type: string
|
||
value:
|
||
type: string
|
||
RecordBaselineSnapshotRequest:
|
||
type: object
|
||
properties:
|
||
updates:
|
||
type: array
|
||
items:
|
||
$ref: '#/components/schemas/BaselineUpdate'
|
||
description: RecordBaselineSnapshotRequest batch-updates baselines using Welford's online algorithm.
|
||
BaselineUpdate:
|
||
type: object
|
||
properties:
|
||
type:
|
||
type: string
|
||
minLength: 1
|
||
description: Activity type key.
|
||
region:
|
||
type: string
|
||
description: Geographic region key, defaults to "global".
|
||
count:
|
||
type: number
|
||
format: double
|
||
description: Observed count value.
|
||
required:
|
||
- type
|
||
description: BaselineUpdate is a single metric observation to incorporate into the running baseline.
|
||
RecordBaselineSnapshotResponse:
|
||
type: object
|
||
properties:
|
||
updated:
|
||
type: integer
|
||
format: int32
|
||
description: Number of baselines that were written.
|
||
error:
|
||
type: string
|
||
description: Error message if the request was invalid.
|
||
description: RecordBaselineSnapshotResponse reports how many baselines were successfully updated.
|
||
GetCableHealthRequest:
|
||
type: object
|
||
description: GetCableHealthRequest requests the current health status of all monitored submarine cables.
|
||
GetCableHealthResponse:
|
||
type: object
|
||
properties:
|
||
generatedAt:
|
||
type: integer
|
||
format: int64
|
||
description: 'Generation timestamp, as Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript'
|
||
cables:
|
||
type: object
|
||
additionalProperties:
|
||
$ref: '#/components/schemas/CableHealthRecord'
|
||
description: Health records keyed by cable identifier.
|
||
description: GetCableHealthResponse contains health status for submarine cables with active signals.
|
||
CablesEntry:
|
||
type: object
|
||
properties:
|
||
key:
|
||
type: string
|
||
value:
|
||
$ref: '#/components/schemas/CableHealthRecord'
|
||
CableHealthRecord:
|
||
type: object
|
||
properties:
|
||
status:
|
||
type: string
|
||
enum:
|
||
- CABLE_HEALTH_STATUS_UNSPECIFIED
|
||
- CABLE_HEALTH_STATUS_OK
|
||
- CABLE_HEALTH_STATUS_DEGRADED
|
||
- CABLE_HEALTH_STATUS_FAULT
|
||
description: CableHealthStatus represents the computed health status of a submarine cable.
|
||
score:
|
||
type: number
|
||
format: double
|
||
description: Composite health score (0.0 = healthy, 1.0 = confirmed fault).
|
||
confidence:
|
||
type: number
|
||
format: double
|
||
description: Confidence in the health assessment (0.0–1.0).
|
||
lastUpdated:
|
||
type: integer
|
||
format: int64
|
||
description: 'Last signal update time, as Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript'
|
||
evidence:
|
||
type: array
|
||
items:
|
||
$ref: '#/components/schemas/CableHealthEvidence'
|
||
description: CableHealthRecord contains the computed health status and supporting evidence for a cable.
|
||
CableHealthEvidence:
|
||
type: object
|
||
properties:
|
||
source:
|
||
type: string
|
||
description: Evidence source (e.g. "NGA").
|
||
summary:
|
||
type: string
|
||
description: Human-readable summary of the evidence.
|
||
ts:
|
||
type: integer
|
||
format: int64
|
||
description: 'Evidence timestamp, as Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript'
|
||
description: CableHealthEvidence represents a single piece of evidence supporting a health assessment.
|
||
ListTemporalAnomaliesRequest:
|
||
type: object
|
||
ListTemporalAnomaliesResponse:
|
||
type: object
|
||
properties:
|
||
anomalies:
|
||
type: array
|
||
items:
|
||
$ref: '#/components/schemas/TemporalAnomaly'
|
||
trackedTypes:
|
||
type: array
|
||
items:
|
||
type: string
|
||
computedAt:
|
||
type: string
|
||
TemporalAnomaly:
|
||
type: object
|
||
properties:
|
||
type:
|
||
type: string
|
||
region:
|
||
type: string
|
||
currentCount:
|
||
type: integer
|
||
format: int32
|
||
expectedCount:
|
||
type: integer
|
||
format: int32
|
||
zScore:
|
||
type: number
|
||
format: double
|
||
severity:
|
||
type: string
|
||
multiplier:
|
||
type: number
|
||
format: double
|
||
message:
|
||
type: string
|
||
ListInternetDdosAttacksRequest:
|
||
type: object
|
||
description: ListInternetDdosAttacksRequest specifies filters for retrieving DDoS attack summaries.
|
||
ListInternetDdosAttacksResponse:
|
||
type: object
|
||
properties:
|
||
protocol:
|
||
type: array
|
||
items:
|
||
$ref: '#/components/schemas/DdosAttackSummaryEntry'
|
||
vector:
|
||
type: array
|
||
items:
|
||
$ref: '#/components/schemas/DdosAttackSummaryEntry'
|
||
dateRangeStart:
|
||
type: string
|
||
description: ISO 8601 start of the data window.
|
||
dateRangeEnd:
|
||
type: string
|
||
description: ISO 8601 end of the data window.
|
||
topTargetLocations:
|
||
type: array
|
||
items:
|
||
$ref: '#/components/schemas/DdosLocationHit'
|
||
description: ListInternetDdosAttacksResponse contains DDoS attack protocol and vector breakdowns.
|
||
DdosAttackSummaryEntry:
|
||
type: object
|
||
properties:
|
||
label:
|
||
type: string
|
||
description: Protocol or vector name (e.g. "TCP", "UDP", "networkFlood").
|
||
percentage:
|
||
type: number
|
||
format: float
|
||
description: Percentage share of total DDoS traffic (0–100).
|
||
description: DdosAttackSummaryEntry represents a single protocol or vector and its share of DDoS traffic.
|
||
DdosLocationHit:
|
||
type: object
|
||
properties:
|
||
countryCode:
|
||
type: string
|
||
description: ISO 3166-1 alpha-2 country code.
|
||
countryName:
|
||
type: string
|
||
description: Country display name.
|
||
percentage:
|
||
type: number
|
||
format: float
|
||
description: Percentage share of total DDoS traffic targeting this location (0-100).
|
||
latitude:
|
||
type: number
|
||
format: float
|
||
description: Latitude of the target location.
|
||
longitude:
|
||
type: number
|
||
format: float
|
||
description: Longitude of the target location.
|
||
description: DdosLocationHit represents a top DDoS target location with geo coordinates.
|
||
ListInternetTrafficAnomaliesRequest:
|
||
type: object
|
||
properties:
|
||
country:
|
||
type: string
|
||
description: Optional ISO 3166-1 alpha-2 country code filter.
|
||
description: ListInternetTrafficAnomaliesRequest specifies filters for traffic anomalies.
|
||
ListInternetTrafficAnomaliesResponse:
|
||
type: object
|
||
properties:
|
||
anomalies:
|
||
type: array
|
||
items:
|
||
$ref: '#/components/schemas/TrafficAnomaly'
|
||
totalCount:
|
||
type: integer
|
||
format: int32
|
||
description: Total anomaly count before filtering.
|
||
description: ListInternetTrafficAnomaliesResponse contains detected traffic anomalies.
|
||
TrafficAnomaly:
|
||
type: object
|
||
properties:
|
||
uuid:
|
||
type: string
|
||
description: Unique identifier for the anomaly.
|
||
type:
|
||
type: string
|
||
description: Anomaly type (e.g. "ANOMALY_DNS", "ANOMALY_BGP").
|
||
status:
|
||
type: string
|
||
description: Current status ("ONGOING" or "HISTORICAL").
|
||
startDate:
|
||
type: integer
|
||
format: int64
|
||
description: 'Start of the anomaly, Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript'
|
||
endDate:
|
||
type: integer
|
||
format: int64
|
||
description: 'End of the anomaly, Unix epoch milliseconds. Zero if ongoing.. Warning: Values > 2^53 may lose precision in JavaScript'
|
||
asn:
|
||
type: string
|
||
description: Autonomous System Number affected.
|
||
asnName:
|
||
type: string
|
||
description: ASN display name.
|
||
locationCode:
|
||
type: string
|
||
description: ISO 3166-1 alpha-2 country code.
|
||
locationName:
|
||
type: string
|
||
description: Country display name.
|
||
latitude:
|
||
type: number
|
||
format: float
|
||
description: Latitude of the affected location.
|
||
longitude:
|
||
type: number
|
||
format: float
|
||
description: Longitude of the affected location.
|
||
description: TrafficAnomaly represents an anomalous traffic pattern detected by Cloudflare Radar.
|