Class: V1::Ont::TagResource

Inherits:

JSONAPI::Resource

• Object
• JSONAPI::Resource
• V1::Ont::TagResource

Defined in:

app/resources/v1/ont/tag_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/ont/tags/ endpoint.

Provides a JSON:API representation of Tag. This is a resource to return all of the ONT tags.

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.

Instance Attribute Summary

• #group_id ⇒ Integer

  The group identifier for the tag.

• #oligo ⇒ String

  The oligo sequence of the tag.

Instance Attribute Details

#group_id ⇒ Integer

Returns the group identifier for the tag.

Returns:

• (Integer) —

  the group identifier for the tag

# File 'app/resources/v1/ont/tag_resource.rb', line 24

attributes :oligo, :group_id

#oligo ⇒ String

Returns the oligo sequence of the tag.

Returns:

• (String) —

  the oligo sequence of the tag

# File 'app/resources/v1/ont/tag_resource.rb', line 24

attributes :oligo, :group_id