endpoints.documented.delegate

JsonSchemaEntities

trait JsonSchemaEntities extends algebra.JsonSchemaEntities with Endpoints

Interpreter for algebra.JsonSchemaEntities that ignores information related to documentation and delegates to another endpoints.algebra.JsonEntitiesFromCodec interpreter.

Source
JsonSchemaEntities.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. JsonSchemaEntities
  2. Endpoints
  3. Responses
  4. Requests
  5. Methods
  6. Urls
  7. JsonSchemaEntities
  8. JsonSchemas
  9. JsonEntities
  10. Endpoints
  11. Responses
  12. Requests
  13. Methods
  14. Urls
  15. AnyRef
  16. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type Endpoint[A, B] = algebra.JsonEntitiesFromCodec.Endpoint[A, B]

    Information carried by an HTTP endpoint

    Information carried by an HTTP endpoint

    Definition Classes
    EndpointsEndpoints
  2. type JsonRequest[A] = JsonSchema[A]

    Type class defining how to represent the A information as a JSON request entity

    Type class defining how to represent the A information as a JSON request entity

    Definition Classes
    JsonSchemaEntitiesJsonEntities
  3. type JsonResponse[A] = JsonSchema[A]

    Type class defining how to represent the A information as a JSON response entity

    Type class defining how to represent the A information as a JSON response entity

    Definition Classes
    JsonSchemaEntitiesJsonEntities
  4. abstract type JsonSchema[A]

    Definition Classes
    JsonSchemas
  5. implicit final class JsonSchemaOps[A] extends AnyRef

    Definition Classes
    JsonSchemas
  6. type Method = algebra.JsonEntitiesFromCodec.Method

    Definition Classes
    Methods → Methods
  7. type Path[A] = algebra.JsonEntitiesFromCodec.Path[A]

    An URL path carrying an A information

    An URL path carrying an A information

    Definition Classes
    UrlsUrls
  8. implicit class PathOps[A] extends AnyRef

    Convenient methods for Paths.

  9. type QueryString[A] = algebra.JsonEntitiesFromCodec.QueryString[A]

    A query string carrying an A information

    A query string carrying an A information

    Definition Classes
    UrlsUrls
  10. implicit class QueryStringOps[A] extends AnyRef

    Provides convenient methods on QueryString.

  11. type QueryStringParam[A] = algebra.JsonEntitiesFromCodec.QueryStringParam[A]

    A single query string parameter carrying an A information.

    A single query string parameter carrying an A information.

    Definition Classes
    UrlsUrls
  12. abstract type Record[A] <: JsonSchema[A]

    Definition Classes
    JsonSchemas
  13. implicit final class RecordOps[A] extends AnyRef

    Definition Classes
    JsonSchemas
  14. type Request[A] = algebra.JsonEntitiesFromCodec.Request[A]

    Information carried by a whole request (headers and entity)

    Information carried by a whole request (headers and entity)

    Definition Classes
    RequestsRequests
  15. type RequestEntity[A] = algebra.JsonEntitiesFromCodec.RequestEntity[A]

    Information carried by request entity

    Information carried by request entity

    Definition Classes
    RequestsRequests
  16. type RequestHeaders[A] = algebra.JsonEntitiesFromCodec.RequestHeaders[A]

    Information carried by requests’ headers

    Information carried by requests’ headers

    Definition Classes
    RequestsRequests
  17. type Response[A] = algebra.JsonEntitiesFromCodec.Response[A]

    Information carried by a response

    Information carried by a response

    Definition Classes
    ResponsesResponses
  18. type Segment[A] = algebra.JsonEntitiesFromCodec.Segment[A]

    An URL path segment carrying an A information.

    An URL path segment carrying an A information.

    Definition Classes
    UrlsUrls
  19. abstract type Tagged[A] <: JsonSchema[A]

    Definition Classes
    JsonSchemas
  20. implicit final class TaggedOps[A] extends AnyRef

    Definition Classes
    JsonSchemas
  21. type Url[A] = algebra.JsonEntitiesFromCodec.Url[A]

    An URL carrying an A information

    An URL carrying an A information

    Definition Classes
    UrlsUrls

