Normalize a type definition
Normalizes a candidate definition and returns its declared form, the registered declared definition and the registered resolved definition. It does not register or replace a type.
bearerAuthAuthorizationBearer <token>Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).
X-Marfa-Instance-Id?stringThe 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.
^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$application/json- body
A declared item type.
fields*The type's own fields, by name.
tables?The type's own tables, by name: at most 32, each named by a lowercase letter, then up to 63 lowercase letters, digits and underscores. A subtype gets its parents' tables and declares only its own.
version?integerA number for you to track changes to the type. Marfa never changes it. Leave it out for 0.
0 <= valueparent?stringThe identifier of the type this one inherits from. To set or change it, you need write on it, unless Marfa ships it. Leave it out for a type with no parent.
label?stringA name for people to read, up to 100 characters. Leave it out and Marfa derives one from the last segment of the identifier.
plural?stringThe label's plural, up to 100 characters, such as People. Leave it out and Marfa adds s, es or ies to the label by the regular English rule.
description?stringWhat the type is for.
roles?array<string>The structural roles the type plays: container. An edge type's role:<name> constraint matches types by role.
required?array<string>The names of the fields an item of the type must have. It means the same as required: true on each of them.
compatible_with?|array<string>The types this one is a structural superset of. Marfa checks the claim when you save the type. A bare string names one type.
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?stringThe 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.
id*stringThe type's identifier, such as acme.deal or user.recipe.
Returns the normalized candidate and the registered definitions.
application/json- response
Canonical definitions from one registry view, with field defaults made explicit as required: false and searchable: true.
type*The normalized candidate's declared definition, including its label and defaults.
registered_type*|The canonical registered type's declared definition; null if its identifier is not registered.
resolved_type*|The canonical registered definition, with inherited fields, policies and roles resolved as on GET /types/{id}, with the author's icon and not the owner's; null if its identifier is not registered.
missing_required_field:fieldsis missing.validation_error:idis malformed, orparentisn't registered or makes too deep a chain.invalid_schema: the schema is invalid or has a key it doesn't define (details.errorsnames each path).property_shadows_field: a field is named like one every item has.inheritance_violation: the type reshapes an inherited field.
application/json- 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- 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- response
An error response.
error*What went wrong.
type_chain_unresolvable: the type's stored definition does not read. PUT /types/{id} can correct it.
application/json- 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- response
An error response.
error*What went wrong.
request_too_large: the request body is larger than this instance accepts.
application/json- response
An error response.
error*What went wrong.
compatible_with_violation: compatible_with names a type this instance doesn't hold, or one the type doesn't satisfy.
application/json- 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- 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- 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- 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- response
An error response.
error*What went wrong.
curl -X POST 'http://localhost:8600/types/normalize' \ -H 'Content-Type: application/json' \ -d '{ "fields": { "property1": { "type": "string", "property1": null, "property2": null }, "property2": { "type": "string", "property1": null, "property2": null } }, "id": "string"}'{ "type": { "id": "acme.deal", "version": 0, "fields": { "name": { "type": "string", "required": true, "searchable": true } }, "label": "Deal" }, "registered_type": { "id": "acme.deal", "label": "Deal", "version": 0, "fields": { "name": { "type": "string", "label": "Name", "required": true, "searchable": true }, "amount": { "type": "number", "label": "Amount", "required": false, "searchable": true }, "stage": { "type": "enum", "label": "Stage", "enum_values": [ "lead", "won", "lost" ], "required": false, "searchable": true } }, "plural": "Deals", "description": "A sales deal.", "display_hints": { "title_field": "name" } }, "resolved_type": { "id": "acme.deal", "version": 0, "fields": { "name": { "type": "string", "label": "Name", "required": true, "searchable": true }, "amount": { "type": "number", "label": "Amount", "required": false, "searchable": true }, "stage": { "type": "enum", "label": "Stage", "enum_values": [ "lead", "won", "lost" ], "required": false, "searchable": true } }, "label": "Deal", "plural": "Deals", "description": "A sales deal.", "display_hints": { "title_field": "name" } }}