Class: V1::Ont::LibraryResource

Inherits:
JSONAPI::Resource
  • Object
show all
Defined in:
app/resources/v1/ont/library_resource.rb

Overview

TODO:

This documentation does not yet include a detailed description of what this resource represents.

TODO:

This documentation does not yet include detailed descriptions for relationships, attributes and filters.

TODO:

This documentation does not yet include any example usage of the API via cURL or similar.

Note:

Access this resource via the /v1/ont/libraries/ endpoint.

Provides a JSON:API representation of Ont::Library.

For more information about JSON:API see the JSON:API Specifications or look at the JSONAPI::Resources package for the service implementation of the JSON:API standard.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#concentration ⇒ Float

Returns the concentration of the library.

Returns:

  • (Float) —

    the concentration of the library



33
34
 
# File 'app/resources/v1/ont/library_resource.rb', line 33

attributes :volume, :kit_barcode, :concentration, :insert_size,
:created_at, :deactivated_at, :state

#created_at ⇒ String

Returns the creation timestamp of the library.

Returns:

  • (String) —

    the creation timestamp of the library



33
34
 
# File 'app/resources/v1/ont/library_resource.rb', line 33

attributes :volume, :kit_barcode, :concentration, :insert_size,
:created_at, :deactivated_at, :state

#deactivated_at ⇒ String?

Returns the deactivation timestamp of the library, if any.

Returns:

  • (String, nil) —

    the deactivation timestamp of the library, if any



33
34
 
# File 'app/resources/v1/ont/library_resource.rb', line 33

attributes :volume, :kit_barcode, :concentration, :insert_size,
:created_at, :deactivated_at, :state

#insert_size ⇒ Integer

Returns the insert size of the library.

Returns:

  • (Integer) —

    the insert size of the library



33
34
 
# File 'app/resources/v1/ont/library_resource.rb', line 33

attributes :volume, :kit_barcode, :concentration, :insert_size,
:created_at, :deactivated_at, :state

#kit_barcode ⇒ String

Returns the barcode of the kit used.

Returns:

  • (String) —

    the barcode of the kit used



33
34
 
# File 'app/resources/v1/ont/library_resource.rb', line 33

attributes :volume, :kit_barcode, :concentration, :insert_size,
:created_at, :deactivated_at, :state

#state ⇒ String

Returns the state of the library.

Returns:

  • (String) —

    the state of the library



33
34
 
# File 'app/resources/v1/ont/library_resource.rb', line 33

attributes :volume, :kit_barcode, :concentration, :insert_size,
:created_at, :deactivated_at, :state

#volume ⇒ Float

Returns the volume of the library.

Returns:

  • (Float) —

    the volume of the library



33
34
 
# File 'app/resources/v1/ont/library_resource.rb', line 33

attributes :volume, :kit_barcode, :concentration, :insert_size,
:created_at, :deactivated_at, :state

Class Method Details

.records_for_populate(*_args) ⇒ Object 



50
51
52
53
54
 
# File 'app/resources/v1/ont/library_resource.rb', line 50

def self.records_for_populate(*_args)
  super.preload(source_well: :plate, request: :sample,
                tag: :tag_set,
                container_material: { container: :barcode })
end