exclude_links from https://jsonapi-resources.com/v0.10/guide/resources.html#Options ?
relationships should be missing by default if the resource does not have any relationships defined. Alternatively, the client can use sparse fieldsets. Does that help?
exclude_links, thanks for pointing that!
Thank you @tobias_grasse_twitter . I am evaluating 0.10 , but using 0.9
Another question. I have a situation where the attribute name is conflicting with has_many relationship say
attribute :tags
has_many :tagsthe PATCH request seems to be in this format
{"data":
{ "type":"tasks",
"id":"6",
"attributes":{
"title": "Title",
"tags": ["Home"]
}
}
}and expected output is in this
{
"data":{
"id":"2",
"type":"tasks",
"attributes":{
"title":"Updated Task Title"
},
"relationships":{
"tags":{
"data":[
{
"id":"2",
"type":"tags"
},
{
"id":"3",
"type":"tags"
}
]
}
}
}
}
"included" :{ ..stuff ...}@tobias_grasse_twitter , I got this error
ArgumentError: wrong number of arguments (given 1, expected 0)
0) Api::V1::TaskResource
Failure/Error:
it { puts JSONAPI::ResourceSerializer
.new(described_class)
.serialize_to_hash(described_class.new(sample, nil))
}
ArgumentError:
wrong number of arguments (given 1, expected 0)
# ./spec/resources/api/v1/task_resource_spec.rb:15:in `block (2 levels) in <top (required)>'My resource class definition is
class Api::V1::TaskResource < JSONAPI::Resource
attributes :title, :tags
has_many :tags, always_include_linkage_data: true
def tags=(tag_titles)
@model.replace_tags!(tag_titles)
end
def self.creatable_fields(context = nil)
super - [:tags]
end
end
serialize_to_hash, see :point_up: 17. September 2020 15:43
requested_relationship is only present in jsonapi-resources 0.10.x . The 0.9.x signature only requires a single TaskResource like your failing RSpec does. Maybe you mixed up the versions 😊
Hi! I'm still on 0.9 and I was wondering if anyone can help out with this:
I need to filter a relationship in my resource based on the context. For example:
a person has many friends
if I want to include person.friends.friends as an example I want to see the friends a person has and the friends they have that are mutual. Because this doesn't make sense in activerecord (this is request-specifc, not a special relationship) I would really need to make the scope records.friends.friends.where(is_friend: context[:person_id) (ignore how I build the actual where clause).
Is this possible in 0.9?
An alternative way to look at this:
my PersonResource is scoped to only allow returning people who are self, or friends of whoever is in context[:person_id]. If I do include=friends.friends which is a PersonResource, the response is an error because one of the friends is not a mutual friend and thus the id is not found in the scope (and I don't want that record returned either).
To add a bit of context:
Crash is in preload_included_fragments
I assumed def records_for(association_name) would be where I can inject myself and make the necessary scoping... however that method is never invoked by the time the crash happens.
The crash being Internal Server Error: key not found: 5735 (jsonapi/resource.rb:1354) because that key is out of scope for my resource.
Is there any way to customize relationship links? I know about the "custom_links" method/override for top-level resource links but I'm talking about the links within a relationship object. Specifically around turning a link into a JSON:API "link object". I'd like to be able to return a meta object along with the link href for things like counts. Something like this:
"relationships": {
"questions": {
"links": {
"related": {
"href": "http://whatever.com/questions",
"meta": {
"count": 10
}
}
},
"data": []
}
}
Thanks, that might work. On a similar note, the JSON:API spec also suggests that the "relationship object" can also contain a meta object alongside "links" and "data". So something like this:
"relationships": {
"questions": {
"links": {
"related": "http://whatever.com/questions"
},
"data": [...],
"meta": {
"count": 10
}
}
}Looking through the code and I don't see any easy way to populate/return meta at that level?
@lgebhardt subqueries? like you mean sq in where clauses or whatever? So basically the problem is that I override self.records in my resources to restrict what records can be seen based on my context (who is logged in). But on occasion a ?include=... includes a relationship that contains records that would otherwise be excluded by self.records. My question would be how to allow filtering of an association (including during included resources)? Typically I could do say record.association.where(...) but I don't know where in JR to put that code.
If you need me to put together a mini-server on github to see the problem I can do that, but I was hoping that just knowing what methods exist could be a good start.
@lgebhardt sorry maybe I didn't quite get the meaning, what would be the right thing to override in 0.9 if you are aware of something that can be done. Currently my best plan is to remove the self.records restriction and take the serialized data and remove records from there in the processor which is definitely not the best performant way about it.
And if 0.10 is definitely going to make things easier I will also look into it. Our only issue is some of our resources don't return db (activerecord) models which I still don't fully understand how to do in 0.10.
- 0.10 solves my problem because
self.recordsgets invoked during includes - 0.10 doesn't support non ActiveRecord models well, so I can't switch to it, hopeful for 0.11
- To solve it in 0.9 I will be creating special models which join the logged in user with a nested relationship so I will have to query it directly (In the example of Hospital -> Patient -> Guardian -> Patient, I will need a HospitalGuardian with filters and HospitalPatient with filters, and won't be able to fetch the relationship directly, for now)
Hi all!
I'm new to jsonapi-resources.
I would like my API to have /my as an alias/shortcut to /users/{guid} where {guid} is the logged-in-user's id.
Correspondingly, /my/someRelationship would be an alias for /users/{guid}/someRelationship
e.g.
GET /my/company
GET /my/teams
I did this:
class MyResource < JSONAPI::Resource
@_model_name = 'User'
@_model_class = User
has_one :company
has_many :teams
singleton singleton_key: lambda { |context|
key = context[:current_user].try(:id)
raise JSONAPI::Exceptions::RecordNotFound, nil if key.nil?
key
}
endThat works for GET /my, and it returns the JSON I would expect; the self link is /users/{guid}, which is what I actually would expect}
companies and teams links are included in the JSON, and they also the non-shortcut URL's, which I consider "canonical"
But as I said, I would like to be able to GET /my/company and /my/teams as well. That doesn' t work.
I get:
{
"errors": [
{
"title": "Missing Parameter",
"detail": "The required parameter, my_id, is missing.",
"code": "106",
"status": "400"
}
]
}Any suggestions?
Instead of a new MyResource you could consider a route like /users/me. You could enforce this at the routes like:
UUID_or_ME_regex ||= /[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}|([Mm][Ee])/
jsonapi_resources :users, constraints: {:id => UUID_or_ME_regex}Then in the controller convert the Me to the logged in user
...
before_action :convert_me_id
def convert_me_id
if params[:id] && params[:id].casecmp('me') == 0
params[:id] = context[:current_user].id
end
endYour relationship routes would then be /users/me/company
That has the advantage that there returned user is the same type as any other user. It also keeps it very simple
/users/my/company. Still a bit "off" but not too bad in my mind
1 reply
