Method: accounts.repos.scans.generate

Yerel kod uyumluluğu analizinin sonuçlarını yükler ve gizlilik sorunlarının taramasını oluşturur. Analiz ve bulguları içeren bir google.longrunning.Operation döndürür.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
parent

string

Zorunlu. Deponun kaynak adı.

Örnek: accounts/123/repos/456

İstek içeriği

İstek metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "cliAnalysis": {
    object (CliAnalysis)
  },
  "localScanPath": string,
  "cliVersion": string,
  "scmMetadata": {
    object (ScmMetadata)
  }
}
Alanlar
cliAnalysis

object (CliAnalysis)

Zorunlu. CLI analiz sonuçları.
localScanPath

string

Zorunlu. Yerel tarama yolu.
cliVersion

string

Zorunlu. CLI sürümü.
scmMetadata

object (ScmMetadata)

Zorunlu. SCM meta verileri.

Yanıt gövdesi

Başarılıysa yanıt metni, Operation öğesinin bir örneğini içerir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için OAuth 2.0'a Genel Bakış başlıklı makaleyi inceleyin.

CliAnalysis

Code Compliance CLI analizinin sonuçları.

JSON gösterimi 
{
  "sources": [
    {
      object (Source)
    }
  ],
  "codeScans": [
    {
      object (CodeScan)
    }
  ]
}
Alanlar
sources[]

object (Source)

İsteğe bağlıdır. Taramada algılanan veri kaynakları.
codeScans[]

object (CodeScan)

İsteğe bağlıdır. Ön CLI analizinden kaynaklanan istenen kod taramaları.

CodeScan

Kaynak kodunun istenen analizi. Kaynak kodunu ve işleme durumunu içerir.

JSON gösterimi 
{
  "sourceCode": {
    object (SourceCode)
  },
  "dataTypeClassifications": [
    {
      object (DataTypeClassification)
    }
  ]
}
Alanlar
sourceCode

object (SourceCode)

Zorunlu. Analiz edilecek kaynak kodu.
dataTypeClassifications[]

object (DataTypeClassification)

İsteğe bağlıdır. Veri türü sınıflandırma istekleri.

SourceCode

Bir depodaki kaynak kodunu içerir.

JSON gösterimi 
{
  "code": string,
  "path": string,
  "startLine": integer,
  "endLine": integer
}
Alanlar
code

string

Zorunlu. Kaynak kodu.
path

string

Zorunlu. Dosyanın yolu.
startLine

integer

Zorunlu. Başlangıç satırı numarası (1 tabanlı).
endLine

integer

Zorunlu. Bitiş satırı numarası (1 tabanlı).

DataTypeClassification

Veri türlerini sınıflandırma isteği.

JSON gösterimi 
{
  "dataType": enum (DataType),
  "lineNumber": integer
}
Alanlar
dataType

enum (DataType)

Zorunlu. Aday veri türü.
lineNumber

integer

Zorunlu. Satır numarası (1 tabanlı).