nori/reference

Reference handling for OpenAPI specifications.

OpenAPI allows objects to be defined inline or referenced via JSON Reference ($ref). This module provides the generic Ref type to handle both cases uniformly.

Types

Ref

</>

Generic type for values that can be either inline or a JSON Reference ($ref).

This pattern is used extensively in OpenAPI specs where objects can be defined inline or referenced from the components section.

Examples

// An inline schema
let inline = Inline(Schema(schema_type: Some(TypeString), ..))

// A reference to a component
let ref = Reference("#/components/schemas/User")

pub type Ref(a) {
  Inline(value: a)
  Reference(ref: String)
}

Constructors

```
Inline(value: a)
```
An inline value of type a
```
Reference(ref: String)
```
A JSON Reference string (e.g., “#/components/schemas/User”)

Values

flat_map

</>

pub fn flat_map(ref: Ref(a), f: fn(a) -> Ref(b)) -> Ref(b)

Applies a function that returns a Ref to an inline value.

get_ref

</>

pub fn get_ref(ref: Ref(a)) -> Result(String, Nil)

Gets the reference string if this is a Reference, otherwise None.

is_inline

</>

pub fn is_inline(ref: Ref(a)) -> Bool

Checks if a Ref is inline (not a reference).

is_reference

</>

pub fn is_reference(ref: Ref(a)) -> Bool

Checks if a Ref is a reference (not inline).

map

</>

pub fn map(ref: Ref(a), f: fn(a) -> b) -> Ref(b)

Maps a function over the inline value, leaving references unchanged.

to_inline

</>

pub fn to_inline(ref: Ref(a)) -> Result(a, String)

Extracts the value from a Ref if it’s inline, returns Error if it’s a reference.