camundala-api/camundala.api/ApiCreator

ApiCreator

trait ApiCreator extends ApiDsl with PostmanApiCreator with TapirApiCreator with App
trait App
trait DelayedInit
trait ApiDsl
class Object
trait Matchable
class Any

Type members

Inherited classlikes

class ApiBuilder
Inherited from:
ApiDsl
case class UsedByReferenceCreator(processName: String)
case class UsesReferenceCreator(processName: String)

Inherited types

type ApiConstr = ApiBuilder => Unit
Inherited from:
ApiDsl

Value members

Concrete methods

protected def createChangeLog(): String
protected def createReadme(): String
protected def description: Option[String]
def document(body: ApiConstr): Unit
protected def openApi(apiDoc: ApiDoc): OpenAPI
protected def postmanDescription: Option[String]
protected def postmanOpenApi(apiDoc: ApiDoc): OpenAPI
protected def replaceJira(line: String, jiraUrls: Map[String, String]): String
protected def toOpenApi(apiDoc: ApiDoc): Unit

Inherited methods

def api[In <: Product : Encoder, Out <: Product : ClassTag](pApi: ProcessApi[In, Out])(body: CApi*): ApiConstr
Inherited from:
ApiDsl
def api[In <: Product : Encoder, Out <: Product : ClassTag](pApi: ProcessApi[In, Out]): ApiConstr
Inherited from:
ApiDsl
protected def apiConfig: ApiConfig
Inherited from:
AbstractApiCreator
final protected def args: Array[String]
Inherited from:
App
protected def basePath: Path
Inherited from:
AbstractApiCreator
protected def create(apiDoc: ApiDoc): Seq[Endpoint[Unit, _, Unit, _, Any]]
Inherited from:
TapirApiCreator
protected def createPostman(apiDoc: ApiDoc): Seq[Endpoint[Unit, _, Unit, _, Any]]
Inherited from:
PostmanApiCreator
protected def createPostmanForDecisionDmn(api: ActivityApi[_, _], tag: String): Seq[Endpoint[Unit, _, Unit, _, Any]]
Inherited from:
PostmanApiCreator
protected def createPostmanForProcess(api: ProcessApi[_, _], tag: String): Seq[Endpoint[Unit, _, Unit, _, Any]]
Inherited from:
PostmanApiCreator
protected def createPostmanForReceiveMessageEvent(api: ActivityApi[_, _], tag: String): Seq[Endpoint[Unit, _, Unit, _, Any]]
Inherited from:
PostmanApiCreator
protected def createPostmanForReceiveSignalEvent(api: ActivityApi[_, _], tag: String): Seq[Endpoint[Unit, _, Unit, _, Any]]
Inherited from:
PostmanApiCreator
protected def createPostmanForUserTask(api: ActivityApi[_, _], tag: String): Seq[Endpoint[Unit, _, Unit, _, Any]]
Inherited from:
PostmanApiCreator
def group(name: String)(apis: GroupedApi*): ApiConstr
Inherited from:
ApiDsl
protected def info(title: String, description: Option[String]): Info
Inherited from:
AbstractApiCreator
final def main(args: Array[String]): Unit
Inherited from:
App
protected def projectName: String
protected def servers: List[Server]
Inherited from:
AbstractApiCreator
protected def title: String
Inherited from:
AbstractApiCreator
protected def version: String
Inherited from:
AbstractApiCreator

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 protected val openAPIDocsInterpreter: OpenAPIDocsInterpreter

Extensions

Inherited extensions

