This repository was archived by the owner on Oct 8, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 13
Expand file tree
/
Copy pathswagger.yaml
More file actions
376 lines (353 loc) · 9.51 KB
/
swagger.yaml
File metadata and controls
376 lines (353 loc) · 9.51 KB
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
openapi: 3.0.0
info:
title: iRODS REST API
description: This is the iRODS REST API
version: 0.1.0
contact:
email: info@irods.org
license:
name: BSD 3-Clause
url: https://opensource.org/licenses/BSD-3-Clause
servers:
- url: /v1
security:
- BearerAuth:
- read
- write
- BasicAuth:
- read
- write
- ApiKeyAuth: []
tags:
- name: auth
description: Authentication endpoint
- name: rodsadmin
description: Secured Admin-only calls
- name: rodsuser
description: Operations available to regular users
paths:
/ticket:
post:
tags:
- auth
- rodsuser
summary:
obtain an iRODS ticket and url for a given object
operationId: ticket
description:
obtain an iRODS ticket and url for a given object
parameters:
- in: query
name: path
description: irods absolute logical path of the object
required: true
schema:
type: string
security: []
responses:
200:
description: token acquired
content:
text/plain:
schema:
type: string
description: iRODS ticket and url to use in subsequent operations
'401':
description: token acquisition failed
/admin:
get:
tags:
- rodsadmin
summary: Administration interface for changes to zone configuration
description: |
Interface for zone administration including modification of users, resources, and
zone federation.
operationId: admin
parameters:
- in: query
name: action
description: dictates the action taken - add, modify, or remove
required: true
schema:
type: string
- name: target
in: query
description: the subject of the action - user, zone, resource, childtoresc, childfromresc, token, group, rebalance, unusedAVUs, specificQuery
required: true
schema:
type: string
- name: arg2
in: query
description: generic argument, could be user name, resource name, etc.
required: true
schema:
type: string
- name: arg3
in: query
description: generic argument
required: true
schema:
type: string
- name: arg4
in: query
description: generic argument
required: true
schema:
type: string
- name: arg5
in: query
description: generic argument
required: true
schema:
type: string
- name: arg6
in: query
description: generic argument
required: true
schema:
type: string
- name: arg7
in: query
description: generic argument
required: true
schema:
type: string
responses:
200:
description: OK
400:
description: bad input parameter
/list:
get:
tags:
- rodsuser
summary: Recursively list the contents of a logical collection
description: |
Recursively list the contents of a logical collection
operationId: list
parameters:
- name: path
in: query
description: irods absolute logical path of the collection
required: true
schema:
type: string
- name: stat
in: query
description: flag to include status information
schema:
type: boolean
- name: permissions
in: query
description: flag to include permission information
schema:
type: boolean
- name: metadata
in: query
description: flag to include metadata information
schema:
type: boolean
- name: offset
in: query
description: number of records to skip for pagination
schema:
type: integer
format: int32
minimum: 0
- name: limit
in: query
description: maximum number of records to return
schema:
type: integer
format: int32
minimum: 1
security:
- BasicAuth: [read]
- ApiKeyAuth: [read]
- BearerAuth: [read]
responses:
'200':
description: listing of logical collection
content:
application/json:
schema:
type: string
'400':
description: bad input parameter
'404':
description: data not found/no access
/stream:
get:
tags:
- rodsuser
summary: Obtains an HTTP stream of file bytes
description: |
Obtains an HTTP stream of file bytes
operationId: stream
parameters:
- name: path
in: query
description: absolute logical path of the data object
required: true
schema:
type: string
- name: offset
in: query
description: number of bytes to skip for pagination
schema:
type: integer
format: int32
minimum: 0
- name: limit
in: query
description: maximum number of bytes to return
schema:
type: integer
format: int32
minimum: 1
security:
- BasicAuth: [read]
- ApiKeyAuth: [read]
- BearerAuth: [read]
responses:
'200':
description: bytestream of the (partial) data object
content:
application/octet-stream:
schema:
type: string
format: binary
'400':
description: bad input parameter
'404':
description: data not found/no access
put:
tags:
- rodsuser
summary: Sends an HTTP stream of file bytes
description: |
Sends an HTTP stream of file bytes
operationId: stream_put
parameters:
- in: query
name: path
description: absolute logical path of the data object
required: true
schema:
type: string
- in: query
name: offset
description: number of bytes to skip for pagination
schema:
type: integer
format: int32
minimum: 0
- in: query
name: limit
description: maximum number of bytes to return
schema:
type: integer
format: int32
minimum: 1
security:
- BasicAuth: [read]
- ApiKeyAuth: [read]
- BearerAuth: [read]
responses:
'200':
description: OK
'400':
description: bad input parameter
'404':
description: data not found/no access
/query:
get:
tags:
- rodsuser
summary: searches iRODS Catalog using the General Query Language
description: |
By passing in the appropriate options, you can search for
anything within the iRODS Catalog
operationId: catalogQuery
parameters:
- name: query_string
in: query
description: an iRODS general query string or iRODS specific query string or iRODS specific query alias
required: true
schema:
type: string
- name: query_limit
in: query
description: maximum number of records to return
required: false
schema:
type: integer
maximum: 50
minimum: 0
format: string
- name: row_offset
in: query
description: number of records to skip for pagination
required: false
schema:
type: integer
minimum: 0
format: string
- name: query_type
in: query
description: which type of query to perform
required: true
schema:
type: string
enum: ['general', 'specific']
responses:
200:
description: search results matching criteria
content:
application/json:
schema:
$ref: '#/components/schemas/query_results'
400:
description: bad input parameter
/zonereport:
get:
tags:
- rodsadmin
summary: produces a json description of an iRODS Zone
description: |
Produces an iRODS Zone Report, a json description of the entire
zone, including all configuration. This API is for administrators
only.
operationId: zonereport
responses:
200:
description: json description of an iRODS Zone
content:
application/json:
schema:
type: string
description: json representation of irods zone
400:
description: bad input parameter
components:
securitySchemes:
BasicAuth:
type: http
scheme: basic
ApiKeyAuth: # arbitrary name for the security scheme
type: apiKey
in: header # can be "header", "query" or "cookie"
name: X-API-KEY # name of the header, query parameter or cookie
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
schemas:
query_results:
type: object
properties:
results:
type: string
example: { "results" : [ [], [] ] }
required:
- results