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.

Sign up for GitHub

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

Jump to bottom

[Docs Bug 🐞 report]: Websocket Tutorial Example Code Wrong Indentation #3418

Open
1 task done
ramyhardan opened this issue Nov 20, 2024 · 4 comments · May be fixed by #3420
Open
1 task done

[Docs Bug 🐞 report]: Websocket Tutorial Example Code Wrong Indentation #3418

ramyhardan opened this issue Nov 20, 2024 · 4 comments · May be fixed by #3420
Labels
🐞 docs bug

Comments

@ramyhardan
Copy link

Describe the bug you found in AsyncAPI Docs.

The code snippet in Define messages and schemas has wrong indentation:

  1. reaction schema is a level too deep
  2. app_id's type needs to be a level deeper (line 22)

The complete code at the end of the tutorial is correct.

Attach any resources that can help us understand the issue.

https://www.asyncapi.com/docs/tutorials/websocket#define-messages-and-schemas

Code of Conduct

  • I agree to follow this project's Code of Conduct
@github-actions GitHub Actions
Copy link

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@hkv24
Copy link
Contributor

hkv24 commented Nov 20, 2024

@ramyhardan I fixed the 2nd point, am not able to understand what you are trying to say in the 1st point? Do you mean that we should keep 'reaction' above 'hello'?

@ramyhardan
Copy link
Author

Sorry for not being clear. The schema should contain hello and reaction types, but reaction has the same indentation as hello.type instead of hello:

components:
  #...
  schemas:
    hello:
      type: object
      #...
      reaction:
        type: object
        #...

@hkv24
Copy link
Contributor

hkv24 commented Nov 20, 2024

@ramyhardan ok got it, but the file where it's code is written (' pages/docs/tutorials/websocket/index.mdx '), is also mentioned in the .gitignore, then how should I proceed?

@bandantonio bandantonio linked a pull request Nov 21, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
🐞 docs bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(tutorials): fix indentation for slackbot with websocket doc bandantonio/website
2 participants
@ramyhardan @hkv24