JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources
Default fields resource option
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
Add an option to the resource class to specify the default fields. Would be used by the request parser if the fields are not specified. Would allow a pared down fields set as the default, while still allowing the full field set if requested.
For example:
class CommentResource < JSONAPI::Resource
attributes :body
has_one :post
has_one :author, class_name: 'Person'
has_many :tags
filters :body
default_fields [:body, :post, :author]
end
Would skip the tags relationship, unless specified in the request.
Comments?
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
Empieza localizando el manejo de opciones de la clase de recursos y el analizador de solicitudes mencionado en el issue. Sigue cómo se seleccionan los campos y las relaciones solicitados y, después, determina cómo debería aplicarse una lista predeterminada solo cuando no haya campos. El trabajo estará terminado cuando los recursos puedan declarar campos predeterminados, las relaciones omitidas queden excluidas de forma predeterminada y los campos solicitados explícitamente sigan funcionando.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- rails, ruby
- Área
- api, backend
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100