harness-endpoint
API
Generated with
harness-endpoint/harness.endpoint/harness.endpoint.spec

harness.endpoint.spec

package harness.endpoint.spec

Members list

Type members

Classlikes

sealed trait BodyCodec[B <: BodyType]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Encoded[O]
object None.type
object Stream.type
object BodyCodec

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
BodyCodec.type
final case class CookieSchema(requirement: SchemaRequirement, key: String, schema: Schema[_]) extends GenericHeaderSchema

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class EndpointSpec[ET <: Any](method: HttpMethod, name: String, classification: Classification, description: Option[String], group: Option[String], pathCodec: PathCodec[Path[ET]], queryCodec: QueryCodec[Query[ET]], authHeaderCodec: HeaderCodec[Auth[ET]], headerCodec: HeaderCodec[Header[ET]], inputBodyCodec: BodyCodec[InputBody[ET]], outputBodyCodec: BodyCodec[OutputBody[ET]], errorCodec: ErrorSchema[Error[ET]])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
object EndpointSpec

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait ErrorSchema[A]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ForProduct[A]
class ForSum[A]
object ErrorSchema extends Derivable[ErrorSchema]

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
trait Derivable[ErrorSchema]
class Object
trait Matchable
class Any
Show all
Self type
sealed abstract class GenericHeaderSchema(source: SchemaSource) extends NonPathSchema

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class CookieSchema
class HeaderSchema
trait HeaderCodec[A]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class And[A, B, O]
object Empty.type
class IMap[A, B]
class IMapDecode[A, B]
trait Many[A]
class HeaderMany[A]
trait ManyNonEmpty[A]
class OneOf[A]
trait Optional[A]
class CookieOptional[A]
class HeaderOptional[A]
trait Required[A]
class CookieRequired[A]
class HeaderRequired[A]
trait WithKey[A, B]
trait CookieWithKey[A, B]
trait HeaderOrCookieWithKey[A, B]
trait HeaderWithKey[A, B]
Show all
Self type
object HeaderCodec

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
final case class HeaderOrCookieSchema(requirement: SchemaRequirement, key: String, schema: Schema[_]) extends GenericHeaderSchema

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class HeaderSchema(requirement: SchemaRequirement, key: String, schema: Schema[_]) extends GenericHeaderSchema

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed abstract class NonPathSchema(val source: SchemaSource)

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class CookieSchema
class HeaderSchema
class QuerySchema
sealed trait PathCodec[A]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Const
object Empty.type
class IMap[A, B]
class IMapDecode[A, B]
class OneOf[A]
class Param[A]
class Rest
class RestNonEmpty
class Then[A, B, O]
Show all
Self type
object PathCodec

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
PathCodec.type
sealed trait PathSchema

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Const
class Param
class Rest
class RestNel
object PathSchema

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
PathSchema.type
trait QueryCodec[A]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class And[A, B, O]
object Empty.type
class IMap[A, B]
class IMapDecode[A, B]
class OneOf[A]
trait WithKey[A, B]
class Many[A]
class ManyNonEmpty[A]
class Optional[A]
class Required[A]
Show all
Self type
object QueryCodec

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
QueryCodec.type
final case class QuerySchema(requirement: SchemaRequirement, key: String, schema: Schema[_]) extends NonPathSchema

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
enum SchemaRequirement(val suffix: String) extends Enum[SchemaRequirement]

Attributes

Companion
object
Supertypes
trait Enum
trait Product
trait Equals
trait Enum[SchemaRequirement]
class Enum[SchemaRequirement]
trait Serializable
trait Comparable[SchemaRequirement]
trait Constable
class Object
trait Matchable
class Any
Show all
object SchemaRequirement extends Companion[SchemaRequirement]

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
trait Companion[SchemaRequirement]
class Object
trait Matchable
class Any
Show all
Self type
sealed abstract class SchemaSource(val show: String)

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Body.type
class Cookie
class Header
class Query
object SchemaSource

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class body[A](schema: Schema[A])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object body

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
body.type
final case class cookie[A](name: String, schema: Schema[A])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object cookie

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
cookie.type
final case class errorBody[A](schema: ErrorSchema[A])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object errorBody

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
errorBody.type
final case class errorCode(code: HttpCode) extends Annotation

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Annotation
class Object
trait Matchable
class Any
Show all
final case class errorExamples[A](ex0: A, exN: A*) extends Annotation

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Annotation
class Object
trait Matchable
class Any
Show all
final case class header[A](name: String, schema: Schema[A])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object header

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
header.type
final case class headerOrCookie[A](name: String, schema: Schema[A])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object headerOrCookie

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class path[A](name: String, schema: Schema[A])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object path

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
path.type
final case class pathRest(name: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class pathRestNonEmpty(name: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class query[A](name: String, schema: Schema[A])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object query

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
query.type

Implicits

Implicits

implicit def convertSpecBuilder[PathT, QueryT, AuthT, HeaderT, InputBodyT <: BodyType, OutputBodyT <: BodyType, ErrorT]: Conversion[Builder7[PathT, QueryT, AuthT, HeaderT, InputBodyT, OutputBodyT, ErrorT], EndpointSpec[EndpointType[PathT, QueryT, AuthT, HeaderT, InputBodyT, OutputBodyT, ErrorT]]]
Generated with