Document access control lists (ACLs)

Documents the syntax and meaning of container ACLs. Account ACLs
were already pretty well documented. However the account
ACL text was moved as part of this change.

TempAuth and keystoneauth have diffent ACLs. However, I decided
to describe both in one section/table because there are many
"examples" of ACLs in other documents, and it's better that
someone coming here from those sources become aware that the
specific ACL might not apply to them. In addition, the
referrer and .rlistings is common to both.

Some changes were also made to the api-ref document. The doc
and api-ref documents are published as seperate documents, so
the cross references from the api-ref section will not work
until this patch merges and the documents are rebuilt.

Change-Id: Icd2d6c278050c263b833ae76545c041f54fae68d

2 files changed, 41 insertions, 8 deletions

diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index 23ab88a1a..52dccd6cf 100644
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -259,6 +259,31 @@ Transfer-Encoding:
   in: header
   required: false
   type: string
+X-Account-Access-Control_req:
+  description: |
+    **Note**: `X-Account-Access-Control` is not supported by Keystone auth.
+
+    Sets an account access control list (ACL) that grants access to
+    containers and objects in the account.
+    See `Account ACLs
+    <http://docs.openstack.org/developer/swift/overview_acl.html#account-acls>`_
+    for more information.
+  in: header
+  required: false
+  type: string
+X-Account-Access-Control_resp:
+  description: |
+    **Note**: `X-Account-Access-Control` is not supported by Keystone auth.
+
+    The account access control list (ACL) that grants access to
+    containers and objects in the account.
+    If there is no ACL, this header is not returned by this operation.
+    See `Account ACLs
+    <http://docs.openstack.org/developer/swift/overview_acl.html#account-acls>`_
+    for more information.
+  in: header
+  required: false
+  type: string
 X-Account-Bytes-Used:
   description: |
     The total number of bytes that are stored in
@@ -527,7 +552,9 @@ X-Container-Read:
     or to perform a GET or HEAD operation on the container itself.
 
     The format and scope of the ACL is dependent on the authorization system
-    used by the Object Storage service.
+    used by the Object Storage service. See `Container ACLs
+    <http://docs.openstack.org/developer/swift/overview_acl.html#container-acls>`_
+    for more information.
   in: header
   required: false
   type: string
@@ -535,6 +562,9 @@ X-Container-Read_resp:
   description: |
     The ACL that grants read access. If there is no ACL, this
     header is not returned by this operation.
+    See `Container ACLs
+    <http://docs.openstack.org/developer/swift/overview_acl.html#container-acls>`_
+    for more information.
   in: header
   required: false
   type: string
@@ -582,7 +612,9 @@ X-Container-Write:
     metadata.
 
     The format of the ACL is dependent on the authorization system
-    used by the Object Storage service.
+    used by the Object Storage service.  See `Container ACLs
+    <http://docs.openstack.org/developer/swift/overview_acl.html#container-acls>`_
+    for more information.
 
   in: header
   required: false
@@ -591,6 +623,9 @@ X-Container-Write_resp:
   description:
     The ACL that grants write access. If there is no ACL,
     this header is not returned by this operation.
+    See `Container ACLs
+    <http://docs.openstack.org/developer/swift/overview_acl.html#container-acls>`_
+    for more information.
   in: header
   required: false
   type: string
diff --git a/api-ref/source/storage-account-services.inc b/api-ref/source/storage-account-services.inc
index 8834c1a6d..b3c19b765 100644
--- a/api-ref/source/storage-account-services.inc
+++ b/api-ref/source/storage-account-services.inc
@@ -109,6 +109,7 @@ Response Parameters
    - X-Account-Storage-Policy-name-Container-Count: X-Account-Storage-Policy-name-Container-Count
    - X-Account-Storage-Policy-name-Object-Count: X-Account-Storage-Policy-name-Object-Count
    - X-Account-Meta-Quota-Bytes: X-Account-Meta-Quota-Bytes_resp
+   - X-Account-Access-Control: X-Account-Access-Control_resp
    - Content-Type: Content-Type_listing_resp
    - count: count
    - bytes: bytes
@@ -257,6 +258,7 @@ Request
    - X-Account-Meta-Temp-URL-Key-2: X-Account-Meta-Temp-URL-Key-2_req
    - X-Account-Meta-name: X-Account-Meta-name_req
    - X-Remove-Account-name: X-Remove-Account-name
+   - X-Account-Access-Control: X-Account-Access-Control_req
    - X-Trans-Id-Extra: X-Trans-Id-Extra
 
 
@@ -359,9 +361,5 @@ Response Parameters
    - X-Account-Storage-Policy-name-Container-Count: X-Account-Storage-Policy-name-Container-Count
    - X-Account-Storage-Policy-name-Object-Count: X-Account-Storage-Policy-name-Object-Count
    - X-Account-Meta-Quota-Bytes: X-Account-Meta-Quota-Bytes_resp
-   - Content-Type: Content-Type_cud_resp
-
-
-
-
-
+   - X-Account-Access-Control: X-Account-Access-Control_resp
+   - Content-Type: Content-Type_cud_resp
\ No newline at end of file