diff options
| author |   Kiran Kamineni <kiran.k.kamineni@intel.com> | 2018-05-22 17:38:16 -0700 |
|---|---|---|
| committer |   Girish Havaldar <hg0071052@techmahindra.com> | 2018-05-23 06:30:48 +0000 |
| commit | 78d594b5a54dd45aebe3ac05a256ce43ca4213b7 (patch) | |
| tree | 78fe13a2547763a2bf7465b7150e3a4d246d310e /docs/usage.rst | |
| parent | cd6ef3a93d3dae845ba0333de9caa52c99923e9b (diff) | |
Add release notes and fix docs
Add release notes for SMS
Fix other docs issues in SMS
Issue-ID: AAF-185
Change-Id: Ib3860018229b61942ab8a48cfdafe0b3f21ceed1
Signed-off-by: Kiran Kamineni <kiran.k.kamineni@intel.com>
Diffstat (limited to 'docs/usage.rst')
| -rw-r--r-- | docs/usage.rst | 75 |
1 files changed, 56 insertions, 19 deletions
diff --git a/docs/usage.rst b/docs/usage.rst index b35e9b5..ee46458 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -2,22 +2,34 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2018 Intel Corporation, Inc -Typical Usage Scenario -====================== +Usage Scenario +============== + +**Create a Domain** + +This is the root where you will store your secrets. .. code-block:: guess - ## Create a Domain - ## This is where all your secrets will be stored - curl -H "Accept: application/json" --cacert ca.pem --cert client.cert --key client.key + curl -H "Accept: application/json" --cacert ca.pem --cert client.cert --key client.key -X POST \ -d '{ "name": "mysecretdomain" }' - https://sms:10443/v1/sms/domain + https://aaf-sms.onap:10443/v1/sms/domain - ## Add a new Secret - curl -H "Accept: application/json" --cacert ca.pem --cert client.cert --key client.key +.. end + +--------------- + +**Add a new Secret** + +Store a new secret in your created Domain. +Secrets have a name and a map containing key value pairs. + +.. code-block:: guess + + curl -H "Accept: application/json" --cacert ca.pem --cert client.cert --key client.key -X POST \ -d '{ "name": "mysecret", @@ -27,28 +39,53 @@ Typical Usage Scenario "password": "mypassword" } }' - https://sms:10443/v1/sms/domain/<domaincurltestdomain/secret + https://aaf-sms.onap:10443/v1/sms/domain/<PREVIOUSLY CREATED DOMAIN NAME>/secret + +.. end + +--------------- +**List all Secret Names in a Domain** + +.. code-block:: guess - ## List all Secrets under a Domain curl -H "Accept: application/json" --cacert ca.pem --cert client.cert --key client.key -X GET \ - https://sms:10443/v1/sms/domain/curltestdomain/secret + https://aaf-sms.onap:10443/v1/sms/domain/<PREVIOUSLY CREATED DOMAIN NAME>/secret + +.. end + +--------------- + +**Get a previously stored Secret from Domain** + +.. code-block:: guess - ## Get a Secret in a Domain curl -H "Accept: application/json" --cacert ca.pem --cert client.cert --key client.key -X GET \ - https://sms:10443/v1/sms/domain/curltestdomain/secret/curltestsecret1 + https://aaf-sms.onap:10443/v1/sms/domain/<PREVIOUSLY CREATED DOMAIN NAME>/secret/<PREVIOUSLY CREATED SECRET NAME> + +.. end + +--------------- + +**Delete a Secret in specified Domain** + +.. code-block:: guess - ## Delete a Secret in specified Domain curl -H "Accept: application/json" --cacert ca.pem --cert client.cert --key client.key -X DELETE \ - https://sms:10443/v1/sms/domain/curltestdomain/secret/curltestsecret1 + https://aaf-sms.onap:10443/v1/sms/domain/<PREVIOUSLY CREATED DOMAIN NAME>/secret/<PREVIOUSLY CREATED SECRET NAME> + +.. end + +--------------- + +**Delete a Domain** + +.. code-block:: guess - ## Delete a Domain - ## This will delete all the secrets in that Domain curl -H "Accept: application/json" --cacert ca.pem --cert client.cert --key client.key -X DELETE \ - https://sms:10443/v1/sms/domain/curltestdomain - + https://aaf-sms.onap:10443/v1/sms/domain/<PREVIOUSLY CREATED DOMAIN NAME> .. end |