Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[📑 Docs]: Adapt message validation guide for v3 #1865

Closed
jonaslagoni opened this issue Jun 28, 2023 · 2 comments
Closed

[📑 Docs]: Adapt message validation guide for v3 #1865

jonaslagoni opened this issue Jun 28, 2023 · 2 comments
Assignees
Labels
area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 📑 docs good first issue Good for newcomers

Comments

@jonaslagoni
Copy link
Member

For AsyncAPI v3, we need to adapt the message validation guide (https://www.asyncapi.com/docs/guides/message-validation) to be usable with AsyncAPI v3.

Here are the v3 structure that should be used instead:

asyncapi: 3.0.0
info:
  title: Example with Avro
  version: 0.1.0

channels:
  example:
    address: 'example'
    messages:
      avroMessage:
        payload:
          schemaFormat: 'application/vnd.apache.avro;version=1.9.0'
          schema:
            $ref: 'https://example.europe-west3.gcp.confluent.cloud/subjects/test/versions/1/schema'

Here are the main points that need to change:

  • Re-add the docs/guides/message-validation.md file.
  • Adapt the AsyncAPI document snippet
  • Adapt the text if needed

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.

@quetzalliwrites quetzalliwrites added good first issue Good for newcomers 📑 docs area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. labels Jun 29, 2023
@alaminthetrustworthy
Copy link
Contributor

@alequetzalli Am new but can i join the assignee work together

@derberg
Copy link
Member

derberg commented Nov 13, 2023

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

@derberg derberg closed this as completed Nov 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 📑 docs good first issue Good for newcomers
Projects
Status: Changes proposed 📄
Development

No branches or pull requests

4 participants