Enum

GitHub

Wraps enum type definitions.

Example

api.enums[:status].values # => ["draft", "published", "archived"]
api.enums[:status].description # => "Document status"
api.enums[:status].deprecated? # => false

Instance Methods

#deprecated?

#deprecated?

GitHub

Whether this enum is deprecated.

Returns

Boolean

---

#description

#description

GitHub

The description for this enum.

Returns

String, nil

---

#example

#example

GitHub

The example for this enum.

Returns

String, nil

---

#to_h

#to_h

GitHub

Converts this enum to a hash.

Returns

Hash

---

#values

#values

GitHub

The values for this enum.

Returns

Array<String>

---