- درخواست HTTP
- پارامترهای مسیر
- درخواست بدن
- بدن پاسخگو
- محدوده مجوز
- آنالیز بالینی
- CodeScan
- کد منبع
- DataTypeClassification
- آن را امتحان کنید!
نتایج تجزیه و تحلیل سازگاری کد محلی را آپلود می کند و اسکن مسائل حریم خصوصی را ایجاد می کند. یک google.longrunning.Operation
حاوی تجزیه و تحلیل و یافته ها را برمی گرداند.
درخواست HTTP
POST https://checks.googleapis.com/v1alpha/{parent=accounts/*/repos/*}/scans:generate
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
پارامترها | |
---|---|
parent | مورد نیاز. نام منبع مخزن. مثال: |
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
نمایندگی JSON |
---|
{ "cliAnalysis": { object ( |
فیلدها | |
---|---|
cli Analysis | مورد نیاز. نتایج تجزیه و تحلیل CLI |
local Scan Path | مورد نیاز. مسیر اسکن محلی |
cli Version | مورد نیاز. نسخه CLI. |
scm Metadata | مورد نیاز. فراداده SCM |
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از Operation
است.
محدوده مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/checks
برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.
آنالیز بالینی
نتایج یک تجزیه و تحلیل CLI مطابقت کد.
نمایندگی JSON |
---|
{ "sources": [ { object ( |
فیلدها | |
---|---|
sources[] | اختیاری. منابع داده در اسکن شناسایی شدند. |
code Scans[] | اختیاری. اسکن کد درخواستی حاصل از تجزیه و تحلیل اولیه CLI. |
CodeScan
تجزیه و تحلیل درخواستی کد منبع حاوی کد منبع و وضعیت پردازش است.
نمایندگی JSON |
---|
{ "sourceCode": { object ( |
فیلدها | |
---|---|
source Code | مورد نیاز. کد منبع برای تجزیه و تحلیل |
data Type Classifications[] | اختیاری. درخواست های طبقه بندی نوع داده |
کد منبع
حاوی کد منبع از یک مخزن است.
نمایندگی JSON |
---|
{ "code": string, "path": string, "startLine": integer, "endLine": integer } |
فیلدها | |
---|---|
code | مورد نیاز. کد منبع |
path | مورد نیاز. مسیر فایل. |
start Line | مورد نیاز. شماره خط شروع (بر اساس 1). |
end Line | مورد نیاز. شماره خط پایانی (بر اساس 1). |
DataTypeClassification
درخواستی برای طبقه بندی انواع داده ها
نمایندگی JSON |
---|
{
"dataType": enum ( |
فیلدها | |
---|---|
data Type | مورد نیاز. نوع داده کاندید |
line Number | مورد نیاز. شماره خط (بر اساس 1). |