camundala-api/camundala.api/APICreator

APICreator

trait APICreator extends ProcessReferenceCreator with App
trait App
trait DelayedInit
class Object
trait Matchable
class Any

Type members

Inherited classlikes

class UsesRef(processRef: String, serviceName: Option[String])

Value members

Abstract methods

def title: String
def version: String

Concrete methods

def apiEndpoints(apiEP: Seq[ApiEndpoints[_, _]] | ApiEndpoints[_, _]*): Unit
def basePath: Path
def cawemoFolder: Option[String]
def contact: Option[Contact]
def createChangeLog(): String
def createReadme(): String
def description: Option[String]
def info(title: String): Info
def jiraUrls: Map[String, String]
def openApi(apiEP: Seq[ApiEndpoints[_, _]]): OpenAPI
def openApiDocuPath: Path
def openApiPath: Path
def postmanOpenApi(apiEP: Seq[ApiEndpoints[_, _]]): OpenAPI
def serverPort: Int
def servers: List[Server]
def writeOpenApi(path: Path, api: OpenAPI): Unit

Inherited methods

final protected def args: Array[String]
Inherited from:
App
protected def docProjectUrl(project: String): String
def docUsedByReference(processName: String): String
def docUsesReference(processName: String): String
protected def docuPath(projectPath: Path, path: Path, content: String): (String, String)
protected def findBpmn(processName: String): Option[String]
protected def findBpmnFor(processName: String): Seq[(String, Seq[(String, String)])]
final def main(args: Array[String]): Unit
Inherited from:
App
def projectName: String
protected def projectPaths: Seq[Path]
protected def usedByTitle(processCount: Int): String
protected def usesTitle(processCount: Int): String

Deprecated and Inherited methods

@deprecated(message = "the delayedInit mechanism will disappear", since = "2.11.0")
override def delayedInit(body: => Unit): Unit
Deprecated
[Since version 2.11.0] the delayedInit mechanism will disappear
Definition Classes
App -> DelayedInit
Inherited from:
App

Concrete fields

lazy val openAPIDocsInterpreter: OpenAPIDocsInterpreter

Inherited fields

lazy protected val allBpmns: Seq[(Path, Seq[(Path, String)])]

Extensions

Extensions

