ditkrg/active_model_serializers
4
0
Fork 0
mirror of https://github.com/ditkrg/active_model_serializers.git synced 2026-01-23 06:16:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2039 from biow0lf/documentation-fixes

Browse Source 
Documentation fixes
This commit is contained in:
Benjamin Fleischer 2017-01-31 09:06:42 -06:00 committed by GitHub
commit ab824e2b58
2 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -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) - [#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) - [#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) ### [v0.10.4 (2017-01-06)](https://github.com/rails-api/active_model_serializers/compare/v0.10.3...v0.10.4)

26
docs/howto/add_pagination_links.md
View File

@ -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. Add this method to your base API controller.
```ruby ```ruby
def pagination_dict(object) def pagination_dict(collection)
{ {
current_page: object.current_page, current_page: collection.current_page,
next_page: object.next_page, next_page: collection.next_page,
prev_page: object.prev_page, # use object.previous_page when using will_paginate prev_page: collection.prev_page, # use collection.previous_page when using will_paginate
total_pages: object.total_pages, total_pages: collection.total_pages,
total_count: object.total_count total_count: collection.total_count
} }
end end
``` ```
@ -117,18 +117,18 @@ 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. 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 ```ruby
render json: @posts, each_serializer: PostPreviewSerializer, meta: meta_attributes(@post) render json: @posts, each_serializer: PostPreviewSerializer, meta: meta_attributes(@posts)
``` ```
```ruby ```ruby
#expects pagination! #expects pagination!
def meta_attributes(resource, extra_meta = {}) def meta_attributes(collection, extra_meta = {})
{ {
current_page: resource.current_page, current_page: collection.current_page,
next_page: resource.next_page, next_page: collection.next_page,
prev_page: resource.prev_page, # use resource.previous_page when using will_paginate prev_page: collection.prev_page, # use collection.previous_page when using will_paginate
total_pages: resource.total_pages, total_pages: collection.total_pages,
total_count: resource.total_count total_count: collection.total_count
}.merge(extra_meta) }.merge(extra_meta)
end end
``` ```