1
0
mirror of https://github.com/weechat/weechat.git synced 2026-06-12 14:14:48 +02:00

doc/relay/api: add doc on resource /api/completion

This commit is contained in:
Sébastien Helleu
2025-01-05 15:03:35 +01:00
parent c6c420c698
commit 3523b5e4e2
2 changed files with 104 additions and 0 deletions
+52
View File
@@ -1220,6 +1220,58 @@ Response:
HTTP/1.1 204 No content
----
[[resource_completion]]
=== Completion
Complete user command or text in a buffer.
Endpoint:
----
POST /api/completion
----
Body parameters:
* `buffer_id` (integer, optional): buffer unique identifier (not to be confused
with the buffer number, which is different)
* `buffer_name` (string, optional, default: `core.weechat`): buffer name
* `command` (string, **required**): command or text to complete
* `position` (integer, optional, default: end of string): position in command
(first position is 0)
Request example: complete command `/qu` on channel #weechat:
[source,shell]
----
curl -L -u 'plain:secret_password' -X POST \
-d '{"buffer_name": "irc.libera.#weechat", "command": "/qu"}' \
'https://localhost:9000/api/completion'
----
Response:
[source,http]
----
HTTP/1.1 200 OK
----
[source,json]
----
{
"context": "command",
"base_word": "qu",
"position_replace": 1,
"add_space": true,
"list": [
"query",
"quiet",
"quit",
"quote"
]
}
----
[[resource_ping]]
=== Ping
+52
View File
@@ -1232,6 +1232,58 @@ Réponse :
HTTP/1.1 204 No content
----
[[resource_completion]]
=== Complétion
Compléter une commande ou du texte de l'utilisateur sur un tampon.
Point de terminaison :
----
POST /api/completion
----
Paramètres du corps :
* `buffer_id` (entier, facultatif) : identifiant unique du tampon (à ne pas
confondre avec le numéro du tampon, qui est différent)
* `buffer_name` (chaîne, facultatif, par défaut: `core.weechat`) : nom de tampon
* `command` (chaîne, **obligatoire**) : commande ou texte à compléter
* `position` (entier, facultatif, par défaut: fin de la chaîne): position
dans la commande (la première position est 0)
Exemple de requête : compléter la commande `/qu` sur le canal #weechat :
[source,shell]
----
curl -L -u 'plain:secret_password' -X POST \
-d '{"buffer_name": "irc.libera.#weechat", "command": "/qu"}' \
'https://localhost:9000/api/completion'
----
Réponse :
[source,http]
----
HTTP/1.1 200 OK
----
[source,json]
----
{
"context": "command",
"base_word": "qu",
"position_replace": 1,
"add_space": true,
"list": [
"query",
"quiet",
"quit",
"quote"
]
}
----
[[resource_ping]]
=== Ping