/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference Get Deprecation Table

Get Deprecation Table

Every deprecated authoring form with its machine-applicable rewrite rule — what stx migrate applies

GET/v1/schema/deprecations.jsonTry it

Returns every deprecated form — config keys, frontmatter keys, MDX tags and props — with the rule that rewrites it. stx migrate fetches this, so newly published rules reach an older stx.

Authentication

None. Public, with the same caching headers as Get syntext.json Schema (Content-Type: application/json).

Response

NameDescription
version:number
The table format version (1).
windowDays:number
Days between a deprecation notice and removal (14).
items:array
One entry per code: code, kind (config, frontmatter, mdx-tag, mdx-prop), old, replacement, rewrite, fix (the rewrite in plain words), requiresV2 (the replacement needs doc engine v2, so it's held back on v1 sites) and an optional note.

Rewrite types

rewrite.typeFieldsWhat it does
move-keyfrom, to[], values?Copy the value at from to each path in to (mapped through values when present), skip a target that's already set, then delete from. [] in a path means every array element
set-valuepath, from, toReplace the value from at path with to
remove-keypathDelete the key
rename-filefrom, toRename the config file, only when to doesn't exist
rename-frontmatter-keyfrom, toRename the key unless to is set (then delete from)
frontmatter-flag-to-valuefrom, to, valuefrom: true becomes to: value unless to is set; from: false is deleted
rename-tagfrom, toRename opening, closing and self-closing tags outside code fences
tag-from-proptag, prop, map<tag prop="x"> becomes <map[x]> with the prop dropped, and the closing tag follows. Unknown values are left alone
rename-proptag, from, toRename the attribute on that tag unless to is present
home-to-mdxfile ("index")Write the index page's generated home as home components — from its home frontmatter, or the preset's home when there is none — and drop home. Needs the site's last build (Convert the home to content with target: "preview")
manualhintNot automatic — a person renames or deletes it

Example

Abbreviated to two of the 38 items.

Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl https://api.syntext.dev/v1/schema/deprecations.json
Responseapplication/json
json
{
"version": 1,
"windowDays": 14,
"items": [
{
"code": "mdx.update-label",
"kind": "mdx-prop",
"old": "<Update label=\"…\">",
"replacement": "<Update title=\"…\">",
"rewrite": { "type": "rename-prop", "tag": "Update", "from": "label", "to": "title" },
"fix": "Rename the label prop of <Update> to title.",
"requiresV2": false
},
{
"code": "config.colors-primary",
"kind": "config",
"old": "colors.primary",
"replacement": "appearance.accent",
"rewrite": { "type": "move-key", "from": "colors.primary", "to": ["appearance.accent"] },
"fix": "Move colors.primary to appearance.accent.",
"requiresV2": true,
"note": "The appearance block applies when the site renders with doc engine v2; adding it opts the site in. v1 also painted parameter names with colors.primary; appearance.accent derives every accent token instead."
}
]
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext