openapi.osdu.yaml 69.1 KB
Newer Older
Diego Molteni's avatar
Diego Molteni committed
1
#  ***************************************************************************
Diego Molteni's avatar
Diego Molteni committed
2
#  Copyright 2017 - 2021, Schlumberger
Diego Molteni's avatar
Diego Molteni committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
#
#  Licensed under the Apache License, Version 2.0(the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.
#  ***************************************************************************

# ===========================================================================
# Endpoints Description
# ===========================================================================

21
swagger: "2.0"
Diego Molteni's avatar
Diego Molteni committed
22
23

info:
Daniel Perez's avatar
Daniel Perez committed
24
  title: "Seismic DMS Service"
Daniel Perez's avatar
Daniel Perez committed
25
  version: "3.0.0"
Daniel Perez's avatar
Daniel Perez committed
26
  description: "Seismic Data Management APIs to store and manage seismic datasets ."
27
28
29
  license:
    name: "Apache 2.0"
    url: "https://www.apache.org/licenses/LICENSE-2.0.html"
Diego Molteni's avatar
Diego Molteni committed
30
31
32
33
34
35
36
37
38
39
40
41

consumes:
  - application/json
produces:
  - application/json
schemes:
  - https

# ===========================================================================
# Endpoints Paths Section
# ===========================================================================

42
43
basePath: /seistore-svc/api/v3

Diego Molteni's avatar
Diego Molteni committed
44
paths:
Diego Molteni's avatar
Diego Molteni committed
45
46
  /svcstatus:
    get:
Duo Chen's avatar
Duo Chen committed
47
      summary: "Seismic store service status (fast check)."
Diego Molteni's avatar
Diego Molteni committed
48
49
50
51
52
53
54
55
      description: "<ul><li>Return the seismic store service status.</li><li>Required roles: none</li></ul>"
      security:
        - api-key: []
      operationId: service-status
      tags:
        - General
      responses:
        200:
Duo Chen's avatar
Duo Chen committed
56
          description: "Service status."
Diego Molteni's avatar
Diego Molteni committed
57
58
59
          schema:
            type: string
            example: "service OK"
Diego Molteni's avatar
Diego Molteni committed
60

Diego Molteni's avatar
Diego Molteni committed
61
62
  /svcstatus/access:
    get:
Duo Chen's avatar
Duo Chen committed
63
      summary: "Seismic store service status."
Diego Molteni's avatar
Diego Molteni committed
64
65
66
67
68
69
      description: "<ul><li>Return the seismic store service status.</li><li>Required roles: none</li></ul>"
      operationId: service-status-check
      tags:
        - General
      responses:
        200:
Duo Chen's avatar
Duo Chen committed
70
          description: "Seismic store service status."
Diego Molteni's avatar
Diego Molteni committed
71
72
73
          schema:
            $ref: "#/definitions/Status"
        401:
Duo Chen's avatar
Duo Chen committed
74
          description: "Unauthorized."
Diego Molteni's avatar
Diego Molteni committed
75
        403:
Duo Chen's avatar
Duo Chen committed
76
          description: "Forbidden."
Diego Molteni's avatar
Diego Molteni committed
77
78
79

  /dataset/tenant/{tenantid}/subproject/{subprojectid}/dataset/{datasetid}:
    post:
Duo Chen's avatar
Duo Chen committed
80
81
      summary: "Register a new dataset."
      description: "<ul><li>Register a new dataset in the seismic store.</li><li>Required roles: subproject.admin, subproject.editor</li></ul>"
Diego Molteni's avatar
Diego Molteni committed
82
83
84
85
      operationId: dataset-register
      tags:
        - Dataset
      parameters:
Duo Chen's avatar
Duo Chen committed
86
        - description: "Legal tag of the dataset."
Diego Molteni's avatar
Diego Molteni committed
87
88
89
90
          in: header
          name: ltag
          type: string
          required: false
Duo Chen's avatar
Duo Chen committed
91
        - description: "Name of the tenant."
Diego Molteni's avatar
Diego Molteni committed
92
93
94
95
          in: path
          name: tenantid
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
96
        - description: "Name of the subproject."
Diego Molteni's avatar
Diego Molteni committed
97
98
99
100
          in: path
          name: subprojectid
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
101
        - description: "Hierarchical path of the dataset."
Diego Molteni's avatar
Diego Molteni committed
102
103
104
105
          in: query
          name: path
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
106
        - description: "Name of the dataset."
Diego Molteni's avatar
Diego Molteni committed
107
108
109
110
111
112
113
114
115
116
          in: path
          name: datasetid
          required: true
          type: string
        - description: "Request body"
          in: body
          name: request body
          required: false
          schema:
            $ref: "#/definitions/DatasetRegisterBody"
Diego Molteni's avatar
Diego Molteni committed
117
118
      responses:
        200:
Duo Chen's avatar
Duo Chen committed
119
          description: "Registered dataset metadata."
Diego Molteni's avatar
Diego Molteni committed
120
121
122
          schema:
            $ref: "#/definitions/Dataset"
        400:
Duo Chen's avatar
Duo Chen committed
123
          description: "Bad request."
Diego Molteni's avatar
Diego Molteni committed
124
        401:
Duo Chen's avatar
Duo Chen committed
125
          description: "Unauthorized."
Diego Molteni's avatar
Diego Molteni committed
126
        403:
Duo Chen's avatar
Duo Chen committed
127
          description: "Forbidden."
Diego Molteni's avatar
Diego Molteni committed
128
        404:
Duo Chen's avatar
Duo Chen committed
129
          description: "Not found."
Diego Molteni's avatar
Diego Molteni committed
130
        409:
Duo Chen's avatar
Duo Chen committed
131
          description: "Conflict."
Diego Molteni's avatar
Diego Molteni committed
132
        423:
Duo Chen's avatar
Duo Chen committed
133
134
135
136
137
          description: "Locked. The error message contains the Reason in the form <b>[RCODE:REASON(2-char-code)TTL(sec-number)]</b>. Possible Reasons code are: <ul>
          <li>WL (Write Locked).</li>
          <li>RL (Read Locked).</li>
          <li>CL (Cannot be Locked).</li>
          <li>UL (Cannot be Unlocked).</ul>\nFor example the reason code <b>[RCODE:RL3600]</b> indicates the dataset is Read Locked with a TTL of 3600 seconds."
