Class: Api::V2::TubePurposeResource

Inherits:
BaseResource
  • Object
show all
Defined in:
app/resources/api/v2/tube_purpose_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 /api/v2/tube_purposes/ endpoint.

Provides a JSON:API representation of Tube::Purpose.

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

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

#name ⇒ String

Returns the name of the tube purpose.

Returns:

  • (String) —

    the name of the tube purpose.



25
 
# File 'app/resources/api/v2/tube_purpose_resource.rb', line 25

attribute :name

#purpose_type ⇒ String

Returns the purpose type. This is mapped to the type attribute on the model.

Returns:

  • (String) —

    the purpose type. This is mapped to the type attribute on the model.



29
 
# File 'app/resources/api/v2/tube_purpose_resource.rb', line 29

attribute :purpose_type, delegate: :type

#target_type ⇒ String

Returns the target type.

Returns:

  • (String) —

    the target type.



33
 
# File 'app/resources/api/v2/tube_purpose_resource.rb', line 33

attribute :target_type

#uuid ⇒ String (readonly)

Returns the UUID of the tube purpose.

Returns:

  • (String) —

    the UUID of the tube purpose.



37
 
# File 'app/resources/api/v2/tube_purpose_resource.rb', line 37

attribute :uuid, readonly: true