Versions Compared

Old Version 2

changes.mady.by.user antoine hage

Saved on

compared with

New Version 3

changes.mady.by.user Ragheb Bou Dargham

Saved on

Key

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

...

Code Block
Type: application/json

Param

Source

Type

Required

Description

type

query

string

Yes

 

name

query

string

Yes

 

config

body

object

Yes

 

env

body.config

string

Yes

 

version

body.config

string

Yes

 

cd

body.config

object

Yes

 

strategy

body.config.cd

enum

Yes

 ["notify", "update"]

settings

body.config

object

Yes

memory

body.config.settings

string

Yes

 

mode

body.config.settings

enum

Yes

 ["Deployment", "DaemonSet", "CronJob"]

concurrencyPolicy

body.config.settings

enum

No

 ["Allow", "Forbid", "Replace"]

schedule

body.config.settings

string

No

restartPolicy

body.config.settings

enum

No

["OnFailure", "Never"]

replicas

body.config.settings

integer

src

body.config

object

No

from

body.config.src

object

Yes

id

body.config.src

string

Yes

autoScale

body.config

object

No

replicas

body.config.autoScale

object

Yes

 

min

body.config.autoScale.replicas

integer

yes

min 1

max

body.config.autoScale.replicas

integer

yes

min 1

metrics

body.config.autoScale

object

Yes

 

cpu

body.config.autoScale.metrics

object

Yes

percent

body.config.autoScale.metrics.cpu

number

Yes

recipe

body.config

object

Yes

id

body.config.recipe

string

Yes

 

image

body.config.recipe

object

No

name

body.config.recipe.image

string

Yes

prefix

body.config.recipe.image

string

Yes

tag

body.config.recipe.image

string

Yes

ports

body.config.recipe

object

No

type

body.config.recipe.ports

string

Yes

portType

body.config.recipe.ports

string

Yes

externalTrafficPolicy

body.config.recipe.ports

enum

No

["Local", "Cluster"]

values

body.config.recipe.ports

array of object

Yes

name

body.config.recipe.ports.externalTrafficPolicy

string

Yes

target

body.config.recipe.ports.externalTrafficPolicy

integer

No

isPublished

body.config.recipe.ports.externalTrafficPolicy

boolean

No

env

body.config.recipe

object

No

sourceCode

body.config.recipe

object

No

body.config.src.from

Conditional require, with one of the following:

  • ["tag"]

  • ["branch", "commit"]

Param

Source

Type

Required

Description

tag

body.config.src.from

string

Yes conditional

branch

body.config.src.from

string

Yes conditional

commit

body.config.src.from

string

Yes conditional

body.config.recipe.env

Any of the below:

  • "^.*$" as string

  • "^.*$" as object

Param

Source

Type

Required

Description

"^.*$"

body.config.recipe.env

string

Yes

"^.*$"

body.config.recipe.env

object

yes

body.config.recipe.env….

string

yes

body.config.recipe.env….

string

yes

body.config.recipe.sourceCode

Conditional require, with one of the following:

  • ["label", "catalog", "id", "version", "tag"]

  • ["label", "catalog", "id", "version", "branch", "commit"]

Param

Source

Type

Required

Description

label

body.config.recipe.sourceCode

string

Yes conditional

catalog

body.config.recipe.sourceCode

string

Yes conditional

id

body.config.recipe.sourceCode

string

Yes conditional

version

body.config.recipe.sourceCode

string

Yes conditional

branch

body.config.recipe.sourceCode

string

Yes conditional

tag

body.config.recipe.sourceCode

string

Yes conditional

commit

body.config.recipe.sourceCode

string

Yes conditional

Output

...

Response

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

Valid Response

Expand
titleSAMPLE
Code Block
languagejson
{
	"result": true,
	"data": "Catalog Item Configuration Successfully updated!"
}

Invalid Response

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

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes

...

Code

Description

400

Business logic required data are missing

405

Recipe not allowed for this item!

406

You are not allowed to deploy this item in this environment!

407

The deploy configuration of this Environment was not found

412

Invalid git information

416

Unable to find healthy configuration in registry.Unable to find healthy configuration in registry.

417

Config Item not found

418

Item version not found!

422

Error: + %error%

501

Item not found!

503

Service Error: + %service_error”

602

Model error: + %model_error%

603

Model item not updated!