Method: accounts.repos.scans.generate

อัปโหลดผลการวิเคราะห์การปฏิบัติตามข้อกำหนดของโค้ดในเครื่องและสร้างการสแกนปัญหาด้านความเป็นส่วนตัว แสดงผล google.longrunning.Operation ที่มีการวิเคราะห์และผลการวิเคราะห์

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลงรหัส 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)