swagger-docs/model.yaml

213 lines
5.6 KiB
YAML

openapi: 3.0.3
info:
title: Model Service
description: This is the model-service interface of the Birbnetes system.
contact:
email: punkosdmarcell@rocketmail.com
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
version: 1.0.4
servers:
- url: https://dev.k8s.tcloud.enginner/api/model/v1
- url: http://dev.k8s.tcloud.enginner/api/model/v1
tags:
- name: model
description: Model Service definition
paths:
/model:
get:
tags:
- model
summary: Return a brief list of available models
description: Returns a brief list of available models
operationId: getModelList
responses:
200:
description: A brief list of available models
content:
application/json:
schema:
$ref: '#/components/schemas/BriefModelDetails'
post:
tags:
- model
summary: Uploads a new model into the service
operationId: uploadFile
requestBody:
content:
multipart/form-data:
schema:
required:
- file
- info
properties:
info:
type: object
description: Json metadata of model
properties:
type:
type: string
id:
type: string
file:
type: string
description: model itself
format: binary
required: true
responses:
201:
description: Model successfully stored. This means that a get request for
this object should be successful.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
409:
description: A model with this Id already exists
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
/model/{modelId}:
get:
tags:
- model
summary: Download a model identified by Id
description: Returns a single model
operationId: getModelById
parameters:
- name: modelId
in: path
description: Id of the model to return or `$default` for the default
required: true
schema:
type: string
responses:
200:
description: The requested model
content:
application/octet-stream: {}
404:
description: A model with this Id does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
delete:
tags:
- model
summary: Deletes a model identified by Id
operationId: deleteModel
parameters:
- name: modelId
in: path
description: Id of the model to delete
required: true
schema:
type: string
responses:
204:
description: Successful deletion
content: {}
404:
description: An model with this Id does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
/model/$default:
put:
tags:
- model
summary: Updates the id of the default model
description: It really does
operationId: updateDefault
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
required: false
responses:
204:
description: Successful update
content: {}
404:
description: The id does not identifies any model
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
x-codegen-request-body-name: modelId
/model/{modelId}/details:
get:
tags:
- model
summary: Get the details of the model required for extraction
description: Returns a single object representing model details
operationId: getModelDetailsById
parameters:
- name: modelId
in: path
description: Id of the model to return the details of or `$default` for the
default model
required: true
schema:
type: string
responses:
200:
description: The details of the requested model.
content:
application/json:
schema:
$ref: '#/components/schemas/ModelDetails'
404:
description: A model with this id does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
components:
schemas:
ApiResponse:
type: object
properties:
status:
type: string
msg:
type: string
BriefModelDetails:
type: array
items:
type: object
properties:
id:
type: string
default:
type: boolean
ModelDetails:
type: object
properties:
id:
type: string
timestamp:
type: string
default:
type: boolean
mid_window:
type: number
mid_step:
type: number
short_window:
type: number
short_step:
type: number
compute_beat:
type: boolean
type:
type: string