/
Resource catalog

Resource catalog

Owned by antoine hage
Last updated: May 18, 2020 by Ragheb Bou Dargham (Unlicensed)

A resource item can be added manually using the SOAJS console UI. You need the following:

  • soa.json for adding an item manually  - required
  • readme content - optional
  • release note content - optional 
soa.json for type=resource
{
	"name": "resource",
	"type": "resource",
	"group": "group",
	"description": "This is the description of your resource",
	"tags": ["tag1", "tag2"],
	"attributes": {
		"att1": ["att1.1", "att1.2"],
		"att2": ["att2.1", "att2.2"]
	},
	"tab": {
		"main": "Main-tab",
		"sub": "Sub-tab"
	},
	"program": ["soajs"],

	"version": "1",
	"profile": {
		//free to add JSON object
		"stringKey": "lsoenf",
		"objectKey": {
			"test": "this is an example"
		},
		"arrayKey": [
			"123",
			"920"
		]
	}
}
VariableRequireddescriptionexampleDefault
Item and UI metadata
typeYesThe following type are supported: static, service, daemon, multi, custom (anything else)if not set the default type will be custom.custom
subtypeNo

services
tabNo

-
nameYesThe name of the resource has to be unique and not been used by another resource at the Resource catalog.



groupYesThe 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"


descriptionNoThe service description to appear in the Resource catalog UI"This is a string"-
Search metadata
tagsNoArray of tags
-
attributesNoObject of attributes
-
programNoArray of programs
-
Documentation metadata by version
documentationNoObject
-
.readmeNoReadme

.releaseNoRelease notes

Configuration metadata  by version
versionYesThe version of the service. make sure it has the following syntax: a string of /[0-9]+(.[0-9]+)?/"1" or "1.1""1"
Profile metadata by version
profilenoFree JSON object to add custom information.


Related content