Skip to content

Commit 243f81a

Browse files
committed
Replace most instances of HDF Kita with HDF REST API
Remove unnecessary doc files that don't relate to REST API itself
1 parent 3142325 commit 243f81a

20 files changed

+22
-700
lines changed

AdminTools.rst

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

Authorization.rst

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Authorization and Authentication
44

55
Request Authentication
66
-----------------------
7-
HDF Kita supports HTTP Basic authentication to authenticate users by comparing an encrypted
7+
The HDF REST API supports HTTP Basic authentication to authenticate users by comparing an encrypted
88
username and password against a value stored within a password file.
99

1010
If neither the requested object (Group, Dataset, or Committed Datatype) nor the object's root group
@@ -36,11 +36,4 @@ If the authorization string is validated, the server will verify the request is
3636
per the object's ACL list. If not authorized a http status 403 - Forbidden will be returned.
3737

3838

39-
User IDs and passwords
40-
----------------------
41-
42-
User IDs and passwords are maintained in a plaintext file:
43-
``admin/config/passwd.txt``.
44-
45-
4639

COPYING

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

CommonErrorResponses.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
Common Error Responses
33
***************************
44

5-
For each request, HDF Kita returns a standard HTTP status code as described below.
5+
For each request, the HDF REST API returns a standard HTTP status code as described below.
66
In general 2xx codes indicate success, 3xx codes are returned for some form of redirection,
77
4xx codes are returned for a client error, and 5xx codes are returned for server errors.
8-
In addition to the numeric code, HDF Kita will return an informational message as part of
8+
In addition to the numeric code, the HDF REST API shall return an informational message as part of
99
the response providing further information on the nature of the error.
1010

1111
* ``200 OK`` - The request was completed successfully
@@ -17,6 +17,5 @@ the response providing further information on the nature of the error.
1717
* ``405 Method Not Allowed`` - The HTTP request type was not valid for the given resource (e.g. ``PUT /datasets/<id>/type``)
1818
* ``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).
1919
* ``410 Gone`` - The resource requested has been recently deleted.
20-
* ``413 Selection Too Large`` - This error is used when the selection within a dataset encompasses too large of an area of data for the server to accept/return.
2120
* ``500 Internal Error`` - An unexpected error that indicates some problem occurred on the server.
2221
* ``501 Not Implemented`` - The request depends on a feature that is not yet implemented.

CommonRequestHeaders.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Common Request Headers
33
***********************
44

5-
The following describe common HTTP request headers as used in HDF Kita:
5+
The following describe common HTTP request headers as used in the HDF REST API:
66

77
* 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)
88
* Accept: Specifies the media type that is acceptable for the response. Valid values are "application/json", and "*/*. In addition, GET/PUT/POST Value (see :doc:`DatasetOps/GET_Value`, :doc:`DatasetOps/PUT_Value`, :doc:`DatasetOps/POST_Value`) support the value "application/octet-stream"

CommonResponseHeaders.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Common Response Headers
33
***************************
44

5-
The following describes some of the common response lines returned by HDF Kita.
5+
The following describes some of the common response lines returned by the HDF REST API.
66

77
* Status Line: the first line of the response will always be: "``HTTP/1.1``" followed by
88
a status code (e.g. 200) followed by a reason message (e.g. "``OK``"). For errors,

DomainOps/index.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,13 @@
22
Domains
33
#######################
44

5-
In HDF Kita, domains are containers for a related collection of resources, similar to a
6-
file in the traditional HDF5 library. In the HDF Kita implementation of the HDF5 REST API,
5+
In the HDF REST API, domains are containers for a related collection of resources, similar to a
6+
file in the traditional HDF5 library. In the HDF Kita implementation of the HDF REST API,
77
domains *are* files, but in general the HDF REST API supports alternative implementations
88
(e.g. data that is stored in a database).
99
Most operations of the service act on a domain resource that is provided in
1010
the *Host* http header or (alternatively) the Host query parameter.
11+
TODO: X-Hdf-domain header, domain/host query parameter
1112

1213
Mapping of file paths to domain names
1314
-------------------------------------

Hypermedia.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Hypermedia
33
*************************
44

5-
HDF Kita supports the REST convention of **HATEOAS** or *Hypermedia as the Engine of
5+
The HDF REST API supports the REST convention of **HATEOAS** or *Hypermedia as the Engine of
66
Application State*. The idea (see http://en.wikipedia.org/wiki/HATEOS for a full
77
explanation) is that each response includes links to resources related to
88
the requested resource.
@@ -35,7 +35,7 @@ a JSON array. Each array element has a key: ``href`` - the related resource, an
3535
3636
This enables clients to "explore" the API without detailed knowledge of it.
3737

38-
This is the list of relations used in HDF Kita:
38+
This is the list of relations used in the HDF REST API:
3939

4040
* attributes - the attributes of the resource
4141
* data - the resource's data (used for datasets)

0 commit comments

Comments
 (0)