-
Notifications
You must be signed in to change notification settings - Fork 0
/
pdr-swagger.json
128 lines (128 loc) · 2.68 KB
/
pdr-swagger.json
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
{
"swagger": "2.0",
"info": {
"title": "CPN PDR API",
"version": "v1"
},
"basePath": "/pdr",
"paths": {
"/": {
"post": {
"summary": "",
"description": "",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "User input",
"required": true,
"schema": {
"$ref": "#/definitions/UserInput"
}
}
],
"responses": {
"200": {
"description": "Success, the message was queued.",
"schema": {
"$ref": "#/definitions/Success"
}
},
"400": {
"description": "The given input is invalid (malformed json)",
"schema": {
"$ref": "#/definitions/Error"
}
},
"502": {
"description": "The receipt couldn't be sent (mailgun error)",
"schema": {
"$ref": "#/definitions/Error"
}
}
}
}
},
},
"definitions": {
"DataProcessed": {
"type": "object",
"required": ["description", "purpose"],
"properties": {
"description": {
"type": "string"
},
"purpose": {
"type": "string"
},
"shared_with": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"UserInput": {
"type": "object",
"required": [
"trigger",
"cpn_user_id",
"cpn_registered_email",
"user_name",
"given_personal_data",
"consents"
],
"properties": {
"trigger": {
"type": "string",
"enum": ["REGISTRATION", "PROFILE_UPDATE", "MANUAL_REQUEST"]
},
"cpn_user_id": {
"type": "string"
},
"cpn_registered_email": {
"type": "string"
},
"user_name": {
"type": "string"
},
"given_personal_data": {
"type": "array",
"items": {
"$ref": "#/definitions/DataProcessed"
}
}
}
},
"Success": {
"type": "object",
"required": ["id", "message"],
"properties": {
"id": {
"type": "string"
},
"message": {
"type": "string"
}
}
},
"Error": {
"type": "object",
"required": [
"error",
],
"properties": {
"error": {
"type": "string"
}
}
}
}
}