API Reference Pristine v#0.3.0

Copy Markdown View Source

Modules

Shared runtime substrate for first-party OpenAPI-based SDKs.

Phase 6 adapter selection policy declaration for Pristine lower simulation.

Admission-control adapter that performs no coordination.

Static API key auth adapter.

Basic auth adapter.

Bearer token auth adapter.

OAuth2 bearer adapter backed by a token source.

GenServer-based byte-budget semaphore adapter.

Circuit breaker adapter backed by Foundation.CircuitBreaker.Registry.

Circuit breaker adapter that performs no checks.

Gzip compression adapter using Erlang's :zlib module.

Multipart adapter backed by multipart_ex.

In-tree OAuth backend adapter for Pristine's control-plane helpers.

System-command browser launcher adapter for interactive OAuth flows.

Bandit-backed loopback callback listener adapter for interactive OAuth flows.

Pool manager adapter backed by Pristine.PoolKey.

Rate limit adapter backed by Foundation.RateLimit.BackoffWindow.

Rate limit adapter that performs no limiting.

Generic HTTP result classifier for Pristine request execution.

Retry adapter backed by Foundation retry policies.

Retry adapter that performs no retries.

Counting semaphore adapter using Foundation.Semaphore.Counting.

JSON serializer using Jason with optional Sinter validation.

Telemetry adapter that does nothing.

Telemetry adapter that emits raw event names without prefixes.

JSON file-backed token source for reusable OAuth2 token persistence.

Token source wrapper that refreshes expiring OAuth2 tokens through Pristine.OAuth2.

Static token source useful for tests and simple callers.

Tokenizer adapter backed by TiktokenEx encodings.

Compatibility-named unary HTTP transport adapter backed by the Execution Plane.

Streaming HTTP transport adapter using Finch.

Configured unary HTTP simulation transport backed by Execution Plane.

Provider-agnostic runtime client used by generated providers and thin facades.

Apply auth modules to request headers.

Internal runtime context for executing request specs.

Internal endpoint metadata contract used by the request pipeline.

Header normalization and merging utilities.

Execute normalized request metadata through the shared request pipeline.

Query string encoder with configurable array and nested formats.

Normalized request data used by the transport port.

Request path validation helpers.

Internal normalized response data from the transport port.

Internal normalized classification for a single request outcome.

Response wrapper for streaming HTTP responses.

Build platform and retry telemetry headers.

Build Sinter schemas from manifest type definitions.

URL builder with path params and query encoding.

Structured error types for API responses.

Authority-materialized HTTP inputs for governed Pristine execution.

Standalone-safe descriptor for governed OpenAPI operation admission.

Phase 6 lower simulation scenario declaration for Pristine HTTP transport.

Generic OAuth2 control-plane helpers built on Pristine's transport boundary.

Authorization URL and any generated state associated with it.

Best-effort browser launcher for interactive OAuth flows.

Exact loopback callback capture for interactive OAuth flows.

Error returned by the Pristine OAuth2 control-plane helpers.

Interactive authorization-code orchestration for OAuth2 providers.

Normalized OAuth2 provider configuration.

Shared persisted-token workflow for OAuth2 token sources.

Pristine-native OAuth2 token representation.

Normalized runtime operation envelope rendered by generated providers.

Centralized pool key generation and URL normalization.

Admission-control boundary for optional high-throughput request shaping.

Auth boundary for producing headers.

Port for byte-budget rate limiting via semaphores.

Circuit breaker boundary.

Compression boundary for request/response payloads.

Multipart encoding boundary.

Boundary for OAuth control-plane request shaping and token normalization.

Normalized OAuth backend request data prior to transport dispatch.

Boundary for best-effort browser launch in interactive OAuth flows.

Boundary for loopback OAuth callback capture.

Port for pool name resolution and URL normalization.

Rate limit boundary.

Classification boundary for normalized request outcomes.

Retry boundary for retrying operations.

Port for connection/concurrency limiting via semaphores.

Serialization boundary for request/response payloads.

Port for streaming HTTP transport.

Port for SSE decoding and streaming helpers.

Telemetry boundary for observability and metrics.

Boundary for retrieving and storing OAuth2 tokens.

Tokenizer boundary for encoding and decoding text.

Transport boundary for sending requests.

Internal Foundation-backed production profile wiring.

Public runtime response wrapper for execute and stream workflows.

Internal schema resolution and materialization helpers for runtime execution.

HTTP-family execution boundary for explicit local or Runtime Client placement.

Same-node HTTP-family gateway.

HTTP-family gateway backed only by an injected Execution Plane Runtime Client.

SDK-facing runtime context contract.

SDK-facing error contract for request execution.

SDK-facing request contracts for generated provider SDKs.

Provider-specific runtime profile for shared error normalization and result classification.

SDK-facing helper for constructing normalized transport responses.

Represents a Server-Sent Event (SSE).

Stateful decoder for Server-Sent Events (SSE) streams.