Exception: Dinie::APIError

Inherits:

Error

• Object
• StandardError
• Error
• Dinie::APIError

Defined in:

lib/dinie/runtime/errors.rb,
sig/dinie/runtime/errors.rbs

Overview

Base for everything that originates from talking to the Dinie API. code / request_id are first-class on every API error.

Direct Known Subclasses

APIConnectionError, APIStatusError

Instance Attribute Summary

• #code ⇒ String^? readonly

  Machine-readable error code from the Problem Details code extension.

• #request_id ⇒ String^? readonly

  Per-request correlation id (from x-request-id, body fallback).

Instance Method Summary

• #initialize(message = nil, code: nil, request_id: nil) ⇒ APIError constructor

  A new instance of APIError.

Constructor Details

#initialize(message = nil, code: nil, request_id: nil) ⇒ APIError

Returns a new instance of APIError.

Parameters:

• message (String, nil) (defaults to: nil)
• code (String, nil) (defaults to: nil)
• request_id (String, nil) (defaults to: nil)
• code: (String, nil) (defaults to: nil)
• request_id: (String, nil) (defaults to: nil)

# File 'lib/dinie/runtime/errors.rb', line 26

def initialize(message = nil, code: nil, request_id: nil)
  super(message)
  @code = code
  @request_id = request_id
end

Instance Attribute Details

#code ⇒ String^? (readonly)

Returns machine-readable error code from the Problem Details code extension.

Returns:

• (String, nil) —

  machine-readable error code from the Problem Details code extension

# File 'lib/dinie/runtime/errors.rb', line 18

def code
  @code
end

#request_id ⇒ String^? (readonly)

Returns per-request correlation id (from x-request-id, body fallback).

Returns:

• (String, nil) —

  per-request correlation id (from x-request-id, body fallback)

# File 'lib/dinie/runtime/errors.rb', line 21

def request_id
  @request_id
end