API docs by Redocly

decentralised.art Chain Connector API (0.4.0)

Download OpenAPI specification:

License: MIT

Connector registry endpoints. Supports fetching a connector by name and creating a local connector definition.

connector

Connector creation and inspection endpoints.

Check connector existence

Returns 200 if connector exists.

path Parameters
name
required
string

Connector name.

Responses

CORS preflight

path Parameters
name
required
string

Connector name.

Responses

Get connector by name

Returns connector definition, owner and derived format hash.

path Parameters
name
required
string

Connector name.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "dimensions": [
    ],
  • "condition_name": "string",
  • "condition_args": [
    ],
  • "static_ri": {
    },
  • "owner": "string",
  • "address": "string",
  • "format_hash": "string"
}

CORS preflight

Responses

Create connector

Compile and deploy a connector locally for simulation. The name must not be reserved on chain. Publish it on chain through /publish/connector.

Authorizations:
BearerAuth
Request Body schema: application/json
required
name
required
string (EntityName) [ 1 .. 128 ] characters ^[A-Za-z_][A-Za-z0-9_]*$

Entity name. Starts with a letter or '', contains only letters, digits and '', at most 128 characters.

required
Array of objects (ConnectorDimension) non-empty

Ordered dimension definitions.

condition_name
string

Condition name. Omitted or empty string means no condition.

condition_args
Array of integers

Condition arguments. Omitted means no condition arguments.

object

Optional static running-instance map. Keys are canonical decimal positions (for example "0", "3", "5").

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "dimensions": [
    ],
  • "condition_name": "string",
  • "condition_args": [
    ],
  • "static_ri": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "owner": "string",
  • "address": "string",
  • "format_hash": "string"
}