Method: accounts.repos.scans.generate

Tải kết quả phân tích Mức độ tuân thủ mã tại địa phương lên và tạo bản quét các vấn đề về quyền riêng tư. Trả về một google.longrunning.Operation chứa thông tin phân tích và kết quả.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Thông số
parent

string

Bắt buộc. Tên tài nguyên của kho lưu trữ.

Ví dụ: accounts/123/repos/456

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON
{
  "cliAnalysis": {
    object (CliAnalysis)
  },
  "localScanPath": string,
  "cliVersion": string,
  "scmMetadata": {
    object (ScmMetadata)
  }
}
Trường
cliAnalysis

object (CliAnalysis)

Bắt buộc. Kết quả phân tích CLI.

localScanPath

string

Bắt buộc. Đường dẫn quét cục bộ.

cliVersion

string

Bắt buộc. Phiên bản CLI.

scmMetadata

object (ScmMetadata)

Bắt buộc. Siêu dữ liệu SCM.

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một phiên bản của Operation.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem bài viết Tổng quan về OAuth 2.0.

CliAnalysis

Kết quả của một hoạt động phân tích CLI về việc tuân thủ quy định.

Biểu diễn dưới dạng JSON
{
  "sources": [
    {
      object (Source)
    }
  ],
  "codeScans": [
    {
      object (CodeScan)
    }
  ]
}
Trường
sources[]

object (Source)

Không bắt buộc. Nguồn dữ liệu được phát hiện trong quá trình quét.

codeScans[]

object (CodeScan)

Không bắt buộc. Các yêu cầu quét mã có được từ kết quả phân tích CLI sơ bộ.

CodeScan

Phân tích mã nguồn theo yêu cầu. Chứa mã nguồn và trạng thái xử lý.

Biểu diễn dưới dạng JSON
{
  "sourceCode": {
    object (SourceCode)
  },
  "dataTypeClassifications": [
    {
      object (DataTypeClassification)
    }
  ]
}
Trường
sourceCode

object (SourceCode)

Bắt buộc. Mã nguồn cần phân tích.

dataTypeClassifications[]

object (DataTypeClassification)

Không bắt buộc. Yêu cầu phân loại kiểu dữ liệu.

SourceCode

Chứa mã nguồn từ một kho lưu trữ.

Biểu diễn dưới dạng JSON
{
  "code": string,
  "path": string,
  "startLine": integer,
  "endLine": integer
}
Trường
code

string

Bắt buộc. Mã nguồn.

path

string

Bắt buộc. Đường dẫn của tệp.

startLine

integer

Bắt buộc. Số dòng bắt đầu (bắt đầu từ 1).

endLine

integer

Bắt buộc. Số dòng kết thúc (bắt đầu từ 1).

DataTypeClassification

Yêu cầu phân loại các loại dữ liệu.

Biểu diễn dưới dạng JSON
{
  "dataType": enum (DataType),
  "lineNumber": integer
}
Trường
dataType

enum (DataType)

Bắt buộc. Loại dữ liệu ứng cử viên.

lineNumber

integer

Bắt buộc. Số dòng (bắt đầu từ 1).