bindings icon indicating copy to clipboard operation
bindings copied to clipboard

[Docs Bug 🐞 report]: JMS Server Binding Example doesn't match AsyncAPI v3 specification

Open ctasada opened this issue 2 years ago • 3 comments

Describe the bug you found in AsyncAPI Docs.

The https://github.com/asyncapi/bindings/blob/master/jms/README.md#examples shows

servers:
  production:
    url: jms://my-activemq-broker:61616
    protocol: jms
    protocolVersion: '1.1'
    description: The production ActiveMQ broker accessed via JMS.

If this object is related with https://github.com/asyncapi/bindings/blob/master/jms/README.md#server-object then the description field shouldn't be included (or it's missing from the Server Object definition) Also, the url field doesn't exist anymore in https://www.asyncapi.com/docs/reference/specification/v3.0.0#serverObject being replaced by the hosts field.

Also, the https://github.com/asyncapi/bindings/blob/master/jms/README.md#server-binding-object points to a Schema Array which doesn't exist anymore. Based in the example it probably should refer to a generic Map[string, string] but I may be wrong there.

Attach any resources that can help us understand the issue.

See https://github.com/asyncapi/bindings/blob/master/jms/README.md#examples

The format of https://github.com/asyncapi/bindings/blob/master/jms/README.md#examples-2 also seems broken compared with the provided documentation

Code of Conduct

  • [X] I agree to follow this project's Code of Conduct

ctasada avatar Dec 14 '23 14:12 ctasada

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.

github-actions[bot] avatar Dec 14 '23 14:12 github-actions[bot]

@rcoppen @SrfHead please have a look folks

derberg avatar Dec 14 '23 15:12 derberg

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

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 :heart:

github-actions[bot] avatar Apr 13 '24 00:04 github-actions[bot]