mirror of
https://github.com/LogicLabs-OU/OpenArchiver.git
synced 2026-04-06 00:31:57 +02:00
2 lines
2.1 KiB
JavaScript
2 lines
2.1 KiB
JavaScript
import{_ as t,c as a,o as r,ag as o}from"./chunks/framework.S-Qvb3wi.js";const g=JSON.parse('{"title":"Storage Service API","description":"","frontmatter":{},"headers":[],"relativePath":"api/storage.md","filePath":"api/storage.md"}'),i={name:"api/storage.md"};function s(n,e,l,d,h,p){return r(),a("div",null,e[0]||(e[0]=[o('<h1 id="storage-service-api" tabindex="-1">Storage Service API <a class="header-anchor" href="#storage-service-api" aria-label="Permalink to "Storage Service API""></a></h1><p>The Storage Service provides an endpoint for downloading files from the configured storage provider.</p><h2 id="endpoints" tabindex="-1">Endpoints <a class="header-anchor" href="#endpoints" aria-label="Permalink to "Endpoints""></a></h2><p>All endpoints in this service require authentication.</p><h3 id="get-api-v1-storage-download" tabindex="-1">GET /api/v1/storage/download <a class="header-anchor" href="#get-api-v1-storage-download" aria-label="Permalink to "GET /api/v1/storage/download""></a></h3><p>Downloads a file from the storage.</p><p><strong>Access:</strong> Authenticated</p><h4 id="query-parameters" tabindex="-1">Query Parameters <a class="header-anchor" href="#query-parameters" aria-label="Permalink to "Query Parameters""></a></h4><table tabindex="0"><thead><tr><th style="text-align:left;">Parameter</th><th style="text-align:left;">Type</th><th style="text-align:left;">Description</th></tr></thead><tbody><tr><td style="text-align:left;"><code>path</code></td><td style="text-align:left;">string</td><td style="text-align:left;">The path to the file within the storage provider.</td></tr></tbody></table><h4 id="responses" tabindex="-1">Responses <a class="header-anchor" href="#responses" aria-label="Permalink to "Responses""></a></h4><ul><li><strong>200 OK:</strong> The file stream.</li><li><strong>400 Bad Request:</strong> File path is required or invalid.</li><li><strong>404 Not Found:</strong> File not found.</li><li><strong>500 Internal Server Error:</strong> An unexpected error occurred.</li></ul>',11)]))}const u=t(i,[["render",s]]);export{g as __pageData,u as default};
|