Skip to content
HallifyDevelopersSearch documentation
Open Hallify
Sections

Guest resource observers

Read a native resource observer baseline

POST/public/guest-observers/baseline

Verifies the current native READ capability and actual Origin, captures a real resource journal barrier, then rechecks the same authority before reading its safe current snapshot. No consumed Socket principal is required. Request a separate ticket and compare scopeBinding before subscribing to public-guest with this cursor. Dependency unavailability returns an error without a substitute cursor.

Authentication

A personal credential is supplied in body: public-guest-native-read-capability.

Connection guide

Parameters

originHeader · Required

Actual browser-supplied Origin, required and verified for canonical and bound native READ access.

string
Full definition
{
  "type": "string",
  "maxLength": 2048,
  "example": "example"
}

Request body

Required

Exact native resource and its current private READ capability, carried directly in the body. No account, device, cookie or URL credential fallback is used.

application/json

ReadPublicGuestObserverBaselineDto
Full definition
{
  "$ref": "#/components/schemas/ReadPublicGuestObserverBaselineDto"
}

Responses

200Safe current native snapshot and its real resource-authority-bound cursor. This operation issues no ticket or replacement capability.

Response headers

Cache-Control

The capability-scoped response is never stored.

string
Full definition
{
  "type": "string",
  "enum": [
    "no-store"
  ],
  "example": "no-store"
}
PublicGuestObserverBaselineDto
Full definition
{
  "$ref": "#/components/schemas/PublicGuestObserverBaselineDto"
}
Example response · 200 · application/json
{
  "streamId": "public-guest",
  "scopeBinding": "gpos1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
  "cursor": "WyIzblpfaUh2aGkyUmw0MHpIQXNvcEF4UE1QX1hmQmhnVWdGemVVSDB5YktNIiwwLCJzeW50aGV0aWMtb2JzZXJ2ZXItZXBvY2giLCIwIiwxODkzNDU2MDAwMDAwXQ.mLmPD58AQQrBrOVbBTVSC1hGgPgEAqJHdEWB-qBcs6Q",
  "snapshot": {
    "kind": "PREORDER",
    "id": "c279756e-3e4a-4ce8-80ee-294a35df0667",
    "orderId": "445745d8-5b60-47eb-98e2-c3a9a146f7fa",
    "revision": 1,
    "status": "CONFIRMED",
    "serviceMode": "PICKUP",
    "scheduledFor": "2030-01-02T12:00:00.000Z",
    "partySize": 2
  }
}
400Native resource or capability shape is invalid.
TranslatedErrorDto
Full definition
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Example response · 400 · application/json
{
  "statusCode": 400,
  "error": "errors:http.badRequest",
  "code": "HTTP_BAD_REQUEST",
  "message": "errors:http.badRequest",
  "translationKey": "errors:http.badRequest"
}
401Current authority expired, changed or no longer owns this resource.
TranslatedErrorDto
Full definition
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Example response · 401 · application/json
{
  "statusCode": 401,
  "error": "errors:http.unauthorized",
  "code": "HTTP_UNAUTHORIZED",
  "message": "errors:http.unauthorized",
  "translationKey": "errors:http.unauthorized"
}
403Actual browser Origin is missing or denied.
TranslatedErrorDto
Full definition
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Example response · 403 · application/json
{
  "statusCode": 403,
  "error": "errors:http.forbidden",
  "code": "HTTP_FORBIDDEN",
  "message": "errors:http.forbidden",
  "translationKey": "errors:http.forbidden"
}
404Native READ access is unavailable without resource enumeration.
TranslatedErrorDto
Full definition
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Example response · 404 · application/json
{
  "statusCode": 404,
  "error": "errors:http.notFound",
  "code": "HTTP_NOT_FOUND",
  "message": "errors:http.notFound",
  "translationKey": "errors:http.notFound"
}
503The real journal or security fence is not ready, the bounded request budget was exceeded, or dependencies became unavailable.
TranslatedErrorDto
Full definition
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Example response · 503 · application/json
{
  "statusCode": 503,
  "error": "errors:http.serviceUnavailable",
  "code": "HTTP_SERVICE_UNAVAILABLE",
  "message": "errors:http.serviceUnavailable",
  "translationKey": "errors:http.serviceUnavailable"
}

Schemas

ReadPublicGuestObserverBaselineDto

Private native READ request for a safe resource snapshot and its observer cursor. The current capability and actual browser Origin are verified again after the journal barrier. This request issues no ticket, cookie or replacement native capability.

kindRequired

Native resource family with implemented observer admission, authorized by the submitted current READ capability. Scheduled preorder, reservation, waitlist and table session sources are each verified by their owning domain.

allOf
Full definition
{
  "description": "Native resource family with implemented observer admission, authorized by the submitted current READ capability. Scheduled preorder, reservation, waitlist and table session sources are each verified by their owning domain.",
  "allOf": [
    {
      "$ref": "#/components/schemas/PublicObserverTicketResourceKind"
    }
  ],
  "example": "PREORDER"
}
resourceIdRequired

Exact native preorder fulfillment, reservation, waitlist entry or table session UUID. The current capability must own this resource.

string · uuid
Full definition
{
  "type": "string",
  "format": "uuid",
  "description": "Exact native preorder fulfillment, reservation, waitlist entry or table session UUID. The current capability must own this resource.",
  "example": "d5b5eb29-9b8d-4d6f-8f4f-6f0e58f32568"
}
capabilityRequired

Private current native READ capability for the selected resource. Submit directly in this command body; keep it outside URLs, Redux, logs and browser account authentication.

string
Full definition
{
  "type": "string",
  "minLength": 20,
  "maxLength": 1024,
  "writeOnly": true,
  "description": "Private current native READ capability for the selected resource. Submit directly in this command body; keep it outside URLs, Redux, logs and browser account authentication.",
  "example": "https://example.test/resource"
}
Full definition
{
  "type": "object",
  "properties": {
    "kind": {
      "description": "Native resource family with implemented observer admission, authorized by the submitted current READ capability. Scheduled preorder, reservation, waitlist and table session sources are each verified by their owning domain.",
      "allOf": [
        {
          "$ref": "#/components/schemas/PublicObserverTicketResourceKind"
        }
      ],
      "example": "PREORDER"
    },
    "resourceId": {
      "type": "string",
      "format": "uuid",
      "description": "Exact native preorder fulfillment, reservation, waitlist entry or table session UUID. The current capability must own this resource.",
      "example": "d5b5eb29-9b8d-4d6f-8f4f-6f0e58f32568"
    },
    "capability": {
      "type": "string",
      "minLength": 20,
      "maxLength": 1024,
      "writeOnly": true,
      "description": "Private current native READ capability for the selected resource. Submit directly in this command body; keep it outside URLs, Redux, logs and browser account authentication.",
      "example": "https://example.test/resource"
    }
  },
  "description": "Private native READ request for a safe resource snapshot and its observer cursor. The current capability and actual browser Origin are verified again after the journal barrier. This request issues no ticket, cookie or replacement native capability.",
  "required": [
    "kind",
    "resourceId",
    "capability"
  ],
  "example": {
    "kind": "PREORDER",
    "resourceId": "d5b5eb29-9b8d-4d6f-8f4f-6f0e58f32568",
    "capability": "https://example.test/resource"
  }
}
PublicObserverTicketResourceKind

Native resource family with implemented observer admission, authorized by the submitted current READ capability. Scheduled preorder, reservation, waitlist and table session sources are each verified by their owning domain.

Full definition
{
  "type": "string",
  "enum": [
    "PREORDER",
    "RESERVATION",
    "WAITLIST",
    "TABLE_SESSION"
  ],
  "description": "Native resource family with implemented observer admission, authorized by the submitted current READ capability. Scheduled preorder, reservation, waitlist and table session sources are each verified by their owning domain.",
  "example": "PREORDER"
}
PublicGuestObserverBaselineDto

Capability-scoped native snapshot with a real resource-and-authority-bound Socket cursor captured before that snapshot. Request a separate ticket and require matching scopeBinding before subscribing. This response grants no replacement native access or transport cookie.

streamIdRequired

Only public native resource observer stream supported by this baseline.

string
Full definition
{
  "type": "string",
  "enum": [
    "public-guest"
  ],
  "description": "Only public native resource observer stream supported by this baseline.",
  "example": "public-guest"
}
scopeBindingRequired

Noncredential authority binding. It must match the separately issued ticket; append a colon and a client context of 1–128 characters for the session scope.

string
Full definition
{
  "type": "string",
  "minLength": 49,
  "maxLength": 49,
  "pattern": "^gpos1_[A-Za-z0-9_-]{43}$",
  "example": "gpos1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
  "description": "Noncredential authority binding. It must match the separately issued ticket; append a colon and a client context of 1–128 characters for the session scope."
}
cursorRequired

Actual signed cursor from the configured journal head and current native authority. Keep it with this snapshot and resource context; it grants no authority by itself. The example uses only synthetic data and a synthetic signing key.

string
Full definition
{
  "type": "string",
  "minLength": 1,
  "maxLength": 512,
  "example": "WyIzblpfaUh2aGkyUmw0MHpIQXNvcEF4UE1QX1hmQmhnVWdGemVVSDB5YktNIiwwLCJzeW50aGV0aWMtb2JzZXJ2ZXItZXBvY2giLCIwIiwxODkzNDU2MDAwMDAwXQ.mLmPD58AQQrBrOVbBTVSC1hGgPgEAqJHdEWB-qBcs6Q",
  "description": "Actual signed cursor from the configured journal head and current native authority. Keep it with this snapshot and resource context; it grants no authority by itself. The example uses only synthetic data and a synthetic signing key."
}
snapshotRequired

Safe current READ projection returned by the exact owning domain after reauthorization.

