diff options
| author |   Kiran Kamineni <kiran.k.kamineni@intel.com> | 2018-05-04 16:50:39 -0700 |
|---|---|---|
| committer |   Girish Havaldar <hg0071052@techmahindra.com> | 2018-05-15 17:21:53 +0000 |
| commit | ac134cb099afa6be09fbc5cdad5db0bcf7aee08a (patch) | |
| tree | cbcdf280db9285edfe8c6e62e094c6c4c6db302e /docs/usage.rst | |
| parent | d4b81c05a255a847bbf7f08caebe032492ad2ca5 (diff) | |
Adding a docs folder under sms repo
WORK IN PROGRESS
Adding a docs folder under sms
Issue-ID: AAF-185
Change-Id: I5ee3560cfda2100ad5207bb7e98d5cb9472e1325
Signed-off-by: Girish Havaldar <hg0071052@techmahindra.com>
Diffstat (limited to 'docs/usage.rst')
| -rw-r--r-- | docs/usage.rst | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/docs/usage.rst b/docs/usage.rst new file mode 100644 index 0000000..b35e9b5 --- /dev/null +++ b/docs/usage.rst @@ -0,0 +1,54 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2018 Intel Corporation, Inc + +Typical Usage Scenario +====================== + +.. 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 + -X POST \ + -d '{ + "name": "mysecretdomain" + }' + https://sms:10443/v1/sms/domain + + ## Add a new Secret + curl -H "Accept: application/json" --cacert ca.pem --cert client.cert --key client.key + -X POST \ + -d '{ + "name": "mysecret", + "values": { + "name": "rah", + "age": 35, + "password": "mypassword" + } + }' + https://sms:10443/v1/sms/domain/<domaincurltestdomain/secret + + + ## 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 + + ## 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 + + ## 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 + + ## 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 + +.. end |