orchescala-api
API
Generated with
orchescala-api/orchescala.api/ApiCreator

ApiCreator

orchescala.api.ApiCreator
trait ApiCreator extends PostmanApiCreator, TapirApiCreator, App

Attributes

Graph
Supertypes
trait App
trait DelayedInit
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

Abstract methods

protected def companyProjectVersion: String
protected def projectDescr: String

Concrete methods

protected def createChangeLog(): String
def createGeneralVariable(key: InputParams, descr: String, scalaExample: String, jsonExample: String): String
protected def createGeneralVariables(): String
protected def createReadme(): String
protected def dependencies: String
protected def description: String
def document(apis: CApi*): Unit
protected def openApi(apiDoc: ApiDoc): OpenAPI
protected def packageConf: String
protected def postmanDescription: String
protected def postmanOpenApi(apiDoc: ApiDoc): OpenAPI
protected def replaceJira(line: String, jiraUrls: Map[String, String]): String
def supportedVariables: Seq[InputParams]

Inherited methods

protected def adjustPostmanOpenApi(api: String): String

You can adjust the OpenApi for Postman, e.g. to replace some values with placeholders.

You can adjust the OpenApi for Postman, e.g. to replace some values with placeholders.

Attributes

Returns

adjusted api

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 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 docProjectUrl(project: String): String

Attributes

Inherited from:
ProcessReferenceCreator
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
final def main(args: Array[String]): Unit

Attributes

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

Inherited and Abstract methods

protected def apiConfig: ApiConfig

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

Inherited from:
PostmanApiCreator
protected def title: String

Attributes

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

Concrete fields

lazy protected val openAPIDocsInterpreter: OpenAPIDocsInterpreter

Inherited fields

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

Attributes

Inherited from:
ProcessReferenceCreator
final val executionStart: Long

Attributes

Inherited from:
App

Givens

Inherited givens

protected given tenantId: Option[String]

Attributes

Inherited from:
AbstractApiCreator

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 (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 (cApi: CApi)
def create(tag: String, tagIsFix: Boolean): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
TapirApiCreator
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
extension (inOutApi: InOutApi[_, _])
def createEndpoint(tagFull: String, tagIsFix: Boolean, additionalDescr: Option[String]): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
TapirApiCreator
def path(tag: String): EndpointInput[Unit]

Attributes

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

Attributes

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

Attributes

Inherited from:
TapirApiCreator
def processName: String

Attributes

Inherited from:
TapirApiCreator
extension (processApi: ProcessApi[_, _, _])
def createInitEndpoint(tagFull: String): Seq[Endpoint[Unit, _, Unit, _, Any]]

Attributes

Inherited from:
TapirApiCreator
Generated with