input-output-hk / atala-prism-building-blocks / 8795121910

package io.iohk.atala.system.controller

import io.iohk.atala.api.http.EndpointOutputs.*

import io.iohk.atala.api.http.{ErrorResponse, RequestContext}

import io.iohk.atala.system.controller.http.HealthInfo

import sttp.apispec.Tag

import sttp.tapir.ztapir.stringBody

import sttp.tapir.json.zio.jsonBody

import sttp.tapir.*

object SystemEndpoints {

  private val tagName = "System"

    s"""

       |The __${tagName}__ is a REST API that allows to check the system health and scrap the runtime metrics.

       |

       |The __health__ endpoint returns the current version of the running service.

       |This information can be used to check the health status of the running service in the docker or kubernetes environment.

       |

       |The __metrics__ endpoint returns the runtime metrics of the running service scraped from the internal prometheus registry.

       |""".stripMargin

  val tag = Tag(tagName, Some(tagDescription))

  val health: PublicEndpoint[

    (RequestContext),

    ErrorResponse,

    HealthInfo,

    Any

      .out(jsonBody[HealthInfo].description("The health info object."))

      .name("systemHealth")

  val metrics: PublicEndpoint[

    (RequestContext),

    ErrorResponse,

    String,

    Any

      .out(stringBody.description("The metrics as plain strings."))

      .name("systemMetrics")

}