mirror of
https://github.com/m1k1o/neko.git
synced 2025-06-06 21:04:11 +02:00
add API reference.
This commit is contained in:
parent
a7287dca25
commit
5886d946b2
75 changed files with 9361 additions and 253 deletions
71
webpage/docs/api/keyboard-map-set.api.mdx
Normal file
71
webpage/docs/api/keyboard-map-set.api.mdx
Normal file
|
@ -0,0 +1,71 @@
|
|||
---
|
||||
id: keyboard-map-set
|
||||
title: "Set Keyboard Map"
|
||||
description: "Update the keyboard map configuration."
|
||||
sidebar_label: "Set Keyboard Map"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzVV01v2zgQ/SsDFih2BVl20+7Ft9T1okGatIid7SEJFmNpLLGmSIWkknoD//fFkJKtJG23h700l8jicOa9+daD8Fg6Mb0S1ph6tKHtyqAtxE0qCnK5lY2XRoupuGwK9AS+IuiFoMYGcqPXsmwtslwmUmEaij9OCjEVvewZNgvyIhWWXGO0IyemD+Jo8ob/PbZ0OlTfBrMFuDbPybl1q9Q2E7tUvJm8en51WRFYum3J+fBfWnLQOrKAra9Ie5nvceZGe9KelWDTqO5k/MWxpgfh8opq5Ce/bUhMhVl9oZwZNJYpehkp1OQcljQQdN5KXYqnDnxHHqWiAshaY6G7l4ndLhVeesVX53x01mnc7XaB5+tv83Rk78hCqwuyzhtThNh07FNYteyCdevIgTeBv7HyHwLpfyH2f0wmz9lfalwpYlZ5hbp8nJC/DLkd10II1ltTbNnI/wRb4da0/luo6SvWTUDjNs9ILIeVHXWEQrtDK1H/h77be7J++2OdnaLHbjk99Aex94m0VIipty3tUlGTrwy3ksa4QBZ9JaZijI0cc88a9wbGNTYiFbEuuKU9zZsPJkfV1Y1IRWuVmIrK+2Y6His+q4zz09eTyUTsblhR3lrpt0HTW0JL9rhl21c3u/RBzIzZSBq+WZoN6f2LgYYFRy4GZ3hr71Bs5Cmx9yTDzIOISIXGmk/P56cf/17MF4uTj+fPPHz8qK9B66QuAcGRc/w76gpxHDLYW2b27LMAUEzFKgj9rJWoEjzzDjYGHvgOuduW7PbALVz9WXNBGBp0jgpABwhBGzRosSZPNqYW18vFobLmfZIeKiOm/z6x++zdMca1Cdi79DynjYHjTycsTtZFeK+zSTZ5BjqIhnb7mVYXyxmgLvhxYfINeViRkwU5uJgvlqyR21djzZ0suGmjGnlZE/BPA85bwlrqMgWpPVnMvbwjyI1SuDJxuqZBv6XaeIKC3MabBtatzvkQlfTb7Fpf6xcvXsDMWIIl5ZU2ypSSHB+MIEn+CtYWvTUwPFAi+iS51gAjCKwU3ZHFkhwkSX8Ma2MPwFNQ5n6k0JPOtylUsqxGt22A0XFitNgWcsAuiyb2855FatM6Aroj7R2gJfAWtaul5yUg4OMp57Cm3s250ZoC6wDJEdaKnDt4zuisJ3zBeJfs6IUs2UucV7qAmanrVvf51rshRq73RKDevwIZ9ooimjwok7qH9RtlZZbuC5Gcx5WSrqpJ+xROZnPIURcyLFX0NQ6y3zOAaOxDiHeF/qAhbkIuxv3Q84K/1qjUCvNN8FiFulC9t/aYDz7oE5Chz+/Ibn3F0OfK0YHrkxJ8CYsOxhlqLIlZJAmMYMEtjr61YwWcPfiAiUPeE0ySC2PqIHPJd5+onVlCHwqgNoVcb8MjC/OMtEYFZ0ejYS/kauJh4AYG3nVFMYtXXFB8XHxpHWsGl1si/Xh/dSnUDITPN99Ly6w3sNg6TzW8J1S+gpdwRt7KPNq54Ge6C4aiWBXF8oryjQtK95syKpDaybLyEX8s2/fmHk48HCsFn43dOFiaknxFlgVeZcNajCF3UFMh8VBgIcRJ8qS9pF0dMoQCPSZJdq2PsicJTtq1vD0jJEnDrc/5kLkrWUhLXZdJkqflN2gDwwqMvF5ng/xLkr7/cVtZS02j0qLUtA9yksQcHsS563qcOo8/PNgnf/Luxb2uCPuYS3kBDvMpNA3+dgiJX5i85Uzrb4pUKJmTdmFIdJPpuMG8IjgKnf7RqnB/f59hOM2MLcfdVTf+cDKbny/mo6NsklW+VmEY8dJSox4oXpA/tLyzsLI8GiSDPfDnP7q6Wevpqx83CqXmYRZQP3QL0xUPYv7+MqYW6f67TKSC16abVPDyw2IPDyt0dGnVbsev48CeXt10A3PFc5H3HVERFmTDdrShrZiKWcQ9WjIYFldtXACe7LK8K8Ubx3lOjf+h7M1gA/z0cbEUqVh1+3JtCr5j8Z554b2YivD9GRKOBcI7Hvu6bMMiL6JO/vsXFgkyAg==
|
||||
sidebar_class_name: "post 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={"Set Keyboard Map"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/api/room/keyboard/map"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Update the keyboard map configuration.
|
||||
|
||||
<Heading
|
||||
id={"request"}
|
||||
as={"h2"}
|
||||
className={"openapi-tabs__heading"}
|
||||
children={"Request"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={{"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"}}},"required":true}}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"204":{"description":"Keyboard map updated successfully."},"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 change 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