decentralised.art Chain Format API (0.4.0)

Download OpenAPI specification:

License: MIT

Format hash listing and format membership exploration.

format

Format hash and connector membership endpoints.

CORS preflight

Responses

Check format list query

Returns 200 when the format list query is valid.

query Parameters

limit required	integer [ 1 .. 256 ] Page size.
after	string^(0x)?[a-fA-F0-9]{64}$ Format hash cursor from a previous response `cursor.next_after`.

Responses

List format hashes

List connector format hashes known to the registry.

query Parameters

limit required	integer [ 1 .. 256 ] Page size.
after	string^(0x)?[a-fA-F0-9]{64}$ Format hash cursor from a previous response `cursor.next_after`.

Responses

Response samples

200
400

Content type

application/json

{"limit": 1,
"total_formats": 0,
"cursor": {"has_more": true,
"next_after": "string"
},
"formats": ["string"
]
}

CORS preflight

path Parameters

hash

required

string (FormatHash) ^(0x)?[a-fA-F0-9]{64}$

Connector format hash.

Responses

Get format membership

List connector names and scalar labels for a format hash.

path Parameters

hash

required

string (FormatHash) ^(0x)?[a-fA-F0-9]{64}$

Connector format hash.

query Parameters

limit required	integer [ 1 .. 256 ] Page size for connector names.
after	string Connector name cursor from a previous response `cursor.next_after`.

Responses

Response samples

200
400

Content type

application/json

{"format_hash": "string",
"limit": 1,
"total_connectors": 0,
"cursor": {"has_more": true,
"next_after": "string"
},
"scalars": ["string"
],
"connectors": ["string"
]
}