fjordllc / fjordllc/bootcamp

提出物詳細APIでレビューに必要な情報を返す

Open
#9,999 1 comment 0 reactions 1 assignee Claimed by @mikan-v7y View on GitHub
3 新機能
Dominant language
Ruby
Stars
296
Forks
80
Avg merge
3d 1h
Merged PRs (30d)
29

Description

## 機能の説明

外部AIエージェントが提出物レビューを行えるように、提出物詳細APIのレスポンスを拡充する。

現状 `GET /api/products/:id.json` は存在するが、提出物本文 `body` が返っていない。またコメントは件数・最終コメント情報中心で、コメント本文一覧は別途 `GET /api/comments` を呼ぶ必要がある。

追加したい情報:

- 提出物本文 `body`
- practice の `id`, `title`, `description` などレビューに必要な情報
- コメント一覧(id, description, user, created_at, updated_at)
- チェック一覧(id, user, created_at)
- 担当メンター情報
- reaction / bookmark / watch など、既存UIで判断に使う情報があれば必要に応じて含める

## 何故この機能が必要なのか

pjord/hermes agent が提出物を読み、レビューコメントや確認処理を行うには、提出物本文と周辺コンテキストを機械処理しやすいJSONで取得できる必要がある。

現状の提出物APIは一覧表示向けの情報が中心で、レビュー判断に必要な本文・コメント履歴が不足している。

## 受け入れ条件

- `GET /api/products/:id.json` で提出物本文 `body` を取得できる
- 提出物に紐づくコメント本文一覧を取得できる
- 提出物に紐づくチェック情報を取得できる
- practice 情報をレビューに必要な粒度で取得できる
- 既存の提出物一覧APIの互換性を壊さない
- integration test で追加フィールドを確認する

## 関連コード

- `app/controllers/api/products_controller.rb`
- `app/views/api/products/show.json.jbuilder`
- `app/views/api/products/_product.json.jbuilder`
- `app/models/product.rb`
- `test/integration/api/products_test.rb`

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.