Frecuentemente publicamos actualizaciones de nuestra documentación. Es posible que la traducción de esta página esté en curso. Para conocer la información más actual, visita la documentación en inglés. Si existe un problema con las traducciones en esta página, por favor infórmanos.

Interacciones

En este artículo

¿Te ayudó este documento?

Los usuarios interactuan con los repositorios al comentar, abrir informes de problemas y crear solicitudes de extracción. Las API de interacciones permiten a las personas con acceso adminsitrativo o de propietario resgringir temporalmente a usuarios específicos de la interacción con los repositorios públicos.

Organización

La API de Interacciones de la Organización permite a los propietarios de las organizaciones restringir temporalmente qué usuarios pueden comentar, abrir informes de problemas, o crear solicitudes de extracción en los repositorios públicos de la organización. Cuando se habilitan las restricciones, solo el grupo de usuarios de GitHub que hayas especificado podrá participar en las interacciones. Las restricciones caducan 24 horas después de la hora en la que se configuraron. Aquí tienes más detalles sobre los grupos de usuarios de GitHub:

  • Usuarios existentes: Cuando limitas las interacciones a existing_users, se restringirá temporalmente a los usuarios nuevos con cuentas de menos de 24 horas que no hayan hecho contribuciones anteriormente y que no sean colaboradores en la organización.

  • Solo para contribuyentes: Cuando limitas las interacciones para contributors_only, se restringirá temporalmente a los usuarios que no hayan hecho contribuciones anteriormente y que no sean colaboradores en la organización.

  • Solo para colaboradores: Cuando limitas las interacciones para collaborators_only, se restringirá temporalmente a los usuarios que no sean colaboradores en la organización.

    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

    Parámetros

    Name Type In Description
    accept string header

    This API is under preview and subject to change.

    Ver aviso de previsualización.
    org string path

    Ejemplos de código

    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

    Aviso de previsualización

    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
    
    ☝️ El encabezado es requerido.

    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

    Parámetros

    Name Type In Description
    accept string header

    This API is under preview and subject to change.

    Ver aviso de previsualización.
    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.

    Ejemplos de código

    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

    Aviso de previsualización

    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
    
    ☝️ El encabezado es requerido.

    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

    Parámetros

    Name Type In Description
    accept string header

    This API is under preview and subject to change.

    Ver aviso de previsualización.
    org string path

    Ejemplos de código

    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

    Aviso de previsualización

    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
    
    ☝️ El encabezado es requerido.

Repositorio

La API de interacciones con el repositorio le permite a las personas con acceso administrativo o de propietario restringir temporalmente qué usuarios pueden comentar, abrir informes de problemas, o crear solicitudes de extracción en un repositorio público. Cuando se habilitan las restricciones, solo el grupo de usuarios de GitHub que hayas especificado podrá participar en las interacciones. Las restricciones caducan 24 horas después de la hora en la que se configuraron. Aquí tienes más detalles sobre los grupos de usuarios de GitHub:

  • Usuarios existentes: Cuando limitas las interacciones a existing_users, se restringirá temporalmente a los usuarios nuevos con cuentas de menos de 24 horas que no hayan hecho contribuciones anteriormente y que no sean colaboradores en el repositorio.
  • Solo para contribuyentes: Cuando limitas las interacciones para contributors_only, se restringirá temporalmente a los usuarios que no hayan hecho contribuciones anteriormente y que no sean colaboradores en el repositorio.
  • Solo para colaboradores: Cuando limitas las interacciones para collaborators_only, se restringirá temporalmente a los usuarios que no sean colaboradores en el repositorio.

Get interaction restrictions for a repository

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

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

Parámetros

Name Type In Description
accept string header

This API is under preview and subject to change.

Ver aviso de previsualización.
owner string path
repo string path

Ejemplos de código

Shell
curl \
  -H "Accept: application/vnd.github.sombra-preview+json" \
  https://api.github.com/repos/octocat/hello-world/interaction-limits
JavaScript (@octokit/core.js)
await octokit.request('GET /repos/{owner}/{repo}/interaction-limits', {
  owner: 'octocat',
  repo: 'hello-world',
  mediaType: {
    previews: [
      'sombra'
    ]
  }
})

Default response

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

Notes

Aviso de previsualización

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
☝️ El encabezado es requerido.

Set interaction restrictions for a repository

Temporarily restricts interactions to certain GitHub users within the given repository. You must have owner or admin access to set restrictions.

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

Parámetros

Name Type In Description
accept string header

This API is under preview and subject to change.

Ver aviso de previsualización.
owner string path
repo string path
limit string body

Required. Specifies the group of GitHub users who can comment, open issues, or create pull requests for the given repository. Must be one of: existing_users, contributors_only, or collaborators_only.

Ejemplos de código

Shell
curl \
  -X PUT \
  -H "Accept: application/vnd.github.sombra-preview+json" \
  https://api.github.com/repos/octocat/hello-world/interaction-limits \
  -d '{"limit":"limit"}'
JavaScript (@octokit/core.js)
await octokit.request('PUT /repos/{owner}/{repo}/interaction-limits', {
  owner: 'octocat',
  repo: 'hello-world',
  limit: 'limit',
  mediaType: {
    previews: [
      'sombra'
    ]
  }
})

Default response

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

Notes

Aviso de previsualización

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
☝️ El encabezado es requerido.

Remove interaction restrictions for a repository

Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions.

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

Parámetros

Name Type In Description
accept string header

This API is under preview and subject to change.

Ver aviso de previsualización.
owner string path
repo string path

Ejemplos de código

Shell
curl \
  -X DELETE \
  -H "Accept: application/vnd.github.sombra-preview+json" \
  https://api.github.com/repos/octocat/hello-world/interaction-limits
JavaScript (@octokit/core.js)
await octokit.request('DELETE /repos/{owner}/{repo}/interaction-limits', {
  owner: 'octocat',
  repo: 'hello-world',
  mediaType: {
    previews: [
      'sombra'
    ]
  }
})

Default Response

Status: 204 No Content

Notes

Aviso de previsualización

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
☝️ El encabezado es requerido.

¿Te ayudó este documento?