Skip to content

Commit 7b0944c

Browse files
author
Aleksandar Jelenak
committed
Minor cleanup of OpenAPI document
1 parent de2c10d commit 7b0944c

File tree

1 file changed

+18
-20
lines changed

1 file changed

+18
-20
lines changed

openapi.yaml

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ servers:
4141
description: HSDS default server
4242

4343

44-
4544
components:
4645
schemas:
4746
ACL:
@@ -158,7 +157,7 @@ components:
158157

159158

160159
paths:
161-
'/':
160+
/:
162161
put:
163162
tags:
164163
- Domain
@@ -589,7 +588,7 @@ paths:
589588

590589
# end '/groups/'
591590

592-
'/groups/{id}':
591+
/groups/{id}:
593592

594593
get:
595594
tags:
@@ -737,7 +736,7 @@ paths:
737736

738737
# end '/groups/{id}'
739738

740-
'/groups/{id}/links':
739+
/groups/{id}/links:
741740

742741
get:
743742
tags:
@@ -1039,7 +1038,7 @@ paths:
10391038

10401039
# end '/groups/{id}/links/{linkname}'
10411040

1042-
'/datasets':
1041+
/datasets:
10431042

10441043
post:
10451044
tags:
@@ -1527,7 +1526,7 @@ paths:
15271526
description: Operation unsuccessful.
15281527
#end /datasets/{id}/shape
15291528

1530-
'/datasets/{id}/type':
1529+
/datasets/{id}/type:
15311530
get:
15321531
tags:
15331532
- Dataset
@@ -1907,7 +1906,7 @@ paths:
19071906

19081907
#end /datasets/{id}/value
19091908

1910-
'/datatypes':
1909+
/datatypes:
19111910

19121911
'post':
19131912
tags:
@@ -2074,14 +2073,14 @@ paths:
20742073
- Group
20752074
- Dataset
20762075
- Datatype
2077-
summary: List all Attributes attached to the given object.
2078-
description: Attributes sorted alphanumerially by name.
2076+
summary: List all Attributes attached to the HDF5 object `obj_uuid`.
2077+
description: Attributes sorted alphanumerically by name.
20792078
parameters:
20802079
- $ref: '#/components/parameters/accept_json'
20812080
- $ref: '#/components/parameters/authorization'
20822081
- name: collection
20832082
in: path
2084-
description: Collection of objects (groups, datasets, or datatypes).
2083+
description: "The collection of the HDF5 object (one of: `groups`, `datasets`, or `datatypes`)."
20852084
schema:
20862085
type: string
20872086
enum:
@@ -2168,21 +2167,20 @@ paths:
21682167
- $ref: '#/components/parameters/authorization'
21692168
- $ref: '#/components/parameters/query_domain'
21702169
- name: collection
2170+
required: true
21712171
in: path
2172-
description: Collection of object (Group, Dataset, or Datatype).
2172+
description: The collection of the HDF5 object (`groups`, `datasets`, or `datatypes`).
21732173
schema:
21742174
type: string
21752175
enum:
21762176
- groups
21772177
- datasets
21782178
- datatypes
2179-
required: true
21802179
- name: obj_uuid
21812180
in: path
2182-
description: Group/dataset/datatype UUID.
2181+
description: HDF5 object's UUID.
21832182
schema:
21842183
type: string
2185-
format: uuid
21862184
required: true
21872185
- name: attr
21882186
in: path
@@ -2191,7 +2189,7 @@ paths:
21912189
type: string
21922190
required: true
21932191
requestBody:
2194-
description: Attribute creation information.
2192+
description: Information to create a new attribute of the HDF5 object `obj_uuid`.
21952193
required: true
21962194
content:
21972195
application/json:
@@ -2332,7 +2330,7 @@ paths:
23322330

23332331
# end /acls
23342332

2335-
'/acls/{user}':
2333+
/acls/{user}:
23362334
get:
23372335
tags:
23382336
- ACLS
@@ -2443,7 +2441,7 @@ paths:
24432441

24442442
# end /acls/{user}
24452443

2446-
'/groups/{id}/acls':
2444+
/groups/{id}/acls:
24472445

24482446
get:
24492447
tags:
@@ -2484,7 +2482,7 @@ paths:
24842482

24852483
# end /groups/{id}/acls
24862484

2487-
'/groups/{id}/acls/{user}':
2485+
/groups/{id}/acls/{user}:
24882486

24892487
get:
24902488
tags:
@@ -2530,7 +2528,7 @@ paths:
25302528

25312529
# end '/groups/{id}/acls/{user}':
25322530

2533-
'/datasets/{id}/acls':
2531+
/datasets/{id}/acls:
25342532
get:
25352533
tags:
25362534
- ACLS
@@ -2569,7 +2567,7 @@ paths:
25692567

25702568
# end /datasets/{id}/acls
25712569

2572-
'/datatypes/{id}/acls':
2570+
/datatypes/{id}/acls:
25732571

25742572
get:
25752573
tags:

0 commit comments

Comments
 (0)