refactor: add tags to swagger

This commit is contained in:
Derrick Hammer 2024-02-07 20:31:42 -05:00
parent 7c945f0a2d
commit b939ea109c
Signed by: pcfreak30
GPG Key ID: C997C339BE476FF2
1 changed files with 65 additions and 0 deletions

View File

@ -7,6 +7,8 @@ paths:
/s5/account/register: /s5/account/register:
get: get:
summary: Initiate account registration summary: Initiate account registration
tags:
- account
security: [] security: []
parameters: parameters:
- name: pubKey - name: pubKey
@ -20,6 +22,8 @@ paths:
description: Registration challenge description: Registration challenge
post: post:
summary: Complete account registration summary: Complete account registration
tags:
- account
security: [] security: []
requestBody: requestBody:
content: content:
@ -32,6 +36,8 @@ paths:
/s5/account/login: /s5/account/login:
get: get:
summary: Initiate account login summary: Initiate account login
tags:
- account
security: [] security: []
parameters: parameters:
- name: pubKey - name: pubKey
@ -45,6 +51,8 @@ paths:
description: Login challenge description: Login challenge
post: post:
summary: Complete account login summary: Complete account login
tags:
- account
security: [] security: []
requestBody: requestBody:
content: content:
@ -57,12 +65,16 @@ paths:
/s5/account: /s5/account:
get: get:
summary: Retrieve account information summary: Retrieve account information
tags:
- account
responses: responses:
'200': '200':
description: Account information description: Account information
/s5/account/stats: /s5/account/stats:
get: get:
summary: Retrieve account statistics summary: Retrieve account statistics
tags:
- account
responses: responses:
'200': '200':
description: Account statistics description: Account statistics
@ -73,6 +85,8 @@ paths:
/s5/account/pins.bin: /s5/account/pins.bin:
get: get:
summary: Retrieve account pins summary: Retrieve account pins
tags:
- account
responses: responses:
'200': '200':
description: Account pins description: Account pins
@ -81,6 +95,8 @@ paths:
/s5/upload: /s5/upload:
post: post:
summary: Upload a small file summary: Upload a small file
tags:
- upload
requestBody: requestBody:
content: content:
multipart/form-data: multipart/form-data:
@ -102,6 +118,8 @@ paths:
/s5/upload/directory: /s5/upload/directory:
post: post:
summary: Upload a directory summary: Upload a directory
tags:
- upload
description: > description: >
This endpoint accepts multiple files in a multipart/form-data request. This endpoint accepts multiple files in a multipart/form-data request.
Each file can be uploaded under its own field name, which the server will process dynamically. Each file can be uploaded under its own field name, which the server will process dynamically.
@ -139,6 +157,9 @@ paths:
/s5/upload/tus: /s5/upload/tus:
post: post:
summary: TUS Upload summary: TUS Upload
tags:
- upload
- tus
description: > description: >
An empty POST request is used to create a new upload resource. The An empty POST request is used to create a new upload resource. The
Upload-Length header indicates the size of the entire upload in bytes. Upload-Length header indicates the size of the entire upload in bytes.
@ -328,6 +349,9 @@ paths:
/s5/upload/tus/{id}: /s5/upload/tus/{id}:
delete: delete:
summary: Added by the Termination extension. summary: Added by the Termination extension.
tags:
- upload
- tus
description: When receiving a DELETE request for an existing upload the Server description: When receiving a DELETE request for an existing upload the Server
SHOULD free associated resources and MUST respond with the 204 No Content SHOULD free associated resources and MUST respond with the 204 No Content
status confirming that the upload was terminated. For all future requests status confirming that the upload was terminated. For all future requests
@ -363,6 +387,9 @@ paths:
$ref: "#/components/schemas/Tus-Version" $ref: "#/components/schemas/Tus-Version"
head: head:
summary: Used to determine the offset at which the upload should be continued. summary: Used to determine the offset at which the upload should be continued.
tags:
- upload
- tus
description: Used to determine the offset at which the upload should be continued. description: Used to determine the offset at which the upload should be continued.
operationId: FilesHead operationId: FilesHead
parameters: parameters:
@ -429,6 +456,9 @@ paths:
$ref: "#/components/schemas/Tus-Version" $ref: "#/components/schemas/Tus-Version"
patch: patch:
summary: Used to resume the upload summary: Used to resume the upload
tags:
- upload
- tus
description: 'The Server SHOULD accept PATCH requests against any upload URL description: 'The Server SHOULD accept PATCH requests against any upload URL
and apply the bytes contained in the message at the given offset specified and apply the bytes contained in the message at the given offset specified
by the Upload-Offset header. All PATCH requests MUST use Content-Type: application/offset+octet-stream, by the Upload-Offset header. All PATCH requests MUST use Content-Type: application/offset+octet-stream,
@ -555,6 +585,8 @@ paths:
/s5/blob/{cid}: /s5/blob/{cid}:
get: get:
summary: Retrieve a blob summary: Retrieve a blob
tags:
- download
parameters: parameters:
- name: cid - name: cid
in: path in: path
@ -567,6 +599,8 @@ paths:
/s5/metadata/{cid}: /s5/metadata/{cid}:
get: get:
summary: Retrieve file metadata summary: Retrieve file metadata
tags:
- download
parameters: parameters:
- name: cid - name: cid
in: path in: path
@ -587,6 +621,8 @@ paths:
/s5/download/{cid}: /s5/download/{cid}:
get: get:
summary: Download a file summary: Download a file
tags:
- download
parameters: parameters:
- name: cid - name: cid
in: path in: path
@ -606,6 +642,8 @@ paths:
/s5/pin/{cid}: /s5/pin/{cid}:
post: post:
summary: Pin a file summary: Pin a file
tags:
- pin
parameters: parameters:
- name: cid - name: cid
in: path in: path
@ -618,6 +656,8 @@ paths:
/s5/delete/{cid}: /s5/delete/{cid}:
delete: delete:
summary: Delete a file. This will only unpin it from the account, and potentially delete it later if there are no more global pins. summary: Delete a file. This will only unpin it from the account, and potentially delete it later if there are no more global pins.
tags:
- pin
parameters: parameters:
- name: cid - name: cid
in: path in: path
@ -632,6 +672,8 @@ paths:
/s5/debug/download_urls/{cid}: /s5/debug/download_urls/{cid}:
get: get:
summary: Retrieve download URLs summary: Retrieve download URLs
tags:
- debug
parameters: parameters:
- name: cid - name: cid
in: path in: path
@ -660,6 +702,8 @@ paths:
/s5/debug/storage_locations/{hash}: /s5/debug/storage_locations/{hash}:
get: get:
summary: Retrieve storage locations summary: Retrieve storage locations
tags:
- debug
parameters: parameters:
- name: hash - name: hash
in: path in: path
@ -678,6 +722,8 @@ paths:
/s5/registry: /s5/registry:
get: get:
summary: Retrieve a registry entry summary: Retrieve a registry entry
tags:
- registry
parameters: parameters:
- name: pk - name: pk
description: Public key of the registry entry description: Public key of the registry entry
@ -694,6 +740,8 @@ paths:
$ref: '#/components/schemas/RegistryQueryResponse' $ref: '#/components/schemas/RegistryQueryResponse'
post: post:
summary: Create or update a registry entry summary: Create or update a registry entry
tags:
- registry
requestBody: requestBody:
content: content:
application/json: application/json:
@ -705,6 +753,8 @@ paths:
/s5/registry/subscription: /s5/registry/subscription:
post: post:
summary: Listen for websocket updates for a given registry entry summary: Listen for websocket updates for a given registry entry
tags:
- registry
requestBody: requestBody:
content: content:
text/plain: text/plain:
@ -928,3 +978,18 @@ security:
- BearerAuth: [] - BearerAuth: []
- CookieAuth: [] - CookieAuth: []
- QueryAuth: [] - QueryAuth: []
tags:
- name: account
description: Account API
- name: upload
description: Upload API
- name: tus
description: TUS API
- name: download
description: Download API
- name: pin
description: Pins API
- name: debug
description: Debug API
- name: registry
description: Registry API