Skip to content

Commit 3a22f42

Browse files
committed
Remove unrelated FAQ
Add link to REST VOL in intro
1 parent 77d30c7 commit 3a22f42

File tree

5 files changed

+26
-120
lines changed

5 files changed

+26
-120
lines changed

FAQ/index.rst

Lines changed: 0 additions & 94 deletions
This file was deleted.

Hypermedia.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,15 @@ a JSON array. Each array element has a key: ``href`` - the related resource, an
2424
.. code-block:: json
2525
2626
{
27-
"hrefs": [
28-
{"href": "http://tall.test.hdfgroup.org/datasets/<id>", "rel": "self"},
29-
{"href": "http://tall.test.hdfgroup.org/groups/<id>", "rel": "root"},
30-
{"href": "http://tall.test.hdfgroup.org/datasets/<id>/attributes", "rel": "attributes"},
31-
{"href": "http://tall.test.hdfgroup.org/datasets/<id>/value", "rel": "data"},
32-
{"href": "http://tall.test.hdfgroup.org/", "rel": "home"}
33-
]
27+
"hrefs": [
28+
{"href": "http://tall.test.hdfgroup.org/datasets/<id>", "rel": "self"},
29+
{"href": "http://tall.test.hdfgroup.org/groups/<id>", "rel": "root"},
30+
{"href": "http://tall.test.hdfgroup.org/datasets/<id>/attributes", "rel": "attributes"},
31+
{"href": "http://tall.test.hdfgroup.org/datasets/<id>/value", "rel": "data"},
32+
{"href": "http://tall.test.hdfgroup.org/", "rel": "home"}
33+
]
3434
}
35-
35+
3636
This enables clients to "explore" the API without detailed knowledge of it.
3737

3838
This is the list of relations used in the HDF REST API:

Introduction/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,5 @@ JavaScript, Python, C, and other common languages. Some services which implement
1414
HDF Kita: https://www.hdfgroup.org/hdf-kita
1515

1616
H5serv: https://github.com/HDFGroup/h5serv
17-
17+
18+
HDF5 REST VOL: https://bitbucket.hdfgroup.org/users/jhenderson/repos/rest-vol/browse

Types/index.rst

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ one of the following strings:
3030
* ``H5T_STD_I64{LE|BE}``: an eight byte signed integer
3131
* ``H5T_IEEE_F32{LE|BE}``: a four byte floating-point value
3232
* ``H5T_IEEE_F64{LE|BE}``: an eight byte floating-point value
33-
33+
3434
Predefined types ending in "LE" are little-endian formatted and types ending in "BE"
3535
are big-endian. E.g. ``H5T_STD_I64LE`` would be an eight byte, signed, little-endian
3636
integer.
@@ -85,7 +85,7 @@ JSON representation of a dataset using a fixed width string of 40 characters:
8585
.. code-block:: json
8686
8787
{
88-
"id": "1e8a359c-ac46-11e4-9f3e-3c15c2da029e",
88+
"id": "d-be8bace4-83c5-11e8-90e7-0242ac120013",
8989
"shape": {
9090
"class": "H5S_SCALAR",
9191
},
@@ -97,7 +97,7 @@ JSON representation of a dataset using a fixed width string of 40 characters:
9797
},
9898
"value": "Hello, World!"
9999
}
100-
100+
101101
String Types - Variable Length
102102
==============================
103103

@@ -145,7 +145,7 @@ JSON representation of a attribute using a variable length string:
145145
]
146146
}
147147
148-
148+
149149
150150
Compound Types
151151
==============
@@ -194,7 +194,7 @@ floating point elements:
194194
},
195195
"value": [ 1.2345, -2.468 ]
196196
}
197-
197+
198198
Enumerated Types
199199
=================
200200

@@ -213,7 +213,7 @@ Example
213213
.. code-block:: json
214214
215215
{
216-
"id": "1e8a359c-ac46-11e4-9f3e-3c15c2da029e",
216+
"id": "d-be9c3582-83c5-11e8-947e-0242ac120014",
217217
"shape": {
218218
"class": "H5S_SIMPLE",
219219
"dims": [ 7 ]
@@ -233,7 +233,7 @@ Example
233233
},
234234
"value": [ 0, 2, 3, 2, 0, 1, 1 ]
235235
}
236-
236+
237237
Array Types
238238
===========
239239

@@ -252,7 +252,7 @@ A dataset with 3 elements, each of which is a 2x2 array of integers.
252252
.. code-block:: json
253253
254254
{
255-
"id": "9348ad51-7bf7-11e4-a66f-3c15c2da029e",
255+
"id": "d-bf1cb98c-83c5-11e8-b9ee-0242ac12000a",
256256
"shape": {
257257
"class": "H5S_SIMPLE",
258258
"dims": [ 3 ]
@@ -314,12 +314,12 @@ third element points to a group.
314314
"base": "H5T_STD_REF_OBJ"
315315
},
316316
"value": [
317-
"groups/a09a9b99-7bf7-11e4-aa4b-3c15c2da029e",
317+
"groups/g-be836c0a-83c5-11e8-947e-0242ac120014",
318318
"",
319-
"datasets/a09a8efa-7bf7-11e4-9fb6-3c15c2da029e"
319+
"datasets/d-be8bace4-83c5-11e8-90e7-0242ac120013"
320320
]
321321
}
322-
322+
323323
Region Reference Types
324324
======================
325325

@@ -338,7 +338,7 @@ Example
338338
A JSON representation of a region reference dataset with two elements.
339339

340340
The first element is a point selection element that references 4 elements
341-
in the dataset with UUID of "68ee967a-...".
341+
in the dataset with UUID of "d-be9c3582-...".
342342

343343
The second element is a hyperslab selection that references 4 hyper-slabs in
344344
the same dataset as the first element. Each element is a pair of points that
@@ -347,7 +347,7 @@ gives the boundary of the selection.
347347
.. code-block:: json
348348
349349
{
350-
"id": "68ee8647-7bed-11e4-9397-3c15c2da029e",
350+
"id": "d-bf1cb98c-83c5-11e8-b9ee-0242ac12000a",
351351
"shape": {
352352
"class": "H5S_SIMPLE",
353353
"dims": [2]
@@ -358,14 +358,14 @@ gives the boundary of the selection.
358358
},
359359
"value": [
360360
{
361-
"id": "68ee967a-7bed-11e4-819c-3c15c2da029e",
361+
"id": "d-be9c3582-83c5-11e8-947e-0242ac120014",
362362
"select_type": "H5S_SEL_POINTS",
363363
"selection": [
364364
[0, 1], [2, 11], [1, 0], [2, 4]
365365
]
366366
},
367367
{
368-
"id": "68ee967a-7bed-11e4-819c-3c15c2da029e",
368+
"id": "d-be9c3582-83c5-11e8-947e-0242ac120014",
369369
"select_type": "H5S_SEL_HYPERSLABS",
370370
"selection": [
371371
[ [0, 0], [0, 2] ],
@@ -376,7 +376,7 @@ gives the boundary of the selection.
376376
}
377377
]
378378
}
379-
379+
380380
Type Keys
381381
=========
382382

index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ Contents:
2222
Types/index
2323
AclOps/index
2424
Reference
25-
FAQ/index
2625

2726

2827

0 commit comments

Comments
 (0)