Diego Molteni's avatar
Diego Molteni committed
138
    get:
Duo Chen's avatar
Duo Chen committed
139
140
      summary: "Retrieve a dataset."
      description: "<ul><li>Return the dataset metadata from the seismic store.</li><li>Required roles: subproject.admin, subproject.editor, subproject.viewer</li></ul>"
Diego Molteni's avatar
Diego Molteni committed
141
142
143
144
      operationId: dataset-get
      tags:
        - Dataset
      parameters:
Duo Chen's avatar
Duo Chen committed
145
        - description: "Name of the tenant."
Diego Molteni's avatar
Diego Molteni committed
146
147
148
149
          in: path
          name: tenantid
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
150
        - description: "Name of the subproject."
Diego Molteni's avatar
Diego Molteni committed
151
152
153
154
          in: path
          name: subprojectid
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
155
        - description: "Hierarchical path of the dataset."
Diego Molteni's avatar
Diego Molteni committed
156
157
158
159
          in: query
          name: path
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
160
        - description: "Name of the dataset."
Diego Molteni's avatar
Diego Molteni committed
161
162
163
164
          in: path
          name: datasetid
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
165
        - description: "Include the seismic storage metadata record if it exists."
Diego Molteni's avatar
Diego Molteni committed
166
167
168
          in: query
          name: seismicmeta
          required: false
Diego Molteni's avatar
Diego Molteni committed
169
          type: boolean
Diego Molteni's avatar
Diego Molteni committed
170
171
      responses:
        200:
Duo Chen's avatar
Duo Chen committed
172
          description: "Metadata of the dataset."
Diego Molteni's avatar
Diego Molteni committed
173
174
175
          schema:
            $ref: "#/definitions/Dataset"
        400:
Duo Chen's avatar
Duo Chen committed
176
          description: "Bad request."
Diego Molteni's avatar
Diego Molteni committed
177
        401:
Duo Chen's avatar
Duo Chen committed
178
          description: "Unauthorized."
Diego Molteni's avatar
Diego Molteni committed
179
        403:
Duo Chen's avatar
Duo Chen committed
180
          description: "Forbidden."
Diego Molteni's avatar
Diego Molteni committed
181
        404:
Duo Chen's avatar
Duo Chen committed
182
          description: "Not found."
Diego Molteni's avatar
Diego Molteni committed
183
184

    delete:
Duo Chen's avatar
Duo Chen committed
185
186
      summary: "Delete a dataset."
      description: "<ul><li>Delete a dataset in the seismic store.</li><li>Required roles: subproject.admin, subproject.editor</li></ul>"
Diego Molteni's avatar
Diego Molteni committed
187
188
189
190
      operationId: dataset-delete
      tags:
        - Dataset
      parameters:
Duo Chen's avatar
Duo Chen committed
191
        - description: "Name of the tenant."
Diego Molteni's avatar
Diego Molteni committed
192
193
194
195
          in: path
          name: tenantid
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
196
        - description: "Name of the subproject."
Diego Molteni's avatar
Diego Molteni committed
197
198
199
200
          in: path
          name: subprojectid
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
201
        - description: "Hierarchical path of the dataset."
Diego Molteni's avatar
Diego Molteni committed
202
203
204
205
          in: query
          name: path
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
206
        - description: "Name of the dataset."
Diego Molteni's avatar
Diego Molteni committed
207
208
209
210
211
212
213
214
          in: path
          name: datasetid
          required: true
          type: string
      responses:
        200:
          description: "The resource was deleted successfully."
        400:
Duo Chen's avatar
Duo Chen committed
215
          description: "Bad request."
Diego Molteni's avatar
Diego Molteni committed
216
        401:
Duo Chen's avatar
Duo Chen committed
217
          description: "Unauthorized."
Diego Molteni's avatar
Diego Molteni committed
218
        403:
Duo Chen's avatar
Duo Chen committed
219
          description: "Forbidden."
Diego Molteni's avatar
Diego Molteni committed
220
        404:
Duo Chen's avatar
Duo Chen committed
221
          description: "Not found."
Diego Molteni's avatar
Diego Molteni committed
222
223

    patch:
Duo Chen's avatar
Duo Chen committed
224
225
226
227
228
229
      summary: "Patch the dataset metadata."
      description: "<ul>
      <li>Update the dataset meta information in the seismic store or close (unlock) the dataset. If the endpoint is used without the close parameter, at least one body field is required or the endpoint will return an error.</li>
      <li>Required roles: subproject.admin, subproject.editor</li>
      <li>Patchable fields: <ul>
      <li><b>dataset_new_name:</b> new name to use for the dataset (rename).</li>
Diego Molteni's avatar
Diego Molteni committed
230
      <li><b>filemetadata:</b> This is a seismic store specific field and describes how the physical data is stored in the cloud storage system (GCS/AzureContainer etc.). This metadata is mainly used by client libraries to correctly reconstruct the dataset. For example you can store a dataset as truncated in multiple objects of 64MB each, name them from 0 to N and save the filemetadata = “{nObject: N, totalSize: 1024, objsize: 64, sizeUnit: MB}”.</li>
Duo Chen's avatar
Duo Chen committed
231
232
233
234
235
      <li><b>last_modified_date:</b> Mark this field as true to update the dataset last modified date.</li>
      <li><b>gtags:</b> Upsert tags to an existing dataset metadata. If the dataset metadata already has gtags, then new gtags are appended to this list.</li>
      <li><b>ltag:</b> Update the existing legalTag value.</b></li>
      <li><b>readonly:</b> Update the dataset mode to readonly (true) or to read/write (false).</li>
      <li><b>seismicmeta:</b> Update the Data Ecosystem storage metadata. (Refer to the Data Ecosystem storage service tutorial for more information.)</b></li></ul></li></ul>"
Diego Molteni's avatar
Diego Molteni committed
236
237
      operationId: dataset-patch
      tags:
Diego Molteni's avatar
Diego Molteni committed
238
        - Dataset
Diego Molteni's avatar
Diego Molteni committed
239
      parameters:
