Add service/API for querying the analyses

オープン
#128 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
静か
技術スタック
typescript

調査の方向性

内部分析の提案から始め、フラットリストへのアクセスと lexicon.entryService で使用されているネットワークオブジェクトパターンを比較します。スキーマ、ペイロード、enum の検証、クエリ形式、読み取り専用の動作について、コントラクトチェックリストの決定事項を確定します。他の拡張機能からクエリでき、内部の提案からも利用できる、定義済みの公開 API が完成条件です。

索引モデルが issue の本文から書いたものです。

説明

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

主要言語
TypeScript
スター
2
フォーク
0
平均マージ
1日 1時間
マージ済み PR(30日)
105

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

sillsdev/interlinearizer-extension のほかの issue

sillsdev/interlinearizer-extension の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。