Method: accounts.repos.scans.generate

Lädt die Ergebnisse der lokalen Code Compliance-Analyse hoch und generiert einen Scan auf Datenschutzprobleme. Gibt ein google.longrunning.Operation mit Analysen und Ergebnissen zurück.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Ressourcenname des Repositorys.

Beispiel: accounts/123/repos/456

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "cliAnalysis": {
    object (CliAnalysis)
  },
  "localScanPath": string,
  "cliVersion": string,
  "scmMetadata": {
    object (ScmMetadata)
  }
}
Felder
cliAnalysis

object (CliAnalysis)

Erforderlich. CLI-Analyseergebnisse
localScanPath

string

Erforderlich. Lokaler Scanpfad.
cliVersion

string

Erforderlich. CLI-Version.
scmMetadata

object (ScmMetadata)

Erforderlich. SCM-Metadaten.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Operation.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie in der OAuth 2.0-Übersicht.

CliAnalysis

Die Ergebnisse einer CLI-Analyse zur Code-Compliance.

JSON-Darstellung 
{
  "sources": [
    {
      object (Source)
    }
  ],
  "codeScans": [
    {
      object (CodeScan)
    }
  ]
}
Felder
sources[]

object (Source)

Optional. Datenquellen, die beim Scan erkannt wurden.
codeScans[]

object (CodeScan)

Optional. Angeforderte Code-Scans, die sich aus der vorläufigen CLI-Analyse ergeben.

CodeScan

Eine angeforderte Analyse des Quellcodes. Enthält den Quellcode und den Verarbeitungsstatus.

JSON-Darstellung 
{
  "sourceCode": {
    object (SourceCode)
  },
  "dataTypeClassifications": [
    {
      object (DataTypeClassification)
    }
  ]
}
Felder
sourceCode

object (SourceCode)

Erforderlich. Quellcode, der analysiert werden soll.
dataTypeClassifications[]

object (DataTypeClassification)

Optional. Anfragen zur Klassifizierung von Datentypen.

SourceCode

Enthält Quellcode aus einem Repository.

JSON-Darstellung 
{
  "code": string,
  "path": string,
  "startLine": integer,
  "endLine": integer
}
Felder
code

string

Erforderlich. Quellcode.
path

string

Erforderlich. Pfad der Datei.
startLine

integer

Erforderlich. Startzeilennummer (1-basiert).
endLine

integer

Erforderlich. Endzeilennummer (1-basiert).

DataTypeClassification

Ein Request zum Klassifizieren von Datentypen.

JSON-Darstellung 
{
  "dataType": enum (DataType),
  "lineNumber": integer
}
Felder
dataType

enum (DataType)

Erforderlich. Datentyp des Kandidaten.
lineNumber

integer

Erforderlich. Zeilennummer (1-basiert).