Scope

GitHub

Aggregated scope for capability API builders.

Provides access to data collected across all representations in the API. Use this to query API-wide state when building shared types.

Instance Methods

#configured

#configured(capability, key)

GitHub

The configured values for a capability.

Parameters

Name	Type	Default	Description
capability	Symbol		The capability name.
key	Symbol		The configuration key.

Returns

Set

---

#filter_types

#filter_types

GitHub

Returns all filterable types across representations.

Returns

Set<Symbol>

---

#filterable?

#filterable?

GitHub

Returns whether any representation has filterable attributes.

Returns

Boolean

---

#index_actions?

#index_actions?

GitHub

Returns whether any resource has index actions.

Returns

Boolean

---

#nullable_filter_types

#nullable_filter_types

GitHub

Returns filterable types that can be null.

Returns

Set<Symbol>

---

#sortable?

#sortable?

GitHub

Returns whether any representation has sortable attributes.

Returns

Boolean

---