jsonapi_compliable 0.11.4 → 0.11.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/docs/Jsonapi.html +1 -1
- data/docs/Jsonapi/ResourceGenerator.html +32 -22
- data/docs/JsonapiCompliable.html +174 -19
- data/docs/JsonapiCompliable/Adapters.html +1 -1
- data/docs/JsonapiCompliable/Adapters/Abstract.html +1 -1
- data/docs/JsonapiCompliable/Adapters/ActiveRecord.html +41 -31
- data/docs/JsonapiCompliable/Adapters/ActiveRecordSideloading.html +47 -39
- data/docs/JsonapiCompliable/Adapters/Null.html +1 -1
- data/docs/JsonapiCompliable/Base.html +70 -14
- data/docs/JsonapiCompliable/Configuration.html +308 -0
- data/docs/JsonapiCompliable/Deserializer.html +1 -1
- data/docs/JsonapiCompliable/Errors.html +2 -2
- data/docs/JsonapiCompliable/Errors/BadFilter.html +1 -1
- data/docs/JsonapiCompliable/Errors/InvalidInclude.html +266 -0
- data/docs/JsonapiCompliable/Errors/RecordNotFound.html +124 -0
- data/docs/JsonapiCompliable/Errors/StatNotFound.html +10 -10
- data/docs/JsonapiCompliable/Errors/UnsupportedPageSize.html +1 -1
- data/docs/JsonapiCompliable/Errors/ValidationError.html +1 -1
- data/docs/JsonapiCompliable/Extensions.html +1 -1
- data/docs/JsonapiCompliable/Extensions/BooleanAttribute.html +1 -1
- data/docs/JsonapiCompliable/Extensions/BooleanAttribute/ClassMethods.html +1 -1
- data/docs/JsonapiCompliable/Extensions/ExtraAttribute.html +1 -1
- data/docs/JsonapiCompliable/Extensions/ExtraAttribute/ClassMethods.html +1 -1
- data/docs/JsonapiCompliable/Query.html +1 -1
- data/docs/JsonapiCompliable/Rails.html +1 -1
- data/docs/JsonapiCompliable/Resource.html +3 -3
- data/docs/JsonapiCompliable/Scope.html +171 -17
- data/docs/JsonapiCompliable/Scoping.html +1 -1
- data/docs/JsonapiCompliable/Scoping/Base.html +1 -1
- data/docs/JsonapiCompliable/Scoping/DefaultFilter.html +2 -2
- data/docs/JsonapiCompliable/Scoping/ExtraFields.html +2 -2
- data/docs/JsonapiCompliable/Scoping/Filter.html +1 -1
- data/docs/JsonapiCompliable/Scoping/Filterable.html +1 -1
- data/docs/JsonapiCompliable/Scoping/Paginate.html +2 -2
- data/docs/JsonapiCompliable/Scoping/Sort.html +5 -3
- data/docs/JsonapiCompliable/SerializableTempId.html +1 -1
- data/docs/JsonapiCompliable/Sideload.html +1 -1
- data/docs/JsonapiCompliable/Stats.html +1 -1
- data/docs/JsonapiCompliable/Stats/DSL.html +1 -1
- data/docs/JsonapiCompliable/Stats/Payload.html +1 -1
- data/docs/JsonapiCompliable/Util.html +1 -1
- data/docs/JsonapiCompliable/Util/FieldParams.html +1 -1
- data/docs/JsonapiCompliable/Util/Hash.html +1 -1
- data/docs/JsonapiCompliable/Util/IncludeParams.html +1 -1
- data/docs/JsonapiCompliable/Util/Persistence.html +1 -1
- data/docs/JsonapiCompliable/Util/RelationshipPayload.html +1 -1
- data/docs/JsonapiCompliable/Util/RenderOptions.html +16 -2
- data/docs/JsonapiCompliable/Util/Sideload.html +1 -1
- data/docs/JsonapiCompliable/Util/ValidationResponse.html +1 -1
- data/docs/_index.html +28 -7
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +41 -1
- data/docs/index.html +41 -1
- data/docs/method_list.html +281 -209
- data/docs/top-level-namespace.html +1 -1
- data/lib/jsonapi_compliable/scope.rb +2 -0
- data/lib/jsonapi_compliable/version.rb +1 -1
- metadata +5 -2
|
@@ -189,7 +189,7 @@
|
|
|
189
189
|
<li class="public ">
|
|
190
190
|
<span class="summary_signature">
|
|
191
191
|
|
|
192
|
-
<a href="#polymorphic_belongs_to-instance_method" title="#polymorphic_belongs_to (instance method)">#<strong>polymorphic_belongs_to</strong>(
|
|
192
|
+
<a href="#polymorphic_belongs_to-instance_method" title="#polymorphic_belongs_to (instance method)">#<strong>polymorphic_belongs_to</strong>(ssociation_name,, roup_by:,, roups:,, &lk)) ⇒ Object </a>
|
|
193
193
|
|
|
194
194
|
|
|
195
195
|
|
|
@@ -319,7 +319,11 @@
|
|
|
319
319
|
91
|
|
320
320
|
92
|
|
321
321
|
93
|
|
322
|
-
94
|
|
322
|
+
94
|
|
323
|
+
95
|
|
324
|
+
96
|
|
325
|
+
97
|
|
326
|
+
98</pre>
|
|
323
327
|
</td>
|
|
324
328
|
<td>
|
|
325
329
|
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/adapters/active_record_sideloading.rb', line 69</span>
|
|
@@ -334,7 +338,11 @@
|
|
|
334
338
|
<span class='id identifier rubyid_parent_ids'>parent_ids</span> <span class='op'>=</span> <span class='id identifier rubyid_parents'>parents</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_p'>p</span><span class='op'>|</span> <span class='id identifier rubyid_p'>p</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_primary_key'>primary_key</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
|
|
335
339
|
<span class='id identifier rubyid_parent_ids'>parent_ids</span><span class='period'>.</span><span class='id identifier rubyid_uniq!'>uniq!</span>
|
|
336
340
|
<span class='id identifier rubyid_parent_ids'>parent_ids</span><span class='period'>.</span><span class='id identifier rubyid_compact!'>compact!</span>
|
|
337
|
-
<span class='id identifier rubyid__scope'>_scope</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span
|
|
341
|
+
<span class='id identifier rubyid__scope'>_scope</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span>
|
|
342
|
+
<span class='period'>.</span><span class='id identifier rubyid_joins'>joins</span><span class='lparen'>(</span><span class='id identifier rubyid_through'>through</span><span class='rparen'>)</span>
|
|
343
|
+
<span class='period'>.</span><span class='id identifier rubyid_preload'>preload</span><span class='lparen'>(</span><span class='id identifier rubyid_through'>through</span><span class='rparen'>)</span> <span class='comment'># otherwise n+1 as we reference in #assign
|
|
344
|
+
</span> <span class='period'>.</span><span class='id identifier rubyid_where'>where</span><span class='lparen'>(</span><span class='id identifier rubyid_through'>through</span> <span class='op'>=></span> <span class='lbrace'>{</span> <span class='id identifier rubyid_fk'>fk</span> <span class='op'>=></span> <span class='id identifier rubyid_parent_ids'>parent_ids</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
345
|
+
<span class='period'>.</span><span class='id identifier rubyid_distinct'>distinct</span>
|
|
338
346
|
<span class='kw'>end</span>
|
|
339
347
|
|
|
340
348
|
<span class='id identifier rubyid_assign'>assign</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_parents'>parents</span><span class='comma'>,</span> <span class='id identifier rubyid_children'>children</span><span class='op'>|</span>
|
|
@@ -492,7 +500,7 @@
|
|
|
492
500
|
<div class="method_details ">
|
|
493
501
|
<h3 class="signature " id="polymorphic_belongs_to-instance_method">
|
|
494
502
|
|
|
495
|
-
#<strong>polymorphic_belongs_to</strong>(
|
|
503
|
+
#<strong>polymorphic_belongs_to</strong>(ssociation_name,, roup_by:,, roups:,, &lk)) ⇒ <tt>Object</tt>
|
|
496
504
|
|
|
497
505
|
|
|
498
506
|
|
|
@@ -504,10 +512,6 @@
|
|
|
504
512
|
<pre class="lines">
|
|
505
513
|
|
|
506
514
|
|
|
507
|
-
96
|
|
508
|
-
97
|
|
509
|
-
98
|
|
510
|
-
99
|
|
511
515
|
100
|
|
512
516
|
101
|
|
513
517
|
102
|
|
@@ -530,38 +534,42 @@
|
|
|
530
534
|
119
|
|
531
535
|
120
|
|
532
536
|
121
|
|
533
|
-
122
|
|
537
|
+
122
|
|
538
|
+
123
|
|
539
|
+
124
|
|
540
|
+
125
|
|
541
|
+
126</pre>
|
|
534
542
|
</td>
|
|
535
543
|
<td>
|
|
536
|
-
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/adapters/active_record_sideloading.rb', line
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
544
|
+
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/adapters/active_record_sideloading.rb', line 100</span>
|
|
545
|
+
|
|
546
|
+
ef polymorphic_belongs_to(association_name, group_by:, groups:, &blk)
|
|
547
|
+
allow_sideload association_name, type: :polymorphic_belongs_to, polymorphic: true do
|
|
548
|
+
group_by(group_by)
|
|
549
|
+
|
|
550
|
+
groups.each_pair do |type, config|
|
|
551
|
+
primary_key = config[:primary_key] || :id
|
|
552
|
+
foreign_key = config[:foreign_key]
|
|
553
|
+
|
|
554
|
+
allow_sideload type, parent: self, primary_key: primary_key, foreign_key: foreign_key, type: :belongs_to, resource: config[:resource] do
|
|
555
|
+
scope do |parents|
|
|
556
|
+
parent_ids = parents.map { |p| p.send(foreign_key) }
|
|
557
|
+
parent_ids.compact!
|
|
558
|
+
parent_ids.uniq!
|
|
559
|
+
config[:scope].call.where(primary_key => parent_ids)
|
|
560
|
+
end
|
|
561
|
+
|
|
562
|
+
assign do |parents, children|
|
|
563
|
+
parents.each do |parent|
|
|
564
|
+
parent.send(:"#{association_name}=", children.find { |c| c.send(primary_key) == parent.send(foreign_key) })
|
|
565
|
+
end
|
|
566
|
+
end
|
|
567
|
+
end
|
|
568
|
+
end
|
|
569
|
+
end
|
|
570
|
+
|
|
571
|
+
instance_eval(&blk) if blk
|
|
572
|
+
end</pre>
|
|
565
573
|
</td>
|
|
566
574
|
</tr>
|
|
567
575
|
</table>
|
|
@@ -572,7 +580,7 @@
|
|
|
572
580
|
</div>
|
|
573
581
|
|
|
574
582
|
<div id="footer">
|
|
575
|
-
Generated on
|
|
583
|
+
Generated on Thu May 3 15:52:17 2018 by
|
|
576
584
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
577
585
|
0.9.9 (ruby-2.3.0).
|
|
578
586
|
</div>
|
|
@@ -1672,7 +1672,7 @@ an HTTP call, etc.</p>
|
|
|
1672
1672
|
</div>
|
|
1673
1673
|
|
|
1674
1674
|
<div id="footer">
|
|
1675
|
-
Generated on
|
|
1675
|
+
Generated on Thu May 3 15:52:18 2018 by
|
|
1676
1676
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1677
1677
|
0.9.9 (ruby-2.3.0).
|
|
1678
1678
|
</div>
|
|
@@ -242,6 +242,28 @@ call.</p>
|
|
|
242
242
|
serialized parameters.</p>
|
|
243
243
|
</div></span>
|
|
244
244
|
|
|
245
|
+
</li>
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
<li class="public ">
|
|
249
|
+
<span class="summary_signature">
|
|
250
|
+
|
|
251
|
+
<a href="#jsonapi_destroy-instance_method" title="#jsonapi_destroy (instance method)">#<strong>jsonapi_destroy</strong> ⇒ Object </a>
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
</span>
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
266
|
+
|
|
245
267
|
</li>
|
|
246
268
|
|
|
247
269
|
|
|
@@ -730,13 +752,13 @@ render jsonapi: foo, default_jsonapi_render_options</code></pre>
|
|
|
730
752
|
<pre class="lines">
|
|
731
753
|
|
|
732
754
|
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
755
|
+
286
|
|
756
|
+
287
|
|
757
|
+
288
|
|
758
|
+
289</pre>
|
|
737
759
|
</td>
|
|
738
760
|
<td>
|
|
739
|
-
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/base.rb', line
|
|
761
|
+
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/base.rb', line 286</span>
|
|
740
762
|
|
|
741
763
|
<span class='kw'>def</span> <span class='id identifier rubyid_default_jsonapi_render_options'>default_jsonapi_render_options</span>
|
|
742
764
|
<span class='lbrace'>{</span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_tap'>tap</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_options'>options</span><span class='op'>|</span>
|
|
@@ -906,6 +928,40 @@ back the transaction.</p>
|
|
|
906
928
|
</td>
|
|
907
929
|
</tr>
|
|
908
930
|
</table>
|
|
931
|
+
</div>
|
|
932
|
+
|
|
933
|
+
<div class="method_details ">
|
|
934
|
+
<h3 class="signature " id="jsonapi_destroy-instance_method">
|
|
935
|
+
|
|
936
|
+
#<strong>jsonapi_destroy</strong> ⇒ <tt>Object</tt>
|
|
937
|
+
|
|
938
|
+
|
|
939
|
+
|
|
940
|
+
|
|
941
|
+
|
|
942
|
+
</h3><table class="source_code">
|
|
943
|
+
<tr>
|
|
944
|
+
<td>
|
|
945
|
+
<pre class="lines">
|
|
946
|
+
|
|
947
|
+
|
|
948
|
+
229
|
|
949
|
+
230
|
|
950
|
+
231
|
|
951
|
+
232
|
|
952
|
+
233</pre>
|
|
953
|
+
</td>
|
|
954
|
+
<td>
|
|
955
|
+
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/base.rb', line 229</span>
|
|
956
|
+
|
|
957
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_jsonapi_destroy'>jsonapi_destroy</span>
|
|
958
|
+
<span class='id identifier rubyid__persist'>_persist</span> <span class='kw'>do</span>
|
|
959
|
+
<span class='id identifier rubyid_jsonapi_resource'>jsonapi_resource</span><span class='period'>.</span><span class='id identifier rubyid_destroy'>destroy</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='lbracket'>[</span><span class='symbol'>:id</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
960
|
+
<span class='kw'>end</span>
|
|
961
|
+
<span class='kw'>end</span></pre>
|
|
962
|
+
</td>
|
|
963
|
+
</tr>
|
|
964
|
+
</table>
|
|
909
965
|
</div>
|
|
910
966
|
|
|
911
967
|
<div class="method_details ">
|
|
@@ -1429,17 +1485,17 @@ avoid this, pass <tt>scope: false</tt></p>
|
|
|
1429
1485
|
<pre class="lines">
|
|
1430
1486
|
|
|
1431
1487
|
|
|
1432
|
-
260
|
|
1433
|
-
261
|
|
1434
|
-
262
|
|
1435
|
-
263
|
|
1436
|
-
264
|
|
1437
|
-
265
|
|
1438
1488
|
266
|
|
1439
|
-
267
|
|
1489
|
+
267
|
|
1490
|
+
268
|
|
1491
|
+
269
|
|
1492
|
+
270
|
|
1493
|
+
271
|
|
1494
|
+
272
|
|
1495
|
+
273</pre>
|
|
1440
1496
|
</td>
|
|
1441
1497
|
<td>
|
|
1442
|
-
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/base.rb', line
|
|
1498
|
+
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/base.rb', line 266</span>
|
|
1443
1499
|
|
|
1444
1500
|
<span class='kw'>def</span> <span class='id identifier rubyid_render_jsonapi'>render_jsonapi</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
1445
1501
|
<span class='id identifier rubyid_scope'>scope</span> <span class='op'>=</span> <span class='id identifier rubyid_jsonapi_scope'>jsonapi_scope</span><span class='lparen'>(</span><span class='id identifier rubyid_scope'>scope</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_opts'>opts</span><span class='lbracket'>[</span><span class='symbol'>:scope</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='kw'>false</span> <span class='op'>||</span> <span class='id identifier rubyid_scope'>scope</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../JsonapiCompliable.html" title="JsonapiCompliable (module)">JsonapiCompliable</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Scope.html" title="JsonapiCompliable::Scope (class)">Scope</a></span></span><span class='rparen'>)</span>
|
|
@@ -1708,7 +1764,7 @@ Helpful for easy-access to things like the current user.</p>
|
|
|
1708
1764
|
</div>
|
|
1709
1765
|
|
|
1710
1766
|
<div id="footer">
|
|
1711
|
-
Generated on
|
|
1767
|
+
Generated on Thu May 3 15:52:17 2018 by
|
|
1712
1768
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1713
1769
|
0.9.9 (ruby-2.3.0).
|
|
1714
1770
|
</div>
|
|
@@ -0,0 +1,308 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: JsonapiCompliable::Configuration
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.9
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
pathId = "JsonapiCompliable::Configuration";
|
|
19
|
+
relpath = '../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../_index.html">Index (C)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../JsonapiCompliable.html" title="JsonapiCompliable (module)">JsonapiCompliable</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Configuration</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: JsonapiCompliable::Configuration
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">JsonapiCompliable::Configuration</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dt>Defined in:</dt>
|
|
97
|
+
<dd>lib/jsonapi_compliable/configuration.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
107
|
+
<ul class="summary">
|
|
108
|
+
|
|
109
|
+
<li class="public ">
|
|
110
|
+
<span class="summary_signature">
|
|
111
|
+
|
|
112
|
+
<a href="#raise_on_missing_sideload-instance_method" title="#raise_on_missing_sideload (instance method)">#<strong>raise_on_missing_sideload</strong> ⇒ Boolean </a>
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
</span>
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
<span class="summary_desc"><div class='inline'>
|
|
130
|
+
<p>Should we raise when the client requests a relationship not defined on the
|
|
131
|
+
server? Defaults to true.</p>
|
|
132
|
+
</div></span>
|
|
133
|
+
|
|
134
|
+
</li>
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
</ul>
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
<h2>
|
|
144
|
+
Instance Method Summary
|
|
145
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
146
|
+
</h2>
|
|
147
|
+
|
|
148
|
+
<ul class="summary">
|
|
149
|
+
|
|
150
|
+
<li class="public ">
|
|
151
|
+
<span class="summary_signature">
|
|
152
|
+
|
|
153
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> ⇒ Configuration </a>
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
</span>
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
<span class="note title constructor">constructor</span>
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
<span class="private note title">private</span>
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
<span class="summary_desc"><div class='inline'>
|
|
170
|
+
<p>Set defaults.</p>
|
|
171
|
+
</div></span>
|
|
172
|
+
|
|
173
|
+
</li>
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
</ul>
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
<div id="constructor_details" class="method_details_list">
|
|
180
|
+
<h2>Constructor Details</h2>
|
|
181
|
+
|
|
182
|
+
<div class="method_details first">
|
|
183
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
184
|
+
|
|
185
|
+
#<strong>initialize</strong> ⇒ <tt><span class='object_link'><a href="" title="JsonapiCompliable::Configuration (class)">Configuration</a></span></tt>
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
</h3><div class="docstring">
|
|
192
|
+
<div class="discussion">
|
|
193
|
+
<p class="note private">
|
|
194
|
+
<strong>This method is part of a private API.</strong>
|
|
195
|
+
You should avoid using this method if possible, as it may be removed or be changed in the future.
|
|
196
|
+
</p>
|
|
197
|
+
|
|
198
|
+
<p>Set defaults</p>
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
</div>
|
|
202
|
+
</div>
|
|
203
|
+
<div class="tags">
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
</div><table class="source_code">
|
|
207
|
+
<tr>
|
|
208
|
+
<td>
|
|
209
|
+
<pre class="lines">
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
10
|
|
213
|
+
11
|
|
214
|
+
12</pre>
|
|
215
|
+
</td>
|
|
216
|
+
<td>
|
|
217
|
+
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/configuration.rb', line 10</span>
|
|
218
|
+
|
|
219
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
|
|
220
|
+
<span class='ivar'>@raise_on_missing_sideload</span> <span class='op'>=</span> <span class='kw'>true</span>
|
|
221
|
+
<span class='kw'>end</span></pre>
|
|
222
|
+
</td>
|
|
223
|
+
</tr>
|
|
224
|
+
</table>
|
|
225
|
+
</div>
|
|
226
|
+
|
|
227
|
+
</div>
|
|
228
|
+
|
|
229
|
+
<div id="instance_attr_details" class="attr_details">
|
|
230
|
+
<h2>Instance Attribute Details</h2>
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
<span id="raise_on_missing_sideload=-instance_method"></span>
|
|
234
|
+
<div class="method_details first">
|
|
235
|
+
<h3 class="signature first" id="raise_on_missing_sideload-instance_method">
|
|
236
|
+
|
|
237
|
+
#<strong>raise_on_missing_sideload</strong> ⇒ <tt>Boolean</tt>
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
</h3><div class="docstring">
|
|
244
|
+
<div class="discussion">
|
|
245
|
+
|
|
246
|
+
<p>Returns Should we raise when the client requests a relationship not defined
|
|
247
|
+
on the server? Defaults to true.</p>
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
</div>
|
|
251
|
+
</div>
|
|
252
|
+
<div class="tags">
|
|
253
|
+
|
|
254
|
+
<p class="tag_title">Returns:</p>
|
|
255
|
+
<ul class="return">
|
|
256
|
+
|
|
257
|
+
<li>
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
—
|
|
265
|
+
<div class='inline'>
|
|
266
|
+
<p>Should we raise when the client requests a relationship not defined on the
|
|
267
|
+
server? Defaults to true.</p>
|
|
268
|
+
</div>
|
|
269
|
+
|
|
270
|
+
</li>
|
|
271
|
+
|
|
272
|
+
</ul>
|
|
273
|
+
|
|
274
|
+
</div><table class="source_code">
|
|
275
|
+
<tr>
|
|
276
|
+
<td>
|
|
277
|
+
<pre class="lines">
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
6
|
|
281
|
+
7
|
|
282
|
+
8</pre>
|
|
283
|
+
</td>
|
|
284
|
+
<td>
|
|
285
|
+
<pre class="code"><span class="info file"># File 'lib/jsonapi_compliable/configuration.rb', line 6</span>
|
|
286
|
+
|
|
287
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_raise_on_missing_sideload'>raise_on_missing_sideload</span>
|
|
288
|
+
<span class='ivar'>@raise_on_missing_sideload</span>
|
|
289
|
+
<span class='kw'>end</span></pre>
|
|
290
|
+
</td>
|
|
291
|
+
</tr>
|
|
292
|
+
</table>
|
|
293
|
+
</div>
|
|
294
|
+
|
|
295
|
+
</div>
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
</div>
|
|
299
|
+
|
|
300
|
+
<div id="footer">
|
|
301
|
+
Generated on Thu May 3 15:52:18 2018 by
|
|
302
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
303
|
+
0.9.9 (ruby-2.3.0).
|
|
304
|
+
</div>
|
|
305
|
+
|
|
306
|
+
</div>
|
|
307
|
+
</body>
|
|
308
|
+
</html>
|