Skip to content

docs: 仕様ドキュメントを実装に追従(整合性監査の反映)#4

Merged
kentalow merged 2 commits into
mainfrom
docs/sync-spec-with-impl
Jun 20, 2026
Merged

docs: 仕様ドキュメントを実装に追従(整合性監査の反映)#4
kentalow merged 2 commits into
mainfrom
docs/sync-spec-with-impl

Conversation

@kentalow

Copy link
Copy Markdown
Member

概要

docs/ と実装の整合性監査(API / DB / CSV・Excel / Web UI / CLI の全領域)で見つかったドキュメントの追従漏れを修正します。コード変更はありません(実装が正でドキュメントが古いものを doc 側で修正、未実装項目は conformance backlog に登録)。

DB スキーマ・CSV/Excel/import-logic・architecture・data-model は監査の結果ほぼ完全一致でした。

修正内容

API

  • api-spec.md: 未定義サブパスの 404 / 500 の imsx_StatusInfo 変換が未実装である旨を明記(既存記述は「返す」だったが実装は FastAPI 既定応答)。あわせて conformance backlog に C14 / C15 として登録。実装済みのエラー形式(400 / 既知リソースの 404 unknownobject / 405)も整理。
  • api-examples.md: rubric の weight / score を整数表記(1 / 5)に修正(実装は整数値を int 化=OpenCASE round-trip parity)。エラー例の imsx_codeMinorFieldNamesourcedId に修正(実装は常に固定。api-spec 内部とも矛盾していた)。500 例に「未実装・目標形(C15)」の注記を追加。

Web UI(web-ui.md)

  • 逆参照「参照元(他機関)」セクションを追記(今回実装した機能が未文書だった。public 限定・private 完全除外の挙動を含む)。
  • <html lang> を「ja 固定」→「リクエスト言語(Accept-Language、既定 en)」に修正(実装に追従)。
  • フレームワーク一覧にルーブリック数列を追記。
  • /uri/ パンくずを実装どおり3段(所属ドキュメントへのリンク)に修正。

CLI(cli.md)

  • tenant update の必須オプションエラー文言に --display-order / --clear-order を追加。
  • export case の「GET と byte 同一」表現を修正(同一ペイロードだが CLI は整形・API は compact)。

英語/日本語の両セクションを揃えて修正しています。

🤖 Generated with Claude Code

kentalow and others added 2 commits June 20, 2026 13:24
実装とドキュメントの整合性監査で見つかった追従漏れを修正。コード変更なし
(実装が正・docが古いものを doc 側で修正、および未実装項目をバックログ化)。

API:
- api-spec: 未定義サブパスの 404 / 500 の imsx 変換が未実装である旨を明記し、
  conformance backlog C14 / C15 として新規追加(実装済みのエラー形式も整理)
- api-examples: rubric の weight/score を整数表記に修正(実装は整数値を int 化)、
  エラー例の imsx_codeMinorFieldName を sourcedId に修正(実装は常に固定)、
  500 例に「未実装・目標形」の注記を追加

Web UI (web-ui.md):
- 逆参照「参照元(他機関)」セクションを追記(public 限定・private 除外の挙動含む)
- <html lang> を「ja 固定」から「リクエスト言語(Accept-Language、既定 en)」に修正
- フレームワーク一覧にルーブリック数列を追記
- /uri/ パンくずを実装どおり3段(所属ドキュメントへのリンク)に修正

CLI (cli.md):
- tenant update の必須オプションエラー文言に --display-order / --clear-order を追加
- export case の出力説明を修正(GET と同一ペイロード、CLI は整形・API は compact)

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XXFogp18twGiPFBAZcqJw2
@kentalow kentalow merged commit 629434d into main Jun 20, 2026
2 checks passed
@kentalow kentalow deleted the docs/sync-spec-with-impl branch June 20, 2026 04:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant