Default

GitHub

Default collection response wrapper.

Wraps serialized records under a pluralized root key with optional meta and capability metadata.

Example: Configuration

class MyAdapter < Adapter::Base
  collection_wrapper Wrapper::Collection::Default
end

Example: Output

{
  "invoices": [
    { "id": 1, "number": "INV-001" },
    { "id": 2, "number": "INV-002" }
  ],
  "meta": { ... },
  "pagination": { "current": 1, "total": 5 }
}

Class Methods

.shape

.shape(klass_or_callable = nil, &block)

GitHub

Defines the response shape for contract generation.

Parameters

Name	Type	Default	Description
klass_or_callable	Class<Shape>, Proc, nil	nil	A Shape subclass or callable.

Returns

Class<Shape>, nil

---

Instance Methods

#data

#data

GitHub

The data for this wrapper.

Returns

Hash

---

#meta

#meta

GitHub

The meta for this wrapper.

Returns

Hash

---

#metadata

#metadata

GitHub

The metadata for this wrapper.

Returns

Hash

---