camundala-api
API
Generated with
camundala-api/camundala.api/DefaultApiCreator

DefaultApiCreator

camundala.api.DefaultApiCreator
trait DefaultApiCreator extends ApiDsl, ApiCreator, CamundaPostmanApiCreator

Attributes

Graph
Supertypes
trait ApiCreator
trait App
trait DelayedInit
trait ApiDsl
trait ApiBaseDsl
class Object
trait Matchable
class Any
Show all

Members list

Type members

Inherited classlikes

case class UsedByReferenceCreator(refId: String)

Attributes

Inherited from:
ProcessReferenceCreator
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class UsesReferenceCreator(processName: String)

Attributes

Inherited from:
ProcessReferenceCreator
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Value members

Inherited methods

def api[In <: Product : Encoder, Out <: Product : ClassTag](pApi: ProcessApi[In, Out])(body: CApi*): ProcessApi[In, Out]

Attributes

Inherited from:
ApiBaseDsl
def api[In <: Product : Encoder, Out <: Product : ClassTag, T <: InOutApi[In, Out]](pApi: T): T

Attributes

Inherited from:
ApiBaseDsl
protected def apiConfig: ApiConfig

Attributes

Inherited from:
AbstractApiCreator
final protected def args: Array[String]

Attributes

Inherited from:
App
protected def basePath: Path

Attributes

Inherited from:
AbstractApiCreator
protected def create(apiDoc: ApiDoc): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
TapirApiCreator
protected def createChangeLog(): String

Attributes

Inherited from:
ApiCreator
def createGeneralVariable(key: InputParams, descr: String, scalaExample: String, jsonExample: String): String

Attributes

Inherited from:
ApiCreator
protected def createGeneralVariables(): String

Attributes

Inherited from:
ApiCreator
protected def createPostman(apiDoc: ApiDoc): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
PostmanApiCreator
protected def createPostmanForDecisionDmn(api: ActivityApi[_, _], tag: String): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
CamundaPostmanApiCreator
protected def createPostmanForMessageEvent(api: ActivityApi[_, _], tag: String): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
CamundaPostmanApiCreator
protected def createPostmanForProcess(api: ProcessApi[_, _], tag: String, isGroup: Boolean): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
CamundaPostmanApiCreator
protected def createPostmanForServiceProcess(api: ServiceProcessApi[_, _, _], tag: String): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
CamundaPostmanApiCreator
protected def createPostmanForSignalEvent(api: ActivityApi[_, _], tag: String): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
CamundaPostmanApiCreator
protected def createPostmanForTimerEvent(api: ActivityApi[_, _], tag: String): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
CamundaPostmanApiCreator
protected def createPostmanForUserTask(api: ActivityApi[_, _], tag: String): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
CamundaPostmanApiCreator
protected def createReadme(): String

Attributes

Inherited from:
ApiCreator
protected def definitionKeyPath(key: String): EndpointInput[String]

Attributes

Inherited from:
PostmanApiCreator
protected def description: Option[String]

Attributes

Inherited from:
ApiCreator
def document(apis: CApi*): Unit

Attributes

Inherited from:
ApiCreator
protected def gitBasePath: Path

Attributes

Inherited from:
ProcessReferenceCreator
def group(name: String)(apis: CApi*): CApiGroup

Attributes

Inherited from:
ApiBaseDsl
protected def info(title: String, description: Option[String]): Info

Attributes

Inherited from:
AbstractApiCreator
protected def jobIdPath(): PathCapture[String]

Attributes

Inherited from:
PostmanApiCreator
final def main(args: Array[String]): Unit

Attributes

Inherited from:
App
protected def nameOfVariable(inOut: InOut[_, _, _]): String

Attributes

Inherited from:
ApiDsl
protected def openApi(apiDoc: ApiDoc): OpenAPI

Attributes

Inherited from:
ApiCreator
protected def postmanDescription: Option[String]

Attributes

Inherited from:
ApiCreator
protected def postmanOpenApi(apiDoc: ApiDoc): OpenAPI

Attributes

Inherited from:
ApiCreator
protected def projectName: String

Attributes

Inherited from:
ProcessReferenceCreator
protected def replaceJira(line: String, jiraUrls: Map[String, String]): String

Attributes

Inherited from:
ApiCreator
protected def servers: List[Server]