Duo Chen's avatar
Duo Chen committed
240
        - description: "Name of the tenant."
Diego Molteni's avatar
Diego Molteni committed
241
242
243
244
          in: path
          name: tenantid
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
245
        - description: "Name of the subproject."
Diego Molteni's avatar
Diego Molteni committed
246
247
248
249
          in: path
          name: subprojectid
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
250
        - description: "Hierarchical path of the dataset."
Diego Molteni's avatar
Diego Molteni committed
251
252
253
254
          in: query
          name: path
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
255
        - description: "Name of the dataset."
Diego Molteni's avatar
Diego Molteni committed
256
257
258
259
260
261
262
263
264
          in: path
          name: datasetid
          required: true
          type: string
        - description: "Request body"
          in: body
          name: request body
          schema:
            $ref: "#/definitions/DatasetPatch"
Duo Chen's avatar
Duo Chen committed
265
        - description: "Non null sbit value of the dataset. Using this value here will close the dataset."
Diego Molteni's avatar
Diego Molteni committed
266
267
268
          in: query
          name: close
          required: false
Diego Molteni's avatar
Diego Molteni committed
269
          type: string
Diego Molteni's avatar
Diego Molteni committed
270
271
      responses:
        200:
Duo Chen's avatar
Duo Chen committed
272
          description: "Metadata of the patched dataset."
Diego Molteni's avatar
Diego Molteni committed
273
274
275
          schema:
            $ref: "#/definitions/Dataset"
        400:
Duo Chen's avatar
Duo Chen committed
276
          description: "Bad request."
Diego Molteni's avatar
Diego Molteni committed
277
        401:
Duo Chen's avatar
Duo Chen committed
278
          description: "Unauthorized."
Diego Molteni's avatar
Diego Molteni committed
279
        403:
Duo Chen's avatar
Duo Chen committed
280
          description: "Forbidden."
Diego Molteni's avatar
Diego Molteni committed
281
        404:
Duo Chen's avatar
Duo Chen committed
282
          description: "Not found."
Diego Molteni's avatar
Diego Molteni committed
283
        409:
Duo Chen's avatar
Duo Chen committed
284
          description: "Conflict."
Diego Molteni's avatar
Diego Molteni committed
285
        423:
Duo Chen's avatar
Duo Chen committed
286
287
288
289
290
          description: "Locked. The error message contains the Reason in the form <b>[RCODE:REASON(2-char-code)TTL(sec-number)]</b>. Possible Reasons code are: <ul>
          <li>WL (Write Locked).</li>
          <li>RL (Read Locked).</li>
          <li>CL (Cannot be Locked).</li>
          <li>UL (Cannot be Unlocked).</ul>\nFor example the reason code <b>[RCODE:RL3600]</b> indicates the dataset is Read Locked with a TTL of 3600 seconds."
Diego Molteni's avatar
Diego Molteni committed
291
292
293

  /dataset/tenant/{tenantid}/subproject/{subprojectid}/dataset/{datasetid}/lock:
    put:
Duo Chen's avatar
Duo Chen committed
294
295
296
297
298
      summary: "Acquire a lock for a dataset id."
      description: "<ul>
      <li>Open a dataset for read or write and lock its state.</li>
      <li>Required roles open lock for write: subproject.admin, subproject.editor</li>
      <li>Required roles open lock for read: subproject.admin, subproject.editor, subproject.viewer</ul>"
Diego Molteni's avatar
Diego Molteni committed
299
300
301
302
      operationId: dataset-lock
      tags:
        - Dataset
      parameters:
Duo Chen's avatar
Duo Chen committed
303
        - description: "Name of the tenant."
Diego Molteni's avatar
Diego Molteni committed
304
305
306
307
          in: path
          name: tenantid
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
308
        - description: "Name of the subproject."
Diego Molteni's avatar
Diego Molteni committed
309
310
311
312
          in: path
          name: subprojectid
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
313
        - description: "Hierarchical path of the dataset."
Diego Molteni's avatar
Diego Molteni committed
314
315
316
317
          in: query
          name: path
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
318
        - description: "Name of the dataset."
Diego Molteni's avatar
Diego Molteni committed
319
320
321
322
          in: path
          name: datasetid
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
323
        - description: "Type of the lock which can be set to 'read' (default) or 'write'."
Diego Molteni's avatar
Diego Molteni committed
324
325
326
327
          in: query
          name: openmode
          required: false
          type: string
Duo Chen's avatar
Duo Chen committed
328
        - description: "Session identifier issued for a previous write lock acquisition operation."
Diego Molteni's avatar
Diego Molteni committed
329
330
331
          in: query
          name: wid
          required: false
Diego Molteni's avatar
Diego Molteni committed
332
          type: number
Diego Molteni's avatar
Diego Molteni committed
333
334
      responses:
        200:
Duo Chen's avatar
Duo Chen committed
335
          description: "Acquired a lock and the return value is the dataset metadata with session identifier stored in the 'sbit' attribute."
Diego Molteni's avatar
Diego Molteni committed
336
337
338
          schema:
            $ref: "#/definitions/Dataset"
        400:
Duo Chen's avatar
Duo Chen committed
339
          description: "Bad request."
Diego Molteni's avatar
Diego Molteni committed
340
        401:
Duo Chen's avatar
Duo Chen committed
341
          description: "Unauthorized."
Diego Molteni's avatar
Diego Molteni committed
342
        403:
Duo Chen's avatar
Duo Chen committed
343
          description: "Forbidden."
Diego Molteni's avatar
Diego Molteni committed
344
        404:
Duo Chen's avatar
Duo Chen committed
345
          description: "Not found."
Diego Molteni's avatar
Diego Molteni committed
346
        423:
Duo Chen's avatar
Duo Chen committed
347
348
349
350
351
          description: "Locked. The error message contains the Reason in the form <b>[RCODE:REASON(2-char-code)TTL(sec-number)]</b>. Possible Reasons code are: <ul>
          <li>WL (Write Locked).</li>
          <li>RL (Read Locked).</li>
          <li>CL (Cannot be Locked).</li>
          <li>UL (Cannot be Unlocked).</ul>\nFor example the reason code <b>[RCODE:RL3600]</b> indicates the dataset is Read Locked with a TTL of 3600 seconds."
