Page Comparison

...

Code Block

language	actionscript3
title	soa.json for type=service

{
    "type": "service",
	"subType": "",
    "name": "artifact",
    "group": "Examples",
	"description": "This is the decryption of your service",
	"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"
	},

	"swaggerFilename": "/doc/swagger.yml",
    "port": 4100,
    "version": "1",

	//Search criteria
	"program": ["soajs"],
	"tags": ["tag1", "tag2"],
	"attributes": {
		"att1": ["att1.1", "att1.2"],
		"att2": ["att2.1", "att2.2"]
	},

	//Configuration
    "extKeyRequired": true,
    "oauth": true,
    "urac": true,
    "urac_Profile": true,
    "urac_ACL": false,
    "tenant_Profile": false,
    "provision_ACL": false,
    "requestTimeout": 30,
    "requestTimeoutRenewal": 5,
	"maintenance": {
        "port": {
            "type": "inherit"
        },
        "readiness": "/heartbeat"
    },
	"interConnect": [
		{"name": "ms", "version": "1"}
	],
    "prerequisites": {
        "cpu": " ",
        "memory": " "
    },

	//Custom profile
	"profile": {
		//free to add whatever you want 
	}
}

...

Variable	Required	description	example

UI meta data

Default
Item and UI metadata
type	Yes	The following type are supported: static, service, daemon, multi, custom (anything else)	if not set the default type will be custom.	custom
subtype	No			services
tab	No			-
name	Yes	The name of the service, has to be unique and not been used by other service at the API catalog.	If the repoName is : xx.pay.merchant-registration Then your serviceName should be: "merchant-registration"
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 serviceGroup should reflect the system the service belongs to "Payment"
description	No	The service description to appear in the API catalog UI	"This is a string"	-
Search

meta data

metadata
tags	No	Array of tags	-
attributes	No	Object of attributes	-
program	No	Array of programs	-
Documentation

meta datadocumentationType meta data4100

metadata by version
documentation	No	Object		-
.readme	No	Readme
.release	No	Release notes
Configuration metadata
port	Yes	The port of the service. make sure it is unique and not being used by any other service at the API catalog.	4100
requestTimeout	No	The request lifetime		30
requestTimeoutRenewal	No	How many times to renew the request lifetime		5
prerequisites
Configuration metadata by version
swaggerFilename	No	The location of the service swagger file from the repository root. if not set soajs will look for swagger.yml or swagger.json at the root folder.	"/doc/swagger.yml"

portYesThe port of the service. make sure it is unique and not being used by any other service at the API catalog.

swagger.json
version	Yes	The version of the service. make sure it has the following syntax: a string of /[0-9]+(.[0-9]+)?/	"1" or "1.1"	"1"
extKeyRequired	No	To turn on multi tenancy you need to have extKeyRequired set to true

default value is

	true
oauth	No	To turn on oauth security for this service.

default is false

soajs supports 2 types of oAuth

oAuth0 aka JWT or webToken
oAuth 2.0

soajs empowers you to turn on oAuth at many different levels

At the service level by adding it to soa.json
Adding it to soa.json means you want oauth to be on for this service by default
At the service > environment level from the console under: develop tab → API catalog → service settings
Adding it at the service settings gives you the flexibility to turn it on and off per service per environment,
Please note that this will overwrite soa.json
At the tenant level from the console under: manage tab → multi-tenancy
Adding it at the tenant level gives you the flexibility to turn on or off oauth per tenant.
Please note that this will overwrite the above 2 points
Also you can specify the type of oauth you want (oauth0 or oauth2)

false

urac

No

To add to the request header the logged-in user information

This is

supper

super useful when soajs gateway proxy the request to your service and you need to know who is the logged-in user.

default is

	false
urac_Profile	No	To add to the request header the logged-in user profile information

default is

	false
urac_ACL	No	To add to the request header the logged-in user ACL information

default is

	false
tenant_profile	No
provision_ACL	No	To add to the request header the tenant ACL information

default is

false

requestTimeoutNoThe request lifetimedefault is 30 requestTimeoutRenewal

NoHow many times to renew the request lifetimedefault is 5

maintenance

Yes

The heartbeat route to probe the health status of the service

.

. The type can be ("inherit", "maintenance", "custom")

inherit= the same port as the microservice
maintenance= the microservice port + the maintenance increment set at SOAJS Gateway
custom= a custom port, you will need to specify a value as follow
Info
{ "port": { "type": "custom" , "value": 4001}, ...}

Code Block

language	actionscript3
title	example

{
 "port": {
    "type": "inherit"

},
 "readiness": "/heartbeat",

 "commands": [
    {
	"label": "reload", 
	"path": "/reload", 
	"icon": "provision"

}

]
}

prerequisites


Profile metadata by version
profile	no	Free json object to add custom information.

Maintenance Icon
For maintenance SOAJS is using font awesome, checkout the available icons at https://fontawesome.com/icons?d=gallery

For example, if you choose the wrench icon as follows :

Code Block

language	js
title	example

{
 "port": {
    "type": "inherit"
        },
 "readiness": "/heartbeat",

 "commands": [
    {"label": "My Command", "path": "/mypath", "icon": "fas fa-wrench"}
        ]
}

Versions Compared

Old Version 6

New Version Current

Key