{"action":"created","comment":{"url":"https://api.github.com/repos/apple/swift-nio/pulls/comments/237184514","pull_request_review_id":179420658,"id":237184514,"node_id":"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDIzNzE4NDUxNA==","diff_hunk":"@@ -0,0 +1,65 @@\n+# SwiftNIO 2 Public API\n+\n+The SwiftNIO project (which includes all of `github.com/apple/swift-nio*`)aims to follow [SemVer 2.0.0](https://semver.org/spec/v2.0.0.html) which requires to declare a public API. This document along with the [API documentation](https://apple.github.io/swift-nio/) declare SwiftNIO's API.\n+\n+### What Are Acceptable Uses of NIO's Public API\n+\n+- it's acceptable and expected to use any type and call any method from the `NIO*` modules unless the type or function name start with an underscore (`_`).","path":"docs/public-api.md","position":7,"original_position":7,"commit_id":"8dae9e3f198a6932056f028d40de9953439995cc","original_commit_id":"8dae9e3f198a6932056f028d40de9953439995cc","user":{"login":"Lukasa","id":1382556,"node_id":"MDQ6VXNlcjEzODI1NTY=","avatar_url":"https://avatars1.githubusercontent.com/u/1382556?v=4","gravatar_id":"","url":"https://api.github.com/users/Lukasa","html_url":"https://github.com/Lukasa","followers_url":"https://api.github.com/users/Lukasa/followers","following_url":"https://api.github.com/users/Lukasa/following{/other_user}","gists_url":"https://api.github.com/users/Lukasa/gists{/gist_id}","starred_url":"https://api.github.com/users/Lukasa/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Lukasa/subscriptions","organizations_url":"https://api.github.com/users/Lukasa/orgs","repos_url":"https://api.github.com/users/Lukasa/repos","events_url":"https://api.github.com/users/Lukasa/events{/privacy}","received_events_url":"https://api.github.com/users/Lukasa/received_events","type":"User","site_admin":false},"body":"While we're here, can we capitalise the first words of all of these points? They're full sentences.","created_at":"2018-11-28T17:25:46Z","updated_at":"2018-11-28T17:31:21Z","html_url":"https://github.com/apple/swift-nio/pull/673#discussion_r237184514","pull_request_url":"https://api.github.com/repos/apple/swift-nio/pulls/673","author_association":"CONTRIBUTOR","_links":{"self":{"href":"https://api.github.com/repos/apple/swift-nio/pulls/comments/237184514"},"html":{"href":"https://github.com/apple/swift-nio/pull/673#discussion_r237184514"},"pull_request":{"href":"https://api.github.com/repos/apple/swift-nio/pulls/673"}},"in_reply_to_id":237159611},"pull_request":{"url":"https://api.github.com/repos/apple/swift-nio/pulls/673","id":234340561,"node_id":"MDExOlB1bGxSZXF1ZXN0MjM0MzQwNTYx","html_url":"https://github.com/apple/swift-nio/pull/673","diff_url":"https://github.com/apple/swift-nio/pull/673.diff","patch_url":"https://github.com/apple/swift-nio/pull/673.patch","issue_url":"https://api.github.com/repos/apple/swift-nio/issues/673","number":673,"state":"open","locked":false,"title":"RFC: declare public API","user":{"login":"weissi","id":624238,"node_id":"MDQ6VXNlcjYyNDIzOA==","avatar_url":"https://avatars2.githubusercontent.com/u/624238?v=4","gravatar_id":"","url":"https://api.github.com/users/weissi","html_url":"https://github.com/weissi","followers_url":"https://api.github.com/users/weissi/followers","following_url":"https://api.github.com/users/weissi/following{/other_user}","gists_url":"https://api.github.com/users/weissi/gists{/gist_id}","starred_url":"https://api.github.com/users/weissi/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/weissi/subscriptions","organizations_url":"https://api.github.com/users/weissi/orgs","repos_url":"https://api.github.com/users/weissi/repos","events_url":"https://api.github.com/users/weissi/events{/privacy}","received_events_url":"https://api.github.com/users/weissi/received_events","type":"User","site_admin":false},"body":"Motivation:\r\n\r\nSemVer requires us to declare a public API, we should do so for NIO 2.\r\n\r\nModifications:\r\n\r\ndeclare our public API.\r\n\r\nResult:\r\n\r\n- more transparency into our versioning policy.\r\n- resolves #405 \r\n","created_at":"2018-11-28T16:24:13Z","updated_at":"2018-11-28T17:31:21Z","closed_at":null,"merged_at":null,"merge_commit_sha":"afe6eea06b174b50b64328f98a2a143af5e160b4","assignee":null,"assignees":[],"requested_reviewers":[{"login":"tomerd","id":147247,"node_id":"MDQ6VXNlcjE0NzI0Nw==","avatar_url":"https://avatars3.githubusercontent.com/u/147247?v=4","gravatar_id":"","url":"https://api.github.com/users/tomerd","html_url":"https://github.com/tomerd","followers_url":"https://api.github.com/users/tomerd/followers","following_url":"https://api.github.com/users/tomerd/following{/other_user}","gists_url":"https://api.github.com/users/tomerd/gists{/gist_id}","starred_url":"https://api.github.com/users/tomerd/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/tomerd/subscriptions","organizations_url":"https://api.github.com/users/tomerd/orgs","repos_url":"https://api.github.com/users/tomerd/repos","events_url":"https://api.github.com/users/tomerd/events{/privacy}","received_events_url":"https://api.github.com/users/tomerd/received_events","type":"User","site_admin":false},{"login":"normanmaurer","id":439362,"node_id":"MDQ6VXNlcjQzOTM2Mg==","avatar_url":"https://avatars3.githubusercontent.com/u/439362?v=4","gravatar_id":"","url":"https://api.github.com/users/normanmaurer","html_url":"https://github.com/normanmaurer","followers_url":"https://api.github.com/users/normanmaurer/followers","following_url":"https://api.github.com/users/normanmaurer/following{/other_user}","gists_url":"https://api.github.com/users/normanmaurer/gists{/gist_id}","starred_url":"https://api.github.com/users/normanmaurer/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/normanmaurer/subscriptions","organizations_url":"https://api.github.com/users/normanmaurer/orgs","repos_url":"https://api.github.com/users/normanmaurer/repos","events_url":"https://api.github.com/users/normanmaurer/events{/privacy}","received_events_url":"https://api.github.com/users/normanmaurer/received_events","type":"User","site_admin":false}],"requested_teams":[],"labels":[{"id":844993462,"node_id":"MDU6TGFiZWw4NDQ5OTM0NjI=","url":"https://api.github.com/repos/apple/swift-nio/labels/%E2%9A%A0%EF%B8%8F%20needs-major-version-bump","name":"⚠️ needs-major-version-bump","color":"ff3f0b","default":false}],"milestone":null,"commits_url":"https://api.github.com/repos/apple/swift-nio/pulls/673/commits","review_comments_url":"https://api.github.com/repos/apple/swift-nio/pulls/673/comments","review_comment_url":"https://api.github.com/repos/apple/swift-nio/pulls/comments{/number}","comments_url":"https://api.github.com/repos/apple/swift-nio/issues/673/comments","statuses_url":"https://api.github.com/repos/apple/swift-nio/statuses/8dae9e3f198a6932056f028d40de9953439995cc","head":{"label":"weissi:jw-public-api","ref":"jw-public-api","sha":"8dae9e3f198a6932056f028d40de9953439995cc","user":{"login":"weissi","id":624238,"node_id":"MDQ6VXNlcjYyNDIzOA==","avatar_url":"https://avatars2.githubusercontent.com/u/624238?v=4","gravatar_id":"","url":"https://api.github.com/users/weissi","html_url":"https://github.com/weissi","followers_url":"https://api.github.com/users/weissi/followers","following_url":"https://api.github.com/users/weissi/following{/other_user}","gists_url":"https://api.github.com/users/weissi/gists{/gist_id}","starred_url":"https://api.github.com/users/weissi/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/weissi/subscriptions","organizations_url":"https://api.github.com/users/weissi/orgs","repos_url":"https://api.github.com/users/weissi/repos","events_url":"https://api.github.com/users/weissi/events{/privacy}","received_events_url":"https://api.github.com/users/weissi/received_events","type":"User","site_admin":false},"repo":{"id":123523477,"node_id":"MDEwOlJlcG9zaXRvcnkxMjM1MjM0Nzc=","name":"swift-nio","full_name":"weissi/swift-nio","private":false,"owner":{"login":"weissi","id":624238,"node_id":"MDQ6VXNlcjYyNDIzOA==","avatar_url":"https://avatars2.githubusercontent.com/u/624238?v=4","gravatar_id":"","url":"https://api.github.com/users/weissi","html_url":"https://github.com/weissi","followers_url":"https://api.github.com/users/weissi/followers","following_url":"https://api.github.com/users/weissi/following{/other_user}","gists_url":"https://api.github.com/users/weissi/gists{/gist_id}","starred_url":"https://api.github.com/users/weissi/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/weissi/subscriptions","organizations_url":"https://api.github.com/users/weissi/orgs","repos_url":"https://api.github.com/users/weissi/repos","events_url":"https://api.github.com/users/weissi/events{/privacy}","received_events_url":"https://api.github.com/users/weissi/received_events","type":"User","site_admin":false},"html_url":"https://github.com/weissi/swift-nio","description":"Event-driven network application framework for high performance protocol servers & clients, non-blocking.","fork":true,"url":"https://api.github.com/repos/weissi/swift-nio","forks_url":"https://api.github.com/repos/weissi/swift-nio/forks","keys_url":"https://api.github.com/repos/weissi/swift-nio/keys{/key_id}","collaborators_url":"https://api.github.com/repos/weissi/swift-nio/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/weissi/swift-nio/teams","hooks_url":"https://api.github.com/repos/weissi/swift-nio/hooks","issue_events_url":"https://api.github.com/repos/weissi/swift-nio/issues/events{/number}","events_url":"https://api.github.com/repos/weissi/swift-nio/events","assignees_url":"https://api.github.com/repos/weissi/swift-nio/assignees{/user}","branches_url":"https://api.github.com/repos/weissi/swift-nio/branches{/branch}","tags_url":"https://api.github.com/repos/weissi/swift-nio/tags","blobs_url":"https://api.github.com/repos/weissi/swift-nio/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/weissi/swift-nio/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/weissi/swift-nio/git/refs{/sha}","trees_url":"https://api.github.com/repos/weissi/swift-nio/git/trees{/sha}","statuses_url":"https://api.github.com/repos/weissi/swift-nio/statuses/{sha}","languages_url":"https://api.github.com/repos/weissi/swift-nio/languages","stargazers_url":"https://api.github.com/repos/weissi/swift-nio/stargazers","contributors_url":"https://api.github.com/repos/weissi/swift-nio/contributors","subscribers_url":"https://api.github.com/repos/weissi/swift-nio/subscribers","subscription_url":"https://api.github.com/repos/weissi/swift-nio/subscription","commits_url":"https://api.github.com/repos/weissi/swift-nio/commits{/sha}","git_commits_url":"https://api.github.com/repos/weissi/swift-nio/git/commits{/sha}","comments_url":"https://api.github.com/repos/weissi/swift-nio/comments{/number}","issue_comment_url":"https://api.github.com/repos/weissi/swift-nio/issues/comments{/number}","contents_url":"https://api.github.com/repos/weissi/swift-nio/contents/{+path}","compare_url":"https://api.github.com/repos/weissi/swift-nio/compare/{base}...{head}","merges_url":"https://api.github.com/repos/weissi/swift-nio/merges","archive_url":"https://api.github.com/repos/weissi/swift-nio/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/weissi/swift-nio/downloads","issues_url":"https://api.github.com/repos/weissi/swift-nio/issues{/number}","pulls_url":"https://api.github.com/repos/weissi/swift-nio/pulls{/number}","milestones_url":"https://api.github.com/repos/weissi/swift-nio/milestones{/number}","notifications_url":"https://api.github.com/repos/weissi/swift-nio/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/weissi/swift-nio/labels{/name}","releases_url":"https://api.github.com/repos/weissi/swift-nio/releases{/id}","deployments_url":"https://api.github.com/repos/weissi/swift-nio/deployments","created_at":"2018-03-02T03:09:39Z","updated_at":"2018-03-02T03:09:41Z","pushed_at":"2018-11-28T16:51:20Z","git_url":"git://github.com/weissi/swift-nio.git","ssh_url":"git@github.com:weissi/swift-nio.git","clone_url":"https://github.com/weissi/swift-nio.git","svn_url":"https://github.com/weissi/swift-nio","homepage":"","size":4177,"stargazers_count":0,"watchers_count":0,"language":"Swift","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":0,"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":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"apple:master","ref":"master","sha":"c1a84a00852567003758e058b64def72515ff3b8","user":{"login":"apple","id":10639145,"node_id":"MDEyOk9yZ2FuaXphdGlvbjEwNjM5MTQ1","avatar_url":"https://avatars0.githubusercontent.com/u/10639145?v=4","gravatar_id":"","url":"https://api.github.com/users/apple","html_url":"https://github.com/apple","followers_url":"https://api.github.com/users/apple/followers","following_url":"https://api.github.com/users/apple/following{/other_user}","gists_url":"https://api.github.com/users/apple/gists{/gist_id}","starred_url":"https://api.github.com/users/apple/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/apple/subscriptions","organizations_url":"https://api.github.com/users/apple/orgs","repos_url":"https://api.github.com/users/apple/repos","events_url":"https://api.github.com/users/apple/events{/privacy}","received_events_url":"https://api.github.com/users/apple/received_events","type":"Organization","site_admin":false},"repo":{"id":120498971,"node_id":"MDEwOlJlcG9zaXRvcnkxMjA0OTg5NzE=","name":"swift-nio","full_name":"apple/swift-nio","private":false,"owner":{"login":"apple","id":10639145,"node_id":"MDEyOk9yZ2FuaXphdGlvbjEwNjM5MTQ1","avatar_url":"https://avatars0.githubusercontent.com/u/10639145?v=4","gravatar_id":"","url":"https://api.github.com/users/apple","html_url":"https://github.com/apple","followers_url":"https://api.github.com/users/apple/followers","following_url":"https://api.github.com/users/apple/following{/other_user}","gists_url":"https://api.github.com/users/apple/gists{/gist_id}","starred_url":"https://api.github.com/users/apple/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/apple/subscriptions","organizations_url":"https://api.github.com/users/apple/orgs","repos_url":"https://api.github.com/users/apple/repos","events_url":"https://api.github.com/users/apple/events{/privacy}","received_events_url":"https://api.github.com/users/apple/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/apple/swift-nio","description":"Event-driven network application framework for high performance protocol servers & clients, non-blocking.","fork":false,"url":"https://api.github.com/repos/apple/swift-nio","forks_url":"https://api.github.com/repos/apple/swift-nio/forks","keys_url":"https://api.github.com/repos/apple/swift-nio/keys{/key_id}","collaborators_url":"https://api.github.com/repos/apple/swift-nio/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/apple/swift-nio/teams","hooks_url":"https://api.github.com/repos/apple/swift-nio/hooks","issue_events_url":"https://api.github.com/repos/apple/swift-nio/issues/events{/number}","events_url":"https://api.github.com/repos/apple/swift-nio/events","assignees_url":"https://api.github.com/repos/apple/swift-nio/assignees{/user}","branches_url":"https://api.github.com/repos/apple/swift-nio/branches{/branch}","tags_url":"https://api.github.com/repos/apple/swift-nio/tags","blobs_url":"https://api.github.com/repos/apple/swift-nio/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/apple/swift-nio/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/apple/swift-nio/git/refs{/sha}","trees_url":"https://api.github.com/repos/apple/swift-nio/git/trees{/sha}","statuses_url":"https://api.github.com/repos/apple/swift-nio/statuses/{sha}","languages_url":"https://api.github.com/repos/apple/swift-nio/languages","stargazers_url":"https://api.github.com/repos/apple/swift-nio/stargazers","contributors_url":"https://api.github.com/repos/apple/swift-nio/contributors","subscribers_url":"https://api.github.com/repos/apple/swift-nio/subscribers","subscription_url":"https://api.github.com/repos/apple/swift-nio/subscription","commits_url":"https://api.github.com/repos/apple/swift-nio/commits{/sha}","git_commits_url":"https://api.github.com/repos/apple/swift-nio/git/commits{/sha}","comments_url":"https://api.github.com/repos/apple/swift-nio/comments{/number}","issue_comment_url":"https://api.github.com/repos/apple/swift-nio/issues/comments{/number}","contents_url":"https://api.github.com/repos/apple/swift-nio/contents/{+path}","compare_url":"https://api.github.com/repos/apple/swift-nio/compare/{base}...{head}","merges_url":"https://api.github.com/repos/apple/swift-nio/merges","archive_url":"https://api.github.com/repos/apple/swift-nio/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/apple/swift-nio/downloads","issues_url":"https://api.github.com/repos/apple/swift-nio/issues{/number}","pulls_url":"https://api.github.com/repos/apple/swift-nio/pulls{/number}","milestones_url":"https://api.github.com/repos/apple/swift-nio/milestones{/number}","notifications_url":"https://api.github.com/repos/apple/swift-nio/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/apple/swift-nio/labels{/name}","releases_url":"https://api.github.com/repos/apple/swift-nio/releases{/id}","deployments_url":"https://api.github.com/repos/apple/swift-nio/deployments","created_at":"2018-02-06T17:47:31Z","updated_at":"2018-11-28T12:18:09Z","pushed_at":"2018-11-28T16:24:14Z","git_url":"git://github.com/apple/swift-nio.git","ssh_url":"git@github.com:apple/swift-nio.git","clone_url":"https://github.com/apple/swift-nio.git","svn_url":"https://github.com/apple/swift-nio","homepage":"","size":21551,"stargazers_count":4393,"watchers_count":4393,"language":"Swift","has_issues":true,"has_projects":false,"has_downloads":true,"has_wiki":false,"has_pages":true,"forks_count":224,"mirror_url":null,"archived":false,"open_issues_count":89,"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":224,"open_issues":89,"watchers":4393,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/apple/swift-nio/pulls/673"},"html":{"href":"https://github.com/apple/swift-nio/pull/673"},"issue":{"href":"https://api.github.com/repos/apple/swift-nio/issues/673"},"comments":{"href":"https://api.github.com/repos/apple/swift-nio/issues/673/comments"},"review_comments":{"href":"https://api.github.com/repos/apple/swift-nio/pulls/673/comments"},"review_comment":{"href":"https://api.github.com/repos/apple/swift-nio/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/apple/swift-nio/pulls/673/commits"},"statuses":{"href":"https://api.github.com/repos/apple/swift-nio/statuses/8dae9e3f198a6932056f028d40de9953439995cc"}},"author_association":"CONTRIBUTOR"}}
{"actor":{"display_login":"Lukasa"}}