Diego Molteni's avatar
Diego Molteni committed
352
353
354
355

  /dataset/tenant/{tenantid}/subproject/{subprojectid}/dataset/{datasetid}/unlock:
    put:
      summary: "Remove the lock associated with a dataset id."
Diego Molteni's avatar
Diego Molteni committed
356
      description: "<ul><li>Removes the lock for a dataset id.</li><li>Required roles: subproject.admin</li></ul>"
Diego Molteni's avatar
Diego Molteni committed
357
358
359
360
      operationId: dataset-lock-rm
      tags:
        - Dataset
      parameters:
Duo Chen's avatar
Duo Chen committed
361
        - description: "Name of the tenant."
Diego Molteni's avatar
Diego Molteni committed
362
363
364
365
          in: path
          name: tenantid
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
366
        - description: "Name of the subproject."
Diego Molteni's avatar
Diego Molteni committed
367
368
369
370
          in: path
          name: subprojectid
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
371
        - description: "Hierarchical path for the dataset."
Diego Molteni's avatar
Diego Molteni committed
372
373
374
375
          in: query
          name: path
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
376
        - description: "Name of the dataset."
Diego Molteni's avatar
Diego Molteni committed
377
378
379
380
381
382
          in: path
          name: datasetid
          required: true
          type: string
      responses:
        200:
Duo Chen's avatar
Duo Chen committed
383
          description: "Removed the lock value associated with dataset id."
Diego Molteni's avatar
Diego Molteni committed
384
        400:
Duo Chen's avatar
Duo Chen committed
385
          description: "Bad request."
Diego Molteni's avatar
Diego Molteni committed
386
        401:
Duo Chen's avatar
Duo Chen committed
387
          description: "Unauthorized."
Diego Molteni's avatar
Diego Molteni committed
388
        403:
Duo Chen's avatar
Duo Chen committed
389
          description: "Forbidden."
Diego Molteni's avatar
Diego Molteni committed
390
        404:
Duo Chen's avatar
Duo Chen committed
391
          description: "Not found."
Diego Molteni's avatar
Diego Molteni committed
392
        423:
Duo Chen's avatar
Duo Chen committed
393
394
395
396
397
          description: "Locked. The error message contains the Reason in the form <b>[RCODE:REASON(2-char-code)TTL(sec-number)]</b>. Possible Reasons code are: <ul>
          <li>WL (Write Locked).</li>
          <li>RL (Read Locked).</li>
          <li>CL (Cannot be Locked).</li>
          <li>UL (Cannot be Unlocked).</ul>\nFor example the reason code <b>[RCODE:RL3600]</b> indicates the dataset is Read Locked with a TTL of 3600 seconds."
Diego Molteni's avatar
Diego Molteni committed
398
399
400
401
402
403
404
405
406

  /dataset/tenant/{tenantid}/subproject/{subprojectid}/dataset/{datasetid}/permission:
    get:
      summary: "Retrieve the access permissions of a user on a dataset id."
      description: "<ul><li>Retrieve the access permission of a user on a dataset.</li><li>Required roles: subproject.admin, subproject.editor, subproject.viewer</li></ul>"
      operationId: dataset-permission
      tags:
        - Dataset
      parameters:
Duo Chen's avatar
Duo Chen committed
407
        - description: "Name of the tenant."
Diego Molteni's avatar
Diego Molteni committed
408
409
410
411
          in: path
          name: tenantid
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
412
        - description: "Name of the subproject."
Diego Molteni's avatar
Diego Molteni committed
413
414
415
416
          in: path
          name: subprojectid
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
417
        - description: "Hierarchical path for the dataset."
Diego Molteni's avatar
Diego Molteni committed
418
419
420
421
          in: query
          name: path
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
422
        - description: "Name of the dataset."
Diego Molteni's avatar
Diego Molteni committed
423
424
425
426
427
428
429
430
431
432
          in: path
          name: datasetid
          required: true
          type: string
      responses:
        200:
          description: "User access permission on the dataset."
          schema:
            $ref: "#/definitions/DatasetPermission"
        400:
Duo Chen's avatar
Duo Chen committed
433
          description: "Bad request."
Diego Molteni's avatar
Diego Molteni committed
434
        401:
Duo Chen's avatar
Duo Chen committed
435
          description: "Unauthorized."
Diego Molteni's avatar
Diego Molteni committed
436
        403:
Duo Chen's avatar
Duo Chen committed
437
          description: "Forbidden."
Diego Molteni's avatar
Diego Molteni committed
438
        404:
Duo Chen's avatar
Duo Chen committed
439
          description: "Not found."
Diego Molteni's avatar
Diego Molteni committed
440
441
442

  /dataset/tenant/{tenantid}/subproject/{subprojectid}/dataset/{datasetid}/ctagcheck:
    get:
Diego Molteni's avatar
Diego Molteni committed
443
444
      summary: "Validate if a dataset ctag matches the pre-existing ctag in metadata catalog."
      description: "<ul><li>Check if the provided dataset cTag match the one stored in the metadata catalog.</li><li>Required roles: subproject.admin, subproject.editor, subproject.viewer</li></ul>"
Diego Molteni's avatar
Diego Molteni committed
445
446
447
448
      operationId: ctag-check
      tags:
        - Dataset
      parameters:
Duo Chen's avatar
Duo Chen committed
449
        - description: "Name of the tenant."
Diego Molteni's avatar
Diego Molteni committed
450
451
452
453
          in: path
          name: tenantid
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
454
        - description: "Name of the subproject."
Diego Molteni's avatar
Diego Molteni committed
455
456
457
458
          in: path
          name: subprojectid
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
459
        - description: "Hierarchical path of the dataset."
Diego Molteni's avatar
Diego Molteni committed
460
461
462
463
          in: query
          name: path
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
464
        - description: "Name of the dataset."
Diego Molteni's avatar
Diego Molteni committed
465
466
467
468
          in: path
          name: datasetid
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
469
        - description: "Ctag to be validated."
Diego Molteni's avatar
Diego Molteni committed
470
471
472
473
474
475
          in: query
          name: ctag
          required: true
          type: string
      responses:
        200:
