Pular para o conteúdo principal

kobana kadu sources

Comandos de kobana kadu sources. Toda opção global (Opções globais) vale aqui.

ComandoHTTPDescrição
sources listGET /v1/sourcesLista repositórios de código
sources createPOST /v1/sourcesCadastra repositório de código
sources getGET /v1/sources/{id}Detalha o repositório de código
sources updatePATCH /v1/sources/{id}Atualiza repositório de código
sources deleteDELETE /v1/sources/{id}Remove repositório de código (soft delete)
sources checkPOST /v1/sources/{id}/checkVerifica o acesso ao repositório

sources list​

Lista repositórios de código

kobana kadu sources list [OPÇÕES]

GET /v1/sources

Parâmetros de consulta

NomeTipoObrigatórioDescrição
cursorstringnão
limitnumbernão
sort_bystringnãoCampo em snake_case: created_at (padrão), updated_at ou um campo filtrável.
sort_orderstringnãoPadrão: desc. Valores: asc, desc.

Respostas

HTTPDescrição
200OK
503AS_UNAVAILABLE — a verificação do token está indisponível (Authorization Server fora do ar ou configuração ausente). Tente de novo (Retry-After).

sources create​

Cadastra repositório de código

kobana kadu sources create [OPÇÕES]

POST /v1/sources

Se a instalação do GitHub App da organização cobre o repositório, o acesso é verificado na hora. Senão, a resposta traz a deploy key a cadastrar no GitHub antes de verificar o acesso.

Corpo da requisição

NomeTipoObrigatórioDescrição
namestringsim
repositorystringsimowner/repo ou a URL do repositório no GitHub.
refstringnãoBranch ou tag; null = a branch padrão.
labelstringnão
workspace_idstring (uuid)não
custom_metadataobjectnão

Outros campos e objetos aninhados: kobana schema kadu.sources.create.

Respostas

HTTPDescrição
201created
400VALIDATION_ERROR
409CONFLICT — já existe repositório vivo com este nome / IDEMPOTENCY_KEY_REUSED
422VALIDATION_ERROR — repositório, ref ou workspace inválido
503GITHUB_UNAVAILABLE — o GitHub não respondeu

sources get​

Detalha o repositório de código

kobana kadu sources get [ID] [OPÇÕES]

GET /v1/sources/{id}

Argumentos do caminho: id

Respostas

HTTPDescrição
200OK
404not found
503AS_UNAVAILABLE — a verificação do token está indisponível (Authorization Server fora do ar ou configuração ausente). Tente de novo (Retry-After).

sources update​

Atualiza repositório de código

kobana kadu sources update [ID] [OPÇÕES]

PATCH /v1/sources/{id}

Nome e repositório não mudam: as skills referenciam o nome e a deploy key é do repositório. Mudar a ref zera a verificação de acesso.

Argumentos do caminho: id

Corpo da requisição

NomeTipoObrigatórioDescrição
refstringnãoBranch ou tag; null = a branch padrão.
labelstringnão
workspace_idstring (uuid)não
custom_metadataobjectnão

Outros campos e objetos aninhados: kobana schema kadu.sources.update.

Respostas

HTTPDescrição
200OK
404NOT_FOUND
409IDEMPOTENCY_KEY_REUSED
422VALIDATION_ERROR — ref ou workspace inválido
503AS_UNAVAILABLE — a verificação do token está indisponível (Authorization Server fora do ar ou configuração ausente). Tente de novo (Retry-After).

sources delete​

Remove repositório de código (soft delete)

kobana kadu sources delete [ID] [OPÇÕES]

DELETE /v1/sources/{id}

As Tasks que o declaram falham na próxima execução. Recusado enquanto o kadu.yaml declarar o repositório.

Argumentos do caminho: id

Respostas

HTTPDescrição
200OK
404NOT_FOUND
409REPO_MANAGED — declarado no kadu.yaml
503AS_UNAVAILABLE — a verificação do token está indisponível (Authorization Server fora do ar ou configuração ausente). Tente de novo (Retry-After).

sources check​

Verifica o acesso ao repositório

kobana kadu sources check [ID] [OPÇÕES]

POST /v1/sources/{id}/check

Lista a ref no GitHub com a credencial do repositório, sem clonar, e grava o resultado. Falta de acesso não é erro HTTP: vem em access_status e last_check_error.

Argumentos do caminho: id

Respostas

HTTPDescrição
200OK
404NOT_FOUND
503AS_UNAVAILABLE — a verificação do token está indisponível (Authorization Server fora do ar ou configuração ausente). Tente de novo (Retry-After).