Brendon Muir
0606b06abd
Update upgrade_from_0_8_to_0_10.md ( #1933 )
...
Update upgrade_from_0_8_to_0_10.md
Changes the upgrade guide to highlight the change in the way relationships are walked.
2016-09-20 13:38:53 -04:00
Filippos Vasilakis
50f27546c3
Add docs for links ( #1909 )
...
Add docs for links
Add docs for links
Add docs for links
Add docs for links
Add docs for links
Add controller info
Grammar fixing
Improve docs
some small wording changes
Add pr to changelog
2016-09-07 15:10:45 -04:00
Alberto Miedes Garcés
050060478d
Fix typo ( #1916 )
2016-09-06 08:42:04 -04:00
Benjamin Fleischer
26bcdbe44a
Clean up docs
2016-08-17 16:16:13 -05:00
Benjamin Fleischer
a0dd5e58cc
Merge branch 'xn-patch-1'
2016-08-17 16:13:37 -05:00
Benjamin Fleischer
9217bc2ec4
Merge pull request #1844 from bkoltai/bk_upgrade_0_8_to_0_10_doc
...
Add documentation on upgrading from `0.8` to `0.10` safely
2016-08-08 20:54:34 -05:00
Leo Correa
6567989ad7
Specify how to get the instance of the serializer ( #1861 )
...
[DOC] `SerializableResource#serializer` vs. `SerializableResource#serializer_instance` [ci skip]
2016-07-27 13:59:12 -05:00
bkoltai
d9ba5cd768
Fix typos and make examples more explicit
2016-07-20 21:07:06 -07:00
bkoltai
5e72ec4be7
Fix small typo
2016-07-13 10:12:41 -07:00
bkoltai
e966d07b2c
PR comments
...
- Add list of breaking changes
- Add `true` param to `responds_to?` calls in overriden `try`
2016-07-13 10:11:19 -07:00
bkoltai
3ecc3ed0c1
Add documentation on upgrading from 0.8 to 0.10 safely
2016-07-13 09:48:07 -07:00
Francisco Quintero
e8f0dc787e
Add note about will_paginate previous_page method ( #1801 )
...
* Add note about will_paginate previous_page method
Pagination_dict method in JSON adapter section refers only to kaminari prev_page. Newer version of will_paginate uses previous_page method.
* move annotation for will_paginate's previous_page method to inline comment in example methods definition
2016-06-26 22:17:21 -05:00
Christian Trosclair
3d48a2fbf7
Create grape integration documentation.
2016-06-22 22:38:48 -05:00
Caleb Sayre
05618eac3d
added howto for serializing poro
...
trying to get styling correct
added changelog entry, link to guide, and fixed indentation
2016-04-09 17:20:46 -04:00
Yohan Robert
21cb896802
Move SerializableResource to ActiveModelSerializers namespace
...
Ref. https://github.com/rails-api/active_model_serializers/pull/1310
2016-03-30 11:33:04 +02:00
L. Preston Sego III
bbebeab348
Merge pull request #1280 from vasilakisfil/patch-1
...
Show how pagination can be done using meta tag from controller in JSON adapter
2016-03-10 12:53:41 -05:00
Taylor Jones
48f8a892e6
a little bit more trimming
2016-03-04 11:14:43 -05:00
Taylor Jones
32c6bccec7
edits and rearranging logic
2016-03-04 11:09:38 -05:00
Edwin Lunando
2678896a9c
update JSON adapter pagination links
2016-01-28 13:51:19 +07:00
Mauro George
5058694f4a
Create assert_response_schema test helper
...
It is a common pattern to use JSON Schema to validate a API response[1], [2]
and [3].
This patch creates the `assert_response_schema` test helper that helps people do
this kind of validation easily on the controller tests.
[1]: https://robots.thoughtbot.com/validating-json-schemas-with-an-rspec-matcher
[2]: https://github.com/sharethrough/json-schema-rspec
[3]: https://github.com/rails-api/active_model_serializers/issues/1011#issuecomment-127608121
2016-01-15 00:45:56 -06:00
Benjamin Fleischer
e60937bc2f
Remove duplicate documentation
2016-01-13 21:47:08 -06:00
Mauro George
c0b99c980c
Bring back assert_serializer for controller testing
...
The `assert_serializer` test helper was added in 0.9.0.apha1[1],
and was not included in 0.10.
This patch brings back the `assert_serializer` test helper. This is the last
revision[2] that has the helper. The original helper was used as base.
[1]: https://github.com/rails-api/active_model_serializers/pull/596
[2]: 610aeb2e92
- Create the AssertSerializer
- Use the Test namespace
- Make the tests pass on the Rails master
- Rails 5 does not include `assert_template` but we need this on the tests of
the helper.
- This add the `rails-controller-testing` to keep support on `assert_template`.
- Only load test helpers in the test environment
2016-01-13 20:54:22 -06:00
Benjamin Fleischer
ce17a1b305
[DOCS] Refactor, update, create documentation [ci skip]
2015-12-14 14:38:29 -06:00
L. Preston Sego III
168ec0ec2a
begin integration docs
2015-10-30 13:58:42 -04:00
L. Preston Sego III
11d8fee4d0
added docs for setting up ember for nested resources with the json api adapter
...
fix typo
fix intra-document links
fix spelling error in nested resources toc link
add example for post collection
Update ember-and-json-api.md
fix typo
2015-10-30 13:25:08 -04:00
Benjamin Fleischer
2c8b9b796d
Rename ArraySerializer to CollectionSerializer for clarity
2015-10-21 16:53:26 -05:00
Filippos Vasilakis
91d6215ac4
Update add_pagination_links.md
2015-10-20 14:26:03 +02:00
Benjamin Fleischer
c6f8d0f5f2
Rename FlattenJson to Attributes (allow plural adapter names)
2015-09-18 10:17:02 -05:00
Benjamin Fleischer
0091be89f8
Consistently refer to the 'JSON API' and the 'JsonApi' adapter
2015-09-17 15:22:28 -05:00
Terminator3
173f21d942
outside controller use tutorial
2015-09-15 15:55:35 -05:00
Bruno Bacarini
b73ffe25c8
add kaminari and will_paginate examples
2015-08-20 11:31:21 -03:00
Bruno Bacarini
f85027e631
add more documentation to pagination links
2015-08-19 11:09:47 -03:00
Bruno Bacarini
2c2f948fa0
Add pagination links automatically
...
Pagination links will be included in your response automatically as long
as the resource is paginated using Kaminari or WillPaginate
and if you are using a JSON-API adapter. The others adapters does not have this feature.
2015-08-18 19:04:04 -03:00
Bruno Bacarini
a41d90cce4
add self to pagination links
2015-08-18 19:04:04 -03:00
Bruno Bacarini
7be25fef14
include query_parameters on pagination links as well
2015-08-18 19:04:03 -03:00
Bruno Bacarini
e62a7d6f34
return complete URIs on pagination links
2015-08-18 19:04:03 -03:00
Bruno Bacarini
acb6545c50
add documentation to pagination feature
2015-08-18 19:04:03 -03:00
T.J. Schuck
b6b3aa5f21
Fix some invalid JSON
2015-08-12 11:53:46 -04:00
João M. D. Moura
63436c73e8
minor updates and TYPOs
2015-07-16 23:29:03 -04:00
João Moura
420f7959c0
creating initial general and how to docs
2015-07-16 10:18:04 -04:00