{"action":"created","comment":{"url":"https://api.github.com/repos/kuzzleio/sdk-javascript/pulls/comments/244117689","pull_request_review_id":188044853,"id":244117689,"node_id":"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDI0NDExNzY4OQ==","diff_hunk":"@@ -98,27 +107,27 @@ const { Kuzzle } = require('kuzzle-sdk/dist/kuzzle.js')\n import { Kuzzle } from 'kuzzle-sdk/dist/kuzzle.js'\n ```\n \n-## Protocols used\n-Currently, the SDK support 3 protocols: `Http`, `Websocket` and `SocketIO`.  \n+## Protocols available\n+Currently, the SDK support 3 protocols: `Http`, `WebSocket` and `SocketIO`.  \n \n WebSocket and Socket.IO protocols implement the whole Kuzzle API, while the **HTTP protocol does not implement realtime features** (rooms and subscriptions).  \n While Socket.IO offers better compatibility with older web browsers, our raw WebSocket implementation is about 20% faster.\n \n #### NodeJS\n \n-We recommend to use the `websocket` protocol, but you can still use `http`, `socketio` or even a custom protocol if you want.  \n+We recommend to use the `WebSocket` protocol, but you can still use `Http`, `SocketIO` or even a custom protocol if you want.  ","path":"README.md","position":68,"original_position":68,"commit_id":"ccdae732d2c55ab8a2ff073b1791d1bab3519139","original_commit_id":"ccdae732d2c55ab8a2ff073b1791d1bab3519139","user":{"login":"etrousset","id":31733541,"node_id":"MDQ6VXNlcjMxNzMzNTQx","avatar_url":"https://avatars2.githubusercontent.com/u/31733541?v=4","gravatar_id":"","url":"https://api.github.com/users/etrousset","html_url":"https://github.com/etrousset","followers_url":"https://api.github.com/users/etrousset/followers","following_url":"https://api.github.com/users/etrousset/following{/other_user}","gists_url":"https://api.github.com/users/etrousset/gists{/gist_id}","starred_url":"https://api.github.com/users/etrousset/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/etrousset/subscriptions","organizations_url":"https://api.github.com/users/etrousset/orgs","repos_url":"https://api.github.com/users/etrousset/repos","events_url":"https://api.github.com/users/etrousset/events{/privacy}","received_events_url":"https://api.github.com/users/etrousset/received_events","type":"User","site_admin":false},"body":"```suggestion\r\nWe recommend using the `WebSocket` protocol, but you can still use `Http`, `SocketIO` or even a custom protocol if you want.  \r\n```","created_at":"2018-12-27T09:42:44Z","updated_at":"2018-12-27T09:46:39Z","html_url":"https://github.com/kuzzleio/sdk-javascript/pull/350#discussion_r244117689","pull_request_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/pulls/350","author_association":"CONTRIBUTOR","_links":{"self":{"href":"https://api.github.com/repos/kuzzleio/sdk-javascript/pulls/comments/244117689"},"html":{"href":"https://github.com/kuzzleio/sdk-javascript/pull/350#discussion_r244117689"},"pull_request":{"href":"https://api.github.com/repos/kuzzleio/sdk-javascript/pulls/350"}}},"pull_request":{"url":"https://api.github.com/repos/kuzzleio/sdk-javascript/pulls/350","id":241104734,"node_id":"MDExOlB1bGxSZXF1ZXN0MjQxMTA0NzM0","html_url":"https://github.com/kuzzleio/sdk-javascript/pull/350","diff_url":"https://github.com/kuzzleio/sdk-javascript/pull/350.diff","patch_url":"https://github.com/kuzzleio/sdk-javascript/pull/350.patch","issue_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/issues/350","number":350,"state":"open","locked":false,"title":"Have host param mandatory for protocols","user":{"login":"Aschen","id":4447392,"node_id":"MDQ6VXNlcjQ0NDczOTI=","avatar_url":"https://avatars3.githubusercontent.com/u/4447392?v=4","gravatar_id":"","url":"https://api.github.com/users/Aschen","html_url":"https://github.com/Aschen","followers_url":"https://api.github.com/users/Aschen/followers","following_url":"https://api.github.com/users/Aschen/following{/other_user}","gists_url":"https://api.github.com/users/Aschen/gists{/gist_id}","starred_url":"https://api.github.com/users/Aschen/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Aschen/subscriptions","organizations_url":"https://api.github.com/users/Aschen/orgs","repos_url":"https://api.github.com/users/Aschen/repos","events_url":"https://api.github.com/users/Aschen/events{/privacy}","received_events_url":"https://api.github.com/users/Aschen/received_events","type":"User","site_admin":false},"body":"## What does this PR do?\r\n\r\nThe `host` param is now mandatory for protocols. The new constructor signature include mandatory `host` param and optional `options` param.\r\n\r\nDocumentation: https://github.com/kuzzleio/documentation-V2/pull/208\r\n\r\n### How should this be manually tested?\r\n\r\n  - Step 1 : Run tests\r\n\r\n### Other changes\r\n\r\n  - Rename `Websocket` to `WebSocket`\r\n  - Update README: \r\n      - link to doc v2\r\n      - fix examples \r\n","created_at":"2018-12-27T08:47:16Z","updated_at":"2018-12-27T09:46:39Z","closed_at":null,"merged_at":null,"merge_commit_sha":"5e69c5186656cc429c7588c97ea7bb2dcad3baf3","assignee":{"login":"Aschen","id":4447392,"node_id":"MDQ6VXNlcjQ0NDczOTI=","avatar_url":"https://avatars3.githubusercontent.com/u/4447392?v=4","gravatar_id":"","url":"https://api.github.com/users/Aschen","html_url":"https://github.com/Aschen","followers_url":"https://api.github.com/users/Aschen/followers","following_url":"https://api.github.com/users/Aschen/following{/other_user}","gists_url":"https://api.github.com/users/Aschen/gists{/gist_id}","starred_url":"https://api.github.com/users/Aschen/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Aschen/subscriptions","organizations_url":"https://api.github.com/users/Aschen/orgs","repos_url":"https://api.github.com/users/Aschen/repos","events_url":"https://api.github.com/users/Aschen/events{/privacy}","received_events_url":"https://api.github.com/users/Aschen/received_events","type":"User","site_admin":false},"assignees":[{"login":"Aschen","id":4447392,"node_id":"MDQ6VXNlcjQ0NDczOTI=","avatar_url":"https://avatars3.githubusercontent.com/u/4447392?v=4","gravatar_id":"","url":"https://api.github.com/users/Aschen","html_url":"https://github.com/Aschen","followers_url":"https://api.github.com/users/Aschen/followers","following_url":"https://api.github.com/users/Aschen/following{/other_user}","gists_url":"https://api.github.com/users/Aschen/gists{/gist_id}","starred_url":"https://api.github.com/users/Aschen/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Aschen/subscriptions","organizations_url":"https://api.github.com/users/Aschen/orgs","repos_url":"https://api.github.com/users/Aschen/repos","events_url":"https://api.github.com/users/Aschen/events{/privacy}","received_events_url":"https://api.github.com/users/Aschen/received_events","type":"User","site_admin":false}],"requested_reviewers":[],"requested_teams":[],"labels":[{"id":995136401,"node_id":"MDU6TGFiZWw5OTUxMzY0MDE=","url":"https://api.github.com/repos/kuzzleio/sdk-javascript/labels/6-dev","name":"6-dev","color":"9d6ef4","default":false},{"id":562373685,"node_id":"MDU6TGFiZWw1NjIzNzM2ODU=","url":"https://api.github.com/repos/kuzzleio/sdk-javascript/labels/changelog:enhancements","name":"changelog:enhancements","color":"84b6eb","default":false}],"milestone":null,"commits_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/pulls/350/commits","review_comments_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/pulls/350/comments","review_comment_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/pulls/comments{/number}","comments_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/issues/350/comments","statuses_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/statuses/ccdae732d2c55ab8a2ff073b1791d1bab3519139","head":{"label":"kuzzleio:protocol-host-param-mandatory","ref":"protocol-host-param-mandatory","sha":"ccdae732d2c55ab8a2ff073b1791d1bab3519139","user":{"login":"kuzzleio","id":12933347,"node_id":"MDEyOk9yZ2FuaXphdGlvbjEyOTMzMzQ3","avatar_url":"https://avatars1.githubusercontent.com/u/12933347?v=4","gravatar_id":"","url":"https://api.github.com/users/kuzzleio","html_url":"https://github.com/kuzzleio","followers_url":"https://api.github.com/users/kuzzleio/followers","following_url":"https://api.github.com/users/kuzzleio/following{/other_user}","gists_url":"https://api.github.com/users/kuzzleio/gists{/gist_id}","starred_url":"https://api.github.com/users/kuzzleio/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kuzzleio/subscriptions","organizations_url":"https://api.github.com/users/kuzzleio/orgs","repos_url":"https://api.github.com/users/kuzzleio/repos","events_url":"https://api.github.com/users/kuzzleio/events{/privacy}","received_events_url":"https://api.github.com/users/kuzzleio/received_events","type":"Organization","site_admin":false},"repo":{"id":40353752,"node_id":"MDEwOlJlcG9zaXRvcnk0MDM1Mzc1Mg==","name":"sdk-javascript","full_name":"kuzzleio/sdk-javascript","private":false,"owner":{"login":"kuzzleio","id":12933347,"node_id":"MDEyOk9yZ2FuaXphdGlvbjEyOTMzMzQ3","avatar_url":"https://avatars1.githubusercontent.com/u/12933347?v=4","gravatar_id":"","url":"https://api.github.com/users/kuzzleio","html_url":"https://github.com/kuzzleio","followers_url":"https://api.github.com/users/kuzzleio/followers","following_url":"https://api.github.com/users/kuzzleio/following{/other_user}","gists_url":"https://api.github.com/users/kuzzleio/gists{/gist_id}","starred_url":"https://api.github.com/users/kuzzleio/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kuzzleio/subscriptions","organizations_url":"https://api.github.com/users/kuzzleio/orgs","repos_url":"https://api.github.com/users/kuzzleio/repos","events_url":"https://api.github.com/users/kuzzleio/events{/privacy}","received_events_url":"https://api.github.com/users/kuzzleio/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/kuzzleio/sdk-javascript","description":"Official javascript SDK for Kuzzle","fork":false,"url":"https://api.github.com/repos/kuzzleio/sdk-javascript","forks_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/forks","keys_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/keys{/key_id}","collaborators_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/teams","hooks_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/hooks","issue_events_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/issues/events{/number}","events_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/events","assignees_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/assignees{/user}","branches_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/branches{/branch}","tags_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/tags","blobs_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/git/refs{/sha}","trees_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/git/trees{/sha}","statuses_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/statuses/{sha}","languages_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/languages","stargazers_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/stargazers","contributors_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/contributors","subscribers_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/subscribers","subscription_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/subscription","commits_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/commits{/sha}","git_commits_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/git/commits{/sha}","comments_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/comments{/number}","issue_comment_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/issues/comments{/number}","contents_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/contents/{+path}","compare_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/compare/{base}...{head}","merges_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/merges","archive_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/downloads","issues_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/issues{/number}","pulls_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/pulls{/number}","milestones_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/milestones{/number}","notifications_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/labels{/name}","releases_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/releases{/id}","deployments_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/deployments","created_at":"2015-08-07T09:54:38Z","updated_at":"2018-12-21T06:06:05Z","pushed_at":"2018-12-27T08:55:29Z","git_url":"git://github.com/kuzzleio/sdk-javascript.git","ssh_url":"git@github.com:kuzzleio/sdk-javascript.git","clone_url":"https://github.com/kuzzleio/sdk-javascript.git","svn_url":"https://github.com/kuzzleio/sdk-javascript","homepage":"http://docs.kuzzle.io/sdk-reference/?javascript#kuzzle","size":33150,"stargazers_count":18,"watchers_count":18,"language":"JavaScript","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":5,"mirror_url":null,"archived":false,"open_issues_count":14,"license":{"key":"apache-2.0","name":"Apache License 2.0","spdx_id":"Apache-2.0","url":"https://api.github.com/licenses/apache-2.0","node_id":"MDc6TGljZW5zZTI="},"forks":5,"open_issues":14,"watchers":18,"default_branch":"master"}},"base":{"label":"kuzzleio:6-dev","ref":"6-dev","sha":"7390dfbbd85601455db06648e3c245f776257e0a","user":{"login":"kuzzleio","id":12933347,"node_id":"MDEyOk9yZ2FuaXphdGlvbjEyOTMzMzQ3","avatar_url":"https://avatars1.githubusercontent.com/u/12933347?v=4","gravatar_id":"","url":"https://api.github.com/users/kuzzleio","html_url":"https://github.com/kuzzleio","followers_url":"https://api.github.com/users/kuzzleio/followers","following_url":"https://api.github.com/users/kuzzleio/following{/other_user}","gists_url":"https://api.github.com/users/kuzzleio/gists{/gist_id}","starred_url":"https://api.github.com/users/kuzzleio/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kuzzleio/subscriptions","organizations_url":"https://api.github.com/users/kuzzleio/orgs","repos_url":"https://api.github.com/users/kuzzleio/repos","events_url":"https://api.github.com/users/kuzzleio/events{/privacy}","received_events_url":"https://api.github.com/users/kuzzleio/received_events","type":"Organization","site_admin":false},"repo":{"id":40353752,"node_id":"MDEwOlJlcG9zaXRvcnk0MDM1Mzc1Mg==","name":"sdk-javascript","full_name":"kuzzleio/sdk-javascript","private":false,"owner":{"login":"kuzzleio","id":12933347,"node_id":"MDEyOk9yZ2FuaXphdGlvbjEyOTMzMzQ3","avatar_url":"https://avatars1.githubusercontent.com/u/12933347?v=4","gravatar_id":"","url":"https://api.github.com/users/kuzzleio","html_url":"https://github.com/kuzzleio","followers_url":"https://api.github.com/users/kuzzleio/followers","following_url":"https://api.github.com/users/kuzzleio/following{/other_user}","gists_url":"https://api.github.com/users/kuzzleio/gists{/gist_id}","starred_url":"https://api.github.com/users/kuzzleio/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kuzzleio/subscriptions","organizations_url":"https://api.github.com/users/kuzzleio/orgs","repos_url":"https://api.github.com/users/kuzzleio/repos","events_url":"https://api.github.com/users/kuzzleio/events{/privacy}","received_events_url":"https://api.github.com/users/kuzzleio/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/kuzzleio/sdk-javascript","description":"Official javascript SDK for Kuzzle","fork":false,"url":"https://api.github.com/repos/kuzzleio/sdk-javascript","forks_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/forks","keys_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/keys{/key_id}","collaborators_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/teams","hooks_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/hooks","issue_events_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/issues/events{/number}","events_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/events","assignees_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/assignees{/user}","branches_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/branches{/branch}","tags_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/tags","blobs_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/git/refs{/sha}","trees_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/git/trees{/sha}","statuses_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/statuses/{sha}","languages_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/languages","stargazers_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/stargazers","contributors_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/contributors","subscribers_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/subscribers","subscription_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/subscription","commits_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/commits{/sha}","git_commits_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/git/commits{/sha}","comments_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/comments{/number}","issue_comment_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/issues/comments{/number}","contents_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/contents/{+path}","compare_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/compare/{base}...{head}","merges_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/merges","archive_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/downloads","issues_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/issues{/number}","pulls_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/pulls{/number}","milestones_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/milestones{/number}","notifications_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/labels{/name}","releases_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/releases{/id}","deployments_url":"https://api.github.com/repos/kuzzleio/sdk-javascript/deployments","created_at":"2015-08-07T09:54:38Z","updated_at":"2018-12-21T06:06:05Z","pushed_at":"2018-12-27T08:55:29Z","git_url":"git://github.com/kuzzleio/sdk-javascript.git","ssh_url":"git@github.com:kuzzleio/sdk-javascript.git","clone_url":"https://github.com/kuzzleio/sdk-javascript.git","svn_url":"https://github.com/kuzzleio/sdk-javascript","homepage":"http://docs.kuzzle.io/sdk-reference/?javascript#kuzzle","size":33150,"stargazers_count":18,"watchers_count":18,"language":"JavaScript","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":5,"mirror_url":null,"archived":false,"open_issues_count":14,"license":{"key":"apache-2.0","name":"Apache License 2.0","spdx_id":"Apache-2.0","url":"https://api.github.com/licenses/apache-2.0","node_id":"MDc6TGljZW5zZTI="},"forks":5,"open_issues":14,"watchers":18,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/kuzzleio/sdk-javascript/pulls/350"},"html":{"href":"https://github.com/kuzzleio/sdk-javascript/pull/350"},"issue":{"href":"https://api.github.com/repos/kuzzleio/sdk-javascript/issues/350"},"comments":{"href":"https://api.github.com/repos/kuzzleio/sdk-javascript/issues/350/comments"},"review_comments":{"href":"https://api.github.com/repos/kuzzleio/sdk-javascript/pulls/350/comments"},"review_comment":{"href":"https://api.github.com/repos/kuzzleio/sdk-javascript/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/kuzzleio/sdk-javascript/pulls/350/commits"},"statuses":{"href":"https://api.github.com/repos/kuzzleio/sdk-javascript/statuses/ccdae732d2c55ab8a2ff073b1791d1bab3519139"}},"author_association":"CONTRIBUTOR"}}
{"actor":{"display_login":"etrousset"}}