Class: V1::TagSetResource

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

Provides a JSON:API representation of TagSet.

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.

Direct Known Subclasses

Ont::TagSetResource, Pacbio::TagSetResource

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#name ⇒ String

Returns the name of the tag set.

Returns:

  • (String) —

    the name of the tag set



22
 
# File 'app/resources/v1/tag_set_resource.rb', line 22

attributes :name, :uuid, :pipeline

#pipeline ⇒ String

Returns the pipeline associated with the tag set.

Returns:

  • (String) —

    the pipeline associated with the tag set



22
 
# File 'app/resources/v1/tag_set_resource.rb', line 22

attributes :name, :uuid, :pipeline

#uuid ⇒ String

Returns the UUID of the tag set.

Returns:

  • (String) —

    the UUID of the tag set



22
 
# File 'app/resources/v1/tag_set_resource.rb', line 22

attributes :name, :uuid, :pipeline

Class Method Details

.records(options = {}) ⇒ Object 



28
29
30
 
# File 'app/resources/v1/tag_set_resource.rb', line 28

def self.records(options = {})
  super.where(active: true)
end