-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
115 lines (114 loc) · 3.36 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
openapi: 3.0.3
info:
title: Analytics Microservice
description: >-
Documentation fot the Analytics microservice. It performs analytics
over the metadata provided by the detection service over Redis.
contact:
email: [email protected]
version: 1.0.1
externalDocs:
description: Find out more about Analytics Microservice
url: https://developer.ridgerun.com/wiki/index.php/Metropolis_Microservices/RidgeRun_Services/Analytics
servers:
- url: http://127.0.0.1:5040
tags:
- name: configuration
description: Analytics Configuration
paths:
/configuration:
put:
tags:
- configuration
summary: Updates the service configuration.
description: Update the service configuration.
operationId: update_configuration
requestBody:
description: Indicates wheter move camera and record actions must be enabled. Also the ip and port of the ptz(move_camera) and vst(record) microservices. And a time threshold, for record it indicates the amount of time elapsed to start a new recording, any event before this threshold is ignored and for ptz it indicates the amount of time elapsed since previous event before the camera position is restarted.
content:
application/json:
schema:
$ref: '#/components/schemas/configuration'
required: true
responses:
'200':
description: Successful operation
'400':
description: Operation failed
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
get:
tags:
- configuration
summary: Gets the service configuration
description: Gets the service configuration
operationId: get_configuration
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/configuration'
'400':
description: Operation failed
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
components:
schemas:
configuration:
required:
- move_camera
- record
type: object
properties:
move_camera:
type: object
properties:
enable:
type: integer
format: int32
example: 1
port:
type: integer
format: int32
example: 5020
ip:
type: string
format: string
example: "127.0.0.1"
time_threshold:
type: integer
format: int32
example: 10
record:
type: object
properties:
enable:
type: integer
format: int32
example: 1
port:
type: integer
format: int32
example: 81
ip:
type: string
format: string
example: "127.0.0.1"
time_threshold:
type: integer
format: int32
example: 10
ApiResponse:
type: object
properties:
code:
type: integer
format: int32
message:
type: string