UI Cloud Platform Deployment Type Registry v2.6.3
This schema defines the REST API for the Deployment Type registry, which stores deployment type definitions. Deployment Types are used to describe deployments which are managed by the Deployment Management.
Contact: Cloud Operations
Operations
Tag: deploymentTypeRegistry
get-deploymentTypes
Operation Id: get-deploymentTypes
Action: GET /deployment-types
Summary: Retrieve list of existing deployment types
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
byType | query | array[string] | false | 'Filter deployment types by deployment type identifier' |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | Inline |
400 | Bad Request | Bad Request | Problem |
401 | Unauthorized | Unauthorized | Problem |
422 | Unprocessable Entity | Unprocessable Entity | Problem |
500 | Internal Server Error | Internal Server Error | Problem |
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [DeploymentType] | false | none | none |
» id | DeploymentTypeId | true | none | The unique identifier of a deployment type |
» displayName | string | false | none | none |
» dependsOn | DeploymentTypeDependencyList | false | none | none |
»» operator | DeploymentTypeDependencyListOperator | false | none | The operator to use while checking if a deployment has all required, dependencies specified. - allOf -> all specified dependencies must be included (specified) in a deployment - anyOf -> at least one of the dependencies must be included (specified) in a deployment - oneOf -> exactly one of the dependencies must be included (specified) in a deployment |
»» items | [DeploymentTypeId] | true | none | [The unique identifier of a deployment type] |
» disabled | boolean | false | none | none |
» isConnector | boolean | false | none | Does this type connect at least two other deployment types. |
» isContainer | boolean | false | none | Does this type act as a container in which other types can be deployed. |
» parameters | DeploymentTypeParameters | false | none | none |
»» identifier | string | true | none | Specifies the name of the parameter, whose value will be used as the identifier for a deployment. |
»» oas_schema | OpenApiV3Schema | true | none | none |
»»» title | string | false | none | none |
»»» multipleOf | number(decimal) | false | none | none |
»»» maximum | number(decimal) | false | none | none |
»»» exclusiveMaximum | boolean | false | none | none |
»»» minimum | number(decimal) | false | none | none |
»»» exclusiveMinimum | boolean | false | none | none |
»»» maxLength | integer(int32) | false | none | none |
»»» minLength | integer(int32) | false | none | none |
»»» pattern | string(regex) | false | none | none |
»»» maxItems | integer(int32) | false | none | none |
»»» minItems | integer(int32) | false | none | none |
»»» uniqueItems | boolean | false | none | none |
»»» maxProperties | integer(int32) | false | none | none |
»»» minProperties | integer(int32) | false | none | none |
»»» required | [string] | false | none | none |
»»» enum | [any] | false | none | none |
»»» type | string | false | none | none |
»»» not | any | false | none | none |
oneOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»»»» anonymous | OpenApiV3Schema | false | none | none |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»»»» anonymous | OpenApiV3SchemaReference | false | none | none |
»»»»» $ref | string(uri-reference) | true | none | none |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»»»» anonymous | any | false | none | none |
continued
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»»» allOf | [oneOf] | false | none | none |
oneOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»»»» anonymous | OpenApiV3Schema | false | none | none |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»»»» anonymous | OpenApiV3SchemaReference | false | none | none |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»»»» anonymous | any | false | none | none |
continued
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»»» oneOf | [oneOf] | false | none | none |
oneOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»»»» anonymous | OpenApiV3Schema | false | none | none |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»»»» anonymous | OpenApiV3SchemaReference | false | none | none |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»»»» anonymous | any | false | none | none |
continued
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»»» anyOf | [oneOf] | false | none | none |
oneOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»»»» anonymous | OpenApiV3Schema | false | none | none |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»»»» anonymous | OpenApiV3SchemaReference | false | none | none |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»»»» anonymous | any | false | none | none |
continued
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»»» items | any | false | none | none |
oneOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»»»» anonymous | OpenApiV3Schema | false | none | none |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»»»» anonymous | OpenApiV3SchemaReference | false | none | none |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»»»» anonymous | any | false | none | none |
continued
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»»» properties | object | false | none | none |
»»»» additionalProperties | any | false | none | none |
oneOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»»»»» anonymous | OpenApiV3Schema | false | none | none |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»»»»» anonymous | OpenApiV3SchemaReference | false | none | none |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»»»»» anonymous | any | false | none | none |
continued
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»»» additionalProperties | any | false | none | none |
oneOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»»»» anonymous | boolean | false | none | none |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»»»» anonymous | OpenApiV3Schema | false | none | none |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»»»» anonymous | OpenApiV3SchemaReference | false | none | none |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»»»» anonymous | any | false | none | none |
continued
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»»» description | string | false | none | none |
»»» format | string | false | none | none |
»»» default | any | false | none | none |
»»» nullable | boolean | false | none | none |
»»» readOnly | boolean | false | none | none |
»»» writeOnly | boolean | false | none | none |
»»» example | any | false | none | none |
»»» deprecated | boolean | false | none | none |
»»» $defs | OpenApiV3Schema | false | none | none |
»»»» additionalProperties | OpenApiV3Schema | false | none | none |
» outputs | OpenApiV3Schema | false | none | none |
Enumerated Values
Property | Value |
---|---|
operator | anyOf |
operator | allOf |
operator | oneOf |
type | array |
type | boolean |
type | integer |
type | number |
type | object |
type | string |
Example responses
200 Response
[
{
"id": "workspace.v1",
"displayName": "Cloud Workspace",
"isContainer": true,
"parameters": [
{
"type": "string",
"name": "name",
"isIdentifier": true
}
]
},
{
"id": "environment.v1",
"displayName": "Cloud Workspace Environment",
"dependsOn": {
"items": [
"workspace.v1"
]
},
"isContainer": true,
"parameters": [
{
"type": "string",
"name": "name",
"isIdentifier": true
}
]
}
]
400 Response
{
"type": "/some/uri-reference",
"title": "some title for the error situation",
"status": 100,
"detail": "some description for the error situation",
"instance": "/some/uri-reference#specific-occurrence-context",
"cause": {
"code": "string",
"message": "string",
"target": "string",
"details": [
{
"code": "string",
"message": "string",
"target": "string",
"details": [
{
"code": null,
"message": null,
"target": null,
"details": null,
"innererror": null
}
],
"innererror": {
"code": "string",
"innererror": {}
}
}
],
"innererror": {
"code": "string",
"innererror": {
"code": "string",
"innererror": {
"code": null,
"innererror": null
}
}
}
}
}
Note
This operation does not require authentication
Code samples
# You can also use wget
curl -X GET http://localhost:3000/deployment-types \
-H 'Accept: application/json'
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('http://localhost:3000/deployment-types', headers = headers)
print(r.json())
create-deploymentType
Operation Id: create-deploymentType
Action: POST /deployment-types
Summary: Create a new deployment type
Body parameter
{
"id": "string",
"displayName": "string",
"dependsOn": {
"operator": "anyOf",
"items": [
"string"
]
},
"disabled": false,
"isConnector": false,
"isContainer": false,
"parameters": {
"identifier": "string",
"oas_schema": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
},
"property2": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
}
}
}
},
"outputs": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {},
"property2": {}
}
},
"allOf": [
{
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
}
],
"oneOf": [
{
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
}
],
"anyOf": [
{
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
}
],
"items": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {},
"property2": {}
}
},
"properties": {
"property1": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
},
"property2": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
},
"property2": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
}
}
},
"property2": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
},
"property2": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
}
}
}
}
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | DeploymentType | true | none |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | Inline |
400 | Bad Request | Bad Request | Problem |
401 | Unauthorized | Unauthorized | Problem |
409 | Conflict | Conflict | Problem |
422 | Unprocessable Entity | Unprocessable Entity | Problem |
500 | Internal Server Error | Internal Server Error | Problem |
Status Code 201
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» id | DeploymentTypeId | true | none | The unique identifier of a deployment type |
Example responses
201 Response
Note
This operation does not require authentication
Code samples
POST http://localhost:3000/deployment-types HTTP/1.1
Host: localhost:3000
Content-Type: application/json
Accept: application/json
# You can also use wget
curl -X POST http://localhost:3000/deployment-types \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('http://localhost:3000/deployment-types', headers = headers)
print(r.json())
get-deploymentType
Operation Id: get-deploymentType
Action: GET /deployment-types/{id}
Summary: Retrieve existing deployment type
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | DeploymentTypeId | true | none |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | DeploymentType |
400 | Bad Request | Bad Request | Problem |
401 | Unauthorized | Unauthorized | Problem |
404 | Not Found | The specified resource was not found | Problem |
422 | Unprocessable Entity | Unprocessable Entity | Problem |
500 | Internal Server Error | Internal Server Error | Problem |
Note
This operation does not require authentication
Code samples
GET http://localhost:3000/deployment-types/{id} HTTP/1.1
Host: localhost:3000
Accept: application/json
# You can also use wget
curl -X GET http://localhost:3000/deployment-types/{id} \
-H 'Accept: application/json'
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('http://localhost:3000/deployment-types/{id}', headers = headers)
print(r.json())
update-deploymentType
Operation Id: update-deploymentType
Action: PATCH /deployment-types/{id}
Summary: Update deployment type
Body parameter
{
"id": "string",
"displayName": "string",
"dependsOn": {
"operator": "anyOf",
"items": [
"string"
]
},
"disabled": false,
"isConnector": false,
"isContainer": false,
"parameters": {
"identifier": "string",
"oas_schema": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
},
"property2": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
}
}
}
},
"outputs": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {},
"property2": {}
}
},
"allOf": [
{
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
}
],
"oneOf": [
{
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
}
],
"anyOf": [
{
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
}
],
"items": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {},
"property2": {}
}
},
"properties": {
"property1": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
},
"property2": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
},
"property2": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
}
}
},
"property2": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
},
"property2": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
}
}
}
}
}
}
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | DeploymentTypeId | true | none |
body | body | DeploymentType | true | none |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | DeploymentType |
400 | Bad Request | Bad Request | Problem |
401 | Unauthorized | Unauthorized | Problem |
404 | Not Found | The specified resource was not found | Problem |
422 | Unprocessable Entity | Unprocessable Entity | Problem |
424 | Failed Dependency | Failed Dependency | Problem |
500 | Internal Server Error | Internal Server Error | Problem |
Note
This operation does not require authentication
Code samples
PATCH http://localhost:3000/deployment-types/{id} HTTP/1.1
Host: localhost:3000
Content-Type: application/json
Accept: application/json
# You can also use wget
curl -X PATCH http://localhost:3000/deployment-types/{id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.patch('http://localhost:3000/deployment-types/{id}', headers = headers)
print(r.json())
delete-deploymentType
Operation Id: delete-deploymentType
Action: DELETE /deployment-types/{id}
Summary: Delete deployment type
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | DeploymentTypeId | true | none |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | No Content | None |
400 | Bad Request | Bad Request | Problem |
401 | Unauthorized | Unauthorized | Problem |
404 | Not Found | The specified resource was not found | Problem |
422 | Unprocessable Entity | Unprocessable Entity | Problem |
424 | Failed Dependency | Failed Dependency | Problem |
500 | Internal Server Error | Internal Server Error | Problem |
Note
This operation does not require authentication
Code samples
DELETE http://localhost:3000/deployment-types/{id} HTTP/1.1
Host: localhost:3000
Accept: application/problem+json
# You can also use wget
curl -X DELETE http://localhost:3000/deployment-types/{id} \
-H 'Accept: application/problem+json'
import requests
headers = {
'Accept': 'application/problem+json'
}
r = requests.delete('http://localhost:3000/deployment-types/{id}', headers = headers)
print(r.json())
get-deployment-type-schema
Operation Id: get-deployment-type-schema
Action: GET /deployment-types/{id}/schema
Summary: Get information about the parameter schema defined for a Deployment Type
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | DeploymentTypeId | true | none |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | JsonSchema |
400 | Bad Request | Bad Request | Problem |
401 | Unauthorized | Unauthorized | Problem |
404 | Not Found | The specified resource was not found | Problem |
422 | Unprocessable Entity | Unprocessable Entity | Problem |
500 | Internal Server Error | Internal Server Error | Problem |
Note
This operation does not require authentication
Code samples
GET http://localhost:3000/deployment-types/{id}/schema HTTP/1.1
Host: localhost:3000
Accept: application/schema+json
# You can also use wget
curl -X GET http://localhost:3000/deployment-types/{id}/schema \
-H 'Accept: application/schema+json'
import requests
headers = {
'Accept': 'application/schema+json'
}
r = requests.get('http://localhost:3000/deployment-types/{id}/schema', headers = headers)
print(r.json())
do-validate-deployment
Operation Id: do-validate-deployment
Action: POST /deployment-types/{id}/validate
Summary: Validate a deployment defined in the JSON body against the defined schema of the deployment type
Body parameter
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
id | path | DeploymentTypeId | true | none |
body | body | JsonObject | true | none |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | No Content | None |
400 | Bad Request | Bad Request | Problem |
401 | Unauthorized | Unauthorized | Problem |
404 | Not Found | The specified resource was not found | Problem |
422 | Unprocessable Entity | Unprocessable Entity | Problem |
500 | Internal Server Error | Internal Server Error | Problem |
Note
This operation does not require authentication
Code samples
POST http://localhost:3000/deployment-types/{id}/validate HTTP/1.1
Host: localhost:3000
Content-Type: application/json
Accept: application/problem+json
# You can also use wget
curl -X POST http://localhost:3000/deployment-types/{id}/validate \
-H 'Content-Type: application/json' \
-H 'Accept: application/problem+json'
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/problem+json'
}
r = requests.post('http://localhost:3000/deployment-types/{id}/validate', headers = headers)
print(r.json())
get-deploymentTypeHandlers
Operation Id: get-deploymentTypeHandlers
Action: GET /deployment-type-handlers
Summary: Retrieve list of existing deployment type handlers
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
byType | query | array[string] | false | Filter deployment type handlers by deployment type identifier |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | Inline |
400 | Bad Request | Bad Request | Problem |
401 | Unauthorized | Unauthorized | Problem |
422 | Unprocessable Entity | Unprocessable Entity | Problem |
500 | Internal Server Error | Internal Server Error | Problem |
Status Code 200
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | [DeploymentTypeHandler] | false | none | none |
» deploymentTypeId | DeploymentTypeId | true | none | The unique identifier of a deployment type |
» handlerTypeId | DeploymentTypeHandlerTypeId | true | none | The unique identifier of a deployment type handler implementation |
» parameters | object | false | none | none |
Example responses
200 Response
[
{
"deploymentTypeId": "workspace.v1",
"handlerType": "webhook",
"parameters": [
{
"name": "p1",
"value": [
1,
2,
3
]
},
{
"name": "obj",
"value": {
"name": "Name",
"item": "v1",
"url": "http://localhost"
}
}
]
},
{
"deploymentTypeId": "environment.v1",
"handlerType": "container",
"parameters": [
{
"name": "image",
"value": "environment.handler:v1"
},
{
"name": "obj",
"value": {
"name": "Name",
"item": "v1",
"url": "http://localhost"
}
}
]
}
]
400 Response
{
"type": "/some/uri-reference",
"title": "some title for the error situation",
"status": 100,
"detail": "some description for the error situation",
"instance": "/some/uri-reference#specific-occurrence-context",
"cause": {
"code": "string",
"message": "string",
"target": "string",
"details": [
{
"code": "string",
"message": "string",
"target": "string",
"details": [
{
"code": null,
"message": null,
"target": null,
"details": null,
"innererror": null
}
],
"innererror": {
"code": "string",
"innererror": {}
}
}
],
"innererror": {
"code": "string",
"innererror": {
"code": "string",
"innererror": {
"code": null,
"innererror": null
}
}
}
}
}
Note
This operation does not require authentication
Code samples
GET http://localhost:3000/deployment-type-handlers HTTP/1.1
Host: localhost:3000
Accept: application/json
# You can also use wget
curl -X GET http://localhost:3000/deployment-type-handlers \
-H 'Accept: application/json'
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('http://localhost:3000/deployment-type-handlers', headers = headers)
print(r.json())
create-deploymentTypeHandler
Operation Id: create-deploymentTypeHandler
Action: POST /deployment-type-handlers
Summary: Create a handler for a deployment type
Body parameter
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
body | body | DeploymentTypeHandler | true | none |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
201 | Created | Created | Inline |
400 | Bad Request | Bad Request | Problem |
401 | Unauthorized | Unauthorized | Problem |
409 | Conflict | Conflict | Problem |
422 | Unprocessable Entity | Unprocessable Entity | Problem |
424 | Failed Dependency | Failed Dependency | Problem |
500 | Internal Server Error | Internal Server Error | Problem |
Status Code 201
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» id | DeploymentTypeId | true | none | The unique identifier of a deployment type |
Example responses
201 Response
Note
This operation does not require authentication
Code samples
POST http://localhost:3000/deployment-type-handlers HTTP/1.1
Host: localhost:3000
Content-Type: application/json
Accept: application/json
# You can also use wget
curl -X POST http://localhost:3000/deployment-type-handlers \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.post('http://localhost:3000/deployment-type-handlers', headers = headers)
print(r.json())
get-deploymentTypeHandler
Operation Id: get-deploymentTypeHandler
Action: GET /deployment-type-handlers/{deploymentType}
Summary: Retrieve existing deployment type handler
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentType | path | DeploymentTypeId | true | none |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | DeploymentTypeHandler |
400 | Bad Request | Bad Request | Problem |
401 | Unauthorized | Unauthorized | Problem |
404 | Not Found | The specified resource was not found | Problem |
422 | Unprocessable Entity | Unprocessable Entity | Problem |
500 | Internal Server Error | Internal Server Error | Problem |
Note
This operation does not require authentication
Code samples
GET http://localhost:3000/deployment-type-handlers/{deploymentType} HTTP/1.1
Host: localhost:3000
Accept: application/json
# You can also use wget
curl -X GET http://localhost:3000/deployment-type-handlers/{deploymentType} \
-H 'Accept: application/json'
import requests
headers = {
'Accept': 'application/json'
}
r = requests.get('http://localhost:3000/deployment-type-handlers/{deploymentType}', headers = headers)
print(r.json())
update-deploymentTypeHandler
Operation Id: update-deploymentTypeHandler
Action: PATCH /deployment-type-handlers/{deploymentType}
Summary: Update deployment type handler
Body parameter
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentType | path | DeploymentTypeId | true | none |
body | body | DeploymentTypeHandler | true | none |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | DeploymentTypeHandler |
400 | Bad Request | Bad Request | Problem |
401 | Unauthorized | Unauthorized | Problem |
404 | Not Found | The specified resource was not found | Problem |
422 | Unprocessable Entity | Unprocessable Entity | Problem |
424 | Failed Dependency | Failed Dependency | Problem |
500 | Internal Server Error | Internal Server Error | Problem |
Note
This operation does not require authentication
Code samples
PATCH http://localhost:3000/deployment-type-handlers/{deploymentType} HTTP/1.1
Host: localhost:3000
Content-Type: application/json
Accept: application/json
# You can also use wget
curl -X PATCH http://localhost:3000/deployment-type-handlers/{deploymentType} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
import requests
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
r = requests.patch('http://localhost:3000/deployment-type-handlers/{deploymentType}', headers = headers)
print(r.json())
delete-deploymentTypeHandler
Operation Id: delete-deploymentTypeHandler
Action: DELETE /deployment-type-handlers/{deploymentType}
Summary: Delete deployment type handler
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
deploymentType | path | DeploymentTypeId | true | none |
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
204 | No Content | No Content | None |
400 | Bad Request | Bad Request | Problem |
401 | Unauthorized | Unauthorized | Problem |
404 | Not Found | The specified resource was not found | Problem |
422 | Unprocessable Entity | Unprocessable Entity | Problem |
500 | Internal Server Error | Internal Server Error | Problem |
Note
This operation does not require authentication
Code samples
DELETE http://localhost:3000/deployment-type-handlers/{deploymentType} HTTP/1.1
Host: localhost:3000
Accept: application/problem+json
# You can also use wget
curl -X DELETE http://localhost:3000/deployment-type-handlers/{deploymentType} \
-H 'Accept: application/problem+json'
import requests
headers = {
'Accept': 'application/problem+json'
}
r = requests.delete('http://localhost:3000/deployment-type-handlers/{deploymentType}', headers = headers)
print(r.json())
Schemas
InnerError
{
"code": "string",
"innererror": {
"code": "string",
"innererror": {
"code": "string",
"innererror": {
"code": "string",
"innererror": {
"code": null,
"innererror": null
}
}
}
}
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
code | string | false | none | none |
innererror | InnerError | false | none | none |
Error
{
"code": "string",
"message": "string",
"target": "string",
"details": [
{
"code": "string",
"message": "string",
"target": "string",
"details": [
{
"code": "string",
"message": "string",
"target": "string",
"details": [
{}
],
"innererror": {
"code": null,
"innererror": null
}
}
],
"innererror": {
"code": "string",
"innererror": {
"code": "string",
"innererror": {}
}
}
}
],
"innererror": {
"code": "string",
"innererror": {
"code": "string",
"innererror": {
"code": "string",
"innererror": {
"code": null,
"innererror": null
}
}
}
}
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
code | string | false | none | none |
message | string | false | none | none |
target | string | false | none | none |
details | [Error] | false | none | none |
innererror | InnerError | false | none | none |
Problem
{
"type": "/some/uri-reference",
"title": "some title for the error situation",
"status": 100,
"detail": "some description for the error situation",
"instance": "/some/uri-reference#specific-occurrence-context",
"cause": {
"code": "string",
"message": "string",
"target": "string",
"details": [
{
"code": "string",
"message": "string",
"target": "string",
"details": [
{
"code": null,
"message": null,
"target": null,
"details": null,
"innererror": null
}
],
"innererror": {
"code": "string",
"innererror": {}
}
}
],
"innererror": {
"code": "string",
"innererror": {
"code": "string",
"innererror": {
"code": null,
"innererror": null
}
}
}
}
}
https://datatracker.ietf.org/doc/html/rfc7807
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
type | string(uri) | true | none | A URI reference that uniquely identifies the problem type only in the context of the provided API. Opposed to the specification in RFC-7807, it is neither recommended to be dereferenceable and point to a human-readable documentation nor globally unique for the problem type. |
title | string | false | none | A short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized. |
status | integer(int32) | false | none | The HTTP status code generated by the origin server for this occurrence of the problem. |
detail | string | false | none | A human readable explanation specific to this occurrence of the problem that is helpful to locate the problem and give advice on how to proceed. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized. |
instance | string(uri-reference) | false | none | A URI reference that identifies the specific occurrence of the problem, e.g. by adding a fragment identifier or sub-path to the problem type. May be used to locate the root of this problem in the source code. |
cause | Error | false | none | none |
OpenApiV3SchemaReference
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
$ref | string(uri-reference) | true | none | none |
OpenApiV3Schema
{
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
},
"property2": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
}
}
},
"allOf": [
{
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
},
"property2": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
}
}
}
],
"oneOf": [
{
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
},
"property2": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
}
}
}
],
"anyOf": [
{
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
},
"property2": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
}
}
}
],
"items": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
},
"property2": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
}
}
},
"properties": {
"property1": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
},
"property2": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
}
}
},
"property2": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
},
"property2": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
}
}
}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
},
"allOf": [
{
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
}
],
"oneOf": [
{
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
}
],
"anyOf": [
{
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
}
],
"items": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
},
"properties": {
"property1": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
},
"property2": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {},
"property2": {}
}
},
"property2": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {},
"property2": {}
}
}
}
},
"property2": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
},
"allOf": [
{
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
}
],
"oneOf": [
{
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
}
],
"anyOf": [
{
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
}
],
"items": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
},
"properties": {
"property1": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
},
"property2": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {},
"property2": {}
}
},
"property2": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {},
"property2": {}
}
}
}
}
}
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
title | string | false | none | none |
multipleOf | number(decimal) | false | none | none |
maximum | number(decimal) | false | none | none |
exclusiveMaximum | boolean | false | none | none |
minimum | number(decimal) | false | none | none |
exclusiveMinimum | boolean | false | none | none |
maxLength | integer(int32) | false | none | none |
minLength | integer(int32) | false | none | none |
pattern | string(regex) | false | none | none |
maxItems | integer(int32) | false | none | none |
minItems | integer(int32) | false | none | none |
uniqueItems | boolean | false | none | none |
maxProperties | integer(int32) | false | none | none |
minProperties | integer(int32) | false | none | none |
required | [string] | false | none | none |
enum | [any] | false | none | none |
type | string | false | none | none |
not | any | false | none | none |
oneOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» anonymous | OpenApiV3Schema | false | none | none |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» anonymous | OpenApiV3SchemaReference | false | none | none |
continued
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
allOf | [oneOf] | false | none | none |
oneOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» anonymous | OpenApiV3Schema | false | none | none |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» anonymous | OpenApiV3SchemaReference | false | none | none |
continued
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
oneOf | [oneOf] | false | none | none |
oneOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» anonymous | OpenApiV3Schema | false | none | none |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» anonymous | OpenApiV3SchemaReference | false | none | none |
continued
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anyOf | [oneOf] | false | none | none |
oneOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» anonymous | OpenApiV3Schema | false | none | none |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» anonymous | OpenApiV3SchemaReference | false | none | none |
continued
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
items | any | false | none | none |
oneOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» anonymous | OpenApiV3Schema | false | none | none |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» anonymous | OpenApiV3SchemaReference | false | none | none |
continued
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
properties | object | false | none | none |
» additionalProperties | any | false | none | none |
oneOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»» anonymous | OpenApiV3Schema | false | none | none |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
»» anonymous | OpenApiV3SchemaReference | false | none | none |
continued
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
additionalProperties | any | false | none | none |
oneOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» anonymous | boolean | false | none | none |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» anonymous | OpenApiV3Schema | false | none | none |
xor
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
» anonymous | OpenApiV3SchemaReference | false | none | none |
continued
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
description | string | false | none | none |
format | string | false | none | none |
default | any | false | none | none |
nullable | boolean | false | none | none |
readOnly | boolean | false | none | none |
writeOnly | boolean | false | none | none |
example | any | false | none | none |
deprecated | boolean | false | none | none |
$defs | object | false | none | none |
» additionalProperties | OpenApiV3Schema | false | none | none |
Enumerated Values
Property | Value |
---|---|
type | array |
type | boolean |
type | integer |
type | number |
type | object |
type | string |
JsonSchema
{
"$schema": "http://example.com",
"$id": "string",
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {},
"property2": {}
}
},
"allOf": [
{
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
}
],
"oneOf": [
{
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
}
],
"anyOf": [
{
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
}
],
"items": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {},
"property2": {}
}
},
"properties": {
"property1": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
},
"property2": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
},
"property2": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
}
}
},
"property2": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
},
"property2": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
}
}
}
}
}
Properties
allOf
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | object | false | none | none |
» $schema | string(uri) | true | none | none |
» $id | string | false | none | none |
and
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | OpenApiV3Schema | false | none | none |
JsonObject
Properties
None
DeploymentTypeId
The unique identifier of a deployment type
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | The unique identifier of a deployment type |
DeploymentTypeParameters
{
"identifier": "string",
"oas_schema": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {},
"property2": {}
}
},
"allOf": [
{
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
}
],
"oneOf": [
{
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
}
],
"anyOf": [
{
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
}
],
"items": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {},
"property2": {}
}
},
"properties": {
"property1": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
},
"property2": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
},
"property2": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
}
}
},
"property2": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
},
"property2": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
}
}
}
}
}
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
identifier | string | true | none | Specifies the name of the parameter, whose value will be used as the identifier for a deployment. |
oas_schema | OpenApiV3Schema | true | none | none |
DeploymentTypeDependencyListOperator
The operator to use while checking if a deployment has all required, dependencies specified.
- allOf -> all specified dependencies must be included (specified) in a deployment
- anyOf -> at least one of the dependencies must be included (specified) in a deployment
- oneOf -> exactly one of the dependencies must be included (specified) in a deployment
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | The operator to use while checking if a deployment has all required, dependencies specified. - allOf -> all specified dependencies must be included (specified) in a deployment - anyOf -> at least one of the dependencies must be included (specified) in a deployment - oneOf -> exactly one of the dependencies must be included (specified) in a deployment |
Enumerated Values
Property | Value |
---|---|
anonymous | anyOf |
anonymous | allOf |
anonymous | oneOf |
DeploymentTypeDependencyList
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
operator | DeploymentTypeDependencyListOperator | false | none | The operator to use while checking if a deployment has all required, dependencies specified. - allOf -> all specified dependencies must be included (specified) in a deployment - anyOf -> at least one of the dependencies must be included (specified) in a deployment - oneOf -> exactly one of the dependencies must be included (specified) in a deployment |
items | [DeploymentTypeId] | true | none | [The unique identifier of a deployment type] |
DeploymentType
{
"id": "string",
"displayName": "string",
"dependsOn": {
"operator": "anyOf",
"items": [
"string"
]
},
"disabled": false,
"isConnector": false,
"isContainer": false,
"parameters": {
"identifier": "string",
"oas_schema": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
},
"property2": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
}
}
}
},
"outputs": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {},
"property2": {}
}
},
"allOf": [
{
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
}
],
"oneOf": [
{
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
}
],
"anyOf": [
{
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
}
],
"items": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {},
"property2": {}
}
},
"properties": {
"property1": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
},
"property2": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
null
],
"enum": [
null
],
"type": "[",
"not": {},
"allOf": [
null
],
"oneOf": [
null
],
"anyOf": [
null
],
"items": {},
"properties": {},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {}
}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
},
"property2": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
}
}
},
"property2": {
"title": "string",
"multipleOf": 0,
"maximum": 0,
"exclusiveMaximum": false,
"minimum": 0,
"exclusiveMinimum": false,
"maxLength": 0,
"minLength": 0,
"pattern": "/regex/",
"maxItems": 0,
"minItems": 0,
"uniqueItems": false,
"maxProperties": 0,
"minProperties": 0,
"required": [
"string"
],
"enum": [
null
],
"type": "array",
"not": {},
"allOf": [
{}
],
"oneOf": [
{}
],
"anyOf": [
{}
],
"items": {},
"properties": {
"property1": {},
"property2": {}
},
"additionalProperties": true,
"description": "string",
"format": "string",
"default": null,
"nullable": false,
"readOnly": false,
"writeOnly": false,
"example": null,
"deprecated": false,
"$defs": {
"property1": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
},
"property2": {
"title": null,
"multipleOf": null,
"maximum": null,
"exclusiveMaximum": null,
"minimum": null,
"exclusiveMinimum": null,
"maxLength": null,
"minLength": null,
"pattern": null,
"maxItems": null,
"minItems": null,
"uniqueItems": null,
"maxProperties": null,
"minProperties": null,
"required": null,
"enum": null,
"type": null,
"not": null,
"allOf": null,
"oneOf": null,
"anyOf": null,
"items": null,
"properties": null,
"additionalProperties": null,
"description": null,
"format": null,
"default": null,
"nullable": null,
"readOnly": null,
"writeOnly": null,
"example": null,
"deprecated": null,
"$defs": null
}
}
}
}
}
}
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
id | DeploymentTypeId | true | none | The unique identifier of a deployment type |
displayName | string | false | none | none |
dependsOn | DeploymentTypeDependencyList | false | none | none |
disabled | boolean | false | none | none |
isConnector | boolean | false | none | Does this type connect at least two other deployment types. |
isContainer | boolean | false | none | Does this type act as a container in which other types can be deployed. |
parameters | DeploymentTypeParameters | false | none | none |
outputs | OpenApiV3Schema | false | none | none |
DeploymentTypeHandlerTypeId
The unique identifier of a deployment type handler implementation
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
anonymous | string | false | none | The unique identifier of a deployment type handler implementation |
DeploymentTypeHandler
Properties
Name | Type | Required | Restrictions | Description |
---|---|---|---|---|
deploymentTypeId | DeploymentTypeId | true | none | The unique identifier of a deployment type |
handlerTypeId | DeploymentTypeHandlerTypeId | true | none | The unique identifier of a deployment type handler implementation |
parameters | object | false | none | none |