@@ -5,6 +5,7 @@ Show details for an object
55--------------------------
66
77.. sample :: object_store/v1/objects/get.php
8+ .. refdoc :: OpenStack/ObjectStore/v1/Models/Container.html#method_getObject
89
910At this point, the object returned is *empty * because we did not execute a HTTP request to receive the state of the
1011container from the API. This is in accordance with one of the SDK's general policies of not assuming too much at the
@@ -26,6 +27,7 @@ Download an object
2627------------------
2728
2829.. sample :: object_store/v1/objects/download.php
30+ .. refdoc :: OpenStack/ObjectStore/v1/Models/Object.html#method_download
2931
3032As you will notice, a Stream _ object is returned by this call. For more information about dealing with streams, please
3133consult `Guzzle's docs `_.
@@ -37,6 +39,7 @@ List objects
3739------------
3840
3941.. sample :: object_store/v1/objects/list.php
42+ .. refdoc :: OpenStack/ObjectStore/v1/Models/Container.html#method_listObjects
4043
4144When listing objects, you must be aware that not *all * information about a container is returned in a collection.
4245Very often only the MD5 hash, last modified date, bytes used, content type and object name will be
@@ -51,12 +54,15 @@ returned. If you would like to access all of the remote state of a collection it
5154
5255 If you have a large collection of $object, this will slow things down because you're issuing a HEAD request per object.
5356
57+ .. include :: /common/generators.rst
58+
5459Create an object
5560----------------
5661
5762When creating an object, you can upload its content according to a string representation:
5863
5964.. sample :: object_store/v1/objects/create.php
65+ .. refdoc :: OpenStack/ObjectStore/v1/Models/Container.html#method_createObject
6066
6167If that is not optimal or convenient, you can use a stream instead. Any instance of ``\Psr\Http\Message\StreamInterface ``
6268is acceptable. For example, to use a normal Guzzle stream:
@@ -76,21 +82,25 @@ uploading, this is what happens under the hood:
7682To upload a DLO, you need to call:
7783
7884.. sample :: object_store/v1/objects/create_large_object.php
85+ .. refdoc :: OpenStack/ObjectStore/v1/Models/Container.html#method_createLargeObject
7986
8087Copy object
8188-----------
8289
8390.. sample :: object_store/v1/objects/copy.php
91+ .. refdoc :: OpenStack/ObjectStore/v1/Models/Object.html#method_copy
8492
8593Delete object
8694-------------
8795
8896.. sample :: object_store/v1/objects/delete.php
97+ .. refdoc :: OpenStack/ObjectStore/v1/Models/Object.html#method_delete
8998
9099Get metadata
91100------------
92101
93102.. sample :: object_store/v1/objects/get_metadata.php
103+ .. refdoc :: OpenStack/ObjectStore/v1/Models/Object.html#method_getMetadata
94104
95105The returned value will be a standard associative array, or hash, containing arbitrary key/value pairs. These will
96106correspond to the values set either when the object was created, or when a previous ``mergeMetadata `` or
@@ -100,6 +110,7 @@ Replace all metadata with new values
100110------------------------------------
101111
102112.. sample :: object_store/v1/objects/reset_metadata.php
113+ .. refdoc :: OpenStack/ObjectStore/v1/Models/Object.html#method_resetMetadata
103114
104115In order to replace all existing metadata with a set of new values, you can use this operation. Any existing metadata
105116items which not specified in the new set will be removed. For example, say an account has the following metadata
@@ -129,6 +140,7 @@ Merge new metadata values with existing
129140---------------------------------------
130141
131142.. sample :: object_store/v1/objects/merge_metadata.php
143+ .. refdoc :: OpenStack/ObjectStore/v1/Models/Object.html#method_mergeMetadata
132144
133145In order to merge a set of new metadata values with the existing metadata set, you can use this operation. Any existing
134146metadata items which are not specified in the new set will be preserved. For example, say an account has the following
0 commit comments