JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

RecordNotFound should receive associated resource class

Abierto
#747 1 comentario 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

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

Descripción

The message from record not found only pass ID as attribute.
I think it would be better to pass the resource class as well so that we can have something like

 detail: I18n.translate('jsonapi-resources.exceptions.record_not_found.detail',
                                                   default: "The #{resource.name} identified by #{id} could not be found.", id: id, type: resource.class))]

Or maybe the associated activerecord class
This is the current implementation

 class RecordNotFound < Error
      attr_accessor :id
      def initialize(id)
        @id = id
      end

      def errors
        [JSONAPI::Error.new(code: JSONAPI::RECORD_NOT_FOUND,
                            status: :not_found,
                            title: I18n.translate('jsonapi-resources.exceptions.record_not_found.title',
                                                  default: 'Record not found'),
                            detail: I18n.translate('jsonapi-resources.exceptions.record_not_found.detail',
                                                   default: "The record identified by #{id} could not be found.", id: id))]
      end
    end

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 rastreando la clase RecordNotFound y sus llamadores, centrándote en la traducción del detalle de JSONAPI::Error y en la clave record_not_found de I18n mostrada en el issue. Determina si el error debe exponer la clase del recurso JSON:API o su clase ActiveRecord asociada y, a continuación, verifica que el mensaje de recurso no encontrado resultante incluya el contexto previsto del recurso y el ID.

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
3/5
Tiempo estimado
1-2 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.