Newer
Older
swagger: '2.0'
info:
description: APIs to help with legal data governance in the Data Lake.
version: 0.1.0
title: Legal data governance APIs
contact:
name: OSDU DPS team
email: dps@[OSDU].org
host: legal-osdu-services.appspot.com
x-google-allow: all
x-google-endpoints:
- name: legal-osdu-services.appspot.com
allowCors: 'true'
basePath: /api/legal/v1
security:
- Bearer: []
- google_id_token: []
- sauth_id_token: []
tags:
- name: LegalTag
description: ''
- name: info
description: "Version info endpoint"
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
schemes:
- https
consumes:
- application/json
produces:
- application/json
paths:
'/legaltags:properties':
get:
tags:
- LegalTag
summary: Gets LegalTag property values.
description: This allows for the retrieval of allowed values for LegalTag properties.
operationId: getLegalTagProperties
consumes:
- application/json
produces:
- application/json
parameters:
- name: OSDU-Account-Id
in: header
description: Users account e.g. OSDU
required: true
type: string
- name: OSDU-On-Behalf-Of
in: header
description: User's email or auth token
required: false
type: string
responses:
'200':
description: Retrieved proeprties successfully.
schema:
$ref: '#/definitions/ReadablePropertyValues'
'401':
description: You do not have permissions to access this API.
security:
- Bearer: []
- google_id_token: []
- sauth_id_token: []
'/legaltags:validate':
post:
tags:
- LegalTag
summary: Retrieves the invalid LegalTag names with reasons for the given names.
description: This allows for the retrieval of the reason why your LegalTag is not valid. A maximum of 25 can be retrieved at once.
operationId: validateLegalTags
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
required: false
schema:
$ref: '#/definitions/RequestLegalTags'
- name: OSDU-Account-Id
in: header
description: Users account e.g. OSDU
required: true
type: string
- name: OSDU-On-Behalf-Of
in: header
description: User's email or auth token
required: false
type: string
responses:
'200':
description: Retrieved LegalTag names with reason successfully.
schema:
$ref: '#/definitions/InvalidTagsWithReason'
'400':
description: Invalid parameters were given on request.
'401':
description: You do not have permissions to access this API.
'404':
description: LegalTag names were not found.
security:
- Bearer: []
- google_id_token: []
- sauth_id_token: []
'/legaltags:batchRetrieve':
post:
tags:
- LegalTag
summary: Retrieves the LegalTags for the given names.
description: This allows for the retrieval of your LegalTags using the 'name' associated with it. A maximum of 25 can be retrieved at once.
operationId: getLegalTags
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
required: false
schema:
$ref: '#/definitions/RequestLegalTags'
- name: OSDU-Account-Id
in: header
description: Users account e.g. OSDU
required: true
type: string
- name: OSDU-On-Behalf-Of
in: header
description: User's email or auth token
required: false
type: string
responses:
'200':
description: Retrieved LegalTags successfully.
schema:
$ref: '#/definitions/LegalTagDtos'
'400':
description: Invalid parameters were given on request.
'401':
description: You do not have permissions to access this API.
'404':
description: One or more requested LegalTags were not found.
security:
- Bearer: []
- google_id_token: []
- sauth_id_token: []
/legaltags:
get:
tags:
- LegalTag
summary: Gets all LegalTags.
description: This allows for the retrieval of all LegalTags.
operationId: listLegalTags
consumes:
- application/json
produces:
- application/json
parameters:
- name: valid
in: query
description: 'If true returns only valid LegalTags, if false returns only invalid LegalTags. Default value is true.'
required: false
type: boolean
default: true
- name: OSDU-Account-Id
in: header
description: Users account e.g. OSDU
required: true
type: string
- name: OSDU-On-Behalf-Of
in: header
description: User's email or auth token
required: false
type: string
responses:
'200':
description: Retrieved LegalTags successfully.
schema:
$ref: '#/definitions/LegalTagDtos'
'400':
description: Invalid parameters were given on request.
'401':
description: You do not have permissions to access this API.
security:
- Bearer: []
- google_id_token: []
- sauth_id_token: []
post:
tags:
- LegalTag
summary: Creates the LegalTag for the given 'name'.
description: This allows for the creation of your LegalTag. There can only be 1 LegalTag per 'name'. A LegalTag must be created before you can start ingesting data for that name.
operationId: createLegalTag
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
required: false
schema:
$ref: '#/definitions/LegalTagDto'
- name: OSDU-Account-Id
in: header
description: Users account e.g. OSDU
required: true
type: string
- name: OSDU-On-Behalf-Of
in: header
description: User's email or auth token
required: false
type: string
responses:
'201':
description: Created LegalTag successfully.
schema:
$ref: '#/definitions/LegalTagDto'
'400':
description: Invalid parameters were given on request.
'401':
description: You do not have permissions to access this API.
'409':
description: A LegalTag with the given name already exists.
security:
- Bearer: []
- google_id_token: []
- sauth_id_token: []
put:
tags:
- LegalTag
summary: Updates the LegalTag for the given 'name'.
description: This allows to update certain properties of your LegalTag using the 'name' associated with it.
operationId: updateLegalTag
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
name: body
required: false
schema:
$ref: '#/definitions/UpdateLegalTag'
- name: OSDU-Account-Id
in: header
description: Users account e.g. OSDU
required: true
type: string
- name: OSDU-On-Behalf-Of
in: header
description: User's email or auth token
required: false
type: string
responses:
'200':
description: Updated LegalTag successfully.
schema:
$ref: '#/definitions/LegalTagDto'
'400':
description: Invalid parameters were given on request.
'401':
description: You do not have permissions to access this API.
'404':
description: Requested LegalTag to update was not found.
security:
- Bearer: []
- google_id_token: []
- sauth_id_token: []
'/legaltags/{name}':
get:
tags:
- LegalTag
summary: Gets a LegalTag for the given 'name'.
description: This allows for the retrieval of your LegalTag using the 'name' associated with it.
operationId: getLegalTag
consumes:
- application/json
produces:
- application/json
parameters:
- name: name
in: path
required: true
type: string
x-example: OSDU-Private-USA-EHC
- name: OSDU-Account-Id
in: header
description: Users account e.g. OSDU
required: true
type: string
- name: OSDU-On-Behalf-Of
in: header
description: User's email or auth token
required: false
type: string
responses:
'200':
description: Retrieved LegalTag successfully.
schema:
$ref: '#/definitions/LegalTagDto'
'400':
description: Invalid parameters were given on request.
'401':
description: You do not have permissions to access this API.
'404':
description: Requested LegalTag was not found.
security:
- Bearer: []
- google_id_token: []
- sauth_id_token: []
/info:
get:
tags:
- info
summary: "Version info"
description: "For deployment available public `/info` endpoint, \
\ which provides build and git related information."
operationId: "Version info"
produces:
- "application/json"
responses:
200:
description: "Version info."
schema:
$ref: "#/definitions/VersionInfo"
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
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
securityDefinitions:
Bearer:
type: apiKey
name: Authorization
in: header
sauth_id_token:
authorizationUrl: 'https://opsauth-dot-osduauth-preview.appspot.com/v1/auth'
flow: implicit
type: oauth2
x-google-issuer: sauth-preview.OSDU.com
x-google-jwks_uri: 'https://opsauth-dot-osduauth-preview.appspot.com/v1/certs'
x-google-audiences: 'entitlement-osdu.OSDUservice.com,entitlement-osdu.OSDUclient.com,dev-OSDUdev-devportal.OSDUapp.com,test-OSDUdev-devportal.OSDUapp.com,discover-evd-csp-OSDU-com-dtwdev.OSDUapp.com,discover-evt-csp-OSDU-com-dtwcmz.OSDUapp.com,discover-evq-csp-OSDU-com-dtwstage.OSDUapp.com,fuse-evd-csp-OSDU-com-dtwdev.OSDUapp.com,fuse-evt-csp-OSDU-com-dtwcmz.OSDUapp.com,fuse-evq-csp-OSDU-com-dtwstage.OSDUapp.com,local-logstore.OSDUapp.com'
scopes: {}
google_id_token:
authorizationUrl: ''
flow: implicit
type: oauth2
x-google-issuer: 'https://accounts.google.com'
x-google-jwks_uri: 'https://www.googleapis.com/oauth2/v3/certs'
x-google-audiences: 245464679631-ktfdfpl147m1mjpbutl00b3cmffissgq.apps.googleusercontent.com
scopes: {}
definitions:
ReadablePropertyValues:
type: object
properties:
countriesOfOrigin:
type: object
description: The values of all the allowed Countries of Origin with the ISO Alpha 2 code and country name.
additionalProperties:
type: string
otherRelevantDataCountries:
type: object
description: The values of all the allowed Other Relevant Data Countries with the ISO Alpha 2 code and country name.
additionalProperties:
type: string
securityClassifications:
type: array
description: The values of all the allowed Security Classifications.
uniqueItems: true
items:
type: string
exportClassificationControlNumbers:
type: array
description: The name of all the allowed Export Classifications.
uniqueItems: true
items:
type: string
personalDataTypes:
type: array
description: The name of all the allowed Personal Data Type values.
uniqueItems: true
items:
type: string
description: Shows the allowed values of the fields of a LegalTag.
InvalidTagWithReason:
type: object
properties:
name:
type: string
description: The name of the LegalTag.
reason:
type: string
description: The reason the LegalTag is currently invalid.
description: Represents a single invalid LegalTag.
InvalidTagsWithReason:
type: object
properties:
invalidLegalTags:
type: array
description: A collection of invalid LegalTags.
items:
$ref: '#/definitions/InvalidTagWithReason'
description: Represents a collection invalid LegalTags.
RequestLegalTags:
type: object
required:
- names
properties:
names:
type: array
description: The name of all the LegalTags to retrieve.
items:
type: string
maxItems: 25
minItems: 1
description: The model to retrieve multiple LegalTags in batch.
LegalTagDto:
type: object
properties:
name:
type: string
example: OSDU-Private-EHCData
description: The name of the LegalTag.
description:
type: string
description: The description of the LegalTag.
properties:
$ref: '#/definitions/Properties'
description: Represents a single LegalTag.
LegalTagDtos:
type: object
properties:
legalTags:
type: array
description: A collection of complete LegalTags
items:
$ref: '#/definitions/LegalTagDto'
description: Represents a collection of LegalTags.
Properties:
type: object
required:
- contractId
- countryOfOrigin
- dataType
- exportClassification
- originator
- personalData
- securityClassification
properties:
countryOfOrigin:
type: array
example: US
description: The ISO Alpha 2 country code(s) of where the data relates to.
items:
type: string
contractId:
type: string
example: No Contract Related
description: The Id of the physical contract associated with the data being ingested.
expirationDate:
type: string
example: '2025-12-25'
description: The optional expiration date of the contract in the format YYYY-MM-DD
originator:
type: string
example: Schlumberger
description: The company who owns the data.
dataType:
type: string
example: Third Party Data
description: The type of data being ingested.
securityClassification:
type: string
example: Private
description: The security classification of the data.
personalData:
type: string
example: No Personal Data
description: Whether the data contains any personally identifiable data.
exportClassification:
type: string
example: EAR99
description: The ECCN value of the data if one applies.
description: LegalTag properties
UpdateLegalTag:
type: object
required:
- contractId
- name
properties:
name:
type: string
description: The name of the LegalTag.
contractId:
type: string
example: No Contract Related
description: The Id of the physical contract associated with the data being ingested.
description:
type: string
description: The optional description if the LegalTag to allow for easier discoverability of Legaltags overtime.
expirationDate:
type: string
example: '2025-12-25'
description: The optional expiration date of the contract in the format YYYY-MM-DD
description: The model to update an existing LegalTag
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
VersionInfo:
type: "object"
properties:
groupId:
type: "string"
description: "Maven artifact group ID."
actifactId:
type: "string"
description: "Maven artifact ID."
version:
type: "string"
description: "Maven artifact version"
buildTime:
type: "string"
description: "Maven artifact build time"
branch:
type: "string"
description: "Current git branch"
commitId:
type: "string"
description: "Latest commit hash"
commitMessage:
type: "string"
description: "Latest commit message"
connectedOuterServices:
type: "array"
description: "Connected outer services information"
items:
$ref: "#/definitions/ConnectedOuterService"
description: "Version info."
ConnectedOuterService:
type: "object"
properties:
name:
type: "string"
description: "Connected outer service name."
version:
type: "string"
description: "Connected outer service version."
description: "Connected outer service information."