Updates to the documentation for ACLs and Attributes

Author: jhendersonHDF

AclOps/GET_ACL.rst

@@ -76,21 +76,21 @@ On success, a JSON response will be returned with the following elements:
 
 acl
 ^^^
-A JSON object that describe a users acces permisions.  Subkeys of acl are:
+A JSON object that describes a user's access permissions.  Subkeys of acl are:
 
 userName: the userid of the requested user
 
-create: A boolean flag that indicated if the user is authorized to create new resources
+create: A boolean flag that indicates if the user is authorized to create new resources
 
-delete: A boolean flag that indicated if the user is authorized to delete resources
+delete: A boolean flag that indicates if the user is authorized to delete resources
 
-read: A boolean flag that indicated if the user is authorized to read (GET) resources
+read: A boolean flag that indicates if the user is authorized to read (GET) resources
 
-update: A boolean flag that indicated if the user is authorized to update resources
+update: A boolean flag that indicates if the user is authorized to update resources
 
-readACL: A boolean flag that indicated if the user is authorized to read the object's ACL
+readACL: A boolean flag that indicates if the user is authorized to read the object's ACL
 
-updateACL: A boolean flag that indicated if the user is authorized to update the object's ACL
+updateACL: A boolean flag that indicates if the user is authorized to update the object's ACL
 
 
 hrefs
@@ -100,7 +100,7 @@ An array of hypertext links to related resources.  See :doc:`../Hypermedia`.
 Special Errors
 --------------
 
-The implementation of the operation does not return special errors.  For general 
+This implementation of the operation does not return special errors.  For general 
 information on standard error codes, see :doc:`../CommonErrorResponses`.
 
 Examples

AclOps/GET_ACLs.rst

@@ -78,22 +78,22 @@ On success, a JSON response will be returned with the following elements:
 acls
 ^^^^
 A JSON list that contains one element for each user specified in the ACL.
-The elements will be JSON object that describe the users acces permisions.  
-Subkeys of the element are are:
+The elements will be JSON objects that describe each user's access permissions.  
+The subkeys of each element are:
 
 userName: the userid of the user ('default' for the default access)
 
-create: A boolean flag that indicated if the user is authorized to create new resources
+create: A boolean flag that indicates if the user is authorized to create new resources
 
-delete: A boolean flag that indicated if the user is authorized to delete resources
+delete: A boolean flag that indicates if the user is authorized to delete resources
 
-read: A boolean flag that indicated if the user is authorized to read (GET) resources
+read: A boolean flag that indicates if the user is authorized to read (GET) resources
 
-update: A boolean flag that indicated if the user is authorized to update resources
+update: A boolean flag that indicates if the user is authorized to update resources
 
-readACL: A boolean flag that indicated if the user is authorized to read the object's ACL
+readACL: A boolean flag that indicates if the user is authorized to read the object's ACL
 
-updateACL: A boolean flag that indicated if the user is authorized to update the object's ACL
+updateACL: A boolean flag that indicates if the user is authorized to update the object's ACL
 
 
 hrefs
@@ -103,7 +103,7 @@ An array of hypertext links to related resources.  See :doc:`../Hypermedia`.
 Special Errors
 --------------
 
-The implementation of the operation does not return special errors.  For general 
+This implementation of the operation does not return special errors.  For general 
 information on standard error codes, see :doc:`../CommonErrorResponses`.
 
 Examples

AclOps/PUT_ACL.rst

@@ -102,7 +102,7 @@ An array of hypertext links to related resources.  See :doc:`../Hypermedia`.
 Special Errors
 --------------
 
-The implementation of the operation does not return special errors.  For general 
+This implementation of the operation does not return special errors.  For general 
 information on standard error codes, see :doc:`../CommonErrorResponses`.
 
 Examples

AclOps/index.rst

@@ -2,16 +2,16 @@
 Access Control List
 ####################
 