oneOf
Full definition
{
  "description": "Safe current READ projection returned by the exact owning domain after reauthorization.",
  "oneOf": [
    {
      "$ref": "#/components/schemas/PublicGuestObserverPreorderSnapshotDto"
    },
    {
      "$ref": "#/components/schemas/PublicGuestObserverReservationSnapshotDto"
    },
    {
      "$ref": "#/components/schemas/PublicGuestObserverWaitlistSnapshotDto"
    },
    {
      "$ref": "#/components/schemas/PublicGuestObserverTableSnapshotDto"
    }
  ],
  "discriminator": {
    "propertyName": "kind",
    "mapping": {
      "PREORDER": "#/components/schemas/PublicGuestObserverPreorderSnapshotDto",
      "RESERVATION": "#/components/schemas/PublicGuestObserverReservationSnapshotDto",
      "WAITLIST": "#/components/schemas/PublicGuestObserverWaitlistSnapshotDto",
      "TABLE_SESSION": "#/components/schemas/PublicGuestObserverTableSnapshotDto"
    }
  },
  "example": {
    "kind": "PREORDER",
    "id": "c279756e-3e4a-4ce8-80ee-294a35df0667",
    "orderId": "445745d8-5b60-47eb-98e2-c3a9a146f7fa",
    "revision": 1,
    "status": "CONFIRMED",
    "serviceMode": "PICKUP",
    "scheduledFor": "2030-01-02T12:00:00.000Z",
    "partySize": 2
  }
}
Full definition
{
  "type": "object",
  "properties": {
    "streamId": {
      "type": "string",
      "enum": [
        "public-guest"
      ],
      "description": "Only public native resource observer stream supported by this baseline.",
      "example": "public-guest"
    },
    "scopeBinding": {
      "type": "string",
      "minLength": 49,
      "maxLength": 49,
      "pattern": "^gpos1_[A-Za-z0-9_-]{43}$",
      "example": "gpos1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
      "description": "Noncredential authority binding. It must match the separately issued ticket; append a colon and a client context of 1–128 characters for the session scope."
    },
    "cursor": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512,
      "example": "WyIzblpfaUh2aGkyUmw0MHpIQXNvcEF4UE1QX1hmQmhnVWdGemVVSDB5YktNIiwwLCJzeW50aGV0aWMtb2JzZXJ2ZXItZXBvY2giLCIwIiwxODkzNDU2MDAwMDAwXQ.mLmPD58AQQrBrOVbBTVSC1hGgPgEAqJHdEWB-qBcs6Q",
      "description": "Actual signed cursor from the configured journal head and current native authority. Keep it with this snapshot and resource context; it grants no authority by itself. The example uses only synthetic data and a synthetic signing key."
    },
    "snapshot": {
      "description": "Safe current READ projection returned by the exact owning domain after reauthorization.",
      "oneOf": [
        {
          "$ref": "#/components/schemas/PublicGuestObserverPreorderSnapshotDto"
        },
        {
          "$ref": "#/components/schemas/PublicGuestObserverReservationSnapshotDto"
        },
        {
          "$ref": "#/components/schemas/PublicGuestObserverWaitlistSnapshotDto"
        },
        {
          "$ref": "#/components/schemas/PublicGuestObserverTableSnapshotDto"
        }
      ],
      "discriminator": {
        "propertyName": "kind",
        "mapping": {
          "PREORDER": "#/components/schemas/PublicGuestObserverPreorderSnapshotDto",
          "RESERVATION": "#/components/schemas/PublicGuestObserverReservationSnapshotDto",
          "WAITLIST": "#/components/schemas/PublicGuestObserverWaitlistSnapshotDto",
          "TABLE_SESSION": "#/components/schemas/PublicGuestObserverTableSnapshotDto"
        }
      },
      "example": {
        "kind": "PREORDER",
        "id": "c279756e-3e4a-4ce8-80ee-294a35df0667",
        "orderId": "445745d8-5b60-47eb-98e2-c3a9a146f7fa",
        "revision": 1,
        "status": "CONFIRMED",
        "serviceMode": "PICKUP",
        "scheduledFor": "2030-01-02T12:00:00.000Z",
        "partySize": 2
      }
    }
  },
  "description": "Capability-scoped native snapshot with a real resource-and-authority-bound Socket cursor captured before that snapshot. Request a separate ticket and require matching scopeBinding before subscribing. This response grants no replacement native access or transport cookie.",
  "required": [
    "streamId",
    "scopeBinding",
    "cursor",
    "snapshot"
  ],
  "example": {
    "streamId": "public-guest",
    "scopeBinding": "gpos1_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
    "cursor": "WyIzblpfaUh2aGkyUmw0MHpIQXNvcEF4UE1QX1hmQmhnVWdGemVVSDB5YktNIiwwLCJzeW50aGV0aWMtb2JzZXJ2ZXItZXBvY2giLCIwIiwxODkzNDU2MDAwMDAwXQ.mLmPD58AQQrBrOVbBTVSC1hGgPgEAqJHdEWB-qBcs6Q",
    "snapshot": {
      "kind": "PREORDER",
      "id": "c279756e-3e4a-4ce8-80ee-294a35df0667",
      "orderId": "445745d8-5b60-47eb-98e2-c3a9a146f7fa",
      "revision": 1,
      "status": "CONFIRMED",
      "serviceMode": "PICKUP",
      "scheduledFor": "2030-01-02T12:00:00.000Z",
      "partySize": 2
    }
  }
}
PublicGuestObserverPreorderSnapshotDto

Current capability-scoped scheduled preorder READ snapshot. The native owner supplies public status and schedule fields without contact, deposit, allocation or private payment data.

kindRequired

Native resource family of this snapshot.

string
Full definition
{
  "type": "string",
  "enum": [
    "PREORDER"
  ],
  "description": "Native resource family of this snapshot.",
  "example": "PREORDER"
}
idRequired

Exact native scheduled fulfillment authorized by the capability.

