Add service/API for querying the analyses

Abierto
#128 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Tranquilo
Stack tecnológico
typescript

Línea de trabajo

Comienza con la sugerencia del análisis interno y compara su acceso a una lista plana con el patrón de objetos de red utilizado por lexicon.entryService. Resuelve las decisiones de la lista de comprobación del contrato sobre esquemas, payloads, validación de enums, formas de consulta y comportamiento de solo lectura. Se considera completado cuando exista una API pública definida que otras extensiones puedan consultar y que la sugerencia interna pueda utilizar.

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

Descripción

Our analysis suggestion can interact directly on the flat analyses lists in a project, but we want to expose those to other extensions. Once we have a defined API for querying the analyses, the internal analysis suggestion should use it too.

Contract checklist (2026-07 audit): before the API is public:

  • #137: schema version on persisted/returned records.
  • Decide typed payloads vs. JSON strings over the command bus (all current commands pass JSON strings; a network-object service like lexicon.entryService would give typed signatures).
  • Validate enum values (Confidence, AssignmentStatus) at the boundary (#140).
  • Define query shape: by token ref(s), by surface form (normalized — the suggestion pool's normalization should be part of the contract), by book, by status.
  • Read-only first; mutation API is a separate decision.

Size: M

Lenguaje dominante
TypeScript
Estrellas
2
Forks
0
Merge medio
1 d 8 h
PR fusionados (30 d)
85

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

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.

Más de sillsdev/interlinearizer-extension

Todos los issues de sillsdev/interlinearizer-extension

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.