/
Deployer config catalog
Deployer config catalog
soa.json for type=config
{ "name": "Nginx Config", "type": "config", "group": "Examples", "description": "This is the description of your config", "subType": "configuration", "tags": ["tag1", "tag2"], "attributes": { "att1": ["att1.1", "att1.2"], "att2": ["att2.1", "att2.2"] }, "tab": { "main": "Main tab", "sub": "Sub tab" }, "program": ["soajs"], "documentation": { "readme": "/doc/markupfile", "release": "/doc/markupfile" }, "version": "1", "profile": { //free to add whatever you want } }
Variable | Required | description | example | default |
---|---|---|---|---|
UI meta data | ||||
type | Yes | The following type is supported: static, service, daemon, multi, config, custom (anything else) | if not set the default type will be custom. | custom |
tab | - | |||
subType | No | configuration | ||
name | Yes | The name of the static content. It has to be unique and not been used by another config at the Deployer config catalog. | ||
group | Yes | The group of the service, make sure you set the right group to properly display the service under the right group at the API catalog. | The group should reflect the system the service belongs to "Payment" | |
description | No | The static description to appear in the Deployer config catalog UI | "This is a string" | - |
Search meta data | ||||
tags | No | - | ||
attributes | No | - | ||
program | No | - | ||
Documentation meta data | ||||
documentation | No | - | ||
Type meta data | ||||
version | Yes | The version of the config. make sure it has the following syntax: a string of /[0-9]+(.[0-9]+)?/ | "1" or "1.1" | "1" |
Related content
Custom catalog
Custom catalog
More like this
Frontend catalog
Frontend catalog
More like this
Catalog Recipes
Catalog Recipes
More like this
Resource catalog
Resource catalog
More like this
API catalog
API catalog
More like this
Demo Configuration
Demo Configuration
More like this