extension [In <: Product, Out <: Product](dmn: DecisionDmn[In, Out])
def endpoint(implicit evidence$145: Encoder[In], evidence$146: Decoder[In], evidence$147: Schema[In], evidence$148: ClassTag[In], evidence$149: Encoder[Out], evidence$150: Decoder[Out], evidence$151: Schema[Out], evidence$152: ClassTag[Out]): ApiEndpoint[In, EvaluateDecisionIn, Out, EvaluateDecision[In, Out]]
extension [In <: Product](event: ReceiveSignalEvent[In])
def endpoint(implicit evidence$165: Encoder[In], evidence$166: Decoder[In], evidence$167: Schema[In], evidence$168: ClassTag[In]): ApiEndpoint[In, SendSignalIn, NoOutput, SendSignal[In]]
extension [In <: Product](event: ReceiveMessageEvent[In])
def endpoint(implicit evidence$157: Encoder[In], evidence$158: Decoder[In], evidence$159: Schema[In], evidence$160: ClassTag[In]): ApiEndpoint[In, CorrelateMessageIn, NoOutput, CorrelateMessage[In]]
extension [In <: Product, Out <: Product](process: Process[In, Out])
def endpoint(tag: String)(implicit evidence$73: Encoder[In], evidence$74: Decoder[In], evidence$75: Schema[In], evidence$76: ClassTag[In], evidence$77: Encoder[Out], evidence$78: Decoder[Out], evidence$79: Schema[Out], evidence$80: ClassTag[Out]): ApiEndpoints[In, Out]
def endpoint(tag: String, processName: String)(implicit evidence$81: Encoder[In], evidence$82: Decoder[In], evidence$83: Schema[In], evidence$84: ClassTag[In], evidence$85: Encoder[Out], evidence$86: Decoder[Out], evidence$87: Schema[Out], evidence$88: ClassTag[Out]): ApiEndpoints[In, Out]
def endpoint(implicit evidence$89: Encoder[In], evidence$90: Decoder[In], evidence$91: Schema[In], evidence$92: ClassTag[In], evidence$93: Encoder[Out], evidence$94: Decoder[Out], evidence$95: Schema[Out], evidence$96: ClassTag[Out]): ApiEndpoints[In, Out]
def endpoints(activities: ApiEndpoint[_, _, _, _]*)(implicit evidence$97: Encoder[In], evidence$98: Decoder[In], evidence$99: Schema[In], evidence$100: ClassTag[In], evidence$101: Encoder[Out], evidence$102: Decoder[Out], evidence$103: Schema[Out], evidence$104: ClassTag[Out]): ApiEndpoints[In, Out]
def endpoints(tag: String, processName: String)(activities: ApiEndpoint[_, _, _, _]*)(implicit evidence$105: Encoder[In], evidence$106: Decoder[In], evidence$107: Schema[In], evidence$108: ClassTag[In], evidence$109: Encoder[Out], evidence$110: Decoder[Out], evidence$111: Schema[Out], evidence$112: ClassTag[Out]): ApiEndpoints[In, Out]
def endpoints(activities: Seq[ApiEndpoint[_, _, _, _]], tag: String, processName: String)(implicit evidence$113: Encoder[In], evidence$114: Decoder[In], evidence$115: Schema[In], evidence$116: ClassTag[In], evidence$117: Encoder[Out], evidence$118: Decoder[Out], evidence$119: Schema[Out], evidence$120: ClassTag[Out]): ApiEndpoints[In, Out]
extension [In <: Product, Out <: Product](processes: Map[String, Process[In, Out]])
def endpoint(implicit evidence$17: Encoder[In], evidence$18: Decoder[In], evidence$19: Schema[In], evidence$20: ClassTag[In], evidence$21: Encoder[Out], evidence$22: Decoder[Out], evidence$23: Schema[Out], evidence$24: ClassTag[Out]): ApiEndpoints[In, Out]
def endpoint(tag: String)(implicit evidence$25: Encoder[In], evidence$26: Decoder[In], evidence$27: Schema[In], evidence$28: ClassTag[In], evidence$29: Encoder[Out], evidence$30: Decoder[Out], evidence$31: Schema[Out], evidence$32: ClassTag[Out]): ApiEndpoints[In, Out]
def endpoint(tag: String, processName: String)(implicit evidence$33: Encoder[In], evidence$34: Decoder[In], evidence$35: Schema[In], evidence$36: ClassTag[In], evidence$37: Encoder[Out], evidence$38: Decoder[Out], evidence$39: Schema[Out], evidence$40: ClassTag[Out]): ApiEndpoints[In, Out]
def endpoints(activities: ApiEndpoint[_, _, _, _]*)(implicit evidence$41: Encoder[In], evidence$42: Decoder[In], evidence$43: Schema[In], evidence$44: ClassTag[In], evidence$45: Encoder[Out], evidence$46: Decoder[Out], evidence$47: Schema[Out], evidence$48: ClassTag[Out]): ApiEndpoints[In, Out]
def endpoints(tag: String, processName: String)(activities: ApiEndpoint[_, _, _, _]*)(implicit evidence$49: Encoder[In], evidence$50: Decoder[In], evidence$51: Schema[In], evidence$52: ClassTag[In], evidence$53: Encoder[Out], evidence$54: Decoder[Out], evidence$55: Schema[Out], evidence$56: ClassTag[Out]): ApiEndpoints[In, Out]
def endpoints(tag: Option[String], processName: Option[String], activities: ApiEndpoint[_, _, _, _]*)(implicit evidence$57: Encoder[In], evidence$58: Decoder[In], evidence$59: Schema[In], evidence$60: ClassTag[In], evidence$61: Encoder[Out], evidence$62: Decoder[Out], evidence$63: Schema[Out], evidence$64: ClassTag[Out]): ApiEndpoints[In, Out]
extension [In <: Product, Out <: Product](userTask: UserTask[In, Out])
def endpoint(implicit evidence$129: Encoder[In], evidence$130: Decoder[In], evidence$131: Schema[In], evidence$132: ClassTag[In], evidence$133: Encoder[Out], evidence$134: Decoder[Out], evidence$135: Schema[Out], evidence$136: ClassTag[Out]): ApiEndpoint[In, NoInput, Out, UserTaskEndpoint[In, Out]]

Implicits

Implicits

implicit def tenantId: Option[String]
implicit def toEndpoint[In <: Product : Encoder, Out <: Product : Schema](processes: Map[String, Process[In, Out]]): ApiEndpoints[In, Out]
implicit inline def toEndpoint[In <: Product : ClassTag, Out <: Product : ClassTag](inline processes: Seq[Process[In, Out]]): ApiEndpoints[In, Out]
implicit def toEndpoint[In <: Product : Decoder, Out <: Product : Schema](process: Process[In, Out]): ApiEndpoints[In, Out]
implicit def toEndpoint[In <: Product : Encoder, Out <: Product : ClassTag](userTask: UserTask[In, Out]): ApiEndpoint[In, NoInput, Out, UserTaskEndpoint[In, Out]]
implicit def toEndpoint[In <: Product : Encoder, Out <: Product : Encoder](dmn: DecisionDmn[In, Out]): ApiEndpoint[In, EvaluateDecisionIn, Out, EvaluateDecision[In, Out]]
implicit def toEndpoint[In <: Product : ClassTag](event: ReceiveMessageEvent[In]): ApiEndpoint[In, CorrelateMessageIn, NoOutput, CorrelateMessage[In]]
implicit def toEndpoint[In <: Product : ClassTag](event: ReceiveSignalEvent[In]): ApiEndpoint[In, SendSignalIn, NoOutput, SendSignal[In]]