3pp-mirror/neko
1
0
Fork 0
mirror of https://github.com/m1k1o/neko.git synced 2025-06-14 08:42:40 +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/batch.api.mdx Normal file
View file

@ -0,0 +1,71 @@
---
id: batch
title: "Batch Request"
description: "Execute multiple API requests in a single call."
sidebar_label: "Batch Request"
hide_title: true
hide_table_of_contents: true
api: eJzlV91v2zYQ/1cOLFBsgixn6ZvfUtdbg3ZpEbvrQxoMZ+ossaZIlaScGob/9+FIKVaddij2Or9YIu/jd9+ngwhYeTG7ExUZcqjFfS5K8tKpNihrxEwsvpLsAkHT6aBaTXD1/hocfenIBw/KAIJXptIEErUuRC5sSw6Z+7oUM7HGIGuRC0e+tcaTF7ODuLy44L9vNb1kykE0UNJbgu+kJO83ndZ7Fi+tCWQC82PbaiWjrulnz0IOwsuaGuSnsG9JzAQ6h3uRCxWo8aNzu/5MMohctI4RB5WgtRjqEZUPTplKnHtlVSdHkClbq0wAZivEMRcNhdqW35NApmvY1X8sViIX798t+e/V4u1itXjqdlbwerV6D0kedJ7KKH9ty/1T3zH54GFgEtg420DoYabQHHPhA4Zu7AVlAlXkvmtg1J84QNqSwG6ixEFRIY7HXAQVNA3hu+2vxDH+OOwxnC971P/P4AULa/q5EKbkTxG07jyAT90d6cXJ18pRKWbBdTQyR7TWR2dF94gptmo61KUntyPHPeAc0FsrUUO6F7nonBYzUYfQzqZTzXe19WH24uLiQhzvWZDsnAr7KOkloSN31bG+u/tjfhBza7eKxicruyXzeDCSsOQsSAEdc52SolVvKGYFw5SRROTCYMO3N4s37/5eLpbL63c3T0LPksiEPu+g49bFHYy85/ckKwZpbMGjZraefRYBcnOLRD+rJYmEwHZHHSMP/MC4Lx25/cm2yPqz6iIxtOg9lYAeEKI0aNFhQ4FcSiiuvdtTlS6+YtNyht0N5XQqgsd84irgiCmzsRF7n5Q3tLWcryIXnFQJ3oviorh4AjqSdp48fKT17WoOaEp+XFq5pQBr8qokD7eL5SpWQLDQOrtTJVcJ6klQDQG/WvDBETbKVDlwO3Mog9oRSKs1rm2aRXmU76ixgaAkvw22hU1nJF+iVmFffDKfzLNnz2BuHcGKZG2stpUizxcTyLK/orbloA3sjlyPPss+GYAJRKs07chhRR6ybLiO1fwIPAdtHyYaAxm5z6FWVT350kUYvU2MFrtSjawrkoo3tF9bdGUkaWznCWhHJnhARxAcGt+owJMz4uMO4rGhwc3SGkPR6gjJEzaavD95zppiMPiW8a7Y0UtVsZc4r0wJc9s0nRnybXBDitzgiWj6cATKx/aXVJ6EKTPA+oWKqsgfC5F8wLVWvm7IhByu5wuQaEpVYiCgr7JGU9GvBUBS9jbGu8ZwktC1TOtT3Le9z6bJXxvUeo1yGz1Woyn14K1HzCcfDAnI0Bc7cvtQM/SF9nSy9awEn8Oyh/EnGqyIrcgymMCSW1wcBQ7wWx7GOYCPmDjkg4FZdmttE2k+MO+Z2LkjDLEAGluqzT4+MjHPW2d1dHZSGpcpriZnbeNHCl71RTFPLD4Kvio/d54lg5eOiDuk2aiqS0Xlc2gYCN9vf5SWxaBgufeBGnhNqEMNz+FPCk7JpOeWn2kXFSWyOpHJmuTWR6GPeyVqUMarqg4Jfyrb1/YBrgNcaQ0frdt6WNmKQk2OCX4rxrWYQu6hoVLhqcBiiLPsrL3kfR0yhBIDZlnxyVwWZwlOxneOuMlmWcutz4eYuWtVKkd9l8my8/IbtYFxBSa7XhSj/Muyof9xW9koQ5PKoTL0GOQsSzk8inPf9Th1vglczO7frYOGe11JAZX2OTjaxPkUmwYv3DHxSys7zrSBU+RCK0m85c0Ow2S6alHWBJex03+zKjw8PBQYbwvrqmnP6qdvr+eLm+VicllcFHVodBxGvKg0aEaC01fBsOicTZHRQvkfPlT6iRvoa5i2GpXhmRyxD6PvjsexyPuPmPtc8MrDx4fDGj19cPp45OM0pmd397nYoVO4jgP0/piLmrAkF6fplvZiJuYJ8GTFyplcd2nsn23DvCEljispqQ3/Sns/ms39bjosmY0tmcfhA3+E4YOYifiNFtOMCeLZQWg0VYcV0yaZ/PsHGQ7YGQ==
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={"Batch Request"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/api/batch"}
context={"endpoint"}
>
</MethodEndpoint>
Execute multiple API requests in a single call.
<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":"array","items":{"type":"object","properties":{"path":{"type":"string","description":"The API endpoint path."},"method":{"type":"string","enum":["GET","POST","DELETE"],"description":"The HTTP method to be used."},"body":{"description":"The request body for the API call."}},"title":"BatchRequest"}}}},"required":true}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Batch request executed successfully.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","description":"The API endpoint path."},"method":{"type":"string","enum":["GET","POST","DELETE"],"description":"The HTTP method used."},"body":{"description":"The response body from the API call."},"status":{"type":"integer","description":"The HTTP status code of the response."}},"title":"BatchResponse"}}}}}}}
>
</StatusCodes>