string · uuid
Full definition
{
  "type": "string",
  "format": "uuid",
  "description": "Exact native scheduled fulfillment authorized by the capability.",
  "example": "c279756e-3e4a-4ce8-80ee-294a35df0667"
}
orderIdRequired

Native order belonging to the authorized scheduled fulfillment.

string · uuid
Full definition
{
  "type": "string",
  "format": "uuid",
  "description": "Native order belonging to the authorized scheduled fulfillment.",
  "example": "445745d8-5b60-47eb-98e2-c3a9a146f7fa"
}
revisionRequired

Current native fulfillment business revision.

integer
Full definition
{
  "type": "integer",
  "minimum": 1,
  "description": "Current native fulfillment business revision.",
  "example": 1
}
statusRequired

Current scheduled fulfillment status, read from its owner.

string
Full definition
{
  "type": "string",
  "enum": [
    "DRAFT",
    "HELD",
    "CONFIRMED",
    "IN_PREPARATION",
    "READY_FOR_HANDOFF",
    "OUT_FOR_DELIVERY",
    "COMPLETED",
    "CANCELED",
    "EXPIRED"
  ],
  "description": "Current scheduled fulfillment status, read from its owner.",
  "example": "CONFIRMED"
}
serviceModeRequired

Current native fulfillment service mode.

string
Full definition
{
  "type": "string",
  "enum": [
    "DINE_IN",
    "PICKUP",
    "DELIVERY",
    "CATERING"
  ],
  "description": "Current native fulfillment service mode.",
  "example": "PICKUP"
}
scheduledForRequired

Current scheduled service instant for the authorized fulfillment.

string · date-time
Full definition
{
  "type": "string",
  "format": "date-time",
  "description": "Current scheduled service instant for the authorized fulfillment.",
  "example": "2030-01-02T12:00:00.000Z"
}
partySizeRequired

Current native party size.

integer
Full definition
{
  "type": "integer",
  "minimum": 1,
  "description": "Current native party size.",
  "example": 2
}
deliveryTrackingOptional

Current accepted-pair delivery projection. Omitted for legacy fulfillments; null when no matching external shipment exists.

