add output-service-rdb api definition
This commit is contained in:
parent
a675dcc03c
commit
2e9b4fe875
142
output-service-rdb.yml
Normal file
142
output-service-rdb.yml
Normal file
@ -0,0 +1,142 @@
|
|||||||
|
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/extractor/rdb/v1"
|
||||||
|
tags:
|
||||||
|
- name: "output"
|
||||||
|
description: "Output Service - RDB interaction"
|
||||||
|
schemes:
|
||||||
|
- "https"
|
||||||
|
- "http"
|
||||||
|
paths:
|
||||||
|
/output/filter/negative:
|
||||||
|
get:
|
||||||
|
summary: Get all negative decision objects
|
||||||
|
operationId: getallnegative
|
||||||
|
tags:
|
||||||
|
- output
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: Array of decision objects
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/OutputObjects'
|
||||||
|
"404":
|
||||||
|
description: No object matching filter
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/ApiResponse'
|
||||||
|
|
||||||
|
/output/filter/positive:
|
||||||
|
get:
|
||||||
|
summary: Get positive decision objects
|
||||||
|
operationId: getallpositive
|
||||||
|
tags:
|
||||||
|
- output
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: Array of decision objects
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/OutputObjects'
|
||||||
|
"404":
|
||||||
|
description: No object matching filter
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/ApiResponse'
|
||||||
|
|
||||||
|
/output/after/{dateAfter}:
|
||||||
|
get:
|
||||||
|
summary: Get decision before a date
|
||||||
|
operationId: getallafter
|
||||||
|
tags:
|
||||||
|
- output
|
||||||
|
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/OutputObjects'
|
||||||
|
"404":
|
||||||
|
description: No object matching filter
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/ApiResponse'
|
||||||
|
|
||||||
|
/output/before/{dateBefore}:
|
||||||
|
get:
|
||||||
|
summary: Get decision before a date
|
||||||
|
operationId: getallbefore
|
||||||
|
tags:
|
||||||
|
- output
|
||||||
|
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/OutputObjects'
|
||||||
|
"404":
|
||||||
|
description: NO objects matching filter
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/ApiResponse'
|
||||||
|
|
||||||
|
/output/{tagID}:
|
||||||
|
get:
|
||||||
|
summary: Get decision by ID
|
||||||
|
operationId: getDecision
|
||||||
|
tags:
|
||||||
|
- output
|
||||||
|
parameters:
|
||||||
|
- name: tagID
|
||||||
|
in: path
|
||||||
|
description: ID of wave file
|
||||||
|
required: true
|
||||||
|
type: integer
|
||||||
|
format: int32
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: Decision object
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/OutputObject'
|
||||||
|
"404":
|
||||||
|
description: Tag not found
|
||||||
|
schema:
|
||||||
|
$ref: '#/definitions/ApiResponse'
|
||||||
|
|
||||||
|
definitions:
|
||||||
|
OutputObjects:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: '#/definitions/OutputObject'
|
||||||
|
OutputObject:
|
||||||
|
type: "object"
|
||||||
|
properties:
|
||||||
|
tag:
|
||||||
|
type: "string"
|
||||||
|
decison:
|
||||||
|
type: "boolean"
|
||||||
|
date:
|
||||||
|
type: "string"
|
||||||
|
format: "date"
|
||||||
|
ApiResponse:
|
||||||
|
type: "object"
|
||||||
|
properties:
|
||||||
|
status:
|
||||||
|
type: "string"
|
||||||
|
message:
|
||||||
|
type: "string"
|
Loading…
Reference in New Issue
Block a user