[📑 Docs]: Adapt Create AsyncAPI document tutorial for v3

[jonaslagoni]

For AsyncAPI v3, we need to adapt the AsyncAPI Documents tutorial (https://www.asyncapi.com/docs/tutorials/create-asyncapi-document) to be usable with AsyncAPI v3.

Here are the v3 structure that should be used instead:

asyncapi: 3.0.0
info:
  title: Streetlights API
  version: '1.0.0'
  description: |
    The Smartylighting Streetlights API allows you
    to remotely manage the city lights.
  license:
    name: Apache 2.0
    url: 'https://www.apache.org/licenses/LICENSE-2.0'

servers:
  mosquitto:
    host: test.mosquitto.org
    protocol: mqtt

channels:
  lightMeasured:
    address: 'light/measured'
    messages:
      lightMeasuredMessage:
        name: LightMeasured
        payload:
          type: object
          properties:
            id:
              type: integer
              minimum: 0
              description: Id of the streetlight.
            lumens:
              type: integer
              minimum: 0
              description: Light intensity measured in lumens.
            sentAt:
              type: string
              format: date-time
              description: Date and time when the message was sent.

operations:
  onLightMeasured:
    action: 'receive'
    summary: Inform about environmental lighting conditions for a particular streetlight.
    operationId: onLightMeasured
    channel:
      $ref: '#/channels/lightMeasured'

Here are the main points that need to change:

• Re-add the docs/tutorials/create-asyncapi-document.md file.
• Adapt the AsyncAPI document snippet
• Adapt the text to match v3 descriptions

Make sure you base your change on the next-major-spec branch and target it in your PR 🙂 If you have any questions, don't hesitate to ask.

[functionguyy]

@jonaslagoni I'm interested in taking up this task. If no one is assigned to it, can it be assigned to me?

[quetzalliwrites]

Go for it, @functionguyy! I sent you more instructions in a Slack DM. ✌🏽

[functionguyy]

Okay, working on it

[functionguyy]

Hello @jonaslagoni @alequetzalli I just wanted to ask if there is a typo in the operation section for the code block because I have read through the spec v3 doc and can't seem to find anything for the operationId field.

[jonaslagoni]

Yep, you right @functionguyy 🙂

[functionguyy]

@jonaslagoni Please how do I base my change on the next-major-spec branch for my pull request?

[functionguyy]

@jonaslagoni @alequetzalli kindly help review my pull request. Thank you.

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

[AnimeshKumar923]

resolved with #2304
@jonaslagoni or @alequetzalli Please close this issue. Don't know why didn't this closed automatically 🤔

[derberg]

solved with #2304
in next major branch, but considered to be fixed and closing - also for easier management of the scope for v3