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

camundala.api

package camundala.api

Members list

Packages

package camundala.api.docs

Type members

Classlikes

trait AbstractApiCreator extends ProcessReferenceCreator

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait ApiCreator
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
Supertypes
trait Serializable
trait Product
trait Equals
trait InOutApi[In, Out]
trait CApi
class Object
trait Matchable
class Any
Show all
object ActivityApi

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
trait ApiBaseDsl

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait ApiDsl
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], gitConfigs: GitConfigs, docProjectUrl: String => String, diagramDownloadPath: Option[String], diagramNameAdjuster: Option[String => String], catalogOptimized: Boolean)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
trait ApiCreator extends PostmanApiCreator, TapirApiCreator, App

Attributes

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

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
trait ApiDsl extends ApiBaseDsl

Attributes

Supertypes
trait ApiBaseDsl
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
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ApiExamples

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
trait ApiInlinedDsl extends ApiBaseDsl

Attributes

Supertypes
trait ApiBaseDsl
class Object
trait Matchable
class Any
sealed trait CApi

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CamundaProperty

Attributes

Companion
class
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
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CompleteTaskIn

Attributes

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CompleteTaskOut

Attributes

Companion
class
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
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CorrelateMessageIn

Attributes

Companion
class
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], diagramName: Option[String])(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]

Attributes

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

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
trait DefaultApiCreator extends ApiDsl, ApiCreator, CamundaPostmanApiCreator

Attributes

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object EvaluateDecisionIn

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class GetActiveJobIn(processInstanceId: String, active: Boolean)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GetActiveJobIn

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class GetActiveTaskIn(processInstanceId: String, active: Boolean)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GetActiveTaskIn

Attributes

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GetActiveTaskOut

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class GitConfig(cloneUrl: String, projects: Seq[ProjectConfig], groupedProjects: Boolean)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GitConfigs(gitDir: Path, gitConfigs: Seq[GitConfig])

Attributes

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

Attributes

Supertypes
trait CApi
class Object
trait Matchable
class Any
Known subtypes
class CApiGroup
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

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

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
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
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object InOutExamples

Attributes

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

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait ApiCreator
case class ProcessApi[In <: Product, Out <: Product](name: String, inOut: Process[In, Out], apiExamples: ApiExamples[In, Out], apis: List[CApi], diagramName: Option[String])(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], GroupedApi

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait GroupedApi
trait InOutApi[In, Out]
trait CApi
class Object
trait Matchable
class Any
Show all
object ProcessApi

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
ProcessApi.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

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait ApiCreator
Show all
case class ProjectConfig(name: String, path: String => RelPath, bpmnPath: RelPath, group: ProjectGroup, color: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ProjectGroup(name: String, color: String, fill: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class RequestErrorOutput(statusCode: StatusCode, examples: Map[ExampleName, CamundaError])

Attributes

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RequestInput

Attributes

Companion
class
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
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RequestOutput

Attributes

Companion
class
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
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object SendSignalIn

Attributes

Companion
class
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
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object StartProcessIn

Attributes

Companion
class
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

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

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait ApiCreator

Types

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

Value members

Concrete fields

val catalogFileName: String

Deprecated fields

val customMockDescr: String

Attributes

Deprecated
true
val doMockDescr: String

Attributes

Deprecated
true
val mockedDescr: String

Attributes

Deprecated
true

Givens

Givens

given given_Decoder_StatusCode: Decoder[StatusCode]
given given_Encoder_StatusCode: Encoder[StatusCode]
given given_Schema_StatusCode: Schema[StatusCode]

Extensions

Extensions

extension (proc: proc)(proc: proc)
def callOnConsole(path: Path): CommandResult
Generated with