Skip to content

Commit ea9af33

Browse files
jhendersonHDFjhendersonHDF
committed
Updates for GroupOps
1 parent 5da8cc1 commit ea9af33

File tree

8 files changed

+509
-405
lines changed

8 files changed

+509
-405
lines changed

‎GroupOps/DELETE_Group.rst‎

Lines changed: 25 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,20 @@ Requests
1616

1717
Syntax
1818
------
19+
1920
.. code-block:: http
2021
2122
DELETE /groups/<id> HTTP/1.1
22-
Host: DOMAIN
23+
X-Hdf-domain: DOMAIN
2324
Authorization: <authorization_string>
24-
25+
26+
.. code-block:: http
27+
28+
DELETE /groups/<id>?domain=DOMAIN HTTP/1.1
29+
Authorization: <authorization_string>
30+
2531
*<id>* is the UUID of the group to be deleted.
26-
32+
2733
Request Parameters
2834
------------------
2935
This implementation of the operation does not use request parameters.
@@ -45,11 +51,7 @@ most responses. See :doc:`../CommonResponseHeaders`.
4551
Response Elements
4652
-----------------
4753

48-
On success, a JSON response will be returned with the following elements:
49-
50-
hrefs
51-
^^^^^
52-
An array of links to related resources. See :doc:`../Hypermedia`.
54+
This implementation of the operation does not return any response elements.
5355

5456
Special Errors
5557
--------------
@@ -65,37 +67,33 @@ Sample Request
6567

6668
.. code-block:: http
6769
68-
DELETE /groups/45a882e1-9d01-11e4-8acf-3c15c2da029e HTTP/1.1
69-
Host: testGroupDelete.test.hdfgroup.org
70+
DELETE /groups/g-76de767c-8606-11e8-9cc2-0242ac120008 HTTP/1.1
71+
Host: hsdshdflab.hdfgroup.org
72+
X-Hdf-domain: /shared/tall.h5
7073
Authorization: authorization_string
71-
74+
75+
Sample cURL command
76+
-------------------
77+
78+
.. code-block:: bash
79+
80+
$ curl -X DELETE -u username:password --header "X-Hdf-domain: /shared/tall.h5" hsdshdflab.hdfgroup.org/groups/g-76de767c-8606-11e8-9cc2-0242ac120008
81+
7282
Sample Response
7383
---------------
7484

7585
.. code-block:: http
7686
7787
HTTP/1.1 200 OK
78-
Date: Thu, 15 Jan 2015 21:55:51 GMT
79-
Content-Length: 270
88+
Date: Thu, 12 Jul 2018 19:05:43 GMT
8089
Content-Type: application/json
81-
Server: TornadoServer/3.2.2
82-
83-
.. code-block:: json
84-
85-
86-
{
87-
"hrefs": [
88-
{"href": "http://testGroupDelete.test.hdfgroup.org/groups", "rel": "self"},
89-
{"href": "http://testGroupDelete.test.hdfgroup.org/groups/45a06719-9d01-11e4-9b1c-3c15c2da029e", "rel": "root"},
90-
{"href": "http://testGroupDelete.test.hdfgroup.org/", "rel": "home"}
91-
]
92-
}
93-
90+
Server: nginx/1.15.0
91+
9492
Related Resources
9593
=================
9694

9795
* :doc:`POST_Group`
9896
* :doc:`GET_Group`
99-
97+
10098

10199

‎GroupOps/DELETE_Link.rst‎

Lines changed: 27 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,18 @@ Syntax
1818
.. code-block:: http
1919
2020
DELETE /groups/<id>/links/<name> HTTP/1.1
21-
Host: DOMAIN
21+
X-Hdf-domain: DOMAIN
2222
Authorization: <authorization_string>
23-
23+
24+
.. code-block:: http
25+
26+
DELETE /groups/<id>/links/<name>?domain=DOMAIN HTTP/1.1
27+
Authorization: <authorization_string>
28+
2429
* *<id>* is the UUID of the group the link is a member of.
2530
* *<name>* is the URL-encoded name of the link.
26-
27-
31+
32+
2833
Request Parameters
2934
------------------
3035
This implementation of the operation does not use request parameters.
@@ -66,34 +71,35 @@ Sample Request
6671

