Class: V1::Ont::TubeResource

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

Provides a JSON:API representation of Tube.

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

#barcode ⇒ String

Returns the barcode of the tube.

Returns:

  • (String) —

    the barcode of the tube



24
 
# File 'app/resources/v1/ont/tube_resource.rb', line 24

attributes :barcode

#pools ⇒ Array<Pool>

Returns the pools associated with the tube.

Returns:

  • (Array<Pool>) —

    the pools associated with the tube



24
 
# File 'app/resources/v1/ont/tube_resource.rb', line 24

attributes :barcode

#requests ⇒ Array<Request>

Returns the requests associated with the tube.

Returns:

  • (Array<Request>) —

    the requests associated with the tube



24
 
# File 'app/resources/v1/ont/tube_resource.rb', line 24

attributes :barcode

Class Method Details

.records(_options = {}) ⇒ Object 



34
35
36
 
# File 'app/resources/v1/ont/tube_resource.rb', line 34

def self.records(_options = {})
  ::Tube.by_pipeline(:ont)
end