{"action":"created","comment":{"url":"https://api.github.com/repos/square/retrofit/pulls/comments/48224501","id":48224501,"diff_hunk":"@@ -110,7 +77,52 @@\n     this.validateEagerly = validateEagerly;\n   }\n \n-  /** Create an implementation of the API defined by the {@code service} interface. */\n+  /**\n+   * Create an implementation of the API endpoints defined by the {@code service} interface.\n+   * <p>\n+   * The relative path for a given method is obtained from an annotation on the method describing\n+   * the request type. The built-in methods are {@link retrofit2.http.GET GET},\n+   * {@link retrofit2.http.PUT PUT}, {@link retrofit2.http.POST POST}, {@link retrofit2.http.PATCH\n+   * PATCH}, {@link retrofit2.http.HEAD HEAD}, {@link retrofit2.http.DELETE DELETE} and\n+   * {@link retrofit2.http.OPTIONS OPTIONS}. You can use a custom HTTP method with\n+   * {@link HTTP @HTTP}. For a dynamic URL, omit the path on the annotation and annotate the first\n+   * parameter with {@link Url @Url}.\n+   * <p>\n+   * Method parameters can be used to replace parts of the URL by annotating them with\n+   * {@link retrofit2.http.Path @Path}. Replacement sections are denoted by an identifier\n+   * surrounded by curly braces (e.g., \"{foo}\"). To add items to the query string of a URL use\n+   * {@link retrofit2.http.Query @Query}.\n+   * <p>\n+   * The body of a request is denoted by the {@link retrofit2.http.Body @Body} annotation. The\n+   * object will be converted to request representation by one of the {@link Converter.Factory}\n+   * instances. A {@link RequestBody} can also be used for a raw representation.\n+   * <p>\n+   * Alternative request body formats are supported by method annotations and corresponding\n+   * parameter annotations:\n+   * <ul>\n+   * <li>{@link retrofit2.http.FormUrlEncoded @FormUrlEncoded} - Form-encoded data with key-value\n+   * pairs specified by the {@link retrofit2.http.Field @Field} parameter annotation.\n+   * <li>{@link retrofit2.http.Multipart @Multipart} - RFC 2388-compliant multi-part data with\n+   * parts specified by the {@link retrofit2.http.Part @Part} parameter annotation.\n+   * </ul>\n+   * <p>\n+   * Additional static headers can be added for an endpoint using the\n+   * {@link retrofit2.http.Headers @Headers} method annotation. For per-request control over a\n+   * header annotate a parameter with {@link Header @Header}.\n+   * <p>\n+   * By default, methods return a {@link Call} which represents the HTTP request. The generic\n+   * parameter of the call is the response body type and will be converted by one of the\n+   * {@link Converter.Factory} instances. {@link ResponseBody} can also be used for a raw\n+   * representation. {@link Void} can be used if you do not care about the body contents.\n+   * <p>\n+   * For example:\n+   * <pre>\n+   * public interface CategoryService {\n+   *   &#64;POST(\"category/{cat}/\")\n+   *   Call&lt;List&lt;Item&gt;&gt; categoryList(@Path(\"cat\") String a, @Query(\"page\") int b);\n+   * }\n+   * </pre>\n+   */","path":"retrofit/src/main/java/retrofit2/Retrofit.java","position":123,"original_position":123,"commit_id":"094687dfdacdd0c98f4e8b3a00d7213945aed780","original_commit_id":"094687dfdacdd0c98f4e8b3a00d7213945aed780","user":{"login":"JakeWharton","id":66577,"avatar_url":"https://avatars.githubusercontent.com/u/66577?v=3","gravatar_id":"","url":"https://api.github.com/users/JakeWharton","html_url":"https://github.com/JakeWharton","followers_url":"https://api.github.com/users/JakeWharton/followers","following_url":"https://api.github.com/users/JakeWharton/following{/other_user}","gists_url":"https://api.github.com/users/JakeWharton/gists{/gist_id}","starred_url":"https://api.github.com/users/JakeWharton/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/JakeWharton/subscriptions","organizations_url":"https://api.github.com/users/JakeWharton/orgs","repos_url":"https://api.github.com/users/JakeWharton/repos","events_url":"https://api.github.com/users/JakeWharton/events{/privacy}","received_events_url":"https://api.github.com/users/JakeWharton/received_events","type":"User","site_admin":false},"body":"I'd like to pare this down in the future...","created_at":"2015-12-22T06:09:40Z","updated_at":"2015-12-22T06:09:40Z","html_url":"https://github.com/square/retrofit/pull/1400#discussion_r48224501","pull_request_url":"https://api.github.com/repos/square/retrofit/pulls/1400","_links":{"self":{"href":"https://api.github.com/repos/square/retrofit/pulls/comments/48224501"},"html":{"href":"https://github.com/square/retrofit/pull/1400#discussion_r48224501"},"pull_request":{"href":"https://api.github.com/repos/square/retrofit/pulls/1400"}}},"pull_request":{"url":"https://api.github.com/repos/square/retrofit/pulls/1400","id":54336289,"html_url":"https://github.com/square/retrofit/pull/1400","diff_url":"https://github.com/square/retrofit/pull/1400.diff","patch_url":"https://github.com/square/retrofit/pull/1400.patch","issue_url":"https://api.github.com/repos/square/retrofit/issues/1400","number":1400,"state":"open","locked":false,"title":"A random assortment of documentation additions.","user":{"login":"JakeWharton","id":66577,"avatar_url":"https://avatars.githubusercontent.com/u/66577?v=3","gravatar_id":"","url":"https://api.github.com/users/JakeWharton","html_url":"https://github.com/JakeWharton","followers_url":"https://api.github.com/users/JakeWharton/followers","following_url":"https://api.github.com/users/JakeWharton/following{/other_user}","gists_url":"https://api.github.com/users/JakeWharton/gists{/gist_id}","starred_url":"https://api.github.com/users/JakeWharton/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/JakeWharton/subscriptions","organizations_url":"https://api.github.com/users/JakeWharton/orgs","repos_url":"https://api.github.com/users/JakeWharton/repos","events_url":"https://api.github.com/users/JakeWharton/events{/privacy}","received_events_url":"https://api.github.com/users/JakeWharton/received_events","type":"User","site_admin":false},"body":"I expect these to evolve even more... just had some time to start filling them out.","created_at":"2015-12-22T06:09:15Z","updated_at":"2015-12-22T06:09:40Z","closed_at":null,"merged_at":null,"merge_commit_sha":"3f3ecfb8058eeebf1efccf244c1250515f5423a4","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/square/retrofit/pulls/1400/commits","review_comments_url":"https://api.github.com/repos/square/retrofit/pulls/1400/comments","review_comment_url":"https://api.github.com/repos/square/retrofit/pulls/comments{/number}","comments_url":"https://api.github.com/repos/square/retrofit/issues/1400/comments","statuses_url":"https://api.github.com/repos/square/retrofit/statuses/094687dfdacdd0c98f4e8b3a00d7213945aed780","head":{"label":"square:jw/some-docs","ref":"jw/some-docs","sha":"094687dfdacdd0c98f4e8b3a00d7213945aed780","user":{"login":"square","id":82592,"avatar_url":"https://avatars.githubusercontent.com/u/82592?v=3","gravatar_id":"","url":"https://api.github.com/users/square","html_url":"https://github.com/square","followers_url":"https://api.github.com/users/square/followers","following_url":"https://api.github.com/users/square/following{/other_user}","gists_url":"https://api.github.com/users/square/gists{/gist_id}","starred_url":"https://api.github.com/users/square/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/square/subscriptions","organizations_url":"https://api.github.com/users/square/orgs","repos_url":"https://api.github.com/users/square/repos","events_url":"https://api.github.com/users/square/events{/privacy}","received_events_url":"https://api.github.com/users/square/received_events","type":"Organization","site_admin":false},"repo":{"id":892275,"name":"retrofit","full_name":"square/retrofit","owner":{"login":"square","id":82592,"avatar_url":"https://avatars.githubusercontent.com/u/82592?v=3","gravatar_id":"","url":"https://api.github.com/users/square","html_url":"https://github.com/square","followers_url":"https://api.github.com/users/square/followers","following_url":"https://api.github.com/users/square/following{/other_user}","gists_url":"https://api.github.com/users/square/gists{/gist_id}","starred_url":"https://api.github.com/users/square/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/square/subscriptions","organizations_url":"https://api.github.com/users/square/orgs","repos_url":"https://api.github.com/users/square/repos","events_url":"https://api.github.com/users/square/events{/privacy}","received_events_url":"https://api.github.com/users/square/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/square/retrofit","description":"Type-safe HTTP client for Android and Java by Square, Inc.","fork":false,"url":"https://api.github.com/repos/square/retrofit","forks_url":"https://api.github.com/repos/square/retrofit/forks","keys_url":"https://api.github.com/repos/square/retrofit/keys{/key_id}","collaborators_url":"https://api.github.com/repos/square/retrofit/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/square/retrofit/teams","hooks_url":"https://api.github.com/repos/square/retrofit/hooks","issue_events_url":"https://api.github.com/repos/square/retrofit/issues/events{/number}","events_url":"https://api.github.com/repos/square/retrofit/events","assignees_url":"https://api.github.com/repos/square/retrofit/assignees{/user}","branches_url":"https://api.github.com/repos/square/retrofit/branches{/branch}","tags_url":"https://api.github.com/repos/square/retrofit/tags","blobs_url":"https://api.github.com/repos/square/retrofit/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/square/retrofit/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/square/retrofit/git/refs{/sha}","trees_url":"https://api.github.com/repos/square/retrofit/git/trees{/sha}","statuses_url":"https://api.github.com/repos/square/retrofit/statuses/{sha}","languages_url":"https://api.github.com/repos/square/retrofit/languages","stargazers_url":"https://api.github.com/repos/square/retrofit/stargazers","contributors_url":"https://api.github.com/repos/square/retrofit/contributors","subscribers_url":"https://api.github.com/repos/square/retrofit/subscribers","subscription_url":"https://api.github.com/repos/square/retrofit/subscription","commits_url":"https://api.github.com/repos/square/retrofit/commits{/sha}","git_commits_url":"https://api.github.com/repos/square/retrofit/git/commits{/sha}","comments_url":"https://api.github.com/repos/square/retrofit/comments{/number}","issue_comment_url":"https://api.github.com/repos/square/retrofit/issues/comments{/number}","contents_url":"https://api.github.com/repos/square/retrofit/contents/{+path}","compare_url":"https://api.github.com/repos/square/retrofit/compare/{base}...{head}","merges_url":"https://api.github.com/repos/square/retrofit/merges","archive_url":"https://api.github.com/repos/square/retrofit/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/square/retrofit/downloads","issues_url":"https://api.github.com/repos/square/retrofit/issues{/number}","pulls_url":"https://api.github.com/repos/square/retrofit/pulls{/number}","milestones_url":"https://api.github.com/repos/square/retrofit/milestones{/number}","notifications_url":"https://api.github.com/repos/square/retrofit/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/square/retrofit/labels{/name}","releases_url":"https://api.github.com/repos/square/retrofit/releases{/id}","created_at":"2010-09-06T21:39:43Z","updated_at":"2015-12-22T03:32:40Z","pushed_at":"2015-12-22T06:09:15Z","git_url":"git://github.com/square/retrofit.git","ssh_url":"git@github.com:square/retrofit.git","clone_url":"https://github.com/square/retrofit.git","svn_url":"https://github.com/square/retrofit","homepage":"http://square.github.io/retrofit/","size":59024,"stargazers_count":8779,"watchers_count":8779,"language":"Java","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":1580,"mirror_url":null,"open_issues_count":27,"forks":1580,"open_issues":27,"watchers":8779,"default_branch":"master"}},"base":{"label":"square:master","ref":"master","sha":"2ee300cbf25802250e2faccc1c707c486fd3f6f6","user":{"login":"square","id":82592,"avatar_url":"https://avatars.githubusercontent.com/u/82592?v=3","gravatar_id":"","url":"https://api.github.com/users/square","html_url":"https://github.com/square","followers_url":"https://api.github.com/users/square/followers","following_url":"https://api.github.com/users/square/following{/other_user}","gists_url":"https://api.github.com/users/square/gists{/gist_id}","starred_url":"https://api.github.com/users/square/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/square/subscriptions","organizations_url":"https://api.github.com/users/square/orgs","repos_url":"https://api.github.com/users/square/repos","events_url":"https://api.github.com/users/square/events{/privacy}","received_events_url":"https://api.github.com/users/square/received_events","type":"Organization","site_admin":false},"repo":{"id":892275,"name":"retrofit","full_name":"square/retrofit","owner":{"login":"square","id":82592,"avatar_url":"https://avatars.githubusercontent.com/u/82592?v=3","gravatar_id":"","url":"https://api.github.com/users/square","html_url":"https://github.com/square","followers_url":"https://api.github.com/users/square/followers","following_url":"https://api.github.com/users/square/following{/other_user}","gists_url":"https://api.github.com/users/square/gists{/gist_id}","starred_url":"https://api.github.com/users/square/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/square/subscriptions","organizations_url":"https://api.github.com/users/square/orgs","repos_url":"https://api.github.com/users/square/repos","events_url":"https://api.github.com/users/square/events{/privacy}","received_events_url":"https://api.github.com/users/square/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/square/retrofit","description":"Type-safe HTTP client for Android and Java by Square, Inc.","fork":false,"url":"https://api.github.com/repos/square/retrofit","forks_url":"https://api.github.com/repos/square/retrofit/forks","keys_url":"https://api.github.com/repos/square/retrofit/keys{/key_id}","collaborators_url":"https://api.github.com/repos/square/retrofit/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/square/retrofit/teams","hooks_url":"https://api.github.com/repos/square/retrofit/hooks","issue_events_url":"https://api.github.com/repos/square/retrofit/issues/events{/number}","events_url":"https://api.github.com/repos/square/retrofit/events","assignees_url":"https://api.github.com/repos/square/retrofit/assignees{/user}","branches_url":"https://api.github.com/repos/square/retrofit/branches{/branch}","tags_url":"https://api.github.com/repos/square/retrofit/tags","blobs_url":"https://api.github.com/repos/square/retrofit/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/square/retrofit/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/square/retrofit/git/refs{/sha}","trees_url":"https://api.github.com/repos/square/retrofit/git/trees{/sha}","statuses_url":"https://api.github.com/repos/square/retrofit/statuses/{sha}","languages_url":"https://api.github.com/repos/square/retrofit/languages","stargazers_url":"https://api.github.com/repos/square/retrofit/stargazers","contributors_url":"https://api.github.com/repos/square/retrofit/contributors","subscribers_url":"https://api.github.com/repos/square/retrofit/subscribers","subscription_url":"https://api.github.com/repos/square/retrofit/subscription","commits_url":"https://api.github.com/repos/square/retrofit/commits{/sha}","git_commits_url":"https://api.github.com/repos/square/retrofit/git/commits{/sha}","comments_url":"https://api.github.com/repos/square/retrofit/comments{/number}","issue_comment_url":"https://api.github.com/repos/square/retrofit/issues/comments{/number}","contents_url":"https://api.github.com/repos/square/retrofit/contents/{+path}","compare_url":"https://api.github.com/repos/square/retrofit/compare/{base}...{head}","merges_url":"https://api.github.com/repos/square/retrofit/merges","archive_url":"https://api.github.com/repos/square/retrofit/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/square/retrofit/downloads","issues_url":"https://api.github.com/repos/square/retrofit/issues{/number}","pulls_url":"https://api.github.com/repos/square/retrofit/pulls{/number}","milestones_url":"https://api.github.com/repos/square/retrofit/milestones{/number}","notifications_url":"https://api.github.com/repos/square/retrofit/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/square/retrofit/labels{/name}","releases_url":"https://api.github.com/repos/square/retrofit/releases{/id}","created_at":"2010-09-06T21:39:43Z","updated_at":"2015-12-22T03:32:40Z","pushed_at":"2015-12-22T06:09:15Z","git_url":"git://github.com/square/retrofit.git","ssh_url":"git@github.com:square/retrofit.git","clone_url":"https://github.com/square/retrofit.git","svn_url":"https://github.com/square/retrofit","homepage":"http://square.github.io/retrofit/","size":59024,"stargazers_count":8779,"watchers_count":8779,"language":"Java","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":1580,"mirror_url":null,"open_issues_count":27,"forks":1580,"open_issues":27,"watchers":8779,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/square/retrofit/pulls/1400"},"html":{"href":"https://github.com/square/retrofit/pull/1400"},"issue":{"href":"https://api.github.com/repos/square/retrofit/issues/1400"},"comments":{"href":"https://api.github.com/repos/square/retrofit/issues/1400/comments"},"review_comments":{"href":"https://api.github.com/repos/square/retrofit/pulls/1400/comments"},"review_comment":{"href":"https://api.github.com/repos/square/retrofit/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/square/retrofit/pulls/1400/commits"},"statuses":{"href":"https://api.github.com/repos/square/retrofit/statuses/094687dfdacdd0c98f4e8b3a00d7213945aed780"}}}}