Base

GitHub

Base class for capability API builders.

Provides access to capability options and aggregated configuration across all representations.

Instance Methods

#build

#build

GitHub

Builds API-level types.

Override this method to register shared types.

Returns

void

---

#configured

#configured(key)

GitHub

The configured values for a key.

Parameters

Name	Type	Default	Description
key	Symbol		The configuration key.

Returns

Set

Example: Check if any representation uses cursor pagination

if configured(:strategy).include?(:cursor)
  # build cursor pagination schema
end

---

#enum

#enum(name, values:, **options, &block)

GitHub

See also

• API::Base#enum

---

#enum?

#enum?(name)

GitHub

See also

• API::Base#enum?

---

#object

#object(name, **options, &block)

GitHub

See also

• API::Base#object

---

#options

#options

GitHub

The options for this API.

Returns

Configuration

---

#type?

#type?(name)

GitHub

See also

• API::Base#type?

---

#union

#union(name, **options, &block)

GitHub

See also

• API::Base#union

---