-
Notifications
You must be signed in to change notification settings - Fork 29
/
perseo-api.yml
223 lines (221 loc) · 5.56 KB
/
perseo-api.yml
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
#
# Copyright 2016 Telefonica Investigación y Desarrollo, S.A.U
#
# This file is part of perseo-fe
#
# perseo-fe is free software: you can redistribute it and/or modify it under the terms of the GNU Affero
# General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your
# option) any later version.
# perseo-fe is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the
# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License
# for more details.
#
# You should have received a copy of the GNU Affero General Public License along with perseo-fe. If not, see
# http://www.gnu.org/licenses/.
#
# For those usages not covered by the GNU Affero General Public License please contact with iot_support at tid dot es
#
# TODO This is an initial Perseo API description. Incomplete
# TODO security
# TODO HEADERS
openapi: 3.0.0
info:
description: ""
version: 1.0.0
title: Perseo
termsOfService: ""
contact:
email: ""
license:
name: GNU Affero General Public License v3.0
url: https://www.gnu.org/licenses/gpl-3.0.en.html
tags:
- name: notice
description: Perseo notice
- name: rule
description: Perseo rule
- name: version
description: Perseo version
paths:
/notices:
post:
tags:
- notice
summary: Send notification to perseo
description: ""
operationId: newNotification
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/Notice"
description: Notice Object
required: true
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/DefaultResponse"
"405":
description: Invalid input
/rules:
get:
tags:
- rule
summary: List All Rules
description: Returns complete rule list
operationId: gelAllRules
responses:
"200":
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Rule"
post:
tags:
- rule
summary: Add new rule
description: ""
operationId: addNewRule
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/Rule"
description: Rule Object
required: true
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/Rule"
"405":
description: Invalid input
"/rules/{ruleName}":
get:
tags:
- rule
summary: Get rule named ruleName
description: returns the rule named ruleName information
operationId: getRuleByName
parameters:
- in: path
name: ruleName
schema:
type: string
required: true
description: The rule name.
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/Rule"
delete:
tags:
- rule
summary: Delete rule
description: ""
operationId: deleteRule
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteRuleResponse"
"405":
description: Invalid input
/version:
get:
tags:
- version
summary: Perseo Version
description: Returns the perseo version
operationId: getVersion
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/Version"
/admin/log:
get:
tags:
- log
summary: Get Perseo log level
description: Returns the Perseo log level
operationId: gelLogLevel
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/LogInfo"
put:
tags:
- log
summary: Set Perseo log level
description: Set the Perseo log level
operationId: changeLogLevel
parameters:
- in: query
name: level
required: true
schema:
$ref: "#/components/schemas/LogLevel"
type: string
responses:
"200":
description: successful operation
externalDocs:
description: ""
url: ""
servers:
- url: https://perseo/
- url: http://perseo/
# TODO
components:
securitySchemes:
api_key:
type: apiKey
name: api_key
in: header
schemas:
Notice:
type: string
description: TODO
DefaultResponse:
type: string
description: TODO
Rule:
type: string
description: TODO
DeleteRuleResponse:
type: string
description: TODO
Version:
type: string
description: TODO
LogInfo:
type: string
description: TODO
LogLevel:
type: string
description: Perseo log levels
enum:
- FATAL
- ERROR
- WARN
- INFO
- DEBUG