Github Connections - Update

Serviço:
Work Item Tracking
Versão da API:
7.2-preview.1

Adicionar/remover lista de repositórios na conexão do github especificada.

POST https://dev.azure.com/{organization}/{project}/_apis/githubconnections/{connectionId}/reposBatch?api-version=7.2-preview.1

Parâmetros de URI

Nome Em Obrigatório Tipo Description
connectionId
 path True

string (uuid)

organization
 path True

string

O nome da organização do Azure DevOps.
project
 path True

string

ID do projeto ou nome do projeto
api-version
 query True

string

Versão da API a ser usada. Isso deve ser definido como '7.2-preview.1' para usar essa versão da api.

Corpo da solicitação

Nome Tipo Description
gitHubRepositoryUrls

GitHubConnectionRepoModel[]

URLs de repositórios solicitados
gitHubUserToken

string

Token de acesso GitHub opcional usado para autenticar o provisionamento para as operações de adição e remoção. Adicionar também requer acesso de administrador aos repositórios.
operationType

string

Tipo de operação (por exemplo, adicionar, remover)

Respostas

Nome Tipo Description
200 OK

GitHubConnectionRepoModel[]

operação bem-sucedida

Segurança

oauth2

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL do Token: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Escopos

Nome Description
vso.githubconnections_manage Concede a capacidade de ler e gerenciar conexões github e dados de repositórios github

Exemplos

Add list of repos to the specified github connection
Remove list of repos from the specified github connection

Add list of repos to the specified github connection

Solicitação de exemplo

POST https://dev.azure.com/{organization}/{project}/_apis/githubconnections/{connectionId}/reposBatch?api-version=7.2-preview.1

{
  "gitHubRepositoryUrls": [
    {
      "gitHubRepositoryUrl": "https://github.com/test-account/repo1"
    },
    {
      "gitHubRepositoryUrl": "https://github.com/test-account/repo2"
    },
    {
      "gitHubRepositoryUrl": "https://github.com/test-account/repo3"
    },
    {
      "gitHubRepositoryUrl": "https://github.com/test-account/repo399"
    }
  ],
  "operationType": "add"
}

Resposta de exemplo

Código de status:
200 
{
  "count": 4,
  "value": [
    {
      "gitHubRepositoryUrl": "https://github.com/test-account/repo3"
    },
    {
      "gitHubRepositoryUrl": "https://github.com/test-account/repo2"
    },
    {
      "gitHubRepositoryUrl": "https://github.com/test-account/repo1",
      "errorMessage": "Failed to find repository"
    },
    {
      "gitHubRepositoryUrl": "https://github.com/test-account/repo399",
      "errorMessage": "Failed to find repository"
    }
  ]
}

Remove list of repos from the specified github connection

Solicitação de exemplo

POST https://dev.azure.com/{organization}/{project}/_apis/githubconnections/{connectionId}/reposBatch?api-version=7.2-preview.1

{
  "gitHubRepositoryUrls": [
    {
      "gitHubRepositoryUrl": "https://github.com/test-account/repo1"
    },
    {
      "gitHubRepositoryUrl": "https://github.com/test-account/repo2"
    },
    {
      "gitHubRepositoryUrl": "https://github.com/test-account/repo3"
    },
    {
      "gitHubRepositoryUrl": "https://github.com/test-account/repo399"
    }
  ],
  "operationType": "remove"
}

Resposta de exemplo

Código de status:
200 
{
  "count": 4,
  "value": [
    {
      "gitHubRepositoryUrl": "https://github.com/test-account/repo3"
    },
    {
      "gitHubRepositoryUrl": "https://github.com/test-account/repo2"
    },
    {
      "gitHubRepositoryUrl": "https://github.com/test-account/repo1",
      "errorMessage": "Repository is not connected to this team project"
    },
    {
      "gitHubRepositoryUrl": "https://github.com/test-account/repo399",
      "errorMessage": "Repository is not connected to this team project"
    }
  ]
}

Definições

Nome Description
GitHubConnectionRepoModel

Descreve o repositório de conexão do Github.
GitHubConnectionReposBatchRequest

Descreve a solicitação em massa de repoimento de conexão do Github

GitHubConnectionRepoModel

Objeto

Descreve o repositório de conexão do Github.

Nome Tipo Description
errorMessage

string

Mensagem de erro
gitHubRepositoryUrl

string

URL da Web do repositório

GitHubConnectionReposBatchRequest

Objeto

Descreve a solicitação em massa de repoimento de conexão do Github

Nome Tipo Description
gitHubRepositoryUrls

GitHubConnectionRepoModel[]

URLs de repositórios solicitados
gitHubUserToken

string

Token de acesso GitHub opcional usado para autenticar o provisionamento para as operações de adição e remoção. Adicionar também requer acesso de administrador aos repositórios.
operationType

string

Tipo de operação (por exemplo, adicionar, remover)