object · null
Full definition
{
  "nullable": true,
  "description": "Current accepted-pair delivery projection. Omitted for legacy fulfillments; null when no matching external shipment exists.",
  "type": "object",
  "properties": {
    "shipmentId": {
      "type": "string",
      "format": "uuid",
      "description": "Shipment bound to the current accepted native quote pair.",
      "example": "107f0aae-41ba-4259-84aa-b07de763733f"
    },
    "revision": {
      "type": "integer",
      "minimum": 1,
      "description": "Monotonic shipment projection revision.",
      "example": 1
    },
    "provider": {
      "type": "string",
      "enum": [
        "UBER_DIRECT",
        "WOLT_DRIVE"
      ],
      "description": "Delivery provider retained in the accepted native delivery demand.",
      "example": "UBER_DIRECT"
    },
    "state": {
      "description": "Verified carrier projection, including explicit uncertainty and reconciliation states.",
      "allOf": [
        {
          "$ref": "#/components/schemas/DeliveryShipmentState"
        }
      ],
      "example": "PREPARED"
    },
    "trackingUrl": {
      "type": "string",
      "nullable": true,
      "format": "uri",
      "maxLength": 2048,
      "description": "Verified HTTPS tracking URL, or null when unavailable or withheld by the owning privacy boundary.",
      "example": "https://example.test/resource"
    },
    "pickupEta": {
      "type": "string",
      "nullable": true,
      "format": "date-time",
      "description": "Latest provider pickup estimate as an ISO UTC instant, or null.",
      "example": "2026-01-15T12:00:00.000Z"
    },
    "dropoffEtaMin": {
      "type": "string",
      "nullable": true,
      "format": "date-time",
      "description": "Earliest provider dropoff estimate as an ISO UTC instant, or null.",
      "example": "2026-01-15T12:00:00.000Z"
    },
    "dropoffEtaMax": {
      "type": "string",
      "nullable": true,
      "format": "date-time",
      "description": "Latest provider dropoff estimate as an ISO UTC instant, or null.",
      "example": "2026-01-15T12:00:00.000Z"
    },
    "requiresAttention": {
      "type": "boolean",
      "description": "Carrier evidence or native application requires operator attention; it grants no payment or meal-cancellation authority.",
      "example": true
    }
  },
  "required": [
    "shipmentId",
    "revision",
    "provider",
    "state",
    "trackingUrl",
    "pickupEta",
    "dropoffEtaMin",
    "dropoffEtaMax",
    "requiresAttention"
  ],
  "example": {
    "shipmentId": "107f0aae-41ba-4259-84aa-b07de763733f",
    "revision": 1,
    "provider": "UBER_DIRECT",
    "state": "PREPARED",
    "trackingUrl": null,
    "pickupEta": null,
    "dropoffEtaMin": null,
    "dropoffEtaMax": null,
    "requiresAttention": true
  }
}
Full definition
{
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": [
        "PREORDER"
      ],
      "description": "Native resource family of this snapshot.",
      "example": "PREORDER"
    },
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Exact native scheduled fulfillment authorized by the capability.",
      "example": "c279756e-3e4a-4ce8-80ee-294a35df0667"
    },
    "orderId": {
      "type": "string",
      "format": "uuid",
      "description": "Native order belonging to the authorized scheduled fulfillment.",
      "example": "445745d8-5b60-47eb-98e2-c3a9a146f7fa"
    },
    "revision": {
      "type": "integer",
      "minimum": 1,
      "description": "Current native fulfillment business revision.",
      "example": 1
    },
    "status": {
      "type": "string",
      "enum": [
        "DRAFT",
        "HELD",
        "CONFIRMED",
        "IN_PREPARATION",
        "READY_FOR_HANDOFF",
        "OUT_FOR_DELIVERY",
        "COMPLETED",
        "CANCELED",
        "EXPIRED"
      ],
      "description": "Current scheduled fulfillment status, read from its owner.",
      "example": "CONFIRMED"
    },
    "serviceMode": {
      "type": "string",
      "enum": [
        "DINE_IN",
        "PICKUP",
        "DELIVERY",
        "CATERING"
      ],
      "description": "Current native fulfillment service mode.",
      "example": "PICKUP"
    },
    "scheduledFor": {
      "type": "string",
      "format": "date-time",
      "description": "Current scheduled service instant for the authorized fulfillment.",
      "example": "2030-01-02T12:00:00.000Z"
    },
    "partySize": {
      "type": "integer",
      "minimum": 1,
      "description": "Current native party size.",
      "example": 2
    },
    "deliveryTracking": {
      "nullable": true,
      "description": "Current accepted-pair delivery projection. Omitted for legacy fulfillments; null when no matching external shipment exists.",
      "type": "object",
      "properties": {
        "shipmentId": {
          "type": "string",
          "format": "uuid",
          "description": "Shipment bound to the current accepted native quote pair.",
          "example": "107f0aae-41ba-4259-84aa-b07de763733f"
        },
        "revision": {
          "type": "integer",
          "minimum": 1,
          "description": "Monotonic shipment projection revision.",
          "example": 1
        },
        "provider": {
          "type": "string",
          "enum": [
            "UBER_DIRECT",
            "WOLT_DRIVE"
          ],
          "description": "Delivery provider retained in the accepted native delivery demand.",
          "example": "UBER_DIRECT"
        },
        "state": {
          "description": "Verified carrier projection, including explicit uncertainty and reconciliation states.",
          "allOf": [
            {
              "$ref": "#/components/schemas/DeliveryShipmentState"
            }
          ],
          "example": "PREPARED"
        },
        "trackingUrl": {
          "type": "string",
          "nullable": true,
          "format": "uri",
          "maxLength": 2048,
          "description": "Verified HTTPS tracking URL, or null when unavailable or withheld by the owning privacy boundary.",
          "example": "https://example.test/resource"
        },
        "pickupEta": {
          "type": "string",
          "nullable": true,
          "format": "date-time",
          "description": "Latest provider pickup estimate as an ISO UTC instant, or null.",
          "example": "2026-01-15T12:00:00.000Z"
        },
        "dropoffEtaMin": {
          "type": "string",
          "nullable": true,
          "format": "date-time",
          "description": "Earliest provider dropoff estimate as an ISO UTC instant, or null.",
          "example": "2026-01-15T12:00:00.000Z"
        },
        "dropoffEtaMax": {
          "type": "string",
          "nullable": true,
          "format": "date-time",
          "description": "Latest provider dropoff estimate as an ISO UTC instant, or null.",
          "example": "2026-01-15T12:00:00.000Z"
        },
        "requiresAttention": {
          "type": "boolean",
          "description": "Carrier evidence or native application requires operator attention; it grants no payment or meal-cancellation authority.",
          "example": true
        }
      },
      "required": [
        "shipmentId",
        "revision",
        "provider",
        "state",
        "trackingUrl",
        "pickupEta",
        "dropoffEtaMin",
        "dropoffEtaMax",
        "requiresAttention"
      ],
      "example": {
        "shipmentId": "107f0aae-41ba-4259-84aa-b07de763733f",
        "revision": 1,
        "provider": "UBER_DIRECT",
        "state": "PREPARED",
        "trackingUrl": null,
        "pickupEta": null,
        "dropoffEtaMin": null,
        "dropoffEtaMax": null,
        "requiresAttention": true
      }
    }
  },
  "description": "Current capability-scoped scheduled preorder READ snapshot. The native owner supplies public status and schedule fields without contact, deposit, allocation or private payment data.",
  "required": [
    "kind",
    "id",
    "orderId",
    "revision",
    "status",
    "serviceMode",
    "scheduledFor",
    "partySize"
  ],
  "example": {
    "kind": "PREORDER",
    "id": "c279756e-3e4a-4ce8-80ee-294a35df0667",
    "orderId": "445745d8-5b60-47eb-98e2-c3a9a146f7fa",
    "revision": 1,
    "status": "CONFIRMED",
    "serviceMode": "PICKUP",
    "scheduledFor": "2030-01-02T12:00:00.000Z",
    "partySize": 2
  }
}
DeliveryShipmentState

Verified carrier projection, including explicit uncertainty and reconciliation states.

