Method: accounts.repos.scans.generate

Importe les résultats de l'analyse de conformité du code local et génère une analyse des problèmes de confidentialité. Renvoie un google.longrunning.Operation contenant l'analyse et les résultats.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de ressource du dépôt.

Exemple : accounts/123/repos/456

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "cliAnalysis": {
    object (CliAnalysis)
  },
  "localScanPath": string,
  "cliVersion": string,
  "scmMetadata": {
    object (ScmMetadata)
  }
}
Champs
cliAnalysis

object (CliAnalysis)

Obligatoire. Résultats de l'analyse de la CLI.
localScanPath

string

Obligatoire. Chemin d'accès local à l'analyse.
cliVersion

string

Obligatoire. Version de la CLI.
scmMetadata

object (ScmMetadata)

Obligatoire. Métadonnées SCM.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Operation.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez la présentation d'OAuth 2.0.

CliAnalysis

Résultats d'une analyse CLI de conformité du code.

Représentation JSON 
{
  "sources": [
    {
      object (Source)
    }
  ],
  "codeScans": [
    {
      object (CodeScan)
    }
  ]
}
Champs
sources[]

object (Source)

Facultatif. Sources de données détectées lors de l'analyse.
codeScans[]

object (CodeScan)

Facultatif. Analyses de code demandées à la suite d'une analyse CLI préliminaire.

CodeScan

Analyse du code source demandée. Contient le code source et l'état de traitement.

Représentation JSON 
{
  "sourceCode": {
    object (SourceCode)
  },
  "dataTypeClassifications": [
    {
      object (DataTypeClassification)
    }
  ]
}
Champs
sourceCode

object (SourceCode)

Obligatoire. Code source à analyser.
dataTypeClassifications[]

object (DataTypeClassification)

Facultatif. Demandes de classification des types de données.

SourceCode

Contient le code source d'un dépôt.

Représentation JSON 
{
  "code": string,
  "path": string,
  "startLine": integer,
  "endLine": integer
}
Champs
code

string

Obligatoire. Code source.
path

string

Obligatoire. Chemin d'accès au fichier.
startLine

integer

Obligatoire. Numéro de la ligne de début (basé sur 1).
endLine

integer

Obligatoire. Numéro de ligne de fin (basé sur 1).

DataTypeClassification

Requête permettant de classer les types de données.

Représentation JSON 
{
  "dataType": enum (DataType),
  "lineNumber": integer
}
Champs
dataType

enum (DataType)

Obligatoire. Type de données du candidat.
lineNumber

integer

Obligatoire. Numéro de ligne (basé sur 1).