Skip to main content
PATCH
update_domain

Authorizations

X-API-Key
string
header
required

Path Parameters

domain_id
string<uuid>
required

Domain version identifier.

Body

application/json

Any subset of the create request.

Editing a draft mutates it. Editing a published domain creates version n+1 as a new draft and leaves version n untouched — there is no way to change the vocabulary under a live corpus, because a workspace that could not explain its own folder structure is worse than one with an old vocabulary.

display_name
string | null
Required string length: 1 - 200
ontology
Ontology · object | null

The graph shape. Closed node and edge types with declared domain/range.

allow_other is the ontology's counterpart to :attr:Taxonomy.allow_other, and unlike it, this one can be turned off: a file must always be classifiable, but an entity need not always be extractable.

taxonomy
Taxonomy · object | null

The classification vocabulary.

Response

Successful Response

domain
Domain · object
required

A domain with inheritance already resolved.

A caller reading a domain wants the vocabulary that will actually be applied, not a delta they have to merge themselves.

validation
DomainValidation · object
required

Returned on every domain write, so a caller never has to guess whether a publish will succeed.