LumeWeb
/
s5-js
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: update swagger.yaml

This commit is contained in:
Derrick Hammer 2024-03-16 11:21:17 -04:00
parent e9f4b03979
commit 7cdcfe3b3e
Signed by: pcfreak30
GPG Key ID: C997C339BE476FF2
1 changed files with 49 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
swagger.yaml
View File

@ -16,7 +16,7 @@ paths:
in: query in: query
required: true required: true
schema: schema:
type: string type: string
responses: responses:
'200': '200':
description: Registration challenge description: Registration challenge
@ -45,7 +45,7 @@ paths:
in: query in: query
required: true required: true
schema: schema:
type: string type: string
responses: responses:
'200': '200':
description: Login challenge description: Login challenge
@ -82,6 +82,20 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/AccountStatsResponse" $ref: "#/components/schemas/AccountStatsResponse"
/s5/account/pins:
get:
summary: Retrieve account pins
tags:
- account
responses:
'200':
description: Account pins
content:
application/json:
schema:
$ref: '#/components/schemas/AccountPinsResponse'
'401':
description: Unauthorized
/s5/account/pins.bin: /s5/account/pins.bin:
get: get:
summary: Retrieve account pins summary: Retrieve account pins
@ -90,6 +104,8 @@ paths:
responses: responses:
'200': '200':
description: Account pins description: Account pins
'401':
description: Unauthorized
# Upload API # Upload API
/s5/upload: /s5/upload:
@ -133,17 +149,17 @@ paths:
in: query in: query
required: true required: true
schema: schema:
$ref: '#/components/schemas/UploadRequestTryFiles' $ref: '#/components/schemas/UploadRequestTryFiles'
- name: errorPages - name: errorPages
in: query in: query
required: true required: true
schema: schema:
$ref: '#/components/schemas/UploadRequestErrorPages' $ref: '#/components/schemas/UploadRequestErrorPages'
- name: name - name: name
in: query in: query
required: true required: true
schema: schema:
type: string type: string
requestBody: requestBody:
content: content:
multipart/form-data: multipart/form-data:
@ -600,7 +616,7 @@ paths:
in: path in: path
required: true required: true
schema: schema:
type: string type: string
responses: responses:
'302': '302':
description: Redirecting to discovered blob url description: Redirecting to discovered blob url
@ -614,7 +630,7 @@ paths:
in: path in: path
required: true required: true
schema: schema:
type: string type: string
description: > description: >
* Resolvers are currently not supported * Resolvers are currently not supported
@ -626,6 +642,8 @@ paths:
application/json: application/json:
schema: schema:
type: object type: object
'415':
description: Unsupported content type
/s5/download/{cid}: /s5/download/{cid}:
get: get:
summary: Download a file summary: Download a file
@ -636,7 +654,7 @@ paths:
in: path in: path
required: true required: true
schema: schema:
type: string type: string
responses: responses:
'200': '200':
description: File content description: File content
@ -657,7 +675,7 @@ paths:
in: path in: path
required: true required: true
schema: schema:
type: string type: string
responses: responses:
'204': '204':
description: File pinned description: File pinned
@ -671,7 +689,7 @@ paths:
in: path in: path
required: true required: true
schema: schema:
type: string type: string
responses: responses:
'204': '204':
description: File deleted description: File deleted
@ -687,19 +705,19 @@ paths:
in: path in: path
required: true required: true
schema: schema:
type: string type: string
- name: hash - name: hash
in: query in: query
required: true required: true
schema: schema:
type: string type: string
description: This is base64 url encoded description: This is base64 url encoded
- name: kinds - name: kinds
in: query in: query
required: false required: false
schema: schema:
type: string type: string
description: This is a comma separated list of kinds, which are integer identifiers. description: This is a comma separated list of kinds, which are integer identifiers.
responses: responses:
'200': '200':
description: Download URLs description: Download URLs
@ -717,8 +735,8 @@ paths:
in: path in: path
required: true required: true
schema: schema:
type: string type: string
description: This is base64 url encoded description: This is base64 url encoded
responses: responses:
'200': '200':
description: Storage locations description: Storage locations
@ -880,6 +898,20 @@ components:
properties: properties:
stats: stats:
$ref: "#/components/schemas/AccountStats" $ref: "#/components/schemas/AccountStats"
AccountPinsResponse:
type: object
properties:
pins:
type: array
items:
$ref: '#/components/schemas/AccountPin'
AccountPin:
type: object
properties:
hash:
type: string
mime_type:
type: string
RegistryQueryResponse: RegistryQueryResponse:
type: object type: object
properties: properties: