Skip to content

Commit

Permalink
updated license text in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jreadey committed Feb 12, 2015
1 parent 76a03e1 commit 26a9ad2
Show file tree
Hide file tree
Showing 9 changed files with 25 additions and 34 deletions.
4 changes: 2 additions & 2 deletions COPYING
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@

Copyright Notice and License Terms for
H5Serv Software Service, Libraries and Utilities
h5serv Software Service, Libraries and Utilities
-----------------------------------------------------------------------------

H5Serv (HDF5 REST Server) Service, Libraries and Utilities
h5serv (HDF5 REST Server) Service, Libraries and Utilities
Copyright 2014 by The HDF Group.

All rights reserved.
Expand Down
16 changes: 5 additions & 11 deletions docs/CommonErrorResponses.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,10 @@ will return an informational message as part of the response providing further
information on the nature of the error.

* ``200 OK`` - The request was completed successfully
* ``201 Created`` - The request was fulfilled and a new resource (e.g. group, dataset,
attribute was created)
* ``400 Bad Request`` - The request was not structured correctly (e.g. a required key
was missing).
* ``404 Not Found`` - The requested resource was not found (e.g. ``GET /groups/<id>`` where
<id> was not a valid identifier for a group in the domain).
* ``409 Conflict`` - This error is used with PUT requests where the resources cannot
be created because there is an existing resource with the same name (e.g. PUT / where
the requested domain is already present).
* ``201 Created`` - The request was fulfilled and a new resource (e.g. group, dataset, attribute was created)
* ``400 Bad Request`` - The request was not structured correctly (e.g. a required key was missing).
* ``404 Not Found`` - The requested resource was not found (e.g. ``GET /groups/<id>`` where <id> was not a valid identifier for a group in the domain).
* ``409 Conflict`` - This error is used with PUT requests where the resources cannot be created because there is an existing resource with the same name (e.g. PUT / where the requested domain is already present).
* ``410 Gone`` - The resource requested has been recently deleted.
* ``500 Internal Error`` - An unexpected error that indicates some problem occurred on
the server.
* ``500 Internal Error`` - An unexpected error that indicates some problem occurred on the server.
* ``501 Not Implemented`` - The request depends on a feature that is not yet implemented.
13 changes: 3 additions & 10 deletions docs/CommonRequestHeaders.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,6 @@ Common Request Headers

The following describe common HTTP request headers as used in h5serv:

* Request line: The first line of the request, the format is of the form HTTP verb (GET,
PUT, DELETE, or POST) followed by the path to the resource (e.g. /group/<uuid>. Some
operations take one or more query parameters (see relevant documentation).

* Authorization: A string that provides the requester's credentials for the request. *Note:*
currently authorization is not implemented and presence or absence of the line will have
no effect.

* Host: the domain (i.e. related collection of groups, datasets, and attributes) that
the request should apply to.
* Request line: The first line of the request, the format is of the form HTTP verb (GET, PUT, DELETE, or POST) followed by the path to the resource (e.g. /group/<uuid>. Some operations take one or more query parameters (see relevant documentation).
* Authorization: A string that provides the requester's credentials for the request. *Note:* currently authorization is not implemented and presence or absence of the line will have no effect.
* Host: the domain (i.e. related collection of groups, datasets, and attributes) that the request should apply to.
4 changes: 1 addition & 3 deletions docs/Diagram.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ Diagram of REST operations


.. image:: RESTful_HDF5.png
:height: 1726px
:width: 3500 px
:scale: 50 %
:width: 100 %
:alt: alternate text
:align: right
4 changes: 4 additions & 0 deletions docs/FAQ/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,10 @@ I have a C or Fortran application that uses HDF5, how can I take advantage of h5
We are planning on creating a hdf5 library plugin that will transparently invoke the
REST api. For now, you can use C-libraries such as libcurl to invoke h5serv requests.

Is there documentation on the JSON format generated by h5tojson.py:
-------------------------------------------------------------------
Yes. There is a grammer published here: http://hdf5-json.readthedocs.org/en/latest/index.html.

How do I submit a bug report?
------------------------------
If you have a Github account, create an issue here:
Expand Down
8 changes: 4 additions & 4 deletions docs/Utilities.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@ Usage:
hdf5_file is a file from the h5serv data directory. Output is a list of All UUID's and
a path to the associated object.

dumpjson.py
exportjson.py
-----------

This script makes a series of rest requests to the desired h5serv endpoint and
constructs a JSON file representing the domain's contents.

Usage:

``python dumpjson.py [-v] [-D|d] [-endpoint=<server_ip>] [-port=<port] <domain>``
``python exportjson.py [-v] [-D|d] [-endpoint=<server_ip>] [-port=<port] <domain>``

Options:
* ``-v``: verbose, print request and response codes from server
Expand All @@ -35,10 +35,10 @@ Options:
* ``-port``: port address of server [default 7253]

Example - get 'tall' collection from HDF Group server:
``python dumpjson.py tall.data.hdfgroup.org``
``python exportjson.py tall.data.hdfgroup.org``
Example - get 'tall' collection from a local server instance
(assuming the server is using port 5000):
``python dumpjson.py -endpoint=127.0.0.1 -port=5000 tall.test.hdfgroup.org``
``python exportjson.py -endpoint=127.0.0.1 -port=5000 tall.test.hdfgroup.org``


jsontoh5.py
Expand Down
2 changes: 2 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@
project = u'h5serv'
copyright = unicode(datetime.now().year) + u', The HDF Group'

rst_epilog = '.. |copyright| replace:: %s' % copyright

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
Expand Down
2 changes: 1 addition & 1 deletion util/dumptojson.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ do
echo "$f"
s=${f##*/}
b=${s%.h5}
python dumpjson.py -endpoint=127.0.0.1 -port=5000 $b.test.hdfgroup.org >json_dump/$b.json
python exportjson.py -endpoint=127.0.0.1 -port=5000 $b.test.hdfgroup.org >json_dump/$b.json
done
6 changes: 3 additions & 3 deletions util/dumpjson.py → util/exportjson.py
Original file line number Diff line number Diff line change
Expand Up @@ -183,18 +183,18 @@ def dumpDomain(self):
# Print usage and exit
#
def printUsage():
print "usage: python dumpjson.py [-v] [-D|d] [-endpoint=<server_ip>] [-port=<port] <domain>"
print "usage: python exportjson.py [-v] [-D|d] [-endpoint=<server_ip>] [-port=<port] <domain>"
print " options -v: verbose, print request and response codes from server"
print " options -D: suppress all data output"
print " options -d: suppress data output for datasets (but not attributes)"
print " options -endpoint: specify IP endpoint of server"
print " options -port: port address of server [default 7253]"
print " ------------------------------------------------------------------------------"
print " Example - get 'tall' collection from HDF Group server:"
print " python dumpjson.py tall.data.hdfgroup.org"
print " python exportjson.py tall.data.hdfgroup.org"
print " Example - get 'tall' collection from a local server instance "
print " (assuming the server is using port 5000):"
print " python dumpjson.py -endpoint=127.0.0.1 -port=5000 tall.test.hdfgroup.org"
print " python exportjson.py -endpoint=127.0.0.1 -port=5000 tall.test.hdfgroup.org"
sys.exit();

#
Expand Down

0 comments on commit 26a9ad2

Please sign in to comment.