openstack/swift
Code Issues Proposed changes

api-ref: update docs links

Browse Source 
Change-Id: I83da881f82faf340d0e394c79f7e9d4df7f34b04
This commit is contained in:
Tim Burke 2017-08-30 20:37:41 +00:00
parent add2a94cd8
commit 9f5aa3bbd7
4 changed files with 31 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
api-ref/source/parameters.yaml
View File

@ -280,7 +280,7 @@ X-Account-Access-Control_req:
Sets an account access control list (ACL) that grants access to Sets an account access control list (ACL) that grants access to
containers and objects in the account. containers and objects in the account.
See `Account ACLs See `Account ACLs
<http://docs.openstack.org/developer/swift/overview_acl.html#account-acls>`_ <https://docs.openstack.org/swift/latest/overview_acl.html#account-acls>`_
for more information. for more information.
in: header in: header
required: false required: false
@ -293,7 +293,7 @@ X-Account-Access-Control_resp:
containers and objects in the account. containers and objects in the account.
If there is no ACL, this header is not returned by this operation. If there is no ACL, this header is not returned by this operation.
See `Account ACLs See `Account ACLs
<http://docs.openstack.org/developer/swift/overview_acl.html#account-acls>`_ <https://docs.openstack.org/swift/latest/overview_acl.html#account-acls>`_
for more information. for more information.
in: header in: header
required: false required: false
@ -480,7 +480,7 @@ X-Container-Meta-Quota-Bytes:
exceeds this quota value. exceeds this quota value.
This value does not take effect immediately. see This value does not take effect immediately. see
`Container Quotas `Container Quotas
<http://docs.openstack.org/developer/swift/api/container_quotas.html>`_ <https://docs.openstack.org/swift/latest/api/container_quotas.html>`_
for more information. for more information.
in: header in: header
required: false required: false
@ -500,7 +500,7 @@ X-Container-Meta-Quota-Count:
exceeds this quota value. exceeds this quota value.
This value does not take effect immediately. see This value does not take effect immediately. see
`Container Quotas `Container Quotas
<http://docs.openstack.org/developer/swift/api/container_quotas.html>`_ <https://docs.openstack.org/swift/latest/api/container_quotas.html>`_
for more information. for more information.
in: header in: header
required: false required: false
@ -568,7 +568,7 @@ X-Container-Read:
The format and scope of the ACL is dependent on the authorization system The format and scope of the ACL is dependent on the authorization system
used by the Object Storage service. See `Container ACLs used by the Object Storage service. See `Container ACLs
<http://docs.openstack.org/developer/swift/overview_acl.html#container-acls>`_ <https://docs.openstack.org/swift/latest/overview_acl.html#container-acls>`_
for more information. for more information.
in: header in: header
required: false required: false
@ -578,7 +578,7 @@ X-Container-Read_resp:
The ACL that grants read access. If there is no ACL, this The ACL that grants read access. If there is no ACL, this
header is not returned by this operation. header is not returned by this operation.
See `Container ACLs See `Container ACLs
<http://docs.openstack.org/developer/swift/overview_acl.html#container-acls>`_ <https://docs.openstack.org/swift/latest/overview_acl.html#container-acls>`_
for more information. for more information.
in: header in: header
required: false required: false
@ -589,8 +589,7 @@ X-Container-Sync-Key:
synchronization. If you remove the secret key, synchronization is synchronization. If you remove the secret key, synchronization is
halted. halted.
For more information, see `Container to Container Synchronization For more information, see `Container to Container Synchronization
<http://docs.openstack.org/developer/swift/overview_ <https://docs.openstack.org/swift/latest/overview_container_sync.html>`_
container_sync.html>`_
in: header in: header
required: false required: false
type: string type: string
@ -628,7 +627,7 @@ X-Container-Write:
The format of the ACL is dependent on the authorization system The format of the ACL is dependent on the authorization system
used by the Object Storage service. See `Container ACLs used by the Object Storage service. See `Container ACLs
<http://docs.openstack.org/developer/swift/overview_acl.html#container-acls>`_ <https://docs.openstack.org/swift/latest/overview_acl.html#container-acls>`_
for more information. for more information.
in: header in: header
@ -639,7 +638,7 @@ X-Container-Write_resp:
The ACL that grants write access. If there is no ACL, The ACL that grants write access. If there is no ACL,
this header is not returned by this operation. this header is not returned by this operation.
See `Container ACLs See `Container ACLs
<http://docs.openstack.org/developer/swift/overview_acl.html#container-acls>`_ <https://docs.openstack.org/swift/latest/overview_acl.html#container-acls>`_
for more information. for more information.
in: header in: header
required: false required: false
@ -731,17 +730,16 @@ X-History-Location:
is set, versioning is disabled for this container. ``X-History-Location`` is set, versioning is disabled for this container. ``X-History-Location``
and ``X-Versions-Location`` cannot both be set at the same time. For more and ``X-Versions-Location`` cannot both be set at the same time. For more
information about object versioning, see `Object versioning information about object versioning, see `Object versioning
<http://docs.openstack.org/ developer/swift/api/object_versioning.html>`_. <https://docs.openstack.org/swift/latest/api/object_versioning.html>`_.
in: header in: header
required: false required: false
type: string type: string
X-History-Location_resp: X-History-Location_resp:
description: | description: |
If present, this container has versioning enabled and the value If present, this container has versioning enabled and the value
is the UTF-8 encoded name of another container. is the UTF-8 encoded name of another container. For more information
For more information about object versioning, about object versioning, see `Object versioning
see `Object versioning <http://docs.openstack.org/developer/ <https://docs.openstack.org/swift/latest/api/object_versioning.html>`_.
swift/api/object_versioning.html>`_.
in: header in: header
required: false required: false
type: string type: string
@ -832,7 +830,7 @@ X-Remove-Versions-Location:
X-Service-Token: X-Service-Token:
description: | description: |
A service token. See `OpenStack Service Using Composite Tokens A service token. See `OpenStack Service Using Composite Tokens
<http://docs.openstack.org/developer/swift/overview_auth.html#openstack- <https://docs.openstack.org/swift/latest/overview_auth.html#openstack-
service-using-composite-tokens>`_ for more information. service-using-composite-tokens>`_ for more information.
in: header in: header
required: false required: false
@ -881,7 +879,7 @@ X-Trans-Id-Extra:
extra transaction information before you include it in the extra transaction information before you include it in the
``X-Trans-Id-Extra`` request header. For example, you can include ``X-Trans-Id-Extra`` request header. For example, you can include
extra transaction information when you upload `large objects extra transaction information when you upload `large objects
<http://docs.openstack.org/developer/swift/api/large_objects.html>`_ <https://docs.openstack.org/swift/latest/api/large_objects.html>`_
such as images. When such as images. When
you upload each segment and the manifest, include the same value you upload each segment and the manifest, include the same value
in the ``X-Trans-Id-Extra`` request header. If an error occurs, in the ``X-Trans-Id-Extra`` request header. If an error occurs,
@ -900,17 +898,16 @@ X-Versions-Location:
is set, versioning is disabled for this container. ``X-Versions-Location`` is set, versioning is disabled for this container. ``X-Versions-Location``
and ``X-History-Location`` cannot both be set at the same time. For more and ``X-History-Location`` cannot both be set at the same time. For more
information about object versioning, see `Object versioning information about object versioning, see `Object versioning
<http://docs.openstack.org/ developer/swift/api/object_versioning.html>`_. <https://docs.openstack.org/swift/latest/api/object_versioning.html>`_.
in: header in: header
required: false required: false
type: string type: string
X-Versions-Location_resp: X-Versions-Location_resp:
description: | description: |
If present, this container has versioning enabled and the value If present, this container has versioning enabled and the value
is the UTF-8 encoded name of another container. is the UTF-8 encoded name of another container. For more information
For more information about object versioning, about object versioning, see `Object versioning
see `Object versioning <http://docs.openstack.org/developer/ <https://docs.openstack.org/swift/latest/api/object_versioning.html>`_.
swift/api/object_versioning.html>`_.
in: header in: header
required: false required: false
type: string type: string
@ -948,8 +945,8 @@ bulk-delete:
When the ``bulk-delete`` query parameter is present in the POST When the ``bulk-delete`` query parameter is present in the POST
request, multiple objects or containers can be deleted request, multiple objects or containers can be deleted
with a single request. See `Bulk Delete with a single request. See `Bulk Delete
<http://docs.openstack.org/developer/swift/middleware.html?highlight= <https://docs.openstack.org/swift/latest/middleware.html#bulk-delete>`_
bulk#bulk-delete>`_ for how this feature is used. for how this feature is used.
in: query in: query
required: false required: false
type: string type: string
@ -975,8 +972,8 @@ extract-archive:
When the ``extract-archive`` query parameter is present in the POST When the ``extract-archive`` query parameter is present in the POST
request, an archive (tar file) is uploaded and extracted to request, an archive (tar file) is uploaded and extracted to
create multiple objects. See `Extract Archive create multiple objects. See `Extract Archive
<http://docs.openstack.org/developer/swift/middleware.html?highlight= <https://docs.openstack.org/swift/latest/middleware.html#extract-archive>`_
bulk#extract-archive>`_ for how this feature is used. for how this feature is used.
in: query in: query
required: false required: false
type: string type: string
@ -988,8 +985,7 @@ filename:
``Content-Disposition`` response header. Browsers can interpret ``Content-Disposition`` response header. Browsers can interpret
this file name value as a file attachment to save. For more this file name value as a file attachment to save. For more
information about temporary URLs, see `Temporary URL middleware information about temporary URLs, see `Temporary URL middleware
<http://docs.openstack.org/developer/ <https://docs.openstack.org/swift/latest/api/temporary_url_middleware.html>`_.
swift/api/temporary_url_middleware.html>`_.
in: query in: query
required: false required: false
type: string type: string
@ -1105,8 +1101,7 @@ temp_url_expires:
For example, ``1440619048`` or ``2015-08-26T19:57:28Z`` For example, ``1440619048`` or ``2015-08-26T19:57:28Z``
is equivalent to ``Mon, Wed, 26 Aug 2015 19:57:28 GMT``. For more is equivalent to ``Mon, Wed, 26 Aug 2015 19:57:28 GMT``. For more
information about temporary URLs, see `Temporary URL middleware information about temporary URLs, see `Temporary URL middleware
<http://docs.openstack.org/developer/swift/api/temporary <https://docs.openstack.org/swift/latest/api/temporary_url_middleware.html>`_.
_url_middleware.html>`_.
in: query in: query
required: true required: true
type: integer type: integer
@ -1117,8 +1112,7 @@ temp_url_sig:
method, expiration date, full path to the object, and the secret method, expiration date, full path to the object, and the secret
key for the temporary URL. For more information about temporary key for the temporary URL. For more information about temporary
URLs, see `Temporary URL middleware URLs, see `Temporary URL middleware
<http://docs.openstack.org/developer/swif <https://docs.openstack.org/swift/latest/api/temporary_url_middleware.html>`_.
t/api/temporary_url_middleware.html>`_.
in: query in: query
required: true required: true
type: string type: string

2
api-ref/source/storage-account-services.inc
View File

@ -7,7 +7,7 @@ Accounts
Lists containers for an account. Creates, updates, shows, and Lists containers for an account. Creates, updates, shows, and
deletes account metadata. For more information and concepts about deletes account metadata. For more information and concepts about
accounts see `Object Storage API overview accounts see `Object Storage API overview
<http://docs.openstack.org/developer/swift/api/object_api_v1_overview.html>`_. <https://docs.openstack.org/swift/latest/api/object_api_v1_overview.html>`_.

