Method: accounts.repos.scans.generate

Mengupload hasil analisis Kepatuhan Kode lokal dan membuat pemindaian masalah privasi. Menampilkan google.longrunning.Operation yang berisi analisis dan temuan.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Nama resource repo.

Contoh: accounts/123/repos/456

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

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

object (CliAnalysis)

Wajib. Hasil analisis CLI.
localScanPath

string

Wajib. Jalur pemindaian lokal.
cliVersion

string

Wajib. Versi CLI.
scmMetadata

object (ScmMetadata)

Wajib. Metadata SCM.

Isi respons

Jika berhasil, isi respons memuat instance Operation.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk mendapatkan informasi selengkapnya, lihat Ringkasan OAuth 2.0.

CliAnalysis

Hasil analisis CLI Kepatuhan Kode.

Representasi JSON 
{
  "sources": [
    {
      object (Source)
    }
  ],
  "codeScans": [
    {
      object (CodeScan)
    }
  ]
}
Kolom
sources[]

object (Source)

Opsional. Sumber data terdeteksi dalam pemindaian.
codeScans[]

object (CodeScan)

Opsional. Pemindaian kode yang diminta sebagai hasil dari analisis CLI awal.

CodeScan

Analisis kode sumber yang diminta. Berisi kode sumber dan status pemrosesan.

Representasi JSON 
{
  "sourceCode": {
    object (SourceCode)
  },
  "dataTypeClassifications": [
    {
      object (DataTypeClassification)
    }
  ]
}
Kolom
sourceCode

object (SourceCode)

Wajib. Kode sumber yang akan dianalisis.
dataTypeClassifications[]

object (DataTypeClassification)

Opsional. Permintaan klasifikasi jenis data.

SourceCode

Berisi kode sumber dari repo.

Representasi JSON 
{
  "code": string,
  "path": string,
  "startLine": integer,
  "endLine": integer
}
Kolom
code

string

Wajib. Kode sumber.
path

string

Wajib. Jalur file.
startLine

integer

Wajib. Nomor baris awal (berbasis 1).
endLine

integer

Wajib. Nomor baris akhir (berbasis 1).

DataTypeClassification

Permintaan untuk mengklasifikasikan jenis data.

Representasi JSON 
{
  "dataType": enum (DataType),
  "lineNumber": integer
}
Kolom
dataType

enum (DataType)

Wajib. Jenis data kandidat.
lineNumber

integer

Wajib. Nomor baris (berbasis 1).