Authentication
A Hallify account session is not required. Follow this operation’s prerequisites and restrictions.
Connection guideParameters
publicHandlePath · RequiredPublished hosted brand handle.
stringFull definition
{ "type": "string", "minLength": 1, "maxLength": 48, "example": "example" }limitQuery · OptionalMaximum number of results. The server applies twenty when omitted.
integerFull definition
{ "minimum": 1, "maximum": 50, "default": 20, "type": "integer", "example": 20 }cursorQuery · OptionalOpaque continuation cursor from the preceding page for the same scope and ordering.
stringFull definition
{ "minLength": 1, "maxLength": 256, "type": "string", "example": "example" }
Responses
200Bounded outlet directory page with scope-bound cursor or null at termination.
Full definition
{
"$ref": "#/components/schemas/StorefrontPublicOutletPageDto"
}{
"items": [
{
"storefrontId": "26a6ca08-40bb-46b0-88cb-edd7b56e8643",
"venue": {
"venueId": "0604de3a-da74-4ad5-89f6-2dfe000d5391",
"name": "Example name",
"currency": "GEL",
"timeZone": "Asia/Tbilisi",
"countryCode": null,
"city": null,
"region": null
},
"ordering": null,
"reservations": null
}
],
"nextCursor": null
}400The handle, page limit or cursor is invalid or belongs to another brand scope.
Full definition
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 400,
"error": "errors:http.badRequest",
"code": "HTTP_BAD_REQUEST",
"message": "errors:http.badRequest",
"translationKey": "errors:http.badRequest"
}404The handle has no active published brand presentation with current hosted authority.
Full definition
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 404,
"error": "errors:http.notFound",
"code": "HTTP_NOT_FOUND",
"message": "errors:http.notFound",
"translationKey": "errors:http.notFound"
}503Scoped native ordering discovery cannot be safely projected. Error code: STOREFRONT_ORDERING_UNAVAILABLE. Invalid scoped reservation discovery uses STOREFRONT_RESERVATIONS_UNAVAILABLE.
Full definition
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 503,
"error": "errors:http.serviceUnavailable",
"code": "HTTP_SERVICE_UNAVAILABLE",
"message": "errors:http.serviceUnavailable",
"translationKey": "errors:http.serviceUnavailable"
}Schemas
StorefrontPublicOutletPageDto
Bounded public brand outlet directory page containing safe venue entries and a nullable opaque continuation cursor.
itemsRequiredBounded outlet directory page.
arrayFull definition
{ "description": "Bounded outlet directory page.", "maxItems": 50, "type": "array", "items": { "$ref": "#/components/schemas/StorefrontPublicOutletDto" }, "example": [ { "storefrontId": "26a6ca08-40bb-46b0-88cb-edd7b56e8643", "venue": { "venueId": "0604de3a-da74-4ad5-89f6-2dfe000d5391", "name": "Example name", "currency": "GEL", "timeZone": "Asia/Tbilisi", "countryCode": null, "city": null, "region": null }, "ordering": null, "reservations": null } ] }nextCursorRequiredOpaque continuation cursor, or null when the directory page is final.
string · nullFull definition
{ "type": "string", "description": "Opaque continuation cursor, or null when the directory page is final.", "nullable": true, "minLength": 1, "maxLength": 256, "example": "example" }
Full definition
{
"type": "object",
"properties": {
"items": {
"description": "Bounded outlet directory page.",
"maxItems": 50,
"type": "array",
"items": {
"$ref": "#/components/schemas/StorefrontPublicOutletDto"
},
"example": [
{
"storefrontId": "26a6ca08-40bb-46b0-88cb-edd7b56e8643",
"venue": {
"venueId": "0604de3a-da74-4ad5-89f6-2dfe000d5391",
"name": "Example name",
"currency": "GEL",
"timeZone": "Asia/Tbilisi",
"countryCode": null,
"city": null,
"region": null
},
"ordering": null,
"reservations": null
}
]
},
"nextCursor": {
"type": "string",
"description": "Opaque continuation cursor, or null when the directory page is final.",
"nullable": true,
"minLength": 1,
"maxLength": 256,
"example": "example"
}
},
"description": "Bounded public brand outlet directory page containing safe venue entries and a nullable opaque continuation cursor.",
"required": [
"items",
"nextCursor"
],
"example": {
"items": [
{
"storefrontId": "26a6ca08-40bb-46b0-88cb-edd7b56e8643",
"venue": {
"venueId": "0604de3a-da74-4ad5-89f6-2dfe000d5391",
"name": "Example name",
"currency": "GEL",
"timeZone": "Asia/Tbilisi",
"countryCode": null,
"city": null,
"region": null
},
"ordering": null,
"reservations": null
}
],
"nextCursor": null
}
}StorefrontPublicOutletDto
Public brand directory entry pairing an actual venue profile with its explicitly selected venue storefront identity.
storefrontIdRequiredExplicit venue storefront UUID in this brand directory.
string · uuidFull definition
{ "type": "string", "description": "Explicit venue storefront UUID in this brand directory.", "format": "uuid", "example": "26a6ca08-40bb-46b0-88cb-edd7b56e8643" }venueRequiredSafe public profile for this actual venue.
allOfFull definition
{ "description": "Safe public profile for this actual venue.", "allOf": [ { "$ref": "#/components/schemas/StorefrontPublicVenueProfileDto" } ], "example": { "venueId": "0604de3a-da74-4ad5-89f6-2dfe000d5391", "name": "Example name", "currency": "GEL", "timeZone": "Asia/Tbilisi", "countryCode": null, "city": null, "region": null } }orderingRequiredCurrent attached active native preorder channel for this outlet and presentation connection, or null when none is available. This nonsecret discovery does not authorize an order or payment.
object · nullFull definition
{ "description": "Current attached active native preorder channel for this outlet and presentation connection, or null when none is available. This nonsecret discovery does not authorize an order or payment.", "nullable": true, "type": "object", "properties": { "connectionId": { "type": "string", "description": "Presentation connection UUID to retain as the nonsecret connection locator on native public draft requests. This does not replace current request-origin authorization.", "format": "uuid", "example": "2fde64d5-54a3-47d0-800f-a015f92a8878" }, "resourceId": { "type": "string", "description": "Current attached PREORDER resource UUID within the presentation connection and selected venue. This is a discovery locator, not a capability.", "format": "uuid", "example": "d5b5eb29-9b8d-4d6f-8f4f-6f0e58f32568" }, "venueId": { "type": "string", "description": "Actual native venue UUID owning this attachment and preorder channel. Orders remain scoped to this venue.", "format": "uuid", "example": "0604de3a-da74-4ad5-89f6-2dfe000d5391" }, "publicChannelId": { "type": "string", "description": "Active native preorder public channel UUID belonging to the selected venue.", "format": "uuid", "example": "9bee613d-3322-4a03-8b9f-8a6259984eee" }, "publicChannelHandle": { "type": "string", "description": "Native preorder channel discovery handle used by the public catalog. This is distinct from the enclosing storefront presentation handle.", "minLength": 1, "maxLength": 48, "example": "example" } }, "required": [ "connectionId", "resourceId", "venueId", "publicChannelId", "publicChannelHandle" ], "example": { "connectionId": "2fde64d5-54a3-47d0-800f-a015f92a8878", "resourceId": "d5b5eb29-9b8d-4d6f-8f4f-6f0e58f32568", "venueId": "0604de3a-da74-4ad5-89f6-2dfe000d5391", "publicChannelId": "9bee613d-3322-4a03-8b9f-8a6259984eee", "publicChannelHandle": "example" } }reservationsRequiredCurrent attached active native reservation channel for this outlet and presentation connection, or null when none is available. This nonsecret discovery grants no booking, waitlist, guest or financial authority.
object · nullFull definition
{ "description": "Current attached active native reservation channel for this outlet and presentation connection, or null when none is available. This nonsecret discovery grants no booking, waitlist, guest or financial authority.", "nullable": true, "type": "object", "properties": { "connectionId": { "type": "string", "description": "Presentation connection UUID used only as the nonsecret connection locator for native public reservation requests. This does not replace current request-origin authorization.", "format": "uuid", "example": "2fde64d5-54a3-47d0-800f-a015f92a8878" }, "resourceId": { "type": "string", "description": "Current attached RESERVATION resource UUID within this presentation connection and venue. This is a discovery locator, not a capability.", "format": "uuid", "example": "d5b5eb29-9b8d-4d6f-8f4f-6f0e58f32568" }, "venueId": { "type": "string", "description": "Actual native venue UUID owning this attachment and reservation channel. Booking and waitlist demand remain scoped to this venue.", "format": "uuid", "example": "0604de3a-da74-4ad5-89f6-2dfe000d5391" }, "publicChannelId": { "type": "string", "description": "Active native reservation public channel UUID belonging to the selected venue.", "format": "uuid", "example": "9bee613d-3322-4a03-8b9f-8a6259984eee" }, "publicChannelHandle": { "type": "string", "description": "Native reservation channel discovery handle used by public booking configuration and availability. This is distinct from the enclosing storefront presentation handle.", "minLength": 1, "maxLength": 48, "example": "1.000" } }, "required": [ "connectionId", "resourceId", "venueId", "publicChannelId", "publicChannelHandle" ], "example": { "connectionId": "2fde64d5-54a3-47d0-800f-a015f92a8878", "resourceId": "d5b5eb29-9b8d-4d6f-8f4f-6f0e58f32568", "venueId": "0604de3a-da74-4ad5-89f6-2dfe000d5391", "publicChannelId": "9bee613d-3322-4a03-8b9f-8a6259984eee", "publicChannelHandle": "1.000" } }
Full definition
{
"type": "object",
"properties": {
"storefrontId": {
"type": "string",
"description": "Explicit venue storefront UUID in this brand directory.",
"format": "uuid",
"example": "26a6ca08-40bb-46b0-88cb-edd7b56e8643"
},
"venue": {
"description": "Safe public profile for this actual venue.",
"allOf": [
{
"$ref": "#/components/schemas/StorefrontPublicVenueProfileDto"
}
],
"example": {
"venueId": "0604de3a-da74-4ad5-89f6-2dfe000d5391",
"name": "Example name",
"currency": "GEL",
"timeZone": "Asia/Tbilisi",
"countryCode": null,
"city": null,
"region": null
}
},
"ordering": {
"description": "Current attached active native preorder channel for this outlet and presentation connection, or null when none is available. This nonsecret discovery does not authorize an order or payment.",
"nullable": true,
"type": "object",
"properties": {
"connectionId": {
"type": "string",
"description": "Presentation connection UUID to retain as the nonsecret connection locator on native public draft requests. This does not replace current request-origin authorization.",
"format": "uuid",
"example": "2fde64d5-54a3-47d0-800f-a015f92a8878"
},
"resourceId": {
"type": "string",
"description": "Current attached PREORDER resource UUID within the presentation connection and selected venue. This is a discovery locator, not a capability.",
"format": "uuid",
"example": "d5b5eb29-9b8d-4d6f-8f4f-6f0e58f32568"
},
"venueId": {
"type": "string",
"description": "Actual native venue UUID owning this attachment and preorder channel. Orders remain scoped to this venue.",
"format": "uuid",
"example": "0604de3a-da74-4ad5-89f6-2dfe000d5391"
},
"publicChannelId": {
"type": "string",
"description": "Active native preorder public channel UUID belonging to the selected venue.",
"format": "uuid",
"example": "9bee613d-3322-4a03-8b9f-8a6259984eee"
},
"publicChannelHandle": {
"type": "string",
"description": "Native preorder channel discovery handle used by the public catalog. This is distinct from the enclosing storefront presentation handle.",
"minLength": 1,
"maxLength": 48,
"example": "example"
}
},
"required": [
"connectionId",
"resourceId",
"venueId",
"publicChannelId",
"publicChannelHandle"
],
"example": {
"connectionId": "2fde64d5-54a3-47d0-800f-a015f92a8878",
"resourceId": "d5b5eb29-9b8d-4d6f-8f4f-6f0e58f32568",
"venueId": "0604de3a-da74-4ad5-89f6-2dfe000d5391",
"publicChannelId": "9bee613d-3322-4a03-8b9f-8a6259984eee",
"publicChannelHandle": "example"
}
},
"reservations": {
"description": "Current attached active native reservation channel for this outlet and presentation connection, or null when none is available. This nonsecret discovery grants no booking, waitlist, guest or financial authority.",
"nullable": true,
"type": "object",
"properties": {
"connectionId": {
"type": "string",
"description": "Presentation connection UUID used only as the nonsecret connection locator for native public reservation requests. This does not replace current request-origin authorization.",
"format": "uuid",
"example": "2fde64d5-54a3-47d0-800f-a015f92a8878"
},
"resourceId": {
"type": "string",
"description": "Current attached RESERVATION resource UUID within this presentation connection and venue. This is a discovery locator, not a capability.",
"format": "uuid",
"example": "d5b5eb29-9b8d-4d6f-8f4f-6f0e58f32568"
},
"venueId": {
"type": "string",
"description": "Actual native venue UUID owning this attachment and reservation channel. Booking and waitlist demand remain scoped to this venue.",
"format": "uuid",
"example": "0604de3a-da74-4ad5-89f6-2dfe000d5391"
},
"publicChannelId": {
"type": "string",
"description": "Active native reservation public channel UUID belonging to the selected venue.",
"format": "uuid",
"example": "9bee613d-3322-4a03-8b9f-8a6259984eee"
},
"publicChannelHandle": {
"type": "string",
"description": "Native reservation channel discovery handle used by public booking configuration and availability. This is distinct from the enclosing storefront presentation handle.",
"minLength": 1,
"maxLength": 48,
"example": "1.000"
}
},
"required": [
"connectionId",
"resourceId",
"venueId",
"publicChannelId",
"publicChannelHandle"
],
"example": {
"connectionId": "2fde64d5-54a3-47d0-800f-a015f92a8878",
"resourceId": "d5b5eb29-9b8d-4d6f-8f4f-6f0e58f32568",
"venueId": "0604de3a-da74-4ad5-89f6-2dfe000d5391",
"publicChannelId": "9bee613d-3322-4a03-8b9f-8a6259984eee",
"publicChannelHandle": "1.000"
}
}
},
"description": "Public brand directory entry pairing an actual venue profile with its explicitly selected venue storefront identity.",
"required": [
"storefrontId",
"venue",
"ordering",
"reservations"
],
"example": {
"storefrontId": "26a6ca08-40bb-46b0-88cb-edd7b56e8643",
"venue": {
"venueId": "0604de3a-da74-4ad5-89f6-2dfe000d5391",
"name": "Example name",
"currency": "GEL",
"timeZone": "Asia/Tbilisi",
"countryCode": null,
"city": null,
"region": null
},
"ordering": null,
"reservations": null
}
}StorefrontPublicVenueProfileDto
Safe native venue display projection containing its identity, name, currency, time zone and nullable public geographic labels.
venueIdRequiredActual native venue UUID.
string · uuidFull definition
{ "type": "string", "description": "Actual native venue UUID.", "format": "uuid", "example": "0604de3a-da74-4ad5-89f6-2dfe000d5391" }nameRequiredPublic venue display name.
stringFull definition
{ "type": "string", "description": "Public venue display name.", "minLength": 1, "maxLength": 255, "example": "Example name" }currencyRequiredNative venue currency code; presentation does not convert it.
stringFull definition
{ "type": "string", "description": "Native venue currency code; presentation does not convert it.", "minLength": 3, "maxLength": 3, "example": "GEL" }timeZoneRequiredNative venue time-zone identifier.
stringFull definition
{ "type": "string", "description": "Native venue time-zone identifier.", "minLength": 1, "maxLength": 64, "example": "Asia/Tbilisi" }countryCodeRequiredConfigured venue country code, or null when unavailable.
string · nullFull definition
{ "type": "string", "description": "Configured venue country code, or null when unavailable.", "nullable": true, "minLength": 2, "maxLength": 2, "example": "GE" }cityRequiredPublic venue city, or null when unavailable.
string · nullFull definition
{ "type": "string", "description": "Public venue city, or null when unavailable.", "nullable": true, "maxLength": 120, "example": "example" }regionRequiredPublic venue region, or null when unavailable.
string · nullFull definition
{ "type": "string", "description": "Public venue region, or null when unavailable.", "nullable": true, "maxLength": 120, "example": "example" }
Full definition
{
"type": "object",
"properties": {
"venueId": {
"type": "string",
"description": "Actual native venue UUID.",
"format": "uuid",
"example": "0604de3a-da74-4ad5-89f6-2dfe000d5391"
},
"name": {
"type": "string",
"description": "Public venue display name.",
"minLength": 1,
"maxLength": 255,
"example": "Example name"
},
"currency": {
"type": "string",
"description": "Native venue currency code; presentation does not convert it.",
"minLength": 3,
"maxLength": 3,
"example": "GEL"
},
"timeZone": {
"type": "string",
"description": "Native venue time-zone identifier.",
"minLength": 1,
"maxLength": 64,
"example": "Asia/Tbilisi"
},
"countryCode": {
"type": "string",
"description": "Configured venue country code, or null when unavailable.",
"nullable": true,
"minLength": 2,
"maxLength": 2,
"example": "GE"
},
"city": {
"type": "string",
"description": "Public venue city, or null when unavailable.",
"nullable": true,
"maxLength": 120,
"example": "example"
},
"region": {
"type": "string",
"description": "Public venue region, or null when unavailable.",
"nullable": true,
"maxLength": 120,
"example": "example"
}
},
"description": "Safe native venue display projection containing its identity, name, currency, time zone and nullable public geographic labels.",
"required": [
"venueId",
"name",
"currency",
"timeZone",
"countryCode",
"city",
"region"
],
"example": {
"venueId": "0604de3a-da74-4ad5-89f6-2dfe000d5391",
"name": "Example name",
"currency": "GEL",
"timeZone": "Asia/Tbilisi",
"countryCode": null,
"city": null,
"region": null
}
}TranslatedErrorDto
Stable error envelope emitted by the global HTTP exception boundary. Domain-specific machine data, when present, is nested under details.
statusCodeRequiredHTTP status code repeated from the response.
integerFull definition
{ "type": "integer", "description": "HTTP status code repeated from the response.", "example": 400 }errorRequiredTranslation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.
stringFull definition
{ "type": "string", "description": "Translation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.", "example": "errors.request.invalid" }codeRequiredStable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions.
stringFull definition
{ "type": "string", "example": "HTTP_BAD_REQUEST", "description": "Stable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions." }messageRequiredTranslation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application.
stringFull definition
{ "type": "string", "example": "errors:http.badRequest", "description": "Translation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application." }translationKeyRequiredCanonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback.
stringFull definition
{ "type": "string", "example": "errors:http.badRequest", "description": "Canonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback." }translationValuesOptionalOptional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.
objectFull definition
{ "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "example": "example" }, { "type": "number", "example": 0 }, { "type": "boolean", "example": true } ], "example": "example" }, "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.", "example": { "exampleKey": "example" } }validationErrorsOptionalField validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.
arrayFull definition
{ "description": "Field validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.", "type": "array", "items": { "$ref": "#/components/schemas/ValidationErrorDto" }, "example": [ { "field": "email", "translationKey": "validation:isEmail", "code": "isEmail", "message": "validation:isEmail" } ] }detailsOptionalOptional domain-specific blocker or validation details
oneOfFull definition
{ "description": "Optional domain-specific blocker or validation details", "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/JsonValue" }, "example": [ "example" ] }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/JsonValue" }, "example": { "exampleKey": "example" } } ], "example": [ "example" ] }
Full definition
{
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"description": "HTTP status code repeated from the response.",
"example": 400
},
"error": {
"type": "string",
"description": "Translation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.",
"example": "errors.request.invalid"
},
"code": {
"type": "string",
"example": "HTTP_BAD_REQUEST",
"description": "Stable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions."
},
"message": {
"type": "string",
"example": "errors:http.badRequest",
"description": "Translation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application."
},
"translationKey": {
"type": "string",
"example": "errors:http.badRequest",
"description": "Canonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback."
},
"translationValues": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "string",
"example": "example"
},
{
"type": "number",
"example": 0
},
{
"type": "boolean",
"example": true
}
],
"example": "example"
},
"description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
"example": {
"exampleKey": "example"
}
},
"validationErrors": {
"description": "Field validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationErrorDto"
},
"example": [
{
"field": "email",
"translationKey": "validation:isEmail",
"code": "isEmail",
"message": "validation:isEmail"
}
]
},
"details": {
"description": "Optional domain-specific blocker or validation details",
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonValue"
},
"example": [
"example"
]
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/JsonValue"
},
"example": {
"exampleKey": "example"
}
}
],
"example": [
"example"
]
}
},
"required": [
"statusCode",
"error",
"code",
"message",
"translationKey"
],
"description": "Stable error envelope emitted by the global HTTP exception boundary. Domain-specific machine data, when present, is nested under details.",
"example": {
"statusCode": 400,
"error": "errors:http.badRequest",
"code": "HTTP_BAD_REQUEST",
"message": "errors:http.badRequest",
"translationKey": "errors:http.badRequest"
}
}ValidationErrorDto
Field validation failure with a field path, stable validator code and a translation key. Human-readable text belongs to the consuming application.
fieldRequiredPublic field path. Nested properties and array indices are separated by dots.
stringFull definition
{ "type": "string", "example": "email", "description": "Public field path. Nested properties and array indices are separated by dots." }translationKeyRequiredTranslation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog.
stringFull definition
{ "type": "string", "example": "validation:isEmail", "description": "Translation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog." }codeRequiredStable validator identifier for this field failure. Custom validators may define additional identifiers.
stringFull definition
{ "type": "string", "example": "isEmail", "description": "Stable validator identifier for this field failure. Custom validators may define additional identifiers." }messageRequiredTranslation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included.
stringFull definition
{ "type": "string", "example": "validation:isEmail", "description": "Translation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included." }translationValuesOptionalOptional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.
objectFull definition
{ "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "example": "example" }, { "type": "number", "example": 0 }, { "type": "boolean", "example": true } ], "example": "example" }, "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.", "example": { "exampleKey": "example" } }
Full definition
{
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "email",
"description": "Public field path. Nested properties and array indices are separated by dots."
},
"translationKey": {
"type": "string",
"example": "validation:isEmail",
"description": "Translation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog."
},
"code": {
"type": "string",
"example": "isEmail",
"description": "Stable validator identifier for this field failure. Custom validators may define additional identifiers."
},
"message": {
"type": "string",
"example": "validation:isEmail",
"description": "Translation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included."
},
"translationValues": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "string",
"example": "example"
},
{
"type": "number",
"example": 0
},
{
"type": "boolean",
"example": true
}
],
"example": "example"
},
"description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
"example": {
"exampleKey": "example"
}
}
},
"required": [
"field",
"translationKey",
"code",
"message"
],
"description": "Field validation failure with a field path, stable validator code and a translation key. Human-readable text belongs to the consuming application.",
"example": {
"field": "email",
"translationKey": "validation:isEmail",
"code": "isEmail",
"message": "validation:isEmail"
}
}JsonValue
Recursively JSON-safe value used only where the owning contract intentionally allows free-form structured data.
Full definition
{
"oneOf": [
{
"type": "string",
"nullable": true,
"example": "example"
},
{
"type": "number",
"example": 0
},
{
"type": "boolean",
"example": true
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonValue"
},
"example": [
"example"
]
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/JsonValue"
},
"example": {
"exampleKey": "example"
}
}
],
"description": "Recursively JSON-safe value used only where the owning contract intentionally allows free-form structured data.",
"example": "example"
}