Skip to content
HALOWERK

Codewerk

asyncapi validate

Runs the Spectral asyncapi ruleset (@stoplight/spectral-rulesets 1.23.0), whose schema rules validate the document against the official AsyncAPI JSON Schemas shipped in @asyncapi/specs 6.11.1 (AsyncAPI 2.0.0-2.6.0 and 3.0.0/3.1.0), checks that local $refs resolve, that channel parameters match the channel address, payloads are valid schemas and examples match them, operationIds and messageIds are unique and server security references exist. A document is valid when no error-level finding.

POST https://code.halowerk.com/v1/asyncapi-validate

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
documentSee schemaYesThe AsyncAPI document as a JSON object or JSON/YAML string (max. 2 MB). External $ref values are rejected.
include_style_rulesbooleanNoAlso report warnings, info and hints (style and best-practice rules).
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "document"
  ],
  "properties": {
    "document": {
      "description": "The AsyncAPI document as a JSON object or JSON/YAML string (max. 2 MB). External $ref values are rejected.",
      "anyOf": [
        {
          "type": "object"
        },
        {
          "type": "string",
          "minLength": 2,
          "maxLength": 2000000
        }
      ]
    },
    "include_style_rules": {
      "type": "boolean",
      "default": true,
      "description": "Also report warnings, info and hints (style and best-practice rules)."
    }
  }
}

Open original schema

Published input example

{
  "document": "asyncapi: 3.0.0\ninfo: {title: Orders, version: 1.0.0}\nchannels:\n  orders:\n    address: orders\n    messages:\n      created: {payload: {type: object}}\noperations:\n  onOrder:\n    action: receive\n    channel: {$ref: \"#/channels/orders\"}\n",
  "include_style_rules": false
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.

More endpoints in this hub

All endpoints in this hub โ†’