21909 lines
781 KiB
JSON
21909 lines
781 KiB
JSON
{
|
|
"openapi": "3.0.3",
|
|
"info": {
|
|
"title": "Activepieces Documentation",
|
|
"version": "0.0.0"
|
|
},
|
|
"components": {
|
|
"securitySchemes": {
|
|
"apiKey": {
|
|
"type": "http",
|
|
"description": "Use your api key generated from the admin console",
|
|
"scheme": "bearer"
|
|
}
|
|
},
|
|
"schemas": {
|
|
"flow.created": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"platformId": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"projectDisplayName": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
},
|
|
"userEmail": {
|
|
"type": "string"
|
|
},
|
|
"ip": {
|
|
"type": "string"
|
|
},
|
|
"action": {
|
|
"type": "string",
|
|
"enum": [
|
|
"flow.created"
|
|
]
|
|
},
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"flow": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated"
|
|
]
|
|
},
|
|
"project": {
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"flow"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"platformId",
|
|
"action",
|
|
"data"
|
|
]
|
|
},
|
|
"flow.deleted": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"platformId": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"projectDisplayName": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
},
|
|
"userEmail": {
|
|
"type": "string"
|
|
},
|
|
"ip": {
|
|
"type": "string"
|
|
},
|
|
"action": {
|
|
"type": "string",
|
|
"enum": [
|
|
"flow.deleted"
|
|
]
|
|
},
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"flow": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated"
|
|
]
|
|
},
|
|
"flowVersion": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"flowId": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"displayName",
|
|
"flowId",
|
|
"created",
|
|
"updated"
|
|
]
|
|
},
|
|
"project": {
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"flow",
|
|
"flowVersion"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"platformId",
|
|
"action",
|
|
"data"
|
|
]
|
|
},
|
|
"connection.upserted": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"platformId": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"projectDisplayName": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
},
|
|
"userEmail": {
|
|
"type": "string"
|
|
},
|
|
"ip": {
|
|
"type": "string"
|
|
},
|
|
"action": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"connection.deleted"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"connection.upserted"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"connection": {
|
|
"description": "App connection is a connection to an external app.",
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ACTIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"MISSING"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ERROR"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"OAUTH2"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM_OAUTH2"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CLOUD_OAUTH2"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"SECRET_TEXT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BASIC_AUTH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM_AUTH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NO_AUTH"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"externalId",
|
|
"pieceName",
|
|
"status",
|
|
"type",
|
|
"id",
|
|
"created",
|
|
"updated"
|
|
]
|
|
},
|
|
"project": {
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"connection"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"platformId",
|
|
"action",
|
|
"data"
|
|
]
|
|
},
|
|
"connection.deleted": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"platformId": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"projectDisplayName": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
},
|
|
"userEmail": {
|
|
"type": "string"
|
|
},
|
|
"ip": {
|
|
"type": "string"
|
|
},
|
|
"action": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"connection.deleted"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"connection.upserted"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"connection": {
|
|
"description": "App connection is a connection to an external app.",
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ACTIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"MISSING"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ERROR"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"OAUTH2"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM_OAUTH2"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CLOUD_OAUTH2"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"SECRET_TEXT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BASIC_AUTH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM_AUTH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NO_AUTH"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"externalId",
|
|
"pieceName",
|
|
"status",
|
|
"type",
|
|
"id",
|
|
"created",
|
|
"updated"
|
|
]
|
|
},
|
|
"project": {
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"connection"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"platformId",
|
|
"action",
|
|
"data"
|
|
]
|
|
},
|
|
"folder.created": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"platformId": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"projectDisplayName": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
},
|
|
"userEmail": {
|
|
"type": "string"
|
|
},
|
|
"ip": {
|
|
"type": "string"
|
|
},
|
|
"action": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"folder.updated"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"folder.created"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"folder.deleted"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"folder": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"displayName",
|
|
"created",
|
|
"updated"
|
|
]
|
|
},
|
|
"project": {
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"folder"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"platformId",
|
|
"action",
|
|
"data"
|
|
]
|
|
},
|
|
"folder.updated": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"platformId": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"projectDisplayName": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
},
|
|
"userEmail": {
|
|
"type": "string"
|
|
},
|
|
"ip": {
|
|
"type": "string"
|
|
},
|
|
"action": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"folder.updated"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"folder.created"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"folder.deleted"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"folder": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"displayName",
|
|
"created",
|
|
"updated"
|
|
]
|
|
},
|
|
"project": {
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"folder"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"platformId",
|
|
"action",
|
|
"data"
|
|
]
|
|
},
|
|
"folder.deleted": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"platformId": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"projectDisplayName": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
},
|
|
"userEmail": {
|
|
"type": "string"
|
|
},
|
|
"ip": {
|
|
"type": "string"
|
|
},
|
|
"action": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"folder.updated"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"folder.created"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"folder.deleted"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"folder": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"displayName",
|
|
"created",
|
|
"updated"
|
|
]
|
|
},
|
|
"project": {
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"folder"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"platformId",
|
|
"action",
|
|
"data"
|
|
]
|
|
},
|
|
"flow.run.started": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"platformId": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"projectDisplayName": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
},
|
|
"userEmail": {
|
|
"type": "string"
|
|
},
|
|
"ip": {
|
|
"type": "string"
|
|
},
|
|
"action": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"flow.run.started"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"flow.run.finished"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"flowRun": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"startTime": {
|
|
"type": "string"
|
|
},
|
|
"finishTime": {
|
|
"type": "string"
|
|
},
|
|
"duration": {
|
|
"type": "number"
|
|
},
|
|
"environment": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PRODUCTION"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TESTING"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"flowId": {
|
|
"type": "string"
|
|
},
|
|
"flowVersionId": {
|
|
"type": "string"
|
|
},
|
|
"flowDisplayName": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"FAILED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"QUOTA_EXCEEDED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"INTERNAL_ERROR"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PAUSED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"RUNNING"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"STOPPED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"SUCCEEDED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"MEMORY_LIMIT_EXCEEDED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TIMEOUT"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"startTime",
|
|
"environment",
|
|
"flowId",
|
|
"flowVersionId",
|
|
"flowDisplayName",
|
|
"status"
|
|
]
|
|
},
|
|
"project": {
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"flowRun"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"platformId",
|
|
"action",
|
|
"data"
|
|
]
|
|
},
|
|
"flow.run.finished": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"platformId": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"projectDisplayName": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
},
|
|
"userEmail": {
|
|
"type": "string"
|
|
},
|
|
"ip": {
|
|
"type": "string"
|
|
},
|
|
"action": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"flow.run.started"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"flow.run.finished"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"flowRun": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"startTime": {
|
|
"type": "string"
|
|
},
|
|
"finishTime": {
|
|
"type": "string"
|
|
},
|
|
"duration": {
|
|
"type": "number"
|
|
},
|
|
"environment": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PRODUCTION"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TESTING"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"flowId": {
|
|
"type": "string"
|
|
},
|
|
"flowVersionId": {
|
|
"type": "string"
|
|
},
|
|
"flowDisplayName": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"FAILED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"QUOTA_EXCEEDED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"INTERNAL_ERROR"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PAUSED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"RUNNING"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"STOPPED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"SUCCEEDED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"MEMORY_LIMIT_EXCEEDED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TIMEOUT"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"startTime",
|
|
"environment",
|
|
"flowId",
|
|
"flowVersionId",
|
|
"flowDisplayName",
|
|
"status"
|
|
]
|
|
},
|
|
"project": {
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"flowRun"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"platformId",
|
|
"action",
|
|
"data"
|
|
]
|
|
},
|
|
"user.signed.up": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"platformId": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"projectDisplayName": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
},
|
|
"userEmail": {
|
|
"type": "string"
|
|
},
|
|
"ip": {
|
|
"type": "string"
|
|
},
|
|
"action": {
|
|
"type": "string",
|
|
"enum": [
|
|
"user.signed.up"
|
|
]
|
|
},
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"source": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"credentials"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"sso"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"managed"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"user": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"source"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"platformId",
|
|
"action",
|
|
"data"
|
|
]
|
|
},
|
|
"user.signed.in": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"platformId": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"projectDisplayName": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
},
|
|
"userEmail": {
|
|
"type": "string"
|
|
},
|
|
"ip": {
|
|
"type": "string"
|
|
},
|
|
"action": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"user.signed.in"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"user.password.reset"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"user.email.verified"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"user": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"platformId",
|
|
"action",
|
|
"data"
|
|
]
|
|
},
|
|
"user.password.reset": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"platformId": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"projectDisplayName": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
},
|
|
"userEmail": {
|
|
"type": "string"
|
|
},
|
|
"ip": {
|
|
"type": "string"
|
|
},
|
|
"action": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"user.signed.in"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"user.password.reset"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"user.email.verified"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"user": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"platformId",
|
|
"action",
|
|
"data"
|
|
]
|
|
},
|
|
"user.email.verified": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"platformId": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"projectDisplayName": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
},
|
|
"userEmail": {
|
|
"type": "string"
|
|
},
|
|
"ip": {
|
|
"type": "string"
|
|
},
|
|
"action": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"user.signed.in"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"user.password.reset"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"user.email.verified"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"user": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"platformId",
|
|
"action",
|
|
"data"
|
|
]
|
|
},
|
|
"signing.key.created": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"platformId": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"projectDisplayName": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
},
|
|
"userEmail": {
|
|
"type": "string"
|
|
},
|
|
"ip": {
|
|
"type": "string"
|
|
},
|
|
"action": {
|
|
"type": "string",
|
|
"enum": [
|
|
"signing.key.created"
|
|
]
|
|
},
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"signingKey": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"displayName"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"signingKey"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"platformId",
|
|
"action",
|
|
"data"
|
|
]
|
|
},
|
|
"project.role.created": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"platformId": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"projectDisplayName": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
},
|
|
"userEmail": {
|
|
"type": "string"
|
|
},
|
|
"ip": {
|
|
"type": "string"
|
|
},
|
|
"action": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"project.role.created"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"project.role.updated"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"project.role.deleted"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"projectRole": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"permissions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"platformId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"name",
|
|
"permissions"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"projectRole"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"platformId",
|
|
"action",
|
|
"data"
|
|
]
|
|
},
|
|
"project.release.created": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"platformId": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"projectDisplayName": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
},
|
|
"userEmail": {
|
|
"type": "string"
|
|
},
|
|
"ip": {
|
|
"type": "string"
|
|
},
|
|
"action": {
|
|
"type": "string",
|
|
"enum": [
|
|
"project.release.created"
|
|
]
|
|
},
|
|
"data": {
|
|
"type": "object",
|
|
"properties": {
|
|
"release": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"GIT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PROJECT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ROLLBACK"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"importedByUser": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"firstName": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ACTIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"INACTIVE"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"externalId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"lastChangelogDismissed": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"platformId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"platformRole": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ADMIN"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"MEMBER"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"lastName": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"email",
|
|
"firstName",
|
|
"status",
|
|
"platformRole",
|
|
"lastName",
|
|
"created",
|
|
"updated"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"type",
|
|
"projectId"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"release"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"platformId",
|
|
"action",
|
|
"data"
|
|
]
|
|
},
|
|
"flow-template": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PROJECT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"tags": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"pieces": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"schemaVersion": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"blogUrl": {
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"trigger": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PIECE_TRIGGER"
|
|
]
|
|
},
|
|
"settings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"pieceVersion": {
|
|
"pattern": "^([~^])?[0-9]+\\.[0-9]+\\.[0-9]+$",
|
|
"type": "string"
|
|
},
|
|
"pieceType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"OFFICIAL"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"packageType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ARCHIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"REGISTRY"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"triggerName": {
|
|
"type": "string"
|
|
},
|
|
"input": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"inputUiInfo": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"properties": {
|
|
"sampleDataFileId": {
|
|
"type": "string"
|
|
},
|
|
"sampleDataInputFileId": {
|
|
"type": "string"
|
|
},
|
|
"lastTestDate": {
|
|
"type": "string"
|
|
},
|
|
"customizedInputs": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"currentSelectedData": {}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"pieceName",
|
|
"pieceVersion",
|
|
"pieceType",
|
|
"packageType",
|
|
"input",
|
|
"inputUiInfo"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"EMPTY"
|
|
]
|
|
},
|
|
"settings": {}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"schemaVersion": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"connectionIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"trigger",
|
|
"valid",
|
|
"connectionIds"
|
|
]
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"platformId": {
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"additionalProperties": {}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"name",
|
|
"description",
|
|
"type",
|
|
"tags",
|
|
"pieces",
|
|
"template",
|
|
"platformId"
|
|
]
|
|
},
|
|
"folder": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"displayOrder": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"projectId",
|
|
"displayName",
|
|
"displayOrder"
|
|
]
|
|
},
|
|
"user": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"firstName": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ACTIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"INACTIVE"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"externalId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"lastChangelogDismissed": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"platformId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"platformRole": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ADMIN"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"MEMBER"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"lastName": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"email",
|
|
"firstName",
|
|
"status",
|
|
"platformRole",
|
|
"lastName",
|
|
"created",
|
|
"updated"
|
|
]
|
|
},
|
|
"user-invitation": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PENDING"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ACCEPTED"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PROJECT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"platformId": {
|
|
"type": "string"
|
|
},
|
|
"platformRole": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ADMIN",
|
|
"MEMBER"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"projectId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"projectRoleId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"projectRole": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"permissions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"platformId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"userCount": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"name",
|
|
"permissions",
|
|
"type"
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"email",
|
|
"status",
|
|
"type",
|
|
"platformId"
|
|
]
|
|
},
|
|
"project-member": {
|
|
"description": "Project member is which user is assigned to a project.",
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"platformId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"projectRoleId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"platformId",
|
|
"userId",
|
|
"projectId",
|
|
"projectRoleId"
|
|
]
|
|
},
|
|
"project": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"ownerId": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"notifyStatus": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NEVER"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ALWAYS"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NEW_ISSUE"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"platformId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"releasesEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"additionalProperties": {}
|
|
},
|
|
"usage": {
|
|
"type": "object",
|
|
"properties": {
|
|
"tasks": {
|
|
"type": "number"
|
|
},
|
|
"aiCredits": {
|
|
"type": "number"
|
|
},
|
|
"nextLimitResetDate": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"tasks",
|
|
"aiCredits",
|
|
"nextLimitResetDate"
|
|
]
|
|
},
|
|
"plan": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"piecesFilterType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NONE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ALLOWED"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"pieces": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"tasks": {
|
|
"type": "number",
|
|
"nullable": true
|
|
},
|
|
"aiCredits": {
|
|
"type": "number",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"projectId",
|
|
"name",
|
|
"piecesFilterType",
|
|
"pieces"
|
|
]
|
|
},
|
|
"analytics": {
|
|
"type": "object",
|
|
"properties": {
|
|
"totalUsers": {
|
|
"type": "number"
|
|
},
|
|
"activeUsers": {
|
|
"type": "number"
|
|
},
|
|
"totalFlows": {
|
|
"type": "number"
|
|
},
|
|
"activeFlows": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"totalUsers",
|
|
"activeUsers",
|
|
"totalFlows",
|
|
"activeFlows"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"ownerId",
|
|
"displayName",
|
|
"notifyStatus",
|
|
"platformId",
|
|
"releasesEnabled",
|
|
"usage",
|
|
"plan",
|
|
"analytics"
|
|
]
|
|
},
|
|
"flow": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"folderId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ENABLED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DISABLED"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"schedule": {
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CRON_EXPRESSION"
|
|
]
|
|
},
|
|
"cronExpression": {
|
|
"type": "string"
|
|
},
|
|
"timezone": {
|
|
"type": "string"
|
|
},
|
|
"failureCount": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"cronExpression",
|
|
"timezone"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"handshakeConfiguration": {
|
|
"type": "object",
|
|
"properties": {
|
|
"strategy": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NONE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"HEADER_PRESENT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"QUERY_PRESENT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BODY_PARAM_PRESENT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"paramName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"strategy"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"publishedVersionId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"additionalProperties": {}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"projectId",
|
|
"externalId",
|
|
"status"
|
|
]
|
|
},
|
|
"flow-run": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"flowId": {
|
|
"type": "string"
|
|
},
|
|
"tags": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"flowVersionId": {
|
|
"type": "string"
|
|
},
|
|
"flowDisplayName": {
|
|
"type": "string"
|
|
},
|
|
"terminationReason": {
|
|
"type": "string"
|
|
},
|
|
"logsFileId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"tasks": {
|
|
"type": "number"
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"FAILED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"QUOTA_EXCEEDED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"INTERNAL_ERROR"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PAUSED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"RUNNING"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"STOPPED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"SUCCEEDED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"MEMORY_LIMIT_EXCEEDED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TIMEOUT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"duration": {
|
|
"type": "number"
|
|
},
|
|
"startTime": {
|
|
"type": "string"
|
|
},
|
|
"finishTime": {
|
|
"type": "string"
|
|
},
|
|
"environment": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PRODUCTION"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TESTING"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"pauseMetadata": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"DELAY"
|
|
]
|
|
},
|
|
"resumeDateTime": {
|
|
"type": "string"
|
|
},
|
|
"handlerId": {
|
|
"type": "string"
|
|
},
|
|
"progressUpdateType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"WEBHOOK_RESPONSE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TEST_FLOW"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NONE"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"resumeDateTime"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"WEBHOOK"
|
|
]
|
|
},
|
|
"requestId": {
|
|
"type": "string"
|
|
},
|
|
"response": {
|
|
"type": "object",
|
|
"properties": {
|
|
"status": {
|
|
"type": "number"
|
|
},
|
|
"body": {},
|
|
"headers": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"handlerId": {
|
|
"type": "string"
|
|
},
|
|
"progressUpdateType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"WEBHOOK_RESPONSE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TEST_FLOW"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NONE"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"requestId",
|
|
"response"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"steps": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"failedStepName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"projectId",
|
|
"flowId",
|
|
"flowVersionId",
|
|
"flowDisplayName",
|
|
"status",
|
|
"startTime",
|
|
"environment",
|
|
"steps"
|
|
]
|
|
},
|
|
"app-connection": {
|
|
"description": "App connection is a connection to an external app.",
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"OAUTH2"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM_OAUTH2"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CLOUD_OAUTH2"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"SECRET_TEXT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BASIC_AUTH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM_AUTH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NO_AUTH"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"projectIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"platformId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"scope": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PROJECT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ACTIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"MISSING"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ERROR"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"ownerId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"owner": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"firstName": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ACTIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"INACTIVE"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"externalId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"lastChangelogDismissed": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"platformId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"platformRole": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ADMIN"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"MEMBER"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"lastName": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"email",
|
|
"firstName",
|
|
"status",
|
|
"platformRole",
|
|
"lastName",
|
|
"created",
|
|
"updated"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"additionalProperties": {}
|
|
},
|
|
"flowIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"externalId",
|
|
"displayName",
|
|
"type",
|
|
"pieceName",
|
|
"projectIds",
|
|
"scope",
|
|
"status"
|
|
]
|
|
},
|
|
"piece": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"logoUrl": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"authors": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"platformId": {
|
|
"type": "string"
|
|
},
|
|
"directoryPath": {
|
|
"type": "string"
|
|
},
|
|
"auth": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName"
|
|
]
|
|
},
|
|
"password": {
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName"
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"BASIC_AUTH"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"username",
|
|
"password",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"props": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"SHORT_TEXT"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"LONG_TEXT"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"NUMBER"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CHECKBOX"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"disabled": {
|
|
"type": "boolean"
|
|
},
|
|
"placeholder": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"label": {
|
|
"type": "string"
|
|
},
|
|
"value": {}
|
|
},
|
|
"required": [
|
|
"label",
|
|
"value"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"options"
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"STATIC_DROPDOWN"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"options",
|
|
"type",
|
|
"required"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM_AUTH"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"props",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"props": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"SHORT_TEXT"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"SECRET_TEXT"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"disabled": {
|
|
"type": "boolean"
|
|
},
|
|
"placeholder": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"label": {
|
|
"type": "string"
|
|
},
|
|
"value": {}
|
|
},
|
|
"required": [
|
|
"label",
|
|
"value"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"options"
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"STATIC_DROPDOWN"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"options",
|
|
"type",
|
|
"required"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"authUrl": {
|
|
"type": "string"
|
|
},
|
|
"tokenUrl": {
|
|
"type": "string"
|
|
},
|
|
"scope": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"pkce": {
|
|
"type": "boolean"
|
|
},
|
|
"authorizationMethod": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"HEADER"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BODY"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"grantType": {
|
|
"anyOf": [
|
|
{
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"authorization_code"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"client_credentials"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"both_client_credentials_and_authorization_code"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"extra": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"OAUTH2"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"authUrl",
|
|
"tokenUrl",
|
|
"scope",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"SECRET_TEXT"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"version": {
|
|
"type": "string"
|
|
},
|
|
"categories": {
|
|
"type": "array",
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ARTIFICIAL_INTELLIGENCE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"COMMUNICATION"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"COMMERCE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CORE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"UNIVERSAL_AI"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"FLOW_CONTROL"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BUSINESS_INTELLIGENCE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ACCOUNTING"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PRODUCTIVITY"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CONTENT_AND_FILES"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DEVELOPER_TOOLS"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOMER_SUPPORT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"FORMS_AND_SURVEYS"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"HUMAN_RESOURCES"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PAYMENT_PROCESSING"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"MARKETING"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"SALES_AND_CRM"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"minimumSupportedRelease": {
|
|
"type": "string"
|
|
},
|
|
"maximumSupportedRelease": {
|
|
"type": "string"
|
|
},
|
|
"i18n": {
|
|
"type": "object",
|
|
"properties": {
|
|
"nl": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"en": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"de": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"it": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"fr": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"bg": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"uk": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"hu": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"es": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"ja": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"vi": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"zh": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"pt": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"actions": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"props": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"SHORT_TEXT"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"LONG_TEXT"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"MARKDOWN"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CHECKBOX"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"disabled": {
|
|
"type": "boolean"
|
|
},
|
|
"placeholder": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"label": {
|
|
"type": "string"
|
|
},
|
|
"value": {}
|
|
},
|
|
"required": [
|
|
"label",
|
|
"value"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"options"
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"STATIC_DROPDOWN"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"options",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"disabled": {
|
|
"type": "boolean"
|
|
},
|
|
"placeholder": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"label": {
|
|
"type": "string"
|
|
},
|
|
"value": {}
|
|
},
|
|
"required": [
|
|
"label",
|
|
"value"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"options"
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"STATIC_MULTI_SELECT_DROPDOWN"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"options",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"DROPDOWN"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {},
|
|
"refreshers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required",
|
|
"refreshers"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"MULTI_SELECT_DROPDOWN"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {},
|
|
"refreshers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required",
|
|
"refreshers"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"refreshers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"DYNAMIC"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"refreshers",
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"NUMBER"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"properties": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"SHORT_TEXT"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"LONG_TEXT"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"disabled": {
|
|
"type": "boolean"
|
|
},
|
|
"placeholder": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"label": {
|
|
"type": "string"
|
|
},
|
|
"value": {}
|
|
},
|
|
"required": [
|
|
"label",
|
|
"value"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"options"
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"STATIC_DROPDOWN"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"options",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"MULTI_SELECT_DROPDOWN"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {},
|
|
"refreshers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required",
|
|
"refreshers"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"disabled": {
|
|
"type": "boolean"
|
|
},
|
|
"placeholder": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"label": {
|
|
"type": "string"
|
|
},
|
|
"value": {}
|
|
},
|
|
"required": [
|
|
"label",
|
|
"value"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"options"
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"STATIC_MULTI_SELECT_DROPDOWN"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"options",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CHECKBOX"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"NUMBER"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"FILE"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ARRAY"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"properties",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"OBJECT"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"JSON"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"DATE_TIME"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"FILE"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"COLOR"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName"
|
|
]
|
|
},
|
|
"password": {
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName"
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"BASIC_AUTH"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"username",
|
|
"password",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"props": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"SHORT_TEXT"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"LONG_TEXT"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"NUMBER"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CHECKBOX"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"disabled": {
|
|
"type": "boolean"
|
|
},
|
|
"placeholder": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"label": {
|
|
"type": "string"
|
|
},
|
|
"value": {}
|
|
},
|
|
"required": [
|
|
"label",
|
|
"value"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"options"
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"STATIC_DROPDOWN"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"options",
|
|
"type",
|
|
"required"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM_AUTH"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"props",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"props": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"SHORT_TEXT"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"SECRET_TEXT"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"disabled": {
|
|
"type": "boolean"
|
|
},
|
|
"placeholder": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"label": {
|
|
"type": "string"
|
|
},
|
|
"value": {}
|
|
},
|
|
"required": [
|
|
"label",
|
|
"value"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"options"
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"STATIC_DROPDOWN"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"options",
|
|
"type",
|
|
"required"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"authUrl": {
|
|
"type": "string"
|
|
},
|
|
"tokenUrl": {
|
|
"type": "string"
|
|
},
|
|
"scope": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"pkce": {
|
|
"type": "boolean"
|
|
},
|
|
"authorizationMethod": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"HEADER"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BODY"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"grantType": {
|
|
"anyOf": [
|
|
{
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"authorization_code"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"client_credentials"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"both_client_credentials_and_authorization_code"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"extra": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"OAUTH2"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"authUrl",
|
|
"tokenUrl",
|
|
"scope",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"SECRET_TEXT"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"requireAuth": {
|
|
"type": "boolean"
|
|
},
|
|
"errorHandlingOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"retryOnFailure": {
|
|
"type": "object",
|
|
"properties": {
|
|
"defaultValue": {
|
|
"type": "boolean"
|
|
},
|
|
"hide": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"continueOnFailure": {
|
|
"type": "object",
|
|
"properties": {
|
|
"defaultValue": {
|
|
"type": "boolean"
|
|
},
|
|
"hide": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"retryOnFailure",
|
|
"continueOnFailure"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"displayName",
|
|
"description",
|
|
"props",
|
|
"requireAuth"
|
|
]
|
|
}
|
|
},
|
|
"triggers": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"props": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"SHORT_TEXT"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"LONG_TEXT"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"MARKDOWN"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CHECKBOX"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"disabled": {
|
|
"type": "boolean"
|
|
},
|
|
"placeholder": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"label": {
|
|
"type": "string"
|
|
},
|
|
"value": {}
|
|
},
|
|
"required": [
|
|
"label",
|
|
"value"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"options"
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"STATIC_DROPDOWN"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"options",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"disabled": {
|
|
"type": "boolean"
|
|
},
|
|
"placeholder": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"label": {
|
|
"type": "string"
|
|
},
|
|
"value": {}
|
|
},
|
|
"required": [
|
|
"label",
|
|
"value"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"options"
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"STATIC_MULTI_SELECT_DROPDOWN"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"options",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"DROPDOWN"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {},
|
|
"refreshers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required",
|
|
"refreshers"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"MULTI_SELECT_DROPDOWN"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {},
|
|
"refreshers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required",
|
|
"refreshers"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"refreshers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"DYNAMIC"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"refreshers",
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"NUMBER"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"properties": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"SHORT_TEXT"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"LONG_TEXT"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"disabled": {
|
|
"type": "boolean"
|
|
},
|
|
"placeholder": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"label": {
|
|
"type": "string"
|
|
},
|
|
"value": {}
|
|
},
|
|
"required": [
|
|
"label",
|
|
"value"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"options"
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"STATIC_DROPDOWN"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"options",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"MULTI_SELECT_DROPDOWN"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {},
|
|
"refreshers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required",
|
|
"refreshers"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"disabled": {
|
|
"type": "boolean"
|
|
},
|
|
"placeholder": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"label": {
|
|
"type": "string"
|
|
},
|
|
"value": {}
|
|
},
|
|
"required": [
|
|
"label",
|
|
"value"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"options"
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"STATIC_MULTI_SELECT_DROPDOWN"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"options",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CHECKBOX"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"NUMBER"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"FILE"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ARRAY"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"properties",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"OBJECT"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"JSON"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"DATE_TIME"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"FILE"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"COLOR"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName"
|
|
]
|
|
},
|
|
"password": {
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName"
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"BASIC_AUTH"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"username",
|
|
"password",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"props": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"SHORT_TEXT"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"LONG_TEXT"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"NUMBER"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CHECKBOX"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"disabled": {
|
|
"type": "boolean"
|
|
},
|
|
"placeholder": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"label": {
|
|
"type": "string"
|
|
},
|
|
"value": {}
|
|
},
|
|
"required": [
|
|
"label",
|
|
"value"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"options"
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"STATIC_DROPDOWN"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"options",
|
|
"type",
|
|
"required"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM_AUTH"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"props",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"props": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"SHORT_TEXT"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"SECRET_TEXT"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "object",
|
|
"properties": {
|
|
"disabled": {
|
|
"type": "boolean"
|
|
},
|
|
"placeholder": {
|
|
"type": "string"
|
|
},
|
|
"options": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"label": {
|
|
"type": "string"
|
|
},
|
|
"value": {}
|
|
},
|
|
"required": [
|
|
"label",
|
|
"value"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"options"
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"STATIC_DROPDOWN"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"options",
|
|
"type",
|
|
"required"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"authUrl": {
|
|
"type": "string"
|
|
},
|
|
"tokenUrl": {
|
|
"type": "string"
|
|
},
|
|
"scope": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"pkce": {
|
|
"type": "boolean"
|
|
},
|
|
"authorizationMethod": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"HEADER"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BODY"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"grantType": {
|
|
"anyOf": [
|
|
{
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"authorization_code"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"client_credentials"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"both_client_credentials_and_authorization_code"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"extra": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"OAUTH2"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"authUrl",
|
|
"tokenUrl",
|
|
"scope",
|
|
"type",
|
|
"required"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"SECRET_TEXT"
|
|
]
|
|
},
|
|
"required": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultValue": {}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"type",
|
|
"required"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"errorHandlingOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"retryOnFailure": {
|
|
"type": "object",
|
|
"properties": {
|
|
"defaultValue": {
|
|
"type": "boolean"
|
|
},
|
|
"hide": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"continueOnFailure": {
|
|
"type": "object",
|
|
"properties": {
|
|
"defaultValue": {
|
|
"type": "boolean"
|
|
},
|
|
"hide": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"retryOnFailure",
|
|
"continueOnFailure"
|
|
]
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"POLLING"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"WEBHOOK"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"APP_WEBHOOK"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sampleData": {},
|
|
"handshakeConfiguration": {
|
|
"type": "object",
|
|
"properties": {
|
|
"strategy": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NONE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"HEADER_PRESENT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"QUERY_PRESENT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BODY_PARAM_PRESENT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"paramName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"strategy"
|
|
]
|
|
},
|
|
"renewConfiguration": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"strategy": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CRON"
|
|
]
|
|
},
|
|
"cronExpression": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"strategy",
|
|
"cronExpression"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"strategy": {
|
|
"type": "string",
|
|
"enum": [
|
|
"NONE"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"strategy"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"testStrategy": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"SIMULATION"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TEST_FUNCTION"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"displayName",
|
|
"description",
|
|
"props",
|
|
"type",
|
|
"sampleData",
|
|
"testStrategy"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"displayName",
|
|
"logoUrl",
|
|
"description",
|
|
"authors",
|
|
"version",
|
|
"actions",
|
|
"triggers"
|
|
]
|
|
},
|
|
"git-repo": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"remoteUrl": {
|
|
"type": "string"
|
|
},
|
|
"branch": {
|
|
"type": "string"
|
|
},
|
|
"branchType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PRODUCTION"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DEVELOPMENT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"remoteUrl",
|
|
"branch",
|
|
"branchType",
|
|
"projectId",
|
|
"slug"
|
|
]
|
|
},
|
|
"project-release": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"importedBy": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"fileId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"GIT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PROJECT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ROLLBACK"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"importedByUser": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"firstName": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ACTIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"INACTIVE"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"externalId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"lastChangelogDismissed": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"platformId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"platformRole": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ADMIN"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"MEMBER"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"lastName": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"email",
|
|
"firstName",
|
|
"status",
|
|
"platformRole",
|
|
"lastName",
|
|
"created",
|
|
"updated"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"projectId",
|
|
"name",
|
|
"fileId",
|
|
"type"
|
|
]
|
|
},
|
|
"global-connection": {
|
|
"description": "App connection is a connection to an external app.",
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"OAUTH2"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM_OAUTH2"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CLOUD_OAUTH2"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"SECRET_TEXT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BASIC_AUTH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM_AUTH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NO_AUTH"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"projectIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"platformId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"scope": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PROJECT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ACTIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"MISSING"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ERROR"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"ownerId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"owner": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"firstName": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ACTIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"INACTIVE"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"externalId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"lastChangelogDismissed": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"platformId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"platformRole": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ADMIN"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"MEMBER"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"lastName": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"email",
|
|
"firstName",
|
|
"status",
|
|
"platformRole",
|
|
"lastName",
|
|
"created",
|
|
"updated"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"additionalProperties": {}
|
|
},
|
|
"flowIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"externalId",
|
|
"displayName",
|
|
"type",
|
|
"pieceName",
|
|
"projectIds",
|
|
"scope",
|
|
"status"
|
|
]
|
|
},
|
|
"mcp": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"token": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"agentId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"tools": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PIECE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"FLOW"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"mcpId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"pieceMetadata": {
|
|
"type": "object",
|
|
"properties": {
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"pieceVersion": {
|
|
"type": "string"
|
|
},
|
|
"actionNames": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"logoUrl": {
|
|
"type": "string"
|
|
},
|
|
"connectionExternalId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"pieceName",
|
|
"pieceVersion",
|
|
"actionNames",
|
|
"logoUrl"
|
|
]
|
|
},
|
|
"flowId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"flow": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"folderId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ENABLED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DISABLED"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"schedule": {
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CRON_EXPRESSION"
|
|
]
|
|
},
|
|
"cronExpression": {
|
|
"type": "string"
|
|
},
|
|
"timezone": {
|
|
"type": "string"
|
|
},
|
|
"failureCount": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"cronExpression",
|
|
"timezone"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"handshakeConfiguration": {
|
|
"type": "object",
|
|
"properties": {
|
|
"strategy": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NONE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"HEADER_PRESENT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"QUERY_PRESENT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BODY_PARAM_PRESENT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"paramName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"strategy"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"publishedVersionId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"additionalProperties": {}
|
|
},
|
|
"version": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"flowId": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"trigger": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PIECE_TRIGGER"
|
|
]
|
|
},
|
|
"settings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"pieceVersion": {
|
|
"pattern": "^([~^])?[0-9]+\\.[0-9]+\\.[0-9]+$",
|
|
"type": "string"
|
|
},
|
|
"pieceType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"OFFICIAL"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"packageType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ARCHIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"REGISTRY"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"triggerName": {
|
|
"type": "string"
|
|
},
|
|
"input": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"inputUiInfo": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"properties": {
|
|
"sampleDataFileId": {
|
|
"type": "string"
|
|
},
|
|
"sampleDataInputFileId": {
|
|
"type": "string"
|
|
},
|
|
"lastTestDate": {
|
|
"type": "string"
|
|
},
|
|
"customizedInputs": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"currentSelectedData": {}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"pieceName",
|
|
"pieceVersion",
|
|
"pieceType",
|
|
"packageType",
|
|
"input",
|
|
"inputUiInfo"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"EMPTY"
|
|
]
|
|
},
|
|
"settings": {}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"updatedBy": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"schemaVersion": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"state": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"LOCKED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DRAFT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"connectionIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"flowId",
|
|
"displayName",
|
|
"trigger",
|
|
"valid",
|
|
"state",
|
|
"connectionIds"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"projectId",
|
|
"externalId",
|
|
"status",
|
|
"version"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"type",
|
|
"mcpId"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"name",
|
|
"projectId",
|
|
"token",
|
|
"tools"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"paths": {
|
|
"/v1/folders": {
|
|
"post": {
|
|
"tags": [
|
|
"folders"
|
|
],
|
|
"description": "Create a new folder",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"projectId"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"folders"
|
|
],
|
|
"description": "List folders",
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "number"
|
|
},
|
|
"in": "query",
|
|
"name": "limit",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "cursor",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "projectId",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/folders/{id}": {
|
|
"post": {
|
|
"tags": [
|
|
"folders"
|
|
],
|
|
"description": "Update an existing folder",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"folders"
|
|
],
|
|
"description": "Get a folder by id",
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"folders"
|
|
],
|
|
"description": "Delete a folder",
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/flows": {
|
|
"post": {
|
|
"tags": [
|
|
"flows"
|
|
],
|
|
"description": "Create a flow",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"folderId": {
|
|
"type": "string"
|
|
},
|
|
"folderName": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"projectId"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"201": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"folderId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ENABLED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DISABLED"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"schedule": {
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CRON_EXPRESSION"
|
|
]
|
|
},
|
|
"cronExpression": {
|
|
"type": "string"
|
|
},
|
|
"timezone": {
|
|
"type": "string"
|
|
},
|
|
"failureCount": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"cronExpression",
|
|
"timezone"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"handshakeConfiguration": {
|
|
"type": "object",
|
|
"properties": {
|
|
"strategy": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NONE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"HEADER_PRESENT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"QUERY_PRESENT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BODY_PARAM_PRESENT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"paramName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"strategy"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"publishedVersionId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"additionalProperties": {}
|
|
},
|
|
"version": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"flowId": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"trigger": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PIECE_TRIGGER"
|
|
]
|
|
},
|
|
"settings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"pieceVersion": {
|
|
"pattern": "^([~^])?[0-9]+\\.[0-9]+\\.[0-9]+$",
|
|
"type": "string"
|
|
},
|
|
"pieceType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"OFFICIAL"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"packageType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ARCHIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"REGISTRY"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"triggerName": {
|
|
"type": "string"
|
|
},
|
|
"input": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"inputUiInfo": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"properties": {
|
|
"sampleDataFileId": {
|
|
"type": "string"
|
|
},
|
|
"sampleDataInputFileId": {
|
|
"type": "string"
|
|
},
|
|
"lastTestDate": {
|
|
"type": "string"
|
|
},
|
|
"customizedInputs": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"currentSelectedData": {}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"pieceName",
|
|
"pieceVersion",
|
|
"pieceType",
|
|
"packageType",
|
|
"input",
|
|
"inputUiInfo"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"EMPTY"
|
|
]
|
|
},
|
|
"settings": {}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"updatedBy": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"schemaVersion": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"state": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"LOCKED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DRAFT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"connectionIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"flowId",
|
|
"displayName",
|
|
"trigger",
|
|
"valid",
|
|
"state",
|
|
"connectionIds"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"projectId",
|
|
"externalId",
|
|
"status",
|
|
"version"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"flows"
|
|
],
|
|
"description": "List flows",
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "folderId",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "number"
|
|
},
|
|
"in": "query",
|
|
"name": "limit",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "cursor",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ENABLED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DISABLED"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "projectId",
|
|
"required": true
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "name",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"LOCKED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DRAFT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"in": "query",
|
|
"name": "versionState",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"in": "query",
|
|
"name": "connectionExternalIds",
|
|
"required": false
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"folderId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ENABLED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DISABLED"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"schedule": {
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CRON_EXPRESSION"
|
|
]
|
|
},
|
|
"cronExpression": {
|
|
"type": "string"
|
|
},
|
|
"timezone": {
|
|
"type": "string"
|
|
},
|
|
"failureCount": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"cronExpression",
|
|
"timezone"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"handshakeConfiguration": {
|
|
"type": "object",
|
|
"properties": {
|
|
"strategy": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NONE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"HEADER_PRESENT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"QUERY_PRESENT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BODY_PARAM_PRESENT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"paramName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"strategy"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"publishedVersionId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"additionalProperties": {}
|
|
},
|
|
"version": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"flowId": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"trigger": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PIECE_TRIGGER"
|
|
]
|
|
},
|
|
"settings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"pieceVersion": {
|
|
"pattern": "^([~^])?[0-9]+\\.[0-9]+\\.[0-9]+$",
|
|
"type": "string"
|
|
},
|
|
"pieceType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"OFFICIAL"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"packageType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ARCHIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"REGISTRY"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"triggerName": {
|
|
"type": "string"
|
|
},
|
|
"input": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"inputUiInfo": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"properties": {
|
|
"sampleDataFileId": {
|
|
"type": "string"
|
|
},
|
|
"sampleDataInputFileId": {
|
|
"type": "string"
|
|
},
|
|
"lastTestDate": {
|
|
"type": "string"
|
|
},
|
|
"customizedInputs": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"currentSelectedData": {}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"pieceName",
|
|
"pieceVersion",
|
|
"pieceType",
|
|
"packageType",
|
|
"input",
|
|
"inputUiInfo"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"EMPTY"
|
|
]
|
|
},
|
|
"settings": {}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"updatedBy": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"schemaVersion": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"state": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"LOCKED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DRAFT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"connectionIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"flowId",
|
|
"displayName",
|
|
"trigger",
|
|
"valid",
|
|
"state",
|
|
"connectionIds"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"projectId",
|
|
"externalId",
|
|
"status",
|
|
"version"
|
|
]
|
|
}
|
|
},
|
|
"next": {
|
|
"description": "Cursor to the next page",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"previous": {
|
|
"description": "Cursor to the previous page",
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"data"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/flows/{id}": {
|
|
"post": {
|
|
"tags": [
|
|
"flows"
|
|
],
|
|
"description": "Apply an operation to a flow",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"title": "Move Action",
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"MOVE_ACTION"
|
|
]
|
|
},
|
|
"request": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"newParentStep": {
|
|
"type": "string"
|
|
},
|
|
"stepLocationRelativeToNewParent": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"AFTER"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"INSIDE_LOOP"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"INSIDE_BRANCH"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"branchIndex": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"newParentStep"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"request"
|
|
]
|
|
},
|
|
{
|
|
"title": "Change Status",
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CHANGE_STATUS"
|
|
]
|
|
},
|
|
"request": {
|
|
"type": "object",
|
|
"properties": {
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ENABLED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DISABLED"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"status"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"request"
|
|
]
|
|
},
|
|
{
|
|
"title": "Lock and Publish",
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"LOCK_AND_PUBLISH"
|
|
]
|
|
},
|
|
"request": {
|
|
"type": "object",
|
|
"properties": {
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ENABLED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DISABLED"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"request"
|
|
]
|
|
},
|
|
{
|
|
"title": "Copy as Draft",
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"USE_AS_DRAFT"
|
|
]
|
|
},
|
|
"request": {
|
|
"type": "object",
|
|
"properties": {
|
|
"versionId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"versionId"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"request"
|
|
]
|
|
},
|
|
{
|
|
"title": "Lock Flow",
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"LOCK_FLOW"
|
|
]
|
|
},
|
|
"request": {
|
|
"type": "object",
|
|
"properties": {}
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"request"
|
|
]
|
|
},
|
|
{
|
|
"title": "Import Flow",
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"IMPORT_FLOW"
|
|
]
|
|
},
|
|
"request": {
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"trigger": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PIECE_TRIGGER"
|
|
]
|
|
},
|
|
"settings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"pieceVersion": {
|
|
"pattern": "^([~^])?[0-9]+\\.[0-9]+\\.[0-9]+$",
|
|
"type": "string"
|
|
},
|
|
"pieceType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"OFFICIAL"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"packageType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ARCHIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"REGISTRY"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"triggerName": {
|
|
"type": "string"
|
|
},
|
|
"input": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"inputUiInfo": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"properties": {
|
|
"sampleDataFileId": {
|
|
"type": "string"
|
|
},
|
|
"sampleDataInputFileId": {
|
|
"type": "string"
|
|
},
|
|
"lastTestDate": {
|
|
"type": "string"
|
|
},
|
|
"customizedInputs": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"currentSelectedData": {}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"pieceName",
|
|
"pieceVersion",
|
|
"pieceType",
|
|
"packageType",
|
|
"input",
|
|
"inputUiInfo"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"EMPTY"
|
|
]
|
|
},
|
|
"settings": {}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"schemaVersion": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"trigger"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"request"
|
|
]
|
|
},
|
|
{
|
|
"title": "Change Name",
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CHANGE_NAME"
|
|
]
|
|
},
|
|
"request": {
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"request"
|
|
]
|
|
},
|
|
{
|
|
"title": "Delete Action",
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"DELETE_ACTION"
|
|
]
|
|
},
|
|
"request": {
|
|
"type": "object",
|
|
"properties": {
|
|
"names": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"names"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"request"
|
|
]
|
|
},
|
|
{
|
|
"title": "Update Action",
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"UPDATE_ACTION"
|
|
]
|
|
},
|
|
"request": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"skip": {
|
|
"type": "boolean"
|
|
},
|
|
"customLogoUrl": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CODE"
|
|
]
|
|
},
|
|
"settings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"sourceCode": {
|
|
"type": "object",
|
|
"properties": {
|
|
"packageJson": {
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"packageJson",
|
|
"code"
|
|
]
|
|
},
|
|
"input": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"inputUiInfo": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"properties": {
|
|
"sampleDataFileId": {
|
|
"type": "string"
|
|
},
|
|
"sampleDataInputFileId": {
|
|
"type": "string"
|
|
},
|
|
"lastTestDate": {
|
|
"type": "string"
|
|
},
|
|
"customizedInputs": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"currentSelectedData": {}
|
|
}
|
|
},
|
|
"errorHandlingOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"continueOnFailure": {
|
|
"type": "object",
|
|
"properties": {
|
|
"value": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"value"
|
|
]
|
|
},
|
|
"retryOnFailure": {
|
|
"type": "object",
|
|
"properties": {
|
|
"value": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"value"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"sourceCode",
|
|
"input"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"skip": {
|
|
"type": "boolean"
|
|
},
|
|
"customLogoUrl": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"LOOP_ON_ITEMS"
|
|
]
|
|
},
|
|
"settings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"inputUiInfo": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"properties": {
|
|
"sampleDataFileId": {
|
|
"type": "string"
|
|
},
|
|
"sampleDataInputFileId": {
|
|
"type": "string"
|
|
},
|
|
"lastTestDate": {
|
|
"type": "string"
|
|
},
|
|
"customizedInputs": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"currentSelectedData": {}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"items",
|
|
"inputUiInfo"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"skip": {
|
|
"type": "boolean"
|
|
},
|
|
"customLogoUrl": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PIECE"
|
|
]
|
|
},
|
|
"settings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"packageType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ARCHIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"REGISTRY"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"pieceType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"OFFICIAL"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"pieceVersion": {
|
|
"pattern": "^([~^])?[0-9]+\\.[0-9]+\\.[0-9]+$",
|
|
"type": "string"
|
|
},
|
|
"actionName": {
|
|
"type": "string"
|
|
},
|
|
"input": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"inputUiInfo": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"properties": {
|
|
"sampleDataFileId": {
|
|
"type": "string"
|
|
},
|
|
"sampleDataInputFileId": {
|
|
"type": "string"
|
|
},
|
|
"lastTestDate": {
|
|
"type": "string"
|
|
},
|
|
"customizedInputs": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"currentSelectedData": {}
|
|
}
|
|
},
|
|
"errorHandlingOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"continueOnFailure": {
|
|
"type": "object",
|
|
"properties": {
|
|
"value": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"value"
|
|
]
|
|
},
|
|
"retryOnFailure": {
|
|
"type": "object",
|
|
"properties": {
|
|
"value": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"value"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"packageType",
|
|
"pieceType",
|
|
"pieceName",
|
|
"pieceVersion",
|
|
"input",
|
|
"inputUiInfo"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"skip": {
|
|
"type": "boolean"
|
|
},
|
|
"customLogoUrl": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ROUTER"
|
|
]
|
|
},
|
|
"settings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"branches": {
|
|
"type": "array",
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"conditions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"firstValue": {
|
|
"type": "string"
|
|
},
|
|
"secondValue": {
|
|
"type": "string"
|
|
},
|
|
"caseSensitive": {
|
|
"type": "boolean"
|
|
},
|
|
"operator": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TEXT_CONTAINS"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TEXT_DOES_NOT_CONTAIN"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TEXT_EXACTLY_MATCHES"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TEXT_DOES_NOT_EXACTLY_MATCH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TEXT_START_WITH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TEXT_DOES_NOT_START_WITH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TEXT_ENDS_WITH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TEXT_DOES_NOT_END_WITH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"LIST_CONTAINS"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"LIST_DOES_NOT_CONTAIN"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"firstValue",
|
|
"secondValue"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"firstValue": {
|
|
"type": "string"
|
|
},
|
|
"secondValue": {
|
|
"type": "string"
|
|
},
|
|
"operator": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NUMBER_IS_GREATER_THAN"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NUMBER_IS_LESS_THAN"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NUMBER_IS_EQUAL_TO"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"firstValue",
|
|
"secondValue"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"firstValue": {
|
|
"type": "string"
|
|
},
|
|
"secondValue": {
|
|
"type": "string"
|
|
},
|
|
"operator": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DATE_IS_BEFORE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DATE_IS_EQUAL"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DATE_IS_AFTER"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"firstValue",
|
|
"secondValue"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"firstValue": {
|
|
"type": "string"
|
|
},
|
|
"operator": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"EXISTS"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DOES_NOT_EXIST"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BOOLEAN_IS_TRUE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BOOLEAN_IS_FALSE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"LIST_IS_EMPTY"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"LIST_IS_NOT_EMPTY"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"firstValue"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"branchType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CONDITION"
|
|
]
|
|
},
|
|
"branchName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"conditions",
|
|
"branchType",
|
|
"branchName"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"branchType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"FALLBACK"
|
|
]
|
|
},
|
|
"branchName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"branchType",
|
|
"branchName"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"executionType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"EXECUTE_ALL_MATCH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"EXECUTE_FIRST_MATCH"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"inputUiInfo": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"properties": {
|
|
"sampleDataFileId": {
|
|
"type": "string"
|
|
},
|
|
"sampleDataInputFileId": {
|
|
"type": "string"
|
|
},
|
|
"lastTestDate": {
|
|
"type": "string"
|
|
},
|
|
"customizedInputs": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"currentSelectedData": {}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"branches",
|
|
"executionType",
|
|
"inputUiInfo"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"request"
|
|
]
|
|
},
|
|
{
|
|
"title": "Add Action",
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ADD_ACTION"
|
|
]
|
|
},
|
|
"request": {
|
|
"type": "object",
|
|
"properties": {
|
|
"parentStep": {
|
|
"type": "string"
|
|
},
|
|
"stepLocationRelativeToParent": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"AFTER"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"INSIDE_LOOP"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"INSIDE_BRANCH"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"branchIndex": {
|
|
"type": "number"
|
|
},
|
|
"action": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"skip": {
|
|
"type": "boolean"
|
|
},
|
|
"customLogoUrl": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CODE"
|
|
]
|
|
},
|
|
"settings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"sourceCode": {
|
|
"type": "object",
|
|
"properties": {
|
|
"packageJson": {
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"packageJson",
|
|
"code"
|
|
]
|
|
},
|
|
"input": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"inputUiInfo": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"properties": {
|
|
"sampleDataFileId": {
|
|
"type": "string"
|
|
},
|
|
"sampleDataInputFileId": {
|
|
"type": "string"
|
|
},
|
|
"lastTestDate": {
|
|
"type": "string"
|
|
},
|
|
"customizedInputs": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"currentSelectedData": {}
|
|
}
|
|
},
|
|
"errorHandlingOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"continueOnFailure": {
|
|
"type": "object",
|
|
"properties": {
|
|
"value": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"value"
|
|
]
|
|
},
|
|
"retryOnFailure": {
|
|
"type": "object",
|
|
"properties": {
|
|
"value": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"value"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"sourceCode",
|
|
"input"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"skip": {
|
|
"type": "boolean"
|
|
},
|
|
"customLogoUrl": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"LOOP_ON_ITEMS"
|
|
]
|
|
},
|
|
"settings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"inputUiInfo": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"properties": {
|
|
"sampleDataFileId": {
|
|
"type": "string"
|
|
},
|
|
"sampleDataInputFileId": {
|
|
"type": "string"
|
|
},
|
|
"lastTestDate": {
|
|
"type": "string"
|
|
},
|
|
"customizedInputs": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"currentSelectedData": {}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"items",
|
|
"inputUiInfo"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"skip": {
|
|
"type": "boolean"
|
|
},
|
|
"customLogoUrl": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PIECE"
|
|
]
|
|
},
|
|
"settings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"packageType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ARCHIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"REGISTRY"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"pieceType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"OFFICIAL"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"pieceVersion": {
|
|
"pattern": "^([~^])?[0-9]+\\.[0-9]+\\.[0-9]+$",
|
|
"type": "string"
|
|
},
|
|
"actionName": {
|
|
"type": "string"
|
|
},
|
|
"input": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"inputUiInfo": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"properties": {
|
|
"sampleDataFileId": {
|
|
"type": "string"
|
|
},
|
|
"sampleDataInputFileId": {
|
|
"type": "string"
|
|
},
|
|
"lastTestDate": {
|
|
"type": "string"
|
|
},
|
|
"customizedInputs": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"currentSelectedData": {}
|
|
}
|
|
},
|
|
"errorHandlingOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"continueOnFailure": {
|
|
"type": "object",
|
|
"properties": {
|
|
"value": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"value"
|
|
]
|
|
},
|
|
"retryOnFailure": {
|
|
"type": "object",
|
|
"properties": {
|
|
"value": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"value"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"packageType",
|
|
"pieceType",
|
|
"pieceName",
|
|
"pieceVersion",
|
|
"input",
|
|
"inputUiInfo"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"skip": {
|
|
"type": "boolean"
|
|
},
|
|
"customLogoUrl": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ROUTER"
|
|
]
|
|
},
|
|
"settings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"branches": {
|
|
"type": "array",
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"conditions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"firstValue": {
|
|
"type": "string"
|
|
},
|
|
"secondValue": {
|
|
"type": "string"
|
|
},
|
|
"caseSensitive": {
|
|
"type": "boolean"
|
|
},
|
|
"operator": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TEXT_CONTAINS"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TEXT_DOES_NOT_CONTAIN"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TEXT_EXACTLY_MATCHES"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TEXT_DOES_NOT_EXACTLY_MATCH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TEXT_START_WITH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TEXT_DOES_NOT_START_WITH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TEXT_ENDS_WITH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TEXT_DOES_NOT_END_WITH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"LIST_CONTAINS"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"LIST_DOES_NOT_CONTAIN"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"firstValue",
|
|
"secondValue"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"firstValue": {
|
|
"type": "string"
|
|
},
|
|
"secondValue": {
|
|
"type": "string"
|
|
},
|
|
"operator": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NUMBER_IS_GREATER_THAN"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NUMBER_IS_LESS_THAN"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NUMBER_IS_EQUAL_TO"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"firstValue",
|
|
"secondValue"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"firstValue": {
|
|
"type": "string"
|
|
},
|
|
"secondValue": {
|
|
"type": "string"
|
|
},
|
|
"operator": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DATE_IS_BEFORE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DATE_IS_EQUAL"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DATE_IS_AFTER"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"firstValue",
|
|
"secondValue"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"firstValue": {
|
|
"type": "string"
|
|
},
|
|
"operator": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"EXISTS"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DOES_NOT_EXIST"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BOOLEAN_IS_TRUE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BOOLEAN_IS_FALSE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"LIST_IS_EMPTY"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"LIST_IS_NOT_EMPTY"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"firstValue"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"branchType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CONDITION"
|
|
]
|
|
},
|
|
"branchName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"conditions",
|
|
"branchType",
|
|
"branchName"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"branchType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"FALLBACK"
|
|
]
|
|
},
|
|
"branchName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"branchType",
|
|
"branchName"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"executionType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"EXECUTE_ALL_MATCH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"EXECUTE_FIRST_MATCH"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"inputUiInfo": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"properties": {
|
|
"sampleDataFileId": {
|
|
"type": "string"
|
|
},
|
|
"sampleDataInputFileId": {
|
|
"type": "string"
|
|
},
|
|
"lastTestDate": {
|
|
"type": "string"
|
|
},
|
|
"customizedInputs": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"currentSelectedData": {}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"branches",
|
|
"executionType",
|
|
"inputUiInfo"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"parentStep",
|
|
"action"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"request"
|
|
]
|
|
},
|
|
{
|
|
"title": "Update Trigger",
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"UPDATE_TRIGGER"
|
|
]
|
|
},
|
|
"request": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"EMPTY"
|
|
]
|
|
},
|
|
"settings": {}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PIECE_TRIGGER"
|
|
]
|
|
},
|
|
"settings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"pieceVersion": {
|
|
"pattern": "^([~^])?[0-9]+\\.[0-9]+\\.[0-9]+$",
|
|
"type": "string"
|
|
},
|
|
"pieceType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"OFFICIAL"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"packageType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ARCHIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"REGISTRY"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"triggerName": {
|
|
"type": "string"
|
|
},
|
|
"input": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"inputUiInfo": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"properties": {
|
|
"sampleDataFileId": {
|
|
"type": "string"
|
|
},
|
|
"sampleDataInputFileId": {
|
|
"type": "string"
|
|
},
|
|
"lastTestDate": {
|
|
"type": "string"
|
|
},
|
|
"customizedInputs": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"currentSelectedData": {}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"pieceName",
|
|
"pieceVersion",
|
|
"pieceType",
|
|
"packageType",
|
|
"input",
|
|
"inputUiInfo"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"request"
|
|
]
|
|
},
|
|
{
|
|
"title": "Change Folder",
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CHANGE_FOLDER"
|
|
]
|
|
},
|
|
"request": {
|
|
"type": "object",
|
|
"properties": {
|
|
"folderId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"request"
|
|
]
|
|
},
|
|
{
|
|
"title": "Duplicate Action",
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"DUPLICATE_ACTION"
|
|
]
|
|
},
|
|
"request": {
|
|
"type": "object",
|
|
"properties": {
|
|
"stepName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"stepName"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"request"
|
|
]
|
|
},
|
|
{
|
|
"title": "Delete Branch",
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"DELETE_BRANCH"
|
|
]
|
|
},
|
|
"request": {
|
|
"type": "object",
|
|
"properties": {
|
|
"branchIndex": {
|
|
"type": "number"
|
|
},
|
|
"stepName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"branchIndex",
|
|
"stepName"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"request"
|
|
]
|
|
},
|
|
{
|
|
"title": "Add Branch",
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ADD_BRANCH"
|
|
]
|
|
},
|
|
"request": {
|
|
"type": "object",
|
|
"properties": {
|
|
"branchIndex": {
|
|
"type": "number"
|
|
},
|
|
"stepName": {
|
|
"type": "string"
|
|
},
|
|
"conditions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"firstValue": {
|
|
"type": "string"
|
|
},
|
|
"secondValue": {
|
|
"type": "string"
|
|
},
|
|
"caseSensitive": {
|
|
"type": "boolean"
|
|
},
|
|
"operator": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TEXT_CONTAINS"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TEXT_DOES_NOT_CONTAIN"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TEXT_EXACTLY_MATCHES"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TEXT_DOES_NOT_EXACTLY_MATCH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TEXT_START_WITH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TEXT_DOES_NOT_START_WITH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TEXT_ENDS_WITH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TEXT_DOES_NOT_END_WITH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"LIST_CONTAINS"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"LIST_DOES_NOT_CONTAIN"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"firstValue",
|
|
"secondValue"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"firstValue": {
|
|
"type": "string"
|
|
},
|
|
"secondValue": {
|
|
"type": "string"
|
|
},
|
|
"operator": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NUMBER_IS_GREATER_THAN"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NUMBER_IS_LESS_THAN"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NUMBER_IS_EQUAL_TO"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"firstValue",
|
|
"secondValue"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"firstValue": {
|
|
"type": "string"
|
|
},
|
|
"secondValue": {
|
|
"type": "string"
|
|
},
|
|
"operator": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DATE_IS_BEFORE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DATE_IS_EQUAL"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DATE_IS_AFTER"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"firstValue",
|
|
"secondValue"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"firstValue": {
|
|
"type": "string"
|
|
},
|
|
"operator": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"EXISTS"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DOES_NOT_EXIST"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BOOLEAN_IS_TRUE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BOOLEAN_IS_FALSE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"LIST_IS_EMPTY"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"LIST_IS_NOT_EMPTY"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"firstValue"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"branchName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"branchIndex",
|
|
"stepName",
|
|
"branchName"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"request"
|
|
]
|
|
},
|
|
{
|
|
"title": "Duplicate Branch",
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"DUPLICATE_BRANCH"
|
|
]
|
|
},
|
|
"request": {
|
|
"type": "object",
|
|
"properties": {
|
|
"branchIndex": {
|
|
"type": "number"
|
|
},
|
|
"stepName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"branchIndex",
|
|
"stepName"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"request"
|
|
]
|
|
},
|
|
{
|
|
"title": "Skip Action",
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"SET_SKIP_ACTION"
|
|
]
|
|
},
|
|
"request": {
|
|
"type": "object",
|
|
"properties": {
|
|
"names": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"skip": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"names",
|
|
"skip"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"request"
|
|
]
|
|
},
|
|
{
|
|
"title": "Update Metadata",
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"UPDATE_METADATA"
|
|
]
|
|
},
|
|
"request": {
|
|
"type": "object",
|
|
"properties": {
|
|
"metadata": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"additionalProperties": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"request"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"MOVE_BRANCH"
|
|
]
|
|
},
|
|
"request": {
|
|
"type": "object",
|
|
"properties": {
|
|
"sourceBranchIndex": {
|
|
"type": "number"
|
|
},
|
|
"targetBranchIndex": {
|
|
"type": "number"
|
|
},
|
|
"stepName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"sourceBranchIndex",
|
|
"targetBranchIndex",
|
|
"stepName"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"request"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"SAVE_SAMPLE_DATA"
|
|
]
|
|
},
|
|
"request": {
|
|
"type": "object",
|
|
"properties": {
|
|
"stepName": {
|
|
"type": "string"
|
|
},
|
|
"payload": {},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"INPUT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"OUTPUT"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"stepName",
|
|
"payload",
|
|
"type"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"request"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"flows"
|
|
],
|
|
"description": "Get a flow by id",
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "versionId",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"folderId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ENABLED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DISABLED"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"schedule": {
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CRON_EXPRESSION"
|
|
]
|
|
},
|
|
"cronExpression": {
|
|
"type": "string"
|
|
},
|
|
"timezone": {
|
|
"type": "string"
|
|
},
|
|
"failureCount": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"cronExpression",
|
|
"timezone"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"handshakeConfiguration": {
|
|
"type": "object",
|
|
"properties": {
|
|
"strategy": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NONE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"HEADER_PRESENT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"QUERY_PRESENT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BODY_PARAM_PRESENT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"paramName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"strategy"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"publishedVersionId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"additionalProperties": {}
|
|
},
|
|
"version": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"flowId": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"trigger": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PIECE_TRIGGER"
|
|
]
|
|
},
|
|
"settings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"pieceVersion": {
|
|
"pattern": "^([~^])?[0-9]+\\.[0-9]+\\.[0-9]+$",
|
|
"type": "string"
|
|
},
|
|
"pieceType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"OFFICIAL"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"packageType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ARCHIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"REGISTRY"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"triggerName": {
|
|
"type": "string"
|
|
},
|
|
"input": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"inputUiInfo": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"properties": {
|
|
"sampleDataFileId": {
|
|
"type": "string"
|
|
},
|
|
"sampleDataInputFileId": {
|
|
"type": "string"
|
|
},
|
|
"lastTestDate": {
|
|
"type": "string"
|
|
},
|
|
"customizedInputs": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"currentSelectedData": {}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"pieceName",
|
|
"pieceVersion",
|
|
"pieceType",
|
|
"packageType",
|
|
"input",
|
|
"inputUiInfo"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"EMPTY"
|
|
]
|
|
},
|
|
"settings": {}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"updatedBy": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"schemaVersion": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"state": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"LOCKED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DRAFT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"connectionIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"flowId",
|
|
"displayName",
|
|
"trigger",
|
|
"valid",
|
|
"state",
|
|
"connectionIds"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"projectId",
|
|
"externalId",
|
|
"status",
|
|
"version"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"flows"
|
|
],
|
|
"description": "Delete a flow",
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"204": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"not": {}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/flows/{id}/template": {
|
|
"get": {
|
|
"tags": [
|
|
"flows"
|
|
],
|
|
"description": "Export flow as template",
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "versionId",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"tags": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"pieces": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"schemaVersion": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"blogUrl": {
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"trigger": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PIECE_TRIGGER"
|
|
]
|
|
},
|
|
"settings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"pieceVersion": {
|
|
"pattern": "^([~^])?[0-9]+\\.[0-9]+\\.[0-9]+$",
|
|
"type": "string"
|
|
},
|
|
"pieceType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"OFFICIAL"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"packageType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ARCHIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"REGISTRY"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"triggerName": {
|
|
"type": "string"
|
|
},
|
|
"input": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"inputUiInfo": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"properties": {
|
|
"sampleDataFileId": {
|
|
"type": "string"
|
|
},
|
|
"sampleDataInputFileId": {
|
|
"type": "string"
|
|
},
|
|
"lastTestDate": {
|
|
"type": "string"
|
|
},
|
|
"customizedInputs": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"currentSelectedData": {}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"pieceName",
|
|
"pieceVersion",
|
|
"pieceType",
|
|
"packageType",
|
|
"input",
|
|
"inputUiInfo"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"EMPTY"
|
|
]
|
|
},
|
|
"settings": {}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"schemaVersion": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"connectionIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"trigger",
|
|
"valid",
|
|
"connectionIds"
|
|
]
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"additionalProperties": {}
|
|
}
|
|
},
|
|
"required": [
|
|
"created",
|
|
"updated",
|
|
"name",
|
|
"description",
|
|
"tags",
|
|
"pieces",
|
|
"template"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/sample-data": {
|
|
"get": {
|
|
"tags": [
|
|
"sample-data"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "flowId",
|
|
"required": true
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "flowVersionId",
|
|
"required": true
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "stepName",
|
|
"required": true
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "projectId",
|
|
"required": true
|
|
},
|
|
{
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"INPUT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"OUTPUT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"in": "query",
|
|
"name": "type",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/flow-runs": {
|
|
"get": {
|
|
"tags": [
|
|
"flow-runs"
|
|
],
|
|
"description": "List Flow Runs",
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"in": "query",
|
|
"name": "flowId",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"in": "query",
|
|
"name": "tags",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"FAILED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"QUOTA_EXCEEDED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"INTERNAL_ERROR"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PAUSED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"RUNNING"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"STOPPED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"SUCCEEDED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"MEMORY_LIMIT_EXCEEDED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TIMEOUT"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "number"
|
|
},
|
|
"in": "query",
|
|
"name": "limit",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "cursor",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "createdAfter",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "createdBefore",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "projectId",
|
|
"required": true
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "failedStepName",
|
|
"required": false
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"flowId": {
|
|
"type": "string"
|
|
},
|
|
"tags": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"flowVersionId": {
|
|
"type": "string"
|
|
},
|
|
"flowDisplayName": {
|
|
"type": "string"
|
|
},
|
|
"logsFileId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"tasks": {
|
|
"type": "number"
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"FAILED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"QUOTA_EXCEEDED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"INTERNAL_ERROR"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PAUSED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"RUNNING"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"STOPPED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"SUCCEEDED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"MEMORY_LIMIT_EXCEEDED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TIMEOUT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"duration": {
|
|
"type": "number"
|
|
},
|
|
"startTime": {
|
|
"type": "string"
|
|
},
|
|
"finishTime": {
|
|
"type": "string"
|
|
},
|
|
"environment": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PRODUCTION"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TESTING"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"failedStepName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"projectId",
|
|
"flowId",
|
|
"flowVersionId",
|
|
"flowDisplayName",
|
|
"status",
|
|
"startTime",
|
|
"environment"
|
|
]
|
|
}
|
|
},
|
|
"next": {
|
|
"description": "Cursor to the next page",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"previous": {
|
|
"description": "Cursor to the previous page",
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"data"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/flow-runs/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"flow-runs"
|
|
],
|
|
"description": "Get Flow Run",
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"flowId": {
|
|
"type": "string"
|
|
},
|
|
"tags": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"flowVersionId": {
|
|
"type": "string"
|
|
},
|
|
"flowDisplayName": {
|
|
"type": "string"
|
|
},
|
|
"logsFileId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"tasks": {
|
|
"type": "number"
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"FAILED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"QUOTA_EXCEEDED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"INTERNAL_ERROR"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PAUSED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"RUNNING"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"STOPPED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"SUCCEEDED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"MEMORY_LIMIT_EXCEEDED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TIMEOUT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"duration": {
|
|
"type": "number"
|
|
},
|
|
"startTime": {
|
|
"type": "string"
|
|
},
|
|
"finishTime": {
|
|
"type": "string"
|
|
},
|
|
"environment": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PRODUCTION"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"TESTING"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"steps": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"failedStepName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"projectId",
|
|
"flowId",
|
|
"flowVersionId",
|
|
"flowDisplayName",
|
|
"status",
|
|
"startTime",
|
|
"environment",
|
|
"steps"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/app-connections": {
|
|
"post": {
|
|
"tags": [
|
|
"app-connections"
|
|
],
|
|
"description": "Upsert an app connection based on the app name",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"title": "Secret Text",
|
|
"description": "Secret Text",
|
|
"type": "object",
|
|
"properties": {
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"SECRET_TEXT"
|
|
]
|
|
},
|
|
"value": {
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"SECRET_TEXT"
|
|
]
|
|
},
|
|
"secret_text": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"secret_text"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"externalId",
|
|
"displayName",
|
|
"pieceName",
|
|
"projectId",
|
|
"type",
|
|
"value"
|
|
]
|
|
},
|
|
{
|
|
"title": "OAuth2",
|
|
"description": "OAuth2",
|
|
"type": "object",
|
|
"properties": {
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"OAUTH2"
|
|
]
|
|
},
|
|
"value": {
|
|
"type": "object",
|
|
"properties": {
|
|
"client_id": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"code_challenge": {
|
|
"type": "string"
|
|
},
|
|
"scope": {
|
|
"type": "string"
|
|
},
|
|
"authorization_method": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"HEADER"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BODY"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"client_secret": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"grant_type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"authorization_code"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"client_credentials"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"props": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"redirect_url": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"OAUTH2"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"client_id",
|
|
"code",
|
|
"scope",
|
|
"client_secret",
|
|
"redirect_url",
|
|
"type"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"externalId",
|
|
"displayName",
|
|
"pieceName",
|
|
"projectId",
|
|
"type",
|
|
"value"
|
|
]
|
|
},
|
|
{
|
|
"title": "Cloud OAuth2",
|
|
"description": "Cloud OAuth2",
|
|
"type": "object",
|
|
"properties": {
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CLOUD_OAUTH2"
|
|
]
|
|
},
|
|
"value": {
|
|
"type": "object",
|
|
"properties": {
|
|
"client_id": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"code_challenge": {
|
|
"type": "string"
|
|
},
|
|
"scope": {
|
|
"type": "string"
|
|
},
|
|
"authorization_method": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"HEADER"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BODY"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"props": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CLOUD_OAUTH2"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"client_id",
|
|
"code",
|
|
"scope",
|
|
"type"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"externalId",
|
|
"displayName",
|
|
"pieceName",
|
|
"projectId",
|
|
"type",
|
|
"value"
|
|
]
|
|
},
|
|
{
|
|
"title": "Platform OAuth2",
|
|
"description": "Platform OAuth2",
|
|
"type": "object",
|
|
"properties": {
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM_OAUTH2"
|
|
]
|
|
},
|
|
"value": {
|
|
"type": "object",
|
|
"properties": {
|
|
"client_id": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"code_challenge": {
|
|
"type": "string"
|
|
},
|
|
"scope": {
|
|
"type": "string"
|
|
},
|
|
"authorization_method": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"HEADER"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BODY"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"props": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM_OAUTH2"
|
|
]
|
|
},
|
|
"redirect_url": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"client_id",
|
|
"code",
|
|
"scope",
|
|
"type",
|
|
"redirect_url"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"externalId",
|
|
"displayName",
|
|
"pieceName",
|
|
"projectId",
|
|
"type",
|
|
"value"
|
|
]
|
|
},
|
|
{
|
|
"title": "Basic Auth",
|
|
"description": "Basic Auth",
|
|
"type": "object",
|
|
"properties": {
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"BASIC_AUTH"
|
|
]
|
|
},
|
|
"value": {
|
|
"type": "object",
|
|
"properties": {
|
|
"username": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"BASIC_AUTH"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"username",
|
|
"password",
|
|
"type"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"externalId",
|
|
"displayName",
|
|
"pieceName",
|
|
"projectId",
|
|
"type",
|
|
"value"
|
|
]
|
|
},
|
|
{
|
|
"title": "Custom Auth",
|
|
"description": "Custom Auth",
|
|
"type": "object",
|
|
"properties": {
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM_AUTH"
|
|
]
|
|
},
|
|
"value": {
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM_AUTH"
|
|
]
|
|
},
|
|
"props": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"props"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"externalId",
|
|
"displayName",
|
|
"pieceName",
|
|
"projectId",
|
|
"type",
|
|
"value"
|
|
]
|
|
},
|
|
{
|
|
"title": "No Auth",
|
|
"description": "No Auth",
|
|
"type": "object",
|
|
"properties": {
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"NO_AUTH"
|
|
]
|
|
},
|
|
"value": {
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"NO_AUTH"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"externalId",
|
|
"displayName",
|
|
"pieceName",
|
|
"projectId",
|
|
"type",
|
|
"value"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"app-connections"
|
|
],
|
|
"description": "List app connections",
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "cursor",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "projectId",
|
|
"required": true
|
|
},
|
|
{
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PROJECT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"in": "query",
|
|
"name": "scope",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "pieceName",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "displayName",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ACTIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"MISSING"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ERROR"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "number"
|
|
},
|
|
"in": "query",
|
|
"name": "limit",
|
|
"required": false
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"description": "App connection is a connection to an external app.",
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"OAUTH2"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM_OAUTH2"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CLOUD_OAUTH2"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"SECRET_TEXT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BASIC_AUTH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM_AUTH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NO_AUTH"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"projectIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"platformId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"scope": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PROJECT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ACTIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"MISSING"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ERROR"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"ownerId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"owner": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"firstName": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ACTIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"INACTIVE"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"externalId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"lastChangelogDismissed": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"platformId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"platformRole": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ADMIN"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"MEMBER"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"lastName": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"email",
|
|
"firstName",
|
|
"status",
|
|
"platformRole",
|
|
"lastName",
|
|
"created",
|
|
"updated"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"additionalProperties": {}
|
|
},
|
|
"flowIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"externalId",
|
|
"displayName",
|
|
"type",
|
|
"pieceName",
|
|
"projectIds",
|
|
"scope",
|
|
"status"
|
|
]
|
|
}
|
|
},
|
|
"next": {
|
|
"description": "Cursor to the next page",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"previous": {
|
|
"description": "Cursor to the previous page",
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"data"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/app-connections/{id}": {
|
|
"post": {
|
|
"tags": [
|
|
"app-connections"
|
|
],
|
|
"description": "Update an app connection value",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"app-connections"
|
|
],
|
|
"description": "Delete an app connection",
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"204": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"not": {}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/app-connections/owners": {
|
|
"get": {
|
|
"tags": [
|
|
"app-connections"
|
|
],
|
|
"description": "List app connection owners",
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "projectId",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"firstName": {
|
|
"type": "string"
|
|
},
|
|
"lastName": {
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"firstName",
|
|
"lastName",
|
|
"email"
|
|
]
|
|
}
|
|
},
|
|
"next": {
|
|
"description": "Cursor to the next page",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"previous": {
|
|
"description": "Cursor to the previous page",
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"data"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/app-connections/replace": {
|
|
"post": {
|
|
"tags": [
|
|
"app-connections"
|
|
],
|
|
"description": "Replace app connections",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"sourceAppConnectionId": {
|
|
"type": "string"
|
|
},
|
|
"targetAppConnectionId": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"sourceAppConnectionId",
|
|
"targetAppConnectionId",
|
|
"projectId"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"204": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"not": {}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/platforms/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"platforms"
|
|
],
|
|
"description": "Get a platform by id",
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"federatedAuthProviders": {
|
|
"type": "object",
|
|
"properties": {
|
|
"google": {
|
|
"type": "object",
|
|
"properties": {
|
|
"clientId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"clientId"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"github": {
|
|
"type": "object",
|
|
"properties": {
|
|
"clientId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"clientId"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"saml": {
|
|
"type": "object",
|
|
"properties": {},
|
|
"nullable": true
|
|
}
|
|
},
|
|
"nullable": true
|
|
},
|
|
"copilotSettings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"providers": {
|
|
"type": "object",
|
|
"properties": {
|
|
"openai": {
|
|
"type": "object",
|
|
"properties": {}
|
|
},
|
|
"azureOpenai": {
|
|
"type": "object",
|
|
"properties": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"providers"
|
|
]
|
|
},
|
|
"smtp": {
|
|
"type": "object",
|
|
"properties": {},
|
|
"nullable": true
|
|
},
|
|
"plan": {
|
|
"type": "object",
|
|
"properties": {
|
|
"includedTasks": {
|
|
"type": "number"
|
|
},
|
|
"includedAiCredits": {
|
|
"type": "number"
|
|
},
|
|
"tasksLimit": {
|
|
"type": "number"
|
|
},
|
|
"aiCreditsLimit": {
|
|
"type": "number"
|
|
},
|
|
"environmentsEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"analyticsEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"showPoweredBy": {
|
|
"type": "boolean"
|
|
},
|
|
"auditLogEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"embeddingEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"managePiecesEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"manageTemplatesEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"customAppearanceEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"manageProjectsEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"projectRolesEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"customDomainsEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"globalConnectionsEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"customRolesEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"apiKeysEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"tablesEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"todosEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"alertsEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"ssoEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"licenseKey": {
|
|
"type": "string"
|
|
},
|
|
"licenseExpiresAt": {
|
|
"type": "string"
|
|
},
|
|
"stripeCustomerId": {
|
|
"type": "string"
|
|
},
|
|
"stripeSubscriptionId": {
|
|
"type": "string"
|
|
},
|
|
"stripeSubscriptionStatus": {
|
|
"type": "string"
|
|
},
|
|
"userSeatsLimit": {
|
|
"type": "number"
|
|
},
|
|
"projectsLimit": {
|
|
"type": "number"
|
|
},
|
|
"tablesLimit": {
|
|
"type": "number"
|
|
},
|
|
"mcpLimit": {
|
|
"type": "number"
|
|
},
|
|
"activeFlowsLimit": {
|
|
"type": "number"
|
|
},
|
|
"agentsLimit": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"includedTasks",
|
|
"includedAiCredits",
|
|
"environmentsEnabled",
|
|
"analyticsEnabled",
|
|
"showPoweredBy",
|
|
"auditLogEnabled",
|
|
"embeddingEnabled",
|
|
"managePiecesEnabled",
|
|
"manageTemplatesEnabled",
|
|
"customAppearanceEnabled",
|
|
"manageProjectsEnabled",
|
|
"projectRolesEnabled",
|
|
"customDomainsEnabled",
|
|
"globalConnectionsEnabled",
|
|
"customRolesEnabled",
|
|
"apiKeysEnabled",
|
|
"tablesEnabled",
|
|
"todosEnabled",
|
|
"alertsEnabled",
|
|
"ssoEnabled"
|
|
]
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"ownerId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"primaryColor": {
|
|
"type": "string"
|
|
},
|
|
"logoIconUrl": {
|
|
"type": "string"
|
|
},
|
|
"fullLogoUrl": {
|
|
"type": "string"
|
|
},
|
|
"favIconUrl": {
|
|
"type": "string"
|
|
},
|
|
"filteredPieceNames": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"filteredPieceBehavior": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ALLOWED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BLOCKED"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"cloudAuthEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"enforceAllowedAuthDomains": {
|
|
"type": "boolean"
|
|
},
|
|
"allowedAuthDomains": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"emailAuthEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"pinnedPieces": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"plan",
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"ownerId",
|
|
"name",
|
|
"primaryColor",
|
|
"logoIconUrl",
|
|
"fullLogoUrl",
|
|
"favIconUrl",
|
|
"filteredPieceNames",
|
|
"filteredPieceBehavior",
|
|
"cloudAuthEnabled",
|
|
"enforceAllowedAuthDomains",
|
|
"allowedAuthDomains",
|
|
"emailAuthEnabled",
|
|
"pinnedPieces"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/mcp-servers": {
|
|
"post": {
|
|
"tags": [
|
|
"mcp"
|
|
],
|
|
"description": "Create a new MCP server",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"projectId"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"token": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"agentId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"tools": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PIECE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"FLOW"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"mcpId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"pieceMetadata": {
|
|
"type": "object",
|
|
"properties": {
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"pieceVersion": {
|
|
"type": "string"
|
|
},
|
|
"actionNames": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"logoUrl": {
|
|
"type": "string"
|
|
},
|
|
"connectionExternalId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"pieceName",
|
|
"pieceVersion",
|
|
"actionNames",
|
|
"logoUrl"
|
|
]
|
|
},
|
|
"flowId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"flow": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"folderId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ENABLED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DISABLED"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"schedule": {
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CRON_EXPRESSION"
|
|
]
|
|
},
|
|
"cronExpression": {
|
|
"type": "string"
|
|
},
|
|
"timezone": {
|
|
"type": "string"
|
|
},
|
|
"failureCount": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"cronExpression",
|
|
"timezone"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"handshakeConfiguration": {
|
|
"type": "object",
|
|
"properties": {
|
|
"strategy": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NONE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"HEADER_PRESENT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"QUERY_PRESENT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BODY_PARAM_PRESENT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"paramName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"strategy"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"publishedVersionId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"additionalProperties": {}
|
|
},
|
|
"version": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"flowId": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"trigger": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PIECE_TRIGGER"
|
|
]
|
|
},
|
|
"settings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"pieceVersion": {
|
|
"pattern": "^([~^])?[0-9]+\\.[0-9]+\\.[0-9]+$",
|
|
"type": "string"
|
|
},
|
|
"pieceType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"OFFICIAL"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"packageType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ARCHIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"REGISTRY"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"triggerName": {
|
|
"type": "string"
|
|
},
|
|
"input": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"inputUiInfo": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"properties": {
|
|
"sampleDataFileId": {
|
|
"type": "string"
|
|
},
|
|
"sampleDataInputFileId": {
|
|
"type": "string"
|
|
},
|
|
"lastTestDate": {
|
|
"type": "string"
|
|
},
|
|
"customizedInputs": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"currentSelectedData": {}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"pieceName",
|
|
"pieceVersion",
|
|
"pieceType",
|
|
"packageType",
|
|
"input",
|
|
"inputUiInfo"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"EMPTY"
|
|
]
|
|
},
|
|
"settings": {}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"updatedBy": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"schemaVersion": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"state": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"LOCKED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DRAFT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"connectionIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"flowId",
|
|
"displayName",
|
|
"trigger",
|
|
"valid",
|
|
"state",
|
|
"connectionIds"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"projectId",
|
|
"externalId",
|
|
"status",
|
|
"version"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"type",
|
|
"mcpId"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"name",
|
|
"projectId",
|
|
"token",
|
|
"tools"
|
|
],
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"mcp"
|
|
],
|
|
"description": "List MCP servers",
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "number"
|
|
},
|
|
"in": "query",
|
|
"name": "limit",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "cursor",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "projectId",
|
|
"required": true
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "name",
|
|
"required": false
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"token": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"agentId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"tools": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PIECE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"FLOW"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"mcpId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"pieceMetadata": {
|
|
"type": "object",
|
|
"properties": {
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"pieceVersion": {
|
|
"type": "string"
|
|
},
|
|
"actionNames": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"logoUrl": {
|
|
"type": "string"
|
|
},
|
|
"connectionExternalId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"pieceName",
|
|
"pieceVersion",
|
|
"actionNames",
|
|
"logoUrl"
|
|
]
|
|
},
|
|
"flowId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"flow": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"folderId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ENABLED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DISABLED"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"schedule": {
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CRON_EXPRESSION"
|
|
]
|
|
},
|
|
"cronExpression": {
|
|
"type": "string"
|
|
},
|
|
"timezone": {
|
|
"type": "string"
|
|
},
|
|
"failureCount": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"cronExpression",
|
|
"timezone"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"handshakeConfiguration": {
|
|
"type": "object",
|
|
"properties": {
|
|
"strategy": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NONE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"HEADER_PRESENT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"QUERY_PRESENT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BODY_PARAM_PRESENT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"paramName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"strategy"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"publishedVersionId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"additionalProperties": {}
|
|
},
|
|
"version": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"flowId": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"trigger": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PIECE_TRIGGER"
|
|
]
|
|
},
|
|
"settings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"pieceVersion": {
|
|
"pattern": "^([~^])?[0-9]+\\.[0-9]+\\.[0-9]+$",
|
|
"type": "string"
|
|
},
|
|
"pieceType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"OFFICIAL"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"packageType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ARCHIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"REGISTRY"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"triggerName": {
|
|
"type": "string"
|
|
},
|
|
"input": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"inputUiInfo": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"properties": {
|
|
"sampleDataFileId": {
|
|
"type": "string"
|
|
},
|
|
"sampleDataInputFileId": {
|
|
"type": "string"
|
|
},
|
|
"lastTestDate": {
|
|
"type": "string"
|
|
},
|
|
"customizedInputs": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"currentSelectedData": {}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"pieceName",
|
|
"pieceVersion",
|
|
"pieceType",
|
|
"packageType",
|
|
"input",
|
|
"inputUiInfo"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"EMPTY"
|
|
]
|
|
},
|
|
"settings": {}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"updatedBy": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"schemaVersion": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"state": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"LOCKED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DRAFT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"connectionIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"flowId",
|
|
"displayName",
|
|
"trigger",
|
|
"valid",
|
|
"state",
|
|
"connectionIds"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"projectId",
|
|
"externalId",
|
|
"status",
|
|
"version"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"type",
|
|
"mcpId"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"name",
|
|
"projectId",
|
|
"token",
|
|
"tools"
|
|
]
|
|
}
|
|
},
|
|
"next": {
|
|
"description": "Cursor to the next page",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"previous": {
|
|
"description": "Cursor to the previous page",
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"data"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/mcp-servers/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"mcp"
|
|
],
|
|
"description": "Get an MCP server by ID",
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"token": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"agentId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"tools": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PIECE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"FLOW"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"mcpId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"pieceMetadata": {
|
|
"type": "object",
|
|
"properties": {
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"pieceVersion": {
|
|
"type": "string"
|
|
},
|
|
"actionNames": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"logoUrl": {
|
|
"type": "string"
|
|
},
|
|
"connectionExternalId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"pieceName",
|
|
"pieceVersion",
|
|
"actionNames",
|
|
"logoUrl"
|
|
]
|
|
},
|
|
"flowId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"flow": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"folderId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ENABLED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DISABLED"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"schedule": {
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CRON_EXPRESSION"
|
|
]
|
|
},
|
|
"cronExpression": {
|
|
"type": "string"
|
|
},
|
|
"timezone": {
|
|
"type": "string"
|
|
},
|
|
"failureCount": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"cronExpression",
|
|
"timezone"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"handshakeConfiguration": {
|
|
"type": "object",
|
|
"properties": {
|
|
"strategy": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NONE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"HEADER_PRESENT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"QUERY_PRESENT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BODY_PARAM_PRESENT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"paramName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"strategy"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"publishedVersionId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"additionalProperties": {}
|
|
},
|
|
"version": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"flowId": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"trigger": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PIECE_TRIGGER"
|
|
]
|
|
},
|
|
"settings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"pieceVersion": {
|
|
"pattern": "^([~^])?[0-9]+\\.[0-9]+\\.[0-9]+$",
|
|
"type": "string"
|
|
},
|
|
"pieceType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"OFFICIAL"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"packageType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ARCHIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"REGISTRY"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"triggerName": {
|
|
"type": "string"
|
|
},
|
|
"input": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"inputUiInfo": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"properties": {
|
|
"sampleDataFileId": {
|
|
"type": "string"
|
|
},
|
|
"sampleDataInputFileId": {
|
|
"type": "string"
|
|
},
|
|
"lastTestDate": {
|
|
"type": "string"
|
|
},
|
|
"customizedInputs": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"currentSelectedData": {}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"pieceName",
|
|
"pieceVersion",
|
|
"pieceType",
|
|
"packageType",
|
|
"input",
|
|
"inputUiInfo"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"EMPTY"
|
|
]
|
|
},
|
|
"settings": {}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"updatedBy": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"schemaVersion": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"state": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"LOCKED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DRAFT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"connectionIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"flowId",
|
|
"displayName",
|
|
"trigger",
|
|
"valid",
|
|
"state",
|
|
"connectionIds"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"projectId",
|
|
"externalId",
|
|
"status",
|
|
"version"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"type",
|
|
"mcpId"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"name",
|
|
"projectId",
|
|
"token",
|
|
"tools"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"mcp"
|
|
],
|
|
"description": "Update the project MCP server configuration",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"tools": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PIECE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"FLOW"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"mcpId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"pieceMetadata": {
|
|
"type": "object",
|
|
"properties": {
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"pieceVersion": {
|
|
"type": "string"
|
|
},
|
|
"actionNames": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"logoUrl": {
|
|
"type": "string"
|
|
},
|
|
"connectionExternalId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"pieceName",
|
|
"pieceVersion",
|
|
"actionNames",
|
|
"logoUrl"
|
|
]
|
|
},
|
|
"flowId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"flow": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"folderId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ENABLED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DISABLED"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"schedule": {
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CRON_EXPRESSION"
|
|
]
|
|
},
|
|
"cronExpression": {
|
|
"type": "string"
|
|
},
|
|
"timezone": {
|
|
"type": "string"
|
|
},
|
|
"failureCount": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"cronExpression",
|
|
"timezone"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"handshakeConfiguration": {
|
|
"type": "object",
|
|
"properties": {
|
|
"strategy": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NONE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"HEADER_PRESENT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"QUERY_PRESENT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BODY_PARAM_PRESENT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"paramName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"strategy"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"publishedVersionId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"additionalProperties": {}
|
|
},
|
|
"version": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"flowId": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"trigger": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PIECE_TRIGGER"
|
|
]
|
|
},
|
|
"settings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"pieceVersion": {
|
|
"pattern": "^([~^])?[0-9]+\\.[0-9]+\\.[0-9]+$",
|
|
"type": "string"
|
|
},
|
|
"pieceType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"OFFICIAL"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"packageType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ARCHIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"REGISTRY"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"triggerName": {
|
|
"type": "string"
|
|
},
|
|
"input": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"inputUiInfo": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"properties": {
|
|
"sampleDataFileId": {
|
|
"type": "string"
|
|
},
|
|
"sampleDataInputFileId": {
|
|
"type": "string"
|
|
},
|
|
"lastTestDate": {
|
|
"type": "string"
|
|
},
|
|
"customizedInputs": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"currentSelectedData": {}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"pieceName",
|
|
"pieceVersion",
|
|
"pieceType",
|
|
"packageType",
|
|
"input",
|
|
"inputUiInfo"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"EMPTY"
|
|
]
|
|
},
|
|
"settings": {}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"updatedBy": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"schemaVersion": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"state": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"LOCKED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DRAFT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"connectionIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"flowId",
|
|
"displayName",
|
|
"trigger",
|
|
"valid",
|
|
"state",
|
|
"connectionIds"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"projectId",
|
|
"externalId",
|
|
"status",
|
|
"version"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"mcpId"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"token": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"agentId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"tools": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PIECE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"FLOW"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"mcpId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"pieceMetadata": {
|
|
"type": "object",
|
|
"properties": {
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"pieceVersion": {
|
|
"type": "string"
|
|
},
|
|
"actionNames": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"logoUrl": {
|
|
"type": "string"
|
|
},
|
|
"connectionExternalId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"pieceName",
|
|
"pieceVersion",
|
|
"actionNames",
|
|
"logoUrl"
|
|
]
|
|
},
|
|
"flowId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"flow": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"folderId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ENABLED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DISABLED"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"schedule": {
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CRON_EXPRESSION"
|
|
]
|
|
},
|
|
"cronExpression": {
|
|
"type": "string"
|
|
},
|
|
"timezone": {
|
|
"type": "string"
|
|
},
|
|
"failureCount": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"cronExpression",
|
|
"timezone"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"handshakeConfiguration": {
|
|
"type": "object",
|
|
"properties": {
|
|
"strategy": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NONE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"HEADER_PRESENT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"QUERY_PRESENT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BODY_PARAM_PRESENT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"paramName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"strategy"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"publishedVersionId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"additionalProperties": {}
|
|
},
|
|
"version": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"flowId": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"trigger": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PIECE_TRIGGER"
|
|
]
|
|
},
|
|
"settings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"pieceVersion": {
|
|
"pattern": "^([~^])?[0-9]+\\.[0-9]+\\.[0-9]+$",
|
|
"type": "string"
|
|
},
|
|
"pieceType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"OFFICIAL"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"packageType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ARCHIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"REGISTRY"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"triggerName": {
|
|
"type": "string"
|
|
},
|
|
"input": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"inputUiInfo": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"properties": {
|
|
"sampleDataFileId": {
|
|
"type": "string"
|
|
},
|
|
"sampleDataInputFileId": {
|
|
"type": "string"
|
|
},
|
|
"lastTestDate": {
|
|
"type": "string"
|
|
},
|
|
"customizedInputs": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"currentSelectedData": {}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"pieceName",
|
|
"pieceVersion",
|
|
"pieceType",
|
|
"packageType",
|
|
"input",
|
|
"inputUiInfo"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"EMPTY"
|
|
]
|
|
},
|
|
"settings": {}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"updatedBy": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"schemaVersion": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"state": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"LOCKED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DRAFT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"connectionIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"flowId",
|
|
"displayName",
|
|
"trigger",
|
|
"valid",
|
|
"state",
|
|
"connectionIds"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"projectId",
|
|
"externalId",
|
|
"status",
|
|
"version"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"type",
|
|
"mcpId"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"name",
|
|
"projectId",
|
|
"token",
|
|
"tools"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"mcp"
|
|
],
|
|
"description": "Delete an MCP server by ID",
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"204": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"not": {}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/mcp-servers/{id}/rotate": {
|
|
"post": {
|
|
"tags": [
|
|
"mcp"
|
|
],
|
|
"description": "Rotate the MCP token",
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"token": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"agentId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"tools": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PIECE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"FLOW"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"mcpId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"pieceMetadata": {
|
|
"type": "object",
|
|
"properties": {
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"pieceVersion": {
|
|
"type": "string"
|
|
},
|
|
"actionNames": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"logoUrl": {
|
|
"type": "string"
|
|
},
|
|
"connectionExternalId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"pieceName",
|
|
"pieceVersion",
|
|
"actionNames",
|
|
"logoUrl"
|
|
]
|
|
},
|
|
"flowId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"flow": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"folderId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ENABLED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DISABLED"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"schedule": {
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CRON_EXPRESSION"
|
|
]
|
|
},
|
|
"cronExpression": {
|
|
"type": "string"
|
|
},
|
|
"timezone": {
|
|
"type": "string"
|
|
},
|
|
"failureCount": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"cronExpression",
|
|
"timezone"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"handshakeConfiguration": {
|
|
"type": "object",
|
|
"properties": {
|
|
"strategy": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NONE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"HEADER_PRESENT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"QUERY_PRESENT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BODY_PARAM_PRESENT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"paramName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"strategy"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"publishedVersionId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"additionalProperties": {}
|
|
},
|
|
"version": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"flowId": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"trigger": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PIECE_TRIGGER"
|
|
]
|
|
},
|
|
"settings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"pieceVersion": {
|
|
"pattern": "^([~^])?[0-9]+\\.[0-9]+\\.[0-9]+$",
|
|
"type": "string"
|
|
},
|
|
"pieceType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"OFFICIAL"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"packageType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ARCHIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"REGISTRY"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"triggerName": {
|
|
"type": "string"
|
|
},
|
|
"input": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"inputUiInfo": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"properties": {
|
|
"sampleDataFileId": {
|
|
"type": "string"
|
|
},
|
|
"sampleDataInputFileId": {
|
|
"type": "string"
|
|
},
|
|
"lastTestDate": {
|
|
"type": "string"
|
|
},
|
|
"customizedInputs": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"currentSelectedData": {}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"pieceName",
|
|
"pieceVersion",
|
|
"pieceType",
|
|
"packageType",
|
|
"input",
|
|
"inputUiInfo"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"EMPTY"
|
|
]
|
|
},
|
|
"settings": {}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"updatedBy": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"schemaVersion": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"state": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"LOCKED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DRAFT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"connectionIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"flowId",
|
|
"displayName",
|
|
"trigger",
|
|
"valid",
|
|
"state",
|
|
"connectionIds"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"projectId",
|
|
"externalId",
|
|
"status",
|
|
"version"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"type",
|
|
"mcpId"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"name",
|
|
"projectId",
|
|
"token",
|
|
"tools"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/mcp-runs": {
|
|
"get": {
|
|
"tags": [
|
|
"mcp-run"
|
|
],
|
|
"description": "Get MCP run",
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "projectId",
|
|
"required": true
|
|
},
|
|
{
|
|
"schema": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "mcpId",
|
|
"required": true
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "cursorRequest",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "number"
|
|
},
|
|
"in": "query",
|
|
"name": "limit",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"Success"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"Failed"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "metadata",
|
|
"required": false
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"mcpId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"toolId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"pieceVersion": {
|
|
"type": "string"
|
|
},
|
|
"actionName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"pieceName",
|
|
"pieceVersion",
|
|
"actionName"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"flowId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"flowVersionId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"flowId",
|
|
"flowVersionId",
|
|
"name"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"input": {},
|
|
"output": {},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"Success"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"Failed"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"mcpId",
|
|
"projectId",
|
|
"toolId",
|
|
"metadata",
|
|
"input",
|
|
"output",
|
|
"status"
|
|
]
|
|
}
|
|
},
|
|
"next": {
|
|
"description": "Cursor to the next page",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"previous": {
|
|
"description": "Cursor to the previous page",
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"data"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/users": {
|
|
"get": {
|
|
"tags": [
|
|
"users"
|
|
],
|
|
"description": "List users",
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "cursor",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "number"
|
|
},
|
|
"in": "query",
|
|
"name": "limit",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "externalId",
|
|
"required": false
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"firstName": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ACTIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"INACTIVE"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"externalId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"lastChangelogDismissed": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"platformId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"platformRole": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ADMIN"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"MEMBER"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"lastName": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"email",
|
|
"firstName",
|
|
"status",
|
|
"platformRole",
|
|
"lastName",
|
|
"created",
|
|
"updated"
|
|
]
|
|
}
|
|
},
|
|
"next": {
|
|
"description": "Cursor to the next page",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"previous": {
|
|
"description": "Cursor to the previous page",
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"data"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/user-invitations": {
|
|
"post": {
|
|
"tags": [
|
|
"user-invitations"
|
|
],
|
|
"description": "Send a user invitation to a user. If the user already has an invitation, the invitation will be updated.",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PROJECT"
|
|
]
|
|
},
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"projectRole": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"email",
|
|
"projectId",
|
|
"projectRole"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM"
|
|
]
|
|
},
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"platformRole": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ADMIN"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"MEMBER"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"email",
|
|
"platformRole"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"201": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PENDING"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ACCEPTED"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PROJECT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"platformId": {
|
|
"type": "string"
|
|
},
|
|
"platformRole": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ADMIN",
|
|
"MEMBER"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"projectId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"projectRoleId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"projectRole": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"permissions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"platformId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"userCount": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"name",
|
|
"permissions",
|
|
"type"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"link": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"email",
|
|
"status",
|
|
"type",
|
|
"platformId"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"user-invitations"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "number"
|
|
},
|
|
"in": "query",
|
|
"name": "limit",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "cursor",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PROJECT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"in": "query",
|
|
"name": "type",
|
|
"required": true
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"in": "query",
|
|
"name": "projectId",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PENDING"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ACCEPTED"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PENDING"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ACCEPTED"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PROJECT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"platformId": {
|
|
"type": "string"
|
|
},
|
|
"platformRole": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ADMIN",
|
|
"MEMBER"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"projectId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"projectRoleId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"projectRole": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"permissions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"platformId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"userCount": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"name",
|
|
"permissions",
|
|
"type"
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"email",
|
|
"status",
|
|
"type",
|
|
"platformId"
|
|
]
|
|
}
|
|
},
|
|
"next": {
|
|
"description": "Cursor to the next page",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"previous": {
|
|
"description": "Cursor to the previous page",
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"data"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/user-invitations/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"user-invitations"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"204": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"not": {}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/tables/{id}": {
|
|
"post": {
|
|
"tags": [
|
|
"tables"
|
|
],
|
|
"description": "Update a table",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"tables"
|
|
],
|
|
"description": "Delete a table",
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"204": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"not": {}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"tables"
|
|
],
|
|
"description": "Get a table by id",
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"name",
|
|
"projectId",
|
|
"externalId"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/tables": {
|
|
"get": {
|
|
"tags": [
|
|
"tables"
|
|
],
|
|
"description": "List tables",
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "number"
|
|
},
|
|
"in": "query",
|
|
"name": "limit",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "cursor",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "name",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"in": "query",
|
|
"name": "externalIds",
|
|
"required": false
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"name",
|
|
"projectId",
|
|
"externalId"
|
|
]
|
|
}
|
|
},
|
|
"next": {
|
|
"description": "Cursor to the next page",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"previous": {
|
|
"description": "Cursor to the previous page",
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"data"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/tables/{id}/export": {
|
|
"get": {
|
|
"tags": [
|
|
"tables"
|
|
],
|
|
"description": "Export a table",
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"fields": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"name"
|
|
]
|
|
}
|
|
},
|
|
"rows": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"fields",
|
|
"rows",
|
|
"name"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/tables/{id}/webhooks": {
|
|
"post": {
|
|
"tags": [
|
|
"tables"
|
|
],
|
|
"description": "Create a table webhook",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"events": {
|
|
"type": "array",
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"RECORD_CREATED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"RECORD_UPDATED"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"RECORD_DELETED"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"webhookUrl": {
|
|
"type": "string"
|
|
},
|
|
"flowId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"events",
|
|
"webhookUrl",
|
|
"flowId"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/tables/{id}/webhooks/{webhookId}": {
|
|
"delete": {
|
|
"tags": [
|
|
"tables"
|
|
],
|
|
"description": "Delete a table webhook",
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "webhookId",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/records/{id}": {
|
|
"post": {
|
|
"tags": [
|
|
"records"
|
|
],
|
|
"description": "Update a record",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"cells": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"fieldId": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"fieldId",
|
|
"value"
|
|
]
|
|
}
|
|
},
|
|
"tableId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"tableId"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"tableId": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"cells": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "object",
|
|
"properties": {
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"value": {},
|
|
"fieldName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"updated",
|
|
"created",
|
|
"value",
|
|
"fieldName"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"tableId",
|
|
"projectId",
|
|
"cells"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/records": {
|
|
"delete": {
|
|
"tags": [
|
|
"records"
|
|
],
|
|
"description": "Delete records",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"ids"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"tableId": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"cells": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "object",
|
|
"properties": {
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"value": {},
|
|
"fieldName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"updated",
|
|
"created",
|
|
"value",
|
|
"fieldName"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"tableId",
|
|
"projectId",
|
|
"cells"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"records"
|
|
],
|
|
"description": "List records",
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "tableId",
|
|
"required": true
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "number"
|
|
},
|
|
"in": "query",
|
|
"name": "limit",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "cursor",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"fieldId": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
},
|
|
"operator": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"eq"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"neq"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"gt"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"gte"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"lt"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"lte"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"co"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"fieldId",
|
|
"value"
|
|
]
|
|
}
|
|
},
|
|
"in": "query",
|
|
"name": "filters",
|
|
"required": false
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"tableId": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"cells": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "object",
|
|
"properties": {
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"value": {},
|
|
"fieldName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"updated",
|
|
"created",
|
|
"value",
|
|
"fieldName"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"tableId",
|
|
"projectId",
|
|
"cells"
|
|
]
|
|
}
|
|
},
|
|
"next": {
|
|
"description": "Cursor to the next page",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"previous": {
|
|
"description": "Cursor to the previous page",
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"data"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/projects": {
|
|
"post": {
|
|
"tags": [
|
|
"projects"
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"pattern": "^[^./]+$",
|
|
"type": "string"
|
|
},
|
|
"externalId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"additionalProperties": {}
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"201": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"ownerId": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"notifyStatus": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NEVER"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ALWAYS"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NEW_ISSUE"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"platformId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"releasesEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"additionalProperties": {}
|
|
},
|
|
"usage": {
|
|
"type": "object",
|
|
"properties": {
|
|
"tasks": {
|
|
"type": "number"
|
|
},
|
|
"aiCredits": {
|
|
"type": "number"
|
|
},
|
|
"nextLimitResetDate": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"tasks",
|
|
"aiCredits",
|
|
"nextLimitResetDate"
|
|
]
|
|
},
|
|
"plan": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"piecesFilterType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NONE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ALLOWED"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"pieces": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"tasks": {
|
|
"type": "number",
|
|
"nullable": true
|
|
},
|
|
"aiCredits": {
|
|
"type": "number",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"projectId",
|
|
"name",
|
|
"piecesFilterType",
|
|
"pieces"
|
|
]
|
|
},
|
|
"analytics": {
|
|
"type": "object",
|
|
"properties": {
|
|
"totalUsers": {
|
|
"type": "number"
|
|
},
|
|
"activeUsers": {
|
|
"type": "number"
|
|
},
|
|
"totalFlows": {
|
|
"type": "number"
|
|
},
|
|
"activeFlows": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"totalUsers",
|
|
"activeUsers",
|
|
"totalFlows",
|
|
"activeFlows"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"ownerId",
|
|
"displayName",
|
|
"notifyStatus",
|
|
"platformId",
|
|
"releasesEnabled",
|
|
"usage",
|
|
"plan",
|
|
"analytics"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"projects"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "externalId",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "number"
|
|
},
|
|
"in": "query",
|
|
"name": "limit",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "cursor",
|
|
"required": false
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"ownerId": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"notifyStatus": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NEVER"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ALWAYS"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NEW_ISSUE"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"platformId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"releasesEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"additionalProperties": {}
|
|
},
|
|
"usage": {
|
|
"type": "object",
|
|
"properties": {
|
|
"tasks": {
|
|
"type": "number"
|
|
},
|
|
"aiCredits": {
|
|
"type": "number"
|
|
},
|
|
"nextLimitResetDate": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"tasks",
|
|
"aiCredits",
|
|
"nextLimitResetDate"
|
|
]
|
|
},
|
|
"plan": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"piecesFilterType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NONE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ALLOWED"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"pieces": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"tasks": {
|
|
"type": "number",
|
|
"nullable": true
|
|
},
|
|
"aiCredits": {
|
|
"type": "number",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"projectId",
|
|
"name",
|
|
"piecesFilterType",
|
|
"pieces"
|
|
]
|
|
},
|
|
"analytics": {
|
|
"type": "object",
|
|
"properties": {
|
|
"totalUsers": {
|
|
"type": "number"
|
|
},
|
|
"activeUsers": {
|
|
"type": "number"
|
|
},
|
|
"totalFlows": {
|
|
"type": "number"
|
|
},
|
|
"activeFlows": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"totalUsers",
|
|
"activeUsers",
|
|
"totalFlows",
|
|
"activeFlows"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"ownerId",
|
|
"displayName",
|
|
"notifyStatus",
|
|
"platformId",
|
|
"releasesEnabled",
|
|
"usage",
|
|
"plan",
|
|
"analytics"
|
|
]
|
|
}
|
|
},
|
|
"next": {
|
|
"description": "Cursor to the next page",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"previous": {
|
|
"description": "Cursor to the previous page",
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"data"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/projects/{id}": {
|
|
"post": {
|
|
"tags": [
|
|
"projects"
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"notifyStatus": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NEVER"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ALWAYS"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NEW_ISSUE"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"releasesEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"pattern": "^[^./]+$",
|
|
"type": "string"
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"plan": {
|
|
"type": "object",
|
|
"properties": {
|
|
"tasks": {
|
|
"type": "number"
|
|
},
|
|
"pieces": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"piecesFilterType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NONE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ALLOWED"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"aiCredits": {
|
|
"type": "number"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"ownerId": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"notifyStatus": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NEVER"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ALWAYS"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NEW_ISSUE"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"platformId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"releasesEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"additionalProperties": {}
|
|
},
|
|
"usage": {
|
|
"type": "object",
|
|
"properties": {
|
|
"tasks": {
|
|
"type": "number"
|
|
},
|
|
"aiCredits": {
|
|
"type": "number"
|
|
},
|
|
"nextLimitResetDate": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"tasks",
|
|
"aiCredits",
|
|
"nextLimitResetDate"
|
|
]
|
|
},
|
|
"plan": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"piecesFilterType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NONE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ALLOWED"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"pieces": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"tasks": {
|
|
"type": "number",
|
|
"nullable": true
|
|
},
|
|
"aiCredits": {
|
|
"type": "number",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"projectId",
|
|
"name",
|
|
"piecesFilterType",
|
|
"pieces"
|
|
]
|
|
},
|
|
"analytics": {
|
|
"type": "object",
|
|
"properties": {
|
|
"totalUsers": {
|
|
"type": "number"
|
|
},
|
|
"activeUsers": {
|
|
"type": "number"
|
|
},
|
|
"totalFlows": {
|
|
"type": "number"
|
|
},
|
|
"activeFlows": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"totalUsers",
|
|
"activeUsers",
|
|
"totalFlows",
|
|
"activeFlows"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"ownerId",
|
|
"displayName",
|
|
"notifyStatus",
|
|
"platformId",
|
|
"releasesEnabled",
|
|
"usage",
|
|
"plan",
|
|
"analytics"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"projects"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/project-members": {
|
|
"get": {
|
|
"tags": [
|
|
"project-members"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "projectId",
|
|
"required": true
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "projectRoleId",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "cursor",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "number"
|
|
},
|
|
"in": "query",
|
|
"name": "limit",
|
|
"required": false
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"platformId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"projectRoleId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"user": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"firstName": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ACTIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"INACTIVE"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"externalId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"lastChangelogDismissed": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"platformId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"platformRole": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ADMIN"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"MEMBER"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"lastName": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"email",
|
|
"firstName",
|
|
"status",
|
|
"platformRole",
|
|
"lastName",
|
|
"created",
|
|
"updated"
|
|
]
|
|
},
|
|
"projectRole": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"permissions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"platformId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"userCount": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"name",
|
|
"permissions",
|
|
"type"
|
|
]
|
|
},
|
|
"project": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"displayName"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"platformId",
|
|
"userId",
|
|
"projectId",
|
|
"projectRoleId",
|
|
"user",
|
|
"projectRole",
|
|
"project"
|
|
]
|
|
}
|
|
},
|
|
"next": {
|
|
"description": "Cursor to the next page",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"previous": {
|
|
"description": "Cursor to the previous page",
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"data"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/project-members/{id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"project-members"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"204": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"not": {}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/pieces": {
|
|
"post": {
|
|
"summary": "Add a piece to a platform",
|
|
"tags": [
|
|
"pieces"
|
|
],
|
|
"description": "Add a piece to a platform",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"title": "Private Piece",
|
|
"type": "object",
|
|
"properties": {
|
|
"packageType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ARCHIVE"
|
|
]
|
|
},
|
|
"scope": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM"
|
|
]
|
|
},
|
|
"pieceName": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"pieceVersion": {
|
|
"pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+$",
|
|
"type": "string"
|
|
},
|
|
"pieceArchive": {
|
|
"type": "object",
|
|
"properties": {
|
|
"filename": {
|
|
"type": "string"
|
|
},
|
|
"data": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"file"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"filename",
|
|
"data",
|
|
"type"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"packageType",
|
|
"scope",
|
|
"pieceName",
|
|
"pieceVersion",
|
|
"pieceArchive"
|
|
]
|
|
},
|
|
{
|
|
"title": "NPM Piece",
|
|
"type": "object",
|
|
"properties": {
|
|
"packageType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"REGISTRY"
|
|
]
|
|
},
|
|
"scope": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM"
|
|
]
|
|
},
|
|
"pieceName": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"pieceVersion": {
|
|
"pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+$",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"packageType",
|
|
"scope",
|
|
"pieceName",
|
|
"pieceVersion"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"201": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/flow-templates/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"flow-templates"
|
|
],
|
|
"description": "Get a flow template",
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"flow-templates"
|
|
],
|
|
"description": "Delete a flow template",
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/flow-templates": {
|
|
"get": {
|
|
"tags": [
|
|
"flow-templates"
|
|
],
|
|
"description": "List flow templates",
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"in": "query",
|
|
"name": "pieces",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"in": "query",
|
|
"name": "tags",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "search",
|
|
"required": false
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"flow-templates"
|
|
],
|
|
"description": "Create a flow template",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"template": {
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"trigger": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PIECE_TRIGGER"
|
|
]
|
|
},
|
|
"settings": {
|
|
"type": "object",
|
|
"properties": {
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"pieceVersion": {
|
|
"pattern": "^([~^])?[0-9]+\\.[0-9]+\\.[0-9]+$",
|
|
"type": "string"
|
|
},
|
|
"pieceType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"OFFICIAL"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"packageType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ARCHIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"REGISTRY"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"triggerName": {
|
|
"type": "string"
|
|
},
|
|
"input": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"inputUiInfo": {
|
|
"additionalProperties": true,
|
|
"type": "object",
|
|
"properties": {
|
|
"sampleDataFileId": {
|
|
"type": "string"
|
|
},
|
|
"sampleDataInputFileId": {
|
|
"type": "string"
|
|
},
|
|
"lastTestDate": {
|
|
"type": "string"
|
|
},
|
|
"customizedInputs": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"currentSelectedData": {}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"pieceName",
|
|
"pieceVersion",
|
|
"pieceType",
|
|
"packageType",
|
|
"input",
|
|
"inputUiInfo"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"nextAction": {},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"EMPTY"
|
|
]
|
|
},
|
|
"settings": {}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"valid",
|
|
"displayName",
|
|
"type",
|
|
"settings"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"valid": {
|
|
"type": "boolean"
|
|
},
|
|
"schemaVersion": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"connectionIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"trigger",
|
|
"valid",
|
|
"connectionIds"
|
|
]
|
|
},
|
|
"blogUrl": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PROJECT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"tags": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"additionalProperties": {}
|
|
}
|
|
},
|
|
"required": [
|
|
"template",
|
|
"type"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/git-repos": {
|
|
"post": {
|
|
"tags": [
|
|
"git-repos"
|
|
],
|
|
"description": "Upsert a git repository information for a project.",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"projectId": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"remoteUrl": {
|
|
"pattern": "^git@",
|
|
"type": "string"
|
|
},
|
|
"branch": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"branchType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PRODUCTION"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DEVELOPMENT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sshPrivateKey": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"projectId",
|
|
"remoteUrl",
|
|
"branch",
|
|
"branchType",
|
|
"sshPrivateKey",
|
|
"slug"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"remoteUrl": {
|
|
"type": "string"
|
|
},
|
|
"branch": {
|
|
"type": "string"
|
|
},
|
|
"branchType": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PRODUCTION"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"DEVELOPMENT"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"remoteUrl",
|
|
"branch",
|
|
"branchType",
|
|
"projectId",
|
|
"slug"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/project-roles/{id}/project-members": {
|
|
"get": {
|
|
"tags": [
|
|
"project-members"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "cursor",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "number"
|
|
},
|
|
"in": "query",
|
|
"name": "limit",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"platformId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"projectRoleId": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"user": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"firstName": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ACTIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"INACTIVE"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"externalId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"lastChangelogDismissed": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"platformId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"platformRole": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ADMIN"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"MEMBER"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"lastName": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"email",
|
|
"firstName",
|
|
"status",
|
|
"platformRole",
|
|
"lastName",
|
|
"created",
|
|
"updated"
|
|
]
|
|
},
|
|
"projectRole": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"permissions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"platformId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"userCount": {
|
|
"type": "number"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"name",
|
|
"permissions",
|
|
"type"
|
|
]
|
|
},
|
|
"project": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"displayName"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"platformId",
|
|
"userId",
|
|
"projectId",
|
|
"projectRoleId",
|
|
"user",
|
|
"projectRole",
|
|
"project"
|
|
]
|
|
}
|
|
},
|
|
"next": {
|
|
"description": "Cursor to the next page",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"previous": {
|
|
"description": "Cursor to the previous page",
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"data"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/project-releases": {
|
|
"post": {
|
|
"tags": [
|
|
"project-releases"
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ROLLBACK"
|
|
]
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"selectedFlowsIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"nullable": true
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"projectReleaseId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"name",
|
|
"projectId",
|
|
"projectReleaseId"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PROJECT"
|
|
]
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"selectedFlowsIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"nullable": true
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"targetProjectId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"name",
|
|
"projectId",
|
|
"targetProjectId"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"GIT"
|
|
]
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"selectedFlowsIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"nullable": true
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"name",
|
|
"projectId"
|
|
]
|
|
}
|
|
],
|
|
"discriminator": {
|
|
"propertyName": "type"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"201": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"importedBy": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"fileId": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"GIT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PROJECT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ROLLBACK"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"importedByUser": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"firstName": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ACTIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"INACTIVE"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"externalId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"lastChangelogDismissed": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"platformId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"platformRole": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ADMIN"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"MEMBER"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"lastName": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"email",
|
|
"firstName",
|
|
"status",
|
|
"platformRole",
|
|
"lastName",
|
|
"created",
|
|
"updated"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"projectId",
|
|
"name",
|
|
"fileId",
|
|
"type"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/global-connections": {
|
|
"post": {
|
|
"tags": [
|
|
"global-connections"
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"allOf": [
|
|
{
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
{
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"SECRET_TEXT"
|
|
]
|
|
},
|
|
"value": {
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"SECRET_TEXT"
|
|
]
|
|
},
|
|
"secret_text": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"secret_text"
|
|
]
|
|
},
|
|
"scope": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM"
|
|
]
|
|
},
|
|
"projectIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"pieceName",
|
|
"type",
|
|
"value",
|
|
"scope",
|
|
"projectIds"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"allOf": [
|
|
{
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
{
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"OAUTH2"
|
|
]
|
|
},
|
|
"value": {
|
|
"type": "object",
|
|
"properties": {
|
|
"client_id": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"code_challenge": {
|
|
"type": "string"
|
|
},
|
|
"scope": {
|
|
"type": "string"
|
|
},
|
|
"authorization_method": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"HEADER"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BODY"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"client_secret": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"grant_type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"authorization_code"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"client_credentials"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"props": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
"redirect_url": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"OAUTH2"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"client_id",
|
|
"code",
|
|
"scope",
|
|
"client_secret",
|
|
"redirect_url",
|
|
"type"
|
|
]
|
|
},
|
|
"scope": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM"
|
|
]
|
|
},
|
|
"projectIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"pieceName",
|
|
"type",
|
|
"value",
|
|
"scope",
|
|
"projectIds"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"allOf": [
|
|
{
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
{
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CLOUD_OAUTH2"
|
|
]
|
|
},
|
|
"value": {
|
|
"type": "object",
|
|
"properties": {
|
|
"client_id": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"code_challenge": {
|
|
"type": "string"
|
|
},
|
|
"scope": {
|
|
"type": "string"
|
|
},
|
|
"authorization_method": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"HEADER"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BODY"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"props": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CLOUD_OAUTH2"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"client_id",
|
|
"code",
|
|
"scope",
|
|
"type"
|
|
]
|
|
},
|
|
"scope": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM"
|
|
]
|
|
},
|
|
"projectIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"pieceName",
|
|
"type",
|
|
"value",
|
|
"scope",
|
|
"projectIds"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"allOf": [
|
|
{
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
{
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM_OAUTH2"
|
|
]
|
|
},
|
|
"value": {
|
|
"type": "object",
|
|
"properties": {
|
|
"client_id": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"code": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"code_challenge": {
|
|
"type": "string"
|
|
},
|
|
"scope": {
|
|
"type": "string"
|
|
},
|
|
"authorization_method": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"HEADER"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BODY"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"props": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM_OAUTH2"
|
|
]
|
|
},
|
|
"redirect_url": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"client_id",
|
|
"code",
|
|
"scope",
|
|
"type",
|
|
"redirect_url"
|
|
]
|
|
},
|
|
"scope": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM"
|
|
]
|
|
},
|
|
"projectIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"pieceName",
|
|
"type",
|
|
"value",
|
|
"scope",
|
|
"projectIds"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"allOf": [
|
|
{
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
{
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"BASIC_AUTH"
|
|
]
|
|
},
|
|
"value": {
|
|
"type": "object",
|
|
"properties": {
|
|
"username": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"BASIC_AUTH"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"username",
|
|
"password",
|
|
"type"
|
|
]
|
|
},
|
|
"scope": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM"
|
|
]
|
|
},
|
|
"projectIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"pieceName",
|
|
"type",
|
|
"value",
|
|
"scope",
|
|
"projectIds"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"allOf": [
|
|
{
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
{
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM_AUTH"
|
|
]
|
|
},
|
|
"value": {
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM_AUTH"
|
|
]
|
|
},
|
|
"props": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
}
|
|
},
|
|
"required": [
|
|
"type",
|
|
"props"
|
|
]
|
|
},
|
|
"scope": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM"
|
|
]
|
|
},
|
|
"projectIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"pieceName",
|
|
"type",
|
|
"value",
|
|
"scope",
|
|
"projectIds"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"allOf": [
|
|
{
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
},
|
|
{
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"NO_AUTH"
|
|
]
|
|
},
|
|
"value": {
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"NO_AUTH"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
},
|
|
"scope": {
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM"
|
|
]
|
|
},
|
|
"projectIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName",
|
|
"pieceName",
|
|
"type",
|
|
"value",
|
|
"scope",
|
|
"projectIds"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"201": {
|
|
"description": "App connection is a connection to an external app.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"description": "App connection is a connection to an external app.",
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"OAUTH2"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM_OAUTH2"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CLOUD_OAUTH2"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"SECRET_TEXT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BASIC_AUTH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM_AUTH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NO_AUTH"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"projectIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"platformId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"scope": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PROJECT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ACTIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"MISSING"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ERROR"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"ownerId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"owner": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"firstName": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ACTIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"INACTIVE"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"externalId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"lastChangelogDismissed": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"platformId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"platformRole": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ADMIN"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"MEMBER"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"lastName": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"email",
|
|
"firstName",
|
|
"status",
|
|
"platformRole",
|
|
"lastName",
|
|
"created",
|
|
"updated"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"additionalProperties": {}
|
|
},
|
|
"flowIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"externalId",
|
|
"displayName",
|
|
"type",
|
|
"pieceName",
|
|
"projectIds",
|
|
"scope",
|
|
"status"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"get": {
|
|
"tags": [
|
|
"global-connections"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "cursor",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PROJECT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"in": "query",
|
|
"name": "scope",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "pieceName",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"in": "query",
|
|
"name": "displayName",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "array",
|
|
"items": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ACTIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"MISSING"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ERROR"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"in": "query",
|
|
"name": "status",
|
|
"required": false
|
|
},
|
|
{
|
|
"schema": {
|
|
"type": "number"
|
|
},
|
|
"in": "query",
|
|
"name": "limit",
|
|
"required": false
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"data": {
|
|
"type": "array",
|
|
"items": {
|
|
"description": "App connection is a connection to an external app.",
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
},
|
|
"externalId": {
|
|
"type": "string"
|
|
},
|
|
"displayName": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"OAUTH2"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM_OAUTH2"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CLOUD_OAUTH2"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"SECRET_TEXT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"BASIC_AUTH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"CUSTOM_AUTH"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"NO_AUTH"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"pieceName": {
|
|
"type": "string"
|
|
},
|
|
"projectIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"platformId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"scope": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PROJECT"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"PLATFORM"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ACTIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"MISSING"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ERROR"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"ownerId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"owner": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"firstName": {
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ACTIVE"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"INACTIVE"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"externalId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"lastChangelogDismissed": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"platformId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"platformRole": {
|
|
"anyOf": [
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"ADMIN"
|
|
]
|
|
},
|
|
{
|
|
"type": "string",
|
|
"enum": [
|
|
"MEMBER"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"lastName": {
|
|
"type": "string"
|
|
},
|
|
"created": {
|
|
"type": "string"
|
|
},
|
|
"updated": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"email",
|
|
"firstName",
|
|
"status",
|
|
"platformRole",
|
|
"lastName",
|
|
"created",
|
|
"updated"
|
|
],
|
|
"nullable": true
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"nullable": true,
|
|
"additionalProperties": {}
|
|
},
|
|
"flowIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"created",
|
|
"updated",
|
|
"externalId",
|
|
"displayName",
|
|
"type",
|
|
"pieceName",
|
|
"projectIds",
|
|
"scope",
|
|
"status"
|
|
]
|
|
}
|
|
},
|
|
"next": {
|
|
"description": "Cursor to the next page",
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"previous": {
|
|
"description": "Cursor to the previous page",
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"data"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/v1/global-connections/{id}": {
|
|
"post": {
|
|
"tags": [
|
|
"global-connections"
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"projectIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"metadata": {
|
|
"type": "object",
|
|
"additionalProperties": {}
|
|
}
|
|
},
|
|
"required": [
|
|
"displayName"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Default Response"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"global-connections"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"schema": {
|
|
"pattern": "^[0-9a-zA-Z]{21}$",
|
|
"type": "string"
|
|
},
|
|
"in": "path",
|
|
"name": "id",
|
|
"required": true
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"apiKey": []
|
|
}
|
|
],
|
|
"responses": {
|
|
"204": {
|
|
"description": "Default Response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"not": {}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"servers": [
|
|
{
|
|
"url": "https://cloud.activepieces.com/api",
|
|
"description": "Production Server"
|
|
}
|
|
],
|
|
"externalDocs": {
|
|
"url": "https://www.activepieces.com/docs",
|
|
"description": "Find more info here"
|
|
}
|
|
} |