Class: V1::Ont::InstrumentResource

Inherits:
JSONAPI::Resource
  • Object
show all
Defined in:
app/resources/v1/ont/instrument_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/instruments/ endpoint.

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

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

Instance Attribute Details

#instrument_type ⇒ String

Returns the type of the instrument.

Returns:

  • (String) —

    the type of the instrument


25
 
# File 'app/resources/v1/ont/instrument_resource.rb', line 25

attributes :name, :instrument_type, :max_number_of_flowcells

#max_number_of_flowcells ⇒ Integer

Returns the maximum number of flowcells the instrument can handle.

Returns:

  • (Integer) —

    the maximum number of flowcells the instrument can handle


25
 
# File 'app/resources/v1/ont/instrument_resource.rb', line 25

attributes :name, :instrument_type, :max_number_of_flowcells

#name ⇒ String

Returns the name of the instrument.

Returns:

  • (String) —

    the name of the instrument


25
 
# File 'app/resources/v1/ont/instrument_resource.rb', line 25

attributes :name, :instrument_type, :max_number_of_flowcells