175 lines
4.4 KiB
YAML
175 lines
4.4 KiB
YAML
openapi: 3.0.3
|
|
info:
|
|
title: Output Service - RDB
|
|
description: This is the feature extraction interface of the Birbnetes system.
|
|
contact:
|
|
email: tormakristof@tormakristof.eu
|
|
license:
|
|
name: Apache 2.0
|
|
url: http://www.apache.org/licenses/LICENSE-2.0.html
|
|
version: 1.0.0
|
|
servers:
|
|
- url: https://birb.k8s.kmlabz.com
|
|
tags:
|
|
- name: output
|
|
description: Output Service - RDB interaction
|
|
paths:
|
|
/output:
|
|
get:
|
|
tags:
|
|
- output
|
|
summary: Get all decision objects
|
|
operationId: getall
|
|
responses:
|
|
200:
|
|
description: Array of decision objects
|
|
content:
|
|
'application/JSON':
|
|
schema:
|
|
$ref: '#/components/schemas/ResultObjects'
|
|
404:
|
|
description: No object matching filter
|
|
content:
|
|
'application/JSON':
|
|
schema:
|
|
$ref: '#/components/schemas/ApiResponse'
|
|
/output/filter/negative:
|
|
get:
|
|
tags:
|
|
- output
|
|
summary: Get all negative decision objects
|
|
operationId: getallnegative
|
|
responses:
|
|
200:
|
|
description: Array of decision objects
|
|
content:
|
|
'application/JSON':
|
|
schema:
|
|
$ref: '#/components/schemas/ResultObjects'
|
|
404:
|
|
description: No object matching filter
|
|
content:
|
|
'application/JSON':
|
|
schema:
|
|
$ref: '#/components/schemas/ApiResponse'
|
|
/output/filter/positive:
|
|
get:
|
|
tags:
|
|
- output
|
|
summary: Get positive decision objects
|
|
operationId: getallpositive
|
|
responses:
|
|
200:
|
|
description: Array of decision objects
|
|
content:
|
|
'application/JSON':
|
|
schema:
|
|
$ref: '#/components/schemas/ResultObjects'
|
|
404:
|
|
description: No object matching filter
|
|
content:
|
|
'application/JSON':
|
|
schema:
|
|
$ref: '#/components/schemas/ApiResponse'
|
|
/output/after/{dateAfter}:
|
|
get:
|
|
tags:
|
|
- output
|
|
summary: Get decision before a date
|
|
operationId: getallafter
|
|
parameters:
|
|
- name: dateAfter
|
|
in: path
|
|
description: Date of filter
|
|
required: true
|
|
schema:
|
|
type: string
|
|
format: date
|
|
responses:
|
|
200:
|
|
description: Array of decision objects
|
|
content:
|
|
'application/JSON':
|
|
schema:
|
|
$ref: '#/components/schemas/ResultObjects'
|
|
404:
|
|
description: No object matching filter
|
|
content:
|
|
'application/JSON':
|
|
schema:
|
|
$ref: '#/components/schemas/ApiResponse'
|
|
/output/before/{dateBefore}:
|
|
get:
|
|
tags:
|
|
- output
|
|
summary: Get decision before a date
|
|
operationId: getallbefore
|
|
parameters:
|
|
- name: dateBefore
|
|
in: path
|
|
description: Date of filter
|
|
required: true
|
|
schema:
|
|
type: string
|
|
format: date
|
|
responses:
|
|
200:
|
|
description: Array of decision objects
|
|
content:
|
|
'application/JSON':
|
|
schema:
|
|
$ref: '#/components/schemas/ResultObjects'
|
|
404:
|
|
description: NO objects matching filter
|
|
content:
|
|
'application/JSON':
|
|
schema:
|
|
$ref: '#/components/schemas/ApiResponse'
|
|
/output/{tagID}:
|
|
get:
|
|
tags:
|
|
- output
|
|
summary: Get decision by ID
|
|
operationId: getDecision
|
|
parameters:
|
|
- name: tagID
|
|
in: path
|
|
description: ID of wave file
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
format: int32
|
|
responses:
|
|
200:
|
|
description: Decision object
|
|
content:
|
|
'application/JSON':
|
|
schema:
|
|
$ref: '#/components/schemas/ResultObject'
|
|
404:
|
|
description: Tag not found
|
|
content:
|
|
'application/JSON':
|
|
schema:
|
|
$ref: '#/components/schemas/ApiResponse'
|
|
components:
|
|
schemas:
|
|
ResultObjects:
|
|
type: array
|
|
items:
|
|
$ref: '#/components/schemas/ResultObject'
|
|
ResultObject:
|
|
type: object
|
|
properties:
|
|
tag:
|
|
type: string
|
|
probability:
|
|
type: number
|
|
ApiResponse:
|
|
type: object
|
|
properties:
|
|
status:
|
|
type: string
|
|
message:
|
|
type: string
|