camundala-api
API
Generated with
© 2002-2021 · LAMP/EPFL
© 2002-2021 · LAMP/EPFL
camundala-api/camundala.api

camundala.api

package camundala.api

Members list

Concise view

Type members

Classlikes

trait AbstractApiCreator extends ProcessReferenceCreator

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class ActivityApi[In <: Product, Out <: Product](name: String, inOut: Activity[In, Out, _], apiExamples: ApiExamples[In, Out])(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]) extends InOutApi[In, Out]

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait InOutApi[In, Out]
trait CApi
class Object
trait Matchable
class Any
object ActivityApi

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
case class ApiConfig(tenantId: Option[String], contact: Option[Contact], endpoint: String, basePath: Path, cawemoFolder: Option[String], openApiPath: Path, postmanOpenApiPath: Path, openApiDocuPath: Path, postmanOpenApiDocuPath: Path, jiraUrls: Map[String, String], localProjectPaths: Seq[Path], docProjectUrl: String => String)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
trait ApiCreator extends ApiDsl with PostmanApiCreator with TapirApiCreator with App

Attributes

Graph
Supertypes
trait App
trait DelayedInit
trait ApiDsl
class Object
trait Matchable
class Any
Known subtypes
case class ApiDoc(apis: List[CApi])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
trait ApiDsl

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class ApiExamples[In <: Product, Out <: Product](inputExamples: InOutExamples[In], outputExamples: InOutExamples[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])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object ApiExamples

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait CApi

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class CApiGroup
class DecisionDmnApi[In, Out]
class ProcessApi[In, Out]
trait InOutApi[In, Out]
class ActivityApi[In, Out]
case class CApiGroup(name: String, apis: List[CApi]) extends GroupedApi

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait CApi
class Object
trait Matchable
class Any
case class CamundaAuthError(`type`: String, message: String, userId: String, permissionName: String, resourceName: String, resourceId: String)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class CamundaError(`type`: String, message: String)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
trait CamundaPostmanApiCreator extends PostmanApiCreator

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class CamundaProperty(key: String, value: CamundaVariable)

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object CamundaProperty

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class CompleteTaskIn(variables: Map[ExampleName, CamundaVariable], withVariablesInReturn: Boolean)

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object CompleteTaskIn

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class CompleteTaskOut(variables: Map[ExampleName, CamundaVariable])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object CompleteTaskOut

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class CorrelateMessageIn(messageName: String, businessKey: Option[String], tenantId: Option[String], withoutTenantId: Option[Boolean], processInstanceId: Option[String], correlationKeys: Option[FormVariables], localCorrelationKeys: Option[FormVariables], processVariables: Option[FormVariables], processVariablesLocal: Option[FormVariables], all: Boolean, resultEnabled: Boolean, variablesInResultEnabled: Boolean)

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object CorrelateMessageIn

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class DecisionDmnApi[In <: Product, Out <: Product](name: String, inOut: DecisionDmn[In, Out], apiExamples: ApiExamples[In, Out])(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]) extends InOutApi[In, Out] with GroupedApi

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait InOutApi[In, Out]
trait CApi
class Object
trait Matchable
class Any
object DecisionDmnApi

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
trait DefaultApiCreator extends ApiCreator with CamundaPostmanApiCreator

Attributes

Graph
Supertypes
trait App
trait DelayedInit
trait ApiDsl
class Object
trait Matchable
class Any
case class EvaluateDecisionIn(variables: Map[ExampleName, CamundaVariable])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object EvaluateDecisionIn

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
trait GenericServiceIn

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
case class GetActiveTaskIn(processInstanceId: String, active: Boolean)

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object GetActiveTaskIn

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class GetActiveTaskOut(id: String)

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
sealed trait GroupedApi extends CApi

Attributes

Graph
Supertypes
trait CApi
class Object
trait Matchable
class Any
Known subtypes
class CApiGroup
class DecisionDmnApi[In, Out]
class ProcessApi[In, Out]
sealed trait InOutApi[In <: Product, Out <: Product](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], evidence$7: ClassTag[Out]) extends CApi

Attributes

Graph
Supertypes
trait CApi
class Object
trait Matchable
class Any
Known subtypes
class ActivityApi[In, Out]
class DecisionDmnApi[In, Out]
class ProcessApi[In, Out]
case class InOutExample[T <: Product](name: String, example: T)(implicit evidence$39: Encoder[T], evidence$40: Decoder[T], evidence$41: Schema[T])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class InOutExamples[T <: Product](examples: Seq[InOutExample[T]])(implicit evidence$36: Encoder[T], evidence$37: Decoder[T], evidence$38: Schema[T])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object InOutExamples

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
trait PostmanApiCreator extends AbstractApiCreator

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class ProcessApi[In <: Product, Out <: Product](name: String, inOut: Process[In, Out], apiExamples: ApiExamples[In, Out], apis: List[CApi])(implicit evidence$8: Encoder[In], evidence$9: Decoder[In], evidence$10: Schema[In], evidence$11: Encoder[Out], evidence$12: Decoder[Out], evidence$13: Schema[Out], evidence$14: ClassTag[Out]) extends InOutApi[In, Out] with GroupedApi

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait InOutApi[In, Out]
trait CApi
class Object
trait Matchable
class Any
object ProcessApi

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
trait ProcessReferenceCreator

Checks all BPMNs if a process is used in another process. As result a list is created that can be included in the Documentation.

Checks all BPMNs if a process is used in another process. As result a list is created that can be included in the Documentation.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class RequestErrorOutput(statusCode: StatusCode, examples: Map[ExampleName, CamundaError])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class RequestInput[T](examples: Map[ExampleName, T])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object RequestInput

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class RequestOutput[T](statusCode: StatusCode, examples: Map[ExampleName, T])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object RequestOutput

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class SendSignalIn(name: String, tenantId: Option[String], withoutTenantId: Option[Boolean], executionId: Option[String], variables: Option[Map[String, CamundaVariable]])

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object SendSignalIn

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class StartProcessIn(variables: Map[String, CamundaVariable], businessKey: Option[String], withVariablesInReturn: Boolean)

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object StartProcessIn

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class StartProcessOut(variables: Map[ExampleName, CamundaVariable], id: String, definitionId: String, businessKey: Option[String])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
trait TapirApiCreator extends AbstractApiCreator

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object XMLChecker extends App

Attributes

Graph
Supertypes
trait App
trait DelayedInit
class Object
trait Matchable
class Any
Self type

Types

type ExampleName = String
type FormVariables = Map[String, CamundaVariable]

Value members

Concrete methods

def serviceNameDescr(serviceName: String): String

Concrete fields

val customMockDescr: String
val doMockDescr: String
val handledErrorsDescr: String
val mockedDescr: String
val testModeDescr: String

Givens

Givens

given given_Decoder_StatusCode: Decoder[StatusCode]
given given_Encoder_StatusCode: Encoder[StatusCode]
given given_Schema_StatusCode: Schema[StatusCode]
Generated with
© 2002-2021 · LAMP/EPFL
© 2002-2021 · LAMP/EPFL