Add docstrings to key_management resources
Change-Id: Iec326a56fb02d683e1b7cd9e7e67786461b75cc7 Closes-Bug: 1428322 Closes-Bug: 1458102
This commit is contained in:
@@ -28,10 +28,17 @@ class Container(resource.Resource):
|
||||
allow_list = True
|
||||
|
||||
# Properties
|
||||
#: A URI for this container
|
||||
container_ref = resource.prop('container_ref')
|
||||
#: The timestamp when this container was created
|
||||
created = resource.prop('created')
|
||||
#: The name of this container
|
||||
name = resource.prop('name')
|
||||
#: A list of references to secrets in this container
|
||||
secret_refs = resource.prop('secret_refs')
|
||||
#: The status of this container
|
||||
status = resource.prop('status')
|
||||
#: The type of this container
|
||||
type = resource.prop('type')
|
||||
#: The timestamp when this container was updated
|
||||
updated = resource.prop('updated')
|
||||
|
||||
@@ -27,10 +27,18 @@ class Order(resource.Resource):
|
||||
allow_list = True
|
||||
|
||||
# Properties
|
||||
# TODO(briancurtin): not documented
|
||||
error_reason = resource.prop('error_reason')
|
||||
# TODO(briancurtin): not documented
|
||||
error_status_code = resource.prop('error_status_code')
|
||||
#: a dictionary containing key-value parameters which specify the
|
||||
#: details of an order request
|
||||
meta = resource.prop('meta')
|
||||
#: A URI for this order
|
||||
order_ref = resource.prop('order_ref')
|
||||
#: TODO(briancurtin): not documented
|
||||
secret_ref = resource.prop('secret_ref')
|
||||
# The status of this order
|
||||
status = resource.prop('status')
|
||||
# The type of order
|
||||
type = resource.prop('type')
|
||||
|
||||
@@ -29,12 +29,22 @@ class Secret(resource.Resource):
|
||||
allow_list = True
|
||||
|
||||
# Properties
|
||||
#: Metadata provided by a user or system for informational purposes
|
||||
algorithm = resource.prop('algorithm')
|
||||
#: Metadata provided by a user or system for informational purposes.
|
||||
#: Value must be greater than zero.
|
||||
bit_length = resource.prop('bit_length')
|
||||
#: A list of content types
|
||||
content_types = resource.prop('content_types')
|
||||
#: Once this timestamp has past, the secret will no longer be available.
|
||||
expiration = resource.prop('expiration')
|
||||
#: The type/mode of the algorithm associated with the secret information.
|
||||
mode = resource.prop('mode')
|
||||
#: The name of the secret set by the user
|
||||
name = resource.prop('name')
|
||||
#: A URI to the sercret
|
||||
secret_ref = resource.prop('secret_ref')
|
||||
#: The status of this secret
|
||||
status = resource.prop('status')
|
||||
#: A timestamp when this secret was updated
|
||||
updated = resource.prop('updated')
|
||||
|
||||
Reference in New Issue
Block a user