Abstract Value Members

  1. implicit abstract def arrayJsonSchema[C[X] <: Seq[X], A](implicit jsonSchema: JsonSchema[A], cbf: CanBuildFrom[_, A, C[A]]): JsonSchema[C[A]]

    Definition Classes
    JsonSchemas
  2. implicit abstract def bigdecimalJsonSchema: JsonSchema[BigDecimal]

    Definition Classes
    JsonSchemas
  3. implicit abstract def booleanJsonSchema: JsonSchema[Boolean]

    Definition Classes
    JsonSchemas
  4. abstract def choiceTagged[A, B](taggedA: Tagged[A], taggedB: Tagged[B]): Tagged[Either[A, B]]

    Definition Classes
    JsonSchemas
  5. abstract val delegate: JsonEntitiesFromCodec

    Definition Classes
    JsonSchemaEntitiesEndpointsResponsesRequestsMethodsUrls
  6. implicit abstract def doubleJsonSchema: JsonSchema[Double]

    Definition Classes
    JsonSchemas
  7. abstract def field[A](name: String, documentation: Option[String])(implicit tpe: JsonSchema[A]): Record[A]

    Definition Classes
    JsonSchemas
  8. implicit abstract def intJsonSchema: JsonSchema[Int]

    Definition Classes
    JsonSchemas
  9. abstract def invmapJsonSchema[A, B](jsonSchema: JsonSchema[A], f: (A) ⇒ B, g: (B) ⇒ A): JsonSchema[B]

    Definition Classes
    JsonSchemas
  10. abstract def invmapRecord[A, B](record: Record[A], f: (A) ⇒ B, g: (B) ⇒ A): Record[B]

    Definition Classes
    JsonSchemas
  11. abstract def invmapTagged[A, B](taggedA: Tagged[A], f: (A) ⇒ B, g: (B) ⇒ A): Tagged[B]

    Definition Classes
    JsonSchemas
  12. implicit abstract def jsonSchemaToDelegateJsonCodec[A](implicit arg0: JsonSchema[A]): JsonCodec[A]

  13. implicit abstract def longJsonSchema: JsonSchema[Long]

    Definition Classes
    JsonSchemas
  14. abstract def optField[A](name: String, documentation: Option[String])(implicit tpe: JsonSchema[A]): Record[Option[A]]

    Definition Classes
    JsonSchemas
  15. implicit abstract def stringJsonSchema: JsonSchema[String]

    Definition Classes
    JsonSchemas
  16. abstract def taggedRecord[A](recordA: Record[A], tag: String): Tagged[A]

    Definition Classes
    JsonSchemas
  17. abstract def zipRecords[A, B](recordA: Record[A], recordB: Record[B]): Record[(A, B)]

    Definition Classes
    JsonSchemas

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  3. final def ##(): Int

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

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

    Definition Classes
    Any
  6. def Delete: Method

    Definition Classes
    Methods → Methods
  7. def Get: Method

    Definition Classes
    Methods → Methods
  8. def Patch: Method

    Definition Classes
    Methods → Methods
  9. def Post: Method

    Definition Classes
    Methods → Methods
  10. def Put: Method

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

    Definition Classes
    Any
  12. 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
    UrlsUrls
  13. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  14. 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
    UrlsUrls
  15. def emptyHeaders: RequestHeaders[Unit]

    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
    RequestsRequests
  16. def emptyRequest: RequestEntity[Unit]

    Empty request.

    Empty request.

    Definition Classes
    RequestsRequests
  17. def emptyResponse(documentation: String): Response[Unit]

    Empty response.

    Empty response.

    Definition Classes
    ResponsesResponses
  18. def endpoint[A, B](request: Request[A], response: Response[B]): Endpoint[A, B]

    HTTP endpoint.

    HTTP endpoint.

    request

    Request

    response

    Response

    Definition Classes
    EndpointsEndpoints
  19. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  21. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. 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
  23. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  24. def hashCode(): Int

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

    Ability to define Int query string parameters

    Ability to define Int query string parameters

    Definition Classes
    UrlsUrls
  26. implicit def intSegment: Segment[Int]

    Ability to define Int path segments

    Ability to define Int path segments

    Definition Classes
    UrlsUrls
  27. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  28. def jsonRequest[A](documentation: Option[String])(implicit arg0: JsonSchema[A]): algebra.JsonEntitiesFromCodec.RequestEntity[A]

    Defines a RequestEntity[A] given an implicit JsonRequest[A]

    Defines a RequestEntity[A] given an implicit JsonRequest[A]

    Definition Classes
    JsonSchemaEntitiesJsonEntities
  29. def jsonResponse[A](documentation: String)(implicit arg0: JsonSchema[A]): algebra.JsonEntitiesFromCodec.Response[A]

    Defines a Response[A] given an implicit JsonResponse[A]

    Defines a Response[A] given an implicit JsonResponse[A]

    Definition Classes
    JsonSchemaEntitiesJsonEntities
  30. def longQueryString: QueryStringParam[Long]

    Query string parameter containing a Long value

    Query string parameter containing a Long value

    Definition Classes
    UrlsUrls
  31. implicit def longSegment: Segment[Long]

    Segment containing a Long value

    Segment containing a Long value

    Definition Classes
    UrlsUrls
  32. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  33. final def notify(): Unit

    Definition Classes
    AnyRef
  34. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  35. 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
    UrlsUrls
  36. 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
  37. 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
  38. 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
    UrlsUrls
  39. 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
    RequestsRequests
  40. def segment[A](name: String)(implicit s: 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
    UrlsUrls
  41. def staticPathSegment(segment: String): Path[Unit]

    Builds a static path segment

    Builds a static path segment

    Definition Classes
    UrlsUrls
  42. implicit def stringQueryString: QueryStringParam[String]

    Ability to define String query string parameters

    Ability to define String query string parameters

    Definition Classes
    UrlsUrls
  43. implicit def stringSegment: Segment[String]

    Ability to define String path segments

    Ability to define String path segments

    Definition Classes
    UrlsUrls
  44. final def synchronized[T0](arg0: ⇒ T0): T0

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

    Text response.

    Text response.

    Definition Classes
    ResponsesResponses
  46. def toString(): String

    Definition Classes
    AnyRef → Any
  47. 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
    UrlsUrls
  48. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Endpoints

Inherited from Responses

Inherited from Requests

Inherited from Methods

Inherited from Urls

Inherited from JsonSchemas

Inherited from algebra.JsonEntities

Inherited from algebra.Endpoints

Inherited from algebra.Responses

Inherited from algebra.Requests

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from AnyRef

Inherited from Any

Ungrouped