Iniciar varredura de código (API do Devin)
Inicie uma nova varredura de código do Devin em um repositório usando a API v3 da organização, opcionalmente com um perfil de varredura ou SHA de commit
Permissões
UseCodeScans no nível da organização.
Comportamento
repo_name na organização. A varredura é iniciada de forma assíncrona pelo despachante de varreduras; a resposta é o registro da varredura, com status inicial waiting ou pending. Consulte List Code Scans para acompanhar o progresso e List Code Scan Findings (filtrada por scan_id) para ler os resultados quando a varredura atingir completed.
A varredura é atribuída ao principal que fez a chamada (o usuário de serviço ou PAT que fez a requisição). O equivalente no escopo Enterprise é Iniciar varredura de código (Enterprise).
Campos da requisição
repo_name(obrigatório): nome completo do repositório, por exemplo,owner/repo. O repositório já deve estar acessível pela integração Git da organização.host: host Git do repositório, caso não possa ser inferido.profile_id: um perfil de varredura a ser aplicado. Use Iniciar varredura de ingestão para perfis no modoingest.scan_type: tipo de varredura a ser executada. Deve corresponder ao tipo de varredura do perfil quandoprofile_idfor informado. Por padrão, usa o tipo do perfil ousecuritypara varreduras sem perfil. Tipos de varredura que não são de segurança exigem um perfil.commit_sha: commit a ser usado antes da varredura. Por padrão, usa o commit mais recente da branch padrão do repositório.
Erros
400quandoscan_typeconflita com o perfil ou quando umscan_typediferente de Security é fornecido sem um perfil.403quando a organização está restrita a varreduras somente de ingestion e nenhum perfil no modoingesté fornecido.404quando o repositório ou o perfil não está visível para a organização.409quando o backlog de varreduras da organização atinge a capacidade máxima. Tente novamente mais tarde.
Autorizações
Credencial de usuário de serviço (prefixo: cog_)
Parâmetros de caminho
ID da organização (prefixo: org-)
"org-abc123def456"
Corpo
Corpo da requisição para iniciar uma nova varredura de código.
Nome completo do repositório a ser varrido.
Commit para fazer checkout antes da varredura.
Host Git do repositório, se conhecido.
Perfil de varredura a ser aplicado à varredura.
Tipo de varredura a executar. Deve corresponder ao tipo de varredura do perfil quando um perfil é fornecido; por padrão, usa o tipo do perfil ou 'security' para varreduras sem perfil. Tipos que não são de segurança exigem um perfil e são rejeitados sem um.
security, performance, db-queries, test-coverage, dead-code, code-quality, telemetry, accessibility, general, migration-docs Resposta
Resposta bem-sucedida
Uma única varredura de código.
Quando a varredura foi criada (segundos Unix).
Host Git do repositório, se conhecido.
Organização à qual a varredura pertence.
Perfil sob o qual a varredura foi executada, se houver.
Repositório principal da varredura. Varreduras com vários repositórios abrangem repositórios adicionais não listados aqui.
Identificador único da varredura.
Tipo de varredura, definido na criação.
security, performance, db-queries, test-coverage, dead-code, code-quality, telemetry, accessibility, general, migration-docs Status da varredura: waiting, pending, running, awaiting_user_input, completed, failed ou cancelled.
waiting, pending, running, awaiting_user_input, completed, failed, cancelled 
