{"action":"created","comment":{"url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/pulls/comments/82103044","pull_request_review_id":3033603,"id":82103044,"diff_hunk":"@@ -94,6 +94,26 @@ endpoint = client.resource( :DoesNotExist )\n result = endpoint.list()\n ```\n \n+#### Enumerating over Resources\n+\n+The list method provides access to a single page within a collection of resources, and its often useful to retrieve the entire collection.  To save callers from having to manually paginate through the resources,  [`Hoodoo::Client::AugmentedArray`]({{site.custom.rdoc_root_url}}/classes/Hoodoo/Client/AugmentedArray.html) provides the [`Hoodoo::Client::PaginatedEnumeration#enumerate_all`]({{ site.custom.rdoc_root_url }}/classes/Hoodoo/Client/PaginatedEnumeration.html#method-i-enumerate-all) method that will yield each of Resources instances to the supplied block individually, and perform the pagination automatically.  It is important for the caller to check for errors on each iteration.","path":"guides_0800_hoodoo_client.md","position":6,"original_position":6,"commit_id":"02528513d9b5e622a403aedf030275a6085bce75","original_commit_id":"02528513d9b5e622a403aedf030275a6085bce75","user":{"login":"pond","id":188364,"avatar_url":"https://avatars.githubusercontent.com/u/188364?v=3","gravatar_id":"","url":"https://api.github.com/users/pond","html_url":"https://github.com/pond","followers_url":"https://api.github.com/users/pond/followers","following_url":"https://api.github.com/users/pond/following{/other_user}","gists_url":"https://api.github.com/users/pond/gists{/gist_id}","starred_url":"https://api.github.com/users/pond/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pond/subscriptions","organizations_url":"https://api.github.com/users/pond/orgs","repos_url":"https://api.github.com/users/pond/repos","events_url":"https://api.github.com/users/pond/events{/privacy}","received_events_url":"https://api.github.com/users/pond/received_events","type":"User","site_admin":false},"body":"Preformat on \"list\" to make it clear it's a method, i.e. style it as \"`list`\". No need to double-space after full stop; Markdown is source code, not literal rendering. Mention that using this method is somewhat less efficient for the client side than manual pagination due to the promotion of error data from the behind-scenes batch list into individual objects for the seamless iteration.","created_at":"2016-10-06T01:20:48Z","updated_at":"2016-10-06T01:21:47Z","html_url":"https://github.com/LoyaltyNZ/hoodoo/pull/180#discussion_r82103044","pull_request_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/pulls/180","_links":{"self":{"href":"https://api.github.com/repos/LoyaltyNZ/hoodoo/pulls/comments/82103044"},"html":{"href":"https://github.com/LoyaltyNZ/hoodoo/pull/180#discussion_r82103044"},"pull_request":{"href":"https://api.github.com/repos/LoyaltyNZ/hoodoo/pulls/180"}}},"pull_request":{"url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/pulls/180","id":88184809,"html_url":"https://github.com/LoyaltyNZ/hoodoo/pull/180","diff_url":"https://github.com/LoyaltyNZ/hoodoo/pull/180.diff","patch_url":"https://github.com/LoyaltyNZ/hoodoo/pull/180.patch","issue_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/issues/180","number":180,"state":"open","locked":false,"title":"Updated guide for `enumerate_all`","user":{"login":"davidoram","id":636717,"avatar_url":"https://avatars.githubusercontent.com/u/636717?v=3","gravatar_id":"","url":"https://api.github.com/users/davidoram","html_url":"https://github.com/davidoram","followers_url":"https://api.github.com/users/davidoram/followers","following_url":"https://api.github.com/users/davidoram/following{/other_user}","gists_url":"https://api.github.com/users/davidoram/gists{/gist_id}","starred_url":"https://api.github.com/users/davidoram/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/davidoram/subscriptions","organizations_url":"https://api.github.com/users/davidoram/orgs","repos_url":"https://api.github.com/users/davidoram/repos","events_url":"https://api.github.com/users/davidoram/events{/privacy}","received_events_url":"https://api.github.com/users/davidoram/received_events","type":"User","site_admin":false},"body":"","created_at":"2016-10-06T01:16:19Z","updated_at":"2016-10-06T01:21:47Z","closed_at":null,"merged_at":null,"merge_commit_sha":"cdb694c0f3882572efb22d3b377ac6dc80f276e6","assignee":{"login":"pond","id":188364,"avatar_url":"https://avatars.githubusercontent.com/u/188364?v=3","gravatar_id":"","url":"https://api.github.com/users/pond","html_url":"https://github.com/pond","followers_url":"https://api.github.com/users/pond/followers","following_url":"https://api.github.com/users/pond/following{/other_user}","gists_url":"https://api.github.com/users/pond/gists{/gist_id}","starred_url":"https://api.github.com/users/pond/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pond/subscriptions","organizations_url":"https://api.github.com/users/pond/orgs","repos_url":"https://api.github.com/users/pond/repos","events_url":"https://api.github.com/users/pond/events{/privacy}","received_events_url":"https://api.github.com/users/pond/received_events","type":"User","site_admin":false},"assignees":[{"login":"pond","id":188364,"avatar_url":"https://avatars.githubusercontent.com/u/188364?v=3","gravatar_id":"","url":"https://api.github.com/users/pond","html_url":"https://github.com/pond","followers_url":"https://api.github.com/users/pond/followers","following_url":"https://api.github.com/users/pond/following{/other_user}","gists_url":"https://api.github.com/users/pond/gists{/gist_id}","starred_url":"https://api.github.com/users/pond/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pond/subscriptions","organizations_url":"https://api.github.com/users/pond/orgs","repos_url":"https://api.github.com/users/pond/repos","events_url":"https://api.github.com/users/pond/events{/privacy}","received_events_url":"https://api.github.com/users/pond/received_events","type":"User","site_admin":false}],"milestone":null,"commits_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/pulls/180/commits","review_comments_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/pulls/180/comments","review_comment_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/pulls/comments{/number}","comments_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/issues/180/comments","statuses_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/statuses/02528513d9b5e622a403aedf030275a6085bce75","head":{"label":"LoyaltyNZ:feature/update-guide-batched-results","ref":"feature/update-guide-batched-results","sha":"02528513d9b5e622a403aedf030275a6085bce75","user":{"login":"LoyaltyNZ","id":1383432,"avatar_url":"https://avatars.githubusercontent.com/u/1383432?v=3","gravatar_id":"","url":"https://api.github.com/users/LoyaltyNZ","html_url":"https://github.com/LoyaltyNZ","followers_url":"https://api.github.com/users/LoyaltyNZ/followers","following_url":"https://api.github.com/users/LoyaltyNZ/following{/other_user}","gists_url":"https://api.github.com/users/LoyaltyNZ/gists{/gist_id}","starred_url":"https://api.github.com/users/LoyaltyNZ/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/LoyaltyNZ/subscriptions","organizations_url":"https://api.github.com/users/LoyaltyNZ/orgs","repos_url":"https://api.github.com/users/LoyaltyNZ/repos","events_url":"https://api.github.com/users/LoyaltyNZ/events{/privacy}","received_events_url":"https://api.github.com/users/LoyaltyNZ/received_events","type":"Organization","site_admin":false},"repo":{"id":29889383,"name":"hoodoo","full_name":"LoyaltyNZ/hoodoo","owner":{"login":"LoyaltyNZ","id":1383432,"avatar_url":"https://avatars.githubusercontent.com/u/1383432?v=3","gravatar_id":"","url":"https://api.github.com/users/LoyaltyNZ","html_url":"https://github.com/LoyaltyNZ","followers_url":"https://api.github.com/users/LoyaltyNZ/followers","following_url":"https://api.github.com/users/LoyaltyNZ/following{/other_user}","gists_url":"https://api.github.com/users/LoyaltyNZ/gists{/gist_id}","starred_url":"https://api.github.com/users/LoyaltyNZ/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/LoyaltyNZ/subscriptions","organizations_url":"https://api.github.com/users/LoyaltyNZ/orgs","repos_url":"https://api.github.com/users/LoyaltyNZ/repos","events_url":"https://api.github.com/users/LoyaltyNZ/events{/privacy}","received_events_url":"https://api.github.com/users/LoyaltyNZ/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/LoyaltyNZ/hoodoo","description":"Simplify the implementation of consistent services within an API-based software platform","fork":false,"url":"https://api.github.com/repos/LoyaltyNZ/hoodoo","forks_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/forks","keys_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/keys{/key_id}","collaborators_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/teams","hooks_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/hooks","issue_events_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/issues/events{/number}","events_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/events","assignees_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/assignees{/user}","branches_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/branches{/branch}","tags_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/tags","blobs_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/git/refs{/sha}","trees_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/git/trees{/sha}","statuses_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/statuses/{sha}","languages_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/languages","stargazers_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/stargazers","contributors_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/contributors","subscribers_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/subscribers","subscription_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/subscription","commits_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/commits{/sha}","git_commits_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/git/commits{/sha}","comments_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/comments{/number}","issue_comment_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/issues/comments{/number}","contents_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/contents/{+path}","compare_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/compare/{base}...{head}","merges_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/merges","archive_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/downloads","issues_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/issues{/number}","pulls_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/pulls{/number}","milestones_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/milestones{/number}","notifications_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/labels{/name}","releases_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/releases{/id}","deployments_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/deployments","created_at":"2015-01-27T00:27:37Z","updated_at":"2016-05-06T07:35:54Z","pushed_at":"2016-10-06T01:16:20Z","git_url":"git://github.com/LoyaltyNZ/hoodoo.git","ssh_url":"git@github.com:LoyaltyNZ/hoodoo.git","clone_url":"https://github.com/LoyaltyNZ/hoodoo.git","svn_url":"https://github.com/LoyaltyNZ/hoodoo","homepage":"https://loyaltynz.github.io/hoodoo/","size":7290,"stargazers_count":11,"watchers_count":11,"language":"Ruby","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":5,"mirror_url":null,"open_issues_count":13,"forks":5,"open_issues":13,"watchers":11,"default_branch":"master"}},"base":{"label":"LoyaltyNZ:gh-pages","ref":"gh-pages","sha":"4305bab7901e78ea8f4a35ac05eb0bc218b27972","user":{"login":"LoyaltyNZ","id":1383432,"avatar_url":"https://avatars.githubusercontent.com/u/1383432?v=3","gravatar_id":"","url":"https://api.github.com/users/LoyaltyNZ","html_url":"https://github.com/LoyaltyNZ","followers_url":"https://api.github.com/users/LoyaltyNZ/followers","following_url":"https://api.github.com/users/LoyaltyNZ/following{/other_user}","gists_url":"https://api.github.com/users/LoyaltyNZ/gists{/gist_id}","starred_url":"https://api.github.com/users/LoyaltyNZ/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/LoyaltyNZ/subscriptions","organizations_url":"https://api.github.com/users/LoyaltyNZ/orgs","repos_url":"https://api.github.com/users/LoyaltyNZ/repos","events_url":"https://api.github.com/users/LoyaltyNZ/events{/privacy}","received_events_url":"https://api.github.com/users/LoyaltyNZ/received_events","type":"Organization","site_admin":false},"repo":{"id":29889383,"name":"hoodoo","full_name":"LoyaltyNZ/hoodoo","owner":{"login":"LoyaltyNZ","id":1383432,"avatar_url":"https://avatars.githubusercontent.com/u/1383432?v=3","gravatar_id":"","url":"https://api.github.com/users/LoyaltyNZ","html_url":"https://github.com/LoyaltyNZ","followers_url":"https://api.github.com/users/LoyaltyNZ/followers","following_url":"https://api.github.com/users/LoyaltyNZ/following{/other_user}","gists_url":"https://api.github.com/users/LoyaltyNZ/gists{/gist_id}","starred_url":"https://api.github.com/users/LoyaltyNZ/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/LoyaltyNZ/subscriptions","organizations_url":"https://api.github.com/users/LoyaltyNZ/orgs","repos_url":"https://api.github.com/users/LoyaltyNZ/repos","events_url":"https://api.github.com/users/LoyaltyNZ/events{/privacy}","received_events_url":"https://api.github.com/users/LoyaltyNZ/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/LoyaltyNZ/hoodoo","description":"Simplify the implementation of consistent services within an API-based software platform","fork":false,"url":"https://api.github.com/repos/LoyaltyNZ/hoodoo","forks_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/forks","keys_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/keys{/key_id}","collaborators_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/teams","hooks_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/hooks","issue_events_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/issues/events{/number}","events_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/events","assignees_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/assignees{/user}","branches_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/branches{/branch}","tags_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/tags","blobs_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/git/refs{/sha}","trees_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/git/trees{/sha}","statuses_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/statuses/{sha}","languages_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/languages","stargazers_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/stargazers","contributors_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/contributors","subscribers_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/subscribers","subscription_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/subscription","commits_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/commits{/sha}","git_commits_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/git/commits{/sha}","comments_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/comments{/number}","issue_comment_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/issues/comments{/number}","contents_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/contents/{+path}","compare_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/compare/{base}...{head}","merges_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/merges","archive_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/downloads","issues_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/issues{/number}","pulls_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/pulls{/number}","milestones_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/milestones{/number}","notifications_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/labels{/name}","releases_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/releases{/id}","deployments_url":"https://api.github.com/repos/LoyaltyNZ/hoodoo/deployments","created_at":"2015-01-27T00:27:37Z","updated_at":"2016-05-06T07:35:54Z","pushed_at":"2016-10-06T01:16:20Z","git_url":"git://github.com/LoyaltyNZ/hoodoo.git","ssh_url":"git@github.com:LoyaltyNZ/hoodoo.git","clone_url":"https://github.com/LoyaltyNZ/hoodoo.git","svn_url":"https://github.com/LoyaltyNZ/hoodoo","homepage":"https://loyaltynz.github.io/hoodoo/","size":7290,"stargazers_count":11,"watchers_count":11,"language":"Ruby","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":5,"mirror_url":null,"open_issues_count":13,"forks":5,"open_issues":13,"watchers":11,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/LoyaltyNZ/hoodoo/pulls/180"},"html":{"href":"https://github.com/LoyaltyNZ/hoodoo/pull/180"},"issue":{"href":"https://api.github.com/repos/LoyaltyNZ/hoodoo/issues/180"},"comments":{"href":"https://api.github.com/repos/LoyaltyNZ/hoodoo/issues/180/comments"},"review_comments":{"href":"https://api.github.com/repos/LoyaltyNZ/hoodoo/pulls/180/comments"},"review_comment":{"href":"https://api.github.com/repos/LoyaltyNZ/hoodoo/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/LoyaltyNZ/hoodoo/pulls/180/commits"},"statuses":{"href":"https://api.github.com/repos/LoyaltyNZ/hoodoo/statuses/02528513d9b5e622a403aedf030275a6085bce75"}}}}
{"actor":{"display_login":"pond"}}