Foxx configuration

Foxx services can define configuration parametersin the service manifest to make them more re-usable.

The configuration object maps names to configuration parameters:

  • The key is the name under which the parameter will be available on theservice context’s configuration property.

  • The value is a parameter definition.

The key should be a valid identifier following the case-insensitive format/^[$a-z][-$a-z0-9]*$/.

The parameter definition can have the following properties:

  • description: string

Human readable description of the parameter.

  • type: string (Default: "string")

Type of the configuration parameter. Supported values are:

  • "integer" or "int":any finite integer number.

  • "boolean" or "bool":the values true or false.

  • "number":any finite decimal or integer number.

  • "string":any string value.

  • "json":any well-formed JSON value.

  • "password":like string but will be displayed as a masked input field in the web frontend.

  • default: any

Default value of the configuration parameter.

  • required: (Default: true)

Whether the parameter is required.

If the configuration has parameters that do not specify a default value, youneed to configure the service before it becomes active. In the meantime afallback service will be mounted that responds to all requests with a HTTP 500status code indicating a server-side error.

The configuration parameters of a mounted service can be adjusted from theweb interface by clicking the Configuration button in the service details.

Examples

  1. "configuration": {
  2. "currency": {
  3. "description": "Currency symbol to use for prices in the shop.",
  4. "default": "$",
  5. "type": "string"
  6. },
  7. "secretKey": {
  8. "description": "Secret key to use for signing session tokens.",
  9. "type": "password"
  10. }
  11. }