Duo Chen's avatar
Duo Chen committed
476
          description: "Return true if the ctag is valid or false if it is invalid."
Diego Molteni's avatar
Diego Molteni committed
477
478
          schema:
            type: boolean
Diego Molteni's avatar
Diego Molteni committed
479
            example: "true"
Diego Molteni's avatar
Diego Molteni committed
480
        400:
Duo Chen's avatar
Duo Chen committed
481
          description: "Bad request."
Diego Molteni's avatar
Diego Molteni committed
482
        401:
Duo Chen's avatar
Duo Chen committed
483
          description: "Unauthorized."
Diego Molteni's avatar
Diego Molteni committed
484
        403:
Duo Chen's avatar
Duo Chen committed
485
          description: "Forbidden."
Diego Molteni's avatar
Diego Molteni committed
486
        404:
Duo Chen's avatar
Duo Chen committed
487
          description: "Not found."
Diego Molteni's avatar
Diego Molteni committed
488
489
490

  /dataset/tenant/{tenantid}/subproject/{subprojectid}/dataset/{datasetid}/gtags:
    put:
Duo Chen's avatar
Duo Chen committed
491
492
493
494
      summary: "Upsert tags to a dataset."
      description: "<ul>
      <li>Upsert tags to an existing dataset metadata. If the dataset metadata already has gtags, then  new gtags are appended to this list.</li>
      <li>Required roles: subproject.admin, subproject.editor</li></ul>"
Diego Molteni's avatar
Diego Molteni committed
495
496
497
498
      operationId: add-tag
      tags:
        - Dataset
      parameters:
Duo Chen's avatar
Duo Chen committed
499
        - description: "Name of the tenant."
Diego Molteni's avatar
Diego Molteni committed
500
501
502
503
          in: path
          name: tenantid
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
504
        - description: "Name of the subproject."
Diego Molteni's avatar
Diego Molteni committed
505
506
507
508
          in: path
          name: subprojectid
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
509
        - description: "Hierarchical path of the dataset."
Diego Molteni's avatar
Diego Molteni committed
510
511
512
513
          in: query
          name: path
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
514
        - description: "Name of the dataset."
Diego Molteni's avatar
Diego Molteni committed
515
516
517
518
          in: path
          name: datasetid
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
519
        - description: "Gtags array list."
Diego Molteni's avatar
Diego Molteni committed
520
          in: query
Diego Molteni's avatar
Diego Molteni committed
521
          name: gtag
Diego Molteni's avatar
Diego Molteni committed
522
523
524
525
526
527
528
529
530
531
          required: true
          type: array
          items:
            type: string
            default: "tag1"
          collectionFormat: multi
      responses:
        200:
          description: "Gtags were upserted to the dataset metadata."
        400:
Duo Chen's avatar
Duo Chen committed
532
          description: "Bad request."
Diego Molteni's avatar
Diego Molteni committed
533
        401:
Duo Chen's avatar
Duo Chen committed
534
          description: "Unauthorized."
Diego Molteni's avatar
Diego Molteni committed
535
        403:
Duo Chen's avatar
Duo Chen committed
536
          description: "Forbidden."
Diego Molteni's avatar
Diego Molteni committed
537
        404:
Duo Chen's avatar
Duo Chen committed
538
          description: "Not found."
Diego Molteni's avatar
Diego Molteni committed
539
540

  # To deprecate in favor of /utility/ls
Diego Molteni's avatar
Diego Molteni committed
541
542
  /dataset/tenant/{tenantid}/subproject/{subprojectid}/readdsdirfulllist:
    get:
Duo Chen's avatar
Duo Chen committed
543
544
545
546
      summary: "Content list."
      description: "<ul>
      <li>List datasets and sub-directories for a directory path.</li>
      <li>Required roles: subproject.admin, subproject.editor, subproject.viewer</li></ul>"
Diego Molteni's avatar
Diego Molteni committed
547
548
549
550
      operationId: dataset-read-directory
      tags:
        - Dataset
      parameters:
Duo Chen's avatar
Duo Chen committed
551
        - description: "The tenant project name."
Diego Molteni's avatar
Diego Molteni committed
552
553
554
555
          in: path
          name: tenantid
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
556
        - description: "The sub-project name."
Diego Molteni's avatar
Diego Molteni committed
557
558
559
560
          in: path
          name: subprojectid
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
561
        - description: "The hierarchy path."
Diego Molteni's avatar
Diego Molteni committed
562
563
564
565
566
567
568
569
570
          in: query
          name: path
          required: true
          type: string
      responses:
        200:
          description: "The list of datasets and directories in the requested directory path."
          schema:
            $ref: "#/definitions/DatasetAndDirectories"
Diego Molteni's avatar
Diego Molteni committed
571
572
573
574

  /dataset/tenant/{tenantid}/subproject/{subprojectid}:
    get:
      summary: "Get the list of datasets in a subproject."
Duo Chen's avatar
Duo Chen committed
575
576
577
      description: "<ul>
      <li>Return the list of datasets in a sub-project. If gtags are in the request parameters, then get only those datasets that have the exact list of gtags.</li>
      <li>Required roles: subproject.admin, subproject.editor, subproject.viewer</li></ul>"
Diego Molteni's avatar
Diego Molteni committed
578
579
      operationId: dataset-list
      tags:
Diego Molteni's avatar
Diego Molteni committed
580
        - Dataset
Diego Molteni's avatar
Diego Molteni committed
581
      parameters:
Duo Chen's avatar
Duo Chen committed
582
        - description: "Name of the tenant."
Diego Molteni's avatar
Diego Molteni committed
583
584
585
586
          in: path
          name: tenantid
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
587
        - description: "Name of the subproject."
Diego Molteni's avatar
Diego Molteni committed
588
589
590
591
          in: path
          name: subprojectid
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
592
        - description: "Gtags associated with dataset metadata."
Diego Molteni's avatar
Diego Molteni committed
593
594
595
          in: query
          name: gtag
          type: array
Diego Molteni's avatar
Diego Molteni committed
596
          items:
Diego Molteni's avatar
Diego Molteni committed
597
598
599
600
601
            type: string
          collectionFormat: multi

      responses:
        200:
