Method: accounts.repos.scans.generate

ローカルのコード コンプライアンス分析の結果をアップロードし、プライバシーに関する問題のスキャンを生成します。分析と検出結果を含む google.longrunning.Operation を返します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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 から始まる）。