endpoints.documented.algebra.Responses.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of endpoints-openapi_sjs0.6_2.11 Show documentation

endpoints-openapi

There is a newer version: 0.10.1

Show newest version

package endpoints
package documented
package algebra

import scala.language.higherKinds

/**
  * Algebra interface for describing responses.
  *
  * This interface is modeled after [[endpoints.algebra.Responses]] but some
  * methods take additional parameters carrying documentation.
  */
trait Responses {

  /** Information carried by a response */
  type Response[A]

  /**
    * Empty response.
    */
  def emptyResponse(documentation: String): Response[Unit]

  /**
    * Text response.
    */
  def textResponse(documentation: String): Response[String]

}