processone / ejabberd

Robust, Ubiquitous and Massively Scalable Messaging Platform (XMPP, MQTT, SIP Server)
https://www.process-one.net/en/ejabberd/
Other
6.01k stars 1.5k forks source link

Typo error in api reference affiliations #4080

Closed arthurchumak closed 11 months ago

arthurchumak commented 11 months ago

Bug description

https://docs.ejabberd.im/developer/ejabberd-api/admin-api/#create-room-with-opts

method create_room_with_opts has error in description

To set affilitions string value must have format 'Type:JID,Type:JID' for example 'owner:bob@example.com,member:peter@example.com'. Subscribers can be define with string

should be affiliations

also move please Subscribers to new line, to make it more readable

badlop commented 11 months ago

Thanks! I've fixed the typo. I found no way to add newlines to the long command description, so i rewrote that paragraph and moved the examples to the examples section https://docs.ejabberd.im/developer/ejabberd-api/admin-api/#create-room-with-opts