-Access Control List (ACL) are key-value stores that can be used to manage what operations can 
+An Access Control List (ACL) is a key-value store that can be used to manage what operations can 
 be performed by which user on group, dataset, or committed type objects.  Operations on other 
 objects (e.g. links, dataspace, or attributes) use the ACL of the object they belong to.
 
 Each ACL consists of 1 or more items in the form:
 
 (username, read, create, update, delete, readACL, updateACL)
 
-where username is a string, and read, create, update, delete, readACL, updateACL are booleans.
-There flags have the following semantics when the given username is provided in the http
+where username is a string, and read, create, update, delete, readACL and updateACL are booleans.
+These flags have the following semantics when the given username is provided in the http
 Authorization header:
 
 * read: The given user is authorized for read access to the resource (generally all GET requests)
@@ -22,7 +22,7 @@ Authorization header:
 * updateACL: The given user is authorized to modify the ACLs of a resource
 
 A special username 'default' is used to denote the access permission for all other users who
-or not list in the ACL (including un-authenticated requests that don't provide a username).
+are not listed in the ACL (including un-authenticated requests that don't provide a username).
 
 Example
 -------
@@ -67,7 +67,7 @@ Finally the same set of requests are sent with 'ann' as the user:
 * PUT /datasets/<id>/attributes/<name> - denied (returns HTTP Status 201 - Created)
 * DELETE /datasets/<id>  - denied (returns HTTP Status 200 - OK)
 
-Note: HTTP Status 401 basically says: "you can't have access until you tell me who your are", 
+Note: HTTP Status 401 basically says: "you can't have access until you tell me who you are", 
 while HTTP Status 403 says: "I know who you are, but you don't have permissions to access this
 resource."
 
@@ -76,7 +76,7 @@ Root ACL Inheritance
 
 In many cases it will be desired to have a default ACL that applies to each resource in the domain.
 This can be accomplished by defining an ACL for the root group.  This will control the access 
-rights for any resource unless of ACL is present in that resource for the requesting user.
+rights for any resource unless an ACL is present in that resource for the requesting user.
 
 The default ACL can be read or updated by forming a request with a uri that includes the root group id, 
 i.e.: "/groups/<root_id>/acls", or by using the uri path for the domain, i.e. "/acls".

AttrOps/DELETE_Attribute.rst

@@ -51,7 +51,7 @@ An array of links to related resources.  See :doc:`../Hypermedia`.
 Special Errors
 --------------
 
-The implementation of the operation does not return special errors.  For general 
+This implementation of the operation does not return special errors.  For general 
 information on standard error codes, see :doc:`../CommonErrorResponses`.
 
 Examples

AttrOps/GET_Attribute.rst

@@ -77,16 +77,16 @@ A JSON object that represents the dataspace of the attribute.  Subkeys of shape
 class: A string with one of the following values:
 
  * H5S_NULL: A null dataspace, which has no elements
- * H5S_SCALAR: A dataspace with a single element (although possibly of a complext datatype)
+ * H5S_SCALAR: A dataspace with a single element (although possibly of a complex datatype)
  * H5S_SIMPLE: A dataspace that consists of a regular array of elements
 
 dims: An integer array whose length is equal to the number of dimensions (rank) of the 
-dataspace.  The value of each element gives the the current size of each dimension.  Dims
+dataspace.  The value of each element gives the current size of each dimension.  Dims
 is not returned for H5S_NULL or H5S_SCALAR dataspaces.
 
 value
 ^^^^^
-A json array (or string or number for scalar datasets) giving the values of the requested 
+A JSON array (or string or number for scalar datasets) giving the values of the requested 
 attribute.
 
 hrefs
@@ -96,7 +96,7 @@ An array of links to related resources.  See :doc:`../Hypermedia`.
 Special Errors
 --------------
 
-The implementation of the operation does not return special errors.  For general 
+This implementation of the operation does not return special errors.  For general 
 information on standard error codes, see :doc:`../CommonErrorResponses`.
 
 Examples
@@ -105,7 +105,7 @@ Examples
 Sample Request
 --------------
 
-Get an attribute named "attr1" from a group with UUID: "45a882e1-...".
+Get an attribute named "attr1" from a group with UUID: "1a956e54-...".
 
 .. code-block:: http
 

AttrOps/GET_Attributes.rst

@@ -5,7 +5,7 @@ GET Attributes
 Description
 ===========
 Gets all the attributes of a dataset, group, or committed datatype.
-For each attribute the request returns the attributes name, type, and shape.  To get 
+For each attribute the request returns the attribute's name, type, and shape.  To get 
 the attribute data use :doc:`GET_Attribute`.
 
 Requests
@@ -91,7 +91,7 @@ An array of links to related resources.  See :doc:`../Hypermedia`.
 Special Errors
 --------------
 
-The implementation of the operation does not return special errors.  For general 
+This implementation of the operation does not return special errors.  For general 
 information on standard error codes, see :doc:`../CommonErrorResponses`.
 
 Examples
@@ -100,7 +100,7 @@ Examples
 Sample Request
 --------------
 
-Get attributes of a group with UUID: "45a882e1-...".
+Get attributes of a group with UUID: "1a956e54-...".
 
 .. code-block:: http
 
@@ -164,8 +164,8 @@ Sample Response
 Sample Request - get Batch
 ---------------------------
 
-Get 5 the five attributes that occur after attribute "a0004" from a of a group with UUID: 
-"45a882e1-...".
+Get the five attributes that occur after attribute "a0004" from a group with UUID: 
+"4cecd4dc-...".
 
 .. code-block:: http
 

AttrOps/PUT_Attribute.rst

@@ -54,13 +54,13 @@ Request Elements
 ----------------
 
 The request body must include a JSON object with "type" key.  Optionally a "shape"
-key can be provide to make a non-scalar attribute.
+key can be provided to make a non-scalar attribute.
 
 
 type
 ^^^^
 
-Specify's the desired type of the attribute.  Either a string that is one of the 
+Specifies the desired type of the attribute.  Either a string that is one of the 
 predefined type values, a uuid of a committed type, or a JSON object describing the type.
 See :doc:`../Types/index` for details of the type specification.
 
@@ -102,7 +102,7 @@ An array of links to related resources.  See :doc:`../Hypermedia`.
 Special Errors
 --------------
 
-The implementation of the operation does not return special errors.  For general 
+This implementation of the operation does not return special errors.  For general 
 information on standard error codes, see :doc:`../CommonErrorResponses`.
 
 Examples
@@ -205,7 +205,7 @@ Sample Response - string attribute
 Sample Request - compound type
 ----------------------------------
 
-Create a two-element, attribute of group with UUID of 
+Create a two-element, attribute in the group with UUID of 
 "be319519-" named "attr_compound".   The attribute has a compound type with an integer
 and a floating point element. 
 

AttrOps/index.rst

@@ -4,7 +4,7 @@ Attributes
 
 Like datasets (see :doc:`../DatasetOps/index`), attributes are objects that contain a 
 homogeneous collection of elements
-and have associatted type information.  Attributes are typically small metadata objects
+and have associated type information.  Attributes are typically small metadata objects
 that describe some aspect of the object (dataset, group, or committed datatype) that 
 contains the attribute.
 
@@ -20,8 +20,8 @@ attributes) is included in the request.
 
 Reading and Writing Data
 -------------------------
-Unlike datasets, attribute's data can not be
-read or written partially.  Data can only be written as part of the PUT requests.  
+Unlike datasets, an attribute's data can not be
+read or written partially.  Data can only be written as part of the PUT request.  
 Reading the data of an attribute is done by :doc:`GET_Attribute`.
 
 Listing attributes