Class: Api::V2::LaneResource

Inherits:
BaseResource
  • Object
show all
Defined in:
app/resources/api/v2/lane_resource.rb

Overview

Note:

This resource is immutable: its endpoint will not accept POST, PATCH, or DELETE requests.

Note:

Access this resource via the /api/v2/lanes/ endpoint.

Provides a JSON:API representation of Lane, representing sequencing lanes within a flowcell.

For more information about JSON:API, see the JSON:API Specifications or check out JSONAPI::Resources for Sequencescape's implementation.

Examples:

GET request for all Lane resources

GET /api/v2/lanes/

GET request for a single Lane resource with ID 123

GET /api/v2/lanes/123/

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 (readonly)

The display name of the lane.

Returns:

  • (String) —

    The human-readable name of the lane.



52
 
# File 'app/resources/api/v2/lane_resource.rb', line 52

attribute :name, delegate: :display_name

#projects ⇒ Array<ProjectResource> (readonly)

The projects associated with this lane.

Returns:



38
 
# File 'app/resources/api/v2/lane_resource.rb', line 38

has_many :projects

#samples ⇒ Array<SampleResource> (readonly)

The samples associated with this lane.

Returns:



28
 
# File 'app/resources/api/v2/lane_resource.rb', line 28

has_many :samples

#studies ⇒ Array<StudyResource> (readonly)

The studies associated with this lane.

Returns:

  • (Array<StudyResource>) —

    A list of studies linked to this lane.



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

has_many :studies

#uuid ⇒ String (readonly)

Note:

This identifier is automatically assigned upon creation and cannot be modified.

Returns The unique identifier for the lane.

Returns:

  • (String) —

    The unique identifier for the lane.



47
 
# File 'app/resources/api/v2/lane_resource.rb', line 47

attribute :uuid, readonly: true