Class: Api::V2::StudyMetadataResource

Inherits:

BaseResource

• Object
• JSONAPI::Resource
• BaseResource
• Api::V2::StudyMetadataResource

Defined in:

app/resources/api/v2/study_metadata_resource.rb

Overview

Provides a JSON:API representation of Study::Metadata which contains additional metadata related to a Study.

A Study is a collection of various samples and the work done on them.

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

• #faculty_sponsor ⇒ Api::V2::FacultySponsorResource readonly

  The faculty sponsor based on faculty_sponsor_id.

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

#faculty_sponsor ⇒ Api::V2::FacultySponsorResource (readonly)

Returns The faculty sponsor based on faculty_sponsor_id.

Returns:

• (Api::V2::FacultySponsorResource) —

  The faculty sponsor based on faculty_sponsor_id

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

has_one :faculty_sponsor, foreign_key_on: :related, readonly: true