Method: accounts.repos.scans.generate

Загружает результаты локального анализа соответствия коду и выполняет сканирование на наличие проблем с конфиденциальностью. Возвращает google.longrunning.Operation , содержащий анализ и результаты.

HTTP-запрос

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

URL использует синтаксис перекодировки gRPC .

Параметры пути

Параметры
parent

string

Обязательно. Имя ресурса репозитория.

Пример: accounts/123/repos/456

Текст запроса

Тело запроса содержит данные со следующей структурой:

JSON-представление 
{
  "cliAnalysis": {
    object (CliAnalysis)
  },
  "localScanPath": string,
  "cliVersion": string,
  "scmMetadata": {
    object (ScmMetadata)
  }
}
Поля
cli Analysis

object ( CliAnalysis )

Обязательно. Результаты анализа CLI.

local Scan Path

string

Обязательно. Локальный путь сканирования.

cli Version

string

Обязательно. CLI-версия.

scm Metadata

object ( ScmMetadata )

Обязательно. Метаданные SCM.

Тело ответа

В случае успеха тело ответа содержит экземпляр Operation .

Области авторизации

Требуется следующая область OAuth:

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

Более подробную информацию см. в обзоре OAuth 2.0 .

КлиАнализ

Результаты анализа соответствия кода CLI.

JSON-представление 
{
  "sources": [
    {
      object (Source)
    }
  ],
  "codeScans": [
    {
      object (CodeScan)
    }
  ]
}
Поля
sources[]

object ( Source )

Необязательно. Источники данных, обнаруженные при сканировании.

code Scans[]

object ( CodeScan )

Необязательно. Запрошенные сканирования кода, полученные в результате предварительного анализа CLI.

CodeScan

Запрошенный анализ исходного кода. Содержит исходный код и состояние обработки.

JSON-представление 
{
  "sourceCode": {
    object (SourceCode)
  },
  "dataTypeClassifications": [
    {
      object (DataTypeClassification)
    }
  ]
}
Поля
source Code

object ( SourceCode )

Требуется. Исходный код для анализа.

data Type Classifications[]

object ( DataTypeClassification )

Необязательно. Запросы на классификацию типов данных.

Исходный код

Содержит исходный код из репозитория.

JSON-представление 
{
  "code": string,
  "path": string,
  "startLine": integer,
  "endLine": integer
}
Поля
code

string

Требуется. Исходный код.

path

string

Обязательно. Путь к файлу.

start Line

integer

Обязательно. Номер стартовой строки (начиная с 1).

end Line

integer

Обязательно. Номер конечной строки (начиная с 1).

ТипДанныеКлассификация

Запрос на классификацию типов данных.

JSON-представление 
{
  "dataType": enum (DataType),
  "lineNumber": integer
}
Поля
data Type

enum ( DataType )

Обязательно. Тип данных кандидата.

line Number

integer

Обязательно. Номер строки (начиная с 1).