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

DefaultApiCreator

camundala.api.DefaultApiCreator
trait DefaultApiCreator extends ApiCreator with CamundaPostmanApiCreator

Attributes

Graph
Supertypes
trait App
trait DelayedInit
trait ApiDsl
class Object
trait Matchable
class Any

Members list

Concise view

Type members

Inherited classlikes

class ApiBuilder

Attributes

Inherited from:
ApiDsl
Graph
Supertypes
class Object
trait Matchable
class Any
case class UsedByReferenceCreator(refId: String)

Attributes

Inherited from:
ProcessReferenceCreator
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class UsesReferenceCreator(processName: String)

Attributes

Inherited from:
ProcessReferenceCreator
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Inherited methods

def api[In <: Product : Encoder, Out <: Product : ClassTag](pApi: ProcessApi[In, Out])(body: CApi*): ProcessApi[In, Out]

Attributes

Inherited from:
ApiDsl
def api[In <: Product : Encoder, Out <: Product : ClassTag](pApi: InOutApi[In, Out]): InOutApi[In, Out]

Attributes

Inherited from:
ApiDsl
protected def apiConfig: ApiConfig

Attributes

Inherited from:
AbstractApiCreator
final protected def args: Array[String]

Attributes

Inherited from:
App
protected def basePath: Path

Attributes

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

Attributes

Inherited from:
TapirApiCreator
protected def createChangeLog(): String

Attributes

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

Attributes

Inherited from:
PostmanApiCreator
protected def createPostmanForDecisionDmn(api: ActivityApi[_, _], tag: String): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
CamundaPostmanApiCreator
protected def createPostmanForProcess(api: ProcessApi[_, _], tag: String, isGroup: Boolean): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
CamundaPostmanApiCreator
protected def createPostmanForReceiveMessageEvent(api: ActivityApi[_, _], tag: String): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
CamundaPostmanApiCreator
protected def createPostmanForReceiveSignalEvent(api: ActivityApi[_, _], tag: String): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
CamundaPostmanApiCreator
protected def createPostmanForUserTask(api: ActivityApi[_, _], tag: String): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
CamundaPostmanApiCreator
protected def createReadme(): String

Attributes

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

Attributes

Inherited from:
PostmanApiCreator
protected def description: Option[String]

Attributes

Inherited from:
ApiCreator
def document(apis: CApi*): Unit

Attributes

Inherited from:
ApiCreator
def group(name: String)(apis: CApi*): CApiGroup

Attributes

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

Attributes

Inherited from:
AbstractApiCreator
final def main(args: Array[String]): Unit

Attributes

Inherited from:
App
protected def openApi(apiDoc: ApiDoc): OpenAPI

Attributes

Inherited from:
ApiCreator
protected def postmanDescription: Option[String]

Attributes

Inherited from:
ApiCreator
protected def postmanOpenApi(apiDoc: ApiDoc): OpenAPI

Attributes

Inherited from:
ApiCreator
protected def projectName: String

Attributes

Inherited from:
ProcessReferenceCreator
protected def replaceJira(line: String, jiraUrls: Map[String, String]): String

Attributes

Inherited from:
ApiCreator
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 toOpenApi(apiDoc: ApiDoc): Unit

Attributes

Inherited from:
ApiCreator
protected def version: String

Attributes

Inherited from:
AbstractApiCreator

Deprecated and Inherited methods

override def delayedInit(body: => Unit): Unit

Attributes

Deprecated
[Since version 2.11.0] the delayedInit mechanism will disappear
Definition Classes
App -> DelayedInit
Inherited from:
App

Inherited fields

lazy protected val openAPIDocsInterpreter: OpenAPIDocsInterpreter

Attributes

Inherited from:
ApiCreator

Extensions

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 (api: ActivityApi[_, _])
def completeTask(tag: String): Endpoint[Unit, _, Unit, _, Any]

Attributes

Inherited from:
CamundaPostmanApiCreator
def correlateMessage(tag: String): Endpoint[Unit, _, Unit, _, Any]

Attributes

Inherited from:
CamundaPostmanApiCreator
def evaluateDecision(tag: String): Endpoint[Unit, _, Unit, _, Any]

Attributes

Inherited from:
CamundaPostmanApiCreator
def getActiveTask(tag: String): Endpoint[Unit, _, Unit, _, Any]

Attributes

Inherited from:
CamundaPostmanApiCreator
def getTaskFormVariables(tag: String): Endpoint[Unit, _, Unit, _, Any]

Attributes

Inherited from:
CamundaPostmanApiCreator
def sendSignal(tag: String): Endpoint[Unit, _, Unit, _, Any]

