-
Notifications
You must be signed in to change notification settings - Fork 1
/
api_contract.yaml
172 lines (161 loc) · 4.09 KB
/
api_contract.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
161
162
163
164
165
166
167
168
169
170
171
172
openapi: 3.0.0
info:
title: Flask PII Analysis API
version: 1.0.0
description: API for PII analysis and data management
servers:
- url: http://localhost:5000
paths:
/:
get:
summary: Home Page
responses:
'200':
description: HTML content of home page
content:
text/html:
schema:
type: string
/configure:
get:
summary: Configure Page
responses:
'200':
description: HTML content of configure page
content:
text/html:
schema:
type: string
/dashboard:
get:
summary: Dashboard Page
responses:
'200':
description: HTML content of dashboard page
content:
text/html:
schema:
type: string
/view:
get:
summary: View Page
responses:
'200':
description: HTML content of view page
content:
text/html:
schema:
type: string
/get_analysis:
get:
summary: Get PII Analysis Results
responses:
'200':
description: JSON containing analysis results
content:
application/json:
schema:
type: object
/get_files:
post:
summary: Get Files from AWS S3
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
access_key:
type: string
secret_key:
type: string
region:
type: string
required:
- access_key
- secret_key
- region
responses:
'200':
description: Successfully fetched files
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
'400':
description: Missing AWS credentials
'403':
description: Invalid AWS credentials
'500':
description: Server error
/connect_postgres:
post:
summary: Connect to PostgreSQL and Fetch Data
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
db_host:
type: string
db_port:
type: string
db_name:
type: string
db_user:
type: string
db_password:
type: string
required:
- db_host
- db_port
- db_name
- db_user
- db_password
responses:
'200':
description: Successfully connected and fetched data
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
tables:
type: array
items:
type: string
'400':
description: Missing PostgreSQL credentials
'500':
description: Server error
/download_csv:
get:
summary: Download CSV File
responses:
'200':
description: CSV file download
content:
text/csv:
schema:
type: string
format: binary
/get_results:
get:
summary: Get Analysis Results
responses:
'200':
description: JSON containing analysis results
content:
application/json:
schema:
type: object
components:
schemas: {}