Skip to content

Commit d21c534

Browse files
committed
Updated docks & readme
1 parent 546ff44 commit d21c534

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ OpenStack services, and versions of services, are supported.
1717
* [Contributing guide](/CONTRIBUTING.md)
1818
* [Code of Conduct](/CODE_OF_CONDUCT.md)
1919

20+
## Backward incompatibility
21+
22+
Due to new [object typehint](https://wiki.php.net/rfc/object-typehint) since PHP 7.2, class `OpenStack\ObjectStore\v1\Models\Object` had to be renamed to `OpenStack\ObjectStore\v1\Models\StorageObject`
23+
2024
## Getting help
2125

2226
- Meet us on Slack: https://phpopencloud.slack.com ([Get your invitation](https://slackpass.io/phpopencloud))

doc/services/object-store/v1/objects.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Download an object
2727
------------------
2828

2929
.. sample:: object_store/v1/objects/download.php
30-
.. refdoc:: OpenStack/ObjectStore/v1/Models/Object.html#method_download
30+
.. refdoc:: OpenStack/ObjectStore/v1/Models/StorageObject.html#method_download
3131

3232
As you will notice, a Stream_ object is returned by this call. For more information about dealing with streams, please
3333
consult `Guzzle's docs`_.
@@ -88,19 +88,19 @@ Copy object
8888
-----------
8989

9090
.. sample:: object_store/v1/objects/copy.php
91-
.. refdoc:: OpenStack/ObjectStore/v1/Models/Object.html#method_copy
91+
.. refdoc:: OpenStack/ObjectStore/v1/Models/StorageObject.html#method_copy
9292

9393
Delete object
9494
-------------
9595

9696
.. sample:: object_store/v1/objects/delete.php
97-
.. refdoc:: OpenStack/ObjectStore/v1/Models/Object.html#method_delete
97+
.. refdoc:: OpenStack/ObjectStore/v1/Models/StorageObject.html#method_delete
9898

9999
Get metadata
100100
------------
101101

102102
.. sample:: object_store/v1/objects/get_metadata.php
103-
.. refdoc:: OpenStack/ObjectStore/v1/Models/Object.html#method_getMetadata
103+
.. refdoc:: OpenStack/ObjectStore/v1/Models/StorageObject.html#method_getMetadata
104104

105105
The returned value will be a standard associative array, or hash, containing arbitrary key/value pairs. These will
106106
correspond to the values set either when the object was created, or when a previous ``mergeMetadata`` or
@@ -110,7 +110,7 @@ Replace all metadata with new values
110110
------------------------------------
111111

112112
.. sample:: object_store/v1/objects/reset_metadata.php
113-
.. refdoc:: OpenStack/ObjectStore/v1/Models/Object.html#method_resetMetadata
113+
.. refdoc:: OpenStack/ObjectStore/v1/Models/StorageObject.html#method_resetMetadata
114114

115115
In order to replace all existing metadata with a set of new values, you can use this operation. Any existing metadata
116116
items which not specified in the new set will be removed. For example, say an account has the following metadata
@@ -140,7 +140,7 @@ Merge new metadata values with existing
140140
---------------------------------------
141141

142142
.. sample:: object_store/v1/objects/merge_metadata.php
143-
.. refdoc:: OpenStack/ObjectStore/v1/Models/Object.html#method_mergeMetadata
143+
.. refdoc:: OpenStack/ObjectStore/v1/Models/StorageObject.html#method_mergeMetadata
144144

145145
In order to merge a set of new metadata values with the existing metadata set, you can use this operation. Any existing
146146
metadata items which are not specified in the new set will be preserved. For example, say an account has the following

0 commit comments

Comments
 (0)