Method: accounts.repos.scans.generate

Faz upload dos resultados da análise de conformidade de código local e gera uma verificação de problemas de privacidade. Retorna um google.longrunning.Operation que contém análises e descobertas.

Solicitação HTTP

POST https://checks.googleapis.com/v1alpha/{parent=accounts/*/repos/*}/scans:generate

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. Nome do recurso do repositório.

Exemplo: accounts/123/repos/456

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "cliAnalysis": {
    object (CliAnalysis)
  },
  "localScanPath": string,
  "cliVersion": string,
  "scmMetadata": {
    object (ScmMetadata)
  }
}
Campos
cliAnalysis

object (CliAnalysis)

Obrigatório. Resultados da análise da CLI.
localScanPath

string

Obrigatório. Caminho de leitura local.
cliVersion

string

Obrigatório. Versão da CLI.
scmMetadata

object (ScmMetadata)

Obrigatório. Metadados do SCM.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/checks

Para mais informações, consulte a visão geral do OAuth 2.0.

CliAnalysis

Os resultados de uma análise da CLI de conformidade de código.

Representação JSON 
{
  "sources": [
    {
      object (Source)
    }
  ],
  "codeScans": [
    {
      object (CodeScan)
    }
  ]
}
Campos
sources[]

object (Source)

Opcional. Fontes de dados detectadas na verificação.
codeScans[]

object (CodeScan)

Opcional. Solicitou verificações de código resultantes da análise preliminar da CLI.

CodeScan

Uma análise solicitada do código-fonte. Contém o código-fonte e o estado de processamento.

Representação JSON 
{
  "sourceCode": {
    object (SourceCode)
  },
  "dataTypeClassifications": [
    {
      object (DataTypeClassification)
    }
  ]
}
Campos
sourceCode

object (SourceCode)

Obrigatório. Código-fonte a ser analisado.
dataTypeClassifications[]

object (DataTypeClassification)

Opcional. Solicitações de classificação de tipo de dados.

SourceCode

Contém o código-fonte de um repositório.

Representação JSON 
{
  "code": string,
  "path": string,
  "startLine": integer,
  "endLine": integer
}
Campos
code

string

Obrigatório. Código-fonte.
path

string

Obrigatório. Caminho do arquivo.
startLine

integer

Obrigatório. Número da linha inicial (com base em 1).
endLine

integer

Obrigatório. Número da linha final (com base em 1).

DataTypeClassification

Uma solicitação para classificar tipos de dados.

Representação JSON 
{
  "dataType": enum (DataType),
  "lineNumber": integer
}
Campos
dataType

enum (DataType)

Obrigatório. Tipo de dados do candidato.
lineNumber

integer

Obrigatório. Número da linha (baseado em 1).