3pp-mirror/neko
1
0
Fork 0
mirror of https://github.com/m1k1o/neko.git synced 2025-05-10 23:57:27 +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/upload-dialog.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: upload-dialog
title: "Upload File to Dialog"
description: "Upload a file to a dialog."
sidebar_label: "Upload File to Dialog"
hide_title: true
hide_table_of_contents: true
api: eJzVV91v2zYQ/1cOLDBsgiy7affit9R10aBtWsTu9tAGw1k8S6wpUiWppF7g/304UrKVpB22xz5ZFu/j9zvel+5EwMqL+SfhrG0mXastSnGdC0m+dKoNyhoxFx/je0DYKk0QLCBIhdpWhciFbckhC15IMRfJxMt4KnLhyLfWePJififOZs/5577tV2wyaZFk28ky+K4syfttp/W+EIdcPJ/NHmt/NLhJkJKJiJBRldYEMoE1sG21KiPE6RfPanfClzU1yE9h35KYC7v5QmUQuWgdEwoqQW7Ie6xoJOiDU4ap3QfykgIqTRLIOeug1yvE4ZCLoIJm1SUfvestHg6HSOrpY1LrmsDR1458iL/KkYfOkwPsQk0m9Gx+Kp7Pvs/Tk7shB52R5HywVkI4sc9h03EItp0nH/OuC7V16m8CFX4m9mdnj9lfHnO2z/jW2aYNgGVQNz9TDv/+74XZOsuFfKrxn6pED9zDYjK+sHLPTkawm04H1aIL0611zURiwP+DnAPhR2LoHO4fweYGGZN/c+qTHD4VqPHfY81YMIi52CiDbp9o9DyUIynmwXV0yEVDobbctFvrIzoMtZiLKbZqyvNgmtxN5dDNU7HyvHh43W9tibovZpGLzmkxF3UI7Xw61XxWWx/mz2azmThcs6Gycyrso6UXhI7cecfOP10f8juxsHanaPxmbXdkji9GFlYc6xTFsdYppq16QxxUxTDLKCJyYbDh08vlm/d/rZar1cX7y0eBP7/XbKHzylSA4Ml7/p9sxdE0ZnD0zOw5ZhEg30YU+q9ekkkIzDv6GEXgB+S+duT2J25R9b+6i8LQovckAT0gRGvQosOGArlUJspsbfTfl8sl7Sycf7gQueDESC6eFbNi9shxFI19/E/aXK0XgEby48qWOwqwIa8kebhartZsse8cN0ryNEA9Caoh4L8WfHCEjTJVDsoEcqljQmm1xo1Ny0ge7TtqbCCQ5HfBtrDtTMmHqFXYF5/NZ/PkyRNYWEewprI2VttKkeeDCWTZH9HbavAGlidVQp9lnw3ABCIrTTfksCIPWTYcw9a6E/ActL2daAxkyn0Otarqydcuwug5MVrspBqxK5KLN7TfWHQyijS28wR0QyZ4QEcQHBrfqBBIJnw8Pj02NIS5tMZQZB0hecJGczs+Rs6aYiB8xXjXHOiVqjhKnBtGwsI2TWeGnBnCkG5uiESkPrwCFRcWmVyejCkzwPqViqrIj8VEPuBGK183ZEIOF4sllGikkhgI6FtZo6notwIgOXsb77vGcLLQtSzr073v+phNU7y2qPUGy12MWI1G6iFaR8ynGAwJyNCXN+T2oWboS+3pxPVBGf0Cqx7GOzRYEbPIMpjAitsUfW95izgH8BETX/lAMMuurG2izEfWfWB24QhDLIDGSrXdx0cW5uHkrI7BTk7jFs3VxB3djxy87ItikVR8NHwuv3SeLYMvHRF3ObNVVZeKyufQMBA+3/0oLYvBwWrvAzXwmlCHGn6BdxScKpOfK36mm+goidVJrKyp3Plo9PhhgRqU8aqqQ8Kfyva1vYWLAOdaw5/W7TysbUWhJscCT4txLaYr99CQVHgqsHjFWfagveR9HTIEnuhZVnw2Z8WDBCfjO17LEbKs5dbnQ8zcjZLKUd9lsuxh+Y3awLgCE69nxSj/smzof9xWtsrQpHKoDB0vOctSDo/uue96nDr3Li5m9yteerjXybgI+Zw36zhjYtPgL62Y+NKWHWfaoClyoVVJxscdq58u5y2WNcFZ7PT3xv3t7W2B8bSwrpr2qn769mKxvFwtJ2fFrKhDo+NA4c2jQTMy3H9rvuq/NI9fkvemyWgL+/eP035QBvoWpq1GZXiURrh3/brziacof6la2zCV9Amci37puc4Fry4sd3e3QU8fnT4c+HUat/NP17m4Qad43U3biqgJJbm42+xoL+ZikcBO1oyGxXXHqL63PvKyk5TOy5LaMBJ/tCTzHnTc4T68X61FLjb9ltpYyTpsONrNT48M8nD4BwAXioA=
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={"Upload File to Dialog"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/api/room/upload/dialog"}
context={"endpoint"}
>
</MethodEndpoint>
Upload a file to a dialog.
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={undefined}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"files":{"type":"array","description":"Files to be uploaded.","items":{"type":"string","format":"binary"}}}}}},"required":true}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"204":{"description":"File uploaded to dialog successfully."},"400":{"description":"Unable to upload file.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}},"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":"No upload dialog prompt active.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}},"500":{"description":"Unable to process uploaded file.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Detailed error message."}},"title":"ErrorMessage"}}}}}}
>
</StatusCodes>