trait JsonEntitiesFromSchemas extends algebra.JsonEntitiesFromSchemas with JsonEntitiesFromCodecs with JsonSchemas
Interpreter for endpoints4s.algebra.JsonEntitiesFromCodecs that encodes JSON requests and decodes JSON responses.
- Alphabetic
- By Inheritance
- JsonEntitiesFromSchemas
- JsonSchemas
- TuplesSchemas
- NoDocsJsonSchemas
- JsonEntitiesFromCodecs
- JsonEntitiesFromCodecs
- EndpointsWithCustomErrors
- StatusCodes
- Methods
- Urls
- JsonEntitiesFromSchemas
- JsonSchemas
- TuplesSchemas
- JsonCodecs
- JsonEntities
- EndpointsWithCustomErrors
- Errors
- Responses
- StatusCodes
- Requests
- SemigroupalSyntax
- Methods
- Urls
- PartialInvariantFunctorSyntax
- InvariantFunctorSyntax
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
abstract
class
Endpoint[A, B] extends (A) ⇒ Result[B]
A function that takes the information needed to build a request and returns a task yielding the information carried by the response.
A function that takes the information needed to build a request and returns a task yielding the information carried by the response.
- Definition Classes
- EndpointsWithCustomErrors
-
trait
Request[A] extends AnyRef
A function that takes the information
Aand returns an XMLHttpRequest with an optional request entity.A function that takes the information
Aand returns an XMLHttpRequest with an optional request entity. If provided, the request entity must be compatible with thesendmethod of XMLHttpRequest.- Definition Classes
- EndpointsWithCustomErrors
-
final
class
CallbackDocs extends Serializable
- Definition Classes
- EndpointsWithCustomErrors
-
type
CallbacksDocs = Map[String, CallbackDocs]
- Definition Classes
- EndpointsWithCustomErrors
-
abstract
type
ClientErrors
- Definition Classes
- Errors
-
final
class
EndpointDocs extends Serializable
- Definition Classes
- EndpointsWithCustomErrors
-
type
Enum[A] = JsonSchema[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
implicit final
class
EnumOps[A] extends JsonSchemaDocumentationOps[A]
- Definition Classes
- JsonSchemas
-
implicit
class
InvariantFunctorSyntax[A, F[_]] extends AnyRef
- Definition Classes
- InvariantFunctorSyntax
-
type
JsonCodec[A] = JsonSchema[A]
- Definition Classes
- JsonEntitiesFromSchemas → JsonCodecs
-
type
JsonRequest[A] = JsonCodec[A]
- Definition Classes
- JsonCodecs → JsonEntities
-
type
JsonResponse[A] = JsonCodec[A]
- Definition Classes
- JsonCodecs → JsonEntities
-
trait
JsonSchema[A] extends AnyRef
- Definition Classes
- JsonSchemas
-
sealed
trait
JsonSchemaDocumentationOps[A] extends AnyRef
- Definition Classes
- JsonSchemas
-
implicit final
class
JsonSchemaOps[A] extends JsonSchemaDocumentationOps[A]
- Definition Classes
- JsonSchemas
-
type
Method = String
- Definition Classes
- Methods → Methods
-
implicit
class
PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
- Definition Classes
- PartialInvariantFunctorSyntax
-
implicit
class
PathOps[A] extends AnyRef
- Definition Classes
- Urls
-
implicit
class
QueryStringSyntax[A] extends AnyRef
- Definition Classes
- Urls
-
trait
Record[A] extends JsonSchema[A]
- Definition Classes
- JsonSchemas
-
implicit final
class
RecordOps[A] extends JsonSchemaDocumentationOps[A]
- Definition Classes
- JsonSchemas
-
type
RequestEntity[A] = Function2[A, XMLHttpRequest, Any]
A function that, given information
Aand an XMLHttpRequest, returns a request entity.A function that, given information
Aand an XMLHttpRequest, returns a request entity. Also, as a side-effect, the function can set the corresponding Content-Type header on the given XMLHttpRequest.- Definition Classes
- EndpointsWithCustomErrors → Requests
-
implicit
class
RequestEntitySyntax[A] extends AnyRef
- Definition Classes
- Requests
-
type
RequestHeaders[A] = Function2[A, XMLHttpRequest, Unit]
A function that takes the information
Aand the XMLHttpRequest and sets up some headers on it.A function that takes the information
Aand the XMLHttpRequest and sets up some headers on it.- Definition Classes
- EndpointsWithCustomErrors → Requests
-
type
Response[A] = Function1[XMLHttpRequest, Option[ResponseEntity[A]]]
Attempts to decode an
Afrom an XMLHttpRequest’s responseAttempts to decode an
Afrom an XMLHttpRequest’s response- Definition Classes
- EndpointsWithCustomErrors → Responses
-
type
ResponseEntity[A] = Function1[XMLHttpRequest, Either[Throwable, A]]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
type
ResponseHeaders[A] = (XMLHttpRequest) ⇒ Validated[A]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
implicit
class
ResponseSyntax[A] extends AnyRef
- Definition Classes
- Responses
-
abstract
type
Result[A]
A value that eventually yields an
A.A value that eventually yields an
A.Typically, concrete representation of
Resultwill have an instance ofMonadError, so that we can perform requests (sequentially and in parallel) and recover errors.- Definition Classes
- EndpointsWithCustomErrors
-
implicit
class
SemigroupalSyntax[A, F[_]] extends AnyRef
- Definition Classes
- SemigroupalSyntax
-
abstract
type
ServerError
- Definition Classes
- Errors
-
type
StatusCode = Int
- Definition Classes
- StatusCodes → StatusCodes
-
trait
Tagged[A] extends Record[A]
- Definition Classes
- JsonSchemas
-
implicit final
class
TaggedOps[A] extends JsonSchemaDocumentationOps[A]
- Definition Classes
- JsonSchemas
-
trait
Path[A] extends Url[A]
Builds an URL path from an
ABuilds an URL path from an
A- Definition Classes
- Urls
-
trait
QueryString[A] extends AnyRef
Defines how to build a query string from an
ADefines how to build a query string from an
A- Definition Classes
- Urls
-
trait
QueryStringParam[A] extends AnyRef
Defines how to build a query string parameter value from an
ADefines how to build a query string parameter value from an
A- Definition Classes
- Urls
-
trait
Segment[A] extends AnyRef
Defines how to build a path segment from an
ADefines how to build a path segment from an
A- Definition Classes
- Urls
-
trait
Url[A] extends AnyRef
Builds an URL from an
ABuilds an URL from an
A- Definition Classes
- Urls
Abstract Value Members
-
abstract
def
clientErrorsResponseEntity: ResponseEntity[ClientErrors]
- Definition Classes
- Errors
-
abstract
def
clientErrorsToInvalid(clientErrors: ClientErrors): Invalid
- Definition Classes
- Errors
-
abstract
def
endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs): Endpoint[A, B]
- Definition Classes
- EndpointsWithCustomErrors
-
abstract
def
invalidToClientErrors(invalid: Invalid): ClientErrors
- Definition Classes
- Errors
-
abstract
def
serverErrorResponseEntity: ResponseEntity[ServerError]
- Definition Classes
- Errors
-
abstract
def
serverErrorToThrowable(serverError: ServerError): Throwable
- Definition Classes
- Errors
-
abstract
def
throwableToServerError(throwable: Throwable): ServerError
- Definition Classes
- Errors
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
Accepted: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
AlreadyReported: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
BadRequest: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
Conflict: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
Created: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
Delete: String
- Definition Classes
- Methods → Methods
-
def
ExpectationFailed: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
FailedDependency: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
Forbidden: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
Get: String
- Definition Classes
- Methods → Methods
-
def
Gone: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
IMUsed: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
InternalServerError: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
LengthRequired: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
Locked: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
MethodNotAllowed: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
MisdirectedRequest: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
MultiStatus: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
NoContent: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
NonAuthoritativeInformation: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
NotAcceptable: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
NotFound: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
NotImplemented: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
NotModified: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
OK: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
Options: String
- Definition Classes
- Methods → Methods
-
def
PartialContent: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
Patch: String
- Definition Classes
- Methods → Methods
-
def
PayloadTooLarge: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
PaymentRequired: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
Post: String
- Definition Classes
- Methods → Methods
-
def
PreconditionFailed: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
PreconditionRequired: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
ProxyAuthenticationRequired: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
Put: String
- Definition Classes
- Methods → Methods
-
def
RangeNotSatisfiable: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
RequestHeaderFieldsTooLarge: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
RequestTimeout: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
ResetContent: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
TooEarly: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
TooManyRequests: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
Unauthorized: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
UnavailableForLegalReasons: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
UnprocessableEntity: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
UnsupportedMediaType: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
UpgradeRequired: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
UriTooLong: Int
- Definition Classes
- StatusCodes → StatusCodes
-
implicit
def
arrayJsonSchema[C[X] <: Iterable[X], A](implicit jsonSchema: JsonSchema[A], factory: scala.collection.compat.Factory[A, C[A]]): JsonSchema[C[A]]
- Definition Classes
- JsonSchemas → JsonSchemas
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
final
def
badRequest[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ClientErrors, A, R]): Response[R]
- Definition Classes
- Responses
-
implicit
lazy val
bigdecimalJsonSchema: JsonSchema[BigDecimal]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
bigdecimalWithConstraintsJsonSchema(constraints: NumericConstraints[BigDecimal]): JsonSchema[BigDecimal]
- Definition Classes
- JsonSchemas → JsonSchemas
-
implicit
def
booleanJsonSchema: JsonSchema[Boolean]
- Definition Classes
- JsonSchemas → JsonSchemas
-
implicit
def
booleanQueryString: QueryStringParam[Boolean]
- Definition Classes
- Urls
-
implicit
def
byteJsonSchema: JsonSchema[Byte]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
- Definition Classes
- Urls → Urls
-
def
choiceRequestEntity[A, B](requestEntityA: RequestEntity[A], requestEntityB: RequestEntity[B]): RequestEntity[Either[A, B]]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
def
choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
def
choiceTagged[A, B](taggedA: Tagged[A], taggedB: Tagged[B]): Tagged[Either[A, B]]
- Definition Classes
- JsonSchemas → JsonSchemas
-
lazy val
clientErrorsResponse: Response[ClientErrors]
- Definition Classes
- Errors
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
def
combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
- Definition Classes
- Urls → Urls
-
def
defaultDiscriminatorName: String
- Definition Classes
- JsonSchemas
-
implicit final
def
defaultStringJsonSchema: JsonSchema[String]
- Definition Classes
- JsonSchemas
-
final
def
delete[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]
- Definition Classes
- Requests
-
implicit
lazy val
doubleJsonSchema: JsonSchema[Double]
- Definition Classes
- JsonSchemas → JsonSchemas
-
implicit
def
doubleQueryString: QueryStringParam[Double]
- Definition Classes
- Urls
-
implicit
def
doubleSegment: Segment[Double]
- Definition Classes
- Urls
-
def
doubleWithConstraintsJsonSchema(constraints: NumericConstraints[Double]): JsonSchema[Double]
- Definition Classes
- JsonSchemas → JsonSchemas
-
implicit
lazy val
durationSchema: JsonSchema[Duration]
- Definition Classes
- JsonSchemas
-
lazy val
emptyRecord: Record[Unit]
- Definition Classes
- JsonSchemas → JsonSchemas
-
lazy val
emptyRequest: RequestEntity[Unit]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
lazy val
emptyRequestHeaders: RequestHeaders[Unit]
Sets up no headers on the given XMLHttpRequest
Sets up no headers on the given XMLHttpRequest
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
def
emptyResponse: ResponseEntity[Unit]
Discards response entity
Discards response entity
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
def
emptyResponseHeaders: ResponseHeaders[Unit]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
def
enumeration[A](values: Seq[A])(tpe: JsonSchema[A]): Enum[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
field[A](name: String, documentation: Option[String])(implicit tpe: JsonSchema[A]): Record[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
implicit
lazy val
floatJsonSchema: JsonSchema[Float]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
floatWithConstraintsJsonSchema(constraints: NumericConstraints[Float]): JsonSchema[Float]
- Definition Classes
- JsonSchemas → JsonSchemas
-
final
def
get[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]
- Definition Classes
- Requests
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
implicit
lazy val
instantJsonSchema: JsonSchema[Instant]
- Definition Classes
- JsonSchemas
-
implicit
lazy val
intJsonSchema: JsonSchema[Int]
- Definition Classes
- JsonSchemas → JsonSchemas
-
implicit
def
intQueryString: QueryStringParam[Int]
- Definition Classes
- Urls
-
implicit
def
intSegment: Segment[Int]
- Definition Classes
- Urls
-
def
intWithConstraintsJsonSchema(constraints: NumericConstraints[Int]): JsonSchema[Int]
- Definition Classes
- JsonSchemas → JsonSchemas
-
final
def
internalServerError[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ServerError, A, R]): Response[R]
- Definition Classes
- Responses
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
jsonRequest[A](implicit codec: JsonCodec[A]): RequestEntity[A]
- Definition Classes
- JsonEntitiesFromCodecs → JsonEntities
-
def
jsonResponse[A](implicit codec: JsonCodec[A]): ResponseEntity[A]
- Definition Classes
- JsonEntitiesFromCodecs → JsonEntities
-
implicit
def
jsonSchemaPartialInvFunctor: PartialInvariantFunctor[JsonSchema]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
lazyRecord[A](name: String)(schema: ⇒ Record[A]): Record[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
lazyRecord[A](schema: ⇒ Record[A], name: String): JsonSchema[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
lazySchema[A](name: String)(schema: ⇒ JsonSchema[A]): JsonSchema[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
lazyTagged[A](name: String)(schema: ⇒ Tagged[A]): Tagged[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
lazyTagged[A](schema: ⇒ Tagged[A], name: String): JsonSchema[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
final
def
literal[A](value: A)(implicit tpe: JsonSchema[A]): JsonSchema[Unit]
- Definition Classes
- JsonSchemas
-
implicit
lazy val
longJsonSchema: JsonSchema[Long]
- Definition Classes
- JsonSchemas → JsonSchemas
-
implicit
def
longQueryString: QueryStringParam[Long]
- Definition Classes
- Urls
-
implicit
def
longSegment: Segment[Long]
- Definition Classes
- Urls
-
def
longWithConstraintsJsonSchema(constraints: NumericConstraints[Long]): JsonSchema[Long]
- Definition Classes
- JsonSchemas → JsonSchemas
-
implicit
def
mapJsonSchema[A](implicit jsonSchema: JsonSchema[A]): JsonSchema[Map[String, A]]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
namedEnum[A](enumeration: Enum[A], name: String): Enum[A]
- Definition Classes
- NoDocsJsonSchemas → JsonSchemas
-
def
namedRecord[A](record: Record[A], name: String): Record[A]
- Definition Classes
- NoDocsJsonSchemas → JsonSchemas
-
def
namedTagged[A](tagged: Tagged[A], name: String): Tagged[A]
- Definition Classes
- NoDocsJsonSchemas → JsonSchemas
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
implicit
lazy val
offsetDateTimeSchema: JsonSchema[OffsetDateTime]
- Definition Classes
- JsonSchemas
-
final
def
ok[A, B, R](entity: ResponseEntity[A], docs: Documentation, headers: ResponseHeaders[B])(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
- Definition Classes
- Responses
-
def
optField[A](name: String, documentation: Option[String])(implicit tpe: JsonSchema[A]): Record[Option[A]]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
optFieldWithDefault[A](name: String, defaultValue: A, docs: Option[String])(implicit arg0: JsonSchema[A]): Record[A]
- Definition Classes
- JsonSchemas
-
def
optRequestHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
def
optResponseHeader(name: String, docs: Documentation = None): ResponseHeaders[Option[String]]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
implicit
def
optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
- Definition Classes
- Urls → Urls
-
def
orElseMergeTagged[A, C >: A, B <: C](taggedA: Tagged[A], taggedB: Tagged[B])(implicit arg0: ClassTag[A], arg1: ClassTag[B]): Tagged[C]
- Definition Classes
- JsonSchemas
-
def
orFallbackToJsonSchema[A, B](schemaA: JsonSchema[A], schemaB: JsonSchema[B]): JsonSchema[Either[A, B]]
- Definition Classes
- JsonSchemas → JsonSchemas
-
final
def
patch[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
- Definition Classes
- Requests
-
val
path: Path[Unit]
- Definition Classes
- Urls
-
implicit
lazy val
pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
- Definition Classes
- Urls → Urls
-
final
def
performXhr[A, B](request: Request[A], response: Response[B], a: A)(onload: (Either[Throwable, B]) ⇒ Unit, onerror: (XMLHttpRequest) ⇒ Unit): Unit
- Attributes
- protected
- Definition Classes
- EndpointsWithCustomErrors
-
final
def
post[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
- Definition Classes
- Requests
-
final
def
put[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
- Definition Classes
- Requests
-
def
qs[A](name: String, docs: Documentation)(implicit param: QueryStringParam[A]): QueryString[A]
- Definition Classes
- Urls → Urls
-
implicit
lazy val
queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]
- Definition Classes
- Urls → Urls
-
implicit
lazy val
queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]
- Definition Classes
- Urls → Urls
-
implicit
def
recordPartialInvFunctor: PartialInvariantFunctor[Record]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
remainingSegments(name: String, docs: Documentation): Path[String]
- Definition Classes
- Urls → Urls
-
implicit
def
repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: scala.collection.compat.Factory[A, CC[A]]): QueryStringParam[CC[A]]
- Definition Classes
- Urls → Urls
-
def
request[A, B, C, AB, Out](method: Method, url: Url[A], entity: RequestEntity[B], docs: Documentation, headers: RequestHeaders[C])(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler.Aux[AB, C, Out]): Request[Out]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
implicit
lazy val
requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
def
requestHeader(name: String, docs: Documentation): RequestHeaders[String]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
implicit
lazy val
requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
implicit
lazy val
requestHeadersSemigroupal: Semigroupal[RequestHeaders]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
implicit
def
requestPartialInvariantFunctor: PartialInvariantFunctor[Request]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
def
response[A, B, R](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation = None, headers: ResponseHeaders[B] = emptyResponseHeaders)(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
implicit
def
responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
def
responseHeader(name: String, docs: Documentation = None): ResponseHeaders[String]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
implicit
def
responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
implicit
def
responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
implicit
lazy val
responseInvariantFunctor: InvariantFunctor[Response]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
def
segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]
- Definition Classes
- Urls → Urls
-
implicit
lazy val
segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]
- Definition Classes
- Urls → Urls
-
lazy val
serverErrorResponse: Response[ServerError]
- Definition Classes
- Errors
-
def
staticPathSegment(segment: String): Path[Unit]
- Definition Classes
- Urls → Urls
-
def
stringCodec[A](implicit codec: JsonCodec[A]): Codec[String, A]
- Definition Classes
- JsonEntitiesFromSchemas → JsonEntitiesFromCodecs
-
def
stringCodecResponse[A](implicit codec: Decoder[String, A]): ResponseEntity[A]
- Definition Classes
- EndpointsWithCustomErrors
-
final
def
stringEnumeration[A](values: Seq[A])(encode: (A) ⇒ String)(implicit tpe: JsonSchema[String]): Enum[A]
- Definition Classes
- JsonSchemas
-
def
stringJsonSchema(format: Option[String]): JsonSchema[String]
- Definition Classes
- JsonSchemas → JsonSchemas
-
implicit
lazy val
stringQueryString: QueryStringParam[String]
- Definition Classes
- Urls → Urls
-
implicit
lazy val
stringSegment: Segment[String]
- Definition Classes
- Urls → Urls
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
implicit
def
taggedPartialInvFunctor: PartialInvariantFunctor[Tagged]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
taggedRecord[A](recordA: Record[A], tag: String): Tagged[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
lazy val
textRequest: RequestEntity[String]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
def
textResponse: ResponseEntity[String]
Decodes a text entity
Decodes a text entity
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
implicit
def
tuple10JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple11JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple12JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple13JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple14JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple15JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple16JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15], schema16: JsonSchema[T16]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple17JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15], schema16: JsonSchema[T16], schema17: JsonSchema[T17]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple18JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15], schema16: JsonSchema[T16], schema17: JsonSchema[T17], schema18: JsonSchema[T18]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple19JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15], schema16: JsonSchema[T16], schema17: JsonSchema[T17], schema18: JsonSchema[T18], schema19: JsonSchema[T19]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple20JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15], schema16: JsonSchema[T16], schema17: JsonSchema[T17], schema18: JsonSchema[T18], schema19: JsonSchema[T19], schema20: JsonSchema[T20]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple21JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15], schema16: JsonSchema[T16], schema17: JsonSchema[T17], schema18: JsonSchema[T18], schema19: JsonSchema[T19], schema20: JsonSchema[T20], schema21: JsonSchema[T21]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple22JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15], schema16: JsonSchema[T16], schema17: JsonSchema[T17], schema18: JsonSchema[T18], schema19: JsonSchema[T19], schema20: JsonSchema[T20], schema21: JsonSchema[T21], schema22: JsonSchema[T22]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple2JsonSchema[T1, T2](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2]): JsonSchema[(T1, T2)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple3JsonSchema[T1, T2, T3](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3]): JsonSchema[(T1, T2, T3)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple4JsonSchema[T1, T2, T3, T4](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4]): JsonSchema[(T1, T2, T3, T4)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple5JsonSchema[T1, T2, T3, T4, T5](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5]): JsonSchema[(T1, T2, T3, T4, T5)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple6JsonSchema[T1, T2, T3, T4, T5, T6](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6]): JsonSchema[(T1, T2, T3, T4, T5, T6)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple7JsonSchema[T1, T2, T3, T4, T5, T6, T7](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple8JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple9JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
lazy val
urlPartialInvariantFunctor: PartialInvariantFunctor[Url]
- Definition Classes
- Urls → Urls
-
def
urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]
- Definition Classes
- Urls → Urls
-
implicit final
lazy val
uuidJsonSchema: JsonSchema[UUID]
- Definition Classes
- JsonSchemas
-
implicit
def
uuidQueryString: QueryStringParam[UUID]
- Definition Classes
- Urls
-
implicit
def
uuidSegment: Segment[UUID]
- Definition Classes
- Urls
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]
- Definition Classes
- Responses
-
def
withDescriptionEnum[A](enumeration: Enum[A], description: String): Enum[A]
- Definition Classes
- NoDocsJsonSchemas → JsonSchemas
-
def
withDescriptionJsonSchema[A](schema: JsonSchema[A], description: String): JsonSchema[A]
- Definition Classes
- NoDocsJsonSchemas → JsonSchemas
-
def
withDescriptionRecord[A](record: Record[A], description: String): Record[A]
- Definition Classes
- NoDocsJsonSchemas → JsonSchemas
-
def
withDescriptionTagged[A](tagged: Tagged[A], description: String): Tagged[A]
- Definition Classes
- NoDocsJsonSchemas → JsonSchemas
-
def
withDiscriminatorTagged[A](tagged: Tagged[A], discriminatorName: String): Tagged[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
withExampleEnum[A](enumeration: Enum[A], example: A): Enum[A]
- Definition Classes
- NoDocsJsonSchemas → JsonSchemas
-
def
withExampleJsonSchema[A](schema: JsonSchema[A], example: A): JsonSchema[A]
- Definition Classes
- NoDocsJsonSchemas → JsonSchemas
-
def
withExampleRecord[A](record: Record[A], example: A): Record[A]
- Definition Classes
- NoDocsJsonSchemas → JsonSchemas
-
def
withExampleTagged[A](tagged: Tagged[A], example: A): Tagged[A]
- Definition Classes
- NoDocsJsonSchemas → JsonSchemas
-
def
withTitleEnum[A](enumeration: Enum[A], title: String): Enum[A]
- Definition Classes
- NoDocsJsonSchemas → JsonSchemas
-
def
withTitleJsonSchema[A](schema: JsonSchema[A], title: String): JsonSchema[A]
- Definition Classes
- NoDocsJsonSchemas → JsonSchemas
-
def
withTitleRecord[A](record: Record[A], title: String): Record[A]
- Definition Classes
- NoDocsJsonSchemas → JsonSchemas
-
def
withTitleTagged[A](tagged: Tagged[A], title: String): Tagged[A]
- Definition Classes
- NoDocsJsonSchemas → JsonSchemas
-
def
zipRecords[A, B](recordA: Record[A], recordB: Record[B])(implicit t: Tupler[A, B]): Record[Out]
- Definition Classes
- JsonSchemas → JsonSchemas
-
object
EndpointDocs extends Serializable
- Definition Classes
- EndpointsWithCustomErrors