Class: Api::V2::BaitLibraryLayoutResource
- Inherits:
-
BaseResource
- Object
- JSONAPI::Resource
- BaseResource
- Api::V2::BaitLibraryLayoutResource
- Defined in:
- app/resources/api/v2/bait_library_layout_resource.rb
Overview
This documentation does not yet include a detailed description of what this resource represents.
This documentation does not yet include detailed descriptions for relationships, attributes and filters.
This documentation does not yet include any example usage of the API via cURL or similar.
This resource cannot be modified after creation: its endpoint will not accept PATCH
requests.
Access this resource via the /api/v2/bait_library_layouts/
endpoint.
Provides a JSON:API representation of BaitLibraryLayout.
For more information about JSON:API see the JSON:API Specifications or look at the JSONAPI::Resources package for Sequencescape’s implementation of the JSON:API standard.
Instance Attribute Summary collapse
-
#layout ⇒ Hash
readonly
The layout of the bait libraries on the plate.
-
#plate ⇒ PlateResource
Setting this relationship alongside the
plate_uuid
attribute will override the attribute value. -
#plate_uuid ⇒ Void
writeonly
deprecated
Deprecated.
Use the
plate
relationship instead. -
#user ⇒ UserResource
Setting this relationship alongside the
user_uuid
attribute will override the attribute value. -
#user_uuid ⇒ Void
writeonly
deprecated
Deprecated.
Use the
user
relationship instead.
Method Summary
Methods inherited from BaseResource
apply_includes, creatable_fields, default_includes, #fetchable_fields, inclusions, resolve_relationship_names_to_relations, updatable_fields
Instance Attribute Details
#layout ⇒ Hash (readonly)
Returns The layout of the bait libraries on the plate.
46 |
# File 'app/resources/api/v2/bait_library_layout_resource.rb', line 46 attribute :layout, readonly: true |
#plate ⇒ PlateResource
This relationship is required.
Setting this relationship alongside the plate_uuid
attribute will override the attribute value.
66 |
# File 'app/resources/api/v2/bait_library_layout_resource.rb', line 66 has_one :plate |
#plate_uuid=(value) ⇒ Void (writeonly)
Use the plate
relationship instead.
This is declared for convenience where the plate is not available to set as a relationship. Setting this attribute alongside the plate
relationship will prefer the relationship value.
25 |
# File 'app/resources/api/v2/bait_library_layout_resource.rb', line 25 attribute :plate_uuid, writeonly: true |
#user ⇒ UserResource
This relationship is required.
Setting this relationship alongside the user_uuid
attribute will override the attribute value.
60 |
# File 'app/resources/api/v2/bait_library_layout_resource.rb', line 60 has_one :user |
#user_uuid=(value) ⇒ Void (writeonly)
Use the user
relationship instead.
This is declared for convenience where the user is not available to set as a relationship. Setting this attribute alongside the user
relationship will prefer the relationship value.
38 |
# File 'app/resources/api/v2/bait_library_layout_resource.rb', line 38 attribute :user_uuid, writeonly: true |