Attributes

Inherited from:
AbstractApiCreator
def supportedVariables: Seq[InputParams]

Attributes

Inherited from:
ApiCreator
protected def taskIdPath(): PathCapture[String]

Attributes

Inherited from:
PostmanApiCreator
protected def tenantIdPath(id: String): EndpointInput[String]

Attributes

Inherited from:
PostmanApiCreator
protected def tenantIdPath(basePath: EndpointInput[_], pathElem: String): EndpointInput[_]

Attributes

Inherited from:
PostmanApiCreator
protected def title: String

Attributes

Inherited from:
AbstractApiCreator
protected def version: String

Attributes

Inherited from:
AbstractApiCreator

Deprecated and Inherited methods

override def delayedInit(body: => Unit): Unit

Attributes

Deprecated
[Since version 2.11.0] the delayedInit mechanism will disappear
Definition Classes
App -> DelayedInit
Inherited from:
App

Inherited fields

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

Attributes

Inherited from:
ProcessReferenceCreator
lazy protected val openAPIDocsInterpreter: OpenAPIDocsInterpreter

Attributes

Inherited from:
ApiCreator

Extensions

Inherited extensions

extension (api: ActivityApi[_, _])(api: ActivityApi[_, _])
def completeTask(tag: String): Endpoint[Unit, _, Unit, _, Any]

Attributes

Inherited from:
CamundaPostmanApiCreator
def correlateMessage(tag: String): Endpoint[Unit, _, Unit, _, Any]

Attributes

Inherited from:
CamundaPostmanApiCreator
def evaluateDecision(tag: String): Endpoint[Unit, _, Unit, _, Any]

Attributes

Inherited from:
CamundaPostmanApiCreator
def executeTimer(tag: String): Endpoint[Unit, _, Unit, _, Any]

Attributes

Inherited from:
CamundaPostmanApiCreator
def getActiveJob(tag: String): Endpoint[Unit, _, Unit, _, Any]

Attributes

Inherited from:
CamundaPostmanApiCreator
def getActiveTask(tag: String): Endpoint[Unit, _, Unit, _, Any]

Attributes

Inherited from:
CamundaPostmanApiCreator
def getTaskFormVariables(tag: String): Endpoint[Unit, _, Unit, _, Any]

Attributes

Inherited from:
CamundaPostmanApiCreator
def sendSignal(tag: String): Endpoint[Unit, _, Unit, _, Any]

Attributes

Inherited from:
CamundaPostmanApiCreator
extension (api: InOutApi[_, _])(api: InOutApi[_, _])
protected def postmanBaseEndpoint(tag: String, input: Option[EndpointInput[_]], label: String, descr: Option[String]): Endpoint[Unit, _, Unit, Unit, Any]

Attributes

Inherited from:
PostmanApiCreator
extension (cApi: CApi)(cApi: CApi)
def createPostman(): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
PostmanApiCreator
extension (cApi: CApi)(cApi: CApi)
def create(tag: String): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
TapirApiCreator
extension (cApi: CApi)(cApi: CApi)
def createPostman(tag: String, isGroup: Boolean): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
PostmanApiCreator
extension [In <: Product, Out <: Product, T <: DecisionDmnApi[In, Out]](decApi: T)(decApi: T)(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])
def withDiagramName(diagramName: String): DecisionDmnApi[In, Out]

Attributes

Inherited from:
ApiBaseDsl
extension (dmn: DecisionDmnApi[_, _])(dmn: DecisionDmnApi[_, _])
def additionalDescr: Option[String]

Attributes

Inherited from:
TapirApiCreator
extension (groupedApi: GroupedApi)(groupedApi: GroupedApi)
def create(): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
TapirApiCreator
extension (inOutApi: InOutApi[_, _])(inOutApi: InOutApi[_, _])
def endpointName: String

Attributes

Inherited from:
AbstractApiCreator
def endpointType: String

Attributes

Inherited from:
AbstractApiCreator
extension [In <: Product, Out <: Product, T <: InOutApi[In, Out]](inOutApi: T)(inOutApi: T)(implicit evidence$22: Encoder[In], evidence$23: Decoder[In], evidence$24: Schema[In], evidence$25: Encoder[Out], evidence$26: Decoder[Out], evidence$27: Schema[Out], evidence$28: ClassTag[Out])
inline def withInExample(inline example: In): T

