Formatter Validator Minifier Escape / Unescape JSON ↔ String JSON ↔ YAML JSON → CSV NDJSON / JSON Lines JSON → Types JSON ↔ XML JSON Diff JSON Patch Canonicalize (RFC 8785) Schema Validator Schema Generator JSONPath Tester JWT Decoder JSON Errors Schemas More Tools
JSONTools / Schema registry / Foxx Manifest
Schema registry

Foxx Manifest

ArangoDB Foxx service manifest file

manifest.json
Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your manifest.json and it validates in your browser — nothing is uploaded.

Validate a manifest.json → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field Type Description
configurationobjectAn object defining the configuration options this service requires.
defaultDocumentstringIf specified, the / (root) route of the service will automatically redirect to the given relative path, e.g. "index.html".
dependenciesobjectThe dependencies this service uses, i.e. which APIs its dependencies need to be compatible with.
providesobjectThe dependencies this provides, i.e. which APIs it claims to be compatible with.
enginesobjectAn object indicating the semantic version ranges of ArangoDB (or compatible environments) the service will be compatible with.
engines.arangodbstring—
default: "^3.0.0"
filesobjectAn object defining file assets served by this service.
libstringThe relative path to the Foxx JavaScript files in the service, e.g. "lib". Defaults to the folder containing this manifest.
default: "."
mainstringThe relative path to the main entry point of this service (relative to lib), e.g. "index.js".
default: "index.js"
scriptsobjectAn object defining named scripts provided by this service, which can either be used directly or as queued jobs by other services.
testsoneOfA path/pattern or list of paths/patterns of JavaScript tests provided for this service.
default: "test/**/*.js"
authorstringThe full name of the author of the service (i.e. you). This will be shown in the web interface.
contributorsarray<string>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.
descriptionstringA human-readable description of the service. This will be shown in the web interface.
keywordsarray<string>A list of keywords that help categorize this service. This is used by the Foxx Store installers to organize services.
licensestringA 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.
namestringThe name of the Foxx service. This will be shown in the web interface.
thumbnailstringThe 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.
versionstringThe version number of the Foxx service. The version number must follow the semantic versioning format. This will be shown in the web interface.
Audit

What we found in this schema

Standards

Specification sections for the keywords in this schema

Keyword Document Section
$idJSON Schema Core, draft 2020-12§8.2.1 — The "$id" Keyword
$schemaJSON Schema Core, draft 2020-12§8.1.1 — "$schema"
additionalPropertiesJSON Schema Core, draft 2020-12§10.3.2.3 — "additionalProperties"
defaultJSON Schema Validation, draft 2020-12§9.2 — "default"
descriptionJSON Schema Validation, draft 2020-12§9.1 — "title" and "description"
enumJSON Schema Validation, draft 2020-12§6.1.2 — "enum"
itemsJSON Schema Core, draft 2020-12§10.3.1.2 — "items"
oneOfJSON Schema Core, draft 2020-12§10.2.1.3 — "oneOf"
propertiesJSON Schema Core, draft 2020-12§10.3.2.1 — "properties"
requiredJSON Schema Validation, draft 2020-12§6.5.3 — "required"
typeJSON Schema Validation, draft 2020-12§6.1.1 — "type"

Documents

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas