Versions Compared

Old Version 8

changes.mady.by.user antoine hage

Saved on

compared with

New Version 9

changes.mady.by.user antoine hage

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

VariableRequireddescriptionexample
UI meta data
typeYesThe following type are supported: static, service, daemon, multi, custom (anything else)if not set the default type will be custom.
subtype


tab


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

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 serviceGroup should reflect the system the service belongs to "Payment"

descriptionNoThe service description to appear in the API catalog UI"This is a string"
Search meta data
tagsNo

attributesNo

programNo

Documentation meta data
documentation


Type meta data
swaggerFilenameNoThe 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. 4100
versionYesThe version of the service. make sure it has the following syntax: a string of /[0-9]+(.[0-9]+)?/"1" or "1.1"
extKeyRequiredNoTo turn on multi tenancy you need to have extKeyRequired set to truedefault value is true
oauthNoTo 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

  1. 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

  2. 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  

  3. 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)
uracNoTo add to the request header the logged in user information 

This is supper 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_ProfileNoTo add to the request header the logged in user profile information default is false
urac_ACLNoTo add to the request header the logged in user ACL information default is false
tenant_profileNo

provision_ACLNoTo add to the request header the tenant ACL information default is false
requestTimeoutNoThe request lifetimedefault is 30 
requestTimeoutRenewalNoHow many times to renew the request lifetimedefault is 5
maintenanceYesThe heartbeat route to probe the health status of the service. 


Code Block
languageactionscript3
titleexample 
{
 "port": {
    "type": "inherit"
        },
 "readiness": "/heartbeat",

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


prerequisites



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 :

...