General Information
Service | API | Method | Data Models | Workflow |
---|---|---|---|---|
marketplace | /item/daemon | PUT | N/A | N/A |
Description
This API adds/updates an item of type daemon to the catalog.
Input
Type: application/json
Input | Source | Required | Type | Description |
---|---|---|---|---|
id | body | Yes | string | Specify the id of catalog |
items | body | Yes | string | Specify the groups this catalog have access to |
src | body.items | Yes | string | |
provider | body.items.src | Yes | string | ["manual", "github", "bitbucket", "bitbucket_enterprise"] |
owner | body.items.src | No | string | |
repo | body.items.src | No | string | |
branch | body.items.src | No | string | |
tag | body.items.src | No | string | |
type | body.items.soa | No | string | daemon |
subType | body.items.soa | No | string | /^(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$/ |
name | body.items.soa | Yes | string | /^(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$/ |
group | body.items.soa | Yes | string | /^(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$/ |
description | body.items.soa | Yes | string | |
tags | body.items.soa | No | Array of strings | |
attributes | body.items.soa | No | Object | example : { “attr1” : ”value” } |
tab | body.items.soa | No | Object | |
main | body.items.soa.tab | No | string | /^[a-zA-Z0-9_-]+$/ |
sub | body.items.soa.tab | No | string | /^[a-zA-Z0-9_-]+$/ |
program | body.items.soa | No | Array of strings | |
profile | body.items.soa | No | Object | Free schema |
version | body.items.soa | Yes | string | |
maintenance | body.items.soa | No | Object | |
port | body.items.soa.maintenance | Yes | Object | |
type | body.items.soa.maintenance.port | Yes | string | |
value | body.items.soa.maintenance.port | No | integer | |
readiness | body.items.soa.maintenance | Yes | string | |
commands | body.items.soa.maintenance | Yes | Array of strings | |
prerequisites | body.items.soa | No | Object | |
cpu | body.items.soa.prerequisites | No | string | |
memory | body.items.soa.prerequisites | No | string | |
jobs | body.items.soa | No | Object | |
documentation | body.items | No | Object | |
readme | body.items.documentation | No | string | |
release | body.items.documentation | No | string |
Output
Response
SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response
Valid Response
Invalid Response
Response schema
Follow this link to check out the response JSON Schema
SOAJS Error Codes
Code | Description |
---|---|
400 | Business logic required data are missing |
401 | Catalog Entry with same DNA detected! |
402 | Item is locked! |
500 | Item not found! |
602 | Model error: + %model_error% |
Add Comment