oaspec/transport

Pure, runtime-agnostic transport contract for generated OpenAPI clients.

Generated client code depends on this module instead of any concrete HTTP runtime. Adapters (e.g. oaspec/httpc, oaspec/fetch) bridge Send to a real runtime; tests can plug in arbitrary fake Send values via oaspec/mock.

Types

Body

</>

pub type Body {
  EmptyBody
  TextBody(String)
  BytesBody(BitArray)
}

Constructors

```
EmptyBody
```
```
TextBody(String)
```
```
BytesBody(BitArray)
```

Credentials

opaque </>

pub opaque type Credentials

Method

</>

pub type Method {
  Get
  Post
  Put
  Delete
  Patch
  Head
  Options
  Trace
  Connect
}

Constructors

```
Get
```
```
Post
```
```
Put
```
```
Delete
```
```
Patch
```
```
Head
```
```
Options
```
```
Trace
```
```
Connect
```

Request

</>

pub type Request {
  Request(
    method: Method,
    base_url: option.Option(String),
    path: String,
    query: List(#(String, String)),
    headers: List(#(String, String)),
    body: Body,
    security: List(SecurityAlternative),
  )
}

Constructors

Request(
  method: Method,
  base_url: option.Option(String),
  path: String,
  query: List(#(String, String)),
  headers: List(#(String, String)),
  body: Body,
  security: List(SecurityAlternative),
)

Response

</>

pub type Response {
  Response(
    status: Int,
    headers: List(#(String, String)),
    body: Body,
  )
}

Constructors

Response(
  status: Int,
  headers: List(#(String, String)),
  body: Body,
)

SecurityAlternative

</>

pub type SecurityAlternative {
  SecurityAlternative(requirements: List(SecurityRequirement))
}

Constructors

SecurityAlternative(requirements: List(SecurityRequirement))

SecurityRequirement

</>

pub type SecurityRequirement {
  ApiKeyHeader(scheme_name: String, header_name: String)
  ApiKeyQuery(scheme_name: String, query_name: String)
  ApiKeyCookie(scheme_name: String, cookie_name: String)
  HttpAuthorization(scheme_name: String, prefix: String)
}

Constructors

ApiKeyHeader(scheme_name: String, header_name: String)

ApiKeyQuery(scheme_name: String, query_name: String)

ApiKeyCookie(scheme_name: String, cookie_name: String)

HttpAuthorization(scheme_name: String, prefix: String)

Send

</>

pub type Send =
  fn(Request) -> Result(Response, TransportError)

TransportError

</>

pub type TransportError {
  ConnectionFailed(detail: String)
  Timeout
  InvalidBaseUrl(detail: String)
  TlsFailure(detail: String)
  Unsupported(detail: String)
}

Constructors

```
ConnectionFailed(detail: String)
```
```
Timeout
```
```
InvalidBaseUrl(detail: String)
```
```
TlsFailure(detail: String)
```
```
Unsupported(detail: String)
```

Values

credentials

</>

pub fn credentials() -> Credentials

with_api_key

</>

pub fn with_api_key(
  creds creds: Credentials,
  scheme_name scheme_name: String,
  value value: String,
) -> Credentials

with_base_url

</>

pub fn with_base_url(
  send send: fn(Request) -> Result(Response, TransportError),
  base_url base_url: String,
) -> fn(Request) -> Result(Response, TransportError)

with_basic_auth

</>

pub fn with_basic_auth(
  creds creds: Credentials,
  scheme_name scheme_name: String,
  value value: String,
) -> Credentials

with_bearer_token

</>

pub fn with_bearer_token(
  creds creds: Credentials,
  scheme_name scheme_name: String,
  token token: String,
) -> Credentials

with_default_header

</>

pub fn with_default_header(
  send send: fn(Request) -> Result(Response, TransportError),
  name name: String,
  value value: String,
) -> fn(Request) -> Result(Response, TransportError)

with_default_headers

</>

pub fn with_default_headers(
  send send: fn(Request) -> Result(Response, TransportError),
  headers headers: List(#(String, String)),
) -> fn(Request) -> Result(Response, TransportError)

with_digest_auth

</>

pub fn with_digest_auth(
  creds creds: Credentials,
  scheme_name scheme_name: String,
  value value: String,
) -> Credentials

with_security

</>

pub fn with_security(
  send send: fn(Request) -> Result(Response, TransportError),
  credentials creds: Credentials,
) -> fn(Request) -> Result(Response, TransportError)