OptionalResponses

Type Members

case class DocumentedEndpoint(path: String, item: PathItem) extends Product with Serializable
case class DocumentedHeaders(value: List[HeaderName]) extends Product with Serializable
case class DocumentedParameter(name: String, required: Boolean) extends Product with Serializable
case class DocumentedQueryString(parameters: List[DocumentedParameter]) extends Product with Serializable
case class DocumentedRequest(method: Requests.Method, url: Requests.DocumentedUrl, headers: DocumentedHeaders, entity: Option[DocumentedRequestEntity]) extends Product with Serializable

Definition Classes
Requests
case class DocumentedRequestEntity(documentation: Option[String], content: Map[String, MediaType]) extends Product with Serializable
case class DocumentedResponse(status: Int, documentation: String, content: Map[String, MediaType]) extends Product with Serializable
case class DocumentedUrl(path: String, pathParameters: List[DocumentedParameter], queryParameters: List[DocumentedParameter]) extends Product with Serializable
type Endpoint[A, B] = DocumentedEndpoint

Information carried by an HTTP endpoint
Information carried by an HTTP endpoint

Definition Classes
Endpoints → Endpoints
type HeaderName = String

Definition Classes
Requests
sealed trait Method extends AnyRef

Definition Classes
Methods → Methods
type Path[A] = DocumentedUrl

An URL path carrying an A information
An URL path carrying an A information

Definition Classes
Urls → Urls
implicit class PathOps[A] extends AnyRef

Convenient methods for Paths.
type QueryString[A] = DocumentedQueryString

A query string carrying an A information
A query string carrying an A information

Definition Classes
Urls → Urls
implicit class QueryStringOps[A] extends AnyRef

Provides convenient methods on QueryString.
type QueryStringParam[A] = Unit

A single query string parameter carrying an A information.
A single query string parameter carrying an A information.

Definition Classes
Urls → Urls
type Request[A] = DocumentedRequest

Information carried by a whole request (headers and entity)
Information carried by a whole request (headers and entity)

Definition Classes
Requests → Requests
type RequestEntity[A] = Option[DocumentedRequestEntity]

Information carried by request entity
Information carried by request entity

Definition Classes
Requests → Requests
type RequestHeaders[A] = DocumentedHeaders

Information carried by requests’ headers
Information carried by requests’ headers

Definition Classes
Requests → Requests
type Response[A] = List[DocumentedResponse]

Information carried by a response
Information carried by a response

Definition Classes
Responses → Responses
type Segment[A] = Unit

An URL path segment carrying an A information.
An URL path segment carrying an A information.

Definition Classes
Urls → Urls
type Url[A] = DocumentedUrl

An URL carrying an A information
An URL carrying an A information

Definition Classes
Urls → Urls

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
object Delete extends Method with Product with Serializable

Definition Classes
Methods → Methods
object Get extends Method with Product with Serializable

Definition Classes
Methods → Methods
object Patch extends Method with Product with Serializable

Definition Classes
Methods → Methods
object Post extends Method with Product with Serializable

Definition Classes
Methods → Methods
object Put extends Method with Product with Serializable

Definition Classes
Methods → Methods
final def asInstanceOf[T0]: T0

Definition Classes
Any
def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]

Chains the two paths
Chains the two paths

Definition Classes
Urls → Urls
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

Concatenates two QueryStrings
Concatenates two QueryStrings

Definition Classes
Urls → Urls
def emptyHeaders: DocumentedHeaders

No particular information.
No particular information. Does not mean that the headers *have to* be empty. Just that, from a server point of view no information will be extracted from them, and from a client point of view no particular headers will be built in the request.

Definition Classes
Requests → Requests
def emptyRequest: None.type

Empty request.
Empty request.

Definition Classes
Requests → Requests
def emptyResponse(documentation: String): Response[Unit]

Empty response.
Empty response.

Definition Classes
Responses → Responses
def endpoint[A, B](request: Request[A], response: Response[B]): Endpoint[A, B]

HTTP endpoint.
HTTP endpoint.
request
Request
response
Response

Definition Classes
Endpoints → Endpoints
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def get[A, B](url: Url[A], headers: RequestHeaders[B] = emptyHeaders)(implicit tuplerAC: Tupler[A, B]): Request[Out]

Helper method to perform GET request
Helper method to perform GET request

Definition Classes
Requests
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def intQueryString: QueryStringParam[Int]

Ability to define Int query string parameters
Ability to define Int query string parameters

Definition Classes
Urls → Urls
def intSegment: Segment[Int]

Ability to define Int path segments
Ability to define Int path segments

Definition Classes
Urls → Urls
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def longQueryString: QueryStringParam[Long]

Query string parameter containing a Long value
Query string parameter containing a Long value

Definition Classes
Urls → Urls
def longSegment: Segment[Long]

Segment containing a Long value
Segment containing a Long value

Definition Classes
Urls → Urls
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def openApi(info: Info)(endpoints: DocumentedEndpoint*): OpenApi

info
General information about the documentation to generate
endpoints
The endpoints to generate the documentation for
returns
An OpenApi instance for the given endpoint descriptions

Definition Classes
Endpoints
def optQs[A](name: String)(implicit value: QueryStringParam[A]): QueryString[Option[A]]

Builds a QueryString with one optional parameter of type A.
Builds a QueryString with one optional parameter of type A.
name
Parameter’s name

Definition Classes
Urls → Urls
def option[A](response: Response[A], notFoundDocumentation: String): Response[Option[A]]

response
Underlying response
notFoundDocumentation
Description in case there is no result
returns
A description of an HTTP response that can be either 404 (Not found) or the underlying response.

Definition Classes
OptionalResponses → OptionalResponses
val path: Path[Unit]

An empty path.
An empty path.
Useful to begin a path definition:
```
path / "foo" / segment[Int]("some-value")
```
Definition Classes
Urls
final def post[A, B, C, AB](url: Url[A], entity: RequestEntity[B], headers: RequestHeaders[C] = emptyHeaders)(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler[AB, C]): Request[Out]

Helper method to perform POST request
Helper method to perform POST request

Definition Classes
Requests
def qs[A](name: String)(implicit value: QueryStringParam[A]): QueryString[A]

Builds a QueryString with one parameter.
Builds a QueryString with one parameter.
A
Type of the value carried by the parameter
name
Parameter’s name

Definition Classes
Urls → Urls
def request[A, B, C, AB](method: Method, url: Url[A], entity: RequestEntity[B] = emptyRequest, headers: RequestHeaders[C] = emptyHeaders)(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler[AB, C]): Request[Out]

Request for given parameters
Request for given parameters
method
Request method
url
Request URL

Definition Classes
Requests → Requests
def segment[A](name: String)(implicit A: Segment[A]): Path[A]

Builds a path segment carrying an A information
Builds a path segment carrying an A information
name
Name for the segment (for documentation)

Definition Classes
Urls → Urls
def staticPathSegment(segment: String): Path[Unit]

Builds a static path segment
Builds a static path segment

Definition Classes
Urls → Urls
def stringQueryString: QueryStringParam[String]

Ability to define String query string parameters
Ability to define String query string parameters

Definition Classes
Urls → Urls
def stringSegment: Segment[String]

Ability to define String path segments
Ability to define String path segments

Definition Classes
Urls → Urls
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def textResponse(documentation: String): Response[String]

Text response.
Text response.

Definition Classes
Responses → Responses
def toString(): String

Definition Classes
AnyRef → Any
def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]

Builds an URL from the given path and query string
Builds an URL from the given path and query string

Definition Classes
Urls → Urls
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

trait OptionalResponses extends algebra.OptionalResponses with Endpoints

Type Members

case class DocumentedEndpoint(path: String, item: PathItem) extends Product with Serializable

case class DocumentedHeaders(value: List[HeaderName]) extends Product with Serializable

case class DocumentedParameter(name: String, required: Boolean) extends Product with Serializable

case class DocumentedQueryString(parameters: List[DocumentedParameter]) extends Product with Serializable

case class DocumentedRequest(method: Requests.Method, url: Requests.DocumentedUrl, headers: DocumentedHeaders, entity: Option[DocumentedRequestEntity]) extends Product with Serializable

case class DocumentedRequestEntity(documentation: Option[String], content: Map[String, MediaType]) extends Product with Serializable

case class DocumentedResponse(status: Int, documentation: String, content: Map[String, MediaType]) extends Product with Serializable

case class DocumentedUrl(path: String, pathParameters: List[DocumentedParameter], queryParameters: List[DocumentedParameter]) extends Product with Serializable

type Endpoint[A, B] = DocumentedEndpoint

type HeaderName = String

sealed trait Method extends AnyRef

type Path[A] = DocumentedUrl

implicit class PathOps[A] extends AnyRef

type QueryString[A] = DocumentedQueryString

implicit class QueryStringOps[A] extends AnyRef

type QueryStringParam[A] = Unit

type Request[A] = DocumentedRequest

type RequestEntity[A] = Option[DocumentedRequestEntity]

type RequestHeaders[A] = DocumentedHeaders

type Response[A] = List[DocumentedResponse]

type Segment[A] = Unit

type Url[A] = DocumentedUrl

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

object Delete extends Method with Product with Serializable

object Get extends Method with Product with Serializable

object Patch extends Method with Product with Serializable

object Post extends Method with Product with Serializable

object Put extends Method with Product with Serializable

final def asInstanceOf[T0]: T0

def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]

def clone(): AnyRef

def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

def emptyHeaders: DocumentedHeaders

def emptyRequest: None.type

def emptyResponse(documentation: String): Response[Unit]

def endpoint[A, B](request: Request[A], response: Response[B]): Endpoint[A, B]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def get[A, B](url: Url[A], headers: RequestHeaders[B] = emptyHeaders)(implicit tuplerAC: Tupler[A, B]): Request[Out]

final def getClass(): Class[_]

def hashCode(): Int

def intQueryString: QueryStringParam[Int]

def intSegment: Segment[Int]

final def isInstanceOf[T0]: Boolean

def longQueryString: QueryStringParam[Long]

def longSegment: Segment[Long]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def openApi(info: Info)(endpoints: DocumentedEndpoint*): OpenApi

def optQs[A](name: String)(implicit value: QueryStringParam[A]): QueryString[Option[A]]

def option[A](response: Response[A], notFoundDocumentation: String): Response[Option[A]]

val path: Path[Unit]

final def post[A, B, C, AB](url: Url[A], entity: RequestEntity[B], headers: RequestHeaders[C] = emptyHeaders)(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler[AB, C]): Request[Out]

def qs[A](name: String)(implicit value: QueryStringParam[A]): QueryString[A]

def request[A, B, C, AB](method: Method, url: Url[A], entity: RequestEntity[B] = emptyRequest, headers: RequestHeaders[C] = emptyHeaders)(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler[AB, C]): Request[Out]

def segment[A](name: String)(implicit A: Segment[A]): Path[A]

def staticPathSegment(segment: String): Path[Unit]

def stringQueryString: QueryStringParam[String]

def stringSegment: Segment[String]

final def synchronized[T0](arg0: ⇒ T0): T0

def textResponse(documentation: String): Response[String]

def toString(): String

def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Endpoints

Inherited from Responses

Inherited from Requests

Inherited from Methods