mirror of
https://github.com/m1k1o/neko.git
synced 2025-07-28 22:18:57 +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/control-status.api.mdx
Normal file
63
webpage/docs/api/control-status.api.mdx
Normal file
|
@ -0,0 +1,63 @@
|
|||
---
|
||||
id: control-status
|
||||
title: "Get Control Status"
|
||||
description: "Retrieve the current control status of the room."
|
||||
sidebar_label: "Get Control Status"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzVV99v20YM/leIK1Bsgiy76Z78lrleG7TNhjhdH5KgoCVauvp0px5PTr3A//vAk2Q7TosVw172ZFnkfSS/4y89qIAlq+mN8s7Vo9zZ4J1Rd6kqiHOvm6CdVVN1RcFr2hCEiiBvvScboNcGDhhaBreKUgHKVKpcQx7l+EWhpqrXXURVlSpP3DjLxGr6oM4mE/l5bHL2GN33HhTAbZ4T86o1ZiuGBJpsEARsGqPzaHX8mQXmQXFeUY3yFLYNqalyy8+UB5WqxouPQXdOVMifKsfhSHPpnCG06pSNC1uIFWLQMWZPoBkQ5PjAjvi2S5W8+qSLI1AOXtvyCeZ1RXDxaiBxoFiOp2IFreDtUhV0MHSgpyd0txPZL5MXT3kUYE9fWuIQf7UnhpbJA7ahIht6wv5DKmtixpL+OehXFFAbKoC8dx76c48DnYvofY84xPny23Ey+Q15aG1BnoNzRZeRXfQpLFuhYNUyMQQX43de/0Wgw/8m+l2qagqVk6IqKVrHUKmpGmOjx1J846GKU9XxIfV9ytY7l6Pp+VKpar1RU1WF0EzHYyMyybzpy8lkonZ3ApS3XodtRPqV0JM/b8Xszd0ufVAz59aajt9cuzXZ/YsjhIWw2BF1fGrPFTb6LW1VqrSNbUNUVKos1iK9nL/9/dNivlhc/H75hM/zR/kMLWtbAgITs/zvsGJVHkewtyzRC2fRQan+qPSjVjpICBJ3tHHEwHeC+9KS3x5ii0d/1FxUhgaZqQCU5hPRoEGPNQXyXRppu3LRfp9Ol7R2cP7HhUqVJEZn4mU2ySZPDEfVWCofaXl1PQO0hTwuXL6mAEtiXRDD1XxxLYhSUI13G11IwaEZBV0TyF8HHDxhrW2ZgraBPOZBbwhyZwwuXTcl0ojvqXaBoCBeB9fAqrW5CNHosM1u7a199uwZzJwnuKa8ss64UhOLYARJ8me0thisgZNm0HmfJLcWYAQxKkMb8lgSQ5IMYlg5f3A8BePuRwYD2XybQqXLavSljW70MYm32Bb6KLqsM/GWtkuHvogqtWuZgDZkAwN6guDRcq1DoKLzTzoUY00DzbmzlmLU0SUmrA0xH5hzNhsCvhJ/r4XohS6FJckNW8DM1XVrh5wZaOhubmAihj68kvnVSipFkwcwbQe3fqKszNJ9MREHXBrNVU02pHAxm0OOttAFBgL6mldoS/o5A+iMvYv3XWE4ILSN6HJ37+ues3HH1wqNWWK+joxVaAszsLX3+cDBkIDi+nxDfhsqcX1umA6xnpTRc1j0brxHiyVJFEkCI1hIm6Jvzcfo5+B89EmufAgwSa6cq6POBzl7AjvzhCEWQO0KvdrGR1Hue3UkuzMalxupJunlfGTgVV8U/eTnCHxefG5ZkIFzTyRdzq502XZFxSnU4ojI199Ly2wwsNhyoBreEJpQwXN4LytX3tnpF8BoqFOrOrW8onzNEXS/8aEBbVmXVej878r2jbuHiwDnxsBH59cM164k2Z5E4UV2XIvdlTPUVGg8FFi84iQ5aS9pX4fiQoEBkyS7tWfZSYKT5VY2H4QkaaT1cYiZu9SF9tR3mSQ5Lb+jNnBcgV1cL7Oj/EuSof9JW1lpS6PSo7a0v+Qk6XL46J77riep8+jiYnb/JkuB9LoiLgqcyvISZ0xsGrIAx8QvXN5Kpg0nVaqMzsly3EH66XLeYF4RnMVO/2jc39/fZxilmfPluD/K43cXs/nlYj46yyZZFWoTB0rjONRoj4BfUxhSEvbr/aNR8nDYrP7Nh0Q/OwN9DePGoLYyXWMED/3ucyODVT4qnKv7Pa7/iukW+hv18LBEpg/e7Hbyupu805u7VG3Qa1zKcJTFRVWEBfm45qxpK7zlOTWyZm3QtN0MP1kNZbvZr2Sv59dqt/sbLuiijA==
|
||||
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 Control Status"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/api/room/control"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Retrieve the current control status of the room.
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"200":{"description":"Control status retrieved successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"has_host":{"type":"boolean","description":"Indicates if there is a host currently."},"host_id":{"type":"string","description":"The ID of the current host, if any."}},"title":"ControlStatus"}}}},"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>
|
||||
|
||||
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue