JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources
Documentation for ResourceSerializer with includes is incorrect
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
This issue is a (choose one):
- Problem/bug report.
- Feature request.
- Request for support. Note: Please try to avoid submitting issues for support requests. Use Gitter instead.
Checklist before submitting:
- I've searched for an existing issue.
- I've asked my question on Gitter and have not received a satisfactory answer. NOTE - I tried to ask in Gitter but it sends me in an infinite redirect loop when I try to sign in.
- I've included a complete bug report template. This step helps us and allows us to see the bug without trying to reproduce the problem from your description. It helps you because you will frequently detect if it's a problem specific to your project. NOTE - I attempted to create a complete bug report, but I'm not sure how to use the template, and can't seem to find documentation about how it's supposed to be used and my best guess of running
ruby rails_5_master.rbdoesn't seem to work. - The feature I'm asking for is compliant with the JSON:API spec.
Description
Choose one section below and delete the other:
Bug reports:
The documentation says that ResourceSerailizer should be able to include resources by doing something like this:
post = Post.find(1)
JSONAPI::ResourceSerializer.new(PostResource,
include: ['comments'],
).serialize_to_hash(PostResource.new(post, nil))
But when I do this I don't get an included section in the serialized output.
Additionally I don't find any tests in the test suite that demonstrate the documented way of doing it, but I find several tests that seem to achieve includes via much more verbose and laborious methods.
Am I missing something?
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 con la sección include de la guía del serializer v0.10 y compara su ejemplo con test/unit/serializer/serializer_test.rb alrededor de las líneas 205-226. Reproduce la llamada documentada a ResourceSerializer y determina después si la documentación o el comportamiento del serializer son incorrectos. Se considera terminado cuando el flujo de trabajo documentado de include es correcto y está cubierto por una prueba específica.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- ruby
- Área
- documentation
- Tipo de issue
- Error
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100