summaryrefslogtreecommitdiff
path: root/barbicanclient
diff options
context:
space:
mode:
authoryushangbin <yushb@gohighsec.com>2017-07-25 15:52:01 +0800
committeryushangbin <yushb@gohighsec.com>2017-07-25 15:52:01 +0800
commitea509a5d7ad6573805b53013b577ac0b05c6e0fe (patch)
treeb705da0f40aa00667e7217a9ea75d4c4aade381d /barbicanclient
parentb045cbdd164401cd281208ab5bf6dbd041bdc349 (diff)
downloadpython-barbicanclient-ea509a5d7ad6573805b53013b577ac0b05c6e0fe.tar.gz
Update api references according to refactor result
Change-Id: I40c51315fe2d1751240e5b28fd8e0bf72cc215f1
Diffstat (limited to 'barbicanclient')
-rw-r--r--barbicanclient/v1/acls.py8
-rw-r--r--barbicanclient/v1/cas.py2
-rw-r--r--barbicanclient/v1/containers.py6
-rw-r--r--barbicanclient/v1/orders.py6
-rw-r--r--barbicanclient/v1/secrets.py4
5 files changed, 13 insertions, 13 deletions
diff --git a/barbicanclient/v1/acls.py b/barbicanclient/v1/acls.py
index 9292d12..3968ce0 100644
--- a/barbicanclient/v1/acls.py
+++ b/barbicanclient/v1/acls.py
@@ -432,8 +432,8 @@ class ACLManager(base.BaseEntityManager):
:param str operation_type: Type indicating which class of Barbican
operations this ACL is defined for e.g. 'read' operations
:returns: ACL object instance
- :rtype: :class:`barbicanclient.acls.SecretACL` or
- :class:`barbicanclient.acls.ContainerACL`
+ :rtype: :class:`barbicanclient.v1.acls.SecretACL` or
+ :class:`barbicanclient.v1.acls.ContainerACL`
"""
entity_type = ACL.identify_ref_type(entity_ref)
@@ -448,8 +448,8 @@ class ACLManager(base.BaseEntityManager):
:param str entity_ref: Full HATEOAS reference to a secret or container.
:returns: ACL entity object instance
- :rtype: :class:`barbicanclient.acls.SecretACL` or
- :class:`barbicanclient.acls.ContainerACL`
+ :rtype: :class:`barbicanclient.v1.acls.SecretACL` or
+ :class:`barbicanclient.v1.acls.ContainerACL`
:raises barbicanclient.exceptions.HTTPAuthError: 401 Responses
:raises barbicanclient.exceptions.HTTPClientError: 4xx Responses
"""
diff --git a/barbicanclient/v1/cas.py b/barbicanclient/v1/cas.py
index 8c46346..d076e4b 100644
--- a/barbicanclient/v1/cas.py
+++ b/barbicanclient/v1/cas.py
@@ -199,7 +199,7 @@ class CAManager(base.BaseEntityManager):
:param str ca_ref: Full HATEOAS reference to a CA
:returns: CA object retrieved from Barbican
- :rtype: :class:`barbicanclient.cas.CA`
+ :rtype: :class:`barbicanclient.v1.cas.CA`
:raises barbicanclient.exceptions.HTTPAuthError: 401 Responses
:raises barbicanclient.exceptions.HTTPClientError: 4xx Responses
:raises barbicanclient.exceptions.HTTPServerError: 5xx Responses
diff --git a/barbicanclient/v1/containers.py b/barbicanclient/v1/containers.py
index fad01f7..45cdf48 100644
--- a/barbicanclient/v1/containers.py
+++ b/barbicanclient/v1/containers.py
@@ -621,7 +621,7 @@ class ContainerManager(base.BaseEntityManager):
:param name: A friendly name for the Container
:param secrets: Secrets to populate when creating a Container
:returns: Container
- :rtype: :class:`barbicanclient.containers.Container`
+ :rtype: :class:`barbicanclient.v1.containers.Container`
:raises barbicanclient.exceptions.HTTPAuthError: 401 Responses
:raises barbicanclient.exceptions.HTTPClientError: 4xx Responses
:raises barbicanclient.exceptions.HTTPServerError: 5xx Responses
@@ -644,7 +644,7 @@ class ContainerManager(base.BaseEntityManager):
:param private_key: Secret object containing a Private Key
:param private_key_passphrase: Secret object containing a passphrase
:returns: RSAContainer
- :rtype: :class:`barbicanclient.containers.RSAContainer`
+ :rtype: :class:`barbicanclient.v1.containers.RSAContainer`
:raises barbicanclient.exceptions.HTTPAuthError: 401 Responses
:raises barbicanclient.exceptions.HTTPClientError: 4xx Responses
:raises barbicanclient.exceptions.HTTPServerError: 5xx Responses
@@ -671,7 +671,7 @@ class ContainerManager(base.BaseEntityManager):
:param private_key: Secret object containing a Private Key
:param private_key_passphrase: Secret object containing a passphrase
:returns: CertificateContainer
- :rtype: :class:`barbicanclient.containers.CertificateContainer`
+ :rtype: :class:`barbicanclient.v1.containers.CertificateContainer`
:raises barbicanclient.exceptions.HTTPAuthError: 401 Responses
:raises barbicanclient.exceptions.HTTPClientError: 4xx Responses
:raises barbicanclient.exceptions.HTTPServerError: 5xx Responses
diff --git a/barbicanclient/v1/orders.py b/barbicanclient/v1/orders.py
index 056d742..3b62f97 100644
--- a/barbicanclient/v1/orders.py
+++ b/barbicanclient/v1/orders.py
@@ -453,7 +453,7 @@ class OrderManager(base.BaseEntityManager):
:param payload_content_type: The format/type of the secret data
:param expiration: The expiration time of the secret in ISO 8601 format
:returns: KeyOrder
- :rtype: :class:`barbicanclient.orders.KeyOrder`
+ :rtype: :class:`barbicanclient.v1.orders.KeyOrder`
:raises barbicanclient.exceptions.HTTPAuthError: 401 Responses
:raises barbicanclient.exceptions.HTTPClientError: 4xx Responses
:raises barbicanclient.exceptions.HTTPServerError: 5xx Responses
@@ -478,7 +478,7 @@ class OrderManager(base.BaseEntityManager):
:param payload_content_type: The format/type of the secret data
:param expiration: The expiration time of the secret in ISO 8601 format
:returns: AsymmetricOrder
- :rtype: :class:`barbicanclient.orders.AsymmetricOrder`
+ :rtype: :class:`barbicanclient.v1.orders.AsymmetricOrder`
:raises barbicanclient.exceptions.HTTPAuthError: 401 Responses
:raises barbicanclient.exceptions.HTTPClientError: 4xx Responses
:raises barbicanclient.exceptions.HTTPServerError: 5xx Responses
@@ -505,7 +505,7 @@ class OrderManager(base.BaseEntityManager):
:param profile: The profile of certificate to use
:param request_data: The CSR content
:returns: CertificateOrder
- :rtype: :class:`barbicanclient.orders.CertificateOrder`
+ :rtype: :class:`barbicanclient.v1.orders.CertificateOrder`
"""
return CertificateOrder(api=self._api, name=name,
request_type=request_type,
diff --git a/barbicanclient/v1/secrets.py b/barbicanclient/v1/secrets.py
index d721ce2..c2577d0 100644
--- a/barbicanclient/v1/secrets.py
+++ b/barbicanclient/v1/secrets.py
@@ -449,7 +449,7 @@ class SecretManager(base.BaseEntityManager):
payload decryption. Setting this can lead to unexpected results.
See Launchpad Bug #1419166.
:returns: Secret object retrieved from Barbican
- :rtype: :class:`barbicanclient.secrets.Secret`
+ :rtype: :class:`barbicanclient.v1.secrets.Secret`
:raises barbicanclient.exceptions.HTTPAuthError: 401 Responses
:raises barbicanclient.exceptions.HTTPClientError: 4xx Responses
:raises barbicanclient.exceptions.HTTPServerError: 5xx Responses
@@ -510,7 +510,7 @@ class SecretManager(base.BaseEntityManager):
:param secret_type: The secret type for this secret key
:param expiration: The expiration time of the secret in ISO 8601 format
:returns: A new Secret object
- :rtype: :class:`barbicanclient.secrets.Secret`
+ :rtype: :class:`barbicanclient.v1.secrets.Secret`
:raises barbicanclient.exceptions.HTTPAuthError: 401 Responses
:raises barbicanclient.exceptions.HTTPClientError: 4xx Responses
:raises barbicanclient.exceptions.HTTPServerError: 5xx Responses