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 开始)。