openstacksdk/doc/source/users/resource2.rst
Brian Curtin 2be9e9b6ba Document the synchronized parameter.
It is apparently confusing that the `synchronized` parameter exists in
the class signature of each resource subclass, but it's not documented
anywhere. This change moves the parameter to _synchronized and pushes
documentation of the parameter down to the new/existing methods, as it's
not directly useful to end-users in the initializer, but is necessary in
those classmethods.

Change-Id: I42a01f24d44383889cccce2a2e89442eea1943d7
Closes-Bug: 1645007
2016-11-29 12:21:19 -05:00

584 B

Note: This class is in the process of being applied as the new base class for resources around the OpenStack SDK. Once that has been completed, this module will be drop the 2 suffix and be the only resource module.

Resource

openstack.resource2

Components

openstack.resource2.Body

openstack.resource2.Header

openstack.resource2.URI

The Resource class

openstack.resource2.Resource