Skip to content
このページは AI の支援により作成・翻訳されました。誤りがあれば、改善にご協力ください。 GitHub で編集

イシューと追跡

イシュー(ワークアイテムとも呼ばれる)はOpenPRのコアの作業単位です。プロジェクト内のタスク、バグ、機能、または追跡可能な作業を表します。

イシューフィールド

フィールドタイプ必須説明
タイトルstringはい作業の短い説明
説明markdownいいえフォーマット付きの詳細説明
状態enumはいワークフロー状態(ワークフローを参照)
優先度enumいいえlowmediumhighurgent
担当者userいいえイシューを担当するチームメンバー
ラベルlistいいえ分類タグ(ラベルを参照)
スプリントsprintいいえイシューが属するスプリントサイクル
期日datetimeいいえ目標完了日
添付ファイルfilesいいえ添付ファイル(画像、ドキュメント、ログ)

イシュー識別子

各イシューにはプロジェクトキーと連番で構成される人間が読める識別子があります:

API-1, API-2, API-3, ...
FRONT-1, FRONT-2, ...

ワークスペース内のすべてのプロジェクト横断でイシューを識別子で検索できます。

イシューの作成

Web UIから

  1. プロジェクトに移動。
  2. **New Issue(新規イシュー)**をクリック。
  3. タイトル、説明、オプションフィールドを入力。
  4. **Create(作成)**をクリック。

REST APIから

bash
curl -X POST http://localhost:8080/api/projects/<project_id>/issues \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token>" \
  -d '{
    "title": "Implement user settings page",
    "description": "Add a settings page where users can update their profile.",
    "state": "todo",
    "priority": "medium",
    "assignee_id": "<user_uuid>"
  }'

MCPから

json
{
  "method": "tools/call",
  "params": {
    "name": "work_items.create",
    "arguments": {
      "project_id": "<project_uuid>",
      "title": "Implement user settings page",
      "state": "todo",
      "priority": "medium"
    }
  }
}

コメント

イシューはMarkdownフォーマットとファイル添付付きのスレッドコメントをサポートします:

bash
# Add a comment
curl -X POST http://localhost:8080/api/issues/<issue_id>/comments \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token>" \
  -d '{"content": "Fixed in commit abc123. Ready for review."}'

コメントはMCPツールでも利用可能です:comments.createcomments.listcomments.delete

アクティビティフィード

イシューへのすべての変更はアクティビティフィードに記録されます:

  • 状態の変更
  • 担当者の変更
  • ラベルの追加/削除
  • コメント
  • 優先度の更新

アクティビティフィードは各イシューの完全な監査証跡を提供します。

ファイル添付

イシューとコメントは画像、ドキュメント、ログ、アーカイブを含むファイル添付をサポートします。APIでアップロード:

bash
curl -X POST http://localhost:8080/api/v1/upload \
  -H "Authorization: Bearer <token>" \
  -F "[email protected]"

またはMCPで:

json
{
  "method": "tools/call",
  "params": {
    "name": "files.upload",
    "arguments": {
      "filename": "screenshot.png",
      "content_base64": "<base64_encoded_content>"
    }
  }
}

サポートされているファイルタイプ:画像(PNG、JPG、GIF、WebP)、ドキュメント(PDF、TXT)、データ(JSON、CSV、XML)、アーカイブ(ZIP、GZ)、ログ。

検索

OpenPRはPostgreSQL FTSを使用して全イシュー、コメント、提案のフルテキスト検索を提供します:

bash
# Search via API
curl -H "Authorization: Bearer <token>" \
  "http://localhost:8080/api/search?q=authentication+bug"

# Search via MCP
# work_items.search: search within a project
# search.all: global search across all projects

MCPツール

ツールパラメータ説明
work_items.listproject_idプロジェクト内のイシューをリスト
work_items.getwork_item_idUUIDでイシューを取得
work_items.get_by_identifieridentifier人間IDで取得(例:API-42
work_items.createproject_id, titleイシューを作成
work_items.updatework_item_id任意のフィールドを更新
work_items.deletework_item_idイシューを削除
work_items.searchqueryフルテキスト検索
comments.creatework_item_id, contentコメントを追加
comments.listwork_item_idコメントをリスト
comments.deletecomment_idコメントを削除
files.uploadfilename, content_base64ファイルをアップロード

次のステップ

Released under the Apache-2.0 License.