{"action":"created","comment":{"url":"https://api.github.com/repos/rackerlabs/docs-barbican/pulls/comments/70896736","id":70896736,"diff_hunk":"@@ -18,90 +18,120 @@ credential, configuration file, etc.  The typical use case for a secret\n is an encryption key that you wish to store away from prying eyes.\n \n Some examples of a secret may include:\n-  * Private Key\n-  * Certificate\n-  * Password\n-  * SSH Keys\n+  * Private RSA Key\n+  * X.509 Certificate\n+  * Passphrase\n+  * SSH Key\n \n The secret schema represents the actual secret or key that is presented\n to the |product name| service.  Secrets themselves can be any format.\n \n-The following example shows the specification for a secret that has been added to |product name|:\n+The following example shows the specification for a secret passphrase that\n+has been added to |product name|:\n \n .. code::\n \n     {\n-        \"uuid\": \"e2b633c7-fda5-4be8-b42c-9a2c9280284d\",\n-        \"name\": \"AES key\",\n-        \"expiration\": \"2018-02-28T19:14:44.180394\",\n-        \"secret\": \"b7990b786ee9659b43e6b1cd6136de07d9c5…\",\n-        \"secret_type\": \"application/aes-256-cbc\",\n-      }\n+        \"status\": \"ACTIVE\",\n+        \"secret_type\": \"passphrase\",\n+        \"updated\": \"2016-07-08T21:51:19\",\n+        \"name\": \"Database administrator passphrase\",\n+        \"algorithm\": null,\n+        \"created\": \"2016-07-08T21:51:19\",\n+        \"secret_ref\": \"https://iad.keep.api.rackspacecloud.com/v1/secrets/0f1afafb-36f7-4976-a3bc-2cc3b4af4059\",\n+        \"content_types\": {\n+            \"default\": \"text/plain\"\n+        },\n+        \"creator_id\": \"123456\",\n+        \"mode\": null,\n+        \"bit_length\": null,\n+        \"expiration\": \"2020-01-31T00:00:00\"\n+    }\n \n A secret consists of the following elements:\n \n-+--------------+---------------------------------------------------------------+\n-| Element      | Description                                                   |\n-+==============+===============================================================+\n-| uuid         | Unique identifier for the secret. This value is assigned by   |\n-|              | the API.                                                      |\n-+--------------+---------------------------------------------------------------+\n-| name         | Human readable name for the secret.                           |\n-+--------------+---------------------------------------------------------------+\n-| expiration   | The expiration date for the secret in ISO-8601 format. Once   |\n-|              | the secret has expired, it will no longer be returned by the  |\n-|              | API or agent.                                                 |\n-+--------------+---------------------------------------------------------------+\n-| secret       | The base64-encoded value of the secret.                       |\n-+--------------+---------------------------------------------------------------+\n-| secret\\_type | (optional) The secret type. The possible secret types are:    |\n-|              |                                                               |\n-|              |         - symmetric: Used for storing byte arrays such as     |\n-|              |           keys suitable for symmetric encryption.             |\n-|              |         - public: Used for storing the public key of an       |\n-|              |           asymmetric keypair.                                 |\n-|              |         - private: Used for storing the private key of an     |\n-|              |           asymmetric keypair.                                 |\n-|              |         - passphrase: Used for storing plain text             |\n-|              |           passphrases.                                        |\n-|              |         - certificate: Used for storing cryptographic         |\n-|              |           certificates such as X.509 certificates.            |\n-|              |                                                               |\n-+--------------+---------------------------------------------------------------+\n++---------------+---------------------------------------------------------------+\n+| Element       | Description                                                   |\n++===============+===============================================================+\n+| name          | Human readable name for the secret.                           |\n++---------------+---------------------------------------------------------------+\n+| status        | The secret's status.  Possible values are ``ACTIVE``,         |\n+|               | ``PENDING``, ``ERROR``.                                       |\n++---------------+---------------------------------------------------------------+\n+| secret\\_ref   | Unique identifier for the secret. This value is assigned by   |\n+|               | the API.                                                      |\n++---------------+---------------------------------------------------------------+\n+| secret\\_type  | The secret type. The possible secret types are:               |\n+|               |                                                               |\n+|               |     - ``symmetric``: Used for storing byte arrays such as     |\n+|               |       keys suitable for symmetric encryption.                 |\n+|               |     - ``public``: Used for storing the public key of an       |\n+|               |       asymmetric keypair.                                     |\n+|               |     - ``private``: Used for storing the private key of an     |\n+|               |       asymmetric keypair.                                     |\n+|               |     - ``passphrase``: Used for storing plain text             |\n+|               |       passphrases.                                            |\n+|               |     - ``certificate``: Used for storing cryptographic         |\n+|               |       certificates such as X.509 certificates.                |\n+|               |     - ``opaque`` (default): Used for storing unformatted data |\n+|               |                                                               |\n++---------------+---------------------------------------------------------------+\n+| creator_id    | User ID of the user who created the secret.                   |\n++---------------+---------------------------------------------------------------+\n+| created       | UTC time stamp of when the secret was created.                |\n++---------------+---------------------------------------------------------------+\n+| updated       | UTC time stamp of when the secret was last updated.           |\n++---------------+---------------------------------------------------------------+\n+| expiration    | The expiration date for the secret in ISO-8601 format. Once   |\n+|               | the secret has expired, it will no longer be returned by the  |\n+|               | API.                                                          |\n++---------------+---------------------------------------------------------------+\n+| content_types | Media Type(s) associated with this secret.                    |\n++---------------+---------------------------------------------------------------+\n+| algorithm     | (Deprecated) Metadata describing the algorithm associated     |\n+|               | with the secret.                                              |\n++---------------+---------------------------------------------------------------+\n+| mode          | (Deprecated) Metadata describing the mode of the algorithm    |\n+|               | associated with the secret.                                   |\n++---------------+---------------------------------------------------------------+\n+| bit_length    | (Deprecated) Metadata describing the bit length of the secret.|\n++---------------+---------------------------------------------------------------+\n \n \n You can use one of the following methods to store a secret:\n \n--  Submit a **POST** request against the secrets resource. Include\n-   the secret metadata in the JSON body and include the secret itself\n-   in the ``payload`` parameter.\n+-  Submit a **POST** request against the secrets resource. Include both\n+   the secret metadata and the secret data itself (the payload as it is called\n+   in Cloud Keep) in the JSON body.\n \n--  Submit a **POST** request without a ``payload`` parameter against the\n+-  Submit a **POST** request without a ``payload`` attribute against the\n    secrets resource and then include the payload in a subsequent **PUT**\n-   request. This mode enables you to upload a binary file to the\n-   |product name| database directly for encrypted storage.\n+   request against the secret that was created by the POST. This mode enables\n+   you to upload payloads that cannot be included inside the JSON body, such\n+   as a binary file, to the |product name| system directly for encrypted storage.","path":"api-docs/concepts.rst","position":148,"original_position":148,"commit_id":"ee06d9ac2afd26543695c902c0c1c0e3e62b2dcc","original_commit_id":"ee06d9ac2afd26543695c902c0c1c0e3e62b2dcc","user":{"login":"meker12","id":6391769,"avatar_url":"https://avatars.githubusercontent.com/u/6391769?v=3","gravatar_id":"","url":"https://api.github.com/users/meker12","html_url":"https://github.com/meker12","followers_url":"https://api.github.com/users/meker12/followers","following_url":"https://api.github.com/users/meker12/following{/other_user}","gists_url":"https://api.github.com/users/meker12/gists{/gist_id}","starred_url":"https://api.github.com/users/meker12/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/meker12/subscriptions","organizations_url":"https://api.github.com/users/meker12/orgs","repos_url":"https://api.github.com/users/meker12/repos","events_url":"https://api.github.com/users/meker12/events{/privacy}","received_events_url":"https://api.github.com/users/meker12/received_events","type":"User","site_admin":false},"body":"- Submit a **POST** request to the secrets resource without a ``payload`` attribute to create a secret, \r\n   and then immediately submit a **PUT** request that includes the payload. Use this method if you\r\n   have a payload that cannot be included in the JSON body, for example a binary file. When you submit\r\n   the **PUT** request the payload is uploaded directly to |product name| for encrypted storage.  (See\r\n   :ref:`Update secret <put-secret>`).","created_at":"2016-07-14T22:40:53Z","updated_at":"2016-07-14T22:40:53Z","html_url":"https://github.com/rackerlabs/docs-barbican/pull/67#discussion_r70896736","pull_request_url":"https://api.github.com/repos/rackerlabs/docs-barbican/pulls/67","_links":{"self":{"href":"https://api.github.com/repos/rackerlabs/docs-barbican/pulls/comments/70896736"},"html":{"href":"https://github.com/rackerlabs/docs-barbican/pull/67#discussion_r70896736"},"pull_request":{"href":"https://api.github.com/repos/rackerlabs/docs-barbican/pulls/67"}}},"pull_request":{"url":"https://api.github.com/repos/rackerlabs/docs-barbican/pulls/67","id":77207181,"html_url":"https://github.com/rackerlabs/docs-barbican/pull/67","diff_url":"https://github.com/rackerlabs/docs-barbican/pull/67.diff","patch_url":"https://github.com/rackerlabs/docs-barbican/pull/67.patch","issue_url":"https://api.github.com/repos/rackerlabs/docs-barbican/issues/67","number":67,"state":"open","locked":false,"title":"Update examples and other inconsistencies","user":{"login":"dmend","id":716126,"avatar_url":"https://avatars.githubusercontent.com/u/716126?v=3","gravatar_id":"","url":"https://api.github.com/users/dmend","html_url":"https://github.com/dmend","followers_url":"https://api.github.com/users/dmend/followers","following_url":"https://api.github.com/users/dmend/following{/other_user}","gists_url":"https://api.github.com/users/dmend/gists{/gist_id}","starred_url":"https://api.github.com/users/dmend/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dmend/subscriptions","organizations_url":"https://api.github.com/users/dmend/orgs","repos_url":"https://api.github.com/users/dmend/repos","events_url":"https://api.github.com/users/dmend/events{/privacy}","received_events_url":"https://api.github.com/users/dmend/received_events","type":"User","site_admin":false},"body":"This PR introduces a lot of updates to the documentation.  Some changes were made because the current docs are incorrect.  Others were made for clarity and consistency.","created_at":"2016-07-12T23:13:43Z","updated_at":"2016-07-14T22:40:53Z","closed_at":null,"merged_at":null,"merge_commit_sha":"c940d2133d81632430a8d82d0e6dd4283b76526c","assignee":null,"assignees":[],"milestone":null,"commits_url":"https://api.github.com/repos/rackerlabs/docs-barbican/pulls/67/commits","review_comments_url":"https://api.github.com/repos/rackerlabs/docs-barbican/pulls/67/comments","review_comment_url":"https://api.github.com/repos/rackerlabs/docs-barbican/pulls/comments{/number}","comments_url":"https://api.github.com/repos/rackerlabs/docs-barbican/issues/67/comments","statuses_url":"https://api.github.com/repos/rackerlabs/docs-barbican/statuses/ee06d9ac2afd26543695c902c0c1c0e3e62b2dcc","head":{"label":"dmend:doc-update","ref":"doc-update","sha":"ee06d9ac2afd26543695c902c0c1c0e3e62b2dcc","user":{"login":"dmend","id":716126,"avatar_url":"https://avatars.githubusercontent.com/u/716126?v=3","gravatar_id":"","url":"https://api.github.com/users/dmend","html_url":"https://github.com/dmend","followers_url":"https://api.github.com/users/dmend/followers","following_url":"https://api.github.com/users/dmend/following{/other_user}","gists_url":"https://api.github.com/users/dmend/gists{/gist_id}","starred_url":"https://api.github.com/users/dmend/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dmend/subscriptions","organizations_url":"https://api.github.com/users/dmend/orgs","repos_url":"https://api.github.com/users/dmend/repos","events_url":"https://api.github.com/users/dmend/events{/privacy}","received_events_url":"https://api.github.com/users/dmend/received_events","type":"User","site_admin":false},"repo":{"id":62915754,"name":"docs-barbican","full_name":"dmend/docs-barbican","owner":{"login":"dmend","id":716126,"avatar_url":"https://avatars.githubusercontent.com/u/716126?v=3","gravatar_id":"","url":"https://api.github.com/users/dmend","html_url":"https://github.com/dmend","followers_url":"https://api.github.com/users/dmend/followers","following_url":"https://api.github.com/users/dmend/following{/other_user}","gists_url":"https://api.github.com/users/dmend/gists{/gist_id}","starred_url":"https://api.github.com/users/dmend/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dmend/subscriptions","organizations_url":"https://api.github.com/users/dmend/orgs","repos_url":"https://api.github.com/users/dmend/repos","events_url":"https://api.github.com/users/dmend/events{/privacy}","received_events_url":"https://api.github.com/users/dmend/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/dmend/docs-barbican","description":"Developer documentation source for Rackspace Cloud Keep API","fork":true,"url":"https://api.github.com/repos/dmend/docs-barbican","forks_url":"https://api.github.com/repos/dmend/docs-barbican/forks","keys_url":"https://api.github.com/repos/dmend/docs-barbican/keys{/key_id}","collaborators_url":"https://api.github.com/repos/dmend/docs-barbican/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/dmend/docs-barbican/teams","hooks_url":"https://api.github.com/repos/dmend/docs-barbican/hooks","issue_events_url":"https://api.github.com/repos/dmend/docs-barbican/issues/events{/number}","events_url":"https://api.github.com/repos/dmend/docs-barbican/events","assignees_url":"https://api.github.com/repos/dmend/docs-barbican/assignees{/user}","branches_url":"https://api.github.com/repos/dmend/docs-barbican/branches{/branch}","tags_url":"https://api.github.com/repos/dmend/docs-barbican/tags","blobs_url":"https://api.github.com/repos/dmend/docs-barbican/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/dmend/docs-barbican/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/dmend/docs-barbican/git/refs{/sha}","trees_url":"https://api.github.com/repos/dmend/docs-barbican/git/trees{/sha}","statuses_url":"https://api.github.com/repos/dmend/docs-barbican/statuses/{sha}","languages_url":"https://api.github.com/repos/dmend/docs-barbican/languages","stargazers_url":"https://api.github.com/repos/dmend/docs-barbican/stargazers","contributors_url":"https://api.github.com/repos/dmend/docs-barbican/contributors","subscribers_url":"https://api.github.com/repos/dmend/docs-barbican/subscribers","subscription_url":"https://api.github.com/repos/dmend/docs-barbican/subscription","commits_url":"https://api.github.com/repos/dmend/docs-barbican/commits{/sha}","git_commits_url":"https://api.github.com/repos/dmend/docs-barbican/git/commits{/sha}","comments_url":"https://api.github.com/repos/dmend/docs-barbican/comments{/number}","issue_comment_url":"https://api.github.com/repos/dmend/docs-barbican/issues/comments{/number}","contents_url":"https://api.github.com/repos/dmend/docs-barbican/contents/{+path}","compare_url":"https://api.github.com/repos/dmend/docs-barbican/compare/{base}...{head}","merges_url":"https://api.github.com/repos/dmend/docs-barbican/merges","archive_url":"https://api.github.com/repos/dmend/docs-barbican/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/dmend/docs-barbican/downloads","issues_url":"https://api.github.com/repos/dmend/docs-barbican/issues{/number}","pulls_url":"https://api.github.com/repos/dmend/docs-barbican/pulls{/number}","milestones_url":"https://api.github.com/repos/dmend/docs-barbican/milestones{/number}","notifications_url":"https://api.github.com/repos/dmend/docs-barbican/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/dmend/docs-barbican/labels{/name}","releases_url":"https://api.github.com/repos/dmend/docs-barbican/releases{/id}","deployments_url":"https://api.github.com/repos/dmend/docs-barbican/deployments","created_at":"2016-07-08T20:31:47Z","updated_at":"2016-07-08T20:31:49Z","pushed_at":"2016-07-14T19:24:00Z","git_url":"git://github.com/dmend/docs-barbican.git","ssh_url":"git@github.com:dmend/docs-barbican.git","clone_url":"https://github.com/dmend/docs-barbican.git","svn_url":"https://github.com/dmend/docs-barbican","homepage":"https://developer.rackspace.com/docs/cloud-keep/v1/developer-guide/","size":1812,"stargazers_count":0,"watchers_count":0,"language":"Python","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"rackerlabs:master","ref":"master","sha":"f1515906dab86492db25253fa2e2a3a2c3ade278","user":{"login":"rackerlabs","id":84293,"avatar_url":"https://avatars.githubusercontent.com/u/84293?v=3","gravatar_id":"","url":"https://api.github.com/users/rackerlabs","html_url":"https://github.com/rackerlabs","followers_url":"https://api.github.com/users/rackerlabs/followers","following_url":"https://api.github.com/users/rackerlabs/following{/other_user}","gists_url":"https://api.github.com/users/rackerlabs/gists{/gist_id}","starred_url":"https://api.github.com/users/rackerlabs/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rackerlabs/subscriptions","organizations_url":"https://api.github.com/users/rackerlabs/orgs","repos_url":"https://api.github.com/users/rackerlabs/repos","events_url":"https://api.github.com/users/rackerlabs/events{/privacy}","received_events_url":"https://api.github.com/users/rackerlabs/received_events","type":"Organization","site_admin":false},"repo":{"id":18450267,"name":"docs-barbican","full_name":"rackerlabs/docs-barbican","owner":{"login":"rackerlabs","id":84293,"avatar_url":"https://avatars.githubusercontent.com/u/84293?v=3","gravatar_id":"","url":"https://api.github.com/users/rackerlabs","html_url":"https://github.com/rackerlabs","followers_url":"https://api.github.com/users/rackerlabs/followers","following_url":"https://api.github.com/users/rackerlabs/following{/other_user}","gists_url":"https://api.github.com/users/rackerlabs/gists{/gist_id}","starred_url":"https://api.github.com/users/rackerlabs/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rackerlabs/subscriptions","organizations_url":"https://api.github.com/users/rackerlabs/orgs","repos_url":"https://api.github.com/users/rackerlabs/repos","events_url":"https://api.github.com/users/rackerlabs/events{/privacy}","received_events_url":"https://api.github.com/users/rackerlabs/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/rackerlabs/docs-barbican","description":"Developer documentation source for Rackspace Cloud Keep API","fork":false,"url":"https://api.github.com/repos/rackerlabs/docs-barbican","forks_url":"https://api.github.com/repos/rackerlabs/docs-barbican/forks","keys_url":"https://api.github.com/repos/rackerlabs/docs-barbican/keys{/key_id}","collaborators_url":"https://api.github.com/repos/rackerlabs/docs-barbican/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/rackerlabs/docs-barbican/teams","hooks_url":"https://api.github.com/repos/rackerlabs/docs-barbican/hooks","issue_events_url":"https://api.github.com/repos/rackerlabs/docs-barbican/issues/events{/number}","events_url":"https://api.github.com/repos/rackerlabs/docs-barbican/events","assignees_url":"https://api.github.com/repos/rackerlabs/docs-barbican/assignees{/user}","branches_url":"https://api.github.com/repos/rackerlabs/docs-barbican/branches{/branch}","tags_url":"https://api.github.com/repos/rackerlabs/docs-barbican/tags","blobs_url":"https://api.github.com/repos/rackerlabs/docs-barbican/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/rackerlabs/docs-barbican/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/rackerlabs/docs-barbican/git/refs{/sha}","trees_url":"https://api.github.com/repos/rackerlabs/docs-barbican/git/trees{/sha}","statuses_url":"https://api.github.com/repos/rackerlabs/docs-barbican/statuses/{sha}","languages_url":"https://api.github.com/repos/rackerlabs/docs-barbican/languages","stargazers_url":"https://api.github.com/repos/rackerlabs/docs-barbican/stargazers","contributors_url":"https://api.github.com/repos/rackerlabs/docs-barbican/contributors","subscribers_url":"https://api.github.com/repos/rackerlabs/docs-barbican/subscribers","subscription_url":"https://api.github.com/repos/rackerlabs/docs-barbican/subscription","commits_url":"https://api.github.com/repos/rackerlabs/docs-barbican/commits{/sha}","git_commits_url":"https://api.github.com/repos/rackerlabs/docs-barbican/git/commits{/sha}","comments_url":"https://api.github.com/repos/rackerlabs/docs-barbican/comments{/number}","issue_comment_url":"https://api.github.com/repos/rackerlabs/docs-barbican/issues/comments{/number}","contents_url":"https://api.github.com/repos/rackerlabs/docs-barbican/contents/{+path}","compare_url":"https://api.github.com/repos/rackerlabs/docs-barbican/compare/{base}...{head}","merges_url":"https://api.github.com/repos/rackerlabs/docs-barbican/merges","archive_url":"https://api.github.com/repos/rackerlabs/docs-barbican/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/rackerlabs/docs-barbican/downloads","issues_url":"https://api.github.com/repos/rackerlabs/docs-barbican/issues{/number}","pulls_url":"https://api.github.com/repos/rackerlabs/docs-barbican/pulls{/number}","milestones_url":"https://api.github.com/repos/rackerlabs/docs-barbican/milestones{/number}","notifications_url":"https://api.github.com/repos/rackerlabs/docs-barbican/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/rackerlabs/docs-barbican/labels{/name}","releases_url":"https://api.github.com/repos/rackerlabs/docs-barbican/releases{/id}","deployments_url":"https://api.github.com/repos/rackerlabs/docs-barbican/deployments","created_at":"2014-04-04T19:35:43Z","updated_at":"2016-03-01T16:02:21Z","pushed_at":"2016-07-14T19:24:00Z","git_url":"git://github.com/rackerlabs/docs-barbican.git","ssh_url":"git@github.com:rackerlabs/docs-barbican.git","clone_url":"https://github.com/rackerlabs/docs-barbican.git","svn_url":"https://github.com/rackerlabs/docs-barbican","homepage":"https://developer.rackspace.com/docs/cloud-keep/v1/developer-guide/","size":1792,"stargazers_count":1,"watchers_count":1,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":6,"mirror_url":null,"open_issues_count":2,"forks":6,"open_issues":2,"watchers":1,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/rackerlabs/docs-barbican/pulls/67"},"html":{"href":"https://github.com/rackerlabs/docs-barbican/pull/67"},"issue":{"href":"https://api.github.com/repos/rackerlabs/docs-barbican/issues/67"},"comments":{"href":"https://api.github.com/repos/rackerlabs/docs-barbican/issues/67/comments"},"review_comments":{"href":"https://api.github.com/repos/rackerlabs/docs-barbican/pulls/67/comments"},"review_comment":{"href":"https://api.github.com/repos/rackerlabs/docs-barbican/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/rackerlabs/docs-barbican/pulls/67/commits"},"statuses":{"href":"https://api.github.com/repos/rackerlabs/docs-barbican/statuses/ee06d9ac2afd26543695c902c0c1c0e3e62b2dcc"}}}}
{"actor":{"display_login":"meker12"}}