Class: V1::Ont::InstrumentResource

Inherits:

JSONAPI::Resource

• Object
• JSONAPI::Resource
• V1::Ont::InstrumentResource

Defined in:

app/resources/v1/ont/instrument_resource.rb

Overview

Note:

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

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

Examples:

curl -X GET http://localhost:3100/v1/ont/instruments
curl -X GET "http://localhost:3100/v1/ont/instruments/1"

Instance Attribute Summary

• #instrument_type ⇒ String

  The type of the instrument.

• #max_number_of_flowcells ⇒ Integer

  The maximum number of flowcells the instrument can handle.

• #name ⇒ String

  The name of the instrument.

Instance Attribute Details

#instrument_type ⇒ String

Returns the type of the instrument.

Returns:

• (String) —

  the type of the instrument

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

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

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

attributes :name, :instrument_type, :max_number_of_flowcells

#name ⇒ String

Returns the name of the instrument.

Returns:

• (String) —

  the name of the instrument

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

attributes :name, :instrument_type, :max_number_of_flowcells