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

DefaultApiCreator

orchescala.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

protected def adjustPostmanOpenApi(api: String): String

You can adjust the OpenApi for Postman, e.g. to replace some values with placeholders.

You can adjust the OpenApi for Postman, e.g. to replace some values with placeholders.

Attributes

Returns

adjusted api

Inherited from:
AbstractApiCreator
def api[In <: Product : Encoder, Out <: Product : ClassTag, InitIn <: Product : Schema](pApi: ProcessApi[In, Out, InitIn])(body: InOutApi[_, _]*): ProcessApi[In, Out, InitIn]

Attributes

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

Attributes

Inherited from:
ApiBaseDsl
protected def apiProjectConfig: ApiProjectConfig

Attributes

Inherited from:
ApiCreator
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 createPostmanForExternalTask(api: ExternalTaskApi[_, _], 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 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 dependencies: String

Attributes

Inherited from:
ApiCreator
protected def description: String

Attributes

Inherited from:
ApiCreator
protected def docProjectUrl(project: String): String

Attributes

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

Attributes

Inherited from:
ApiCreator
protected def gitBasePath: Path

Attributes

Inherited from:
ProcessReferenceCreator
def group(name: String, description: String)(apis: InOutApi[_, _]*): CApiGroup

Attributes

Inherited from:
ApiBaseDsl
def group(name: String)(apis: InOutApi[_, _]*): 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 packageConf: String

Attributes

Inherited from:
ApiCreator
protected def postmanDescription: 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 refIdentShort(refIdent: String, projectName: String): String

Attributes

Inherited from:
ProcessReferenceCreator
protected def refIdentShort(refIdent: String): 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

Inherited and Abstract methods

protected def apiConfig: ApiConfig

Attributes

Inherited from:
AbstractApiCreator
protected def companyProjectVersion: String

Attributes

Inherited from:
ApiCreator
protected def projectDescr: String

Attributes

Inherited from:
ApiCreator
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
final val executionStart: Long

Attributes

Inherited from:
App
lazy protected val openAPIDocsInterpreter: OpenAPIDocsInterpreter

Attributes

Inherited from:
ApiCreator

Givens

Inherited givens

given given_Conversion_CustomTask_CustomWorkerApi[In <: Product : Encoder, Out <: Product : ClassTag]: Conversion[CustomTask[In, Out], CustomWorkerApi[In, Out]]

Attributes

Inherited from:
ApiDsl
given given_Conversion_DecisionDmn_DecisionDmnApi[In <: Product : Encoder, Out <: Product : ClassTag]: Conversion[DecisionDmn[In, Out], DecisionDmnApi[In, Out]]

Attributes

Inherited from:
ApiDsl
given given_Conversion_Process_ProcessApi[In <: Product : Encoder, Out <: Product : ClassTag, InitIn <: Product : Schema]: Conversion[Process[In, Out, InitIn], ProcessApi[In, Out, InitIn]]

Attributes

Inherited from:
ApiDsl
given given_Conversion_ReceiveEvent_ActivityApi[In <: Product : Schema]: Conversion[ReceiveEvent[In, _], ActivityApi[In, NoOutput]]

Attributes

Inherited from:
ApiDsl
given given_Conversion_ServiceTask_ServiceWorkerApi[In <: Product : Encoder, Out <: Product : Schema, ServiceIn : Schema, ServiceOut : Decoder]: Conversion[ServiceTask[In, Out, ServiceIn, ServiceOut], ServiceWorkerApi[In, Out, ServiceIn, ServiceOut]]

Attributes

Inherited from:
ApiDsl
given given_Conversion_UserTask_ActivityApi[In <: Product : Encoder, Out <: Product : ClassTag]: Conversion[UserTask[In, Out], ActivityApi[In, Out]]

Attributes

Inherited from:
ApiDsl
protected given tenantId: Option[String]

Attributes

Inherited from:
AbstractApiCreator

Extensions

Inherited extensions

extension (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 (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 (cApi: CApi)
def createPostman(): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

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

Attributes

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

Attributes

Inherited from:
TapirApiCreator
extension [In <: Product, Out <: Product, T <: DecisionDmnApi[In, Out]](decApi: T)(using evidence$1: Encoder[In], evidence$2: Decoder[In], evidence$3: Schema[In], evidence$4: Encoder[Out], evidence$5: Decoder[Out], evidence$6: Schema[Out], evidence$7: ClassTag[Out])
def withDiagramName: DecisionDmnApi[In, Out]

Attributes

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

Attributes

Inherited from:
TapirApiCreator
extension (externalTaskApi: ExternalTaskApi[_, _])
def startProcess(tag: String): Endpoint[Unit, _, Unit, _, Any]

Attributes

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

Attributes

Inherited from:
TapirApiCreator
extension [In <: Product, Out <: Product, T <: InOutApi[In, Out]](inOutApi: T)(using evidence$1: Encoder[In], evidence$2: Decoder[In], evidence$3: Schema[In], evidence$4: Encoder[Out], evidence$5: Decoder[Out], evidence$6: Schema[Out], evidence$7: ClassTag[Out])
def withExample: T

Attributes

Inherited from:
ApiBaseDsl
inline def withExample: T

Attributes

Inherited from:
ApiBaseDsl
def withInExample: T

Attributes

Inherited from:
ApiBaseDsl
inline def withInExample: T

Attributes

Inherited from:
ApiBaseDsl
def withInOutExample: T

Attributes

Inherited from:
ApiBaseDsl
def withOutExample: T

Attributes

Inherited from:
ApiBaseDsl
inline def withOutExample: T

Attributes

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

Attributes

Inherited from:
AbstractApiCreator
extension (inOutApi: InOutApi[_, _])
def createEndpoint(tagFull: String, tagIsFix: Boolean, additionalDescr: Option[String]): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
TapirApiCreator
def path(tag: String): EndpointInput[Unit]

Attributes

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

Attributes

Inherited from:
PostmanApiCreator
extension (inOutApi: InOutApi[_, _])
def toPostmanInput[T <: Product : Schema](wrapper: FormVariables => T, examples: Seq[InOutExample[_]]): Option[EndpointInput[T]]

Attributes

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

Attributes

Inherited from:
TapirApiCreator
def processName: String

Attributes

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

Attributes

Inherited from:
CamundaPostmanApiCreator
extension (processApi: ProcessApi[_, _, _])
def createInitEndpoint(tagFull: String): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
TapirApiCreator
extension [In <: Product, Out <: Product, InitIn <: Product, T <: ProcessApi[In, Out, InitIn]](processApi: T)(using evidence$1: Encoder[In], evidence$2: Decoder[In], evidence$3: Schema[In], evidence$4: Encoder[Out], evidence$5: Decoder[Out], evidence$6: Schema[Out], evidence$7: ClassTag[Out], evidence$8: Encoder[InitIn], evidence$9: Decoder[InitIn], evidence$10: Schema[InitIn])
def withDiagramName: ProcessApi[In, Out, InitIn]

Attributes

Inherited from:
ApiBaseDsl
Generated with