Skip to content

Commit 50524db

Browse files
author
James Glover
committed
Improve documentation
1 parent aa72b82 commit 50524db

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

app/resources/v1/pacbio/library_resource.rb

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ class LibraryResource < JSONAPI::Resource
1111

1212
has_one :request, always_include_optional_linkage_data: true
1313
# If we don't specify the relation_name here, jsonapi-resources
14-
# attempts to use_related_resource_records_for_joins
15-
# In this case I can see it using container_associations
16-
# so seems to be linking the wrong tube relationship.
14+
# attempts to apply the filters present on `V1::Pacbio::TubeResource`
15+
# as defined by `V1::Pacbio::TubeResource#records`. This filters out
16+
# all our lovely tubes
1717
has_one :tube, relation_name: :tube
1818
has_one :tag, always_include_optional_linkage_data: true
1919
has_one :pool, always_include_optional_linkage_data: true

app/resources/v1/pacbio/pool_resource.rb

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ class PoolResource < JSONAPI::Resource
77
model_name 'Pacbio::Pool'
88

99
# If we don't specify the relation_name here, jsonapi-resources
10-
# attempts to use_related_resource_records_for_joins
11-
# In this case I can see it using container_associations
12-
# so seems to be linking the wrong tube relationship.
10+
# attempts to apply the filters present on `V1::Pacbio::TubeResource`
11+
# as defined by `V1::Pacbio::TubeResource#records`. This filters out
12+
# all our lovely tubes
1313
has_one :tube, relation_name: :tube
1414
has_many :libraries
1515

0 commit comments

Comments
 (0)