chore(docs): Generated API Reference (#2927)

Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-01-03 10:40:03 +02:00
committed by GitHub
parent 19d7be31eb
commit cd32795595
12 changed files with 3847 additions and 3419 deletions

View File

@@ -57,3 +57,58 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
delete:
operationId: AdminDeleteUploads
summary: Delete an Uploaded File
description: Removes an uploaded file using the installed fileservice
x-authenticated: true
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminDeleteUploadsReq.yaml
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/uploads/deleteundefined
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/uploads/deleteundefined
security:
- api_token: []
- cookie_auth: []
tags:
- Upload
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The file key of the upload deleted
object:
type: string
description: The type of the object that was deleted.
default: file
deleted:
type: boolean
description: Whether or not the items were deleted.
default: true
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml

View File

@@ -0,0 +1,47 @@
post:
operationId: PostUploadsDownloadUrl
summary: Get a File's Download URL
description: Creates a presigned download url for a file
x-authenticated: true
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostUploadsDownloadUrlReq.yaml
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/uploads_download-url/postundefined
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/uploads_download-url/postundefined
security:
- api_token: []
- cookie_auth: []
tags:
- Upload
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
download_url:
type: string
description: The Download URL of the file
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml