status | The status of the module. | 'coming_soon' | 'preview' | 'beta' | 'stable' | 'maintenance' | 'end_of_life' |
name | The human readable name of the module. | string |
description | A short description of the module. | string |
icon | The Font Awesome icon name of the module. | string |
tags | The tags associated with this module. | Array<string> |
authors | The GitHub handle of the authors of the module. | Array<string> |
scripts | The scripts associated with this module. | Object with dynamic keys of type string and values of type Object with properties:name: string - The human readable name of the script.description: string - A short description of the script.public: boolean - If the script can be called from the public HTTP interface.
|
actors | The actors associated with this module. | Object with dynamic keys of type string and values of type Object with properties:storageAlias: string - Used to keep actor IDs the same in case the actor name changes.
|
routes | The routes associated with this module. | Object with dynamic keys of type string and values of type Object with properties:name: string - The human readable name of the route.description: string - A short description of the route.method: string - The HTTP method of the route.path: string - The path of the route.
or Object with properties:name: string - The human readable name of the route.description: string - A short description of the route.method: string - The HTTP method of the route.pathPrefix: string - The path prefix of the route.
|
errors (*) | The errors associated with this module. | Object with dynamic keys of type string and values of type Object with properties:name: string - The human readable name of the error.description: string - A short description of the error.internal: boolean - If the error should only be shown internally.
|
dependencies | The dependencies of this module. | Object with dynamic keys of type string and values of type Object with properties: |
defaultConfig | Default user config. | unknown (nullable) |
