-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathapispec.yaml
159 lines (159 loc) · 4.35 KB
/
apispec.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
openapi: 3.0.3
info:
description: API for managing documents.
version: 0.0.1
title: Document API
servers:
- url: SERVER_URL
security:
- ApiKeyAuth: []
paths:
/documents:
get:
summary: List objects.
description: Retrieve a page of objects from the server.
responses:
"200":
description: Successful response
content:
application/json:
schema:
type: object
properties:
Documents:
type: array
items:
$ref: "#/components/schemas/ListOfDocuments"
post:
summary: Creates a new object.
description: Creates a new object.
requestBody:
description: The object to create.
required: false
content:
application/json:
schema:
$ref: "#/components/schemas/Document"
responses:
"201":
description: Successful response
content:
application/json:
schema:
$ref: "#/components/schemas/Document"
/documents/{id}:
get:
summary: Retrieve object.
description: Retrieve a single object.
parameters:
- name: id
in: path
required: true
description: Unique identifier of the desired object.
schema:
type: string
responses:
"200":
description: Successful response
content:
application/json:
schema:
$ref: "#/components/schemas/Document"
"404":
description: Object was not found.
put:
summary: Update object.
description: Update a single object.
parameters:
- name: id
in: path
required: true
description: Unique identifier of the desired object.
schema:
type: string
requestBody:
description: The object to update.
required: false
content:
application/json:
schema:
$ref: "#/components/schemas/Document"
responses:
"200":
description: Successful response
content:
application/json:
schema:
$ref: "#/components/schemas/Document"
"404":
description: Object was not found.
delete:
summary: Delete object.
description: Delete a single object.
parameters:
- name: id
in: path
required: true
description: Unique identifier of the desired object.
schema:
type: string
responses:
"200":
description: Successful response
"404":
description: Object was not found.
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
name: x-apikey
in: header
schemas:
Document:
title: Document
type: object
properties:
id:
description: The id of the object
type: string
example: hu32hu3
dateTime:
description: The date-time of the object
type: string
example: 8/9/2023 9:38:51 AM
description:
description: The text of the object
type: string
example: Example description
file:
description: The file path of the document
type: string
example: /path/to/doc
text:
description: Text version of the file
type: string
example: "\nEnglish\n=☑ \nFrançais\n=☑"
formFields:
description: The form fields of the document
type: string
example: "\nEnglish\n=☑ \nFrançais\n=☑"
entities:
description: The named entities found in the document
type: string
example: "\nEnglish\n=☑ \nFrançais\n=☑"
image:
description: A thumbnail image of the document
type: string
totalFields:
description: How many total fields were found in the document
type: integer
example: 12
filledFields:
description: How many of the fields are filled with data
type: integer
example: 8
ListOfDocuments:
title: List of objects
type: array
items:
$ref: "#/components/schemas/Document"