Versions Compared

Old Version 4

changes.mady.by.user Ragheb Bou Dargham (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Ragheb Bou Dargham (Unlicensed)

Saved on

Key

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

General Information

Service

API

Method

Data Models

Workflow

marketplace

/recipe

POST

N/A

N/A

Description

Get catalog recipe by id

Input

Code Block
Type: application/json

Input

Source

Required

Type

Description

catalog

body

Yes

object

name

body.catalog

Yes

string

type

body.catalog

Yes

string

subtype

body.catalog

No

string

description

body.catalog

Yes

string

recipe

body.catalog

Yes

object

deployOptions

body.catalog.recipe

Yes

object

image

body.catalog.recipe.deployOptions

No

object

prefix

body.catalog.recipe.deployOptions.image

No

string

name

body.catalog.recipe.deployOptions.image

Yes

string

tag

body.catalog.recipe.deployOptions.image

Yes

string

repositoryType

body.catalog.recipe.deployOptions.image

No

string

"private","public"

pullPolicy

body.catalog.recipe.deployOptions.image

No

string

shell

body.catalog.recipe.deployOptions.image

No

string

sourceCode

body.catalog.recipe.deployOptions

No

object

configuration

body.catalog.recipe.deployOptions.sourceCode

No

object

label

body.catalog.recipe.deployOptions.sourceCode.configuration

Yes

string

readinessProbe

body.catalog.recipe.deployOptions

No

object

Free JSON Schema

liveinessProbe

body.catalog.recipe.deployOptions

No

object

Free JSON Schema

ports

body.catalog.recipe.deployOptions

No

Array of objects

name

body.catalog.recipe.deployOptions.ports

Yes

string

isPublished

body.catalog.recipe.deployOptions.ports

No

boolean

port

body.catalog.recipe.deployOptions.ports

No

number

target

body.catalog.recipe.deployOptions.ports

No

number

published

body.catalog.recipe.deployOptions.ports

No

number

preserveClientIP

body.catalog.recipe.deployOptions.ports

No

boolean

voluming

body.catalog.recipe.deployOptions

No

object

kubernetes

body.catalog.recipe.deployOptions.voluming

No

object

volume

body.catalog.recipe.deployOptions.voluming.kubernetes

Yes

object

volumeMount

body.catalog.recipe.deployOptions.voluming.kubernetes

Yes

object

labels

body.catalog.recipe.deployOptions

No

object

execCommands

body.catalog.recipe.deployOptions

No

object

buildOptions

body.catalog.recipe

No

object

settings

body.catalog.recipe.buildOptions

No

object

env

body.catalog.recipe.buildOptions

No

object

type

body.catalog.recipe.buildOptions.env

Yes

string

"static", "userInput", "computed", "secret"

label

body.catalog.recipe.buildOptions.env

No

string

fieldMsg

body.catalog.recipe.buildOptions.env

No

string

default

body.catalog.recipe.buildOptions.env

No

string

cmd

body.catalog.recipe.buildOptions

No

object

deploy

body.catalog.recipe.buildOptions.cmd

Yes

object

command

body.catalog.recipe.buildOptions.cmd.deploy

Yes

Array of strings

args

body.catalog.recipe.buildOptions.cmd.deploy

Yes

Array of strings

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": {
      id: "123"  
  }
}

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

430

One of the inputs under configuration repository is missing.

431

The port chosen is outside the range of valid exposed ports (30000, 32767)

432

Invalid port schema provided!

602

Model error: + %model_error%