{"action":"created","comment":{"url":"https://api.github.com/repos/ElektraInitiative/libelektra/pulls/comments/77798017","id":77798017,"diff_hunk":"@@ -0,0 +1,410 @@\n+FORMAT: 1.0\n+\n+# REST service API for sharing configuration snippets\n+\n+This is a description of the API provided by the REST service that can be used to share, search and download configuration snippets.\n+\n+\n+# API Description [/]\n+\n+## List API methods [GET]\n+\n+Returns an overview of available API methods with required parameters and a description.\n+\n++ Response 200 (text/html; charset=utf-8)\n+\n+\n+\n+# Authentication endpoint [/auth]\n+\n+## Authenticate [POST]\n+\n+The API will try to authenticate the user by the submitted credentials. In case of success a session token (JWT) will be returned, which can be used for further requests to the API.\n+\n++ Request (application/x-www-form-urlencoded)\n+    + Attributes\n+        + username: the_username (string, required)\n+        + password: aSecretPassword (string, required)","path":"doc/rest_api/snippet_sharing/api-description.apib","position":null,"original_position":27,"commit_id":"b75f92705dd2e8a5a965106a7a06c058a6843c8f","original_commit_id":"f0ff0fd3337158cb44d60a2d701f6ade13773627","user":{"login":"petermax2","id":2538677,"avatar_url":"https://avatars.githubusercontent.com/u/2538677?v=3","gravatar_id":"","url":"https://api.github.com/users/petermax2","html_url":"https://github.com/petermax2","followers_url":"https://api.github.com/users/petermax2/followers","following_url":"https://api.github.com/users/petermax2/following{/other_user}","gists_url":"https://api.github.com/users/petermax2/gists{/gist_id}","starred_url":"https://api.github.com/users/petermax2/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/petermax2/subscriptions","organizations_url":"https://api.github.com/users/petermax2/orgs","repos_url":"https://api.github.com/users/petermax2/repos","events_url":"https://api.github.com/users/petermax2/events{/privacy}","received_events_url":"https://api.github.com/users/petermax2/received_events","type":"User","site_admin":false},"body":"curl supports the digest authentication, just append `--anyauth` or `--digest`, see `man curl` or [here](https://curl.haxx.se/docs/manpage.html#--digest) .\r\n\r\nThis authentication scheme is not something I made up. RFC2617 is widely accepted and implemented by a wide range of tools.","created_at":"2016-09-07T10:36:37Z","updated_at":"2016-09-07T10:36:37Z","html_url":"https://github.com/ElektraInitiative/libelektra/pull/921#discussion_r77798017","pull_request_url":"https://api.github.com/repos/ElektraInitiative/libelektra/pulls/921","_links":{"self":{"href":"https://api.github.com/repos/ElektraInitiative/libelektra/pulls/comments/77798017"},"html":{"href":"https://github.com/ElektraInitiative/libelektra/pull/921#discussion_r77798017"},"pull_request":{"href":"https://api.github.com/repos/ElektraInitiative/libelektra/pulls/921"}}},"pull_request":{"url":"https://api.github.com/repos/ElektraInitiative/libelektra/pulls/921","id":84091717,"html_url":"https://github.com/ElektraInitiative/libelektra/pull/921","diff_url":"https://github.com/ElektraInitiative/libelektra/pull/921.diff","patch_url":"https://github.com/ElektraInitiative/libelektra/pull/921.patch","issue_url":"https://api.github.com/repos/ElektraInitiative/libelektra/issues/921","number":921,"state":"open","locked":false,"title":"REST API: description draft for sharing of conf snippets","user":{"login":"Namoshek","id":8877609,"avatar_url":"https://avatars.githubusercontent.com/u/8877609?v=3","gravatar_id":"","url":"https://api.github.com/users/Namoshek","html_url":"https://github.com/Namoshek","followers_url":"https://api.github.com/users/Namoshek/followers","following_url":"https://api.github.com/users/Namoshek/following{/other_user}","gists_url":"https://api.github.com/users/Namoshek/gists{/gist_id}","starred_url":"https://api.github.com/users/Namoshek/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Namoshek/subscriptions","organizations_url":"https://api.github.com/users/Namoshek/orgs","repos_url":"https://api.github.com/users/Namoshek/repos","events_url":"https://api.github.com/users/Namoshek/events{/privacy}","received_events_url":"https://api.github.com/users/Namoshek/received_events","type":"User","site_admin":false},"body":"# Purpose\r\n\r\nREST API description for the service that allows for sharing of configuration snippets.\r\n\r\n# Additional info\r\n\r\nI checked the format with [Drafter](https://github.com/apiaryio/drafter) and generated a HTML documentation with the [Apairy CLI](https://github.com/apiaryio/apiary-client).\r\n\r\n# TODO\r\n\r\n- [X] Authentication endpoint\r\n- [ ] Database endpoint\r\n\r\n# Checklist\r\n\r\n- [X] commit messages are fine (with references to issues)\r\n- [X] I ran all tests and everything went fine\r\n- [ ] meta data is updated (e.g. README.md of plugins)\r\n\r\n@markus2330 please review my pull request\r\n\r\n","created_at":"2016-09-06T09:48:58Z","updated_at":"2016-09-07T10:36:37Z","closed_at":null,"merged_at":null,"merge_commit_sha":"048ccb3840ab7385b324d50773ad63fba021a0be","assignee":null,"assignees":[],"milestone":null,"commits_url":"https://api.github.com/repos/ElektraInitiative/libelektra/pulls/921/commits","review_comments_url":"https://api.github.com/repos/ElektraInitiative/libelektra/pulls/921/comments","review_comment_url":"https://api.github.com/repos/ElektraInitiative/libelektra/pulls/comments{/number}","comments_url":"https://api.github.com/repos/ElektraInitiative/libelektra/issues/921/comments","statuses_url":"https://api.github.com/repos/ElektraInitiative/libelektra/statuses/b75f92705dd2e8a5a965106a7a06c058a6843c8f","head":{"label":"Namoshek:rest-service-api-desc","ref":"rest-service-api-desc","sha":"b75f92705dd2e8a5a965106a7a06c058a6843c8f","user":{"login":"Namoshek","id":8877609,"avatar_url":"https://avatars.githubusercontent.com/u/8877609?v=3","gravatar_id":"","url":"https://api.github.com/users/Namoshek","html_url":"https://github.com/Namoshek","followers_url":"https://api.github.com/users/Namoshek/followers","following_url":"https://api.github.com/users/Namoshek/following{/other_user}","gists_url":"https://api.github.com/users/Namoshek/gists{/gist_id}","starred_url":"https://api.github.com/users/Namoshek/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Namoshek/subscriptions","organizations_url":"https://api.github.com/users/Namoshek/orgs","repos_url":"https://api.github.com/users/Namoshek/repos","events_url":"https://api.github.com/users/Namoshek/events{/privacy}","received_events_url":"https://api.github.com/users/Namoshek/received_events","type":"User","site_admin":false},"repo":{"id":53196992,"name":"libelektra","full_name":"Namoshek/libelektra","owner":{"login":"Namoshek","id":8877609,"avatar_url":"https://avatars.githubusercontent.com/u/8877609?v=3","gravatar_id":"","url":"https://api.github.com/users/Namoshek","html_url":"https://github.com/Namoshek","followers_url":"https://api.github.com/users/Namoshek/followers","following_url":"https://api.github.com/users/Namoshek/following{/other_user}","gists_url":"https://api.github.com/users/Namoshek/gists{/gist_id}","starred_url":"https://api.github.com/users/Namoshek/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Namoshek/subscriptions","organizations_url":"https://api.github.com/users/Namoshek/orgs","repos_url":"https://api.github.com/users/Namoshek/repos","events_url":"https://api.github.com/users/Namoshek/events{/privacy}","received_events_url":"https://api.github.com/users/Namoshek/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/Namoshek/libelektra","description":"Elektra serves as a universal and secure framework to access configuration parameters in a global, hierarchical key database.","fork":true,"url":"https://api.github.com/repos/Namoshek/libelektra","forks_url":"https://api.github.com/repos/Namoshek/libelektra/forks","keys_url":"https://api.github.com/repos/Namoshek/libelektra/keys{/key_id}","collaborators_url":"https://api.github.com/repos/Namoshek/libelektra/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/Namoshek/libelektra/teams","hooks_url":"https://api.github.com/repos/Namoshek/libelektra/hooks","issue_events_url":"https://api.github.com/repos/Namoshek/libelektra/issues/events{/number}","events_url":"https://api.github.com/repos/Namoshek/libelektra/events","assignees_url":"https://api.github.com/repos/Namoshek/libelektra/assignees{/user}","branches_url":"https://api.github.com/repos/Namoshek/libelektra/branches{/branch}","tags_url":"https://api.github.com/repos/Namoshek/libelektra/tags","blobs_url":"https://api.github.com/repos/Namoshek/libelektra/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/Namoshek/libelektra/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/Namoshek/libelektra/git/refs{/sha}","trees_url":"https://api.github.com/repos/Namoshek/libelektra/git/trees{/sha}","statuses_url":"https://api.github.com/repos/Namoshek/libelektra/statuses/{sha}","languages_url":"https://api.github.com/repos/Namoshek/libelektra/languages","stargazers_url":"https://api.github.com/repos/Namoshek/libelektra/stargazers","contributors_url":"https://api.github.com/repos/Namoshek/libelektra/contributors","subscribers_url":"https://api.github.com/repos/Namoshek/libelektra/subscribers","subscription_url":"https://api.github.com/repos/Namoshek/libelektra/subscription","commits_url":"https://api.github.com/repos/Namoshek/libelektra/commits{/sha}","git_commits_url":"https://api.github.com/repos/Namoshek/libelektra/git/commits{/sha}","comments_url":"https://api.github.com/repos/Namoshek/libelektra/comments{/number}","issue_comment_url":"https://api.github.com/repos/Namoshek/libelektra/issues/comments{/number}","contents_url":"https://api.github.com/repos/Namoshek/libelektra/contents/{+path}","compare_url":"https://api.github.com/repos/Namoshek/libelektra/compare/{base}...{head}","merges_url":"https://api.github.com/repos/Namoshek/libelektra/merges","archive_url":"https://api.github.com/repos/Namoshek/libelektra/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/Namoshek/libelektra/downloads","issues_url":"https://api.github.com/repos/Namoshek/libelektra/issues{/number}","pulls_url":"https://api.github.com/repos/Namoshek/libelektra/pulls{/number}","milestones_url":"https://api.github.com/repos/Namoshek/libelektra/milestones{/number}","notifications_url":"https://api.github.com/repos/Namoshek/libelektra/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/Namoshek/libelektra/labels{/name}","releases_url":"https://api.github.com/repos/Namoshek/libelektra/releases{/id}","deployments_url":"https://api.github.com/repos/Namoshek/libelektra/deployments","created_at":"2016-03-05T10:57:01Z","updated_at":"2016-05-07T21:43:07Z","pushed_at":"2016-09-07T10:20:48Z","git_url":"git://github.com/Namoshek/libelektra.git","ssh_url":"git@github.com:Namoshek/libelektra.git","clone_url":"https://github.com/Namoshek/libelektra.git","svn_url":"https://github.com/Namoshek/libelektra","homepage":"http://libelektra.org","size":33557,"stargazers_count":0,"watchers_count":0,"language":"C","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":"ElektraInitiative:master","ref":"master","sha":"74010c8192b4ed8e356bb376e31eed46a16f07d6","user":{"login":"ElektraInitiative","id":7949092,"avatar_url":"https://avatars.githubusercontent.com/u/7949092?v=3","gravatar_id":"","url":"https://api.github.com/users/ElektraInitiative","html_url":"https://github.com/ElektraInitiative","followers_url":"https://api.github.com/users/ElektraInitiative/followers","following_url":"https://api.github.com/users/ElektraInitiative/following{/other_user}","gists_url":"https://api.github.com/users/ElektraInitiative/gists{/gist_id}","starred_url":"https://api.github.com/users/ElektraInitiative/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ElektraInitiative/subscriptions","organizations_url":"https://api.github.com/users/ElektraInitiative/orgs","repos_url":"https://api.github.com/users/ElektraInitiative/repos","events_url":"https://api.github.com/users/ElektraInitiative/events{/privacy}","received_events_url":"https://api.github.com/users/ElektraInitiative/received_events","type":"Organization","site_admin":false},"repo":{"id":21063580,"name":"libelektra","full_name":"ElektraInitiative/libelektra","owner":{"login":"ElektraInitiative","id":7949092,"avatar_url":"https://avatars.githubusercontent.com/u/7949092?v=3","gravatar_id":"","url":"https://api.github.com/users/ElektraInitiative","html_url":"https://github.com/ElektraInitiative","followers_url":"https://api.github.com/users/ElektraInitiative/followers","following_url":"https://api.github.com/users/ElektraInitiative/following{/other_user}","gists_url":"https://api.github.com/users/ElektraInitiative/gists{/gist_id}","starred_url":"https://api.github.com/users/ElektraInitiative/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ElektraInitiative/subscriptions","organizations_url":"https://api.github.com/users/ElektraInitiative/orgs","repos_url":"https://api.github.com/users/ElektraInitiative/repos","events_url":"https://api.github.com/users/ElektraInitiative/events{/privacy}","received_events_url":"https://api.github.com/users/ElektraInitiative/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/ElektraInitiative/libelektra","description":"Elektra serves as a universal and secure framework to access configuration parameters in a global, hierarchical key database.","fork":false,"url":"https://api.github.com/repos/ElektraInitiative/libelektra","forks_url":"https://api.github.com/repos/ElektraInitiative/libelektra/forks","keys_url":"https://api.github.com/repos/ElektraInitiative/libelektra/keys{/key_id}","collaborators_url":"https://api.github.com/repos/ElektraInitiative/libelektra/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/ElektraInitiative/libelektra/teams","hooks_url":"https://api.github.com/repos/ElektraInitiative/libelektra/hooks","issue_events_url":"https://api.github.com/repos/ElektraInitiative/libelektra/issues/events{/number}","events_url":"https://api.github.com/repos/ElektraInitiative/libelektra/events","assignees_url":"https://api.github.com/repos/ElektraInitiative/libelektra/assignees{/user}","branches_url":"https://api.github.com/repos/ElektraInitiative/libelektra/branches{/branch}","tags_url":"https://api.github.com/repos/ElektraInitiative/libelektra/tags","blobs_url":"https://api.github.com/repos/ElektraInitiative/libelektra/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/ElektraInitiative/libelektra/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/ElektraInitiative/libelektra/git/refs{/sha}","trees_url":"https://api.github.com/repos/ElektraInitiative/libelektra/git/trees{/sha}","statuses_url":"https://api.github.com/repos/ElektraInitiative/libelektra/statuses/{sha}","languages_url":"https://api.github.com/repos/ElektraInitiative/libelektra/languages","stargazers_url":"https://api.github.com/repos/ElektraInitiative/libelektra/stargazers","contributors_url":"https://api.github.com/repos/ElektraInitiative/libelektra/contributors","subscribers_url":"https://api.github.com/repos/ElektraInitiative/libelektra/subscribers","subscription_url":"https://api.github.com/repos/ElektraInitiative/libelektra/subscription","commits_url":"https://api.github.com/repos/ElektraInitiative/libelektra/commits{/sha}","git_commits_url":"https://api.github.com/repos/ElektraInitiative/libelektra/git/commits{/sha}","comments_url":"https://api.github.com/repos/ElektraInitiative/libelektra/comments{/number}","issue_comment_url":"https://api.github.com/repos/ElektraInitiative/libelektra/issues/comments{/number}","contents_url":"https://api.github.com/repos/ElektraInitiative/libelektra/contents/{+path}","compare_url":"https://api.github.com/repos/ElektraInitiative/libelektra/compare/{base}...{head}","merges_url":"https://api.github.com/repos/ElektraInitiative/libelektra/merges","archive_url":"https://api.github.com/repos/ElektraInitiative/libelektra/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/ElektraInitiative/libelektra/downloads","issues_url":"https://api.github.com/repos/ElektraInitiative/libelektra/issues{/number}","pulls_url":"https://api.github.com/repos/ElektraInitiative/libelektra/pulls{/number}","milestones_url":"https://api.github.com/repos/ElektraInitiative/libelektra/milestones{/number}","notifications_url":"https://api.github.com/repos/ElektraInitiative/libelektra/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/ElektraInitiative/libelektra/labels{/name}","releases_url":"https://api.github.com/repos/ElektraInitiative/libelektra/releases{/id}","deployments_url":"https://api.github.com/repos/ElektraInitiative/libelektra/deployments","created_at":"2014-06-21T08:01:04Z","updated_at":"2016-07-18T18:38:12Z","pushed_at":"2016-09-07T10:20:48Z","git_url":"git://github.com/ElektraInitiative/libelektra.git","ssh_url":"git@github.com:ElektraInitiative/libelektra.git","clone_url":"https://github.com/ElektraInitiative/libelektra.git","svn_url":"https://github.com/ElektraInitiative/libelektra","homepage":"http://libelektra.org","size":34176,"stargazers_count":34,"watchers_count":34,"language":"C","has_issues":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":26,"mirror_url":null,"open_issues_count":167,"forks":26,"open_issues":167,"watchers":34,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/ElektraInitiative/libelektra/pulls/921"},"html":{"href":"https://github.com/ElektraInitiative/libelektra/pull/921"},"issue":{"href":"https://api.github.com/repos/ElektraInitiative/libelektra/issues/921"},"comments":{"href":"https://api.github.com/repos/ElektraInitiative/libelektra/issues/921/comments"},"review_comments":{"href":"https://api.github.com/repos/ElektraInitiative/libelektra/pulls/921/comments"},"review_comment":{"href":"https://api.github.com/repos/ElektraInitiative/libelektra/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/ElektraInitiative/libelektra/pulls/921/commits"},"statuses":{"href":"https://api.github.com/repos/ElektraInitiative/libelektra/statuses/b75f92705dd2e8a5a965106a7a06c058a6843c8f"}}}}
{"actor":{"display_login":"petermax2"}}