Full definition
{
  "type": "string",
  "enum": [
    "PREPARED",
    "DISPATCHING",
    "UNKNOWN",
    "CONFIRMED",
    "PICKUP_STARTED",
    "PICKED_UP",
    "IN_TRANSIT",
    "DELIVERED",
    "CANCELED",
    "NOT_DELIVERED",
    "RETURNING",
    "RETURNED",
    "REJECTED",
    "RECONCILIATION_REQUIRED"
  ],
  "description": "Verified carrier projection, including explicit uncertainty and reconciliation states.",
  "example": "PREPARED"
}
PublicGuestObserverReservationSnapshotDto

Current capability-scoped reservation READ snapshot, restricted to native public status, schedule and party fields.

kindRequired

Native resource family of this snapshot.

string
Full definition
{
  "type": "string",
  "enum": [
    "RESERVATION"
  ],
  "description": "Native resource family of this snapshot.",
  "example": "RESERVATION"
}
idRequired

Exact reservation authorized by the current capability.

string · uuid
Full definition
{
  "type": "string",
  "format": "uuid",
  "description": "Exact reservation authorized by the current capability.",
  "example": "c279756e-3e4a-4ce8-80ee-294a35df0667"
}
referenceCodeRequired

Public booking reference for the authorized reservation.

string
Full definition
{
  "type": "string",
  "description": "Public booking reference for the authorized reservation.",
  "example": "SYNTHETIC"
}
revisionRequired

Current native reservation business revision.

integer
Full definition
{
  "type": "integer",
  "minimum": 1,
  "description": "Current native reservation business revision.",
  "example": 1
}
statusRequired

Current native reservation status; observer events carry no substitute status.

string
Full definition
{
  "type": "string",
  "enum": [
    "REQUESTED",
    "BOOKED",
    "CONFIRMED",
    "ARRIVED",
    "SEATED",
    "CANCELED",
    "NO_SHOW",
    "DECLINED",
    "EXPIRED"
  ],
  "description": "Current native reservation status; observer events carry no substitute status.",
  "example": "CONFIRMED"
}
scheduledAtRequired

Current authorized reservation start instant.

string · date-time
Full definition
{
  "type": "string",
  "format": "date-time",
  "description": "Current authorized reservation start instant.",
  "example": "2030-01-02T12:00:00.000Z"
}
endsAtRequired

Current authorized reservation end instant.

string · date-time
Full definition
{
  "type": "string",
  "format": "date-time",
  "description": "Current authorized reservation end instant.",
  "example": "2030-01-02T14:00:00.000Z"
}
partySizeRequired

Current party size for this reservation.

integer
Full definition
{
  "type": "integer",
  "minimum": 1,
  "description": "Current party size for this reservation.",
  "example": 2
}
Full definition
{
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": [
        "RESERVATION"
      ],
      "description": "Native resource family of this snapshot.",
      "example": "RESERVATION"
    },
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Exact reservation authorized by the current capability.",
      "example": "c279756e-3e4a-4ce8-80ee-294a35df0667"
    },
    "referenceCode": {
      "type": "string",
      "description": "Public booking reference for the authorized reservation.",
      "example": "SYNTHETIC"
    },
    "revision": {
      "type": "integer",
      "minimum": 1,
      "description": "Current native reservation business revision.",
      "example": 1
    },
    "status": {
      "type": "string",
      "enum": [
        "REQUESTED",
        "BOOKED",
        "CONFIRMED",
        "ARRIVED",
        "SEATED",
        "CANCELED",
        "NO_SHOW",
        "DECLINED",
        "EXPIRED"
      ],
      "description": "Current native reservation status; observer events carry no substitute status.",
      "example": "CONFIRMED"
    },
    "scheduledAt": {
      "type": "string",
      "format": "date-time",
      "description": "Current authorized reservation start instant.",
      "example": "2030-01-02T12:00:00.000Z"
    },
    "endsAt": {
      "type": "string",
      "format": "date-time",
      "description": "Current authorized reservation end instant.",
      "example": "2030-01-02T14:00:00.000Z"
    },
    "partySize": {
      "type": "integer",
      "minimum": 1,
      "description": "Current party size for this reservation.",
      "example": 2
    }
  },
  "description": "Current capability-scoped reservation READ snapshot, restricted to native public status, schedule and party fields.",
  "required": [
    "kind",
    "id",
    "referenceCode",
    "revision",
    "status",
    "scheduledAt",
    "endsAt",
    "partySize"
  ],
  "example": {
    "kind": "RESERVATION",
    "id": "c279756e-3e4a-4ce8-80ee-294a35df0667",
    "referenceCode": "SYNTHETIC",
    "revision": 1,
    "status": "CONFIRMED",
    "scheduledAt": "2030-01-02T12:00:00.000Z",
    "endsAt": "2030-01-02T14:00:00.000Z",
    "partySize": 2
  }
}
PublicGuestObserverWaitlistSnapshotDto

Current capability-scoped waitlist READ snapshot, including public status, party size and an optional claim window.

kindRequired

Native resource family of this snapshot.

string
Full definition
{
  "type": "string",
  "enum": [
    "WAITLIST"
  ],
  "description": "Native resource family of this snapshot.",
  "example": "WAITLIST"
}
idRequired

Exact waitlist entry authorized by the current capability.

string · uuid
Full definition
{
  "type": "string",
  "format": "uuid",
  "description": "Exact waitlist entry authorized by the current capability.",
  "example": "c279756e-3e4a-4ce8-80ee-294a35df0667"
}
referenceCodeRequired

