Module: JsonapiCompliable::SerializableTempId

Defined in:
lib/jsonapi_compliable/extensions/temp_id.rb

Overview

If the object we are serializing has the instance variable @_jsonapi_temp_id, render temp-id in the resource identifier

Why? Well, when the request is a nested POST, creating the main entity as well as relationships, we need some way of telling the client, “hey, the object you have in memory, that you just sent to the server, has been persisted and now has id X”.

@_jsonapi_temp_id is set within this library. You should never have to reference it directly.

Instance Method Summary collapse

Instance Method Details

#as_jsonapi ⇒ Object

Common interface for jsonapi-rb extensions



14
15
16
17
18
19
20
 
# File 'lib/jsonapi_compliable/extensions/temp_id.rb', line 14

def as_jsonapi(*)
  super.tap do |hash|
    if temp_id = @object.instance_variable_get(:@_jsonapi_temp_id')
      hash[:temp-id'] = temp_id
    end
  end
end