• Home
• org.julienrf
• endpoints-openapi_sjs0.6_2.11
• 0.3.0
• source code
• OptionalResponses.scala

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

package endpoints
package documented
package algebra

/**
  * Algebra interface for describing optional responses including documentation.
  *
  * This interface is modeled after [[endpoints.algebra.OptionalResponses]] but the `option`
  * method takes an additional parameter carrying a description.
  */
trait OptionalResponses
  extends Endpoints {

  /**
    * @return A description of an HTTP response that can be either 404 (Not found)
    *         or the underlying `response`.
    * @param response Underlying response
    * @param notFoundDocumentation Description in case there is no result
    */
  def option[A](response: Response[A], notFoundDocumentation: String): Response[Option[A]]

}