mirror of
https://github.com/m1k1o/neko.git
synced 2025-07-31 15:29:41 +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/broadcast-stop.api.mdx
Normal file
63
webpage/docs/api/broadcast-stop.api.mdx
Normal file
|
@ -0,0 +1,63 @@
|
|||
---
|
||||
id: broadcast-stop
|
||||
title: "Stop Broadcast"
|
||||
description: "Stop broadcasting the room's content."
|
||||
sidebar_label: "Stop Broadcast"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzVV0tv2zgQ/isDFujuCrLsJj35lrpeNGibFpG7PSTBgpbGEmuKVDmUU6/h/74YUrIdtwV67cmyOI/vG85LO+FlRWJ6J5y1zWjprCwLSV48pKJEKpxqvbJGTEXubQuHc2Uq8DUCa/1BUFjj0fhMpMK26CTrXJdiKg4KrC5S4ZBaawhJTHfiYvKSf576eTVoAHnbtlgCdUWBRKtO620m9ql4OXnxvd6C0eDXDsmHX+WQoCN0IDtfo/GqCLAYYw+Xjci21f3J+AuxpZ2gosZG8pPftiimwi6/YOFFKlrH9LyK+BskkhWeCJJ3ylTiPHav0UulsQR0zjro9TKx36fCK69Zdc5H73uL+/0+8Lz8MU9Ct0EHnSnRkbe2jHcR2aew7DgEq46QwNvA3zr1H4LyvxP7i4vv2eeRuSIw1j9Jx9+G2T4VDfracnm0loJ76WsxFWPZqjFX1PhAbEyxbuKNc6GeR+SdLaTuM0KkonNaTEXtfTsdjzWf1Zb89HIymYj9AxsqOqf8Nlh6hdKhu+rY+93DPt2JmbVrhadvFnaN5vDixELO0YwBO9U6xEy26i1uRSoUwyyCiEiFkQ2f3szffvg3n+f59Yeb7+J69aRioSNuNxIIifh/tBVawSmDg2dmzzELALkJBaFf9RJNgmfewcdJBH5C7muHbnvkFlR/1V0QhlYSYQmSQEKwBq10skGPLqaTMisb/PdpdYNrC1cfr0UqODGii8tskk2+cxxEQzP4jMvbxQykKfkxt8UaPSyRVIkEt/N8wRa5ZbTOblTJLUXqkVcNAv+1QN6hbJSpUlDGo5OFVxuEwmotlzb2/TTYd9hYj1AirXlwrDpT8KHUym+ze3Nvnj17BjPrEBZY1MZqWykkPhhBkvwTvOWDN7Bc9BF9ktwbgBEEVho36GSFBEkyHMPKuiPwFLR9HGnp0RTbFGpV1aOvXYDRc2K0sivVCbssuniL26WVrgwije0IATdoPIF0CN5JQ43yHsuIj3swyQaHMBfWGAysAyRC2WgkOkbOmmwgfMt4FxzoXFUcJc4NU8LMNk1nhpwZwhBvbohEoD684tbYcSoFl0djygyw/sSsytJDMSF5udSK6gaNT+F6NodCmlKV0iPgt6KWpsK/MoDo7F2471r6o4WuZVmK977uYzaO8VpJrZeyWIeI1dKUeojWAfMxBkMCMvT5Bt3W1wx9rgmPXM/K6DnkPYz30sgKmUWSwAhyblP4ow0g4BzAB0x85QPBJLm1tgkyn1j3zOzMofShABpbqtU2PLIwzx5ndQh2dBq2Fq4mbul04uB1XxSzqELB8FX5pYt7FRUOkbucWamqi0VFKTQMhM/XP0vLbHCQb8ljA29Qal/Dc3iP3qki+rnlZ9wER1GsjmJFjcWagtHDDic1KEOqqn3EH8v2jX2Eaw9XWsNn69YEC1uhr9GxwIvstBbjlRM0WCp5LLBwxUly1l7Svg4ZQim9TJLs3lxkZwmOhjre7SQkScutj3zI3KUqlcO+yyTJefmdtIHTCoy8LrOT/EuSof9xW1kpg6PKSWXwcMlJEnP45J77rsep8+TiQnb/zcsB97oyLAyU8noWZkxoGrzZhsQvbdFxpg2aIhVaFWgo7CL9dLlqZVEjXIRO/2TcPz4+ZjKcZtZV416Vxu+uZ/ObfD66yCZZ7RsdBgqvHo00J4bDhn9Yv8/HyO64Xf3yt0A/LD1+8+NWS2V4nAbIu37nueNJyt8F1jYiPX4u8PjmzechFby/sOBut5SEn5ze7/l1nLnTu4dUbKRTcsljkVcWUaMs0YUFZ41bjlhRYMsmN1J3cXqfLYe81xyWso8f8oXY7/8H3hSMhg==
|
||||
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={"Stop Broadcast"}
|
||||
>
|
||||
</Heading>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/api/room/broadcast/stop"}
|
||||
context={"endpoint"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Stop broadcasting the room's content.
|
||||
|
||||
<ParamsDetails
|
||||
parameters={undefined}
|
||||
>
|
||||
|
||||
</ParamsDetails>
|
||||
|
||||
<RequestSchema
|
||||
title={"Body"}
|
||||
body={undefined}
|
||||
>
|
||||
|
||||
</RequestSchema>
|
||||
|
||||
<StatusCodes
|
||||
id={undefined}
|
||||
label={undefined}
|
||||
responses={{"204":{"description":"Broadcast stopped 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"}}}},"422":{"description":"Server is not broadcasting.","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