- Richiesta HTTP
- Parametri del percorso
- Corpo della richiesta
- Corpo della risposta
- Ambiti di autorizzazione
- CliAnalysis
- CodeScan
- SourceCode
- DataTypeClassification
- Prova!
Carica i risultati dell'analisi della conformità del codice locale e genera una scansione dei problemi di privacy. Restituisce un google.longrunning.Operation
contenente l'analisi e i risultati.
Richiesta HTTP
POST https://checks.googleapis.com/v1alpha/{parent=accounts/*/repos/*}/scans:generate
L'URL utilizza la sintassi di transcodifica gRPC.
Parametri del percorso
Parametri | |
---|---|
parent |
Obbligatorio. Nome della risorsa del repository. Esempio: |
Corpo della richiesta
Il corpo della richiesta contiene dati con la seguente struttura:
Rappresentazione JSON |
---|
{ "cliAnalysis": { object ( |
Campi | |
---|---|
cli |
Obbligatorio. Risultati dell'analisi della CLI. |
local |
Obbligatorio. Percorso di scansione locale. |
cli |
Obbligatorio. Versione della CLI. |
scm |
Obbligatorio. Metadati SCM. |
Corpo della risposta
In caso di esito positivo, il corpo della risposta contiene un'istanza di Operation
.
Ambiti di autorizzazione
Richiede il seguente ambito OAuth:
https://www.googleapis.com/auth/checks
Per ulteriori informazioni, consulta la panoramica di OAuth 2.0.
CliAnalysis
I risultati di un'analisi della CLI di conformità del codice.
Rappresentazione JSON |
---|
{ "sources": [ { object ( |
Campi | |
---|---|
sources[] |
(Facoltativo) Origini dati rilevate nella scansione. |
code |
(Facoltativo) Scansioni del codice richieste risultanti dall'analisi preliminare della CLI. |
CodeScan
Un'analisi richiesta del codice sorgente. Contiene il codice sorgente e lo stato di elaborazione.
Rappresentazione JSON |
---|
{ "sourceCode": { object ( |
Campi | |
---|---|
source |
Obbligatorio. Codice sorgente da analizzare. |
data |
(Facoltativo) Richieste di classificazione del tipo di dati. |
SourceCode
Contiene il codice sorgente di un repository.
Rappresentazione JSON |
---|
{ "code": string, "path": string, "startLine": integer, "endLine": integer } |
Campi | |
---|---|
code |
Obbligatorio. Codice sorgente. |
path |
Obbligatorio. Percorso del file. |
start |
Obbligatorio. Numero di riga iniziale (in base 1). |
end |
Obbligatorio. Numero di riga finale (in base 1). |
DataTypeClassification
Una richiesta di classificazione dei tipi di dati.
Rappresentazione JSON |
---|
{
"dataType": enum ( |
Campi | |
---|---|
data |
Obbligatorio. Tipo di dati del candidato. |
line |
Obbligatorio. Numero di riga (in base 1). |