3c935a82d1
This is the start of a reworking of our docs around the secrets API. There will be a number of follow-up patches before this document will be considered complete. Until this document is considered complete, I'm not adding this page to the table of contents. Also, to limit individual CR size, I've tossed TODOs on the areas that will be worked on in future CRs. Change-Id: I8599628d51f4b5aae9ec1b8fd76f419d5b38bdcc
35 lines
733 B
ReStructuredText
35 lines
733 B
ReStructuredText
*************************
|
|
Secrets API - Quick Start
|
|
*************************
|
|
|
|
The secrets resource is the heart of the Barbican service. It provides access
|
|
to the secret / keying material stored in the system.
|
|
|
|
Barbican supports the storage of data for various content-types securely.
|
|
|
|
TODO(jvrbanac): Add more information about the secrets resource
|
|
|
|
|
|
What is a secret
|
|
################
|
|
|
|
TODO(jvrbanac): Add a summary here
|
|
|
|
|
|
How to create a secret
|
|
######################
|
|
TODO(jvrbanac): Add examples
|
|
|
|
How to update a secret
|
|
######################
|
|
TODO(jvrbanac): Add examples
|
|
|
|
How to retrieve a secret
|
|
########################
|
|
TODO(jvrbanac): Add examples
|
|
|
|
How to delete a secret
|
|
######################
|
|
TODO(jvrbanac): Add examples
|
|
|