-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathQuill-swagger-2.0.yml
203 lines (203 loc) · 4.28 KB
/
Quill-swagger-2.0.yml
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# ___ _ _ _ _ _ __
# / __(_)_ __ _ __| (_)__(_) |_ /_/
# \__ \ | ' \| '_ \ | / _| | _/ -_)
# |___/_|_|_|_| .__/_|_\__|_|\__\___|
# |_| Module: Quill 6
basePath: /api
paths:
/#:
get:
summary: Login (obtain bearer token)
security:
- basicAuth: []
produces:
- text/plain
- application/json
operationId: login
responses:
'200':
description: Successful login
'401':
schema:
$ref: '#/definitions/Error401'
description: Unauthorized
parameters:
- in: query
name: _output
description: Optional output format
type: string
required: false
enum:
- json
- oauth2
- token
tags:
- session
/logout:
get:
summary: Logout (revoke bearer token)
security:
- bearerAuth: []
produces:
- application/json
operationId: logout
responses:
'200':
description: Successfull logout
'401':
schema:
$ref: '#/definitions/Error401'
description: Unauthorized
tags:
- session
/:
get:
summary: Get user session information
security:
- bearerAuth: []
produces:
- application/json
operationId: info
responses:
'200':
description: Success in getting user session information
'401':
schema:
$ref: '#/definitions/Error401'
description: Unauthorized
parameters:
- in: query
name: texts
description: Texts?
type: boolean
required: false
tags:
- session
securityDefinitions:
basicAuth:
type: basic
bearerAuth:
in: header
name: Authorization
type: apiKey
definitions:
Error404:
type: object
properties:
error:
description: Error message
type: string
status:
description: Error status
type: integer
enum:
- 404
ActionResult:
type: object
properties:
result:
description: Action result
type: string
TreeviewData:
type: object
properties:
item:
description: Object item with lists of linked objects' items
type: object
PublicationResult:
type: object
properties:
mime:
description: MIME type
type: string
content:
description: Content (plain text or base64 encoded)
type: string
PlaceData:
type: object
properties:
coord:
description: Geographical coordinates
type: string
address:
description: Address
type: string
row_id:
description: Row ID
type: string
label1:
description: 'Label #1'
type: string
label2:
description: 'Label #2'
type: string
label3:
description: 'Label #3'
type: string
Error400:
type: object
properties:
error:
description: Error message
type: string
status:
description: Error status
type: integer
enum:
- 400
Error401:
type: object
properties:
error:
description: Error message
type: string
status:
description: Error status
type: integer
enum:
- 401
Error500:
type: object
properties:
error:
description: Error message
type: string
status:
description: Error status
type: integer
enum:
- 500
PlaceMapData:
type: object
properties:
places:
description: Places
type: array
items:
$ref: '#/definitions/PlaceData'
name:
description: Name
type: string
Error403:
type: object
properties:
error:
description: Error message
type: string
status:
description: Error status
type: integer
enum:
- 403
swagger: '2.0'
info:
license:
name: Simplicite license
url: http://www.simplicitesoftware.com
contact:
name: Simplicite Software
url: http://www.simplicitesoftware.com
email: contact@simplicitesoftware.com
description: API for module Quill
title: Quill
version: '6'