ErrorCode

GitHub

Modules

• Definition

Class Methods

.find

.find(key)

GitHub

Finds an error code by key.

Parameters

Name	Type	Default	Description
key	Symbol		The error code key.

Returns

ErrorCode::Definition, nil

See also

• .find!

Example

Apiwork::ErrorCode.find(:not_found)

---

.find!

.find!(key)

GitHub

Finds an error code by key.

Parameters

Name	Type	Default	Description
key	Symbol		The error code key.

Returns

ErrorCode::Definition

See also

• .find

Example

Apiwork::ErrorCode.find!(:not_found)

---

.register

.register(key, attach_path: false, status:)

GitHub

Registers a custom error code for use in API responses.

Error codes are used with raises declarations and expose_error in controllers. Built-in codes (400-504) are pre-registered.

Parameters

Name	Type	Default	Description
key	Symbol		The unique identifier for the error code.
attach_path	Boolean	false	Include request path in error response.
status	Integer		The HTTP status code (must be 400-599).

Returns

ErrorCode::Definition

See also

• Issue

Example: Register custom error code

Apiwork::ErrorCode.register :resource_locked, status: 423

Example: With path attachment

Apiwork::ErrorCode.register :not_found, status: 404, attach_path: true

---

Instance Methods

#key

#key

GitHub

The key for this error code.

Returns

Symbol

---

#status

#status

GitHub

The status for this error code.

Returns

Integer

---