Asset Loader
API
Generated with
Asset Loader/com.alecdorrington.assetloader/com.alecdorrington.assetloader.tapir/TapirService

TapirService

com.alecdorrington.assetloader.tapir.TapirService
trait TapirService[Capabilities, F[_]](serviceName: String, serviceVersion: String)

The base trait for all API services in this library. Each service is a thematic grouping of API endpoint implementations.

Type parameters

Capabilities

Capabilities required by this service (e.g. WebSocket or Streams[IO]).

F

The effect type (e.g. Future or IO).

Value parameters

serviceName

The name of this service, used in API documentation.

serviceVersion

The version of this service, used in API documentation.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class AssetService[F]

Members list

Type members

Types

final type Endpoint = ServerEndpoint[Capabilities, F]

The upper bound on the type of all API endpoints in this service.

The upper bound on the type of all API endpoints in this service.

Attributes

Value members

Abstract methods

def api: List[Endpoint]

A list of all endpoints implemented in this service.

A list of all endpoints implemented in this service.

Attributes

Concrete fields

lazy val all: List[Endpoint]

All endpoints combined from api, docs, and metrics.

All endpoints combined from api, docs, and metrics.

Attributes

lazy val docs: List[Endpoint]

Swagger documentation for this service.

Swagger documentation for this service.

Attributes

lazy val metrics: List[Endpoint]

Prometheus metrics for this service.

Prometheus metrics for this service.

Attributes

Generated with