Class: Api::V2::WellResource

Inherits:
BaseResource
  • Object
show all
Includes:
SharedBehaviour::Receptacle
Defined in:
app/resources/api/v2/well_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 /api/v2/wells/ endpoint.

Provides a JSON:API representation of Well.

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 Method Summary collapse

Methods inherited from BaseResource

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

Instance Method Details

#position ⇒ Object 



24
25
26
 
# File 'app/resources/api/v2/well_resource.rb', line 24

def position
  { 'name' => _model.map_description }
end