Skip to main content

ModelAction

@webda/core • Readme | API


Interface: ModelAction

Define an Action on a model

It is basically a method designed to be called by the API or external systems

Properties​

global?​

global?: boolean

Define if the action is global or per object

The method that implement the action must be called _${actionName}

Source​

packages/core/src/models/coremodel.ts:167


method?​

method?: string

Method of the action

Source​

packages/core/src/models/coremodel.ts:175


methods?​

methods?: HttpMethodType[]

Method for the route

By default ["PUT"]

Source​

packages/core/src/models/coremodel.ts:160


openapi?​

openapi?: any

Additional openapi info

Source​

packages/core/src/models/coremodel.ts:171