AdminRoutes

com.worxbend.wolfram.AdminRoutes
See theAdminRoutes companion class
object AdminRoutes

Attributes

Companion
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

final case class Reply(status: Int, contentType: String, body: String)

A status code, a content type and a body — everything these routes ever need.

A status code, a content type and a body — everything these routes ever need.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Value members

Concrete methods

def openApi: Reply

The generated OpenAPI document.

The generated OpenAPI document.

Kept on this operational router rather than left to the Swagger UI bundle's own /docs/openapi.yaml, because /openapi.json at the root is the conventional place a code generator looks and it should not move just because the UI is mounted somewhere. Both render the same model.

Attributes

def reply(status: Int, body: Json): Reply

Concrete fields

val JsonContentType: String
val LivenessPath: String

Split liveness and readiness, under Meters.HealthPath so one Prometheus/ingress config covers all three services.

Split liveness and readiness, under Meters.HealthPath so one Prometheus/ingress config covers all three services.

Attributes

val OpenApiPath: String

Served rather than published as a file so the document can never describe a build other than the running one.

Served rather than published as a file so the document can never describe a build other than the running one.

Attributes

val ReadinessPath: String
val live: Reply

Liveness: the process is running and its event loop is answering. Consults nothing else — see AdminRoutes.readiness.

Liveness: the process is running and its event loop is answering. Consults nothing else — see AdminRoutes.readiness.

Attributes