-
Notifications
You must be signed in to change notification settings - Fork 0
/
fosswarn_api.yaml
160 lines (149 loc) · 4.25 KB
/
fosswarn_api.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
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
openapi: 3.1.0
info:
title: "FOSSWarn Server API"
version: '1.0.0'
description: 'This is the API for the FOSS Warn notification Server'
termsOfService: todo
contact:
name: FOSS Warn
url: https://github.com/nucleus-ffm/foss_warn_server
email: fosswarn@posteo.de
license:
name: license
url: todo
servers:
- url: https://api.fosswarn.de
description: Production server
- url: https://api-testing.fosswarn.de
description: Testing server
paths:
/registration:
post:
description: register a new client
parameters:
- in: body
name: new_client
required: true
description: client data for regiser new subscription
schema:
type: object
$ref: '#/components/schemas/new_subscription'
responses:
"200":
description: client succesfully registered
content:
application/json:
schema:
type: object
properties:
token:
type: string
example: succesfully registered
"400":
description: client already registered
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: User already exists please login instead!
/update:
post:
description: update subscription
parameters:
- in: body
name: updated config
required: true
description: updated subscriptions
schema:
type: object
$ref: '#/components/schemas/updated_subscription'
responses:
"200":
description: succesfully updated
content:
application/json:
schema:
type: object
properties:
token:
type: string
example: YOURUNIQUESESSIONTOKEN
"400":
description: failed
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Client not registered
/delete:
post:
description: delete subscription
parameters:
- in: body
name: updated config
required: true
description: delete subscriptions
schema:
type: object
$ref: '#/components/schemas/delete'
responses:
"200":
description: succesfully delete
content:
application/json:
schema:
type: object
properties:
token:
type: String
example: succesfully deleted
"400":
description: failed
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: client could not delted
components:
schemas:
new_subsrciption:
description: new subscription
properties:
distributor_url:
type: string
example: https://example.de
geocode:
type: string
example: 1234
delete:
description: delete subscription
properties:
distributor_url:
type: string
example: https://example.de
reason:
type: string
example: change distributor
update_subscription:
description: update subscription, send new geocode to subscripe and old to remove
properties:
distributor_url:
type: string
example: https://example.de
new_geocodes:
type: array
maxItems: 5
example: [12345, 5678, 21323]
remove_geocode:
type: array
maxItems: 5
example: [12345, 5678, 21323]