JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

Issue with `fields` request params

Abierto
#282 7 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Type: Bug
Lenguaje dominante
Ruby
Estrellas
2.3k
Forks
546
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

As I'm playing with the Sparse Fieldsets, I encountered some issues.

With the following resources:

class UserResource < JSONAPI::Resource
  has_one :status, class_name: 'UserStatus'
  attributes :name, :email
end
class UserStatusResource < JSONAPI::Resource
  has_one :user
  attributes :foo, :bar
end

Relationships are removed from then response when using fields, so we can't link a user to his status.

/users?include=status&fields[users]=name

Association with custom class_name failed with fields.

/users?include=status&fields[users]=name&fields[user-statuses]=foo

returns:

{:errors=>
  [{:title=>"Invalid resource",
    :detail=>"user-statuses is not a valid resource.",
    :id=>nil,
    :href=>nil,
    :code=>101,
    :path=>nil,
    :links=>nil,
    :status=>"bad_request"},
   {:title=>"Invalid resource",
    :detail=>"user-statuses is not a valid resource.",
    :id=>nil,
    :href=>nil,
    :code=>101,
    :path=>nil,
    :links=>nil,
    :status=>"bad_request"}]}

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza con los ejemplos de UserResource y UserStatusResource y reproduce las dos solicitudes usando include=status y los parámetros fields. Rastrea el manejo de sparse fieldsets para las relaciones y la clave de recurso personalizada class_name. Se considera terminado cuando la relación sigue siendo enlazable y user-statuses se acepta sin los errores de recurso no válido indicados.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
ruby
Área
api
Tipo de issue
Error
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.