sttp.tapir.redoc.RedocUIOptions.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tapir-redoc_3 Show documentation
tapir-redoc
The newest version!
package sttp.tapir.redoc

/** @param pathPrefix
  *   The path prefix which will be added to the documentation endpoints, as a list of path segments. Defaults to `List("docs")`, so the
  *   address of the docs will be `./docs` (relative to the context in which the interpreted docs endpoints are attached).
  * @param specName
  *   The name of the file, through which the yaml documentation will be served. Defaults to `docs.yaml`.
  * @param htmlName
  *   the name of the file, through which the html documentation will be served. Defaults to `index.html`.
  * @param contextPath
  *   The context path in which the interpreted documentation endpoints are going to be attached. Only relevant when {{useRelativePaths ==
  *   false}}. E.g. when context path is `List("api", "v1")`, `useRelativePaths = false`, and other parameters are left with default values,
  *   the generated full path to the yaml will be `/api/v1/docs/docs.yaml`, instead of `./docs/docs.yaml` or `./docs.yaml` (depending on the
  *   referrer's uri). Also used for creating redirects. Defaults to `Nil`.
  * @param useRelativePaths
  *   Should relative paths be used for yaml references and redirects. Defaults to `true`.
  * @param redocVersion
  *   Version of Redoc library
  * @param redocOptions
  *   Options to pass to the Redoc library (see https://redocly.com/docs/api-reference-docs/configuration/functionality/)
  * @param redocThemeOptionsJson
  *   Theming options to pass to the Redoc library (see https://redocly.com/docs/api-reference-docs/configuration/theming/). Must be a valid
  *   JSON if not empty
  */
case class RedocUIOptions(
    pathPrefix: List[String],
    specName: String,
    htmlName: String,
    contextPath: List[String],
    useRelativePaths: Boolean,
    redocVersion: String,
    redocOptions: Option[String],
    redocThemeOptionsJson: Option[String]
) {
  def pathPrefix(pathPrefix: List[String]): RedocUIOptions = copy(pathPrefix = pathPrefix)
  def specName(specName: String): RedocUIOptions = copy(specName = specName)
  def htmlName(htmlName: String): RedocUIOptions = copy(htmlName = htmlName)
  def contextPath(contextPath: List[String]): RedocUIOptions = copy(contextPath = contextPath)
  def withRelativePaths: RedocUIOptions = copy(useRelativePaths = true)
  def withAbsolutePaths: RedocUIOptions = copy(useRelativePaths = false)
  def redocVersion(redocVersion: String): RedocUIOptions = copy(redocVersion = redocVersion)
  def redocOptions(redocOptions: String): RedocUIOptions = copy(redocOptions = Some(redocOptions))
  def redocThemeOptionsJson(redocThemeOptionsJson: String): RedocUIOptions =
    copy(redocThemeOptionsJson = Some(redocThemeOptionsJson))
}

object RedocUIOptions {
  val default: RedocUIOptions =
    RedocUIOptions(List("docs"), "docs.yaml", "index.html", Nil, useRelativePaths = true, "2.0.0-rc.56", None, None)
}