camundala-api/camundala.api/ApiEndpoint

ApiEndpoint

trait ApiEndpoint[In <: Product, PIn <: Product, Out <: Product, T <: ApiEndpoint[In, PIn, Out, T]](implicit evidence$15: Encoder[In], evidence$16: Decoder[In], evidence$17: Schema[In], evidence$18: Encoder[PIn], evidence$19: Decoder[PIn], evidence$20: Schema[PIn], evidence$21: Encoder[Out], evidence$22: Decoder[Out], evidence$23: Schema[Out], evidence$24: ClassTag[Out]) extends Product
trait Product
trait Equals
class Object
trait Matchable
class Any
class CompleteTask[In]
class EvaluateDecision[In, Out]
class SendSignal[In]
class StartProcessInstance[In, Out]
class UserTaskEndpoint[In, Out]

Value members

Abstract methods

def apiName: String
def createPostman()(using tenantId: Option[String]): Seq[Endpoint[Unit, _, Unit, Unit, Any]]
def endpointType: String
protected def inMapperPostman()(using tenantId: Option[String]): Option[EndpointInput[PIn]]
def outStatusCode: StatusCode
def restApi: CamundaRestApi[In, Out]
def withRestApi(restApi: CamundaRestApi[In, Out]): T

Concrete methods

def create(): Seq[Endpoint[Unit, _, Unit, _, Any]]
protected def definitionKeyPath(key: String): EndpointInput[String]
def descr: String
protected def inMapper(): Option[EndpointInput[In]]
protected def outMapper(): Option[EndpointOutput[Out]]
def postmanBaseEndpoint(using tenantId: Option[String]): Endpoint[Unit, _, Unit, Unit, Any]
protected def tenantIdPath(id: String): EndpointInput[String]
def withDescr(description: String): T
def withInExample(label: String, example: In): T
inline def withInExample(inline example: In): T
def withName(n: String): T
def withOutExample(label: String, example: Out): T
inline def withOutExample(inline 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 inExample: In
lazy val outExample: Out
lazy val postmanName: String
lazy val tag: String