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 frontpage animation for v3 #1853

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

[📑 Docs]: Adapt frontpage animation for v3 #1853

jonaslagoni opened this issue Jun 28, 2023 · 2 comments
Assignees
Labels
good first issue Good for newcomers

Comments

@jonaslagoni
Copy link
Member

jonaslagoni commented Jun 28, 2023

For AsyncAPI v3, we need to adapt the frontpage animation (components/DemoAnimation.js) to use AsyncAPI v3 structure instead of v2.

Here are the v3 structure that should be used instead:

asyncapi: 3.0.0
info:
  title: Account Service
  version: 1.0.0
  description: This service is in charge of processing user signups :rocket:
channels:
  userSignedup:
    address: 'user/signedup'
    messages:
      userSignedupMessage:
        $ref: '#/components/messages/UserSignedUp'

operations:
  processUserSignups:
    action: 'receive'
    channel:
        $ref: '#/channels/userSignedup'

components:
  messages:
    UserSignedUp:
      payload:
        type: object
        properties:
          displayName:
            type: string
            description: Name of the user
          email:
            type: string
            format: email
            description: Email of the user

Here is the list of things that need to be adapted:

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
@quetzalliwrites quetzalliwrites moved this to Changes proposed 📄 ✨✨ in AsyncAPI Docs Board Jun 29, 2023
@afzal442
Copy link
Contributor

Hi there, I want to give it a shot. 📃
/assign

@quetzalliwrites quetzalliwrites removed 📑 docs area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. labels Aug 31, 2023
@derberg
Copy link
Member

derberg commented Nov 8, 2023

already in v3.asyncapi.com

@derberg derberg closed this as completed Nov 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
Status: Changes proposed 📄
Development

Successfully merging a pull request may close this issue.

4 participants