Class: Api::V2::TagLayoutTemplateResource

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

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

Note:

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

Provides a JSON:API representation of TagLayoutTemplate.

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

Instance Method Summary collapse

Methods inherited from BaseResource

apply_includes, creatable_fields, default_includes, #fetchable_fields, inclusions, resolve_relationship_names_to_relations, updatable_fields

Instance Attribute Details

#direction ⇒ String (readonly)

The name of the algorithm defining the direction of the tag layout.

Returns:

  • (String) 


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

attribute :direction, readonly: true

#name ⇒ String (readonly)

The display name of the tag layout template.

Returns:

  • (String) 


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

attribute :name, readonly: true

#tag2_group ⇒ Api::V2::TagGroupResource (readonly)

A relationship for the secondary tag group associated with the tag layout template. This is used during dual indexing, but will not be found during single indexing.

Returns:



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

has_one :tag2_group, class_name: 'TagGroup', readonly: true

#tag_group ⇒ Api::V2::TagGroupResource (readonly)

A relationship for the primary tag group associated with the tag layout template.

Returns:



27
 
# File 'app/resources/api/v2/tag_layout_template_resource.rb', line 27

has_one :tag_group, readonly: true

#uuid ⇒ String (readonly)

The UUID of the tag layout template.

Returns:

  • (String) 


42
 
# File 'app/resources/api/v2/tag_layout_template_resource.rb', line 42

attribute :uuid, readonly: true

#walking_by ⇒ String (readonly)

The name of the algorithm defining the way of walking through the tag layout.

Returns:

  • (String) 


57
 
# File 'app/resources/api/v2/tag_layout_template_resource.rb', line 57

attribute :walking_by, readonly: true

Instance Method Details

#enabled ⇒ Object

A filter to return only enabled tag layout templates. Set by default to true.



66
 
# File 'app/resources/api/v2/tag_layout_template_resource.rb', line 66

filter :enabled, default: true