Method: accounts.repos.scans.generate

Sube los resultados del análisis de cumplimiento del código local y genera un análisis de los problemas de privacidad. Devuelve un objeto google.longrunning.Operation que contiene el análisis y los hallazgos.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

Es obligatorio. Es el nombre del recurso del repo.

Ejemplo: accounts/123/repos/456

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "cliAnalysis": {
    object (CliAnalysis)
  },
  "localScanPath": string,
  "cliVersion": string,
  "scmMetadata": {
    object (ScmMetadata)
  }
}
Campos
cliAnalysis

object (CliAnalysis)

Es obligatorio. Son los resultados del análisis de la CLI.
localScanPath

string

Es obligatorio. Es la ruta de acceso de la búsqueda local.
cliVersion

string

Es obligatorio. Versión de la CLI.
scmMetadata

object (ScmMetadata)

Es obligatorio. Son los metadatos del SCM.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Operation.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.

CliAnalysis

Son los resultados de un análisis de la CLI de cumplimiento del código.

Representación JSON 
{
  "sources": [
    {
      object (Source)
    }
  ],
  "codeScans": [
    {
      object (CodeScan)
    }
  ]
}
Campos
sources[]

object (Source)

Opcional. Fuentes de datos detectadas en el análisis.
codeScans[]

object (CodeScan)

Opcional. Son los análisis de código solicitados que resultan del análisis preliminar de la CLI.

CodeScan

Es un análisis solicitado del código fuente. Contiene el código fuente y el estado de procesamiento.

Representación JSON 
{
  "sourceCode": {
    object (SourceCode)
  },
  "dataTypeClassifications": [
    {
      object (DataTypeClassification)
    }
  ]
}
Campos
sourceCode

object (SourceCode)

Es obligatorio. Es el código fuente que se analizará.
dataTypeClassifications[]

object (DataTypeClassification)

Opcional. Solicitudes de clasificación de tipo de datos

SourceCode

Contiene código fuente de un repo.

Representación JSON 
{
  "code": string,
  "path": string,
  "startLine": integer,
  "endLine": integer
}
Campos
code

string

Es obligatorio. Código fuente
path

string

Es obligatorio. Es la ruta del archivo.
startLine

integer

Es obligatorio. Número de línea de inicio (basado en 1).
endLine

integer

Es obligatorio. Número de línea final (basado en 1).

DataTypeClassification

Es una solicitud para clasificar tipos de datos.

Representación JSON 
{
  "dataType": enum (DataType),
  "lineNumber": integer
}
Campos
dataType

enum (DataType)

Es obligatorio. Es el tipo de datos del candidato.
lineNumber

integer

Es obligatorio. Número de línea (en base 1).