Duo Chen's avatar
Duo Chen committed
602
          description: "The list of all datasets in the subproject if no gtags are in the request parameters. If gtags exist in the request parameters, then list all datasets that have the same list of gtags."
Diego Molteni's avatar
Diego Molteni committed
603
604
605
606
607
          schema:
            type: array
            items:
              $ref: "#/definitions/Dataset"
        400:
Duo Chen's avatar
Duo Chen committed
608
          description: "Bad request."
Diego Molteni's avatar
Diego Molteni committed
609
        401:
Duo Chen's avatar
Duo Chen committed
610
          description: "Unauthorized."
Diego Molteni's avatar
Diego Molteni committed
611
        403:
Duo Chen's avatar
Duo Chen committed
612
          description: "Forbidden."
Diego Molteni's avatar
Diego Molteni committed
613
        404:
Duo Chen's avatar
Duo Chen committed
614
          description: "Not found."
Diego Molteni's avatar
Diego Molteni committed
615
616
617

  /dataset/tenant/{tenantid}/subproject/{subprojectid}/exist:
    post:
Duo Chen's avatar
Duo Chen committed
618
619
620
621
      summary: "Check to see if a list of datasets exists in the subproject."
      description: "<ul>
      <li>Check if the dataset exists.</li>
      <li>Required roles: subproject.admin, subproject.editor, subproject.viewer</li></ul>"
Diego Molteni's avatar
Diego Molteni committed
622
623
      operationId: dataset-exist
      tags:
Diego Molteni's avatar
Diego Molteni committed
624
        - Dataset
Diego Molteni's avatar
Diego Molteni committed
625
      parameters:
Duo Chen's avatar
Duo Chen committed
626
        - description: "Name of the tenant."
Diego Molteni's avatar
Diego Molteni committed
627
628
629
630
          in: path
          name: tenantid
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
631
        - description: "Name of the subproject."
Diego Molteni's avatar
Diego Molteni committed
632
633
634
635
636
637
638
639
640
          in: path
          name: subprojectid
          required: true
          type: string
        - description: "Request body"
          in: body
          name: request body
          required: true
          schema:
Diego Molteni's avatar
Diego Molteni committed
641
            $ref: "#/definitions/DatasetCheckList"
Diego Molteni's avatar
Diego Molteni committed
642
643
      responses:
        200:
Duo Chen's avatar
Duo Chen committed
644
          description: "A list of Boolean values for all the input datasets in the request body. If a value is true, then the corresponding dataset exists and if it is false, then the dataset does not exist."
Diego Molteni's avatar
Diego Molteni committed
645
646
647
648
649
650
          schema:
            type: array
            items:
              type: boolean
            example: [true, false]
        400:
Duo Chen's avatar
Duo Chen committed
651
          description: "Bad request."
Diego Molteni's avatar
Diego Molteni committed
652
        401:
Duo Chen's avatar
Duo Chen committed
653
          description: "Unauthorized."
Diego Molteni's avatar
Diego Molteni committed
654
        403:
Duo Chen's avatar
Duo Chen committed
655
          description: "Forbidden."
Diego Molteni's avatar
Diego Molteni committed
656
        404:
Duo Chen's avatar
Duo Chen committed
657
          description: "Not found."
Diego Molteni's avatar
Diego Molteni committed
658
659
660

  /dataset/tenant/{tenantid}/subproject/{subprojectid}/sizes:
    post:
Duo Chen's avatar
Duo Chen committed
661
662
663
664
      summary: "Retrieve the size of datasets."
      description: "<ul>
      <li>Return a list with the sizes of the requested datasets.</li>
      <li>Required roles: subproject.admin, subproject.editor, subproject.viewer</li></ul>"
Diego Molteni's avatar
Diego Molteni committed
665
666
667
668
      operationId: dataset-sizes
      tags:
        - Dataset
      parameters:
Duo Chen's avatar
Duo Chen committed
669
        - description: "Name of the tenant."
Diego Molteni's avatar
Diego Molteni committed
670
671
672
673
          in: path
          name: tenantid
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
674
        - description: "Name of the subproject."
Diego Molteni's avatar
Diego Molteni committed
675
676
677
678
679
680
681
682
683
          in: path
          name: subprojectid
          required: true
          type: string
        - description: "Request body"
          in: body
          name: request body
          required: true
          schema:
Diego Molteni's avatar
Diego Molteni committed
684
            $ref: "#/definitions/DatasetCheckList"
Diego Molteni's avatar
Diego Molteni committed
685
686
      responses:
        200:
Duo Chen's avatar
Duo Chen committed
687
          description: "The list of sizes of all the datasets. If the dataset does not exist, the size returns -1."
Diego Molteni's avatar
Diego Molteni committed
688
689
690
691
692
693
          schema:
            type: array
            items:
              type: number
            example: [1024, -1]
        400:
Duo Chen's avatar
Duo Chen committed
694
          description: "Bad request."
Diego Molteni's avatar
Diego Molteni committed
695
        401:
Duo Chen's avatar
Duo Chen committed
696
          description: "Unauthorized."
Diego Molteni's avatar
Diego Molteni committed
697
        403:
Duo Chen's avatar
Duo Chen committed
698
          description: "Forbidden."
Diego Molteni's avatar
Diego Molteni committed
699
        404:
Duo Chen's avatar
Duo Chen committed
700
          description: "Not found."
Diego Molteni's avatar
Diego Molteni committed
701
702
703

  /utility/ls:
    get:
Duo Chen's avatar
Duo Chen committed
704
705
706
707
      summary: "Retrieve the list of datasets and sub-directories inside a seismic store path."
      description: "<ul>
      <li>Return the list of datasets and sub-directories of a seismic store path.</li>
      <li>Required roles: subproject.admin, subproject.editor, subproject.viewer</li></ul>"
Diego Molteni's avatar
Diego Molteni committed
708
709
      operationId: ls
      tags:
Diego Molteni's avatar
Diego Molteni committed
710
        - Utility
Diego Molteni's avatar
Diego Molteni committed
711
      parameters:
Duo Chen's avatar
Duo Chen committed
712
        - description: "Seismic store path, sd://tenant/sub-project/path."
