Skip to content

ThemeProblem

A 422 of the theme operations. For the type /api/v1/problems/invalid-theme, theme_errors lists why the token set cannot be saved or published; another 422 (a malformed request) has none.

object
type
required

A URI that identifies the problem type, stable for clients to branch on. It is about:blank when the problem means no more than its HTTP status.

string format: uri-reference
title
required

A short summary of the problem type, localized from Accept-Language.

string
status
required

The HTTP status code.

integer
>= 400 <= 599
detail

An explanation of this occurrence, localized from Accept-Language.

string
request_id

The request ID (the X-Request-Id response header), for reporting the problem.

string
field

The member of the request that a 422 is about, by its name in the request: a property of the JSON body by its path (display_name, fields[].name, poll.options[1]), a form field, a query parameter, or a header (Idempotency-Key). detail then says what is wrong with its value without naming it, for the client to show beside that field. Absent when the problem is not about one member.

string
theme_errors
Array<object>

One reason a token set cannot be saved or published. code is unknown_token, duplicate_token, invalid_value (the value does not have the token’s shape; scheme names the color scheme of a color), out_of_range (min and max are the bounds, in rem for a length and ms for a duration), low_contrast (token on background is ratio:1 in scheme and needs minimum:1), or too_many_overrides (more than max tokens).

object
code
required
string
Allowed values: unknown_token duplicate_token invalid_value out_of_range low_contrast too_many_overrides
token
string
scheme
string
Allowed values: light dark
background
string
ratio
number
minimum
number
min
number
max
number

Example generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"request_id": "example",
"field": "example",
"theme_errors": [
{
"code": "unknown_token",
"token": "example",
"scheme": "light",
"background": "example",
"ratio": 1,
"minimum": 1,
"min": 1,
"max": 1
}
]
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site