Attributes

Inherited from:
CamundaPostmanApiCreator
extension (cApi: CApi)
def create(tag: String): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
TapirApiCreator
extension (cApi: CApi)
def createPostman(tag: String, isGroup: Boolean): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
PostmanApiCreator
extension (cApi: CApi)
def createPostman(): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
PostmanApiCreator
extension (dmn: DecisionDmnApi[_, _])
def additionalDescr: Option[String]

Attributes

Inherited from:
TapirApiCreator
extension (groupedApi: GroupedApi)
def create(): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
TapirApiCreator
extension (inOutApi: InOutApi[_, _])
def endpointName: String

Attributes

Inherited from:
AbstractApiCreator
def endpointType: String

Attributes

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

Attributes

Inherited from:
PostmanApiCreator
extension [In <: Product, Out <: Product, T <: InOutApi[In, Out]](inOutApi: T)
def withExample(label: String, example: InOut[In, Out, _])(implicit evidence$57: Encoder[In], evidence$58: Decoder[In], evidence$59: Schema[In], evidence$60: Encoder[Out], evidence$61: Decoder[Out], evidence$62: Schema[Out], evidence$63: ClassTag[Out]): T

Attributes

Inherited from:
ApiDsl
inline def withExample(inline example: InOut[In, Out, _])(implicit evidence$36: Encoder[In], evidence$37: Decoder[In], evidence$38: Schema[In], evidence$39: Encoder[Out], evidence$40: Decoder[Out], evidence$41: Schema[Out], evidence$42: ClassTag[Out]): T

Attributes

Inherited from:
ApiDsl
def withInExample(label: String, example: In)(implicit evidence$64: Encoder[In], evidence$65: Decoder[In], evidence$66: Schema[In], evidence$67: Encoder[Out], evidence$68: Decoder[Out], evidence$69: Schema[Out], evidence$70: ClassTag[Out]): T

Attributes

Inherited from:
ApiDsl
inline def withInExample(inline example: In)(implicit evidence$43: Encoder[In], evidence$44: Decoder[In], evidence$45: Schema[In], evidence$46: Encoder[Out], evidence$47: Decoder[Out], evidence$48: Schema[Out], evidence$49: ClassTag[Out]): T

Attributes

Inherited from:
ApiDsl
def withOutExample(label: String, example: Out)(implicit evidence$71: Encoder[In], evidence$72: Decoder[In], evidence$73: Schema[In], evidence$74: Encoder[Out], evidence$75: Decoder[Out], evidence$76: Schema[Out], evidence$77: ClassTag[Out]): T

Attributes

Inherited from:
ApiDsl
inline def withOutExample(inline example: Out)(implicit evidence$50: Encoder[In], evidence$51: Decoder[In], evidence$52: Schema[In], evidence$53: Encoder[Out], evidence$54: Decoder[Out], evidence$55: Schema[Out], evidence$56: ClassTag[Out]): T

Attributes

Inherited from:
ApiDsl
extension (inOutApi: InOutApi[_, _])
def toPostmanInput[T <: Product : Schema](wrapper: FormVariables => T, examples: Seq[InOutExample[_]]): Option[EndpointInput[T]]

Attributes

Inherited from:
CamundaPostmanApiCreator
extension (inOutApi: InOutApi[_, _])
def createEndpoint(tag: String, additionalDescr: Option[String]): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
TapirApiCreator
extension (pa: ProcessApi[_, _])
def additionalDescr: Option[String]

Attributes

Inherited from:
TapirApiCreator
def processName: String

Attributes

Inherited from:
TapirApiCreator
extension (process: ProcessApi[_, _])
def startProcess(tag: String, isGroup: Boolean): Endpoint[Unit, _, Unit, _, Any]

Attributes

Inherited from:
CamundaPostmanApiCreator

Implicits

Inherited implicits

implicit protected def tenantId: Option[String]

Attributes

Inherited from:
AbstractApiCreator
implicit inline def toApi[In <: Product : Encoder, Out <: Product : Encoder](inline inOut: Activity[In, Out, _]): ActivityApi[In, Out]

Attributes

Inherited from:
ApiDsl
implicit inline def toApi[In <: Product : Encoder, Out <: Product : Schema](inline dmn: DecisionDmn[In, Out]): DecisionDmnApi[In, Out]

Attributes

Inherited from:
ApiDsl
implicit inline def toApi[In <: Product : Decoder, Out <: Product : Schema](inline process: Process[In, Out]): ProcessApi[In, Out]

Attributes

Inherited from:
ApiDsl
Generated with
© 2002-2021 · LAMP/EPFL
© 2002-2021 · LAMP/EPFL