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

POST

/repos/{owner}/{repo}/pulls/{number}/article

既存のPullRequest情報を基に、Geminiを利用して差分を要約し、PullRequestArticleとして生成・保存します。PullRequestが存在しない場合は404エラーとなります。

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/repos/octocat/Hello-World/pulls/42/article'

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パラメータ

owner

string

必須

リポジトリのオーナー名

サンプル値:

octocat

repo

string

必須

リポジトリ名

サンプル値:

Hello-World

number

integer

必須

Pull Requestの番号

サンプル値:

Response

🟢200OK

application/json

Pull Request解説記事の生成・保存成功

Body

success

boolean

必須

サンプル値:

true

data

object (PullRequestArticle)

必須

Pull Request解説記事（多言語対応）

string <uuid>

必須

記事ID (UUID形式)

contents

object

可選

言語コードをキーとした記事内容のオブジェクト。記事がまだない場合はundefined。

createdAt

string <date-time> | null

可選

作成日時 (正しい日時形式)

updatedAt

string <date-time> | null

可選

更新日時 (正しい日時形式)

message

string | null

可選

🟢202承認済み

🟠401権限なし

🟠404レコードが存在しない

🔴500サーバーエラー

更新日時 2025-06-07 20:59:46

データベースにキャッシュされたPull Request本体を取得

生成済みのPull Request解説記事を取得