@asyncapi/specs/examples/2.6.0/message.json

AsyncAPI schema versions

[
    {
      "messageId": "userSignup",
      "name": "UserSignup",
      "title": "User signup",
      "summary": "Action to sign a user up.",
      "description": "A longer description",
      "contentType": "application/json",
      "tags": [
        { "name": "user" },
        { "name": "signup" },
        { "name": "register" }
      ],
      "headers": {
        "type": "object",
        "properties": {
          "correlationId": {
            "description": "Correlation ID set by application",
            "type": "string"
          },
          "applicationInstanceId": {
            "description": "Unique identifier for a given instance of the publishing application",
            "type": "string"
          }
        }
      },
      "payload": {
        "type": "object",
        "properties": {
          "user": {
            "$ref": "#/components/schemas/userCreate"
          },
          "signup": {
            "$ref": "#/components/schemas/signup"
          }
        }
      },
      "correlationId": {
        "description": "Default Correlation ID",
        "location": "$message.header#/correlationId"
      },
      "traits": [{ "$ref": "#/components/messageTraits/commonHeaders" }],
      "examples": [
        {
          "name": "SimpleSignup",
          "summary": "A simple UserSignup example message",
          "headers": {
            "correlationId": "my-correlation-id",
            "applicationInstanceId": "myInstanceId"
          },
          "payload": {
            "user": {
              "someUserKey": "someUserValue"
            },
            "signup": {
              "someSignupKey": "someSignupValue"
            }
          }
        }
      ]
    },
    {
      "messageId": "userSignup",
      "name": "UserSignup",
      "title": "User signup",
      "summary": "Action to sign a user up.",
      "description": "A longer description",
      "tags": [
        { "name": "user" },
        { "name": "signup" },
        { "name": "register" }
      ],
      "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0",
      "payload": {
        "$ref": "path/to/user-create.avsc#/UserCreate"
      }
    }
]