Schema Validation

Schema Validation

HZN Queue Console supports AsyncAPI 2.x / 3.x schemas. Once you import a schema, messages in the matching queue are validated against it automatically, and the filter bar gains schema-aware typed inputs.

Importing a Schema

  1. Open AsyncAPI Manager from the toolbar or the … menu.
  2. Click Import schema.
  3. Paste your AsyncAPI YAML or JSON, or load it from a local file.
  4. The schema is parsed and its message types are extracted.

Schemas are stored locally per server connection.

Assigning a Schema to a Queue

After importing:

  1. Select the queue in the queue list.
  2. Click Assign schema in the message browser toolbar.
  3. Choose the message type from the schema that this queue carries.

The assignment is saved and remembered across sessions.

Validation in the Message Browser

With a schema assigned, each message row shows a validation badge:

  • Valid — the message payload conforms to the schema
  • Invalid — one or more fields are missing, have the wrong type, or fail other constraints. Hover the badge to see the exact validation errors.
  • No schema — shown for messages in queues without an assigned schema

This is useful for catching malformed messages that may have caused processing errors downstream.

Schema-Aware Filters

When a schema is assigned to a queue, the filter bar expands with typed inputs for each top-level property defined in the schema. For example, a schema with a customerId string field and a status enum field would add:

  • A text input labeled customerId
  • A dropdown labeled status with the enum values

These filters are applied the same way as standard filters — any combination, AND logic.

Viewing the Schema

Click View schema on any assigned queue to open a read-only panel showing the full schema definition, field descriptions, types, and required fields. This is useful as a quick reference without leaving the queue browser.

Exporting and Sharing

Schemas can be exported as YAML or JSON from the AsyncAPI Manager. You can share them with team members who import them on their own machines.