camundala.api
package camundala.api
Type members
Classlikes
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]
- Companion:
- object
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)
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])
- Companion:
- object
case class CamundaAuthError(`type`: String, message: String, userId: String, permissionName: String, resourceName: String, resourceId: String)
@Schema$$annotations$$description("A JSON object with the following properties: (at least an empty JSON object {} or an empty request body)")
case class CompleteTaskIn(variables: Map[ExampleName, CamundaVariable], @Schema$$annotations$$description("Set to false will not return the Process Variables and the Result Status is 204.") withVariablesInReturn: Boolean)
- Companion:
- object
case class CompleteTaskOut(@Schema$$annotations$$description("The Process Variables - Be aware that returns everything stored in the Process.") variables: Map[ExampleName, CamundaVariable])
- Companion:
- object
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)
- Companion:
- object
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
- Companion:
- object
@Schema$$annotations$$description("A JSON object with the following properties")
case class GetActiveTaskIn(@Schema$$annotations$$description processInstanceId: String, @Schema$$annotations$$description("We are only interested in the active Task(s)") active: Boolean)
- Companion:
- object
case class InOutExample[T <: Product](name: String, example: T)(implicit evidence$39: Encoder[T], evidence$40: Decoder[T], evidence$41: Schema[T])
case class InOutExamples[T <: Product](examples: Seq[InOutExample[T]])(implicit evidence$36: Encoder[T], evidence$37: Decoder[T], evidence$38: Schema[T])
- Companion:
- object
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
- Companion:
- object
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.
case class SendSignalIn(@Schema$$annotations$$description("The name of the signal to deliver.") name: String, @Schema$$annotations$$description("\nSpecifies a tenant to deliver the signal. The signal can only be received on executions or process definitions which belongs to the given tenant.\n\nNote: Cannot be used in combination with executionId.\n") tenantId: Option[String], withoutTenantId: Option[Boolean], @Schema$$annotations$$description("\nOptionally specifies a single execution which is notified by the signal.\n\nNote: If no execution id is defined the signal is broadcasted to all subscribed handlers.\n") executionId: Option[String], @Schema$$annotations$$description("A JSON object containing variable key-value pairs. Each key is a variable name and each value a JSON variable value object.") variables: Option[Map[String, CamundaVariable]])
- Companion:
- object
@Schema$$annotations$$description("A JSON object with the following properties: (at least an empty JSON object {} or an empty request body)")
case class StartProcessIn(variables: Map[String, CamundaVariable], @Schema$$annotations$$description("The business key of the process instance.") businessKey: Option[String], @Schema$$annotations$$description("Set to false will not return the Process Variables.") withVariablesInReturn: Boolean)
- Companion:
- object
@Schema$$annotations$$description
case class StartProcessOut(@Schema$$annotations$$description("The Process Variables - Be aware that returns everything stored in the Process.") variables: Map[ExampleName, CamundaVariable], @Schema$$annotations$$description id: String, @Schema$$annotations$$description("The id of the process definition.") definitionId: String, @Schema$$annotations$$description("The business key of the process instance.") businessKey: Option[String])