Method: accounts.repos.scans.generate

Przesyła wyniki lokalnej analizy zgodności kodu i generuje skanowanie problemów związanych z prywatnością. Zwraca google.longrunning.Operation zawierający analizę i wyniki.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
parent

string

Wymagany. Nazwa zasobu repozytorium.

Przykład: accounts/123/repos/456

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "cliAnalysis": {
    object (CliAnalysis)
  },
  "localScanPath": string,
  "cliVersion": string,
  "scmMetadata": {
    object (ScmMetadata)
  }
}
Pola
cliAnalysis

object (CliAnalysis)

Wymagany. Wyniki analizy w interfejsie CLI.
localScanPath

string

Wymagany. Lokalna ścieżka skanowania.
cliVersion

string

Wymagany. Wersja CLI.
scmMetadata

object (ScmMetadata)

Wymagany. metadane SCM,

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Operation.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w omówieniu OAuth 2.0.

CliAnalysis

Wyniki analizy interfejsu wiersza poleceń zgodności kodu.

Zapis JSON 
{
  "sources": [
    {
      object (Source)
    }
  ],
  "codeScans": [
    {
      object (CodeScan)
    }
  ]
}
Pola
sources[]

object (Source)

Opcjonalnie. Źródła danych wykryte podczas skanowania.
codeScans[]

object (CodeScan)

Opcjonalnie. Skanowanie kodu wynikające ze wstępnej analizy interfejsu CLI.

CodeScan

Żądana analiza kodu źródłowego. Zawiera kod źródłowy i stan przetwarzania.

Zapis JSON 
{
  "sourceCode": {
    object (SourceCode)
  },
  "dataTypeClassifications": [
    {
      object (DataTypeClassification)
    }
  ]
}
Pola
sourceCode

object (SourceCode)

Wymagany. Kod źródłowy do analizy.
dataTypeClassifications[]

object (DataTypeClassification)

Opcjonalnie. Prośby o klasyfikację typu danych.

SourceCode

Zawiera kod źródłowy z repozytorium.

Zapis JSON 
{
  "code": string,
  "path": string,
  "startLine": integer,
  "endLine": integer
}
Pola
code

string

Wymagany. Kod źródłowy.
path

string

Wymagany. Ścieżka pliku.
startLine

integer

Wymagany. Numer wiersza początkowego (od 1).
endLine

integer

Wymagany. Numer wiersza końcowego (od 1).

DataTypeClassification

Prośba o sklasyfikowanie typów danych.

Zapis JSON 
{
  "dataType": enum (DataType),
  "lineNumber": integer
}
Pola
dataType

enum (DataType)

Wymagany. Typ danych kandydata.
lineNumber

integer

Wymagany. Numer wiersza (od 1).