mirror of
https://github.com/m1k1o/neko.git
synced 2025-05-30 01:17:13 +02:00
add API reference.
This commit is contained in:
parent
a7287dca25
commit
5886d946b2
75 changed files with 9361 additions and 253 deletions
63
webpage/docs/api/keyboard-map-get.api.mdx
Normal file
63
webpage/docs/api/keyboard-map-get.api.mdx
Normal file
|
@ -0,0 +1,63 @@
|
|||
---
|
||||
id: keyboard-map-get
|
||||
title: "Get Keyboard Map"
|
||||
description: "Retrieve the current keyboard map configuration."
|
||||
sidebar_label: "Get Keyboard Map"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzVV91v2zYQ/1cOLFBsgix76fbit8z12iBNOsTu+pAEw5k6S6wpUiEpp57h/304SvJHmm7FsJc+6YPHu9/9eF/cioCFF+Nb4aytBivaLCy6XNynIicvnaqDskaMxQ0Fp2hNEEoC2ThHJkAvDhXWIK1ZqqJxyDsykQpbU/txkYux6GWvsH5DQaTCka+t8eTFeCvORiN+nNq8PFbvOgA5+EZK8n7ZaL1hO9KaQCbwfqxrrWQ0OvzkWclWeFlShfwWNjWJsbCLTyQZQe0YYlAtBI0b24QjOR+cMoVIBX3Gqtbx10o8JWZe0oGHVkcmdqlYo1No/kXfwyO5sPlnnZ2iTOx2qQgqxI2XBzbFbscrP49++pJBVuTooSEf4lM58tB4coBNKMmEjqz/kcaKvMeCnvP7FNtrCqg05UDOWQfdvlM3p7x01Wns/Xz1vJ+e3JocNCYn54O1eQzVzvsUFg1TsGw8eQg2+m+d+otAhe/I+1+ey5MPBhea2KuCTpPyu/Fsl4qKQmm5UhSxPNQYSjEWQ6zVkGvTsPdrWGEtUtEeN5eup3S8sxJ1Fw4iFY3TYizKEOrxcKh5rbQ+jF+NRiOxu2dFsnEqbKKmXwkdufOGbd/e79KtmFi7UnT8Z25XZPY/jjTMmMqWreNde8KwVpfE2a4YpowiIhUGK169nl6+/3M2nc0u3l9/Qer5SbpC45UpAMGT9/zd6op159iDvWX2njmLAMVYLKLQt1ppVUJgv6ONIwa+4txDQ25z8C1u/VZzURhq9J5yQA8IURvU6LCiQK6NJWWWNtrvYuqaVhbOf78QqeDAaE28ykbZ6AvDUTRWgo+0uJlPAE3OrzMrVxRgQV7l5OFmOpuzRs6s2tm1yrmeoB4EVRHwpwUfHGGlTJGCMoEcyqDWBNJqjQvb9r806ndU2UCQk18FW8OyMZIXUauwye7MnXnx4gVMrCOYkyyN1bZQ5HlhAEnyR7Q2662B5VrXok+SOwMwgOiVpjU5LMhDkvTLsLTuADwFbR8HGgMZuUmhVEU5eGgijM4nRotNro68y1oT+47MIpVtPAGtyQQP6AiCQ+MrFQLlLT4uwB4r6mmW1hiKXkdInrDS5P2BOWuy3uEbxjtnomeqYJY4NkwOE1tVjeljpqehPbmeieh6/wtUbHl5a/KgTJke1g+UFVm6TybyARda+bIiE1K4mExBoslVjoGAPssSTUE/ZgCtsXfxvEsMBw1NzbK+PfdD3Yp8LVHrBcpVZKxEk+uerT3mAwd9ADL06ZrcJpQMfao9HXx9kkYvYdbBuEKDBbEXSQIDmHGZoufaf8TZg4+Y+Mh7B5PkxtoqynzgvU/UThxhiAlQ2VwtN/GVhbnxOKsj2a3ROLdxNnFB90cGXndJMWm3+Kj4PP/UeNYMXjoiczph+hQqBsLrq6+FZdYbmG18oAreEupQwku44mlStna60TYaasXKVkyWJFc+Kt3PsqhBGa+KMrT427R9ax/hIsC51vDRupWHuS0olORY4KfsOBfbI/dQUa7wkGDxiJPkSXlJuzxkCDkGTJLszpxlTwKcjG94sENIkppLnw8xchcqV466KpMkT9PvqAwcZ2Dr16vsKP6SpK9/XFaWytCgcKgM7Q85SdoYPjrnrupx6JxeDZiT33gy4FqXx2nBpzybxR4TiwbP9jHwcysbjrR+p0iFVpKMj4NI113Oa5QlwVms9Cft/vHxMcO4mllXDLutfvjuYjK9nk0HZ9koK0OlY0OprQ8VmiPFbygcSt5VHDtOGsn2MFz9lwtS1zkDfQ7DWqMy3Fsj/m03/txyW+W7krWVSPd3KJEKHoLuU8GjDItttwv09MHp3Y5/t+13fHvf3UMW3CF5ehElYU4uzjor2jB5UlLNA9caddM28idDIo84++HszXQudru/AfEi76g=
|
||||
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={"Get Keyboard Map"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/api/room/keyboard/map"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Retrieve the current keyboard map configuration.
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Keyboard map retrieved successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"layout":{"type":"string","example":"sk","description":"The keyboard layout."},"variant":{"type":"string","example":"qwerty","description":"The keyboard variant."}},"title":"KeyboardMap"}}}},"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"}}}},"500":{"description":"Unable to get keyboard map.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}}}}
|
||||
>
|
||||
|
||||
</StatusCodes>
|
||||
|
||||
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue