3pp-mirror/neko
1
0
Fork 0
mirror of https://github.com/m1k1o/neko.git synced 2025-05-10 07:37:26 +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/screen-configuration-change.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: screen-configuration-change
title: "Change Screen Configuration"
description: "Update the screen configuration of the room."
sidebar_label: "Change Screen Configuration"
hide_title: true
hide_table_of_contents: true
api: eJztWG1v2zYQ/isHFig2QZbdZMAGf0tdDw36ithdPyTBcJbOEmuKVEnKqRf4vw9HSrHipEUHDAMKzF8si/fy3PvRt8Jj6cT0Ulhj6pHLLZEW16koyOVWNl4aLabiQ1OgJ/AVQSSB3Oi1LFuLTAFmHc5YRiZSYRqKB+eFmIrIMRsyzCrUJYlUWHKN0Y6cmN6Kk8mEv+6rXjymrw14CnBtnpNz61apHSvOjfakPUvBplEyD+TjT45F3QqXV1QjP/ldQ2IqzOoT5V6korGM2csI5EYWvhqQSe2pJCtSQV+wbhSJ6bOT3ybHXlpWBIG190e0PBP7VFQky8p/W+avJ4+KjKyPyLTo6dsSTx8VaGltyVXA/A/E7lPhpWfmzvX3Aif2e6b4ZfLsYaSi6M8tOR++pSUHrSML2PqKtO/C8S8GqibnsBw6wXkrdSmOzX5BHqWiAshaY6Hju2/unI/edBJ7O08ft9OR3ZKFVhdknTemiPkfrU9h1bIL1q0jB94E+42VfxFI/yNZf3Ly0PpzvUUli0f7wA9jGxdPjNVzU+xYyf+d4z/oHNHr0lIhpt62tE9FTb4yPCUa44I7kf0nxtjIMY+TcTeSUhFLjmfVcUq+NjmqriRFKlqrxFRU3jfT8VjxWWWcn55OJhOxv2ZBeWul3wVJzwkt2bOWtV5e79NbMTNmI2n4Zmk2pO9eDCQsOCti4Idcd37FRr6inUiFZJh5IBGp0Fjz6dv5q3d/LuaLxfm7tw/S+uxey4TWSV0CgiPn+HeUFWI5tOBOM1vPPgsAxVSsAtH3aokiwbPdQcfAA18x7nNLdnewLbB+r7pADA06RwWgA4QgDRq0WJMnG5OLa/HiULXzPlXvqi5WVl8voSZiop9O9gxzbQL8Lkff0sbA2ftzkQrOq4jwNJtkkwe4A2lo5h9pdbGcAeqCHxcm35CHFTlZkIOL+WLJErnlN9ZsZcEVg2rkZU3APw04bwlrqcsUuOos5l5uCXKjFK5MLJU0yLdUG09QkNt408C61TkfopJ+l13pK/3kyROYGUuwpLzSRplSkuODESTJH0HbotcGhsdVRJ8kVxpgBMEqRVuyWJKDJOmPYW3sAXgKytyMFHrS+S6FSpbV6HMbYHQ2MVpsCzmwLosqXtFuZdAWgaQ2rSOgLWnvAC2Bt6hdLT1vcgFfaCdYU+/m3GhNweoAyRHWipw7eM7orDf4gvEu2dELWbKXOLV0ATNT163uU653Q4xc74lgev8KZNhaiqjyIEzqHtZPlJVZeleL5DyulHRVTdqncD6bQ466kGFlpi952HV/zgCistch3hX6g4S4zroY903ns3H01xqVWmG+CR6rUBeq99Yd5oMP+gRk6PMt2Z2vGPpcOTrYelSFT2HRwXiDGktiK5IERrDgLkePbXABZw8+YOKQ9wYmyYUxdaD5wLxHYmeW0IcCqE0h17vwyMQ8gq1RwdlRaVjuuZp4EriBghddUcwiiwuCz4pPrWPJj+4mLoWagfD55mtpmfUKFjvnqYaXhMpX8BTekLcyj3ou+Jm2QVEkqyJZXlG+cUHo3Q0IFUjtuCNF/LFsX5obOPdwphR8NHbjYGlK8hVZJniWDWsxhtxBTYXEQ4GFECfJUXtJuzpkCAV6TJLsSp9kRwlO2rW8myMkScOtz/mQuStZSEtdl0mS4/IbtIFhBUa7TrNB/iVJ3/+4raylplFpUWq6C3KSxBwexLnrepw695dK9snvvNpxryvCuudSXkXCiApNgy+AIfELk7ecaT2nSIWSOWkX5kQ3nM4azCuCk9Dp720LNzc3GYbTzNhy3LG68evz2fztYj46ySZZ5WsV5hFvLDXqgeB4rYXuynp//TmaKYON85/errv56+mLHzcKpeYJHcy47danSx7OfLs2pg5bQH+r50WIj29vV+jog1X7Pb+Ow3t6eZ2KLVqJKx6QvPuIirAgGzalDe3YxIh6tGQQTK7auAwc7cy8N0WOszynxn+T9nqwB75/t1iKVKy6vbw2BfNYvGF78EZMRfiDIWQeE4R3t0KhLttwYRBRJn/+BqD/13U=
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={"Change Screen Configuration"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/api/room/screen"}
context={"endpoint"}
>
</MethodEndpoint>
Update the screen configuration of the room.
<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":{"width":{"type":"integer","example":1280,"description":"The width of the screen."},"height":{"type":"integer","example":720,"description":"The height of the screen."},"rate":{"type":"integer","example":30,"description":"The refresh rate of the screen."}},"title":"ScreenConfiguration"}}},"required":true}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Screen configuration updated successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"width":{"type":"integer","example":1280,"description":"The width of the screen."},"height":{"type":"integer","example":720,"description":"The height of the screen."},"rate":{"type":"integer","example":30,"description":"The refresh rate of the screen."}},"title":"ScreenConfiguration"}}}},"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"}}}},"422":{"description":"Invalid screen configuration.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}}}}
>
</StatusCodes>