Комментарии фиксации

Используйте REST API для взаимодействия с комментариями фиксации.

Сведения о комментариях к фиксации

Вы можете создавать, изменять и просматривать комментарии фиксации с помощью REST API. Комментарий фиксации — это комментарий, сделанный для определенной фиксации. Дополнительные сведения см. в разделе Работа с комментариями.

Пользовательские типы мультимедиа для комментариев фиксации

Это поддерживаемые типы мультимедиа для комментариев фиксации. Дополнительные сведения об использовании типов мультимедиа в API см. здесь.

application/vnd.github-commitcomment.raw+json
application/vnd.github-commitcomment.text+json
application/vnd.github-commitcomment.html+json
application/vnd.github-commitcomment.full+json

Дополнительные сведения см. в статье Пользовательские типы фиксации.

List commit comments for a repository

Работа с GitHub Apps

Commit Comments use these custom media types. You can read more about the use of media types in the API here.

Comments are ordered by ascending ID.

Параметры

Заголовки
Имя, Тип, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`owner`stringОбязательно The account owner of the repository. The name is not case sensitive.
`repo`stringОбязательно The name of the repository. The name is not case sensitive.
Параметры запроса
Имя, Тип, Описание
`per_page`integer The number of results per page (max 100). Значение по умолчанию: `30`
`page`integer Page number of the results to fetch. Значение по умолчанию: `1`

Коды состояния HTTP-ответа

Код состояния	Описание
`200`	OK

Примеры кода

get/repos/{owner}/{repo}/comments

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/comments

Response

Status: 200

[
  {
    "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1",
    "url": "https://api.github.com/repos/octocat/Hello-World/comments/1",
    "id": 1,
    "node_id": "MDEzOkNvbW1pdENvbW1lbnQx",
    "body": "Great stuff",
    "path": "file1.txt",
    "position": 4,
    "line": 14,
    "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
    "user": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "created_at": "2011-04-14T16:00:49Z",
    "updated_at": "2011-04-14T16:00:49Z",
    "author_association": "COLLABORATOR"
  }
]

Get a commit comment

Работа с GitHub Apps

Параметры

Заголовки
Имя, Тип, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`owner`stringОбязательно The account owner of the repository. The name is not case sensitive.
`repo`stringОбязательно The name of the repository. The name is not case sensitive.
`comment_id`integerОбязательно The unique identifier of the comment.

Коды состояния HTTP-ответа

Код состояния	Описание
`200`	OK
`404`	Resource not found

Примеры кода

get/repos/{owner}/{repo}/comments/{comment_id}

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/comments/COMMENT_ID

Response

Status: 200

{
  "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1",
  "url": "https://api.github.com/repos/octocat/Hello-World/comments/1",
  "id": 1,
  "node_id": "MDEzOkNvbW1pdENvbW1lbnQx",
  "body": "Great stuff",
  "path": "file1.txt",
  "position": 4,
  "line": 14,
  "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
  "author_association": "COLLABORATOR",
  "user": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  },
  "created_at": "2011-04-14T16:00:49Z",
  "updated_at": "2011-04-14T16:00:49Z"
}

Update a commit comment

Работа с GitHub Apps

Параметры

Заголовки
Имя, Тип, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`owner`stringОбязательно The account owner of the repository. The name is not case sensitive.
`repo`stringОбязательно The name of the repository. The name is not case sensitive.
`comment_id`integerОбязательно The unique identifier of the comment.
Параметры запроса
Имя, Тип, Описание
`body`stringОбязательно The contents of the comment

Коды состояния HTTP-ответа

Код состояния	Описание
`200`	OK
`404`	Resource not found

Примеры кода

patch/repos/{owner}/{repo}/comments/{comment_id}

curl \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/comments/COMMENT_ID \
  -d '{"body":"Nice change"}'

Response

Status: 200

