Custom catalog

Custom catalog

soa.json for type=daemon
{ "name": "custom", "type": "custom", "group": "groupone", "subType":"subtype", "description": "This is the description of your custom", "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

Variable

Required

description

example

default

UI meta data

 

 

 

 

name

Yes

The name of the content. It has to be unique and not been used by other Custom contents at the Custom catalog.

 

 

type

Yes

The following type is supported: static, service, daemon, multi, config, custom (anything else)

 

custom

subType

No

 

if not set the default type will be custom.

custom

tab

No

 

 

 

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 Custom catalog UI

"This is a string"

-

Search meta data

 

 

 

 

tags

No

 

 

-

attributes

No

 

 

-

program

No

 

 

-

Documentation meta data

 

 

 

 

documentation

No

 

 

-

Type meta data

 

 

 

 

version

No

The version of the static content. make sure it has the following syntax: a string of /[0-9]+(.[0-9]+)?/

"1" or "1.1"

"1"