swagger-docs/classification.yml
2020-04-19 22:57:27 +02:00

59 lines
1.4 KiB
YAML

swagger: "2.0"
info:
description: "This is the classification interface of the Birbnetes system."
version: "1.0.0"
title: "Classification Service"
contact:
email: "punkosdmarcell@rocketmail.com"
license:
name: "Apache 2.0"
url: "http://www.apache.org/licenses/LICENSE-2.0.html"
host: "dev.k8s.tcloud.enginner"
basePath: "/api/classification/v1"
tags:
- name: "classification"
description: "Classification Service interaction"
schemes:
- "https"
- "http"
paths:
/classify:
post:
tags:
- "classification"
summary: "Start classifying sample"
description: "This endpoint recieves the features extracted by the feature extractor"
operationId: "classify"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- name: "modelId"
in: "body"
schema:
type: "object"
properties:
tag:
type: "string"
features:
type: "array"
items:
type: "number"
model:
type: "string"
responses:
200:
description: "Classification started"
schema:
$ref: "#/definitions/ApiResponse"
definitions:
ApiResponse:
type: "object"
properties:
status:
type: "string"
message:
type: "string"