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

התוצאות של ניתוח Code Compliance 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).