Skip to navigation
APIReference

Put Definition

Authentication

AuthorizationBearer

ediphai_test_… or ediphai_live_…

Path parameters

keystringRequired
versionstringRequired

Request

This endpoint expects an object.
kindenumRequired
Allowed values:
namestringRequired1-200 characters
roleslist of objectsRequired
sectionslist of objectsRequired
itemslist of objectsRequired
keystringOptionalformat: "^([a-z][a-z0-9_]{0,63}\.)?[a-z][a-z0-9_]{0,63}$"

A key. Platform definitions prefix their declarer’s namespace (rock.disc); church keys never contain a dot

declarerstringOptionalformat: "^[a-z][a-z0-9_]{0,63}$"
The declaring source, or a platform namespace such as rock
scopeenumOptional
church unless a platform seed declares global
Allowed values:
supersedesstring or nullOptionalformat: "^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$"
respondentslist of objectsOptional

Who may answer; self only when not declared

readingobjectOptional

Response

Unchanged: this version was already stored with the same definition

keystring
versionstring
declarerstring

The source that declared it; the key is namespaced by it

scope"church"
envenum
Allowed values:
statusstring

applied: in use at once, in the environment of the key that sent it

supersedesstring or null
linestring
The version that started the compatible line this version joins
compatibleboolean or null

Whether it is compatible with the version it supersedes; null when it supersedes none. false starts a new line

reasonslist of strings
Why it is not compatible, one line each
hashstring

sha256 of the canonical definition; an identical re-PUT answers 200 with this receipt

Errors

4XX
Client Request Error
5XX
Server Error