From d6b1b1c81f4cbad4d17b63ac0ced83e0d4c185cd Mon Sep 17 00:00:00 2001 From: Igor Zubkov Date: Tue, 24 Jan 2017 13:27:20 +0200 Subject: [PATCH 1/3] Fix typo --- docs/howto/add_pagination_links.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/howto/add_pagination_links.md b/docs/howto/add_pagination_links.md index 7c486fbd..eec974cf 100644 --- a/docs/howto/add_pagination_links.md +++ b/docs/howto/add_pagination_links.md @@ -117,7 +117,7 @@ ex. You can also achieve the same result if you have a helper method that adds the pagination info in the meta tag. For instance, in your action specify a custom serializer. ```ruby -render json: @posts, each_serializer: PostPreviewSerializer, meta: meta_attributes(@post) +render json: @posts, each_serializer: PostPreviewSerializer, meta: meta_attributes(@posts) ``` ```ruby From 3c6eb57ee945bcde7857f575ea3895e19302269f Mon Sep 17 00:00:00 2001 From: Igor Zubkov Date: Tue, 24 Jan 2017 13:28:50 +0200 Subject: [PATCH 2/3] Replace object with collection. Replace resource with collection. --- docs/howto/add_pagination_links.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/howto/add_pagination_links.md b/docs/howto/add_pagination_links.md index eec974cf..69d290c2 100644 --- a/docs/howto/add_pagination_links.md +++ b/docs/howto/add_pagination_links.md @@ -77,13 +77,13 @@ If you are using `JSON` adapter, pagination links will not be included automatic Add this method to your base API controller. ```ruby -def pagination_dict(object) +def pagination_dict(collection) { - current_page: object.current_page, - next_page: object.next_page, - prev_page: object.prev_page, # use object.previous_page when using will_paginate - total_pages: object.total_pages, - total_count: object.total_count + current_page: collection.current_page, + next_page: collection.next_page, + prev_page: collection.prev_page, # use collection.previous_page when using will_paginate + total_pages: collection.total_pages, + total_count: collection.total_count } end ``` @@ -122,13 +122,13 @@ render json: @posts, each_serializer: PostPreviewSerializer, meta: meta_attribut ```ruby #expects pagination! -def meta_attributes(resource, extra_meta = {}) +def meta_attributes(collection, extra_meta = {}) { - current_page: resource.current_page, - next_page: resource.next_page, - prev_page: resource.prev_page, # use resource.previous_page when using will_paginate - total_pages: resource.total_pages, - total_count: resource.total_count + current_page: collection.current_page, + next_page: collection.next_page, + prev_page: collection.prev_page, # use collection.previous_page when using will_paginate + total_pages: collection.total_pages, + total_count: collection.total_count }.merge(extra_meta) end ``` From 775ad66ffd1bbe0806ed7a7eb5831858da273cb0 Mon Sep 17 00:00:00 2001 From: Igor Zubkov Date: Tue, 24 Jan 2017 15:12:25 +0200 Subject: [PATCH 3/3] Update CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index b025a61b..ad6232e2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -16,6 +16,7 @@ Misc: - [#2021](https://github.com/rails-api/active_model_serializers/pull/2021) Make test attributes explicit. Tests have Model#associations. (@bf4) - [#1981](https://github.com/rails-api/active_model_serializers/pull/1981) Fix relationship link documentation. (@groyoh) +- [#2039](https://github.com/rails-api/active_model_serializers/pull/2039) Documentation fixes. (@biow0lf) ### [v0.10.4 (2017-01-06)](https://github.com/rails-api/active_model_serializers/compare/v0.10.3...v0.10.4)