Method: accounts.repos.scans.generate

上傳本機程式碼法規遵循分析結果,並產生隱私權問題掃描結果。傳回包含分析和發現的 google.longrunning.Operation

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
parent

string

必要欄位。存放區的資源名稱。

範例:accounts/123/repos/456

要求主體

要求主體的資料會採用以下結構:

JSON 表示法
{
  "cliAnalysis": {
    object (CliAnalysis)
  },
  "localScanPath": string,
  "cliVersion": string,
  "scmMetadata": {
    object (ScmMetadata)
  }
}
欄位
cliAnalysis

object (CliAnalysis)

必要欄位。CLI 分析結果。

localScanPath

string

必要欄位。本機掃描路徑。

cliVersion

string

必要欄位。CLI 版本。

scmMetadata

object (ScmMetadata)

必要欄位。SCM 中繼資料。

回應主體

如果成功,回應主體會包含 Operation 的執行例項。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 總覽

CliAnalysis

程式碼相容性 CLI 分析結果。

JSON 表示法
{
  "sources": [
    {
      object (Source)
    }
  ],
  "codeScans": [
    {
      object (CodeScan)
    }
  ]
}
欄位
sources[]

object (Source)

(選用步驟) 掃描偵測到的資料來源。

codeScans[]

object (CodeScan)

(選用步驟) 初步 CLI 分析產生的要求程式碼掃描。

CodeScan

要求分析原始碼。包含原始碼和處理狀態。

JSON 表示法
{
  "sourceCode": {
    object (SourceCode)
  },
  "dataTypeClassifications": [
    {
      object (DataTypeClassification)
    }
  ]
}
欄位
sourceCode

object (SourceCode)

必要欄位。要分析的原始碼。

dataTypeClassifications[]

object (DataTypeClassification)

(選用步驟) 資料類型分類要求。

SourceCode

包含存放區的原始碼。

JSON 表示法
{
  "code": string,
  "path": string,
  "startLine": integer,
  "endLine": integer
}
欄位
code

string

必要欄位。原始碼。

path

string

必要欄位。檔案路徑。

startLine

integer

必要欄位。起始行號 (從 1 開始)。

endLine

integer

必要欄位。結束行號 (從 1 開始)。

DataTypeClassification

要求分類資料類型。

JSON 表示法
{
  "dataType": enum (DataType),
  "lineNumber": integer
}
欄位
dataType

enum (DataType)

必要欄位。候選人資料類型。

lineNumber

integer

必要欄位。行號 (以 1 為基礎)。