Class: Api::V2::RequestMetadataResource

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

Provides a JSON:API representation of Metadata::Metadata.

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

#cells_per_chip_well ⇒ Int (readonly)

Returns the cells_per_chip_well.

Returns:

  • (Int) —

    the cells_per_chip_well.



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

attribute :cells_per_chip_well, write_once: true

#number_of_samples_per_pool ⇒ Int (readonly)

Returns the number_of_samples_per_pool.

Returns:

  • (Int) —

    the number_of_samples_per_pool.



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

attribute :number_of_samples_per_pool, write_once: true