Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(604)

Side by Side Diff: discovery/googleapis/safebrowsing__v4.json

Issue 2973303002: Api-Roll 51: 2017-07-10 (Closed)
Patch Set: Created 3 years, 5 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « discovery/googleapis/runtimeconfig__v1.json ('k') | discovery/googleapis/script__v1.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 { 1 {
2 "basePath": "", 2 "basePath": "",
3 "baseUrl": "https://safebrowsing.googleapis.com/", 3 "baseUrl": "https://safebrowsing.googleapis.com/",
4 "batchPath": "batch", 4 "batchPath": "batch",
5 "description": "The Safe Browsing API is an experimental API that allows cli ent applications to check URLs against Google's constantly-updated blacklists of suspected phishing and malware pages. Your client application can use the API t o download an encrypted table for local, client-side lookups of URLs.", 5 "description": "The Safe Browsing API is an experimental API that allows cli ent applications to check URLs against Google's constantly-updated blacklists of suspected phishing and malware pages. Your client application can use the API t o download an encrypted table for local, client-side lookups of URLs.",
6 "discoveryVersion": "v1", 6 "discoveryVersion": "v1",
7 "documentationLink": "https://developers.google.com/safe-browsing/", 7 "documentationLink": "https://developers.google.com/safe-browsing/",
8 "icons": { 8 "icons": {
9 "x16": "http://www.google.com/images/icons/product/search-16.gif", 9 "x16": "http://www.google.com/images/icons/product/search-16.gif",
10 "x32": "http://www.google.com/images/icons/product/search-32.gif" 10 "x32": "http://www.google.com/images/icons/product/search-32.gif"
11 }, 11 },
12 "id": "safebrowsing:v4", 12 "id": "safebrowsing:v4",
13 "kind": "discovery#restDescription", 13 "kind": "discovery#restDescription",
14 "name": "safebrowsing", 14 "name": "safebrowsing",
15 "ownerDomain": "google.com", 15 "ownerDomain": "google.com",
16 "ownerName": "Google", 16 "ownerName": "Google",
17 "parameters": { 17 "parameters": {
18 "quotaUser": {
19 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",
20 "location": "query",
21 "type": "string"
22 },
23 "pp": {
24 "default": "true",
25 "description": "Pretty-print response.",
26 "location": "query",
27 "type": "boolean"
28 },
29 "bearer_token": {
30 "description": "OAuth bearer token.",
31 "location": "query",
32 "type": "string"
33 },
34 "oauth_token": {
35 "description": "OAuth 2.0 token for the current user.",
36 "location": "query",
37 "type": "string"
38 },
39 "upload_protocol": { 18 "upload_protocol": {
40 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").", 19 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
41 "location": "query", 20 "location": "query",
42 "type": "string" 21 "type": "string"
43 }, 22 },
44 "prettyPrint": { 23 "prettyPrint": {
45 "default": "true", 24 "default": "true",
46 "description": "Returns response with indentations and line breaks." , 25 "description": "Returns response with indentations and line breaks." ,
47 "location": "query", 26 "location": "query",
48 "type": "boolean" 27 "type": "boolean"
49 }, 28 },
29 "uploadType": {
30 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
31 "location": "query",
32 "type": "string"
33 },
50 "fields": { 34 "fields": {
51 "description": "Selector specifying which fields to include in a par tial response.", 35 "description": "Selector specifying which fields to include in a par tial response.",
52 "location": "query", 36 "location": "query",
53 "type": "string" 37 "type": "string"
54 }, 38 },
55 "uploadType": { 39 "callback": {
56 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").", 40 "description": "JSONP",
57 "location": "query", 41 "location": "query",
58 "type": "string" 42 "type": "string"
59 }, 43 },
60 "$.xgafv": { 44 "$.xgafv": {
61 "description": "V1 error format.", 45 "description": "V1 error format.",
62 "enum": [ 46 "enum": [
63 "1", 47 "1",
64 "2" 48 "2"
65 ], 49 ],
66 "enumDescriptions": [ 50 "enumDescriptions": [
67 "v1 error format", 51 "v1 error format",
68 "v2 error format" 52 "v2 error format"
69 ], 53 ],
70 "location": "query", 54 "location": "query",
71 "type": "string" 55 "type": "string"
72 }, 56 },
73 "callback": {
74 "description": "JSONP",
75 "location": "query",
76 "type": "string"
77 },
78 "alt": { 57 "alt": {
79 "default": "json", 58 "default": "json",
80 "description": "Data format for response.", 59 "description": "Data format for response.",
81 "enum": [ 60 "enum": [
82 "json", 61 "json",
83 "media", 62 "media",
84 "proto" 63 "proto"
85 ], 64 ],
86 "enumDescriptions": [ 65 "enumDescriptions": [
87 "Responses with Content-Type of application/json", 66 "Responses with Content-Type of application/json",
88 "Media download with context-dependent Content-Type", 67 "Media download with context-dependent Content-Type",
89 "Responses with Content-Type of application/x-protobuf" 68 "Responses with Content-Type of application/x-protobuf"
90 ], 69 ],
91 "location": "query", 70 "location": "query",
92 "type": "string" 71 "type": "string"
93 }, 72 },
94 "key": { 73 "key": {
95 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.", 74 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.",
96 "location": "query", 75 "location": "query",
97 "type": "string" 76 "type": "string"
98 }, 77 },
99 "access_token": { 78 "access_token": {
100 "description": "OAuth access token.", 79 "description": "OAuth access token.",
101 "location": "query", 80 "location": "query",
102 "type": "string" 81 "type": "string"
82 },
83 "quotaUser": {
84 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",
85 "location": "query",
86 "type": "string"
87 },
88 "pp": {
89 "default": "true",
90 "description": "Pretty-print response.",
91 "location": "query",
92 "type": "boolean"
93 },
94 "oauth_token": {
95 "description": "OAuth 2.0 token for the current user.",
96 "location": "query",
97 "type": "string"
98 },
99 "bearer_token": {
100 "description": "OAuth bearer token.",
101 "location": "query",
102 "type": "string"
103 } 103 }
104 }, 104 },
105 "protocol": "rest", 105 "protocol": "rest",
106 "resources": { 106 "resources": {
107 "threatListUpdates": { 107 "threatListUpdates": {
108 "methods": { 108 "methods": {
109 "fetch": { 109 "fetch": {
110 "description": "Fetches the most recent threat list updates. A client can request updates\nfor multiple lists at once.", 110 "description": "Fetches the most recent threat list updates. A client can request updates\nfor multiple lists at once.",
111 "httpMethod": "POST", 111 "httpMethod": "POST",
112 "id": "safebrowsing.threatListUpdates.fetch", 112 "id": "safebrowsing.threatListUpdates.fetch",
(...skipping 12 matching lines...) Expand all
125 "encodedFullHashes": { 125 "encodedFullHashes": {
126 "methods": { 126 "methods": {
127 "get": { 127 "get": {
128 "description": "", 128 "description": "",
129 "httpMethod": "GET", 129 "httpMethod": "GET",
130 "id": "safebrowsing.encodedFullHashes.get", 130 "id": "safebrowsing.encodedFullHashes.get",
131 "parameterOrder": [ 131 "parameterOrder": [
132 "encodedRequest" 132 "encodedRequest"
133 ], 133 ],
134 "parameters": { 134 "parameters": {
135 "encodedRequest": {
136 "description": "A serialized FindFullHashesRequest p roto.",
137 "format": "byte",
138 "location": "path",
139 "required": true,
140 "type": "string"
141 },
142 "clientId": { 135 "clientId": {
143 "description": "A client ID that (hopefully) uniquel y identifies the client implementation\nof the Safe Browsing API.", 136 "description": "A client ID that (hopefully) uniquel y identifies the client implementation\nof the Safe Browsing API.",
144 "location": "query", 137 "location": "query",
145 "type": "string" 138 "type": "string"
146 }, 139 },
147 "clientVersion": { 140 "clientVersion": {
148 "description": "The version of the client implementa tion.", 141 "description": "The version of the client implementa tion.",
149 "location": "query", 142 "location": "query",
150 "type": "string" 143 "type": "string"
144 },
145 "encodedRequest": {
146 "description": "A serialized FindFullHashesRequest p roto.",
147 "format": "byte",
148 "location": "path",
149 "required": true,
150 "type": "string"
151 } 151 }
152 }, 152 },
153 "path": "v4/encodedFullHashes/{encodedRequest}", 153 "path": "v4/encodedFullHashes/{encodedRequest}",
154 "response": { 154 "response": {
155 "$ref": "FindFullHashesResponse" 155 "$ref": "FindFullHashesResponse"
156 } 156 }
157 } 157 }
158 } 158 }
159 }, 159 },
160 "threatLists": { 160 "threatLists": {
(...skipping 50 matching lines...) Expand 10 before | Expand all | Expand 10 after
211 "encodedUpdates": { 211 "encodedUpdates": {
212 "methods": { 212 "methods": {
213 "get": { 213 "get": {
214 "description": "", 214 "description": "",
215 "httpMethod": "GET", 215 "httpMethod": "GET",
216 "id": "safebrowsing.encodedUpdates.get", 216 "id": "safebrowsing.encodedUpdates.get",
217 "parameterOrder": [ 217 "parameterOrder": [
218 "encodedRequest" 218 "encodedRequest"
219 ], 219 ],
220 "parameters": { 220 "parameters": {
221 "clientVersion": {
222 "description": "The version of the client implementa tion.",
223 "location": "query",
224 "type": "string"
225 },
226 "encodedRequest": { 221 "encodedRequest": {
227 "description": "A serialized FetchThreatListUpdatesR equest proto.", 222 "description": "A serialized FetchThreatListUpdatesR equest proto.",
228 "format": "byte", 223 "format": "byte",
229 "location": "path", 224 "location": "path",
230 "required": true, 225 "required": true,
231 "type": "string" 226 "type": "string"
232 }, 227 },
233 "clientId": { 228 "clientId": {
234 "description": "A client ID that uniquely identifies the client implementation of the Safe\nBrowsing API.", 229 "description": "A client ID that uniquely identifies the client implementation of the Safe\nBrowsing API.",
235 "location": "query", 230 "location": "query",
236 "type": "string" 231 "type": "string"
232 },
233 "clientVersion": {
234 "description": "The version of the client implementa tion.",
235 "location": "query",
236 "type": "string"
237 } 237 }
238 }, 238 },
239 "path": "v4/encodedUpdates/{encodedRequest}", 239 "path": "v4/encodedUpdates/{encodedRequest}",
240 "response": { 240 "response": {
241 "$ref": "FetchThreatListUpdatesResponse" 241 "$ref": "FetchThreatListUpdatesResponse"
242 } 242 }
243 } 243 }
244 } 244 }
245 } 245 }
246 }, 246 },
247 "revision": "20170608", 247 "revision": "20170704",
248 "rootUrl": "https://safebrowsing.googleapis.com/", 248 "rootUrl": "https://safebrowsing.googleapis.com/",
249 "schemas": { 249 "schemas": {
250 "ClientInfo": { 250 "ThreatListDescriptor": {
251 "description": "The client metadata associated with Safe Browsing AP I requests.", 251 "description": "Describes an individual threat list. A list is defin ed by three parameters:\nthe type of threat posed, the type of platform targeted by the threat, and\nthe type of entries in the list.",
252 "id": "ClientInfo", 252 "id": "ThreatListDescriptor",
253 "properties": { 253 "properties": {
254 "clientVersion": { 254 "threatEntryType": {
255 "description": "The version of the client implementation.", 255 "description": "The entry types contained in the list.",
256 "enum": [
257 "THREAT_ENTRY_TYPE_UNSPECIFIED",
258 "URL",
259 "EXECUTABLE",
260 "IP_RANGE",
261 "CHROME_EXTENSION",
262 "FILENAME",
263 "CERT"
264 ],
265 "enumDescriptions": [
266 "Unspecified.",
267 "A URL.",
268 "An executable program.",
269 "An IP range.",
270 "Chrome extension.",
271 "Filename.",
272 "CERT"
273 ],
256 "type": "string" 274 "type": "string"
257 }, 275 },
258 "clientId": { 276 "platformType": {
259 "description": "A client ID that (hopefully) uniquely identi fies the client implementation\nof the Safe Browsing API.", 277 "description": "The platform type targeted by the list's ent ries.",
278 "enum": [
279 "PLATFORM_TYPE_UNSPECIFIED",
280 "WINDOWS",
281 "LINUX",
282 "ANDROID",
283 "OSX",
284 "IOS",
285 "ANY_PLATFORM",
286 "ALL_PLATFORMS",
287 "CHROME"
288 ],
289 "enumDescriptions": [
290 "Unknown platform.",
291 "Threat posed to Windows.",
292 "Threat posed to Linux.",
293 "Threat posed to Android.",
294 "Threat posed to OS X.",
295 "Threat posed to iOS.",
296 "Threat posed to at least one of the defined platforms." ,
297 "Threat posed to all defined platforms.",
298 "Threat posed to Chrome."
299 ],
300 "type": "string"
301 },
302 "threatType": {
303 "description": "The threat type posed by the list's entries. ",
304 "enum": [
305 "THREAT_TYPE_UNSPECIFIED",
306 "MALWARE",
307 "SOCIAL_ENGINEERING",
308 "UNWANTED_SOFTWARE",
309 "POTENTIALLY_HARMFUL_APPLICATION",
310 "MALICIOUS_BINARY"
311 ],
312 "enumDescriptions": [
313 "Unknown.",
314 "Malware threat type.",
315 "Social engineering threat type.",
316 "Unwanted software threat type.",
317 "Potentially harmful application threat type.",
318 "Malicious binary threat type."
319 ],
260 "type": "string" 320 "type": "string"
261 } 321 }
262 }, 322 },
263 "type": "object" 323 "type": "object"
264 }, 324 },
265 "FindThreatMatchesRequest": { 325 "MetadataEntry": {
266 "description": "Request to check entries against lists.", 326 "description": "A single metadata entry.",
267 "id": "FindThreatMatchesRequest", 327 "id": "MetadataEntry",
268 "properties": { 328 "properties": {
269 "threatInfo": { 329 "key": {
270 "$ref": "ThreatInfo", 330 "description": "The metadata entry key. For JSON requests, t he key is base64-encoded.",
271 "description": "The lists and entries to be checked for matc hes." 331 "format": "byte",
332 "type": "string"
272 }, 333 },
273 "client": { 334 "value": {
274 "$ref": "ClientInfo", 335 "description": "The metadata entry value. For JSON requests, the value is base64-encoded.",
275 "description": "The client metadata." 336 "format": "byte",
337 "type": "string"
276 } 338 }
277 }, 339 },
278 "type": "object" 340 "type": "object"
341 },
342 "ClientInfo": {
343 "description": "The client metadata associated with Safe Browsing AP I requests.",
344 "id": "ClientInfo",
345 "properties": {
346 "clientId": {
347 "description": "A client ID that (hopefully) uniquely identi fies the client implementation\nof the Safe Browsing API.",
348 "type": "string"
349 },
350 "clientVersion": {
351 "description": "The version of the client implementation.",
352 "type": "string"
353 }
354 },
355 "type": "object"
279 }, 356 },
280 "ThreatInfo": { 357 "ThreatInfo": {
281 "description": "The information regarding one or more threats that a client submits when\nchecking for matches in threat lists.", 358 "description": "The information regarding one or more threats that a client submits when\nchecking for matches in threat lists.",
282 "id": "ThreatInfo", 359 "id": "ThreatInfo",
283 "properties": { 360 "properties": {
284 "threatEntryTypes": { 361 "threatEntryTypes": {
285 "description": "The entry types to be checked.", 362 "description": "The entry types to be checked.",
286 "enumDescriptions": [ 363 "enumDescriptions": [
287 "Unspecified.", 364 "Unspecified.",
288 "A URL.", 365 "A URL.",
(...skipping 72 matching lines...) Expand 10 before | Expand all | Expand 10 after
361 "threatEntries": { 438 "threatEntries": {
362 "description": "The threat entries to be checked.", 439 "description": "The threat entries to be checked.",
363 "items": { 440 "items": {
364 "$ref": "ThreatEntry" 441 "$ref": "ThreatEntry"
365 }, 442 },
366 "type": "array" 443 "type": "array"
367 } 444 }
368 }, 445 },
369 "type": "object" 446 "type": "object"
370 }, 447 },
448 "FindThreatMatchesRequest": {
449 "description": "Request to check entries against lists.",
450 "id": "FindThreatMatchesRequest",
451 "properties": {
452 "client": {
453 "$ref": "ClientInfo",
454 "description": "The client metadata."
455 },
456 "threatInfo": {
457 "$ref": "ThreatInfo",
458 "description": "The lists and entries to be checked for matc hes."
459 }
460 },
461 "type": "object"
462 },
371 "ThreatEntryMetadata": { 463 "ThreatEntryMetadata": {
372 "description": "The metadata associated with a specific threat entry . The client is expected\nto know the metadata key/value pairs associated with e ach threat type.", 464 "description": "The metadata associated with a specific threat entry . The client is expected\nto know the metadata key/value pairs associated with e ach threat type.",
373 "id": "ThreatEntryMetadata", 465 "id": "ThreatEntryMetadata",
374 "properties": { 466 "properties": {
375 "entries": { 467 "entries": {
376 "description": "The metadata entries.", 468 "description": "The metadata entries.",
377 "items": { 469 "items": {
378 "$ref": "MetadataEntry" 470 "$ref": "MetadataEntry"
379 }, 471 },
380 "type": "array" 472 "type": "array"
(...skipping 29 matching lines...) Expand all
410 "description": "The number of bytes for each prefix encoded below. This field can be\nanywhere from 4 (shortest prefix) to 32 (full SHA256 hash).", 502 "description": "The number of bytes for each prefix encoded below. This field can be\nanywhere from 4 (shortest prefix) to 32 (full SHA256 hash).",
411 "format": "int32", 503 "format": "int32",
412 "type": "integer" 504 "type": "integer"
413 } 505 }
414 }, 506 },
415 "type": "object" 507 "type": "object"
416 }, 508 },
417 "FetchThreatListUpdatesResponse": { 509 "FetchThreatListUpdatesResponse": {
418 "id": "FetchThreatListUpdatesResponse", 510 "id": "FetchThreatListUpdatesResponse",
419 "properties": { 511 "properties": {
512 "minimumWaitDuration": {
513 "description": "The minimum duration the client must wait be fore issuing any update\nrequest. If this field is not set clients may update as soon as they want.",
514 "format": "google-duration",
515 "type": "string"
516 },
420 "listUpdateResponses": { 517 "listUpdateResponses": {
421 "description": "The list updates requested by the clients.", 518 "description": "The list updates requested by the clients.",
422 "items": { 519 "items": {
423 "$ref": "ListUpdateResponse" 520 "$ref": "ListUpdateResponse"
424 }, 521 },
425 "type": "array" 522 "type": "array"
426 },
427 "minimumWaitDuration": {
428 "description": "The minimum duration the client must wait be fore issuing any update\nrequest. If this field is not set clients may update as soon as they want.",
429 "format": "google-duration",
430 "type": "string"
431 } 523 }
432 }, 524 },
433 "type": "object" 525 "type": "object"
434 }, 526 },
435 "Checksum": { 527 "Checksum": {
436 "description": "The expected state of a client's local database.", 528 "description": "The expected state of a client's local database.",
437 "id": "Checksum", 529 "id": "Checksum",
438 "properties": { 530 "properties": {
439 "sha256": { 531 "sha256": {
440 "description": "The SHA256 hash of the client state; that is , of the sorted list of all\nhashes present in the database.", 532 "description": "The SHA256 hash of the client state; that is , of the sorted list of all\nhashes present in the database.",
441 "format": "byte", 533 "format": "byte",
442 "type": "string" 534 "type": "string"
443 } 535 }
444 }, 536 },
445 "type": "object" 537 "type": "object"
446 }, 538 },
447 "FindFullHashesResponse": { 539 "FindFullHashesResponse": {
448 "id": "FindFullHashesResponse", 540 "id": "FindFullHashesResponse",
449 "properties": { 541 "properties": {
450 "matches": {
451 "description": "The full hashes that matched the requested p refixes.",
452 "items": {
453 "$ref": "ThreatMatch"
454 },
455 "type": "array"
456 },
457 "negativeCacheDuration": { 542 "negativeCacheDuration": {
458 "description": "For requested entities that did not match th e threat list, how long to\ncache the response.", 543 "description": "For requested entities that did not match th e threat list, how long to\ncache the response.",
459 "format": "google-duration", 544 "format": "google-duration",
460 "type": "string" 545 "type": "string"
461 }, 546 },
462 "minimumWaitDuration": { 547 "minimumWaitDuration": {
463 "description": "The minimum duration the client must wait be fore issuing any find hashes\nrequest. If this field is not set, clients can iss ue a request as soon as\nthey want.", 548 "description": "The minimum duration the client must wait be fore issuing any find hashes\nrequest. If this field is not set, clients can iss ue a request as soon as\nthey want.",
464 "format": "google-duration", 549 "format": "google-duration",
465 "type": "string" 550 "type": "string"
551 },
552 "matches": {
553 "description": "The full hashes that matched the requested p refixes.",
554 "items": {
555 "$ref": "ThreatMatch"
556 },
557 "type": "array"
466 } 558 }
467 }, 559 },
468 "type": "object" 560 "type": "object"
469 }, 561 },
470 "ThreatEntrySet": { 562 "ThreatEntrySet": {
471 "description": "A set of threats that should be added or removed fro m a client's local\ndatabase.", 563 "description": "A set of threats that should be added or removed fro m a client's local\ndatabase.",
472 "id": "ThreatEntrySet", 564 "id": "ThreatEntrySet",
473 "properties": { 565 "properties": {
474 "rawIndices": {
475 "$ref": "RawIndices",
476 "description": "The raw removal indices for a local list."
477 },
478 "rawHashes": {
479 "$ref": "RawHashes",
480 "description": "The raw SHA256-formatted entries."
481 },
482 "riceHashes": { 566 "riceHashes": {
483 "$ref": "RiceDeltaEncoding", 567 "$ref": "RiceDeltaEncoding",
484 "description": "The encoded 4-byte prefixes of SHA256-format ted entries, using a\nGolomb-Rice encoding. The hashes are converted to uint32, sorted in\nascending order, then delta encoded and stored as encoded_data." 568 "description": "The encoded 4-byte prefixes of SHA256-format ted entries, using a\nGolomb-Rice encoding. The hashes are converted to uint32, sorted in\nascending order, then delta encoded and stored as encoded_data."
485 }, 569 },
570 "riceIndices": {
571 "$ref": "RiceDeltaEncoding",
572 "description": "The encoded local, lexicographically-sorted list indices, using a\nGolomb-Rice encoding. Used for sending compressed removal indices. The\nremoval indices (uint32) are sorted in ascending order, then delt a encoded\nand stored as encoded_data."
573 },
486 "compressionType": { 574 "compressionType": {
487 "description": "The compression type for the entries in this set.", 575 "description": "The compression type for the entries in this set.",
488 "enum": [ 576 "enum": [
489 "COMPRESSION_TYPE_UNSPECIFIED", 577 "COMPRESSION_TYPE_UNSPECIFIED",
490 "RAW", 578 "RAW",
491 "RICE" 579 "RICE"
492 ], 580 ],
493 "enumDescriptions": [ 581 "enumDescriptions": [
494 "Unknown.", 582 "Unknown.",
495 "Raw, uncompressed data.", 583 "Raw, uncompressed data.",
496 "Rice-Golomb encoded data." 584 "Rice-Golomb encoded data."
497 ], 585 ],
498 "type": "string" 586 "type": "string"
499 }, 587 },
500 "riceIndices": { 588 "rawIndices": {
501 "$ref": "RiceDeltaEncoding", 589 "$ref": "RawIndices",
502 "description": "The encoded local, lexicographically-sorted list indices, using a\nGolomb-Rice encoding. Used for sending compressed removal indices. The\nremoval indices (uint32) are sorted in ascending order, then delt a encoded\nand stored as encoded_data." 590 "description": "The raw removal indices for a local list."
591 },
592 "rawHashes": {
593 "$ref": "RawHashes",
594 "description": "The raw SHA256-formatted entries."
503 } 595 }
504 }, 596 },
505 "type": "object" 597 "type": "object"
506 }, 598 },
507 "FindFullHashesRequest": { 599 "FindFullHashesRequest": {
508 "description": "Request to return full hashes matched by the provide d hash prefixes.", 600 "description": "Request to return full hashes matched by the provide d hash prefixes.",
509 "id": "FindFullHashesRequest", 601 "id": "FindFullHashesRequest",
510 "properties": { 602 "properties": {
511 "apiClient": {
512 "$ref": "ClientInfo",
513 "description": "Client metadata associated with callers of h igher-level APIs built on top\nof the client's implementation."
514 },
515 "clientStates": { 603 "clientStates": {
516 "description": "The current client states for each of the cl ient's local threat lists.", 604 "description": "The current client states for each of the cl ient's local threat lists.",
517 "items": { 605 "items": {
518 "format": "byte", 606 "format": "byte",
519 "type": "string" 607 "type": "string"
520 }, 608 },
521 "type": "array" 609 "type": "array"
522 }, 610 },
523 "client": { 611 "client": {
524 "$ref": "ClientInfo", 612 "$ref": "ClientInfo",
525 "description": "The client metadata." 613 "description": "The client metadata."
526 }, 614 },
527 "threatInfo": { 615 "threatInfo": {
528 "$ref": "ThreatInfo", 616 "$ref": "ThreatInfo",
529 "description": "The lists and hashes to be checked." 617 "description": "The lists and hashes to be checked."
618 },
619 "apiClient": {
620 "$ref": "ClientInfo",
621 "description": "Client metadata associated with callers of h igher-level APIs built on top\nof the client's implementation."
530 } 622 }
531 }, 623 },
532 "type": "object" 624 "type": "object"
533 }, 625 },
534 "ListUpdateRequest": { 626 "ListUpdateRequest": {
535 "description": "A single list update request.", 627 "description": "A single list update request.",
536 "id": "ListUpdateRequest", 628 "id": "ListUpdateRequest",
537 "properties": { 629 "properties": {
630 "threatEntryType": {
631 "description": "The types of entries present in the list.",
632 "enum": [
633 "THREAT_ENTRY_TYPE_UNSPECIFIED",
634 "URL",
635 "EXECUTABLE",
636 "IP_RANGE",
637 "CHROME_EXTENSION",
638 "FILENAME",
639 "CERT"
640 ],
641 "enumDescriptions": [
642 "Unspecified.",
643 "A URL.",
644 "An executable program.",
645 "An IP range.",
646 "Chrome extension.",
647 "Filename.",
648 "CERT"
649 ],
650 "type": "string"
651 },
652 "state": {
653 "description": "The current state of the client for the requ ested list (the encrypted\nclient state that was received from the last successf ul list update).",
654 "format": "byte",
655 "type": "string"
656 },
538 "platformType": { 657 "platformType": {
539 "description": "The type of platform at risk by entries pres ent in the list.", 658 "description": "The type of platform at risk by entries pres ent in the list.",
540 "enum": [ 659 "enum": [
541 "PLATFORM_TYPE_UNSPECIFIED", 660 "PLATFORM_TYPE_UNSPECIFIED",
542 "WINDOWS", 661 "WINDOWS",
543 "LINUX", 662 "LINUX",
544 "ANDROID", 663 "ANDROID",
545 "OSX", 664 "OSX",
546 "IOS", 665 "IOS",
547 "ANY_PLATFORM", 666 "ANY_PLATFORM",
548 "ALL_PLATFORMS", 667 "ALL_PLATFORMS",
549 "CHROME" 668 "CHROME"
550 ], 669 ],
551 "enumDescriptions": [ 670 "enumDescriptions": [
552 "Unknown platform.", 671 "Unknown platform.",
553 "Threat posed to Windows.", 672 "Threat posed to Windows.",
554 "Threat posed to Linux.", 673 "Threat posed to Linux.",
555 "Threat posed to Android.", 674 "Threat posed to Android.",
556 "Threat posed to OS X.", 675 "Threat posed to OS X.",
557 "Threat posed to iOS.", 676 "Threat posed to iOS.",
558 "Threat posed to at least one of the defined platforms." , 677 "Threat posed to at least one of the defined platforms." ,
559 "Threat posed to all defined platforms.", 678 "Threat posed to all defined platforms.",
560 "Threat posed to Chrome." 679 "Threat posed to Chrome."
561 ], 680 ],
562 "type": "string" 681 "type": "string"
563 }, 682 },
683 "constraints": {
684 "$ref": "Constraints",
685 "description": "The constraints associated with this request ."
686 },
564 "threatType": { 687 "threatType": {
565 "description": "The type of threat posed by entries present in the list.", 688 "description": "The type of threat posed by entries present in the list.",
566 "enum": [ 689 "enum": [
567 "THREAT_TYPE_UNSPECIFIED", 690 "THREAT_TYPE_UNSPECIFIED",
568 "MALWARE", 691 "MALWARE",
569 "SOCIAL_ENGINEERING", 692 "SOCIAL_ENGINEERING",
570 "UNWANTED_SOFTWARE", 693 "UNWANTED_SOFTWARE",
571 "POTENTIALLY_HARMFUL_APPLICATION", 694 "POTENTIALLY_HARMFUL_APPLICATION",
572 "MALICIOUS_BINARY" 695 "MALICIOUS_BINARY"
573 ], 696 ],
574 "enumDescriptions": [ 697 "enumDescriptions": [
575 "Unknown.", 698 "Unknown.",
576 "Malware threat type.", 699 "Malware threat type.",
577 "Social engineering threat type.", 700 "Social engineering threat type.",
578 "Unwanted software threat type.", 701 "Unwanted software threat type.",
579 "Potentially harmful application threat type.", 702 "Potentially harmful application threat type.",
580 "Malicious binary threat type." 703 "Malicious binary threat type."
581 ], 704 ],
582 "type": "string" 705 "type": "string"
583 },
584 "constraints": {
585 "$ref": "Constraints",
586 "description": "The constraints associated with this request ."
587 },
588 "threatEntryType": {
589 "description": "The types of entries present in the list.",
590 "enum": [
591 "THREAT_ENTRY_TYPE_UNSPECIFIED",
592 "URL",
593 "EXECUTABLE",
594 "IP_RANGE",
595 "CHROME_EXTENSION",
596 "FILENAME",
597 "CERT"
598 ],
599 "enumDescriptions": [
600 "Unspecified.",
601 "A URL.",
602 "An executable program.",
603 "An IP range.",
604 "Chrome extension.",
605 "Filename.",
606 "CERT"
607 ],
608 "type": "string"
609 },
610 "state": {
611 "description": "The current state of the client for the requ ested list (the encrypted\nclient state that was received from the last successf ul list update).",
612 "format": "byte",
613 "type": "string"
614 } 706 }
615 }, 707 },
616 "type": "object" 708 "type": "object"
617 }, 709 },
618 "FetchThreatListUpdatesRequest": { 710 "FetchThreatListUpdatesRequest": {
619 "description": "Describes a Safe Browsing API update request. Client s can request updates for\nmultiple lists in a single request.\nNOTE: Field inde x 2 is unused.\nNEXT: 5", 711 "description": "Describes a Safe Browsing API update request. Client s can request updates for\nmultiple lists in a single request.\nNOTE: Field inde x 2 is unused.\nNEXT: 5",
620 "id": "FetchThreatListUpdatesRequest", 712 "id": "FetchThreatListUpdatesRequest",
621 "properties": { 713 "properties": {
622 "listUpdateRequests": { 714 "listUpdateRequests": {
623 "description": "The requested threat list updates.", 715 "description": "The requested threat list updates.",
624 "items": { 716 "items": {
625 "$ref": "ListUpdateRequest" 717 "$ref": "ListUpdateRequest"
626 }, 718 },
627 "type": "array" 719 "type": "array"
628 }, 720 },
629 "client": { 721 "client": {
630 "$ref": "ClientInfo", 722 "$ref": "ClientInfo",
631 "description": "The client metadata." 723 "description": "The client metadata."
632 } 724 }
633 }, 725 },
634 "type": "object" 726 "type": "object"
635 }, 727 },
636 "ListUpdateResponse": { 728 "ListUpdateResponse": {
637 "description": "An update to an individual list.", 729 "description": "An update to an individual list.",
638 "id": "ListUpdateResponse", 730 "id": "ListUpdateResponse",
639 "properties": { 731 "properties": {
640 "newClientState": {
641 "description": "The new client state, in encrypted format. O paque to clients.",
642 "format": "byte",
643 "type": "string"
644 },
645 "removals": { 732 "removals": {
646 "description": "A set of entries to remove from a local thre at type's list. In practice,\nthis field is empty or contains exactly one Threat EntrySet.", 733 "description": "A set of entries to remove from a local thre at type's list. In practice,\nthis field is empty or contains exactly one Threat EntrySet.",
647 "items": { 734 "items": {
648 "$ref": "ThreatEntrySet" 735 "$ref": "ThreatEntrySet"
649 }, 736 },
650 "type": "array" 737 "type": "array"
651 }, 738 },
739 "newClientState": {
740 "description": "The new client state, in encrypted format. O paque to clients.",
741 "format": "byte",
742 "type": "string"
743 },
652 "platformType": { 744 "platformType": {
653 "description": "The platform type for which data is returned .", 745 "description": "The platform type for which data is returned .",
654 "enum": [ 746 "enum": [
655 "PLATFORM_TYPE_UNSPECIFIED", 747 "PLATFORM_TYPE_UNSPECIFIED",
656 "WINDOWS", 748 "WINDOWS",
657 "LINUX", 749 "LINUX",
658 "ANDROID", 750 "ANDROID",
659 "OSX", 751 "OSX",
660 "IOS", 752 "IOS",
661 "ANY_PLATFORM", 753 "ANY_PLATFORM",
(...skipping 80 matching lines...) Expand 10 before | Expand all | Expand 10 after
742 ], 834 ],
743 "type": "string" 835 "type": "string"
744 } 836 }
745 }, 837 },
746 "type": "object" 838 "type": "object"
747 }, 839 },
748 "Constraints": { 840 "Constraints": {
749 "description": "The constraints for this update.", 841 "description": "The constraints for this update.",
750 "id": "Constraints", 842 "id": "Constraints",
751 "properties": { 843 "properties": {
752 "maxDatabaseEntries": {
753 "description": "Sets the maximum number of entries that the client is willing to have\nin the local database. This should be a power of 2 be tween 2**10 and\n2**20. If zero, no database size limit is set.",
754 "format": "int32",
755 "type": "integer"
756 },
757 "region": {
758 "description": "Requests the list for a specific geographic location. If not set the\nserver may pick that value based on the user's IP addr ess. Expects ISO\n3166-1 alpha-2 format.",
759 "type": "string"
760 },
761 "supportedCompressions": { 844 "supportedCompressions": {
762 "description": "The compression types supported by the clien t.", 845 "description": "The compression types supported by the clien t.",
763 "enumDescriptions": [ 846 "enumDescriptions": [
764 "Unknown.", 847 "Unknown.",
765 "Raw, uncompressed data.", 848 "Raw, uncompressed data.",
766 "Rice-Golomb encoded data." 849 "Rice-Golomb encoded data."
767 ], 850 ],
768 "items": { 851 "items": {
769 "enum": [ 852 "enum": [
770 "COMPRESSION_TYPE_UNSPECIFIED", 853 "COMPRESSION_TYPE_UNSPECIFIED",
771 "RAW", 854 "RAW",
772 "RICE" 855 "RICE"
773 ], 856 ],
774 "type": "string" 857 "type": "string"
775 }, 858 },
776 "type": "array" 859 "type": "array"
777 }, 860 },
778 "maxUpdateEntries": { 861 "maxUpdateEntries": {
779 "description": "The maximum size in number of entries. The u pdate will not contain more\nentries than this value. This should be a power of 2 between 2**10 and\n2**20. If zero, no update size limit is set.", 862 "description": "The maximum size in number of entries. The u pdate will not contain more\nentries than this value. This should be a power of 2 between 2**10 and\n2**20. If zero, no update size limit is set.",
780 "format": "int32", 863 "format": "int32",
781 "type": "integer" 864 "type": "integer"
865 },
866 "region": {
867 "description": "Requests the list for a specific geographic location. If not set the\nserver may pick that value based on the user's IP addr ess. Expects ISO\n3166-1 alpha-2 format.",
868 "type": "string"
869 },
870 "maxDatabaseEntries": {
871 "description": "Sets the maximum number of entries that the client is willing to have\nin the local database. This should be a power of 2 be tween 2**10 and\n2**20. If zero, no database size limit is set.",
872 "format": "int32",
873 "type": "integer"
782 } 874 }
783 }, 875 },
784 "type": "object" 876 "type": "object"
785 }, 877 },
786 "ThreatMatch": { 878 "ThreatMatch": {
787 "description": "A match when checking a threat entry in the Safe Bro wsing threat lists.", 879 "description": "A match when checking a threat entry in the Safe Bro wsing threat lists.",
788 "id": "ThreatMatch", 880 "id": "ThreatMatch",
789 "properties": { 881 "properties": {
790 "threatEntryType": { 882 "threatEntryType": {
791 "description": "The threat entry type matching this threat." , 883 "description": "The threat entry type matching this threat." ,
(...skipping 15 matching lines...) Expand all
807 "Filename.", 899 "Filename.",
808 "CERT" 900 "CERT"
809 ], 901 ],
810 "type": "string" 902 "type": "string"
811 }, 903 },
812 "cacheDuration": { 904 "cacheDuration": {
813 "description": "The cache lifetime for the returned match. C lients must not cache this\nresponse for more than this duration to avoid false positives.", 905 "description": "The cache lifetime for the returned match. C lients must not cache this\nresponse for more than this duration to avoid false positives.",
814 "format": "google-duration", 906 "format": "google-duration",
815 "type": "string" 907 "type": "string"
816 }, 908 },
909 "threatEntryMetadata": {
910 "$ref": "ThreatEntryMetadata",
911 "description": "Optional metadata associated with this threa t."
912 },
817 "threatType": { 913 "threatType": {
818 "description": "The threat type matching this threat.", 914 "description": "The threat type matching this threat.",
819 "enum": [ 915 "enum": [
820 "THREAT_TYPE_UNSPECIFIED", 916 "THREAT_TYPE_UNSPECIFIED",
821 "MALWARE", 917 "MALWARE",
822 "SOCIAL_ENGINEERING", 918 "SOCIAL_ENGINEERING",
823 "UNWANTED_SOFTWARE", 919 "UNWANTED_SOFTWARE",
824 "POTENTIALLY_HARMFUL_APPLICATION", 920 "POTENTIALLY_HARMFUL_APPLICATION",
825 "MALICIOUS_BINARY" 921 "MALICIOUS_BINARY"
826 ], 922 ],
827 "enumDescriptions": [ 923 "enumDescriptions": [
828 "Unknown.", 924 "Unknown.",
829 "Malware threat type.", 925 "Malware threat type.",
830 "Social engineering threat type.", 926 "Social engineering threat type.",
831 "Unwanted software threat type.", 927 "Unwanted software threat type.",
832 "Potentially harmful application threat type.", 928 "Potentially harmful application threat type.",
833 "Malicious binary threat type." 929 "Malicious binary threat type."
834 ], 930 ],
835 "type": "string" 931 "type": "string"
836 }, 932 },
837 "threatEntryMetadata": {
838 "$ref": "ThreatEntryMetadata",
839 "description": "Optional metadata associated with this threa t."
840 },
841 "threat": { 933 "threat": {
842 "$ref": "ThreatEntry", 934 "$ref": "ThreatEntry",
843 "description": "The threat matching this threat." 935 "description": "The threat matching this threat."
844 }, 936 },
845 "platformType": { 937 "platformType": {
846 "description": "The platform type matching this threat.", 938 "description": "The platform type matching this threat.",
847 "enum": [ 939 "enum": [
848 "PLATFORM_TYPE_UNSPECIFIED", 940 "PLATFORM_TYPE_UNSPECIFIED",
849 "WINDOWS", 941 "WINDOWS",
850 "LINUX", 942 "LINUX",
(...skipping 30 matching lines...) Expand all
881 }, 973 },
882 "type": "array" 974 "type": "array"
883 } 975 }
884 }, 976 },
885 "type": "object" 977 "type": "object"
886 }, 978 },
887 "RiceDeltaEncoding": { 979 "RiceDeltaEncoding": {
888 "description": "The Rice-Golomb encoded data. Used for sending compr essed 4-byte hashes or\ncompressed removal indices.", 980 "description": "The Rice-Golomb encoded data. Used for sending compr essed 4-byte hashes or\ncompressed removal indices.",
889 "id": "RiceDeltaEncoding", 981 "id": "RiceDeltaEncoding",
890 "properties": { 982 "properties": {
983 "encodedData": {
984 "description": "The encoded deltas that are encoded using th e Golomb-Rice coder.",
985 "format": "byte",
986 "type": "string"
987 },
891 "firstValue": { 988 "firstValue": {
892 "description": "The offset of the first entry in the encoded data, or, if only a single\ninteger was encoded, that single integer's value.", 989 "description": "The offset of the first entry in the encoded data, or, if only a single\ninteger was encoded, that single integer's value.",
893 "format": "int64", 990 "format": "int64",
894 "type": "string" 991 "type": "string"
895 }, 992 },
896 "encodedData": {
897 "description": "The encoded deltas that are encoded using th e Golomb-Rice coder.",
898 "format": "byte",
899 "type": "string"
900 },
901 "numEntries": { 993 "numEntries": {
902 "description": "The number of entries that are delta encoded in the encoded data. If only a\nsingle integer was encoded, this will be zero a nd the single value will be\nstored in `first_value`.", 994 "description": "The number of entries that are delta encoded in the encoded data. If only a\nsingle integer was encoded, this will be zero a nd the single value will be\nstored in `first_value`.",
903 "format": "int32", 995 "format": "int32",
904 "type": "integer" 996 "type": "integer"
905 }, 997 },
906 "riceParameter": { 998 "riceParameter": {
907 "description": "The Golomb-Rice parameter, which is a number between 2 and 28. This field\nis missing (that is, zero) if `num_entries` is ze ro.", 999 "description": "The Golomb-Rice parameter, which is a number between 2 and 28. This field\nis missing (that is, zero) if `num_entries` is ze ro.",
908 "format": "int32", 1000 "format": "int32",
909 "type": "integer" 1001 "type": "integer"
910 } 1002 }
(...skipping 26 matching lines...) Expand all
937 "format": "byte", 1029 "format": "byte",
938 "type": "string" 1030 "type": "string"
939 }, 1031 },
940 "hash": { 1032 "hash": {
941 "description": "A hash prefix, consisting of the most signif icant 4-32 bytes of a SHA256\nhash. This field is in binary format. For JSON req uests, hashes are\nbase64-encoded.", 1033 "description": "A hash prefix, consisting of the most signif icant 4-32 bytes of a SHA256\nhash. This field is in binary format. For JSON req uests, hashes are\nbase64-encoded.",
942 "format": "byte", 1034 "format": "byte",
943 "type": "string" 1035 "type": "string"
944 } 1036 }
945 }, 1037 },
946 "type": "object" 1038 "type": "object"
947 },
948 "ThreatListDescriptor": {
949 "description": "Describes an individual threat list. A list is defin ed by three parameters:\nthe type of threat posed, the type of platform targeted by the threat, and\nthe type of entries in the list.",
950 "id": "ThreatListDescriptor",
951 "properties": {
952 "platformType": {
953 "description": "The platform type targeted by the list's ent ries.",
954 "enum": [
955 "PLATFORM_TYPE_UNSPECIFIED",
956 "WINDOWS",
957 "LINUX",
958 "ANDROID",
959 "OSX",
960 "IOS",
961 "ANY_PLATFORM",
962 "ALL_PLATFORMS",
963 "CHROME"
964 ],
965 "enumDescriptions": [
966 "Unknown platform.",
967 "Threat posed to Windows.",
968 "Threat posed to Linux.",
969 "Threat posed to Android.",
970 "Threat posed to OS X.",
971 "Threat posed to iOS.",
972 "Threat posed to at least one of the defined platforms." ,
973 "Threat posed to all defined platforms.",
974 "Threat posed to Chrome."
975 ],
976 "type": "string"
977 },
978 "threatType": {
979 "description": "The threat type posed by the list's entries. ",
980 "enum": [
981 "THREAT_TYPE_UNSPECIFIED",
982 "MALWARE",
983 "SOCIAL_ENGINEERING",
984 "UNWANTED_SOFTWARE",
985 "POTENTIALLY_HARMFUL_APPLICATION",
986 "MALICIOUS_BINARY"
987 ],
988 "enumDescriptions": [
989 "Unknown.",
990 "Malware threat type.",
991 "Social engineering threat type.",
992 "Unwanted software threat type.",
993 "Potentially harmful application threat type.",
994 "Malicious binary threat type."
995 ],
996 "type": "string"
997 },
998 "threatEntryType": {
999 "description": "The entry types contained in the list.",
1000 "enum": [
1001 "THREAT_ENTRY_TYPE_UNSPECIFIED",
1002 "URL",
1003 "EXECUTABLE",
1004 "IP_RANGE",
1005 "CHROME_EXTENSION",
1006 "FILENAME",
1007 "CERT"
1008 ],
1009 "enumDescriptions": [
1010 "Unspecified.",
1011 "A URL.",
1012 "An executable program.",
1013 "An IP range.",
1014 "Chrome extension.",
1015 "Filename.",
1016 "CERT"
1017 ],
1018 "type": "string"
1019 }
1020 },
1021 "type": "object"
1022 },
1023 "MetadataEntry": {
1024 "description": "A single metadata entry.",
1025 "id": "MetadataEntry",
1026 "properties": {
1027 "key": {
1028 "description": "The metadata entry key. For JSON requests, t he key is base64-encoded.",
1029 "format": "byte",
1030 "type": "string"
1031 },
1032 "value": {
1033 "description": "The metadata entry value. For JSON requests, the value is base64-encoded.",
1034 "format": "byte",
1035 "type": "string"
1036 }
1037 },
1038 "type": "object"
1039 } 1039 }
1040 }, 1040 },
1041 "servicePath": "", 1041 "servicePath": "",
1042 "title": "Google Safe Browsing API", 1042 "title": "Google Safe Browsing API",
1043 "version": "v4" 1043 "version": "v4"
1044 } 1044 }
OLDNEW
« no previous file with comments | « discovery/googleapis/runtimeconfig__v1.json ('k') | discovery/googleapis/script__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698