Skip to main content

Module semantics

Module semantics 

Source
Expand description

OpenAPI-derived SDK behaviour shared by language targets.

Renderers should not each rediscover whether an operation streams, can be retried, needs a credential, or has typed error responses. This module is deliberately free of language and HTTP-client details: it turns the normalized API AST into a small, stable behaviour plan which a selected client generator can render idiomatically.

Structs§

AuthAlternative
One OpenAPI security alternative. Every item inside an alternative is required; alternatives themselves are OR-ed.
DeclaredError
A non-success response declared by an operation.
OperationSemantics
Behaviour that applies to one generated operation.
PaginationHint
An opt-in pagination declaration. Pagination is intentionally not guessed from operation names: a false pager is worse than no pager. Adapters retain vendor extensions, so Poolster accepts its own portable extension and the established Speakeasy declaration while keeping their payload opaque until a concrete paginator renderer needs it.
SdkSemantics
The complete target-neutral behaviour plan for one API.

Enums§

AuthScheme
A resolved credential requirement. Unknown schemes are deliberately kept as Other so targets can report a useful configuration error rather than quietly omitting security.
PaginationSource
RequestBodyKind
Request encodings that require specialised client-runtime handling.
RetryClass
Retry safety derived from HTTP semantics and explicit idempotency headers.
StreamingKind
A response whose media type requires a streaming API instead of ordinary JSON deserialization.

Functions§

analyze_operation
analyze_sdk_semantics
Analyses every operation once. A caller that has no component security artifact can pass None; operation security remains visible as Other.