Types

Set a type's icon

Sets the owner's icon for a type. Reads answer it in place of the author's, and a subtype with no icon inherits it. Replacing the type keeps it. Needs schema.write and write on the type, as replacing it does.

PUT
/types/{id}/icon

Authorization

bearerAuth
headerAuthorizationBearer <token>

Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).

Path parameters

id*string

The identifier of the type, such as core.note or acme.deal.

Header parameters

X-Marfa-Instance-Id?string

The ID of the instance you expect, as GET / returns it. If another instance answers at this address, Marfa returns 409 instance_changed and doesn't write. Leave it out to send the request to whichever instance answers.

Match^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Request body

application/json
  1. body

The icon to show for a type.

icon*string

An Iconify ID, <set>:<name>, from a set and version Marfa pins: lucide or simple-icons, such as lucide:calendar-days or simple-icons:github.

Response body

About errors

Returns the type, with the icon.

application/json
  1. response

A type says which fields the items of that type hold, and what else Marfa does for them.

id*string

Unique identifier for the type.

label?string

The type's name for people to read.

plural*string

The type's plural name for people to read, such as People: the one the type declares, else one made from its label. Never inherited.

description?string

What the type is for.

parent?string

The identifier of the type this one inherits from.

compatible_with?array<string>

The types this one is a structural superset of.

roles?array<>

The structural roles the type plays, including those it inherits.

fields*

The type's own fields, by name. GET /types/{id} adds the fields it inherits.

tables?

The type's own tables, by name. GET /types/{id} adds the tables it inherits.

version*integer

The version number the type was last saved with.

Range0 <= value
display_hints?

How clients show the type and its items: the title field, the body field, whether the body names an item, and the icon.

link_field?string

The name of a string field, declared or inherited, that holds each item's own ID at the vendor that writes the type. No two items of the type, in any state, hold the same value. A subtype names its own link. The name has no " or \.

version_policy?

How long Marfa keeps the versions of the type's items.

merge_policy?

How Marfa merges conflicting edits to the type's items.

retention_policy?

How long Marfa keeps the type's items in the feed tier.

provenance*

The type's recorded origin and creator.

  • invalid_schema: icon isn't the ID of an icon in a pinned set (details.errors names it).
  • missing_required_field: the body has no icon. details.field names it.
  • validation_error: the query has a parameter this endpoint doesn't take.
application/json
  1. response

An error response.

error*

What went wrong.

unauthorized: the request has no credential, or its credential is not valid. For a key that has expired, details.expired_at says when it expired.

application/json
  1. response

An error response.

error*

What went wrong.

  • forbidden: you lack schema.write, or your key is a connector's, which cannot change what the owner chose.
  • type_not_permitted: your type map doesn't grant write on the type.
application/json
  1. response

An error response.

error*

What went wrong.

type_not_found: no type has this identifier.

application/json
  1. response

An error response.

error*

What went wrong.

request_timeout: the request body didn't arrive whole within 180 seconds. Nothing changed, and Marfa closed the connection. Send the request again. A body larger than about 21 MiB can't arrive in that time over a 1 Mbit/s link, so send it in smaller requests.

application/json
  1. response

An error response.

error*

What went wrong.

instance_changed: X-Marfa-Instance-Id names another instance. Nothing is written. Rebuild the working copy from the instance at this address.

application/json
  1. response

An error response.

error*

What went wrong.

contract_mismatch: X-Marfa-Contract names another contract version than this instance speaks, or is not a whole number. Nothing was done.

application/json
  1. response

An error response.

error*

What went wrong.

request_too_large: the request body is larger than this instance accepts.

application/json
  1. response

An error response.

error*

What went wrong.

rate_limited: you sent too many requests. Wait for the number of seconds in Retry-After, then try again.

application/json
  1. response

An error response.

error*

What went wrong.

internal_error: Marfa failed in a way it didn't expect, and the request may not have completed. Read what you changed before you repeat a write.

application/json
  1. response

An error response.

error*

What went wrong.

write_contention: the database was busy, and Marfa couldn't complete the request in time. Nothing changed. Try the request again. While a restore runs, details.reason is restore_running.

application/json
  1. response

An error response.

error*

What went wrong.

insufficient_storage: the disk that holds the instance's data has no room for the request, or the request would leave less free than the instance keeps in reserve. Nothing changed, unless details.write_outcome is unknown, which means the write may have landed: read what you changed before you repeat it. Free space on the disk, then try the request again.

application/json
  1. response

An error response.

error*

What went wrong.

curl -X PUT 'http://localhost:8600/types/string/icon' \  -H 'Content-Type: application/json' \  -d '{  "icon": "string"}'
About errors
{  "id": "acme.deal",  "version": 1,  "fields": {    "name": {      "type": "string",      "label": "Name",      "required": true    },    "amount": {      "type": "number",      "label": "Amount"    },    "stage": {      "type": "enum",      "label": "Stage",      "enum_values": [        "lead",        "won",        "lost"      ]    }  },  "label": "Deal",  "plural": "Deals",  "description": "A sales deal.",  "display_hints": {    "title_field": "name",    "icon": "simple-icons:github"  },  "provenance": {    "origin": "user",    "created_by": {      "kind": "key",      "id": "01a1011b-b5e5-7be6-8f3b-77492475b5a4",      "name": "CRM sync"    }  }}