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$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 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(companyId: String, tenantId: Option[String], contact: Option[Contact], endpoint: String, basePath: Path, openApiPath: Path, postmanOpenApiPath: Path, openApiDocuPath: Path, postmanOpenApiDocuPath: Path, jiraUrls: Map[String, String], projectsConfig: ProjectsConfig, modelerTemplateConfig: ModelerTemplateConfig, docProjectUrl: String => String, diagramDownloadPath: Option[String], diagramNameAdjuster: Option[String => String], projectRefId: String => (String, String))

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$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])

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
enum AppliesTo

Attributes

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

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
AppliesTo.type
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]
trait ExternalTaskApi[In, Out]
class CustomWorkerApi[In, Out]
class ServiceWorkerApi[In, Out, ServiceIn, ServiceOut]
Show all
case class CApiGroup(name: String, apis: List[InOutApi[_, _]]) 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

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class CamundaError(`type`: String, message: String)

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
trait CamundaPostmanApiCreator extends PostmanApiCreator

Attributes

Supertypes
class Object
trait Matchable
class Any
Show all
Known subtypes
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 CustomWorkerApi[In <: Product, Out <: Product](name: String, inOut: CustomTask[In, Out], apiExamples: ApiExamples[In, Out])(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 ExternalTaskApi[In, Out]

Attributes

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

Attributes

Companion
class
Supertypes
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$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 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
final case class ElementType(value: AppliesTo)

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait ExternalTaskApi[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 InOutApi[In, Out]

Attributes

Supertypes
trait InOutApi[In, Out]
trait CApi
class Object
trait Matchable
class Any
Known subtypes
class CustomWorkerApi[In, Out]
class ServiceWorkerApi[In, Out, ServiceIn, ServiceOut]
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
sealed trait GroupedApi extends CApi

Attributes

Supertypes
trait CApi
class Object
trait Matchable
class Any
Known subtypes
class CApiGroup
class ProcessApi[In, Out]
case class GroupedProjectConfig(cloneUrl: String, projects: Seq[ProjectConfig], groupedProjects: Boolean)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
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]
trait ExternalTaskApi[In, Out]
class CustomWorkerApi[In, Out]
class ServiceWorkerApi[In, Out, ServiceIn, ServiceOut]
class ProcessApi[In, Out]
Show all
case class InOutExample[T <: Product](name: String, example: T)(implicit evidence$1: Encoder[T], evidence$2: Decoder[T], evidence$3: Schema[T])

Attributes

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

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
case class InOutExamples[T <: Product](examples: Seq[InOutExample[T]])(implicit evidence$1: Encoder[T], evidence$2: Decoder[T], evidence$3: Schema[T])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class InputParamForTempl(inParam: InputParams, defaultValue: Product => String)

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class MTemplate(name: String, id: String, description: String, version: Int, appliesTo: Seq[AppliesTo], elementType: ElementType, properties: Seq[TemplProp], $schema: String, groups: Seq[PropGroup], entriesVisible: Boolean)

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
MTemplate.type
final case class ModelerTemplGenerator(apiVersion: String, config: ModelerTemplateConfig, projectName: Option[String]) extends App

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait App
trait DelayedInit
class Object
trait Matchable
class Any
Show all
case class ModelerTemplUpdater(apiConfig: ApiConfig)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ModelerTemplateConfig(schemaVersion: String, templateRelativePath: RelPath, generateGeneralVariables: Boolean)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
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[InOutApi[_, _]], diagramName: Option[String])(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 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 ProjectsConfig(gitDir: Path, projectConfPath: RelPath, groupedConfigs: Seq[GroupedProjectConfig])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
enum PropBinding

Attributes

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

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class PropGroup(id: PropGroupId, label: String)

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
PropGroup.type
enum PropGroupId

Attributes

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

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
enum PropType

Attributes

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

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
PropType.type
case class RequestErrorOutput(statusCode: StatusCode, examples: Map[ExampleName, CamundaError])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
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 ServiceWorkerApi[In <: Product, Out <: Product, ServiceIn, ServiceOut](name: String, inOut: ServiceTask[In, Out, ServiceIn, ServiceOut], apiExamples: ApiExamples[In, Out])(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], evidence$8: Encoder[ServiceIn], evidence$9: Decoder[ServiceIn], evidence$10: Schema[ServiceIn], evidence$11: Encoder[ServiceOut], evidence$12: Decoder[ServiceOut], evidence$13: Schema[ServiceOut]) extends ExternalTaskApi[In, Out]

Attributes

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

Attributes

Companion
class
Supertypes
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
object TemplMapperHelper

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
final case class TemplProp(value: String, `type`: TemplType, binding: PropBinding, label: String, description: String, group: Option[PropGroupId])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
TemplProp.type
enum TemplType

Attributes

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

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
TemplType.type

Types

type ExampleName = String

Value members

Concrete methods

def generalVariablesDescr[Out <: Product : Encoder](out: Out, serviceMock: String): String

Concrete fields

val catalogFileName: String
val defaultProjectPath: rel.ThisType

Givens

Givens

given given_ApiSchema_StatusCode: Schema[StatusCode]
given given_InOutDecoder_StatusCode: Decoder[StatusCode]
given given_InOutEncoder_StatusCode: Encoder[StatusCode]

Extensions

Extensions

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