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 BodySchema[B <: BodyType]

Attributes

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

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
BodySchema.type
final case class EndpointSpec[ET <: Any](method: HttpMethod, name: String, classification: Classification, description: Option[String], group: Option[String], inputWithCookiesCodec: NonBodyInputCodec[_, InputWithCookies[ET]], inputWithoutCookiesCodec: NonBodyInputCodec[_, InputWithoutCookies[ET]], inputBodyCodec: BodySchema[InputBody[ET]], outputBodyCodec: BodySchema[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
final case class NonBodyInputCodec[Path, All](encode: All => (List[String], Map[String, List[String]], Map[String, List[String]], Map[String, String]), decodePath: List[String] => Option[Path], decodeAll: (Path, Map[String, List[String]], Map[String, List[String]], Map[String, String]) => Result[All], pathSchemas: List[PathSchema], querySchemas: List[QuerySchema], headerSchemas: List[HeaderBasedSchema])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
NonBodyInputCodec[Path, All]
object NonBodyInputCodec

Attributes

Companion
class
Supertypes
trait Product
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 pathRestNel(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[Path, AllWithCookies, AllWithoutCookies, InputBody <: BodyType, OutputBody <: BodyType]: Conversion[Builder5[Path, AllWithCookies, AllWithoutCookies, InputBody, OutputBody], EndpointSpec[EndpointType[AllWithCookies, AllWithoutCookies, InputBody, OutputBody, ApiInternalDefect]]]
Generated with