/
openapi.yaml
2563 lines (2406 loc) · 88 KB
/
openapi.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
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
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
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
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
$schema: “https://spec.openapis.org/oas/3.1/dialect/base”
openapi: "3.1.0"
info:
title: HDF Scalable Data Service REST API
description: RESTful application programming interface documentation for HDF Scalable Data Service (HSDS).
contact:
name: The HDF Group
url: https://www.hdfgroup.org
email: info@hdfgroup.org
# termsOfService: TODO url
# license
# name: TODO
# url: TODO
version: "2.0"
externalDocs:
description: HSDS REST API documentation
url: "http://h5serv.readthedocs.io/en/latest/index.html"
tags:
- name: Domain
description: Operations involving the file Domain.
- name: Group
description: Operations involving Groups.
- name: Link
description: Operations involving Links.
- name: Dataset
description: Operations involving Datasets.
- name: Datatype
description: Operations involving Datatypes.
- name: Attribute
description: Operations involving Attributes.
- name: ACLS
description: Operations involving Attributes.
servers:
- url: http://hsdshdflab.hdfgroup.org
description: HSDS default server
components:
schemas:
ACL:
description: Access Control List for a single user.
type: object
properties:
username:
type: object
properties:
create:
type: boolean
update:
type: boolean
delete:
type: boolean
updateACL:
type: boolean
read:
type: boolean
readACL:
type: boolean
ACLS:
type: object
description: Access Control Lists for users.
properties:
forWhom:
$ref: "#/components/schemas/ACL"
examples:
- test_user1:
create: true
update: true
delete: true
updateACL: true
read: true
readACL: true
default:
create: false
update: false
delete: false
updateACL: false
read: true
readACL: false
parameters:
authorization:
in: header
name: Authorization
schema:
type: string
description: >
Credentials for the request.
'Basic' authorization, `"Basic " + base64(<username>:<password>)`
linkname:
in: path
name: linkname
required: true
schema:
type: string
description: >
URL-encoded name of the Link.
Label/name/title of the Link, e.g., `dset1` or `group3`.
`linkname` cannot contain slashes.
query_domain:
in: query
name: domain
schema:
type: string
description: Domain on service to access, e.g., `/home/user/someproject/somefile`.
path_group_uuid:
in: path
name: id
required: true
description: UUID of the Group, e.g. `g-37aa76f6-2c86-11e8-9391-0242ac110009`.
schema:
type: string
path_dataset_uuid:
in: path
description: UUID of the Dataset.
name: id
required: true
schema:
type: string
path_datatype_uuid:
name: id
in: path
required: true
description: UUID of the committed datatype.
schema:
type: string
securitySchemes:
basicAuth:
type: http
scheme: basic
paths:
/:
put:
tags:
- Domain
summary: Create a new Domain on the service.
description: >
Domains represent dataspaces analogous to hdf5 files.
Folders are 'placeholder' domains which lack a root Group. Their
main use is to manage top-level directories (outside of user space)
and to fill out a user's directory paths if required.
E.g., `/home/user/project/missingdir/data.h5`
Note: Initially, the only object in a Domain is the root group. Use
other `put` and `post` operations to create new objects in the
domain.
Note: Domains (and Folders) may only be created as direct children
of existing Domains. e.g., `/home/user/project/missingdir` _must_
exist prior to the creation of Domain
`/home/user/project/missingdir/data.h5`.
Note: The operation will fail if the domain already exists
(Error 409).
requestBody:
content:
application/json:
schema:
type: object
parameters:
- $ref: "#/components/parameters/query_domain"
- name: folder
in: query
schema:
type: number
description: If present and `1`, creates a Folder instead of a Domain.
- $ref: "#/components/parameters/authorization"
responses:
"201":
description: Created.
headers:
Content-Length:
description: Length of response in bytes.
schema:
type: string
Etag:
description: Hash-code status of resource.
schema:
type: string
Content-Type:
description: MIME type of response.
schema:
type: string
enum:
- application/json
content:
application/json:
schema:
type: object
properties:
acls:
$ref: "#/components/schemas/ACLS"
created:
description: When domain was created.
type: number
examples:
- 1521482043.5271084
lastModified:
description: When object was last modified.
type: number
examples:
- 1521482043.5271084
owner:
description: Name of owner.
type: string
examples:
- "test_user1"
root:
description: ID of root group.
type: string
examples:
- "g-82da0346-2b9e-11e8-9391-0242ac110009"
default:
description: Operation unsuccessful.
get:
tags:
- Domain
summary: Get information about the requested domain.
description: >
If the domain is of class 'folder', `root` is absent from returned
JSON object.
If no domain query parameter is provided, returns:
`{"domains": [], "href": []}`
parameters:
- $ref: "#/components/parameters/query_domain"
- $ref: "#/components/parameters/authorization"
responses:
"200":
description: Operation successful.
headers:
content-length:
description: Length of response in bytes.
schema:
type: string
Etag:
description: Hash-code status of resource.
schema:
type: string
Content-Type:
description: MIME type of response -- always 'application/json'
schema:
type: string
enum:
- application/json
content:
application/json:
schema:
type: object
properties:
root:
description: >
UUID of root Group.
If Domain is of class 'folder', this entry is not present.
type: string
examples:
- "g-82da0346-2b9e-11e8-9391-0242ac110009"
owner:
type: string
examples:
- "test_user1"
class:
description: >
Category of Domain.
If 'folder' no root group is included in response.
type: string
enum:
- domain
- folder
examples:
- domain
created:
type: number
examples:
- 1521476710.039304
lastModified:
type: number
examples:
- 1521476710.039304
hrefs:
description: >
Array of url references and their relation to this Domain.
Should include entries for:
`acls`,
`database` (if not class is not `folder`),
`groupbase` (if not class is not `folder`),
`parent`,
`root` (if not class is not `folder`),
`self`,
`typebase` (if not class is not `folder`).
type: array
items:
type: object
properties:
href:
description: URL to reference.
type: string
rel:
description: Relation to this Domain.
type: string
examples:
- rel: acls
href: "http://myfile.test_user1.home/acls"
- rel: database
href: "http://myfile.test_user1.home/datasets"
- rel: groupbase
href: "http://myfile.test_user1.home/groups"
- rel: parent
href: "http://myfile.test_user1.home/?domain=/home/test_user1"
- rel: root
href: "http://myfile.test_user1.home/groups/g-17d88042-2b92-11e8-9391-0242ac110009"
- rel: self
href: "http://myfile.test_user1.home/"
- rel: typebase
href: "http://myfile.test_user1.home/datatypes/"
default:
description: Operation unsuccessful.
delete:
tags:
- Domain
summary: Delete the specified Domain or Folder.
description: >
Delete the domain and all associated groups, datasets, attributes,
etc.
Note: if there are Domains which are children of this Domain
(e.g., deleting `somedir` from `/home/user/project/somedir/data.h5`),
those children directories will _not_ be deleted.
(TODO: abandoned children is incorrect behavior?)
parameters:
- $ref: "#/components/parameters/query_domain"
- $ref: "#/components/parameters/authorization"
responses:
"200":
description: Operation successful.
headers:
content-length:
description: Length of response in bytes.
schema:
type: string
Etag:
description: Hash-code status of resource.
schema:
type: string
Content-Type:
description: MIME type of response -- always 'application/json'
schema:
type: string
enum:
- application/json
content:
application/json:
schema:
type: object
description: The Domain or Folder which was deleted.
properties:
domain:
type: string
description: domain path
examples:
- "/home/test_user/some_path/some_file"
default:
description: Operation unsuccessful.
# end '/'
/groups:
post:
tags:
- Domain
- Group
summary: Create a new Group.
description: >
Create a new Group in the given Domain.
By default, the new Group it not attached to any other object in the
Domain; it is left to the user or application to appropriately attach
the new Group, i.e., Link to.
A link description may be supplied in the request body as
structured JSON, which will immediately link the new Group. If
supplying link info, the header `Content-Type: application/json`
should also be supplied as a matter of course. Note that this
link will be a hard link -- it refers directly to the object.
parameters:
- $ref: "#/components/parameters/query_domain"
- $ref: "#/components/parameters/authorization"
requestBody:
content:
application/json:
schema:
type: object
properties:
link:
description: >
Optional JSON object to immediately create a hard Link to
the newly-created object. If present, both `id` and `name`
must be supplied and `id` must be the UUID of an existing
Group -- UUID of any non-Group object will result in an
error.
Note that the id reference is _reverse_ the usual for Link
creation: the `id` value refers to the targeting object,
not the target object of the link.
type: object
required:
- id
- name
properties:
id:
description: "UUID of Group to link from."
type: string
examples:
- "g-a613ed48-2c86-11e8-9391-0242ac110009"
name:
description: Title of Link.
type: string
examples:
- "g2"
responses:
"201":
description: New Group created.
headers:
content-length:
description: Length of response in bytes.
schema:
type: string
Etag:
description: Hash-code status of resource.
schema:
type: string
content:
application/json:
schema:
type: object
properties:
id:
description: UUID of new Group.
type: string
examples:
- "g-a613ed48-2c86-11e8-9391-0242ac110009"
root:
description: UUID of root Group in Domain.
type: string
examples:
- "g-37aa76f6-2c86-11e8-9391-0242ac110009"
lastModified:
type: number
examples:
- 1521581745.9365487
created:
type: number
examples:
- 1521581745.9365487
attributeCount:
type: number
examples:
- 0
linkCount:
type: number
examples:
- 0
default:
description: Operation unsuccessful.
get:
tags:
- Domain
- Group
summary: Get UUIDs for all non-root Groups in Domain.
description: >
Listed Group(s) must be reachable via hard Link from root Group,
either directly or indirectly. If Groups exist which are unlinked or
not reachable by tree originating at root, they will not be included
in the list.
If there is any hard Link in the tree to a Group which has been
deleted, the request will fail with error 410 (GONE).
parameters:
- $ref: "#/components/parameters/query_domain"
- $ref: "#/components/parameters/authorization"
responses:
"200":
description: OK
headers:
content-length:
description: Length of response in bytes.
schema:
type: string
Etag:
description: Hash-code status of resource.
schema:
type: string
Content-Type:
description: MIME type of response -- always 'application/json'
schema:
type: string
content:
application/json:
schema:
type: object
properties:
groups:
type: array
items:
description: UUID of each Group.
type: string
examples:
- "g-a613ed48-2c86-11e8-9391-0242ac110009"
- "g-37aa76f6-2c86-11e8-9391-0242ac110009"
hrefs:
type: array
items:
description: >
References to other objects.
Must contain references for only:
`attributes`,
`home`,
`links`,
`root`,
`self`.
type: object
properties:
href:
description: URL reference.
type: string
rel:
description: Relation to this object.
type: string
examples:
- rel: "attributes"
href: "http://localhost:5101/groups/g-ee2f6a2c-3847-11e8-a123-0242ac110009/attributes?domain=/home/test_user1/file"
- rel: "home"
href: "http://localhost:5101/?domain=/home/test_user1/file"
- rel: "links"
href: "http://localhost:5101/groups/g-ee2f6a2c-3847-11e8-a123-0242ac110009/links?domain=/home/test_user1/file"
- rel: "root"
href: "http://localhost:5101/groups/g-ed14d712-3847-11e8-a123-0242ac110009?domain=/home/test_user1/file"
- rel: "self"
href: "http://localhost:5101/groups/g-ee2f6a2c-3847-11e8-a123-0242ac110009?domain=/home/test_user1/file"
default:
description: Operation unsuccessful.
# end '/groups/'
/groups/{id}:
get:
tags:
- Group
summary: Get information about a Group.
parameters:
- $ref: "#/components/parameters/path_group_uuid"
- $ref: "#/components/parameters/query_domain"
- $ref: "#/components/parameters/authorization"
- name: getalias
in: query
schema:
type: integer
enum:
- 0
- 1
description: >
Optional body content, gets the alias (path name(s) from root) of
the group as part of the response. Only includes paths as reached
via _hard_ Links.
If present, must be either `0` (no alias list) or `1` (alias list).
responses:
"200":
description: OK
headers:
content-length:
description: Length of response in bytes.
schema:
type: string
Etag:
description: Hash-code status of resource.
schema:
type: string
Content-Type:
description: MIME type of response -- always 'application/json'
schema:
type: string
content:
application/json:
schema:
type: object
properties:
id:
description: UUID of this Group.
type: string
examples:
- g-37aa76f6-2c86-11e8-9391-0242ac110009
root:
description: UUID of root Group.
type: string
examples:
- g-37aa76f6-2c86-11e8-9391-0242ac110009
alias:
description: >
List of aliases for the Group, as reached by _hard_ Links.
If Group is unlinked, its alias list will be empty (`[]`).
Only present if `alias=1` is present as query parameter.
type: array
items:
type: string
examples:
- ["/g1/g1.1"]
created:
type: number
examples:
- 1521581560.6883142
lastModified:
type: number
examples:
- 1521644498.984212
domain:
type: string
examples:
- "/home/test_user1/file"
attributeCount:
type: number
examples:
- 4
linkCount:
type: number
examples:
- 2
hrefs:
description: List of references to other objects.
type: array
items:
description: >
References to other objects.
Must contain references for only:
`attributes`,
`home`,
`links`,
`root`,
`self`.
type: object
properties:
rel:
description: Relation to this object.
type: string
examples:
- "self"
href:
description: URL to reference.
type: string
examples:
- "http://myfile.test_user1.home/"
examples:
- rel: "attributes"
href: "http://localhost:5101/groups/g-37aa76f6-2c86-11e8-9391-0242ac110009/attributes?domain=/home/test_user1/file"
- rel: "home"
href: "http://localhost:5101/?domain=/home/test_user1/file"
- rel: "links"
href: "http://localhost:5101/groups/g-37aa76f6-2c86-11e8-9391-0242ac110009/links?domain=/home/test_user1/file"
- rel: "root"
href: "http://localhost:5101/groups/g-37aa76f6-2c86-11e8-9391-0242ac110009?domain=/home/test_user1/file"
- rel: "self"
href: "http://localhost:5101/groups/g-37aa76f6-2c86-11e8-9391-0242ac110009?domain=/home/test_user1/file"
default:
description: Operation unsuccessful.
delete:
tags:
- Group
summary: Delete a Group.
description: >
TODO: Will delete attributes of the Group.
Will _not_ delete: (TODO: extensive tests to verify)
+ Objects (Groups, Types, Datasets) this object linked to
+ Links to this Group
If a group is deleted while still hard-Linked, it will result in all
`GET /groups` requests to fail with error 410 (GONE) until all Links to
the deleted Group are also deleted.
parameters:
- $ref: "#/components/parameters/path_group_uuid"
- $ref: "#/components/parameters/query_domain"
- $ref: "#/components/parameters/authorization"
responses:
"200":
description: Group removed.
content:
application/json:
schema:
type: object
default:
description: Operation unsuccessful.
# end '/groups/{id}'
/groups/{id}/links:
get:
tags:
- Link
summary: List all Links in a Group.
description: >
Items in the "list" array are sorted alphanumerically by title.
parameters:
- $ref: "#/components/parameters/path_group_uuid"
- $ref: "#/components/parameters/query_domain"
- name: Limit
in: query
schema:
type: number
description: >
Cap the number of Links returned in list.
Must be an integer `N >= 0`.
May be greater than or equal to the number of Links; has no
effect in that case.
May be used in conjunction with query parameter `Marker`.
- name: Marker
in: query
schema:
type: string
description: >
Title of a Link; the first Link name to list.
If no Link exists with that title, causes an error.
May be used with query parameter `Limit`.
- $ref: "#/components/parameters/authorization"
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
properties:
links:
type: array
items:
type: object
properties:
id:
description: UUID of Link target.
type: string
examples:
- "g-a613ed48-2c86-11e8-9391-0242ac110009"
created:
type: number
examples:
- 1521644498.984212
class:
description: >
Indicate whether this Link is hard, soft, or
external.
type: string
enum:
- "H5L_TYPE_HARD"
- "H5L_TYPE_SOFT"
- "H5L_TYPE_EXTERNAL"
examples:
- "H5L_TYPE_HARD"
- "H5L_TYPE_SOFT"
- "H5L_TYPE_EXTERNAL"
title:
description: >
Name/label/title of the Link, as provided upon
creation.
type: string
examples:
- "g1"
target:
description: URL of Link target.
type: string
examples:
- "http://localhost:5101/groups/g-a613ed48-2c86-11e8-9391-0242ac110009?domain=/home/test_user1/file"
href:
description: URL to origin of Link.
type: string
examples:
- "http://localhost:5101/groups/g-37aa76f6-2c86-11e8-9391-0242ac110009/links/g1?domain=/home/test_user1/file"
collection:
description: >
What kind of object is the target. (TODO)
type: string
enum:
- "groups"
- "datasets"
# - 'datatypes' TODO
# - 'attributes' TODO
examples:
- "groups"
- "datasets"
hrefs:
type: array
description: >
List of references to other entities.
Should contain references for:
`home`,
`owner`,
`self`.
items:
type: object
properties:
rel:
description: Relation to this object.
type: string
href:
description: URL to reference.
type: string
examples:
- rel: home
href': http://localhost:5101/?domain=/home/test_user1/file
- rel: owner
href': http://localhost:5101/groups/g-cbb6b840-3849-11e8-a123-0242ac110009?domain=/home/test_user1/file
- rel: self
href': http://localhost:5101/groups/g-cbb6b840-3849-11e8-a123-0242ac110009/links?domain=/home/test_user1/file
default:
description: Operation unsuccessful.
# end '/groups/{id}/links':
/groups/{id}/links/{linkname}:
put:
tags:
- Link
summary: Create a new Link in a Group.
description: >
Link will be 'hard', 'soft', or 'external' depending on request
elements.
If `id` is provided, it will override other properties and attempt to
create a hard Link to the object with that UUID.
If `h5path` is provided, will create a symbolic link to object (if
any) at the given path -- either a soft Link within this domain if no
domain is specified, or an external Link.
If `h5domain` is provided, will create an external Link, pointing to
the object (if any) at `h5path` in domain `h5domain`.
parameters:
- $ref: "#/components/parameters/path_group_uuid"
- $ref: "#/components/parameters/linkname"
- $ref: "#/components/parameters/query_domain"
- $ref: "#/components/parameters/authorization"
requestBody:
description: >
JSON object describing the Link to create.
Requires at least one of `id` and `h5path`; if both supplied,
`id` takes priority. `h5domain` applies only if `h5path` is
present, providing the Domain for an external Link.
required: true
content:
application/json:
schema:
type: object
properties:
id:
description: >
UUID of object to link to. Creates a hard Link.
Target UUID _must_ be the UUID of an object which exists
within the Domain. Deleted, missing, or malformed UUIDs
will result in an error.
Overrides other fields.
type: string
examples:
- "g-37aa76f6-2c86-11e8-9391-0242ac110009"
h5path:
description: >
Path to an object relative to a Domain's root.
TODO: Resolves by following hard Links to groups that match
the path elements until a non-group terminal is reached.
(alias of Link?)
Creating a Link to a target that does not exist is allowed,
but must be done with caution -- results in a dangling Link.
If used, will create a soft or external Link.
type: string
examples:
- "/dset1"
h5domain:
description: >
URL of external domain.
Results in an external Link.
Requires `h5path` be present.
type: string
examples:
- "external_target.test.hdfgroup.org"
responses:
"201":
description: New Link created.
content:
application/json:
schema:
type: object
description: 'Always returns `{"hrefs": []}`.'
examples:
- hrefs: []
default:
description: Operation unsuccessful.
get:
tags:
- Link
summary: Get Link info.
description: Get information about a given Link.
parameters:
- $ref: "#/components/parameters/path_group_uuid"
- $ref: "#/components/parameters/linkname"
- $ref: "#/components/parameters/query_domain"
- $ref: "#/components/parameters/authorization"
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
properties:
lastModified:
type: number
created:
type: number
link:
type: object
properties:
id:
type: string
examples:
- "g-a613ed48-2c86-11e8-9391-0242ac110009"
title:
type: string
examples:
- "g1"
collection:
type: string
examples:
- "group"
class:
type: string
examples:
- "H5L_TYPE_HARD"
hrefs:
type: array
description: >
List of references to other entities.
Should contain references for:
`home`,
`owner`,
`self`,
`target`,
items:
type: object
properties:
href:
description: URL to reference.
type: string
rel:
description: Relation to this object.
type: string
examples:
- rel: "home"
href: "http://localhost:5101/?domain=/home/test_user1/file"
- rel: "owner"
href: "http://localhost:5101/groups/g-8822ef7a-384b-11e8-a123-0242ac110009?domain=/home/test_user1/file"
- rel: "self"
href: "http://localhost:5101/groups/g-8822ef7a-384b-11e8-a123-0242ac110009/links/g1?domain=/home/test_user1/file"
- rel: "target"
href: "http://localhost:5101/groups/g-a613ed48-2c86-11e8-9391-0242ac110009?domain=/home/test_user1/file"
default:
description: Operation unsuccessful.
delete:
tags:
- Link