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

CamundaPostmanApiCreator

camundala.api.CamundaPostmanApiCreator
trait CamundaPostmanApiCreator extends PostmanApiCreator

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Show all
Known subtypes

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

Concrete methods

protected def createPostmanForDecisionDmn(api: ActivityApi[_, _], tag: String): Seq[Endpoint[Unit, _, Unit, _, Any]]
protected def createPostmanForExternalTask(api: ExternalTaskApi[_, _], tag: String): Seq[Endpoint[Unit, _, Unit, _, Any]]
protected def createPostmanForMessageEvent(api: ActivityApi[_, _], tag: String): Seq[Endpoint[Unit, _, Unit, _, Any]]
protected def createPostmanForProcess(api: ProcessApi[_, _], tag: String, isGroup: Boolean): Seq[Endpoint[Unit, _, Unit, _, Any]]
protected def createPostmanForSignalEvent(api: ActivityApi[_, _], tag: String): Seq[Endpoint[Unit, _, Unit, _, Any]]
protected def createPostmanForTimerEvent(api: ActivityApi[_, _], tag: String): Seq[Endpoint[Unit, _, Unit, _, Any]]
protected def createPostmanForUserTask(api: ActivityApi[_, _], tag: String): Seq[Endpoint[Unit, _, Unit, _, Any]]

Inherited methods

protected def apiConfig: ApiConfig

Attributes

Inherited from:
AbstractApiCreator
protected def basePath: Path

Attributes

Inherited from:
AbstractApiCreator
protected def createPostman(apiDoc: ApiDoc): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
PostmanApiCreator
protected def definitionKeyPath(key: String): EndpointInput[String]

Attributes

Inherited from:
PostmanApiCreator
protected def gitBasePath: Path

Attributes

Inherited from:
ProcessReferenceCreator
protected def info(title: String, description: Option[String]): Info

Attributes

Inherited from:
AbstractApiCreator
protected def jobIdPath(): PathCapture[String]

Attributes

Inherited from:
PostmanApiCreator
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 servers: List[Server]

Attributes

Inherited from:
AbstractApiCreator
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
protected def title: String

Attributes

Inherited from:
AbstractApiCreator
protected def version: String

Attributes

Inherited from:
AbstractApiCreator

Inherited fields

lazy val allBpmns: Seq[(String, Seq[(Path, String)])]

Attributes

Inherited from:
ProcessReferenceCreator

Givens

Inherited givens

protected given tenantId: Option[String]

Attributes

Inherited from:
AbstractApiCreator

Extensions

Extensions

extension (api: ActivityApi[_, _])
def completeTask(tag: String): Endpoint[Unit, _, Unit, _, Any]
def correlateMessage(tag: String): Endpoint[Unit, _, Unit, _, Any]
def evaluateDecision(tag: String): Endpoint[Unit, _, Unit, _, Any]
def executeTimer(tag: String): Endpoint[Unit, _, Unit, _, Any]
def getActiveJob(tag: String): Endpoint[Unit, _, Unit, _, Any]
def getActiveTask(tag: String): Endpoint[Unit, _, Unit, _, Any]
def getTaskFormVariables(tag: String): Endpoint[Unit, _, Unit, _, Any]
def sendSignal(tag: String): Endpoint[Unit, _, Unit, _, Any]
extension (externalTaskApi: ExternalTaskApi[_, _])
def startProcess(tag: String): Endpoint[Unit, _, Unit, _, Any]
extension (inOutApi: InOutApi[_, _])
def toPostmanInput[T <: Product : Schema](wrapper: FormVariables => T, examples: Seq[InOutExample[_]]): Option[EndpointInput[T]]
extension (process: ProcessApi[_, _])
def startProcess(tag: String, isGroup: Boolean): Endpoint[Unit, _, Unit, _, Any]

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 (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 (inOutApi: InOutApi[_, _])
def endpointName: String

Attributes

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

Attributes

Inherited from:
PostmanApiCreator
Generated with