Public reference for the authorized waitlist entry.

string
Full definition
{
  "type": "string",
  "description": "Public reference for the authorized waitlist entry.",
  "example": "SYNTHETIC"
}
revisionRequired

Current native waitlist business revision.

integer
Full definition
{
  "type": "integer",
  "minimum": 1,
  "description": "Current native waitlist business revision.",
  "example": 1
}
statusRequired

Current native waitlist status, read from its owner.

string
Full definition
{
  "type": "string",
  "enum": [
    "WAITING",
    "NOTIFIED",
    "CLAIMED",
    "SKIPPED",
    "SEATED",
    "CANCELED",
    "NO_SHOW"
  ],
  "description": "Current native waitlist status, read from its owner.",
  "example": "WAITING"
}
partySizeRequired

Current party size for this waitlist entry.

integer
Full definition
{
  "type": "integer",
  "minimum": 1,
  "description": "Current party size for this waitlist entry.",
  "example": 2
}
claimExpiresAtRequired

Current claim deadline; null when no claim window exists.

string · date-time · null
Full definition
{
  "type": "string",
  "format": "date-time",
  "nullable": true,
  "description": "Current claim deadline; null when no claim window exists.",
  "example": null
}
Full definition
{
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": [
        "WAITLIST"
      ],
      "description": "Native resource family of this snapshot.",
      "example": "WAITLIST"
    },
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Exact waitlist entry authorized by the current capability.",
      "example": "c279756e-3e4a-4ce8-80ee-294a35df0667"
    },
    "referenceCode": {
      "type": "string",
      "description": "Public reference for the authorized waitlist entry.",
      "example": "SYNTHETIC"
    },
    "revision": {
      "type": "integer",
      "minimum": 1,
      "description": "Current native waitlist business revision.",
      "example": 1
    },
    "status": {
      "type": "string",
      "enum": [
        "WAITING",
        "NOTIFIED",
        "CLAIMED",
        "SKIPPED",
        "SEATED",
        "CANCELED",
        "NO_SHOW"
      ],
      "description": "Current native waitlist status, read from its owner.",
      "example": "WAITING"
    },
    "partySize": {
      "type": "integer",
      "minimum": 1,
      "description": "Current party size for this waitlist entry.",
      "example": 2
    },
    "claimExpiresAt": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Current claim deadline; null when no claim window exists.",
      "example": null
    }
  },
  "description": "Current capability-scoped waitlist READ snapshot, including public status, party size and an optional claim window.",
  "required": [
    "kind",
    "id",
    "referenceCode",
    "revision",
    "status",
    "partySize",
    "claimExpiresAt"
  ],
  "example": {
    "kind": "WAITLIST",
    "id": "c279756e-3e4a-4ce8-80ee-294a35df0667",
    "referenceCode": "SYNTHETIC",
    "revision": 1,
    "status": "WAITING",
    "partySize": 2,
    "claimExpiresAt": null
  }
}
PublicGuestObserverTableSnapshotDto

Current native QR membership READ projection for the authorized guest slot, without CRM identity, staff data, order or payment truth.

kindRequired

Native resource family of this snapshot.

string
Full definition
{
  "type": "string",
  "enum": [
    "TABLE_SESSION"
  ],
  "description": "Native resource family of this snapshot.",
  "example": "TABLE_SESSION"
}
membershipIdRequired

Native membership that authorizes this guest READ scope.

string · uuid
Full definition
{
  "type": "string",
  "format": "uuid",
  "description": "Native membership that authorizes this guest READ scope.",
  "example": "c279756e-3e4a-4ce8-80ee-294a35df0667"
}
tableSessionIdRequired

Exact native table session authorized by this membership.

string · uuid
Full definition
{
  "type": "string",
  "format": "uuid",
  "description": "Exact native table session authorized by this membership.",
  "example": "445745d8-5b60-47eb-98e2-c3a9a146f7fa"
}
tableSessionGuestIdRequired

Authorized native guest slot inside this table session.

string · uuid
Full definition
{
  "type": "string",
  "format": "uuid",
  "description": "Authorized native guest slot inside this table session.",
  "example": "3ddab55e-0d96-4cda-bf10-5cb7a5848306"
}
guestLabelRequired

Current display label of the authorized guest slot.

string
Full definition
{
  "type": "string",
  "description": "Current display label of the authorized guest slot.",
  "example": "Guest 1"
}
tableLabelRequired

Current public label of the authorized physical table.

string
Full definition
{
  "type": "string",
  "description": "Current public label of the authorized physical table.",
  "example": "Table 4"
}
paymentScopeRequired

Current payment-entry availability hint. It grants no payment authority; collection requires current native payment access and explicit consent.

string
Full definition
{
  "type": "string",
  "enum": [
    "DISABLED",
    "ASSIGNED_ITEMS",
    "SESSION_BILL"
  ],
  "description": "Current payment-entry availability hint. It grants no payment authority; collection requires current native payment access and explicit consent.",
  "example": "DISABLED"
}
revisionRequired

Current native membership authority revision.

integer
Full definition
{
  "type": "integer",
  "minimum": 1,
  "description": "Current native membership authority revision.",
  "example": 1
}
accessEpochRequired

Native table-session access epoch of the membership.