Attributes

Inherited from:
ApiBaseDsl
extension [In <: Product, Out <: Product, T <: InOutApi[In, Out]](inOutApi: T)(inOutApi: T)(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])
def withExample(label: String, example: InOut[In, Out, _]): T

Attributes

Inherited from:
ApiBaseDsl
extension [In <: Product, Out <: Product, T <: InOutApi[In, Out]](inOutApi: T)(inOutApi: T)(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])
def withOutExample(label: String, example: Out): T

Attributes

Inherited from:
ApiBaseDsl
extension [In <: Product, Out <: Product, T <: InOutApi[In, Out]](inOutApi: T)(inOutApi: T)(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])
inline def withOutExample(inline example: Out): T

Attributes

Inherited from:
ApiBaseDsl
extension [In <: Product, Out <: Product, T <: InOutApi[In, Out]](inOutApi: T)(inOutApi: T)(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])
def withInExample(label: String, example: In): T

Attributes

Inherited from:
ApiBaseDsl
extension [In <: Product, Out <: Product, T <: InOutApi[In, Out]](inOutApi: T)(inOutApi: T)(implicit evidence$15: Encoder[In], evidence$16: Decoder[In], evidence$17: Schema[In], evidence$18: Encoder[Out], evidence$19: Decoder[Out], evidence$20: Schema[Out], evidence$21: ClassTag[Out])
inline def withExample(inline example: InOut[In, Out, _]): T

Attributes

Inherited from:
ApiBaseDsl
extension (inOutApi: InOutApi[_, _])(inOutApi: InOutApi[_, _])
def createEndpoint(tag: String, additionalDescr: Option[String]): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
TapirApiCreator
extension (inOutApi: InOutApi[_, _])(inOutApi: InOutApi[_, _])
protected def endpointPath(isGroup: Boolean): EndpointInput[Unit]

Attributes

Inherited from:
PostmanApiCreator
extension (inOutApi: InOutApi[_, _])(inOutApi: InOutApi[_, _])
def toPostmanInput[T <: Product : Schema](wrapper: FormVariables => T, examples: Seq[InOutExample[_]])(implicit evidence$1: Encoder[T], evidence$2: Decoder[T], evidence$3: Schema[T]): Option[EndpointInput[T]]

Attributes

Inherited from:
CamundaPostmanApiCreator
extension (pa: ProcessApi[_, _] | ServiceProcessApi[_, _, _])(pa: ProcessApi[_, _] | ServiceProcessApi[_, _, _])
def additionalDescr: Option[String]

Attributes

Inherited from:
TapirApiCreator
def processName: String

Attributes

Inherited from:
TapirApiCreator
extension (process: ProcessApi[_, _] | ServiceProcessApi[_, _, _])(process: ProcessApi[_, _] | ServiceProcessApi[_, _, _])
def startProcess(tag: String, isGroup: Boolean): Endpoint[Unit, _, Unit, _, Any]

Attributes

Inherited from:
CamundaPostmanApiCreator
extension [In <: Product, Out <: Product, T <: ProcessApi[In, Out]](processApi: T)(processApi: T)(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])
def withDiagramName(diagramName: String): ProcessApi[In, Out]

Attributes

Inherited from:
ApiBaseDsl

Implicits

Inherited implicits

implicit protected def tenantId: Option[String]

Attributes

Inherited from:
AbstractApiCreator
implicit def toApi[In <: Product : Schema, Out <: Product : Decoder](inOut: Activity[In, Out, _]): ActivityApi[In, Out]

Attributes

Inherited from:
ApiDsl
implicit def toApi[In <: Product : Schema, Out <: Product : Decoder](dmn: DecisionDmn[In, Out]): DecisionDmnApi[In, Out]

Attributes

Inherited from:
ApiDsl
implicit def toApi[In <: Product : Encoder, Out <: Product : ClassTag, ServiceOut : Decoder](process: ServiceProcess[In, Out, ServiceOut]): ServiceProcessApi[In, Out, ServiceOut]

Attributes

Inherited from:
ApiDsl
implicit def toApi[In <: Product : Encoder, Out <: Product : ClassTag](process: Process[In, Out]): ProcessApi[In, Out]

Attributes

Inherited from:
ApiDsl
Generated with