PRnews
  1. Pull Request
PRnews
  • General
    • ヘルスチェック
      GET
  • User & Auth
    • 現在のユーザー情報を取得
      GET
    • ログアウト処理
      POST
    • ユーザーサインアップ
      POST
    • 自分が「いいね」した記事の一覧を取得
      GET
    • GitHubアクセストークンを保存
      POST
  • Pull Request
    • GitHubから指定されたPull Request情報を取得・保存
      POST
    • データベースにキャッシュされたPull Request本体を取得
      GET
  • Article Generation
    • 指定されたPull Requestの解説記事をAIで生成・保存
      POST
    • 生成済みのPull Request解説記事を取得
      GET
  • Favorites
    • お気に入りリポジトリを登録
      POST
  • Likes
    • 記事に「いいね」を付ける
      POST
    • 記事の「いいね」を取り消す
      DELETE
  • Ranking
    • いいね数に基づいた記事ランキングを取得
      GET
  1. Pull Request

GitHubから指定されたPull Request情報を取得・保存

POST
/repos/{owner}/{repo}/pulls/{number}/ingest
GitHub APIを利用してPull Requestのメタデータ、差分、コメントなどを取得し、データベースにPullRequestとして保存(既に存在する場合は更新)します。
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/repos/octocat/Hello-World/pulls/42/ingest'
Response Response Example
200 - 成功例
{
    "success": true,
    "data": {
        "prNumber": 42,
        "repositoryFullName": "acme/widgets",
        "githubPrUrl": "https://github.com/acme/widgets/pull/42",
        "title": "feat: add new widget",
        "body": "This PR adds a new widget to the application.",
        "diff": "...",
        "authorLogin": "alice",
        "githubPrCreatedAt": "2025-06-04T12:34:56Z"
    }
}

Requestパラメータ

Authorization
Headerにパラメータ
Authorization
を追加し、その値にはBearerの後にTokenを連結します
例:
Authorization: Bearer ********************
Pathパラメータ
owner
string 
必須
リポジトリのオーナー名
サンプル値:
octocat
repo
string 
必須
リポジトリ名
サンプル値:
Hello-World
number
integer 
必須
Pull Requestの番号
サンプル値:
42

Response

🟢200OK
application/json
Pull Request情報の取得・保存成功
Body
success
boolean 
必須
サンプル値:
true
data
object (PullRequest) 
必須
Pull Requestの基本情報を表すスキーマ
prNumber
integer 
必須
PR 番号 (整数、正の数)
>= 1
repositoryFullName
string 
必須
リポジトリのフルネーム (例: 'owner/repo')
githubPrUrl
string <url>
必須
GitHub上のPRのURL (正しいURL形式)
title
string 
必須
PRのタイトル
body
string  | null 
可選
PRの本文
diff
string 
必須
PRの差分情報
authorLogin
string 
必須
PR作成者のGitHubログイン名
githubPrCreatedAt
string <date-time>
必須
GitHub上でのPR作成日時 (正しい日時形式)
message
string  | null 
可選
🟠401権限なし
🟠404レコードが存在しない
🔴500サーバーエラー
更新日時 2025-06-07 20:59:46
前へ
GitHubアクセストークンを保存
次へ
データベースにキャッシュされたPull Request本体を取得
Built with