Diego Molteni's avatar
Diego Molteni committed
713
714
715
716
717
          in: query
          name: sdpath
          required: true
          type: string
          default: sd://common/carbon/a/b/c
Duo Chen's avatar
Duo Chen committed
718
        - description: "Working mode, directories or datasets or undefined for both."
Diego Molteni's avatar
Diego Molteni committed
719
720
721
722
          in: query
          name: wmode
          required: false
          type: string
Duo Chen's avatar
Duo Chen committed
723
        - description: "Limits the total number of datasets to return."
Diego Molteni's avatar
Diego Molteni committed
724
725
726
727
          in: query
          name: limit
          required: false
          type: number
Duo Chen's avatar
Duo Chen committed
728
        - description: "Pagination token - this query parameter can be omitted on first call."
Diego Molteni's avatar
Diego Molteni committed
729
730
731
732
733
734
          in: query
          name: cursor
          required: false
          type: string
      responses:
        200:
Duo Chen's avatar
Duo Chen committed
735
          description: "Seismic store path content."
Diego Molteni's avatar
Diego Molteni committed
736
          schema:
Diego Molteni's avatar
Diego Molteni committed
737
            $ref: "#/definitions/LsDatasets"
Diego Molteni's avatar
Diego Molteni committed
738
        201:
Duo Chen's avatar
Duo Chen committed
739
          description: "Paginated seismic store path content - For documentation purposes, if limit or cursor is given, status code here is 200."
Diego Molteni's avatar
Diego Molteni committed
740
          schema:
Diego Molteni's avatar
Diego Molteni committed
741
            $ref: "#/definitions/LsPaginatedDatasets"
Diego Molteni's avatar
Diego Molteni committed
742
        400:
Duo Chen's avatar
Duo Chen committed
743
          description: "Bad request."
Diego Molteni's avatar
Diego Molteni committed
744
        401:
Duo Chen's avatar
Duo Chen committed
745
          description: "Unauthorized."
Diego Molteni's avatar
Diego Molteni committed
746
        403:
Duo Chen's avatar
Duo Chen committed
747
          description: "Forbidden."
Diego Molteni's avatar
Diego Molteni committed
748
        404:
Duo Chen's avatar
Duo Chen committed
749
          description: "Not found."
Diego Molteni's avatar
Diego Molteni committed
750
751
752

  /utility/cp:
    post:
Duo Chen's avatar
Duo Chen committed
753
754
755
756
      summary: "Copy dataset."
      description: "<ul>
      <li>Copy a seismic store dataset. The source and destination dataset must be in the same sub-project.</li>
      <li>Required roles: subproject.admin, subproject.editor</li></ul>"
Diego Molteni's avatar
Diego Molteni committed
757
758
      operationId: cp
      tags:
Diego Molteni's avatar
Diego Molteni committed
759
        - Utility
Diego Molteni's avatar
Diego Molteni committed
760
      parameters:
Duo Chen's avatar
Duo Chen committed
761
        - description: "Seismic store source dataset path."
Diego Molteni's avatar
Diego Molteni committed
762
763
764
765
          in: query
          name: sdpath_from
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
766
        - description: "Seismic store destination dataset path."
Diego Molteni's avatar
Diego Molteni committed
767
768
769
770
          in: query
          name: sdpath_to
          required: true
          type: string
Duo Chen's avatar
Duo Chen committed
771
        - description: "Lock source and destination while copying."
Diego Molteni's avatar
Diego Molteni committed
772
773
774
          in: query
          name: lock
          required: false
Diego Molteni's avatar
Diego Molteni committed
775
          type: boolean
Diego Molteni's avatar
Diego Molteni committed
776
777
      responses:
        200:
Duo Chen's avatar
Duo Chen committed
778
          description: "Copy operation succeeded."
Diego Molteni's avatar
Diego Molteni committed
779
780
781
          schema:
            type: object
        400:
Duo Chen's avatar
Duo Chen committed
782
          description: "Bad request."
Diego Molteni's avatar
Diego Molteni committed
783
        401:
Duo Chen's avatar
Duo Chen committed
784
          description: "Unauthorized."
Diego Molteni's avatar
Diego Molteni committed
785
        403:
Duo Chen's avatar
Duo Chen committed
786
          description: "Forbidden."
Diego Molteni's avatar
Diego Molteni committed
787
        404:
Duo Chen's avatar
Duo Chen committed
788
          description: "Not found."
Diego Molteni's avatar
Diego Molteni committed
789
        409:
Duo Chen's avatar
Duo Chen committed
790
          description: "Conflict."
Diego Molteni's avatar
Diego Molteni committed
791
        423:
Duo Chen's avatar
Duo Chen committed
792
793
794
795
796
          description: "Locked. The error message contains the Reason in the form <b>[RCODE:REASON(2-char-code)TTL(sec-number)]</b>. Possible Reasons code are: <ul>
          <li>WL (Write Locked)</li>
          <li>RL (Read Locked)</li>
          <li>CL (Cannot be Locked)</li>
          <li>UL (Cannot be Unlocked)</ul>\nFor example the reason code <b>[RCODE:RL3600]</b> indicates the dataset is Read Locked with a TTL of 3600 seconds."
Diego Molteni's avatar
Diego Molteni committed
797
798
799

  /utility/gcs-access-token:
    get:
Duo Chen's avatar
Duo Chen committed
800
      summary: "Generate a GCS access token."
Diego Molteni's avatar
Diego Molteni committed
801
      description: "<ul><li>Generate a GCS access token for a specified seismic store resource. The source and destination dataset must be in the same sub-project.</li><li>Required roles: subproject.admin, subproject.editor, subproject.viewer</li></ul>"
Diego Molteni's avatar
Diego Molteni committed
802
803
      operationId: gcs-access-token
      tags:
Diego Molteni's avatar
Diego Molteni committed
804
        - Utility
Diego Molteni's avatar
Diego Molteni committed
805
      parameters:
Duo Chen's avatar
Duo Chen committed
806
        - description: "Seismic store path in the format sd://tenant/sub-project."
Diego Molteni's avatar
Diego Molteni committed
807
808
809
810
811
          in: query
          name: sdpath
          type: string
          required: true
          default: sd://common/carbon
