mirror of
https://github.com/weechat/weechat.git
synced 2026-06-27 05:16:38 +02:00
doc/api: note that colors param is supported nicks endpoint
This commit is contained in:
committed by
Sébastien Helleu
parent
3200a05c00
commit
905a68739e
@@ -1034,6 +1034,13 @@ Path parameters:
|
||||
confused with the buffer number, which is different)
|
||||
* `buffer_name` (string, **required**): buffer name
|
||||
|
||||
Query parameters:
|
||||
|
||||
* `colors` (string, optional, default: `ansi`): how to return strings with color codes:
|
||||
** `ansi`: return ANSI color codes
|
||||
** `weechat`: return WeeChat internal color codes
|
||||
** `strip`: strip colors
|
||||
|
||||
Request example: get nicks of a buffer:
|
||||
|
||||
[source,shell]
|
||||
|
||||
@@ -1046,6 +1046,14 @@ Paramètres de chemin :
|
||||
confondre avec le numéro du tampon, qui est différent)
|
||||
* `buffer_name` (chaîne, **obligatoire**) : nom du tampon
|
||||
|
||||
Paramètres de requête :
|
||||
|
||||
* `colors` (chaîne, facultatif, par défaut : `ansi`) : comment les chaînes avec
|
||||
des couleurs sont retournées :
|
||||
** `ansi` : retourner les codes couleur ANSI
|
||||
** `weechat` : retourner les codes couleur internes WeeChat
|
||||
** `strip` : supprimer les couleurs
|
||||
|
||||
Exemple de requête : obtenir les pseudos d'un tampon :
|
||||
|
||||
[source,shell]
|
||||
|
||||
@@ -1030,12 +1030,19 @@ GET /api/buffers/{id_бафера}/nicks
|
||||
GET /api/buffers/{име_бафера}/nicks
|
||||
----
|
||||
|
||||
Параметри упита:
|
||||
Параметри путање:
|
||||
|
||||
* `id_бафера` (цео број, **обавезно**): јединствени идентификатор бафера (не треба
|
||||
да се помеша са бројем бафера, то је нешто друго)
|
||||
* `име_бафера` (стринг, **обавезно**): име бафера
|
||||
|
||||
Параметри упита:
|
||||
|
||||
* `colors` (стринг, није обавезно, подразумевано: `ansi`): како се враћају стрингови са кодовима боје:
|
||||
** `ansi`: враћају се ANSI кодови боје
|
||||
** `weechat`: враћају се WeeChat интерни кодови боје
|
||||
** `strip`: уклањају се боје
|
||||
|
||||
Пример захтева: врати надимке бафера:
|
||||
|
||||
[source,shell]
|
||||
|
||||
Reference in New Issue
Block a user