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

PostmanApiCreator

camundala.api.PostmanApiCreator
trait PostmanApiCreator extends AbstractApiCreator

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait ApiCreator

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

Abstract 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]]

Concrete methods

protected def createPostman(apiDoc: ApiDoc): Seq[Endpoint[Unit, _, Unit, _, Any]]
protected def definitionKeyPath(key: String): EndpointInput[String]
protected def jobIdPath(): PathCapture[String]
protected def taskIdPath(): PathCapture[String]
protected def tenantIdPath(basePath: EndpointInput[_], pathElem: String): EndpointInput[_]
protected def tenantIdPath(id: String): EndpointInput[String]

Inherited methods

protected def apiConfig: ApiConfig

Attributes

Inherited from:
AbstractApiCreator
protected def basePath: Path

Attributes

Inherited from:
AbstractApiCreator
protected def gitBasePath: Path

Attributes

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

Attributes

Inherited from:
AbstractApiCreator
protected def projectName: String

Attributes

Inherited from:
ProcessReferenceCreator
protected def servers: List[Server]

Attributes

Inherited from:
AbstractApiCreator
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

Extensions

Extensions

extension (api: InOutApi[_, _])(api: InOutApi[_, _])
protected def postmanBaseEndpoint(tag: String, input: Option[EndpointInput[_]], label: String, descr: Option[String]): Endpoint[Unit, _, Unit, Unit, Any]
extension (cApi: CApi)(cApi: CApi)
def createPostman(): Seq[Endpoint[Unit, _, Unit, _, Any]]
extension (cApi: CApi)(cApi: CApi)
def createPostman(tag: String, isGroup: Boolean): Seq[Endpoint[Unit, _, Unit, _, Any]]
extension (inOutApi: InOutApi[_, _])(inOutApi: InOutApi[_, _])
protected def endpointPath(isGroup: Boolean): EndpointInput[Unit]

Inherited extensions

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

Attributes

Inherited from:
AbstractApiCreator
def endpointType: String

Attributes

Inherited from:
AbstractApiCreator

Implicits

Inherited implicits

implicit protected def tenantId: Option[String]

Attributes

Inherited from:
AbstractApiCreator
Generated with