Validate a registry document

POST

/config/validate/registry

curl --request POST \
  --url https://api.sloose.com/config/validate/registry \
  --header 'Content-Type: application/json' \
  --data '{ "version": 1, "modules": [ { "key": "example", "apiName": "example", "label": "example", "singular": "example", "color": "example", "defaultEnabled": true, "uniqueFields": [ "example" ], "defaultDuplicateCheck": { "searchField": "example", "searchMethod": "example", "expression": "example" }, "excludedFields": [ "example" ], "seedMappings": { "additionalProperty": { "mode": "column", "source": "example", "staticValue": "example", "transform": "example", "skip": true, "searchField": "example", "searchMethod": "example", "searchExpression": "example", "patch": { "when": [ "pending" ], "overwrite": "always" } } } } ], "expressionContext": "example", "apiDelayMs": 1, "systemExcludedFields": [ "example" ], "dateFormat": "DMY" }'

• Production
• Staging

Checks a RegistryDoc against the current schema and reports the module keys it declares. No authentication, no storage, no side effects.

Request Body^required

A registry document.

Media typeapplication/json

object

version

integer

modules

required

Array<object>

object

key

required

string

/^[a-z][a-z0-9_]*$/

apiName

required

string

>= 1 characters

label

required

string

>= 1 characters

singular

required

string

/^[A-Za-z_$][\w$]*$/

color

string

defaultEnabled

boolean

uniqueFields

Array<string>

defaultDuplicateCheck

object

searchField

string

searchMethod

string

expression

string

excludedFields

Array<string>

seedMappings

object

key

additional properties

object

mode

string

Allowed values: column static expression search skip

source

string | null

staticValue

string | null

transform

string | null

skip

boolean

searchField

string | null

searchMethod

string | null

searchExpression

string | null

patch

object

when

Array<string>

Allowed values: pending created updated exists skipped filtered guarded dryrun error blocked

overwrite

string

Allowed values: always if-absent

expressionContext

string

/^[A-Za-z_$][\w$]*$/

apiDelayMs

integer

systemExcludedFields

Array<string>

dateFormat

string

Allowed values: DMY MDY YMD

Responses

200

Valid. modules lists the keys it declares, in order.

Media typeapplication/json

object

ok

required

boolean

modules

required

Array<string>

Example

{
  "ok": true
}

400

Not a valid registry document. This route answers { ok: false, issues } rather than the usual error envelope, because the SDK prints the issue list directly.

Media typeapplication/json

object

ok

required

boolean

issues

required

Array

Example

{
  "ok": false
}