3pp-mirror/neko
1
0
Fork 0
mirror of https://github.com/m1k1o/neko.git synced 2025-05-30 09:27:10 +02:00
Code Issues Projects Releases Packages Wiki Activity

add API reference.

Browse source
This commit is contained in:
Miroslav Šedivý 2025-02-18 22:44:48 +01:00
parent a7287dca25
commit 5886d946b2
75 changed files with 9361 additions and 253 deletions
Download patch file Download diff file Expand all files Collapse all files

71
webpage/docs/api/members-list.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: members-list
title: "List Members"
description: "Retrieve a list of all members."
sidebar_label: "List Members"
hide_title: true
hide_table_of_contents: true
api: eJzVWF1z27YS/Ss7yEznlkPTbtInvfk6uq0ncZqx3NsHJ+NZkSsSEQgwWNCO6tF/7yxASrTsdDz1U/UiiVics7vYL/BeBaxZza5VS+2SPKvPuaqIS6+7oJ1VM3VJwWu6JUAwmgO4FaAxMMgXKleuI48ifV6p2Qj0XnNQuerQY0tBkGfX90oL4tee/EblymJLaqaMbrWIctlQi2p2r8KmkwXbC5LabvOnN7rViunvd37OlSfunGViWX99ciJfDy28SBqDHyytgPuyJOZVb8xGLCydDWSDbMWuM7qM5h5/Ydl//5gfvUdRVAdqefLcLb9QGd3ixWlBJ610NZHh4LWt1eExXDUEvdVfewJdkQ16pcnLYYSGhsMo1DYir7QhAfx29MTh/r0mybPP0UUkn6DXfINVq+0EZOmcIbSPUM5tJY4kBj2FAc2AFiJKhCzR3hhXvwizRAvG1TCBLJ214oKXgQ4oO9Q7DGXzQsyIsUNsHL9USYHY4XGDnm5aqjS+EDYiQUTaoWNMnJvS6G7p0FcvpEhw8ekOMnIx2YpvtMUy6Fu6KXvPzr+ALOLBiAcJb+8zokMufqnziA7pOCWw6Wttn6waWFVaoNF8nGRt8D0dMp/uJCHhAVMI2tbCsc1V0EFqxFD6Pg4146k8H+oJaLtyvo1171HaPwJ8iwHVVj65+vnkp8clV5A9fe2JQ/zWnhh6Jg/Yh0bKWyqx/6T4fqe0tcSM9TOq21sKqA1VQN47D8O+h2bOZeliQBztfPO0nUz+ljz0tiLPwbkqOm+wPodlLy5Y9UwMwUX7ndd/Eujwr7F+m6uWQuOk/9eU+n5o1EwdY6ePx+4jWSuuSKPAQ9r3rkQzuErlqvdGzVQTQjc7PjayJjVs9ubk5ERJU2cqe6/DJiL9l9CTP+2F8fqzTAtnzq01TZ9cuTXZ3YMJwkIcmHw03bVv5Z1+R7GXi5plFNmPIB/m7367WcwXi/PfPjxy5emDUIaeta0BgYlZ/iesmPNTC3bMYv043MQqE4Wey5IgIYjdkWPige8YdzBexa3PpYvC0CEzVYAMCBENdvNfiiCpIpF/iKQPtHZw+vFc5UoCI1G8KU6Kk0fEUTRmyR+0vLw6A7SV/Fy4ck0BlsS6IobL+eJKECWXOu9udSW5huYo6JZA/jrg4AlbbesctA3kxyrsjMGlS7NsHvE9tS4QVMTr4DpY9bZMZVWHTfHJfrKvXr2CM+cJrqhsrJM5hVgWjiDL/h/ZFiMbOKkDSfss+2QBjiBaZeiWPNbEkGXjMqyc3yueg3F3RwYD2XKTQ6Pr5uhrH9UYbBJtsa/0xLoiUbyjTeybUaR1PRPQLdnAIO07eLTc6hCoSvpJcWIZ7gY3DxOOHLaoxIStkZ6885yzxWjwpeh7JY5e6Fq8JLFhKzhzbdvbMWZGN6STGz0RTR8fyRDYSyhFyj2YtqNa/6GiLvJdMhEHXBrNTUs25HB+NpcuW+kKAwF9Kxu0Nf1YACSy9/G8Gwx7hL4TWU7nvh58dpz8tUJjlliuo8catJUZvbXTee+DMQBF9fkt+U1oRPW5YdrbepBGP8BiUOMCLdYkVmQZHMFCyhQ91RqjnqPyUSc58tHALLt0ro0yv8veA9gzTxhiArSu0qtN/CnC0m68M9HZiXSYwBx451qeELwdkuIsbeEIfFp96VmQgUtPFAfkla77lFScQyuKyPr6e2FZjASLDQdq4VdCExr4AS7kflYmnuFWGomSWJPEyobKNUfQ3b0UDWjLum5C0j+l7a/uDs4DnBoDfzi/ZrhyNYWGvAj8VExzMR05p1l3n2DxiLPsoLzkQx6KChUGzLLik31dHAQ4We5l6EHIsk5KH4cYuUtdaU9Dlcmyw/SblIFpBia73hST+Muysf5JWVlpS0e1R21pd8hZlmJ4cs5D1ZPQeXBwMbr/J/OA1Loqzgicy9wSe0wsGnJbjoFfubKXSBt3qlwZXZJl2l8x1WmHZUPwOlb6B+3+7u6uwLhaOF8fD1v5+P352fzDYn70ujgpmtCa2FA6x6FFOwGWFw9wsRs5HjSR+/049Yz3GkOTDPQtHHcGtZU2GlW9H+aba+mgKp/er9N17Vrd3y+R6Xdvtlt5nHprnHs049JQpWYrNEy5WtNm8hbkFk0vrEqmlu/I7l587IU/yx+vRTqNPKohrMhHyrTrtCypm+56NE8Kym6O+2V+pbbbvwAlsEqX
sidebar_class_name: "get api-method"
info_path: docs/api/neko-api
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"List Members"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/api/members"}
context={"endpoint"}
>
</MethodEndpoint>
Retrieve a list of all members.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"in":"query","name":"limit","schema":{"type":"number"}},{"in":"query","name":"offset","schema":{"type":"number"}}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Members retrieved successfully.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the member."},"profile":{"x-tags":["members"],"type":"object","properties":{"name":{"type":"string","description":"The name of the member."},"is_admin":{"type":"boolean","description":"Indicates if the member is an admin."},"can_login":{"type":"boolean","description":"Indicates if the member can log in."},"can_connect":{"type":"boolean","description":"Indicates if the member can connect."},"can_watch":{"type":"boolean","description":"Indicates if the member can watch."},"can_host":{"type":"boolean","description":"Indicates if the member can host."},"can_share_media":{"type":"boolean","description":"Indicates if the member can share media."},"can_access_clipboard":{"type":"boolean","description":"Indicates if the member can access the clipboard."},"sends_inactive_cursor":{"type":"boolean","description":"Indicates if the member sends inactive cursor."},"can_see_inactive_cursors":{"type":"boolean","description":"Indicates if the member can see inactive cursors."},"plugins":{"type":"object","additionalProperties":true,"description":"Additional plugin settings."}},"title":"MemberProfile","description":"The profile information of the member."}},"title":"MemberData"}}}}},"401":{"description":"The request requires user authentication.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}},"403":{"description":"The server understood the request, but refuses to authorize it.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}}}}
>
</StatusCodes>