This repository has been archived by the owner on Aug 15, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathopenapi.yaml
110 lines (110 loc) · 4.43 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
openapi: "3.0.0"
info:
title: Redact API
description: An API for redacting sensitive data from CSV, Excel and JSON files
version: "1.0.0"
servers:
- url: <http://localhost:6000/>
paths:
/api/process_csv:
post:
summary: Process a CSV file and redact sensitive data
description: This endpoint allows users to upload a CSV file and specify a redaction method to remove sensitive data from the file. The redacted file can be downloaded in the same format as the original file. The endpoint also supports synthetic data generation to replace sensitive data with realistic but fake data.
operationId: processCsvFile
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
format: binary
description: The CSV file to be redacted.
redaction_method:
type: string
enum: [fixed_string, random_value, hash]
description: The method to be used for redacting sensitive data from the file.
synthetic_data:
type: string
enum: [true, false]
description: Whether to generate synthetic data to replace sensitive data in the file.
responses:
"200":
description: Success
content:
text/csv:
schema:
type: string
format: binary
"400":
description: Bad request
/api/process_excel:
post:
summary: Process an Excel file and redact sensitive data
description: This endpoint allows users to upload an Excel file and specify a redaction method to remove sensitive data from the file. The redacted file can be downloaded in the same format as the original file. The endpoint also supports synthetic data generation to replace sensitive data with realistic but fake data.
operationId: processExcelFile
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
format: binary
description: The Excel file to be redacted.
redaction_method:
type: string
enum: [fixed_string, random_value, hash]
description: The method to be used for redacting sensitive data from the file.
synthetic_data:
type: string
enum: [true, false]
description: Whether to generate synthetic data to replace sensitive data in the file.
responses:
"200":
description: Success
content:
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
schema:
type: string
format: binary
"400":
description: Bad request
/api/process_json:
post:
summary: Process a JSON file and redact sensitive data
description: This endpoint allows users to upload a JSON file and specify a redaction method to remove sensitive data from the file. The redacted file can be downloaded in the same format as the original file. The endpoint also supports synthetic data generation to replace sensitive data with realistic but fake data.
operationId: processJsonFile
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
format: binary
description: The JSON file to be redacted.
redaction_method:
type: string
enum: [fixed_string, random_value, hash]
description: The method to be used for redacting sensitive data from the file.
synthetic_data:
type: string
enum: [true, false]
description: Whether to generate synthetic data to replace sensitive data in the file.
responses:
"200":
description: Success
content:
application/json:
schema:
type: string
format: binary
"400":
description: Bad request