Class: V1::LibraryTypeResource

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

Provides a JSON:API representation of LibraryType and exposes valid library type options for use by the UI.

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 collapse

Instance Attribute Details

#active ⇒ Boolean

Returns the active status of the library type.

Returns:

  • (Boolean) —

    the active status of the library type



29
 
# File 'app/resources/v1/library_type_resource.rb', line 29

attributes :name, :pipeline, :created_at, :updated_at, :external_identifier, :active

#created_at ⇒ String

Returns the timestamp when the library type was created.

Returns:

  • (String) —

    the timestamp when the library type was created



29
 
# File 'app/resources/v1/library_type_resource.rb', line 29

attributes :name, :pipeline, :created_at, :updated_at, :external_identifier, :active

#external_identifier ⇒ String

Returns the external identifier of the library type.

Returns:

  • (String) —

    the external identifier of the library type



29
 
# File 'app/resources/v1/library_type_resource.rb', line 29

attributes :name, :pipeline, :created_at, :updated_at, :external_identifier, :active

#name ⇒ String

Returns the name of the library type.

Returns:

  • (String) —

    the name of the library type



29
 
# File 'app/resources/v1/library_type_resource.rb', line 29

attributes :name, :pipeline, :created_at, :updated_at, :external_identifier, :active

#pipeline ⇒ String

Returns the pipeline associated with the library type.

Returns:

  • (String) —

    the pipeline associated with the library type



29
 
# File 'app/resources/v1/library_type_resource.rb', line 29

attributes :name, :pipeline, :created_at, :updated_at, :external_identifier, :active

#updated_at ⇒ String

Returns the timestamp when the library type was last updated.

Returns:

  • (String) —

    the timestamp when the library type was last updated



29
 
# File 'app/resources/v1/library_type_resource.rb', line 29

attributes :name, :pipeline, :created_at, :updated_at, :external_identifier, :active