JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources
Automatic include directives from filtering on a relationship column?
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Ruby
- Estrellas
- 2.3k
- Forks
- 546
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
In the apply filters function:
def apply_filters(records, filters, options = {})
required_includes = []
if filters
filters.each do |filter, value|
if _resource_klass._relationships.include?(filter)
if _resource_klass._relationships[filter].belongs_to?
records = apply_filter(records, _resource_klass._relationships[filter].foreign_key, value, options)
else
required_includes.push(filter.to_s)
records = apply_filter(records, "#{_resource_klass._relationships[filter].table_name}.#{_resource_klass._relationships[filter].primary_key}", value, options)
end
else
records = apply_filter(records, filter, value, options)
end
end
end
if required_includes.any?
records = apply_includes(records, options.merge(include_directives: IncludeDirectives.new(_resource_klass, required_includes, force_eager_load: true)))
end
records
end
I noticed there is a line where the filtered relationships are then added as includes which then get returned.
if required_includes.any?
records = apply_includes(records, options.merge(include_directives: IncludeDirectives.new(_resource_klass, required_includes, force_eager_load: true)))
end
This means that I can never just filter on a relationship column but just return the top level object, I have to return the whole filtered relationship as well.
Is that right? Is that in accordance with the JSON API spec?
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza por la función apply_filters mostrada en el issue y sigue cómo apply_includes e IncludeDirectives gestionan las inclusiones de relaciones requeridas. Compara el comportamiento resultante de la respuesta con la especificación JSON:API y determina y documenta si filtrar por una columna de relación debería devolver solo el recurso de nivel superior o también la relación filtrada.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- ruby
- Área
- api, backend
- Tipo de issue
- Error
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 30/100