Method: accounts.repos.scans.generate

यह कुकी, स्थानीय कानून के मुताबिक कोड के इस्तेमाल से जुड़े विश्लेषण के नतीजे अपलोड करती है. साथ ही, निजता से जुड़ी समस्याओं को स्कैन करती है. यह फ़ंक्शन, विश्लेषण और नतीजों वाला google.longrunning.Operation दिखाता है.

एचटीटीपी अनुरोध

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

यह यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ पैरामीटर

पैरामीटर
parent

string

ज़रूरी है. रिपो के संसाधन का नाम.

उदाहरण: accounts/123/repos/456

अनुरोध का मुख्य भाग

अनुरोध के मुख्य भाग में, इस स्ट्रक्चर का डेटा शामिल होता है:

JSON के काेड में दिखाना 
{
  "cliAnalysis": {
    object (CliAnalysis)
  },
  "localScanPath": string,
  "cliVersion": string,
  "scmMetadata": {
    object (ScmMetadata)
  }
}
फ़ील्ड
cliAnalysis

object (CliAnalysis)

ज़रूरी है. सीएलआई विश्लेषण के नतीजे.
localScanPath

string

ज़रूरी है. लोकल स्कैन पाथ.
cliVersion

string

ज़रूरी है. सीएलआई वर्शन.
scmMetadata

object (ScmMetadata)

ज़रूरी है. एससीएम मेटाडेटा.

जवाब का मुख्य भाग

कामयाब रहने पर, जवाब के मुख्य हिस्से में Operation का एक इंस्टेंस शामिल किया जाता है.

अनुमति के स्कोप

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

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

ज़्यादा जानकारी के लिए, OAuth 2.0 से जुड़ी खास जानकारी देखें.

CliAnalysis

कोड के नियमों के पालन से जुड़े सीएलआई विश्लेषण के नतीजे.

JSON के काेड में दिखाना 
{
  "sources": [
    {
      object (Source)
    }
  ],
  "codeScans": [
    {
      object (CodeScan)
    }
  ]
}
फ़ील्ड
sources[]

object (Source)

ज़रूरी नहीं. स्कैन में डेटा सोर्स का पता चला.
codeScans[]

object (CodeScan)

ज़रूरी नहीं. सीएलआई के शुरुआती विश्लेषण के बाद, कोड स्कैन करने के अनुरोध किए गए.

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 से शुरू होने वाला).