76 Commits

Author SHA1 Message Date
iwsksky
b9a86a002a pass array of unique movies to serializer 2019-10-04 12:50:22 -04:00
Maxime Orefice
021db27605 Update Readme
Fix typo
2019-10-04 12:50:22 -04:00
Charalampos Aristomenopoulos
209c925723 Fix typo in README 2019-10-04 12:50:22 -04:00
Csaba Apagyi
f0142d948c Fix formatting of set_id example in README 2019-10-04 12:50:22 -04:00
Jessie A. Young
9e83c1e0a5 Highlight that this is for JSON:API spec only
* The link was already there but I skipped over it on my first read.
This update makes the fact more prominent.
* I was testing to see if we wanted to move from AM Serializers to
fast_jsonapi but our API is not written according to the JSON:API spec
so, after converting one serializer over, I learned that this would not work for me.
* This update might save someone in my position the ~30 mins or so it
takes to bundle and write a serializer in the future. :)
2019-10-04 12:50:22 -04:00
Srinivas R
3df917f407
Update README.md 2019-06-11 14:59:22 -07:00
Manoj M J
e0228dacdc Add documentation on how to use helper methods in serializers 2019-03-28 21:12:36 -07:00
Manoj M J
a160d6746f Fix Documentation of Meta Per Resource
Some part of the documentation for this got removed during last merge, so fixing it.
2019-03-28 21:11:48 -07:00
Shishir Kakaraddi
cc7f88843a
Merge pull request #331 from larissa/set-id-block
Allow block for id customization
2018-11-03 11:37:56 -07:00
Shishir Kakaraddi
326f9784ca
Merge pull request #294 from nikz/add-links-option-to-relationship-serializer
Adds a :links option to the relationship macros
2018-11-03 11:35:39 -07:00
Shishir Kakaraddi
a105bac3d9
Merge pull request #336 from coderbydesign/patch-1
Minor fix in README.md
2018-11-03 11:30:35 -07:00
Larissa Reis
0ba5f231fe Add set_id block syntax example to README 2018-10-18 22:04:52 -06:00
Keith Walsh
dbda6b6153
Update README.md
Resolve minor typo
2018-10-17 09:29:49 -04:00
nikz
1ad20d6b7b Merge branch 'upstream-dev' into add-links-option-to-relationship-serializer 2018-10-07 21:29:43 +01:00
nikz
85b41c45d4 Adds :lazy_load_data option
If you include a default empty `data` option in your JSON API response,
many frontend frameworks will ignore your `related` link that could be
used to load relationship records, and will instead treat the
relationship as empty.

This adds a `lazy_load_data` option which will:

  * stop the serializer attempting to load the data and;
  * exclude the `data` key from the final response

This allows you to lazy load a JSON API relationship.
2018-10-07 21:23:36 +01:00
zino
467024f8fd Improve readme with id_method_name 2018-10-02 11:36:21 -04:00
Orhan Toy
8357acd6a7 [ci skip] Fix punctuation 2018-09-03 12:01:45 -07:00
Shishir Kakaraddi
2eaaa71bd8
Merge pull request #299 from g13ydson/feature/add_option_key
add the option "key" in customizable options in the README
2018-08-13 18:05:05 -07:00
Gleydson Tavares
ce2c8003ee add the "option key" in customizable options 2018-08-10 13:15:02 -03:00
Nik Wakelin
100f850416
Merge branch 'dev' into add-links-option-to-relationship-serializer 2018-08-05 20:58:39 +01:00
nikz
8eef7a0bb1 Adds README documentation for relationship links 2018-08-05 20:51:56 +01:00
Shishir Kakaraddi
a5414c6b8f
Merge pull request #280 from manojmj92/add_meta
Introduce the ability to add `meta` tag for every resource in the collection
2018-07-23 13:30:39 -07:00
Trevor Hinesley
5a5a5e5125 Fixed conditional attributes documentation 2018-07-23 13:23:41 -07:00
Manoj M J
dd71bc15d6 Introduce the ability to add meta tag for every resource in the collection 2018-07-20 10:33:27 +05:30
Erol
9aec7c58ed Add README instructions for using sparse fieldsets 2018-07-16 21:10:10 -07:00
Erol
41c1e0a106 Add proc shortcut use case to README 2018-07-16 21:10:10 -07:00
Erol
3df48cd4cb Add README instructions for using sparse fieldsets 2018-07-16 21:07:57 -07:00
Erol
abc830b41e Add proc shortcut use case to README 2018-07-16 09:05:04 -07:00
Oleksiy Babich
ecb92f07f5 add is_collection parameter to force corresponding serialization (#239)
* add is_collection parameter to force corresponding serialization

* add documentation for is_collection purpose, behavior
and notes re. default autodetect logic
2018-07-03 19:35:06 -07:00
Kyle Reeves
25c099e923 add documentation for conditional relationships 2018-07-03 19:33:34 -07:00
Trevor Hinesley
f1df3f4a2d Added documentation about conditional attributes 2018-06-21 18:38:42 -07:00
Ray Walters
f54e6242ff Remove extra 'class MovieSerializer' from an example in the README 2018-05-31 17:16:38 -07:00
Shishir Kakaraddi
ea5296ac25 making object level links similar to attributes 2018-05-20 15:08:47 -07:00
Ankit gupta
ac136b988c
Merge pull request #213 from ohbarye/patch-1
Remove dead link
2018-05-14 21:42:53 -07:00
Masato Ohba
7263aba777
Remove dead link
Because the position is closed.

Refs: https://github.com/Netflix/fast_jsonapi/issues/209
2018-05-15 12:39:23 +09:00
Jodi Showers
3ebf34928c Serialize nested includes (#152) 2018-05-10 21:17:32 -07:00
Shishir Kakaraddi
966b3509a4 update readme 2018-05-08 22:11:22 -07:00
Carlos Solares
fe5ecb5b28 Use the serializer_key directly if it is not a symbol in relationships (#198) 2018-05-01 10:15:43 -07:00
Brandon Buck
a585497161 Add in options[:scope] and receiving scope in attribute blocks (#153) 2018-05-01 09:58:01 -07:00
Alessio Fanelli
01ac9ccbe7
Use proper casing on generator example
`rails g Serializer` isn't a valid command, serializer shouldn't be capitalized.
2018-04-20 14:37:56 +02:00
Shuhei Kitagawa
4fdf5a221c Enable to set race_condition_ttl for cache_options 2018-04-08 22:53:31 -07:00
Rob Wise
fea384b4c6 update README to mention cache_key is required
see https://github.com/Netflix/fast_jsonapi/issues/99#issuecomment-374060813
2018-03-20 10:35:51 -07:00
sojan v jose
b387f94a13 Fix typo in the readme sample command (#131)
fix typo in the readme sample command
2018-03-19 12:53:24 -07:00
Roberto Quintanilla
88553cf9ab Updated README with details about polymorphic associations 2018-03-18 22:32:01 -07:00
mnauage
1e6d127aec links doc 2018-03-18 22:31:02 -07:00
Shuhei Kitagawa
fa09c29190 Add document for for set_id method 2018-03-18 08:29:13 -07:00
Les Fletcher
41bffb1e20 Some docs for the instrumentation 2018-03-12 22:46:41 -07:00
Sam Morgan
dfd215d3a1 91 allow includes strings (#93)
* add hash benchmarking to performance tests

* Add missing attribute in README example

* Disable GC before doing performance test

* Enable oj to AM for fair benchmark test

* add information on performance methodology

* add oss metadata

* Make an error that demonstrates [Issue

* Simple RSpec test that fails with a non-empty string but passes with a
non-empty symbol
* To run the test, rspec spec/lib/object_serializer_spec.rb

* Map includes to symbols if they are provided as strings

* Includes would fail with an ArgumentError unless they were explicitly
provided as symbols (see #97)
* This is solved by mapping the strings to symbols in the
ObjectSerializer initializer
* No real impact on performance here
2018-02-28 08:29:24 -08:00
Les Fletcher
08cee7b82d refactor performance specs 2018-02-16 17:30:51 -08:00
Guillermo Iguaran
33f08d925a Update README to include docs about the Rails generator 2018-02-11 13:12:37 -08:00