互动

用户通过评论、开设议题和创建拉取请求与仓库进行交互。 交互 API 允许具有所有者或管理员权限的用户临时限制某些用户与公共仓库交互。

组织

组织交互 API 允许组织所有者临时限制哪些用户可以在组织的公共仓库中发表评论、开设议题或创建拉取请求。 When restrictions are enabled, only the specified group of GitHub users will be able to participate in interactions. Restrictions expire 24 hours from the time they are set. 以下是有关 GitHub 用户组的更多信息：

• 组织中的 Existing users: When you limit interactions to existing_users, new users with accounts less than 24 hours old who have not previously contributed and are not collaborators will be temporarily restricted。

• 组织中的 Contributors only: When you limit interactions to contributors_only, users who have not previously contributed and are not collaborators will be temporarily restricted。

• 组织中的 Collaborators only: When you limit interactions to collaborators_only, users who are not collaborators will be temporarily restricted。

  Get interaction restrictions for an organization

  Shows which group of GitHub users can interact with this organization and when the restriction expires. If there are no restrictions, you will see an empty response.

  get /orgs/{org}/interaction-limits

  参数

  Name	Type	In	Description
  accept	string	header	This API is under preview and subject to change. 查看预览通知.
  org	string	path

  代码示例

  Shell

  curl \
    -H "Accept: application/vnd.github.sombra-preview+json" \
    https://api.github.com/orgs/ORG/interaction-limits
  

  JavaScript (@octokit/core.js)

  await octokit.request('GET /orgs/{org}/interaction-limits', {
    org: 'org',
    mediaType: {
      previews: [
        'sombra'
      ]
    }
  })
  

  Default response

  Status: 200 OK

  {
    "limit": "collaborators_only",
    "origin": "organization",
    "expires_at": "2018-08-17T04:18:39Z"
  }
  

  Notes

  • Works with GitHub Apps

  预览通知

  The Interactions API is currently in public preview. See the blog post preview for more details. To access the API during the preview period, you must provide a custom media type in the Accept header:

  application/vnd.github.sombra-preview
  

  ☝️ 此标头必填.

  ---

  Set interaction restrictions for an organization

  Temporarily restricts interactions to certain GitHub users in any public repository in the given organization. You must be an organization owner to set these restrictions.

  put /orgs/{org}/interaction-limits

  参数

  Name	Type	In	Description
  accept	string	header	This API is under preview and subject to change. 查看预览通知.
  org	string	path
  limit	string	body	Required. Specifies the group of GitHub users who can comment, open issues, or create pull requests in public repositories for the given organization. Must be one of: existing_users, contributors_only, or collaborators_only.

  代码示例

  Shell

  curl \
    -X PUT \
    -H "Accept: application/vnd.github.sombra-preview+json" \
    https://api.github.com/orgs/ORG/interaction-limits \
    -d '{"limit":"limit"}'
  

  JavaScript (@octokit/core.js)

  await octokit.request('PUT /orgs/{org}/interaction-limits', {
    org: 'org',
    limit: 'limit',
    mediaType: {
      previews: [
        'sombra'
      ]
    }
  })
  

  Default response

  Status: 200 OK

  {
    "limit": "collaborators_only",
    "origin": "organization",
    "expires_at": "2018-08-17T04:18:39Z"
  }
  

  Notes

  • Works with GitHub Apps

  预览通知

  The Interactions API is currently in public preview. See the blog post preview for more details. To access the API during the preview period, you must provide a custom media type in the Accept header:

  application/vnd.github.sombra-preview
  

  ☝️ 此标头必填.

  ---

  Remove interaction restrictions for an organization

  Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.

  delete /orgs/{org}/interaction-limits

  参数

  Name	Type	In	Description
  accept	string	header	This API is under preview and subject to change. 查看预览通知.
  org	string	path

  代码示例

  Shell

  curl \
    -X DELETE \
    -H "Accept: application/vnd.github.sombra-preview+json" \
    https://api.github.com/orgs/ORG/interaction-limits
  

  JavaScript (@octokit/core.js)

  await octokit.request('DELETE /orgs/{org}/interaction-limits', {
    org: 'org',
    mediaType: {
      previews: [
        'sombra'
      ]
    }
  })
  

  Default Response

  Status: 204 No Content

  Notes

  • Works with GitHub Apps

  预览通知

  The Interactions API is currently in public preview. See the blog post preview for more details. To access the API during the preview period, you must provide a custom media type in the Accept header:

  application/vnd.github.sombra-preview
  

  ☝️ 此标头必填.

  ---

仓库

仓库交互 API 允许具有所有者或管理员权限的用户临时限制哪些用户可以在公共存储库中发表评论、开设议题或创建拉取请求。 When restrictions are enabled, only the specified group of GitHub users will be able to participate in interactions. Restrictions expire 24 hours from the time they are set. 以下是有关 GitHub 用户组的更多信息：

• 仓库中的 Existing users: When you limit interactions to existing_users, new users with accounts less than 24 hours old who have not previously contributed and are not collaborators will be temporarily restricted。
• 仓库中的 Contributors only: When you limit interactions to contributors_only, users who have not previously contributed and are not collaborators will be temporarily restricted。
• 仓库中的 Collaborators only: When you limit interactions to collaborators_only, users who are not collaborators will be temporarily restricted。

get /repos/{owner}/{repo}/interaction-limits

curl \
  -H "Accept: application/vnd.github.sombra-preview+json" \
  https://api.github.com/repos/octocat/hello-world/interaction-limits

await octokit.request('GET /repos/{owner}/{repo}/interaction-limits', {
  owner: 'octocat',
  repo: 'hello-world',
  mediaType: {
    previews: [
      'sombra'
    ]
  }
})

Status: 200 OK

{
  "limit": "collaborators_only",
  "origin": "repository",
  "expires_at": "2018-08-17T04:18:39Z"
}

application/vnd.github.sombra-preview

put /repos/{owner}/{repo}/interaction-limits

curl \
  -X PUT \
  -H "Accept: application/vnd.github.sombra-preview+json" \
  https://api.github.com/repos/octocat/hello-world/interaction-limits \
  -d '{"limit":"limit"}'

await octokit.request('PUT /repos/{owner}/{repo}/interaction-limits', {
  owner: 'octocat',
  repo: 'hello-world',
  limit: 'limit',
  mediaType: {
    previews: [
      'sombra'
    ]
  }
})

Status: 200 OK

{
  "limit": "collaborators_only",
  "origin": "repository",
  "expires_at": "2018-08-17T04:18:39Z"
}

application/vnd.github.sombra-preview

delete /repos/{owner}/{repo}/interaction-limits

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.sombra-preview+json" \
  https://api.github.com/repos/octocat/hello-world/interaction-limits

await octokit.request('DELETE /repos/{owner}/{repo}/interaction-limits', {
  owner: 'octocat',
  repo: 'hello-world',
  mediaType: {
    previews: [
      'sombra'
    ]
  }
})

Status: 204 No Content

application/vnd.github.sombra-preview