Foxx Manifest

An object defining the configuration options this service requires.

If specified, the / (root) route of the service will automatically redirect to the given relative path, e.g. "index.html".

The dependencies this service uses, i.e. which APIs its dependencies need to be compatible with.

The dependencies this provides, i.e. which APIs it claims to be compatible with.

An object indicating the semantic version ranges of ArangoDB (or compatible environments) the service will be compatible with.

An object defining file assets served by this service.

The relative path to the Foxx JavaScript files in the service, e.g. "lib". Defaults to the folder containing this manifest.

The relative path to the main entry point of this service (relative to lib), e.g. "index.js".

An object defining named scripts provided by this service, which can either be used directly or as queued jobs by other services.

A path/pattern or list of paths/patterns of JavaScript tests provided for this service.

The full name of the author of the service (i.e. you). This will be shown in the web interface.

A list of names of people that have contributed to the development of the service in some way. This will be shown in the web interface.

A human-readable description of the service. This will be shown in the web interface.

A list of keywords that help categorize this service. This is used by the Foxx Store installers to organize services.

A string identifying the license under which the service is published, ideally in the form of an SPDX license identifier. This will be shown in the web interface.

The name of the Foxx service. This will be shown in the web interface.

The filename of a thumbnail that will be used alongside the service in the web interface. This should be a JPEG or PNG image that looks good at sizes 50x50 and 160x160.

The version number of the Foxx service. The version number must follow the semantic versioning format. This will be shown in the web interface.