A resource item can be added from GIT or manually using the SOAJS console UI UI. You need the following:
- soa.json for adding an item manually - required
- readme content - optional
- release note content - optional
| Code Block |
|---|
| language | js |
|---|
| title | 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"
]
}
}
|
| Variable | Required | description | example | 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 resource has to be unique and not been used by another resource at the Resource 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 service description to appear in the Resource catalog UI | "This is a string" | - |
| Search metadata |
| tags | No | Array of tags |
| - |
| attributes | No | Object of attributes |
| - |
| program | No | Array of programs |
| - |
| Documentation metadata by version |
| documentation | No | Object |
| - |
| .readme | No | Readme |
|
|
| .release | No | Release notes |
|
|
| Configuration metadata by version |
| 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" |
| Profile metadata by version |
| profile | no | Free JSON object to add custom information. |
|
|