Did stuff
bestesterest commit message evur - Added GET and DELETE endpoints - Added ERROR schema - Renamed Response to Success - Changed return types to object from list - Updated version - Updated descriptions
This commit is contained in:
parent
429ad33be4
commit
963d8c31b3
75
storage.yml
75
storage.yml
@ -1,7 +1,7 @@
|
|||||||
openapi: 3.0.0
|
openapi: 3.0.0
|
||||||
info:
|
info:
|
||||||
title: Sound storage as object
|
title: Sound storage as object
|
||||||
version: 1.0.1
|
version: 1.1.0
|
||||||
servers:
|
servers:
|
||||||
- url: https://dev.k8s.tcloud.enginner/api/storage/v1
|
- url: https://dev.k8s.tcloud.enginner/api/storage/v1
|
||||||
paths:
|
paths:
|
||||||
@ -24,20 +24,83 @@ paths:
|
|||||||
format: binary
|
format: binary
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
description: Status message
|
description: Object successfully stored. This means that a get request for this object should be successful.
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: array
|
$ref: '#/components/schemas/Success'
|
||||||
items:
|
'409':
|
||||||
$ref: '#/components/schemas/Response'
|
description: An object with this Tag already exists
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/Error'
|
||||||
|
|
||||||
|
/object/{tag}:
|
||||||
|
get:
|
||||||
|
summary: Get a sound file from the storage
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: tag
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
required: true
|
||||||
|
description: Tag of the sound file to get
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: "The audio file requested"
|
||||||
|
content:
|
||||||
|
audio/wave:
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: binary
|
||||||
|
|
||||||
|
'404':
|
||||||
|
description: "Unknown tag error"
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/Error'
|
||||||
|
|
||||||
|
delete:
|
||||||
|
summary: Deletes a sound file from the storage
|
||||||
|
parameters:
|
||||||
|
- in: path
|
||||||
|
name: tag
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
required: true
|
||||||
|
description: Tag of the sound file to delete
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: "The audio file successfully deleted."
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/Success'
|
||||||
|
|
||||||
|
'404':
|
||||||
|
description: "Unknown tag error"
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/Error'
|
||||||
components:
|
components:
|
||||||
schemas:
|
schemas:
|
||||||
Response:
|
Success:
|
||||||
properties:
|
properties:
|
||||||
status:
|
status:
|
||||||
type: string
|
type: string
|
||||||
description: "Status message from backend."
|
description: "Status message from backend."
|
||||||
required:
|
required:
|
||||||
- status
|
- status
|
||||||
|
Error:
|
||||||
|
properties:
|
||||||
|
status:
|
||||||
|
type: string
|
||||||
|
description: "Status message from backend."
|
||||||
|
msg:
|
||||||
|
type: string
|
||||||
|
description: "Human-readable description of the error"
|
||||||
|
required:
|
||||||
|
- status
|
Loading…
Reference in New Issue
Block a user