Interface: BaseActionInfo

The description of a controller action in a channel, as listed by Entrypoint.getActions, given to the access control rules and, extended with the address, to the adapters.

Extended by

• HTTPActionInfo
• ServiceActionInfo
• CLIActionInfo

Properties

acl

readonly acl: boolean

Whether the action is checked by the access control rules (its acl option).

---

controller

readonly controller: string

The class name of the controller serving the action.

---

description

readonly description: string

The action's description: its description option, empty by default.

---

groups

readonly groups: string[]

The ids of the action's groups (its groups option).

---

id

readonly id: string

The action's id: a UUID derived from the controller, the method and the address, stable across restarts.

---

jsonSchema

readonly jsonSchema: JSONSchema

The JSON schema of the action's input (its DTO).

---

method

readonly method: string

The name of the controller method running the action.

---

name

readonly name: string

The action's name: its name option, ControllerClass:method by default. It is unique within a channel among the controller methods (the addresses of one method share its name).