Attribute

GitHub

Represents an attribute defined on a representation.

Attributes map to model columns and define serialization behavior. Used by adapters to build contracts and serialize records.

Example

attribute = InvoiceRepresentation.attributes[:title]
attribute.name # => :title
attribute.type # => :string
attribute.filterable? # => true

Instance Methods

#deprecated?

#deprecated?

GitHub

Whether this attribute is deprecated.

Returns

Boolean

---

#description

#description

GitHub

The description for this attribute.

Returns

String, nil

---

#enum

#enum

GitHub

The enum for this attribute.

Returns

Array<Object>, nil

---

#example

#example

GitHub

The example for this attribute.

Returns

Object, nil

---

#filterable?

#filterable?

GitHub

Whether this attribute is filterable.

Returns

Boolean

---

#format

#format

GitHub

The format for this attribute.

Returns

Symbol, nil

---

#max

#max

GitHub

The maximum for this attribute.

Returns

Integer, nil

---

#min

#min

GitHub

The minimum for this attribute.

Returns

Integer, nil

---

#name

#name

GitHub

The name for this attribute.

Returns

Symbol

---

#nullable?

#nullable?

GitHub

Whether this attribute is nullable.

Returns

Boolean

---

#of

#of

GitHub

The of for this attribute.

Returns

Symbol, nil

---

#optional?

#optional?

GitHub

Whether this attribute is optional.

Returns

Boolean

---

#preload

#preload

GitHub

The preload for this attribute.

Returns

Symbol, Array, Hash, nil

---

#sortable?

#sortable?

GitHub

Whether this attribute is sortable.

Returns

Boolean

---

#writable?

#writable?

GitHub

Whether this attribute is writable.

Returns

Boolean

See also

• #writable_for?

---

#writable_for?

#writable_for?(action)

GitHub

Whether this attribute is writable for the given action.

Parameters

Name	Type	Default	Description
action	Symbol<:create, :update>		The action.

Returns

Boolean

See also

• #writable?

---