{
  "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1",
  "url": "https://api.github.com/repos/octocat/Hello-World/comments/1",
  "id": 1,
  "node_id": "MDEzOkNvbW1pdENvbW1lbnQx",
  "body": "Nice change",
  "path": "file1.txt",
  "position": 4,
  "line": 14,
  "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
  "author_association": "COLLABORATOR",
  "user": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  },
  "created_at": "2011-04-14T16:00:49Z",
  "updated_at": "2011-04-14T16:00:49Z"
}

Delete a commit comment

Работа с GitHub Apps

Параметры

Заголовки
Имя, Тип, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`owner`stringОбязательно The account owner of the repository. The name is not case sensitive.
`repo`stringОбязательно The name of the repository. The name is not case sensitive.
`comment_id`integerОбязательно The unique identifier of the comment.

Коды состояния HTTP-ответа

Код состояния	Описание
`204`	No Content
`404`	Resource not found

Примеры кода

delete/repos/{owner}/{repo}/comments/{comment_id}

curl \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/comments/COMMENT_ID

Response

Status: 204

List commit comments

Работа с GitHub Apps

Use the :commit_sha to specify the commit that will have its comments listed.

Параметры

Заголовки
Имя, Тип, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`owner`stringОбязательно The account owner of the repository. The name is not case sensitive.
`repo`stringОбязательно The name of the repository. The name is not case sensitive.
`commit_sha`stringОбязательно The SHA of the commit.
Параметры запроса
Имя, Тип, Описание
`per_page`integer The number of results per page (max 100). Значение по умолчанию: `30`
`page`integer Page number of the results to fetch. Значение по умолчанию: `1`

Коды состояния HTTP-ответа

Код состояния	Описание
`200`	OK

Примеры кода

get/repos/{owner}/{repo}/commits/{commit_sha}/comments

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/commits/COMMIT_SHA/comments

Response

Status: 200

[
  {
    "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1",
    "url": "https://api.github.com/repos/octocat/Hello-World/comments/1",
    "id": 1,
    "node_id": "MDEzOkNvbW1pdENvbW1lbnQx",
    "body": "Great stuff",
    "path": "file1.txt",
    "position": 4,
    "line": 14,
    "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
    "user": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    },
    "created_at": "2011-04-14T16:00:49Z",
    "updated_at": "2011-04-14T16:00:49Z",
    "author_association": "COLLABORATOR"
  }
]

Create a commit comment

Работа с GitHub Apps

Create a comment for a commit using its :commit_sha.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See "Secondary rate limits" and "Dealing with secondary rate limits" for details.

Параметры

Заголовки
Имя, Тип, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`owner`stringОбязательно The account owner of the repository. The name is not case sensitive.
`repo`stringОбязательно The name of the repository. The name is not case sensitive.
`commit_sha`stringОбязательно The SHA of the commit.
Параметры запроса
Имя, Тип, Описание
`body`stringОбязательно The contents of the comment.
`path`string Relative path of the file to comment on.
`position`integer Line index in the diff to comment on.
`line`integer Deprecated. Use position parameter instead. Line number in the file to comment on.

Коды состояния HTTP-ответа

Код состояния	Описание
`201`	Created
`403`	Forbidden
`422`	Validation failed, or the endpoint has been spammed.

Примеры кода

post/repos/{owner}/{repo}/commits/{commit_sha}/comments

curl \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/commits/COMMIT_SHA/comments \
  -d '{"body":"Great stuff","path":"file1.txt","position":4,"line":1}'

Response

Status: 201

{
  "html_url": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1",
  "url": "https://api.github.com/repos/octocat/Hello-World/comments/1",
  "id": 1,
  "node_id": "MDEzOkNvbW1pdENvbW1lbnQx",
  "body": "Great stuff",
  "path": "file1.txt",
  "position": 4,
  "line": 14,
  "commit_id": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
  "author_association": "COLLABORATOR",
  "user": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  },
  "created_at": "2011-04-14T16:00:49Z",
  "updated_at": "2011-04-14T16:00:49Z"
}