asyncapi/bindings

[๐Ÿ“‘ Docs]: Readme.md, section MQTT bindings / Server Binding Object

Closed this issue ยท 7 comments

vhe1 commented

What Dev Docs changes are you proposing?

I would like to suggest a clarification for the cleanSession field:
It should be made clear whether it means:

  • that the server (the entity providing the API) connects to the broker using cleanSession=true/false or
  • that the client (the entity using the api) MUST/SHOULD/MAY connect to the broker usign cleanSession = true/false

Code of Conduct

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

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.

AsyncAPI document should describe what user can do with it. So that the client (the entity using the api) MUST/SHOULD/MAY connect to the broker usign cleanSession = true/false

vhe1 commented

Ok, but the client can do that anyway. Why would it need to be specified at all then?

AsyncAPI documents are source not only for docs but code generation too.

vhe1 commented

Oh - right.

@vhe1 can this be closed then?

vhe1 commented

Yes.