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 Bug 🐞 report]: Fix typos in add-server.md #3170

Closed
1 task done
mscriven opened this issue Aug 28, 2024 · 2 comments · Fixed by #3171
Closed
1 task done

[Docs Bug 🐞 report]: Fix typos in add-server.md #3170

mscriven opened this issue Aug 28, 2024 · 2 comments · Fixed by #3171

Comments

@mscriven
Copy link
Contributor

Describe the bug you found in AsyncAPI Docs.

There's a couple of typos in the Server reusability page.

The code reads:

servers:
  kafka-test:
    $ref: '#/components/servers/kafka-test
  mqtt-test:
    $ref: '#/components/servers/mqtt-test
components
  servers:
    kafka-test:
      host: my.kafka.pl
      protocol: kafka-secure
      description: Test Kafka server
    mqtt-test:
      host: test.mosquitto.org
      protocol: mqtt
      description: Test MQTT server

but it should be:

servers:
  kafka-test:
    $ref: '#/components/servers/kafka-test'
  mqtt-test:
    $ref: '#/components/servers/mqtt-test'
components:
  servers:
    kafka-test:
      host: my.kafka.pl
      protocol: kafka-secure
      description: Test Kafka server
    mqtt-test:
      host: test.mosquitto.org
      protocol: mqtt
      description: Test MQTT server

Attach any resources that can help us understand the issue.

Code is at URL: add-server#server-reusability

Image of the rendered typos:

image

Code of Conduct

  • I agree to follow this project's Code of Conduct
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.

@mscriven
Copy link
Contributor Author

Spotted while working locally, fixed and submitted a PR: #3171

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant