25
1
mirror of https://github.com/processone/ejabberd.git synced 2024-11-24 16:23:40 +01:00

Annotate version when the commands v1 are available

This commit is contained in:
Badlop 2024-01-04 22:00:28 +01:00
parent 65d585496c
commit 78750bf753
3 changed files with 7 additions and 1 deletions

View File

@ -95,6 +95,7 @@ get_commands_spec() ->
desc = "Issue an [OAuth](https://docs.ejabberd.im/developer/ejabberd-api/oauth/) token for the given jid",
module = ?MODULE, function = oauth_issue_token,
version = 1,
note = "updated in 24.01",
args = [{jid, string}, {ttl, integer}, {scopes, {list, {scope, binary}}}],
policy = restricted,
args_example = ["user@server.com", 3600, ["connected_users_number", "muc_online_rooms"]],

View File

@ -428,6 +428,7 @@ get_commands_spec() ->
desc = "Set presence of a session",
module = ?MODULE, function = set_presence,
version = 1,
note = "updated in 24.01",
args = [{user, binary}, {host, binary},
{resource, binary}, {type, binary},
{show, binary}, {status, binary},
@ -515,6 +516,7 @@ get_commands_spec() ->
desc = "Add an item to a user's roster (supports ODBC)",
module = ?MODULE, function = add_rosteritem,
version = 1,
note = "updated in 24.01",
args = [{localuser, binary}, {localhost, binary},
{user, binary}, {host, binary},
{nick, binary}, {groups, {list, {group, binary}}},
@ -715,6 +717,7 @@ get_commands_spec() ->
desc = "Create a Shared Roster Group",
module = ?MODULE, function = srg_create,
version = 1,
note = "updated in 24.01",
args = [{group, binary}, {host, binary},
{label, binary}, {description, binary}, {display, {list, {group, binary}}}],
args_rename = [{name, label}],

View File

@ -316,6 +316,7 @@ get_commands_spec() ->
"`password` and `message` can be set to `none`.",
module = ?MODULE, function = send_direct_invitation,
version = 1,
note = "updated in 24.01",
args_desc = ["Room name", "MUC service", "Password, or `none`",
"Reason text, or `none`", "List of users JIDs"],
args_example = [<<"room1">>, <<"muc.example.com">>,
@ -364,6 +365,7 @@ get_commands_spec() ->
desc = "Subscribe to a MUC conference",
module = ?MODULE, function = subscribe_room,
version = 1,
note = "updated in 24.01",
args_desc = ["User JID", "a user's nick",
"the room to subscribe", "list of nodes"],
args_example = ["tom@localhost", "Tom", "room1@conference.localhost",
@ -399,12 +401,12 @@ get_commands_spec() ->
result = {res, rescode}},
#ejabberd_commands{name = subscribe_room_many, tags = [muc_room, muc_sub],
desc = "Subscribe several users to a MUC conference",
note = "added in 22.05",
longdesc = "This command accepts up to 50 users at once "
"(this is configurable with the *`mod_muc_admin`* option "
"`subscribe_room_many_max_users`)",
module = ?MODULE, function = subscribe_room_many,
version = 1,
note = "updated in 24.01",
args_desc = ["Users JIDs and nicks",
"the room to subscribe",
"nodes separated by commas: `,`"],