{"action":"opened","number":8,"pull_request":{"url":"https://api.github.com/repos/potatosalad/erlang-jose/pulls/8","id":45125972,"html_url":"https://github.com/potatosalad/erlang-jose/pull/8","diff_url":"https://github.com/potatosalad/erlang-jose/pull/8.diff","patch_url":"https://github.com/potatosalad/erlang-jose/pull/8.patch","issue_url":"https://api.github.com/repos/potatosalad/erlang-jose/issues/8","number":8,"state":"open","locked":false,"title":"Begin documenting the Elixir API","user":{"login":"cs-victor-nascimento","id":7049728,"avatar_url":"https://avatars.githubusercontent.com/u/7049728?v=3","gravatar_id":"","url":"https://api.github.com/users/cs-victor-nascimento","html_url":"https://github.com/cs-victor-nascimento","followers_url":"https://api.github.com/users/cs-victor-nascimento/followers","following_url":"https://api.github.com/users/cs-victor-nascimento/following{/other_user}","gists_url":"https://api.github.com/users/cs-victor-nascimento/gists{/gist_id}","starred_url":"https://api.github.com/users/cs-victor-nascimento/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cs-victor-nascimento/subscriptions","organizations_url":"https://api.github.com/users/cs-victor-nascimento/orgs","repos_url":"https://api.github.com/users/cs-victor-nascimento/repos","events_url":"https://api.github.com/users/cs-victor-nascimento/events{/privacy}","received_events_url":"https://api.github.com/users/cs-victor-nascimento/received_events","type":"User","site_admin":false},"body":"This is an initial attempt at documenting the Elixir API of the erlang-jose library. I still have to find more time to dig in deeper on the API to understand its structures.\r\n\r\nAlthough incomplete, this has the base for publishing it to hex and linking the docs to the version. If you run:\r\n\r\n```elixir\r\nMIX_ENV=docs mix do deps.get, compile\r\nMIX_ENV=docs mix docs\r\n```\r\n\r\nYou will see something like:\r\n![screenshot from 2015-09-15 23 44 23](https://cloud.githubusercontent.com/assets/7049728/9895241/b876846a-5c03-11e5-9513-2c9257d1ba83.png)\r\n\r\nAfter that is just a matter of issuing:\r\n\r\n```elixir\r\nMIX_ENV=docs mix hex.docs\r\n```\r\n\r\nAnd Hex will show a \"(docs)\" link. \r\n\r\n@potatosalad What do you think of starting small? This might be helpful in a future version release where people will get more insightful messages from `h JOSE.JWK.verify` in the shell or IDEs. ","created_at":"2015-09-16T02:51:19Z","updated_at":"2015-09-16T02:51:20Z","closed_at":null,"merged_at":null,"merge_commit_sha":null,"assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/potatosalad/erlang-jose/pulls/8/commits","review_comments_url":"https://api.github.com/repos/potatosalad/erlang-jose/pulls/8/comments","review_comment_url":"https://api.github.com/repos/potatosalad/erlang-jose/pulls/comments{/number}","comments_url":"https://api.github.com/repos/potatosalad/erlang-jose/issues/8/comments","statuses_url":"https://api.github.com/repos/potatosalad/erlang-jose/statuses/6054bfb27c61553e411f606a699dd667cbd83013","head":{"label":"cs-victor-nascimento:begin_documentation","ref":"begin_documentation","sha":"6054bfb27c61553e411f606a699dd667cbd83013","user":{"login":"cs-victor-nascimento","id":7049728,"avatar_url":"https://avatars.githubusercontent.com/u/7049728?v=3","gravatar_id":"","url":"https://api.github.com/users/cs-victor-nascimento","html_url":"https://github.com/cs-victor-nascimento","followers_url":"https://api.github.com/users/cs-victor-nascimento/followers","following_url":"https://api.github.com/users/cs-victor-nascimento/following{/other_user}","gists_url":"https://api.github.com/users/cs-victor-nascimento/gists{/gist_id}","starred_url":"https://api.github.com/users/cs-victor-nascimento/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cs-victor-nascimento/subscriptions","organizations_url":"https://api.github.com/users/cs-victor-nascimento/orgs","repos_url":"https://api.github.com/users/cs-victor-nascimento/repos","events_url":"https://api.github.com/users/cs-victor-nascimento/events{/privacy}","received_events_url":"https://api.github.com/users/cs-victor-nascimento/received_events","type":"User","site_admin":false},"repo":{"id":40494638,"name":"erlang-jose","full_name":"cs-victor-nascimento/erlang-jose","owner":{"login":"cs-victor-nascimento","id":7049728,"avatar_url":"https://avatars.githubusercontent.com/u/7049728?v=3","gravatar_id":"","url":"https://api.github.com/users/cs-victor-nascimento","html_url":"https://github.com/cs-victor-nascimento","followers_url":"https://api.github.com/users/cs-victor-nascimento/followers","following_url":"https://api.github.com/users/cs-victor-nascimento/following{/other_user}","gists_url":"https://api.github.com/users/cs-victor-nascimento/gists{/gist_id}","starred_url":"https://api.github.com/users/cs-victor-nascimento/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cs-victor-nascimento/subscriptions","organizations_url":"https://api.github.com/users/cs-victor-nascimento/orgs","repos_url":"https://api.github.com/users/cs-victor-nascimento/repos","events_url":"https://api.github.com/users/cs-victor-nascimento/events{/privacy}","received_events_url":"https://api.github.com/users/cs-victor-nascimento/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/cs-victor-nascimento/erlang-jose","description":"JSON Object Signing and Encryption (JOSE) for Erlang and Elixir","fork":true,"url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose","forks_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/forks","keys_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/keys{/key_id}","collaborators_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/teams","hooks_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/hooks","issue_events_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/issues/events{/number}","events_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/events","assignees_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/assignees{/user}","branches_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/branches{/branch}","tags_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/tags","blobs_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/git/refs{/sha}","trees_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/git/trees{/sha}","statuses_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/statuses/{sha}","languages_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/languages","stargazers_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/stargazers","contributors_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/contributors","subscribers_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/subscribers","subscription_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/subscription","commits_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/commits{/sha}","git_commits_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/git/commits{/sha}","comments_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/comments{/number}","issue_comment_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/issues/comments{/number}","contents_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/contents/{+path}","compare_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/compare/{base}...{head}","merges_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/merges","archive_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/downloads","issues_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/issues{/number}","pulls_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/pulls{/number}","milestones_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/milestones{/number}","notifications_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/labels{/name}","releases_url":"https://api.github.com/repos/cs-victor-nascimento/erlang-jose/releases{/id}","created_at":"2015-08-10T16:58:26Z","updated_at":"2015-08-10T16:58:27Z","pushed_at":"2015-09-16T02:50:21Z","git_url":"git://github.com/cs-victor-nascimento/erlang-jose.git","ssh_url":"git@github.com:cs-victor-nascimento/erlang-jose.git","clone_url":"https://github.com/cs-victor-nascimento/erlang-jose.git","svn_url":"https://github.com/cs-victor-nascimento/erlang-jose","homepage":"","size":299,"stargazers_count":0,"watchers_count":0,"language":"Erlang","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":"potatosalad:master","ref":"master","sha":"86339abcf6d19c5b295c15c3ae40103c323a1df3","user":{"login":"potatosalad","id":1804,"avatar_url":"https://avatars.githubusercontent.com/u/1804?v=3","gravatar_id":"","url":"https://api.github.com/users/potatosalad","html_url":"https://github.com/potatosalad","followers_url":"https://api.github.com/users/potatosalad/followers","following_url":"https://api.github.com/users/potatosalad/following{/other_user}","gists_url":"https://api.github.com/users/potatosalad/gists{/gist_id}","starred_url":"https://api.github.com/users/potatosalad/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/potatosalad/subscriptions","organizations_url":"https://api.github.com/users/potatosalad/orgs","repos_url":"https://api.github.com/users/potatosalad/repos","events_url":"https://api.github.com/users/potatosalad/events{/privacy}","received_events_url":"https://api.github.com/users/potatosalad/received_events","type":"User","site_admin":false},"repo":{"id":39801338,"name":"erlang-jose","full_name":"potatosalad/erlang-jose","owner":{"login":"potatosalad","id":1804,"avatar_url":"https://avatars.githubusercontent.com/u/1804?v=3","gravatar_id":"","url":"https://api.github.com/users/potatosalad","html_url":"https://github.com/potatosalad","followers_url":"https://api.github.com/users/potatosalad/followers","following_url":"https://api.github.com/users/potatosalad/following{/other_user}","gists_url":"https://api.github.com/users/potatosalad/gists{/gist_id}","starred_url":"https://api.github.com/users/potatosalad/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/potatosalad/subscriptions","organizations_url":"https://api.github.com/users/potatosalad/orgs","repos_url":"https://api.github.com/users/potatosalad/repos","events_url":"https://api.github.com/users/potatosalad/events{/privacy}","received_events_url":"https://api.github.com/users/potatosalad/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/potatosalad/erlang-jose","description":"JSON Object Signing and Encryption (JOSE) for Erlang and Elixir","fork":false,"url":"https://api.github.com/repos/potatosalad/erlang-jose","forks_url":"https://api.github.com/repos/potatosalad/erlang-jose/forks","keys_url":"https://api.github.com/repos/potatosalad/erlang-jose/keys{/key_id}","collaborators_url":"https://api.github.com/repos/potatosalad/erlang-jose/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/potatosalad/erlang-jose/teams","hooks_url":"https://api.github.com/repos/potatosalad/erlang-jose/hooks","issue_events_url":"https://api.github.com/repos/potatosalad/erlang-jose/issues/events{/number}","events_url":"https://api.github.com/repos/potatosalad/erlang-jose/events","assignees_url":"https://api.github.com/repos/potatosalad/erlang-jose/assignees{/user}","branches_url":"https://api.github.com/repos/potatosalad/erlang-jose/branches{/branch}","tags_url":"https://api.github.com/repos/potatosalad/erlang-jose/tags","blobs_url":"https://api.github.com/repos/potatosalad/erlang-jose/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/potatosalad/erlang-jose/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/potatosalad/erlang-jose/git/refs{/sha}","trees_url":"https://api.github.com/repos/potatosalad/erlang-jose/git/trees{/sha}","statuses_url":"https://api.github.com/repos/potatosalad/erlang-jose/statuses/{sha}","languages_url":"https://api.github.com/repos/potatosalad/erlang-jose/languages","stargazers_url":"https://api.github.com/repos/potatosalad/erlang-jose/stargazers","contributors_url":"https://api.github.com/repos/potatosalad/erlang-jose/contributors","subscribers_url":"https://api.github.com/repos/potatosalad/erlang-jose/subscribers","subscription_url":"https://api.github.com/repos/potatosalad/erlang-jose/subscription","commits_url":"https://api.github.com/repos/potatosalad/erlang-jose/commits{/sha}","git_commits_url":"https://api.github.com/repos/potatosalad/erlang-jose/git/commits{/sha}","comments_url":"https://api.github.com/repos/potatosalad/erlang-jose/comments{/number}","issue_comment_url":"https://api.github.com/repos/potatosalad/erlang-jose/issues/comments{/number}","contents_url":"https://api.github.com/repos/potatosalad/erlang-jose/contents/{+path}","compare_url":"https://api.github.com/repos/potatosalad/erlang-jose/compare/{base}...{head}","merges_url":"https://api.github.com/repos/potatosalad/erlang-jose/merges","archive_url":"https://api.github.com/repos/potatosalad/erlang-jose/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/potatosalad/erlang-jose/downloads","issues_url":"https://api.github.com/repos/potatosalad/erlang-jose/issues{/number}","pulls_url":"https://api.github.com/repos/potatosalad/erlang-jose/pulls{/number}","milestones_url":"https://api.github.com/repos/potatosalad/erlang-jose/milestones{/number}","notifications_url":"https://api.github.com/repos/potatosalad/erlang-jose/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/potatosalad/erlang-jose/labels{/name}","releases_url":"https://api.github.com/repos/potatosalad/erlang-jose/releases{/id}","created_at":"2015-07-27T22:40:04Z","updated_at":"2015-09-12T20:36:33Z","pushed_at":"2015-08-21T03:56:50Z","git_url":"git://github.com/potatosalad/erlang-jose.git","ssh_url":"git@github.com:potatosalad/erlang-jose.git","clone_url":"https://github.com/potatosalad/erlang-jose.git","svn_url":"https://github.com/potatosalad/erlang-jose","homepage":"","size":439,"stargazers_count":21,"watchers_count":21,"language":"Erlang","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":2,"mirror_url":null,"open_issues_count":3,"forks":2,"open_issues":3,"watchers":21,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/potatosalad/erlang-jose/pulls/8"},"html":{"href":"https://github.com/potatosalad/erlang-jose/pull/8"},"issue":{"href":"https://api.github.com/repos/potatosalad/erlang-jose/issues/8"},"comments":{"href":"https://api.github.com/repos/potatosalad/erlang-jose/issues/8/comments"},"review_comments":{"href":"https://api.github.com/repos/potatosalad/erlang-jose/pulls/8/comments"},"review_comment":{"href":"https://api.github.com/repos/potatosalad/erlang-jose/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/potatosalad/erlang-jose/pulls/8/commits"},"statuses":{"href":"https://api.github.com/repos/potatosalad/erlang-jose/statuses/6054bfb27c61553e411f606a699dd667cbd83013"}},"merged":false,"mergeable":null,"mergeable_state":"unknown","merged_by":null,"comments":0,"review_comments":0,"commits":1,"additions":69,"deletions":3,"changed_files":6}}