API Types

Core types for API contract validation.

Endpoint Types

• NormalizedEndpoint — Unified endpoint model
• DriftResult — Drift detection result

Supporting Types

HttpMethod

type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS'

Severity

type Severity = 'critical' | 'high' | 'medium' | 'low'

Level	Emoji	Impact
critical	🔴	Will break clients
high	🔴	Likely to break clients
medium	🟡	May cause issues
low	🟢	Non-breaking

DriftType

type DriftType =
  | 'missing-endpoint'
  | 'phantom-endpoint'
  | 'type-mismatch'
  | 'missing-field'
  | 'extra-field'
  | 'required-mismatch'
  | 'response-code-mismatch'
  | 'deprecated-not-removed'

Param, Schema, Response, SourceLocation

See NormalizedEndpoint for detailed definitions.

Type Relationships

parseAndNormalizeSpec(): NormalizedEndpoint[]
createAnalyzer().analyze(): NormalizedEndpoint[]
detectDrifts(): DriftResult[]

See Also

• API Reference — Full API documentation