2
api-ref/source/storage-container-services.inc
View File

@ -8,7 +8,7 @@ Lists objects in a container. Creates, shows details for, and
deletes containers. Creates, updates, shows, and deletes container deletes containers. Creates, updates, shows, and deletes container
metadata. For more information and concepts about metadata. For more information and concepts about
containers see `Object Storage API overview containers see `Object Storage API overview
<http://docs.openstack.org/developer/swift/api/object_api_v1_overview.html>`_. <https://docs.openstack.org/swift/latest/api/object_api_v1_overview.html>`_.
Show container details and list objects Show container details and list objects

4
api-ref/source/storage-object-services.inc
View File

@ -8,9 +8,9 @@ Creates, replaces, shows details for, and deletes objects. Copies
objects from another object with a new or different name. Updates objects from another object with a new or different name. Updates
object metadata. For more information and concepts about object metadata. For more information and concepts about
objects see `Object Storage API overview objects see `Object Storage API overview
<http://docs.openstack.org/developer/swift/api/object_api_v1_overview.html>`_ <https://docs.openstack.org/swift/latest/api/object_api_v1_overview.html>`_
and `Large Objects and `Large Objects
<http://docs.openstack.org/developer/swift/api/large_objects.html>`_. <https://docs.openstack.org/swift/latest/api/large_objects.html>`_.
Get object content and metadata Get object content and metadata