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

AbstractApiCreator

orchescala.api.AbstractApiCreator
trait AbstractApiCreator extends ProcessReferenceCreator

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 apiConfig: ApiConfig
protected def title: String
protected def version: String

Concrete 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

protected def basePath: Path
protected def info(title: String, description: Option[String]): Info
protected def servers: List[Server]

Inherited methods

protected def docProjectUrl(project: String): String

Attributes

Inherited from:
ProcessReferenceCreator
protected def gitBasePath: Path

Attributes

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

Inherited fields

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

Attributes

Inherited from:
ProcessReferenceCreator

Givens

Givens

protected given tenantId: Option[String]

Extensions

Extensions

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