PRnews
  1. Article Generation
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. Article Generation

指定されたPull Requestの解説記事をAIで生成・保存

POST
/repos/{owner}/{repo}/pulls/{number}/article
既存のPullRequest情報を基に、Geminiを利用して差分を要約し、PullRequestArticleとして生成・保存します。PullRequestが存在しない場合は404エラーとなります。
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/repos/octocat/Hello-World/pulls/42/article'
Response Response Example
200 - 成功例
{
    "success": true,
    "data": {
        "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
        "prNumber": 42,
        "repositoryFullName": "acme/widgets",
        "githubPrUrl": "https://github.com/acme/widgets/pull/42",
        "title": "feat: add new widget",
        "authorLogin": "alice",
        "githubPrCreatedAt": "2025-06-04T12:34:56Z",
        "aiGeneratedTitle": "✨ 新しいウィジェット機能の追加",
        "summaryGeneratedAt": "2025-06-04T13:00:00Z"
    }
}

Requestパラメータ

Authorization
Headerにパラメータ
Authorization
を追加し、その値にはBearerの後にTokenを連結します
例:
Authorization: Bearer ********************
Pathパラメータ

Response

🟢200OK
application/json
Pull Request解説記事の生成・保存成功
Body

🟢202承認済み
🟠401権限なし
🟠404レコードが存在しない
🔴500サーバーエラー
更新日時 2025-06-07 20:59:46
前へ
データベースにキャッシュされたPull Request本体を取得
次へ
生成済みのPull Request解説記事を取得
Built with