camundala-api/camundala.api/endpoints/ApiEndpoint

ApiEndpoint

sealed
trait ApiEndpoint[In <: Product, Out <: Product, T <: ApiEndpoint[In, Out, T]](implicit evidence$7: Encoder[In], evidence$8: Decoder[In], evidence$9: Schema[In], evidence$10: Encoder[Out], evidence$11: Decoder[Out], evidence$12: Schema[Out]) extends Product
trait Product
trait Equals
class Object
trait Matchable
class Any
class CompleteTask[In]
class EvaluateDecision[In, Out]
class StartProcessInstance[In, Out]
class UserTaskEndpoint[In, Out]

Value members

Abstract methods

def apiName: String
def createPostman()(implicit tenantId: Option[String]): Seq[Endpoint[_, _, _, _]]
protected
def inMapper(): Option[EndpointInput[_]]
protected
def outMapper(): Option[EndpointOutput[_]]
def restApi: CamundaRestApi[In, Out]
def withRestApi(restApi: CamundaRestApi[In, Out]): T

Concrete methods

def baseEndpoint: Endpoint[_, _, _, _]
def create(): Seq[Endpoint[_, _, _, _]]
def descr: String
def withDescr(description: String): T
def withInExample(label: String, example: In): T
def withName(n: String): T
def withOutExample(label: String, example: Out): T
def withTag(t: String): T

Inherited methods

def canEqual(that: Any): Boolean
Inherited from
Equals
def productArity: Int
Inherited from
Product
def productElement(n: Int): Any
Inherited from
Product
def productElementName(n: Int): String
Inherited from
Product
def productElementNames: Iterator[String]
Inherited from
Product
def productIterator: Iterator[Any]
Inherited from
Product
def productPrefix: String
Inherited from
Product

Concrete fields

lazy
val docName: String
lazy
val inExample: In
lazy
val outExample: Out
lazy
val postmanName: String
lazy
val tag: String
lazy
val valueName: String