diff --git a/CHANGELOG b/CHANGELOG index 46003bf23c..8eadb2c5b9 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -11,6 +11,12 @@ devel * Foxx configuration values for unknown options will be discarded when saving the configuration in production mode using the web interface +v3.1.2 (20XX-XX-XX) +------------------- + +* added support for descriptions field in Foxx dependencies + + v3.1.1 (XXXX-XX-XX) ------------------- diff --git a/Documentation/Books/Manual/Foxx/Dependencies.mdpp b/Documentation/Books/Manual/Foxx/Dependencies.mdpp index dae904ca77..5c0787eba1 100644 --- a/Documentation/Books/Manual/Foxx/Dependencies.mdpp +++ b/Documentation/Books/Manual/Foxx/Dependencies.mdpp @@ -62,6 +62,7 @@ A `dependencies` definition maps the local alias of a given dependency against i "myAuth": { "name": "@foxx/auth", "version": "^1.0.0", + "description": "This description is entirely optional.", "required": false } } diff --git a/Documentation/Books/Manual/Foxx/Manifest.mdpp b/Documentation/Books/Manual/Foxx/Manifest.mdpp index 8512b6a21f..e9d578b75d 100644 --- a/Documentation/Books/Manual/Foxx/Manifest.mdpp +++ b/Documentation/Books/Manual/Foxx/Manifest.mdpp @@ -5,6 +5,7 @@ Every service comes with a `manifest.json` file providing metadata. The followin * **configuration**: `Object` (optional) An object defining the [configuration options](Configuration.md) this service requires. + * **defaultDocument**: `string` (optional)