Safe Haskell	None
Language	GHC2024

Arbiter.Servant.API

Contents

Orphan instances

Description

Servant API type definitions for Arbiter job queue admin interface.

The API is generated from the registry, creating separate endpoints for each table.

Synopsis

type ArbiterAPI (registry :: JobPayloadRegistry) = "api" :> ("v1" :> RegistryToAPI registry)
type family RegistryToAPI (registry :: [(Symbol, Type)]) where ...
data TableAPI payload (mode :: k) = TableAPI {
- jobs :: mode :- ("jobs" :> NamedRoutes (JobsAPI payload :: Type -> Type))
- dlq :: mode :- ("dlq" :> NamedRoutes (DLQAPI payload :: Type -> Type))
- stats :: mode :- ("stats" :> NamedRoutes (StatsAPI :: Type -> Type))
}
data JobsAPI payload (mode :: k) = JobsAPI {
- listJobs :: mode :- (QueryParam "limit" Int :> (QueryParam "offset" Int :> (QueryParam "group_key" Text :> (QueryParam "parent_id" Int64 :> (QueryParam "suspended" Bool :> (QueryFlag "roots_only" :> (QueryFlag "in_flight" :> (QueryParam "sort_by" JobSortColumn :> (QueryParam "sort_dir" SortDir :> Get '[JSON] (JobsResponse payload))))))))))
- insertJob :: mode :- (ReqBody '[JSON] (ApiJobWrite payload) :> Post '[JSON] (JobResponse payload))
- insertJobsBatch :: mode :- ("batch" :> (ReqBody '[JSON] (BatchInsertRequest payload) :> Post '[JSON] (BatchInsertResponse payload)))
- getJob :: mode :- (Capture "id" Int64 :> Get '[JSON] (JobResponse payload))
- cancelJob :: mode :- (Capture "id" Int64 :> DeleteNoContent)
- promoteJob :: mode :- (Capture "id" Int64 :> ("promote" :> PostNoContent))
- moveToDLQ :: mode :- (Capture "id" Int64 :> ("move-to-dlq" :> PostNoContent))
- pauseChildren :: mode :- (Capture "id" Int64 :> ("pause-children" :> PostNoContent))
- resumeChildren :: mode :- (Capture "id" Int64 :> ("resume-children" :> PostNoContent))
- suspendJob :: mode :- (Capture "id" Int64 :> ("suspend" :> PostNoContent))
- resumeJob :: mode :- (Capture "id" Int64 :> ("resume" :> PostNoContent))
}
data DLQAPI payload (mode :: k) = DLQAPI {
- listDLQ :: mode :- (QueryParam "limit" Int :> (QueryParam "offset" Int :> (QueryParam "parent_id" Int64 :> (QueryParam "group_key" Text :> (QueryParam "sort_by" DLQSortColumn :> (QueryParam "sort_dir" SortDir :> Get '[JSON] (DLQResponse payload)))))))
- retryFromDLQ :: mode :- (Capture "id" Int64 :> ("retry" :> PostNoContent))
- deleteDLQ :: mode :- (Capture "id" Int64 :> DeleteNoContent)
- deleteDLQBatch :: mode :- ("batch-delete" :> (ReqBody '[JSON] BatchDeleteRequest :> Post '[JSON] BatchDeleteResponse))
}
data StatsAPI (mode :: k) = StatsAPI {
- getStats :: mode :- Get '[JSON] StatsResponse
}
data QueuesAPI (mode :: k) = QueuesAPI {
- listQueues :: mode :- Get '[JSON] QueuesResponse
}
type EventsAPI = "stream" :> Raw
data CronAPI (mode :: k) = CronAPI {
- listSchedules :: mode :- ("schedules" :> Get '[JSON] CronSchedulesResponse)
- updateSchedule :: mode :- ("schedules" :> (Capture "name" Text :> (ReqBody '[JSON] CronScheduleUpdate :> Patch '[JSON] CronScheduleRow)))
}

Documentation

type ArbiterAPI (registry :: JobPayloadRegistry) = "api" :> ("v1" :> RegistryToAPI registry) Source #

Top-level Arbiter API, mounted at /api/v1. The route tree under that prefix is generated from the registry; see RegistryToAPI for the shape and the per-route data types (TableAPI, QueuesAPI, EventsAPI, CronAPI) for what each one exposes.

type family RegistryToAPI (registry :: [(Symbol, Type)]) where ... Source #

Generates a TableAPI route for each entry in the registry, followed by the shared QueuesAPI, EventsAPI, and CronAPI routes. The expansion is in the equations below.

Equations

RegistryToAPI ('[] :: [(Symbol, Type)]) = ("queues" :> NamedRoutes (QueuesAPI :: Type -> Type)) :<\|> (("events" :> EventsAPI) :<\|> ("cron" :> NamedRoutes (CronAPI :: Type -> Type)))
RegistryToAPI '['(tableName, payload)] = (tableName :> NamedRoutes (TableAPI payload :: Type -> Type)) :<\|> (("queues" :> NamedRoutes (QueuesAPI :: Type -> Type)) :<\|> (("events" :> EventsAPI) :<\|> ("cron" :> NamedRoutes (CronAPI :: Type -> Type))))
RegistryToAPI ('(tableName, payload) ': rest) = (tableName :> NamedRoutes (TableAPI payload :: Type -> Type)) :<\|> RegistryToAPI rest

data TableAPI payload (mode :: k) Source #

API routes for a specific table

Constructors

TableAPI
Fields jobs :: mode :- ("jobs" :> NamedRoutes (JobsAPI payload :: Type -> Type)) dlq :: mode :- ("dlq" :> NamedRoutes (DLQAPI payload :: Type -> Type)) stats :: mode :- ("stats" :> NamedRoutes (StatsAPI :: Type -> Type))

Instances

Instances details

Generic (TableAPI payload mode) Source #

Instance details

StatsAPI
Fields getStats :: mode :- Get '[JSON] StatsResponse

QueuesAPI
Fields listQueues :: mode :- Get '[JSON] QueuesResponse

CronAPI
Fields listSchedules :: mode :- ("schedules" :> Get '[JSON] CronSchedulesResponse) updateSchedule :: mode :- ("schedules" :> (Capture "name" Text :> (ReqBody '[JSON] CronScheduleUpdate :> Patch '[JSON] CronScheduleRow)))

FromHttpApiData DLQSortColumn Source #
Instance details Methods parseUrlPiece :: Text -> Either Text DLQSortColumn parseHeader :: ByteString -> Either Text DLQSortColumn parseQueryParam :: Text -> Either Text DLQSortColumn
FromHttpApiData JobSortColumn Source #
Instance details Methods parseUrlPiece :: Text -> Either Text JobSortColumn parseHeader :: ByteString -> Either Text JobSortColumn parseQueryParam :: Text -> Either Text JobSortColumn
FromHttpApiData SortDir Source #
Instance details Methods parseUrlPiece :: Text -> Either Text SortDir parseHeader :: ByteString -> Either Text SortDir parseQueryParam :: Text -> Either Text SortDir
ToHttpApiData DLQSortColumn Source #
Instance details Methods toUrlPiece :: DLQSortColumn -> Text toEncodedUrlPiece :: DLQSortColumn -> Builder toHeader :: DLQSortColumn -> ByteString toQueryParam :: DLQSortColumn -> Text toEncodedQueryParam :: DLQSortColumn -> Builder
ToHttpApiData JobSortColumn Source #
Instance details Methods toUrlPiece :: JobSortColumn -> Text toEncodedUrlPiece :: JobSortColumn -> Builder toHeader :: JobSortColumn -> ByteString toQueryParam :: JobSortColumn -> Text toEncodedQueryParam :: JobSortColumn -> Builder
ToHttpApiData SortDir Source #
Instance details Methods toUrlPiece :: SortDir -> Text toEncodedUrlPiece :: SortDir -> Builder toHeader :: SortDir -> ByteString toQueryParam :: SortDir -> Text toEncodedQueryParam :: SortDir -> Builder

Documentation

Instances

Instances

Instances

Instances

Instances

Instances

Orphan instances