Module: OpenStax

Defined in:

lib/openstax/api/rspec_helpers.rb,
lib/openstax_api.rb,
lib/openstax/api/roar.rb,
lib/openstax/api/apipie.rb,
lib/openstax/api/engine.rb,
lib/openstax/api/version.rb,
lib/openstax/api/constraints.rb,
app/models/openstax/api/api_user.rb,
lib/openstax/api/routing_mapper_includes.rb,
lib/openstax/api/representable_schema_printer.rb,
app/controllers/openstax/api/v1/api_controller.rb,
lib/openstax/api/doorkeeper_application_includes.rb,
app/representers/openstax/api/v1/abstract_search_representer.rb

Overview

Represents search results for a JSON API

Subclasses should define the representer for the search results:

collection :items, inherit: true, decorator: SomeRepresenter

See spec/dummy/app/representers/user_search_representer.rb for an example search representer

Defined Under Namespace

Modules: Api