{"action":"created","comment":{"url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/pulls/comments/91811202","pull_request_review_id":12324434,"id":91811202,"diff_hunk":"@@ -0,0 +1,381 @@\n+Zasady konstrukcji API\n+======================\n+do wewnętrznego użycia w EZD oraz dla zewnętrznych aplikacji — rekomendacje\n+>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n+\n+\n+*Dobre praktyki i zalecenia dotyczące konstrukcji API.*\n+\n+\n+API dla Java\n+------------\n+\n+Projektuj przewidując rozwój\n+++++++++++++++++++++++++++++\n+\n+Jeśli API jest cokolwiek warte – będzie ewoluować.   Z drugiej strony, jeśli coś w API już jest, to zapewne będzie musiało zostać.\n+\n+2 postulaty wstecznej zgodności:\n+\n+- skompilowany kod nadal działa (zgodność binarna)\n+- istniejący kod źródłowy można nadal skompilować (zgodność źródłowa).\n+\n+Nie da się przewidzieć, w jaki sposób użytkownicy skorzystają z API.\n+Rozważając zmianę – należy rozumować konserwatywnie: *tylko* jeśli można stwierdzić z prawdopodobieństwem graniczącym z pewnością, że zmiana nie spowoduje załamania jakiejkolwiek istniejącej aplikacji – *można* zmianę wprowadzić.\n+\n+Jeśli potrzebne jest wprowadzenie większych zmian – należy zbudować nowe API, z inną nazwą.\n+\n+Dobrym pomysłem jest wprowadzenie na początek jednej lub kilku wersji o numerach 0.xx przed wersją 1.0. Użytkownicy rozumieją, że takie wersje mogą być zmieniane.\n+\n+API – cele projektowe\n++++++++++++++++++++++\n+\n+Musi być:\n+\n+- absolutnie poprawny\n+- łatwy do użycia\n+- trudny do błędnego użycia\n+- łatwy do nauczenia\n+- wystarczająco szybki\n+- wystarczająco mały.\n+\n+Minimalizm\n+++++++++++\n+\n+Znacznie łatwiej dodawać nowe elementy niż je usuwać.\n+\n+Im więcej jest elementów w API, tym trudniej jest się nauczyć.\n+\n+Im większy API, tym więcej może być błędów.\n+\n+Nadmiarowe metody niepotrzebnie zajmują miejsce.\n+\n+Ostrożnie z pakietami","path":"zasady_konstrukcji_api.rst","position":53,"original_position":53,"commit_id":"81cb73919d7be7434545fde844ad626455249965","original_commit_id":"81cb73919d7be7434545fde844ad626455249965","user":{"login":"sjchmiela","id":1151041,"avatar_url":"https://avatars.githubusercontent.com/u/1151041?v=3","gravatar_id":"","url":"https://api.github.com/users/sjchmiela","html_url":"https://github.com/sjchmiela","followers_url":"https://api.github.com/users/sjchmiela/followers","following_url":"https://api.github.com/users/sjchmiela/following{/other_user}","gists_url":"https://api.github.com/users/sjchmiela/gists{/gist_id}","starred_url":"https://api.github.com/users/sjchmiela/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sjchmiela/subscriptions","organizations_url":"https://api.github.com/users/sjchmiela/orgs","repos_url":"https://api.github.com/users/sjchmiela/repos","events_url":"https://api.github.com/users/sjchmiela/events{/privacy}","received_events_url":"https://api.github.com/users/sjchmiela/received_events","type":"User","site_admin":false},"body":"https://github.com/Ministerstwo-Cyfryzacji/ezd-analizy-it/pull/14/files#r91765472\r\n\r\nznów, why Java","created_at":"2016-12-09T22:51:24Z","updated_at":"2016-12-09T22:57:12Z","html_url":"https://github.com/Ministerstwo-Cyfryzacji/ezd-analizy-it/pull/14#discussion_r91811202","pull_request_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/pulls/14","_links":{"self":{"href":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/pulls/comments/91811202"},"html":{"href":"https://github.com/Ministerstwo-Cyfryzacji/ezd-analizy-it/pull/14#discussion_r91811202"},"pull_request":{"href":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/pulls/14"}}},"pull_request":{"url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/pulls/14","id":96115866,"html_url":"https://github.com/Ministerstwo-Cyfryzacji/ezd-analizy-it/pull/14","diff_url":"https://github.com/Ministerstwo-Cyfryzacji/ezd-analizy-it/pull/14.diff","patch_url":"https://github.com/Ministerstwo-Cyfryzacji/ezd-analizy-it/pull/14.patch","issue_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/issues/14","number":14,"state":"open","locked":false,"title":"Dodany dokument Zasady konstrukcji API","user":{"login":"stas53","id":9504047,"avatar_url":"https://avatars.githubusercontent.com/u/9504047?v=3","gravatar_id":"","url":"https://api.github.com/users/stas53","html_url":"https://github.com/stas53","followers_url":"https://api.github.com/users/stas53/followers","following_url":"https://api.github.com/users/stas53/following{/other_user}","gists_url":"https://api.github.com/users/stas53/gists{/gist_id}","starred_url":"https://api.github.com/users/stas53/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/stas53/subscriptions","organizations_url":"https://api.github.com/users/stas53/orgs","repos_url":"https://api.github.com/users/stas53/repos","events_url":"https://api.github.com/users/stas53/events{/privacy}","received_events_url":"https://api.github.com/users/stas53/received_events","type":"User","site_admin":false},"body":"Tytuł mi się nie bardzo podoba, ale nie potrafię ładniej.\r\n\r\nNie użyłem konstrukcji 'definicji', bo tak jak jest (z użyciem '**') - podoba mi się bardziej.","created_at":"2016-12-01T15:57:23Z","updated_at":"2016-12-09T22:57:12Z","closed_at":null,"merged_at":null,"merge_commit_sha":"c784c6758c88076e85e54ec594352ea5f63b9c51","assignee":null,"assignees":[],"milestone":null,"commits_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/pulls/14/commits","review_comments_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/pulls/14/comments","review_comment_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/pulls/comments{/number}","comments_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/issues/14/comments","statuses_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/statuses/81cb73919d7be7434545fde844ad626455249965","head":{"label":"stas53:api_zasady","ref":"api_zasady","sha":"81cb73919d7be7434545fde844ad626455249965","user":{"login":"stas53","id":9504047,"avatar_url":"https://avatars.githubusercontent.com/u/9504047?v=3","gravatar_id":"","url":"https://api.github.com/users/stas53","html_url":"https://github.com/stas53","followers_url":"https://api.github.com/users/stas53/followers","following_url":"https://api.github.com/users/stas53/following{/other_user}","gists_url":"https://api.github.com/users/stas53/gists{/gist_id}","starred_url":"https://api.github.com/users/stas53/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/stas53/subscriptions","organizations_url":"https://api.github.com/users/stas53/orgs","repos_url":"https://api.github.com/users/stas53/repos","events_url":"https://api.github.com/users/stas53/events{/privacy}","received_events_url":"https://api.github.com/users/stas53/received_events","type":"User","site_admin":false},"repo":{"id":72203756,"name":"ezd-analizy-it","full_name":"stas53/ezd-analizy-it","owner":{"login":"stas53","id":9504047,"avatar_url":"https://avatars.githubusercontent.com/u/9504047?v=3","gravatar_id":"","url":"https://api.github.com/users/stas53","html_url":"https://github.com/stas53","followers_url":"https://api.github.com/users/stas53/followers","following_url":"https://api.github.com/users/stas53/following{/other_user}","gists_url":"https://api.github.com/users/stas53/gists{/gist_id}","starred_url":"https://api.github.com/users/stas53/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/stas53/subscriptions","organizations_url":"https://api.github.com/users/stas53/orgs","repos_url":"https://api.github.com/users/stas53/repos","events_url":"https://api.github.com/users/stas53/events{/privacy}","received_events_url":"https://api.github.com/users/stas53/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/stas53/ezd-analizy-it","description":null,"fork":true,"url":"https://api.github.com/repos/stas53/ezd-analizy-it","forks_url":"https://api.github.com/repos/stas53/ezd-analizy-it/forks","keys_url":"https://api.github.com/repos/stas53/ezd-analizy-it/keys{/key_id}","collaborators_url":"https://api.github.com/repos/stas53/ezd-analizy-it/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/stas53/ezd-analizy-it/teams","hooks_url":"https://api.github.com/repos/stas53/ezd-analizy-it/hooks","issue_events_url":"https://api.github.com/repos/stas53/ezd-analizy-it/issues/events{/number}","events_url":"https://api.github.com/repos/stas53/ezd-analizy-it/events","assignees_url":"https://api.github.com/repos/stas53/ezd-analizy-it/assignees{/user}","branches_url":"https://api.github.com/repos/stas53/ezd-analizy-it/branches{/branch}","tags_url":"https://api.github.com/repos/stas53/ezd-analizy-it/tags","blobs_url":"https://api.github.com/repos/stas53/ezd-analizy-it/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/stas53/ezd-analizy-it/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/stas53/ezd-analizy-it/git/refs{/sha}","trees_url":"https://api.github.com/repos/stas53/ezd-analizy-it/git/trees{/sha}","statuses_url":"https://api.github.com/repos/stas53/ezd-analizy-it/statuses/{sha}","languages_url":"https://api.github.com/repos/stas53/ezd-analizy-it/languages","stargazers_url":"https://api.github.com/repos/stas53/ezd-analizy-it/stargazers","contributors_url":"https://api.github.com/repos/stas53/ezd-analizy-it/contributors","subscribers_url":"https://api.github.com/repos/stas53/ezd-analizy-it/subscribers","subscription_url":"https://api.github.com/repos/stas53/ezd-analizy-it/subscription","commits_url":"https://api.github.com/repos/stas53/ezd-analizy-it/commits{/sha}","git_commits_url":"https://api.github.com/repos/stas53/ezd-analizy-it/git/commits{/sha}","comments_url":"https://api.github.com/repos/stas53/ezd-analizy-it/comments{/number}","issue_comment_url":"https://api.github.com/repos/stas53/ezd-analizy-it/issues/comments{/number}","contents_url":"https://api.github.com/repos/stas53/ezd-analizy-it/contents/{+path}","compare_url":"https://api.github.com/repos/stas53/ezd-analizy-it/compare/{base}...{head}","merges_url":"https://api.github.com/repos/stas53/ezd-analizy-it/merges","archive_url":"https://api.github.com/repos/stas53/ezd-analizy-it/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/stas53/ezd-analizy-it/downloads","issues_url":"https://api.github.com/repos/stas53/ezd-analizy-it/issues{/number}","pulls_url":"https://api.github.com/repos/stas53/ezd-analizy-it/pulls{/number}","milestones_url":"https://api.github.com/repos/stas53/ezd-analizy-it/milestones{/number}","notifications_url":"https://api.github.com/repos/stas53/ezd-analizy-it/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/stas53/ezd-analizy-it/labels{/name}","releases_url":"https://api.github.com/repos/stas53/ezd-analizy-it/releases{/id}","deployments_url":"https://api.github.com/repos/stas53/ezd-analizy-it/deployments","created_at":"2016-10-28T12:00:52Z","updated_at":"2016-10-24T11:28:25Z","pushed_at":"2016-12-09T17:29:23Z","git_url":"git://github.com/stas53/ezd-analizy-it.git","ssh_url":"git@github.com:stas53/ezd-analizy-it.git","clone_url":"https://github.com/stas53/ezd-analizy-it.git","svn_url":"https://github.com/stas53/ezd-analizy-it","homepage":null,"size":218,"stargazers_count":0,"watchers_count":0,"language":null,"has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":1,"mirror_url":null,"open_issues_count":0,"forks":1,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"Ministerstwo-Cyfryzacji:master","ref":"master","sha":"fb598b2fff43e6fe57fb809cc231dcde55802af7","user":{"login":"Ministerstwo-Cyfryzacji","id":22318476,"avatar_url":"https://avatars.githubusercontent.com/u/22318476?v=3","gravatar_id":"","url":"https://api.github.com/users/Ministerstwo-Cyfryzacji","html_url":"https://github.com/Ministerstwo-Cyfryzacji","followers_url":"https://api.github.com/users/Ministerstwo-Cyfryzacji/followers","following_url":"https://api.github.com/users/Ministerstwo-Cyfryzacji/following{/other_user}","gists_url":"https://api.github.com/users/Ministerstwo-Cyfryzacji/gists{/gist_id}","starred_url":"https://api.github.com/users/Ministerstwo-Cyfryzacji/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Ministerstwo-Cyfryzacji/subscriptions","organizations_url":"https://api.github.com/users/Ministerstwo-Cyfryzacji/orgs","repos_url":"https://api.github.com/users/Ministerstwo-Cyfryzacji/repos","events_url":"https://api.github.com/users/Ministerstwo-Cyfryzacji/events{/privacy}","received_events_url":"https://api.github.com/users/Ministerstwo-Cyfryzacji/received_events","type":"Organization","site_admin":false},"repo":{"id":68700223,"name":"ezd-analizy-it","full_name":"Ministerstwo-Cyfryzacji/ezd-analizy-it","owner":{"login":"Ministerstwo-Cyfryzacji","id":22318476,"avatar_url":"https://avatars.githubusercontent.com/u/22318476?v=3","gravatar_id":"","url":"https://api.github.com/users/Ministerstwo-Cyfryzacji","html_url":"https://github.com/Ministerstwo-Cyfryzacji","followers_url":"https://api.github.com/users/Ministerstwo-Cyfryzacji/followers","following_url":"https://api.github.com/users/Ministerstwo-Cyfryzacji/following{/other_user}","gists_url":"https://api.github.com/users/Ministerstwo-Cyfryzacji/gists{/gist_id}","starred_url":"https://api.github.com/users/Ministerstwo-Cyfryzacji/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Ministerstwo-Cyfryzacji/subscriptions","organizations_url":"https://api.github.com/users/Ministerstwo-Cyfryzacji/orgs","repos_url":"https://api.github.com/users/Ministerstwo-Cyfryzacji/repos","events_url":"https://api.github.com/users/Ministerstwo-Cyfryzacji/events{/privacy}","received_events_url":"https://api.github.com/users/Ministerstwo-Cyfryzacji/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/Ministerstwo-Cyfryzacji/ezd-analizy-it","description":null,"fork":false,"url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it","forks_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/forks","keys_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/keys{/key_id}","collaborators_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/teams","hooks_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/hooks","issue_events_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/issues/events{/number}","events_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/events","assignees_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/assignees{/user}","branches_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/branches{/branch}","tags_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/tags","blobs_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/git/refs{/sha}","trees_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/git/trees{/sha}","statuses_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/statuses/{sha}","languages_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/languages","stargazers_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/stargazers","contributors_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/contributors","subscribers_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/subscribers","subscription_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/subscription","commits_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/commits{/sha}","git_commits_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/git/commits{/sha}","comments_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/comments{/number}","issue_comment_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/issues/comments{/number}","contents_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/contents/{+path}","compare_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/compare/{base}...{head}","merges_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/merges","archive_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/downloads","issues_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/issues{/number}","pulls_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/pulls{/number}","milestones_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/milestones{/number}","notifications_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/labels{/name}","releases_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/releases{/id}","deployments_url":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/deployments","created_at":"2016-09-20T10:17:42Z","updated_at":"2016-12-09T13:16:30Z","pushed_at":"2016-12-09T18:17:20Z","git_url":"git://github.com/Ministerstwo-Cyfryzacji/ezd-analizy-it.git","ssh_url":"git@github.com:Ministerstwo-Cyfryzacji/ezd-analizy-it.git","clone_url":"https://github.com/Ministerstwo-Cyfryzacji/ezd-analizy-it.git","svn_url":"https://github.com/Ministerstwo-Cyfryzacji/ezd-analizy-it","homepage":null,"size":220,"stargazers_count":27,"watchers_count":27,"language":null,"has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":12,"mirror_url":null,"open_issues_count":3,"forks":12,"open_issues":3,"watchers":27,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/pulls/14"},"html":{"href":"https://github.com/Ministerstwo-Cyfryzacji/ezd-analizy-it/pull/14"},"issue":{"href":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/issues/14"},"comments":{"href":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/issues/14/comments"},"review_comments":{"href":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/pulls/14/comments"},"review_comment":{"href":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/pulls/14/commits"},"statuses":{"href":"https://api.github.com/repos/Ministerstwo-Cyfryzacji/ezd-analizy-it/statuses/81cb73919d7be7434545fde844ad626455249965"}}}}
{"actor":{"display_login":"sjchmiela"}}