swagger-docs/output-service-tsdb.yaml

156 lines
3.7 KiB
YAML
Raw Normal View History

2020-04-08 03:18:24 +02:00
swagger: "2.0"
info:
description: "This is the feature extraction interface of the Birbnetes system."
version: "1.0.0"
title: "Output Service - RDB"
contact:
email: "tormakristof@tormakristof.eu"
license:
name: "Apache 2.0"
url: "http://www.apache.org/licenses/LICENSE-2.0.html"
host: "dev.k8s.tcloud.enginner"
basePath: "/api/result/rdb/v1"
tags:
- name: "result"
description: "Output Service - RDB interaction"
schemes:
- "https"
- "http"
paths:
/result:
get:
summary: Get all decision objects
operationId: getall
tags:
- result
responses:
"200":
description: Array of decision objects
schema:
$ref: '#/definitions/ResultObjects'
"404":
description: No object matching filter
schema:
$ref: '#/definitions/ApiResponse'
/result/filter/negative:
get:
summary: Get all negative decision objects
operationId: getallnegative
tags:
- result
responses:
"200":
description: Array of decision objects
schema:
$ref: '#/definitions/ResultObjects'
"404":
description: No object matching filter
schema:
$ref: '#/definitions/ApiResponse'
/result/filter/positive:
get:
summary: Get positive decision objects
operationId: getallpositive
tags:
- result
responses:
"200":
description: Array of decision objects
schema:
$ref: '#/definitions/ResultObjects'
"404":
description: No object matching filter
schema:
$ref: '#/definitions/ApiResponse'
/result/after/{dateAfter}:
get:
summary: Get decision before a date
operationId: getallafter
tags:
- result
parameters:
- name: dateAfter
in: path
description: Date of filter
required: true
type: string
format: date
responses:
"200":
description: Array of decision objects
schema:
$ref: '#/definitions/ResultObjects'
"404":
description: No object matching filter
schema:
$ref: '#/definitions/ApiResponse'
/result/before/{dateBefore}:
get:
summary: Get decision before a date
operationId: getallbefore
tags:
- result
parameters:
- name: dateBefore
in: path
description: Date of filter
required: true
type: string
format: date
responses:
"200":
description: Array of decision objects
schema:
$ref: '#/definitions/ResultObjects'
"404":
description: NO objects matching filter
schema:
$ref: '#/definitions/ApiResponse'
/result/{tagID}:
get:
summary: Get decision by ID
operationId: getDecision
tags:
- result
parameters:
- name: tagID
in: path
description: ID of wave file
required: true
type: integer
format: int32
responses:
"200":
description: Decision object
schema:
$ref: '#/definitions/ResultObject'
"404":
description: Tag not found
schema:
$ref: '#/definitions/ApiResponse'
definitions:
ResultObjects:
type: array
items:
$ref: '#/definitions/ResultObject'
ResultObject:
type: "object"
properties:
tag:
type: "string"
probability:
type: "number"
ApiResponse:
type: "object"
properties:
status:
type: "string"
message:
type: "string"