Duo Chen's avatar
Duo Chen committed
812
        - description: "Readonly access, true(default) or false."
Diego Molteni's avatar
Diego Molteni committed
813
814
815
          in: query
          name: readonly
          type: boolean
Diego Molteni's avatar
Diego Molteni committed
816
817
      responses:
        200:
Duo Chen's avatar
Duo Chen committed
818
          description: "The GCS access token."
Diego Molteni's avatar
Diego Molteni committed
819
          schema:
Diego Molteni's avatar
Diego Molteni committed
820
            $ref: "#/definitions/AccessToken"
Diego Molteni's avatar
Diego Molteni committed
821
        400:
Duo Chen's avatar
Duo Chen committed
822
          description: "Bad request."
Diego Molteni's avatar
Diego Molteni committed
823
        401:
Duo Chen's avatar
Duo Chen committed
824
          description: "Unauthorized."
Diego Molteni's avatar
Diego Molteni committed
825
        403:
Duo Chen's avatar
Duo Chen committed
826
          description: "Forbidden."
Diego Molteni's avatar
Diego Molteni committed
827
        404:
Duo Chen's avatar
Duo Chen committed
828
          description: "Not found."
Diego Molteni's avatar
Diego Molteni committed
829

Diego Molteni's avatar
Diego Molteni committed
830
831
  /imptoken:
    post:
Duo Chen's avatar
Duo Chen committed
832
833
834
835
      summary: "Generate impersonation credentials token."
      description: "<ul>
      <li>Generate an impersonation credential token of a user for a set of subproject resources.</li>
      <li>Required roles: app.trusted</li></ul>"
Diego Molteni's avatar
Diego Molteni committed
836
837
      operationId: imp-token
      tags:
Diego Molteni's avatar
Diego Molteni committed
838
        - Impersonation Token (Obsolete)
Diego Molteni's avatar
Diego Molteni committed
839
840
841
842
843
844
      parameters:
        - description: "Request body"
          in: body
          name: request body
          required: true
          schema:
Diego Molteni's avatar
Diego Molteni committed
845
            $ref: "#/definitions/ImpersonationToken"
Diego Molteni's avatar
Diego Molteni committed
846
847
      responses:
        200:
Duo Chen's avatar
Duo Chen committed
848
          description: "Generated a impersonation credentials token successfully."
Diego Molteni's avatar
Diego Molteni committed
849
          schema:
Diego Molteni's avatar
Diego Molteni committed
850
            $ref: "#/definitions/ImpersonationToken"
Diego Molteni's avatar
Diego Molteni committed
851
        400:
Duo Chen's avatar
Duo Chen committed
852
          description: "Bad request."
Diego Molteni's avatar
Diego Molteni committed
853
        401:
Duo Chen's avatar
Duo Chen committed
854
          description: "Unauthorized."
Diego Molteni's avatar
Diego Molteni committed
855
        403:
Duo Chen's avatar
Duo Chen committed
856
          description: "Forbidden."
Diego Molteni's avatar
Diego Molteni committed
857
        404:
Duo Chen's avatar
Duo Chen committed
858
          description: "Not found."
Diego Molteni's avatar
Diego Molteni committed
859

Diego Molteni's avatar
Diego Molteni committed
860
    put:
Duo Chen's avatar
Duo Chen committed
861
      summary: "Refresh an impersonation credential token."
Diego Molteni's avatar
Diego Molteni committed
862
863
864
865
866
      description: "<ul><li>Refresh an impersonation credential token.</li><li>Required roles: none</li></ul>"
      security:
        - api-key: []
      operationId: imp-token-refresh
      tags:
Diego Molteni's avatar
Diego Molteni committed
867
        - Impersonation Token (Obsolete)
Diego Molteni's avatar
Diego Molteni committed
868
869
870
871
872
873
874
875
876
      parameters:
        - description: "Request body"
          in: body
          name: request body
          required: true
          schema:
            $ref: "#/definitions/RefreshTokenRequest"
      responses:
        200:
Duo Chen's avatar
Duo Chen committed
877
          description: "Refreshed impersonation credential token successfully."
Diego Molteni's avatar
Diego Molteni committed
878
          schema:
Diego Molteni's avatar
Diego Molteni committed
879
            $ref: "#/definitions/ImpersonationToken"
Diego Molteni's avatar
Diego Molteni committed
880
        400:
Duo Chen's avatar
Duo Chen committed
881
          description: "Bad request."
Diego Molteni's avatar
Diego Molteni committed
882
        401:
Duo Chen's avatar
Duo Chen committed
883
          description: "Unauthorized."
Diego Molteni's avatar
Diego Molteni committed
884
        403:
Duo Chen's avatar
Duo Chen committed
885
          description: "Forbidden."
Diego Molteni's avatar
Diego Molteni committed
886
        404:
Duo Chen's avatar
Duo Chen committed
887
          description: "Not found."
Diego Molteni's avatar
Diego Molteni committed
888

Diego Molteni's avatar
Diego Molteni committed
889
    patch:
Duo Chen's avatar
Duo Chen committed
890
891
892
893
      summary: "Patch an impersonation credential token's refresh url and generate a new impersonation token."
      description: "<ul>
      <li>Patch an impersonation credential token's refresh url and generate a new impersonation token.</li>
      <li>Required roles: none</li></ul>"
Diego Molteni's avatar
Diego Molteni committed
894
895
      operationId: imp-token-patch
      tags:
Diego Molteni's avatar
Diego Molteni committed
896
        - Impersonation Token (Obsolete)
Diego Molteni's avatar
Diego Molteni committed
897
898
899
900
901
902
903
904
905
      parameters:
        - description: "Request body"
          in: body
          name: request body
          required: true
          schema:
            $ref: "#/definitions/ImpTokenPatchRequest"
      responses:
        200:
Duo Chen's avatar
Duo Chen committed
906
          description: "Generated impersonation token successfully and its refresh url is updated."
Diego Molteni's avatar
Diego Molteni committed
907
          schema:
Diego Molteni's avatar
Diego Molteni committed
908
909
910
911
912
913
914
915
916
917
918
919
920