ari

Type Members

1. trait FetcherApi extends AnyRef

   

   The fetcher calls the Naptime APIs (either local or remote) to acquire all of the data necessary.

2. case class FullSchema(resources: Set[Resource], types: Set[DataSchema]) extends Product with Serializable

   

   Contains the complete set of static type information to fully specify a Naptime service.

   Contains the complete set of static type information to fully specify a Naptime service.

   resources

   The Resource schemas for all available resources.

   types

   All of the data types that compose the service.

3. class LocalSchemaProvider extends SchemaProvider with StrictLogging

   

   Implements a default schema provider for local-only ARI operation.

4. case class Request(requestHeader: RequestHeader, topLevelRequests: Seq[TopLevelRequest]) extends Product with Serializable

   

   This encapsulates all of the information needed to compute a response.

   This encapsulates all of the information needed to compute a response.

   requestHeader

   The request header is used for authentication parsing in the underlying requests made. Path and query parameters included in the request header are ignored in favor of the data within the topLevelRequests fields.

   topLevelRequests

   A non-empty list of "roots" used to begin queries. Every query begins with a "base" resource and related models are joined upon it from there.

5. case class RequestField(name: String, alias: Option[String], args: Set[(String, JsValue)], selections: List[RequestField], typeCondition: Option[String] = None) extends Product with Serializable

   

   Represents a requested field within a requested resource.

   Represents a requested field within a requested resource.

   TODO: figure out directives

   name

   The name of the requested field.

   alias

   The name the field should be renamed to in the response.

   args

   If the field takes parameters, they are encapsulated here.

   selections

   The list of fields in the related resource.

6. case class Response(topLevelResponses: Map[TopLevelRequest, TopLevelResponse], data: Map[ResourceName, Map[AnyRef, DataMap]], metrics: ResponseMetrics = ResponseMetrics()) extends Product with Serializable

   

   All of the data required to assemble a response to an automatic includes query.

   All of the data required to assemble a response to an automatic includes query.

   TODO: performance test, and determine if mutable collections yield non-trivial performance improvements.

   topLevelResponses

   A map from the top level requests to a TopLevelResponse, containing ids and pagination

   data

   A map from the resource name to a Map of IDs to DataMaps.

7. case class ResponseMetrics(numRequests: Int = 0, duration: FiniteDuration = FiniteDuration(0, "seconds")) extends Product with Serializable

   

8. trait SchemaProvider extends AnyRef

   

   Provides the metadata required to power the engine.

   Provides the metadata required to power the engine.

   For local-only operation, a LocalSchemaProvider implements this interface. For distributed operations, a more sophisticated SchemaProvider must be implemented.

9. case class TopLevelRequest(resource: ResourceName, selection: RequestField, alias: Option[String] = None) extends Product with Serializable

   

   Encapsulates the starting root of a query into the naptime resource tree.

   Encapsulates the starting root of a query into the naptime resource tree.

   resource

   The name of the resource that forms the root of the request.

   selection

   The field selection on the first resource.

10. case class TopLevelResponse(ids: DataList, pagination: ResponsePagination, url: Option[String] = None) extends Product with Serializable

    

    Represents the response data from a TopLevelRequest, including returned ids and pagination

    Represents the response data from a TopLevelRequest, including returned ids and pagination

    ids

    a list of IDs returned by the top level request. (i.e. ids 5, 6, and 7 were returned by the bySlug finder)

    pagination

    pagination info from the top level request, including total and next cursor

    url

    the downstream url used to fetch the data