extension (api: ActivityApi[_, _])
def completeTask(tag: String): Endpoint[Unit, _, Unit, _, Any]
Inherited from:
PostmanApiCreator
def correlateMessage(tag: String): Endpoint[Unit, _, Unit, _, Any]
Inherited from:
PostmanApiCreator
def evaluateDecision(tag: String): Endpoint[Unit, _, Unit, _, Any]
Inherited from:
PostmanApiCreator
def getActiveTask(tag: String): Endpoint[Unit, _, Unit, _, Any]
Inherited from:
PostmanApiCreator
def getTaskFormVariables(tag: String): Endpoint[Unit, _, Unit, _, Any]
Inherited from:
PostmanApiCreator
def sendSignal(tag: String): Endpoint[Unit, _, Unit, _, Any]
Inherited from:
PostmanApiCreator
extension (cApi: CApi)
def create(tag: String): Seq[Endpoint[Unit, _, Unit, _, Any]]
Inherited from:
TapirApiCreator
extension (cApi: CApi)
def createPostman(tag: String): Seq[Endpoint[Unit, _, Unit, _, Any]]
Inherited from:
PostmanApiCreator
extension (groupedApi: GroupedApi)
def create(): Seq[Endpoint[Unit, _, Unit, _, Any]]
Inherited from:
TapirApiCreator
extension (groupedApi: GroupedApi)
def createPostman(): Seq[Endpoint[Unit, _, Unit, _, Any]]
Inherited from:
PostmanApiCreator
extension (inOutApi: InOutApi[_, _])
def createEndpoint(tag: String, additionalDescr: Option[String]): Seq[Endpoint[Unit, _, Unit, _, Any]]
Inherited from:
TapirApiCreator
extension (inOutApi: InOutApi[_, _])
def toPostmanInput[T <: Product : Schema](wrapper: FormVariables => T, examples: Seq[InOutExample[_]]): Option[EndpointInput[T]]
Inherited from:
PostmanApiCreator
extension [In <: Product, Out <: Product, T <: InOutApi[In, Out]](inOutApi: T)
def withExample(label: String, example: InOut[In, Out, _])(implicit evidence$50: Encoder[In], evidence$51: Decoder[In], evidence$52: Schema[In], evidence$53: Encoder[Out], evidence$54: Decoder[Out], evidence$55: Schema[Out], evidence$56: ClassTag[Out]): T
Inherited from:
ApiDsl
inline def withExample(inline example: InOut[In, Out, _])(implicit evidence$29: Encoder[In], evidence$30: Decoder[In], evidence$31: Schema[In], evidence$32: Encoder[Out], evidence$33: Decoder[Out], evidence$34: Schema[Out], evidence$35: ClassTag[Out]): T
Inherited from:
ApiDsl
def withInExample(label: String, example: In)(implicit evidence$57: Encoder[In], evidence$58: Decoder[In], evidence$59: Schema[In], evidence$60: Encoder[Out], evidence$61: Decoder[Out], evidence$62: Schema[Out], evidence$63: ClassTag[Out]): T
Inherited from:
ApiDsl
inline def withInExample(inline example: In)(implicit evidence$36: Encoder[In], evidence$37: Decoder[In], evidence$38: Schema[In], evidence$39: Encoder[Out], evidence$40: Decoder[Out], evidence$41: Schema[Out], evidence$42: ClassTag[Out]): T
Inherited from:
ApiDsl
def withOutExample(label: String, example: Out)(implicit evidence$64: Encoder[In], evidence$65: Decoder[In], evidence$66: Schema[In], evidence$67: Encoder[Out], evidence$68: Decoder[Out], evidence$69: Schema[Out], evidence$70: ClassTag[Out]): T
Inherited from:
ApiDsl
inline def withOutExample(inline example: Out)(implicit evidence$43: Encoder[In], evidence$44: Decoder[In], evidence$45: Schema[In], evidence$46: Encoder[Out], evidence$47: Decoder[Out], evidence$48: Schema[Out], evidence$49: ClassTag[Out]): T
Inherited from:
ApiDsl
extension (pa: ProcessApi[_, _])
def additionalDescr: Option[String]
Inherited from:
TapirApiCreator
def processName: String
Inherited from:
TapirApiCreator
extension (process: ProcessApi[_, _])
def startProcess(tag: String): Endpoint[Unit, _, Unit, _, Any]
Inherited from:
PostmanApiCreator

Implicits

Inherited implicits

implicit protected def tenantId: Option[String]
Inherited from:
AbstractApiCreator
implicit inline def toApi[In <: Product : Encoder, Out <: Product : Schema](inline inOut: Activity[In, Out, _]): ActivityApi[In, Out]
Inherited from:
ApiDsl
implicit inline def toApi[In <: Product : Decoder, Out <: Product : Schema](inline process: Process[In, Out]): ProcessApi[In, Out]
Inherited from:
ApiDsl