Versions Compared

Key

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

...

Input

Source

Required

Type

Description

skipstart

query

No

integer

To control the pagination starting record

limit

query

No

integer

To control the pagination limit

idskeywords

query

No

Array of stringsstring

To list filter by IDsname or description

version

query

No

Boolean

Specify whether to retrieve the versions

boolean

Output

...

Response

SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response 

...

Expand
titleSAMPLE
Code Block
languagejson
{
  "result": true,
  "data": [{
	_id: "5ef5a98e707a10af2f5d84c8",
	name: "Controller",
	type: "service",
	subtype: "nodejs",
	description: "Deploy Node.js service",
	restriction: {
		deployment: [
			"container"
		]
	},
	recipe: {
		deployOptions: {
			image: {
				prefix: "soajsorg",
				name: "gateway",
				tag: "latest",
				pullPolicy: "Always",
				repositoryType: "public",
				override: true,
				shell: "shell/bin/bash",
				binary: true
			},
			sourceCode: {},
			readinessProbe: {
				exec: {
					command: [
						"ls"
					]
				},
				initialDelaySeconds: 5,
				timeoutSeconds: 2,
				periodSeconds: 5,
				successThreshold: 1,
				failureThreshold: 4
			},
			livenessProbe: null,
			ports: [
				{
					name: "http",
					target: 80,
					isPublished: true,
					published: 30080
				}
			],
			voluming: [
				{
					docker: {},
					kubernetes: {
						volume: {
							name: "soajsprofile",
							secret: {
								secretName: "soajsprofile"
							}
						},
						volumeMount: {
							mountPath: "/opt/soajs/profile/",
							name: "soajsprofile"
						}
					}
				}
			],
			restartPolicy: {
				condition: "any",
				maxAttempts: 5
			},
			container: {
				network: "soajsnet",
				workingDir: ""
			},
			labels: {
				ragheb: "ragheb"
			},
			execCommands: {
				list: "ls -l"
			}
		},
		buildOptions: {
			env: {
				SOAJS_ENV: {
					type: "computed",
					value: "$SOAJS_ENV"
				},
				SOAJS_DEPLOY_HA: {
					type: "computed",
					value: "$SOAJS_DEPLOY_HA"
				},
				SOAJS_PROFILE: {
					type: "static",
					value: "/opt/soajs/profile/soajsprofile"
				},
				SOAJS_MONGO_CON_KEEPALIVE: {
					type: "static",
					value: "true"
				},
				SOAJS_EXTKEY: {
					type: "computed",
					value: "$SOAJS_EXTKEY"
				}
			},
			cmd: {
				deploy: {
					command: [
						"bash"
					],
					args: [
						"-c",
						"node ."
					]
				}
			}
		}
	},
	v: 1,
	ts: 1595250459348
  }]
}

Invalid Response

Expand
titleSAMPLE
Code Block
{
    "result":false,
    "errors":{
        "codes":[602],
        "details":[
            {
                "code":602,
                "message":"Model error: + %model_error%"
            }
        ]
    }
}

...