sillsdev / sillsdev/interlinearizer-extension

Add service/API for querying the analyses

Open
#128 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
2
Forks
0
Avg merge
1d 17h
Merged PRs (30d)
55

Description

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

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the internal analysis suggestion and compare its flat-list access with the network-object pattern used by lexicon.entryService. Resolve the contract checklist decisions for schemas, payloads, enum validation, query shapes, and read-only behavior. Done means a defined public API that other extensions can query and that the internal suggestion can use.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.