camundala-api/camundala.api/APICreator

APICreator

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

Value members

Abstract methods

def title: String
def version: String

Concrete methods

def apiEndpoints(apiEP: ApiEndpoints*): Unit
def contact: Option[Contact]
def createChangeLog(): String
def createReadme(): String
def description: Option[String]
def info(title: String): Info
def openApi(apiEP: Seq[ApiEndpoints]): OpenAPI
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
final
def main(args: Array[String]): Unit
Inherited from
App

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

Extensions

Extensions

extension [In <: Product, Out <: Product](dmn: DecisionDmn[In, Out])
def endpoint(implicit evidence$13: Encoder[In], evidence$14: Decoder[In], evidence$15: Schema[In], evidence$16: Encoder[Out], evidence$17: Decoder[Out], evidence$18: Schema[Out]): ApiEndpoint[In, Out, EvaluateDecision[In, Out]]
extension [In <: Product, Out <: Product, T <: InOut[In, Out, LazyRef(...)]](process: Process[In, Out])
def endpoints(activities: ApiEndpoint[_, _, _]*)(implicit evidence$1: Encoder[In], evidence$2: Decoder[In], evidence$3: Schema[In], evidence$4: Encoder[Out], evidence$5: Decoder[Out], evidence$6: Schema[Out]): ApiEndpoints
extension [In <: Product, Out <: Product](userTask: UserTask[In, Out])
def endpoint(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]): ApiEndpoint[In, Out, UserTaskEndpoint[In, Out]]

Implicits

Implicits

implicit
def tenantId: Option[String]