Describing an array of JSON objects

[jayzym]

Hello, I am not sure if I am doing something wrong or if this is a bug. I am trying to describe the payload of an MQTT topic, it should be an array of objects. Below is a stripped down version of my asyncapi document. The payload section and example payload do not render properly in https://studio.asyncapi.com/ or in the asyncapi-preview vscode extension. Am I doing something wrong?

asyncapi: 3.0.0
info:
  title: test
  version: 0.0.1
  description: >-
    test
defaultContentType: application/json
servers:
  production:
    host: s.com
    protocol: mqtt
    variables:
      port:
        description: S
        default: '1883'
        enum:
          - '1883'
          - '8883'
channels:
  'site/{site_id}/messages':
    address: 'site/{site_id}/messages'
    messages:
      subscribe.message:
        $ref: '#/components/messages/testmessages'
    parameters:
      site_id:
        $ref: '#/components/parameters/site_id'
    
operations:
  'site/{site_id}/messages':
    action: send
    channel:
      $ref: '#/channels/site~1{site_id}~1messages'
    messages:
      - $ref: >-
          #/channels/site~1{site_id}~1messages/messages/subscribe.message


components:
  schemas:
    Message:
      type: object
      payload:
        properties:
          timestamp:
            type: string
          market:
            type: string
          network-type:
            type: string
          message:
            type: string
          
  messages:
    testmessages:
      payload:
        type: array
        items:
          $ref: '#/components/schemas/Message'
            
          
  parameters:
    site_id:
      description: >-
        ID of the site.
    username:
      description: 'Username'

[catosaurusrex2003]

Hey @jayzym , I found the issue 😀 .

the issue lies here

components:
  schemas:
    Message:
      type: object
      payload:                 👈
        properties:
          timestamp:
            type: string
          market:
            type: string
          network-type:
            type: string
          message:
            type: string

above ☝️ there is an extra nested payload which is causing the problem.

instead it should be like this 👇

components:
  schemas:
    Message:
      type: object
      properties:
        timestamp:
          type: string
        market:
          type: string
        network-type:
          type: string
        message:
          type: string

This is because you are writing the schema for the message. not the message itself.
While declaring the message ( in #/components/messages/testmessages ) you have already defined the payload so defining it again in schema makes it twice which is incorrect.

I hope i am able to explain it 😁

below 👇 is the final document after the correction

asyncapi: 3.0.0
info:
  title: test
  version: 0.0.1
  description: >-
    test
defaultContentType: application/json
servers:
  production:
    host: s.com
    protocol: mqtt
    variables:
      port:
        description: S
        default: '1883'
        enum:
          - '1883'
          - '8883'
channels:
  'site/{site_id}/messages':
    address: 'site/{site_id}/messages'
    messages:
      subscribe.message:
        $ref: '#/components/messages/testmessages'
    parameters:
      site_id:
        $ref: '#/components/parameters/site_id'
    
operations:
  'site/{site_id}/messages':
    action: send
    channel:
      $ref: '#/channels/site~1{site_id}~1messages'
    messages:
      - $ref: >-
          #/channels/site~1{site_id}~1messages/messages/subscribe.message


components:
  schemas:
    Message:
      type: object
      properties:
        timestamp:
          type: string
        market:
          type: string
        network-type:
          type: string
        message:
          type: string
          
  messages:
    testmessages:
      payload:
        type: array
        items:
          $ref: '#/components/schemas/Message'
            
          
  parameters:
    site_id:
      description: >-
        ID of the site.
    username:
      description: 'Username'

[catosaurusrex2003]

source: https://www.asyncapi.com/docs/reference/specification/v3.0.0-explorer

[jayzym]

Thank you @catosaurusrex2003! I thought I was going crazy.