6772
.. code-block:: http
6873
69-
DELETE /groups/25dd052b-a06d-11e4-a29e-3c15c2da029e/links/deleteme HTTP/1.1
74+
DELETE /groups/g-b116b6f0-85e9-11e8-9cc2-0242ac120008/links/deleteme HTTP/1.1
75+
Host: hsdshdflab.hdfgroup.org
76+
X-Hdf-domain: /shared/tall.h5
7077
Content-Length: 0
71-
User-Agent: python-requests/2.3.0 CPython/2.7.8 Darwin/14.0.0
72-
host: tall_updated.test.hdfgroup.org
7378
Accept: */*
7479
Accept-Encoding: gzip, deflate
75-
80+
81+
Sample cURL command
82+
-------------------
83+
84+
.. code-block:: bash
85+
86+
$ curl -X DELETE -u username:password --header "X-Hdf-domain: /shared/tall.h5" hsdshdflab.hdfgroup.org/groups/g-b116b6f0-85e9-11e8-9cc2-0242ac120008/links/deleteme
87+
7688
Sample Response
7789
---------------
7890

7991
.. code-block:: http
8092
8193
HTTP/1.1 200 OK
82-
Date: Tue, 20 Jan 2015 06:25:37 GMT
83-
Content-Length: 299
94+
Date: Thu, 12 Jul 2018 19:45:54 GMT
95+
Content-Length: 12
8496
Content-Type: application/json
85-
Server: TornadoServer/3.2.2
86-
97+
Server: nginx/1.15.0
98+
8799
.. code-block:: json
88-
89-
{
90-
"hrefs": [
91-
{"href": "http://tall_updated.test.hdfgroup.org/groups/25dd052b-a06d-11e4-a29e-3c15c2da029e", "rel": "root"},
92-
{"href": "http://tall_updated.test.hdfgroup.org/", "rel": "home"},
93-
{"href": "http://tall_updated.test.hdfgroup.org/groups/25dd052b-a06d-11e4-a29e-3c15c2da029e", "rel": "owner"}
94-
]
95-
}
96-
100+
101+
{"href": []}
102+
97103
Related Resources
98104
=================
99105

‎GroupOps/GET_Group.rst‎

Lines changed: 43 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,16 @@ Syntax
1414
.. code-block:: http
1515
1616
GET /groups/<id> HTTP/1.1
17-
Host: DOMAIN
17+
X-Hdf-domain: DOMAIN
1818
Authorization: <authorization_string>
19-
19+
20+
.. code-block:: http
21+
22+
GET /groups/<id>?domain=DOMAIN HTTP/1.1
23+
Authorization: <authorization_string>
24+
2025
*<id>* is the UUID of the requested group.
21-
26+
2227
Request Parameters
2328
------------------
2429

@@ -48,7 +53,11 @@ On success, a JSON response will be returned with the following elements:
4853

4954
id
5055
^^
51-
The UUID of the requested group
56+
The UUID of the requested group.
57+
58+
root
59+
^^^^
60+
The root group of the domain that the group is within.
5261

5362
attributeCount
5463
^^^^^^^^^^^^^^
@@ -85,41 +94,50 @@ Sample Request
8594

8695
.. code-block:: http
8796
88-
GET /groups/052dcbbd-9d33-11e4-86ce-3c15c2da029e HTTP/1.1
89-
host: tall.test.hdfgroup.org
97+
GET /groups/g-be6eb652-83c5-11e8-b9ee-0242ac12000a HTTP/1.1
98+
Host: hsdshdflab.hdfgroup.org
99+
X-Hdf-domain: /shared/tall.h5
90100
Accept-Encoding: gzip, deflate
91101
Accept: */*
92-
User-Agent: python-requests/2.3.0 CPython/2.7.8 Darwin/14.0.0
102+
103+
Sample cURL command
104+
-------------------
105+
106+
.. code-block:: bash
107+
108+
$ curl -X GET --header "X-Hdf-domain: /shared/tall.h5" hsdshdflab.hdfgroup.org/groups/g-be6eb652-83c5-11e8-b9ee-0242ac12000a
93109
94110
Sample Response
95111
---------------
96112

97113
.. code-block:: http
98114
99115
HTTP/1.1 200 OK
100-
Date: Fri, 16 Jan 2015 20:06:08 GMT
101-
Content-Length: 660
116+
Date: Thu, 12 Jul 2018 18:27:24 GMT
117+
Content-Length: 711
102118
Etag: "2c410d1c469786f25ed0075571a8e7a3f313cec1"
103119
Content-Type: application/json
104-
Server: TornadoServer/3.2.2
105-
120+
Server: nginx/1.15.0
121+
106122
.. code-block:: json
107123
108124
{
109-
"id": "052dcbbd-9d33-11e4-86ce-3c15c2da029e",
110-
"attributeCount": 2,
111-
"linkCount": 2,
112-
"created": "2015-01-16T03:47:22Z",
113-
"lastModified": "2015-01-16T03:47:22Z",
114-
"hrefs": [
115-
{"href": "http://tall.test.hdfgroup.org/groups/052dcbbd-9d33-11e4-86ce-3c15c2da029e", "rel": "self"},
116-
{"href": "http://tall.test.hdfgroup.org/groups/052dcbbd-9d33-11e4-86ce-3c15c2da029e/links", "rel": "links"},
117-
{"href": "http://tall.test.hdfgroup.org/groups/052dcbbd-9d33-11e4-86ce-3c15c2da029e", "rel": "root"},
118-
{"href": "http://tall.test.hdfgroup.org/", "rel": "home"},
119-
{"href": "http://tall.test.hdfgroup.org/groups/052dcbbd-9d33-11e4-86ce-3c15c2da029e/attributes", "rel": "attributes"}
125+
"id": "g-be6eb652-83c5-11e8-b9ee-0242ac12000a",
126+
"root": "g-be5996fa-83c5-11e8-a8e6-0242ac120016",
127+
"linkCount": 2,
128+
"attributeCount": 0,
129+
"lastModified": 1531174596.5785563,
130+
"created": 1531174596.2463753,
131+
"domain": "/shared/tall.h5",
132+
"hrefs": [
133+
{"href": "hsdshdflab.hdfgroup.org/groups/g-be6eb652-83c5-11e8-b9ee-0242ac12000a", "rel": "self"},
134+
{"href": "hsdshdflab.hdfgroup.org/groups/g-be6eb652-83c5-11e8-b9ee-0242ac12000a/links", "rel": "links"},
135+
{"href": "hsdshdflab.hdfgroup.org/groups/g-be5996fa-83c5-11e8-a8e6-0242ac120016", "rel": "root"},
136+
{"href": "hsdshdflab.hdfgroup.org/", "rel": "home"},
137+
{"href": "hsdshdflab.hdfgroup.org/groups/g-be6eb652-83c5-11e8-b9ee-0242ac12000a/attributes", "rel": "attributes"}
120138
]
121-
}
122-
139+
}
140+
123141
Related Resources
124142
=================
125143

@@ -128,6 +146,6 @@ Related Resources
128146
* :doc:`GET_Groups`
129147
* :doc:`POST_Group`
130148
* :doc:`../AttrOps/GET_Attribute`
131-
149+
132150

133151

0 commit comments

Comments
 (0)