integer
Full definition
{
  "type": "integer",
  "minimum": 1,
  "description": "Native table-session access epoch of the membership.",
  "example": 1
}
policyAccessEpochRequired

Native venue QR authority epoch of the membership.

integer
Full definition
{
  "type": "integer",
  "minimum": 1,
  "description": "Native venue QR authority epoch of the membership.",
  "example": 1
}
expiresAtRequired

Original native membership expiry; observer tickets and leases also obey current presentation deadlines.

string · date-time
Full definition
{
  "type": "string",
  "format": "date-time",
  "description": "Original native membership expiry; observer tickets and leases also obey current presentation deadlines.",
  "example": "2030-01-01T00:10:00.000Z"
}
Full definition
{
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": [
        "TABLE_SESSION"
      ],
      "description": "Native resource family of this snapshot.",
      "example": "TABLE_SESSION"
    },
    "membershipId": {
      "type": "string",
      "format": "uuid",
      "description": "Native membership that authorizes this guest READ scope.",
      "example": "c279756e-3e4a-4ce8-80ee-294a35df0667"
    },
    "tableSessionId": {
      "type": "string",
      "format": "uuid",
      "description": "Exact native table session authorized by this membership.",
      "example": "445745d8-5b60-47eb-98e2-c3a9a146f7fa"
    },
    "tableSessionGuestId": {
      "type": "string",
      "format": "uuid",
      "description": "Authorized native guest slot inside this table session.",
      "example": "3ddab55e-0d96-4cda-bf10-5cb7a5848306"
    },
    "guestLabel": {
      "type": "string",
      "description": "Current display label of the authorized guest slot.",
      "example": "Guest 1"
    },
    "tableLabel": {
      "type": "string",
      "description": "Current public label of the authorized physical table.",
      "example": "Table 4"
    },
    "paymentScope": {
      "type": "string",
      "enum": [
        "DISABLED",
        "ASSIGNED_ITEMS",
        "SESSION_BILL"
      ],
      "description": "Current payment-entry availability hint. It grants no payment authority; collection requires current native payment access and explicit consent.",
      "example": "DISABLED"
    },
    "revision": {
      "type": "integer",
      "minimum": 1,
      "description": "Current native membership authority revision.",
      "example": 1
    },
    "accessEpoch": {
      "type": "integer",
      "minimum": 1,
      "description": "Native table-session access epoch of the membership.",
      "example": 1
    },
    "policyAccessEpoch": {
      "type": "integer",
      "minimum": 1,
      "description": "Native venue QR authority epoch of the membership.",
      "example": 1
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time",
      "description": "Original native membership expiry; observer tickets and leases also obey current presentation deadlines.",
      "example": "2030-01-01T00:10:00.000Z"
    }
  },
  "description": "Current native QR membership READ projection for the authorized guest slot, without CRM identity, staff data, order or payment truth.",
  "required": [
    "kind",
    "membershipId",
    "tableSessionId",
    "tableSessionGuestId",
    "guestLabel",
    "tableLabel",
    "paymentScope",
    "revision",
    "accessEpoch",
    "policyAccessEpoch",
    "expiresAt"
  ],
  "example": {
    "kind": "TABLE_SESSION",
    "membershipId": "c279756e-3e4a-4ce8-80ee-294a35df0667",
    "tableSessionId": "445745d8-5b60-47eb-98e2-c3a9a146f7fa",
    "tableSessionGuestId": "3ddab55e-0d96-4cda-bf10-5cb7a5848306",
    "guestLabel": "Guest 1",
    "tableLabel": "Table 4",
    "paymentScope": "DISABLED",
    "revision": 1,
    "accessEpoch": 1,
    "policyAccessEpoch": 1,
    "expiresAt": "2030-01-01T00:10:00.000Z"
  }
}
TranslatedErrorDto

Stable error envelope emitted by the global HTTP exception boundary. Domain-specific machine data, when present, is nested under details.

statusCodeRequired

HTTP status code repeated from the response.

integer
Full definition
{
  "type": "integer",
  "description": "HTTP status code repeated from the response.",
  "example": 400
}
errorRequired

Translation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.

string
Full 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"
}
codeRequired

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.

string
Full 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."
}
messageRequired

Translation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application.

string
Full 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."
}
translationKeyRequired

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.

string
Full 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."
}
translationValuesOptional

Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.

object
Full 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"
  }
}
validationErrorsOptional

Field validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.

array
Full 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"
    }
  ]
}
detailsOptional

Optional domain-specific blocker or validation details

oneOf
Full 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.

fieldRequired

Public field path. Nested properties and array indices are separated by dots.

string
Full definition
{
  "type": "string",
  "example": "email",
  "description": "Public field path. Nested properties and array indices are separated by dots."
}
translationKeyRequired

Translation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog.

string
Full 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."
}
codeRequired

Stable validator identifier for this field failure. Custom validators may define additional identifiers.

string
Full definition
{
  "type": "string",
  "example": "isEmail",
  "description": "Stable validator identifier for this field failure. Custom validators may define additional identifiers."
}
messageRequired

Translation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included.

string
Full 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."
}
translationValuesOptional

Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.

object
Full 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"
}

Hallify uses essential cookies and optional analytics.

Essential cookies keep sign-in, locale, and theme preferences working. Analytics is off until you choose to allow it.