refactor api

This commit is contained in:
Torma Kristóf 2020-04-08 03:17:47 +02:00
parent 23ef0e725a
commit e69851d4f8
1 changed files with 38 additions and 25 deletions

View File

@ -9,52 +9,68 @@ info:
name: "Apache 2.0" name: "Apache 2.0"
url: "http://www.apache.org/licenses/LICENSE-2.0.html" url: "http://www.apache.org/licenses/LICENSE-2.0.html"
host: "dev.k8s.tcloud.enginner" host: "dev.k8s.tcloud.enginner"
basePath: "/api/extractor/rdb/v1" basePath: "/api/result/rdb/v1"
tags: tags:
- name: "output" - name: "result"
description: "Output Service - RDB interaction" description: "Output Service - RDB interaction"
schemes: schemes:
- "https" - "https"
- "http" - "http"
paths: paths:
/output/filter/negative: /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: get:
summary: Get all negative decision objects summary: Get all negative decision objects
operationId: getallnegative operationId: getallnegative
tags: tags:
- output - result
responses: responses:
"200": "200":
description: Array of decision objects description: Array of decision objects
schema: schema:
$ref: '#/definitions/OutputObjects' $ref: '#/definitions/ResultObjects'
"404": "404":
description: No object matching filter description: No object matching filter
schema: schema:
$ref: '#/definitions/ApiResponse' $ref: '#/definitions/ApiResponse'
/output/filter/positive: /result/filter/positive:
get: get:
summary: Get positive decision objects summary: Get positive decision objects
operationId: getallpositive operationId: getallpositive
tags: tags:
- output - result
responses: responses:
"200": "200":
description: Array of decision objects description: Array of decision objects
schema: schema:
$ref: '#/definitions/OutputObjects' $ref: '#/definitions/ResultObjects'
"404": "404":
description: No object matching filter description: No object matching filter
schema: schema:
$ref: '#/definitions/ApiResponse' $ref: '#/definitions/ApiResponse'
/output/after/{dateAfter}: /result/after/{dateAfter}:
get: get:
summary: Get decision before a date summary: Get decision before a date
operationId: getallafter operationId: getallafter
tags: tags:
- output - result
parameters: parameters:
- name: dateAfter - name: dateAfter
in: path in: path
@ -66,18 +82,18 @@ paths:
"200": "200":
description: Array of decision objects description: Array of decision objects
schema: schema:
$ref: '#/definitions/OutputObjects' $ref: '#/definitions/ResultObjects'
"404": "404":
description: No object matching filter description: No object matching filter
schema: schema:
$ref: '#/definitions/ApiResponse' $ref: '#/definitions/ApiResponse'
/output/before/{dateBefore}: /result/before/{dateBefore}:
get: get:
summary: Get decision before a date summary: Get decision before a date
operationId: getallbefore operationId: getallbefore
tags: tags:
- output - result
parameters: parameters:
- name: dateBefore - name: dateBefore
in: path in: path
@ -89,18 +105,18 @@ paths:
"200": "200":
description: Array of decision objects description: Array of decision objects
schema: schema:
$ref: '#/definitions/OutputObjects' $ref: '#/definitions/ResultObjects'
"404": "404":
description: NO objects matching filter description: NO objects matching filter
schema: schema:
$ref: '#/definitions/ApiResponse' $ref: '#/definitions/ApiResponse'
/output/{tagID}: /result/{tagID}:
get: get:
summary: Get decision by ID summary: Get decision by ID
operationId: getDecision operationId: getDecision
tags: tags:
- output - result
parameters: parameters:
- name: tagID - name: tagID
in: path in: path
@ -112,27 +128,24 @@ paths:
"200": "200":
description: Decision object description: Decision object
schema: schema:
$ref: '#/definitions/OutputObject' $ref: '#/definitions/ResultObject'
"404": "404":
description: Tag not found description: Tag not found
schema: schema:
$ref: '#/definitions/ApiResponse' $ref: '#/definitions/ApiResponse'
definitions: definitions:
OutputObjects: ResultObjects:
type: array type: array
items: items:
$ref: '#/definitions/OutputObject' $ref: '#/definitions/ResultObject'
OutputObject: ResultObject:
type: "object" type: "object"
properties: properties:
tag: tag:
type: "string" type: "string"
decison: probability:
type: "boolean" type: "number"
date:
type: "string"
format: "date"
ApiResponse: ApiResponse:
type: "object" type: "object"
properties: properties: