Index: discovery/googleapis/safebrowsing__v4.json |
diff --git a/discovery/googleapis/safebrowsing__v4.json b/discovery/googleapis/safebrowsing__v4.json |
index 30121a06fb7dd56196dd96de7fb0140912cbf6cc..747f1aaf25ea0c36a2be9c04c4ff71dedd541025 100644 |
--- a/discovery/googleapis/safebrowsing__v4.json |
+++ b/discovery/googleapis/safebrowsing__v4.json |
@@ -15,27 +15,6 @@ |
"ownerDomain": "google.com", |
"ownerName": "Google", |
"parameters": { |
- "quotaUser": { |
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", |
- "location": "query", |
- "type": "string" |
- }, |
- "pp": { |
- "default": "true", |
- "description": "Pretty-print response.", |
- "location": "query", |
- "type": "boolean" |
- }, |
- "bearer_token": { |
- "description": "OAuth bearer token.", |
- "location": "query", |
- "type": "string" |
- }, |
- "oauth_token": { |
- "description": "OAuth 2.0 token for the current user.", |
- "location": "query", |
- "type": "string" |
- }, |
"upload_protocol": { |
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", |
"location": "query", |
@@ -47,13 +26,18 @@ |
"location": "query", |
"type": "boolean" |
}, |
+ "uploadType": { |
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
+ "location": "query", |
+ "type": "string" |
+ }, |
"fields": { |
"description": "Selector specifying which fields to include in a partial response.", |
"location": "query", |
"type": "string" |
}, |
- "uploadType": { |
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
+ "callback": { |
+ "description": "JSONP", |
"location": "query", |
"type": "string" |
}, |
@@ -70,11 +54,6 @@ |
"location": "query", |
"type": "string" |
}, |
- "callback": { |
- "description": "JSONP", |
- "location": "query", |
- "type": "string" |
- }, |
"alt": { |
"default": "json", |
"description": "Data format for response.", |
@@ -100,6 +79,27 @@ |
"description": "OAuth access token.", |
"location": "query", |
"type": "string" |
+ }, |
+ "quotaUser": { |
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "pp": { |
+ "default": "true", |
+ "description": "Pretty-print response.", |
+ "location": "query", |
+ "type": "boolean" |
+ }, |
+ "oauth_token": { |
+ "description": "OAuth 2.0 token for the current user.", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "bearer_token": { |
+ "description": "OAuth bearer token.", |
+ "location": "query", |
+ "type": "string" |
} |
}, |
"protocol": "rest", |
@@ -132,13 +132,6 @@ |
"encodedRequest" |
], |
"parameters": { |
- "encodedRequest": { |
- "description": "A serialized FindFullHashesRequest proto.", |
- "format": "byte", |
- "location": "path", |
- "required": true, |
- "type": "string" |
- }, |
"clientId": { |
"description": "A client ID that (hopefully) uniquely identifies the client implementation\nof the Safe Browsing API.", |
"location": "query", |
@@ -148,6 +141,13 @@ |
"description": "The version of the client implementation.", |
"location": "query", |
"type": "string" |
+ }, |
+ "encodedRequest": { |
+ "description": "A serialized FindFullHashesRequest proto.", |
+ "format": "byte", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
} |
}, |
"path": "v4/encodedFullHashes/{encodedRequest}", |
@@ -218,11 +218,6 @@ |
"encodedRequest" |
], |
"parameters": { |
- "clientVersion": { |
- "description": "The version of the client implementation.", |
- "location": "query", |
- "type": "string" |
- }, |
"encodedRequest": { |
"description": "A serialized FetchThreatListUpdatesRequest proto.", |
"format": "byte", |
@@ -234,6 +229,11 @@ |
"description": "A client ID that uniquely identifies the client implementation of the Safe\nBrowsing API.", |
"location": "query", |
"type": "string" |
+ }, |
+ "clientVersion": { |
+ "description": "The version of the client implementation.", |
+ "location": "query", |
+ "type": "string" |
} |
}, |
"path": "v4/encodedUpdates/{encodedRequest}", |
@@ -244,35 +244,112 @@ |
} |
} |
}, |
- "revision": "20170608", |
+ "revision": "20170704", |
"rootUrl": "https://safebrowsing.googleapis.com/", |
"schemas": { |
- "ClientInfo": { |
- "description": "The client metadata associated with Safe Browsing API requests.", |
- "id": "ClientInfo", |
+ "ThreatListDescriptor": { |
+ "description": "Describes an individual threat list. A list is defined by three parameters:\nthe type of threat posed, the type of platform targeted by the threat, and\nthe type of entries in the list.", |
+ "id": "ThreatListDescriptor", |
"properties": { |
- "clientVersion": { |
- "description": "The version of the client implementation.", |
+ "threatEntryType": { |
+ "description": "The entry types contained in the list.", |
+ "enum": [ |
+ "THREAT_ENTRY_TYPE_UNSPECIFIED", |
+ "URL", |
+ "EXECUTABLE", |
+ "IP_RANGE", |
+ "CHROME_EXTENSION", |
+ "FILENAME", |
+ "CERT" |
+ ], |
+ "enumDescriptions": [ |
+ "Unspecified.", |
+ "A URL.", |
+ "An executable program.", |
+ "An IP range.", |
+ "Chrome extension.", |
+ "Filename.", |
+ "CERT" |
+ ], |
"type": "string" |
}, |
- "clientId": { |
- "description": "A client ID that (hopefully) uniquely identifies the client implementation\nof the Safe Browsing API.", |
+ "platformType": { |
+ "description": "The platform type targeted by the list's entries.", |
+ "enum": [ |
+ "PLATFORM_TYPE_UNSPECIFIED", |
+ "WINDOWS", |
+ "LINUX", |
+ "ANDROID", |
+ "OSX", |
+ "IOS", |
+ "ANY_PLATFORM", |
+ "ALL_PLATFORMS", |
+ "CHROME" |
+ ], |
+ "enumDescriptions": [ |
+ "Unknown platform.", |
+ "Threat posed to Windows.", |
+ "Threat posed to Linux.", |
+ "Threat posed to Android.", |
+ "Threat posed to OS X.", |
+ "Threat posed to iOS.", |
+ "Threat posed to at least one of the defined platforms.", |
+ "Threat posed to all defined platforms.", |
+ "Threat posed to Chrome." |
+ ], |
+ "type": "string" |
+ }, |
+ "threatType": { |
+ "description": "The threat type posed by the list's entries.", |
+ "enum": [ |
+ "THREAT_TYPE_UNSPECIFIED", |
+ "MALWARE", |
+ "SOCIAL_ENGINEERING", |
+ "UNWANTED_SOFTWARE", |
+ "POTENTIALLY_HARMFUL_APPLICATION", |
+ "MALICIOUS_BINARY" |
+ ], |
+ "enumDescriptions": [ |
+ "Unknown.", |
+ "Malware threat type.", |
+ "Social engineering threat type.", |
+ "Unwanted software threat type.", |
+ "Potentially harmful application threat type.", |
+ "Malicious binary threat type." |
+ ], |
"type": "string" |
} |
}, |
"type": "object" |
}, |
- "FindThreatMatchesRequest": { |
- "description": "Request to check entries against lists.", |
- "id": "FindThreatMatchesRequest", |
+ "MetadataEntry": { |
+ "description": "A single metadata entry.", |
+ "id": "MetadataEntry", |
"properties": { |
- "threatInfo": { |
- "$ref": "ThreatInfo", |
- "description": "The lists and entries to be checked for matches." |
+ "key": { |
+ "description": "The metadata entry key. For JSON requests, the key is base64-encoded.", |
+ "format": "byte", |
+ "type": "string" |
}, |
- "client": { |
- "$ref": "ClientInfo", |
- "description": "The client metadata." |
+ "value": { |
+ "description": "The metadata entry value. For JSON requests, the value is base64-encoded.", |
+ "format": "byte", |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "ClientInfo": { |
+ "description": "The client metadata associated with Safe Browsing API requests.", |
+ "id": "ClientInfo", |
+ "properties": { |
+ "clientId": { |
+ "description": "A client ID that (hopefully) uniquely identifies the client implementation\nof the Safe Browsing API.", |
+ "type": "string" |
+ }, |
+ "clientVersion": { |
+ "description": "The version of the client implementation.", |
+ "type": "string" |
} |
}, |
"type": "object" |
@@ -368,6 +445,21 @@ |
}, |
"type": "object" |
}, |
+ "FindThreatMatchesRequest": { |
+ "description": "Request to check entries against lists.", |
+ "id": "FindThreatMatchesRequest", |
+ "properties": { |
+ "client": { |
+ "$ref": "ClientInfo", |
+ "description": "The client metadata." |
+ }, |
+ "threatInfo": { |
+ "$ref": "ThreatInfo", |
+ "description": "The lists and entries to be checked for matches." |
+ } |
+ }, |
+ "type": "object" |
+ }, |
"ThreatEntryMetadata": { |
"description": "The metadata associated with a specific threat entry. The client is expected\nto know the metadata key/value pairs associated with each threat type.", |
"id": "ThreatEntryMetadata", |
@@ -417,17 +509,17 @@ |
"FetchThreatListUpdatesResponse": { |
"id": "FetchThreatListUpdatesResponse", |
"properties": { |
+ "minimumWaitDuration": { |
+ "description": "The minimum duration the client must wait before issuing any update\nrequest. If this field is not set clients may update as soon as they want.", |
+ "format": "google-duration", |
+ "type": "string" |
+ }, |
"listUpdateResponses": { |
"description": "The list updates requested by the clients.", |
"items": { |
"$ref": "ListUpdateResponse" |
}, |
"type": "array" |
- }, |
- "minimumWaitDuration": { |
- "description": "The minimum duration the client must wait before issuing any update\nrequest. If this field is not set clients may update as soon as they want.", |
- "format": "google-duration", |
- "type": "string" |
} |
}, |
"type": "object" |
@@ -447,13 +539,6 @@ |
"FindFullHashesResponse": { |
"id": "FindFullHashesResponse", |
"properties": { |
- "matches": { |
- "description": "The full hashes that matched the requested prefixes.", |
- "items": { |
- "$ref": "ThreatMatch" |
- }, |
- "type": "array" |
- }, |
"negativeCacheDuration": { |
"description": "For requested entities that did not match the threat list, how long to\ncache the response.", |
"format": "google-duration", |
@@ -463,6 +548,13 @@ |
"description": "The minimum duration the client must wait before issuing any find hashes\nrequest. If this field is not set, clients can issue a request as soon as\nthey want.", |
"format": "google-duration", |
"type": "string" |
+ }, |
+ "matches": { |
+ "description": "The full hashes that matched the requested prefixes.", |
+ "items": { |
+ "$ref": "ThreatMatch" |
+ }, |
+ "type": "array" |
} |
}, |
"type": "object" |
@@ -471,18 +563,14 @@ |
"description": "A set of threats that should be added or removed from a client's local\ndatabase.", |
"id": "ThreatEntrySet", |
"properties": { |
- "rawIndices": { |
- "$ref": "RawIndices", |
- "description": "The raw removal indices for a local list." |
- }, |
- "rawHashes": { |
- "$ref": "RawHashes", |
- "description": "The raw SHA256-formatted entries." |
- }, |
"riceHashes": { |
"$ref": "RiceDeltaEncoding", |
"description": "The encoded 4-byte prefixes of SHA256-formatted entries, using a\nGolomb-Rice encoding. The hashes are converted to uint32, sorted in\nascending order, then delta encoded and stored as encoded_data." |
}, |
+ "riceIndices": { |
+ "$ref": "RiceDeltaEncoding", |
+ "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 delta encoded\nand stored as encoded_data." |
+ }, |
"compressionType": { |
"description": "The compression type for the entries in this set.", |
"enum": [ |
@@ -497,9 +585,13 @@ |
], |
"type": "string" |
}, |
- "riceIndices": { |
- "$ref": "RiceDeltaEncoding", |
- "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 delta encoded\nand stored as encoded_data." |
+ "rawIndices": { |
+ "$ref": "RawIndices", |
+ "description": "The raw removal indices for a local list." |
+ }, |
+ "rawHashes": { |
+ "$ref": "RawHashes", |
+ "description": "The raw SHA256-formatted entries." |
} |
}, |
"type": "object" |
@@ -508,10 +600,6 @@ |
"description": "Request to return full hashes matched by the provided hash prefixes.", |
"id": "FindFullHashesRequest", |
"properties": { |
- "apiClient": { |
- "$ref": "ClientInfo", |
- "description": "Client metadata associated with callers of higher-level APIs built on top\nof the client's implementation." |
- }, |
"clientStates": { |
"description": "The current client states for each of the client's local threat lists.", |
"items": { |
@@ -527,6 +615,10 @@ |
"threatInfo": { |
"$ref": "ThreatInfo", |
"description": "The lists and hashes to be checked." |
+ }, |
+ "apiClient": { |
+ "$ref": "ClientInfo", |
+ "description": "Client metadata associated with callers of higher-level APIs built on top\nof the client's implementation." |
} |
}, |
"type": "object" |
@@ -535,6 +627,33 @@ |
"description": "A single list update request.", |
"id": "ListUpdateRequest", |
"properties": { |
+ "threatEntryType": { |
+ "description": "The types of entries present in the list.", |
+ "enum": [ |
+ "THREAT_ENTRY_TYPE_UNSPECIFIED", |
+ "URL", |
+ "EXECUTABLE", |
+ "IP_RANGE", |
+ "CHROME_EXTENSION", |
+ "FILENAME", |
+ "CERT" |
+ ], |
+ "enumDescriptions": [ |
+ "Unspecified.", |
+ "A URL.", |
+ "An executable program.", |
+ "An IP range.", |
+ "Chrome extension.", |
+ "Filename.", |
+ "CERT" |
+ ], |
+ "type": "string" |
+ }, |
+ "state": { |
+ "description": "The current state of the client for the requested list (the encrypted\nclient state that was received from the last successful list update).", |
+ "format": "byte", |
+ "type": "string" |
+ }, |
"platformType": { |
"description": "The type of platform at risk by entries present in the list.", |
"enum": [ |
@@ -561,6 +680,10 @@ |
], |
"type": "string" |
}, |
+ "constraints": { |
+ "$ref": "Constraints", |
+ "description": "The constraints associated with this request." |
+ }, |
"threatType": { |
"description": "The type of threat posed by entries present in the list.", |
"enum": [ |
@@ -580,37 +703,6 @@ |
"Malicious binary threat type." |
], |
"type": "string" |
- }, |
- "constraints": { |
- "$ref": "Constraints", |
- "description": "The constraints associated with this request." |
- }, |
- "threatEntryType": { |
- "description": "The types of entries present in the list.", |
- "enum": [ |
- "THREAT_ENTRY_TYPE_UNSPECIFIED", |
- "URL", |
- "EXECUTABLE", |
- "IP_RANGE", |
- "CHROME_EXTENSION", |
- "FILENAME", |
- "CERT" |
- ], |
- "enumDescriptions": [ |
- "Unspecified.", |
- "A URL.", |
- "An executable program.", |
- "An IP range.", |
- "Chrome extension.", |
- "Filename.", |
- "CERT" |
- ], |
- "type": "string" |
- }, |
- "state": { |
- "description": "The current state of the client for the requested list (the encrypted\nclient state that was received from the last successful list update).", |
- "format": "byte", |
- "type": "string" |
} |
}, |
"type": "object" |
@@ -637,11 +729,6 @@ |
"description": "An update to an individual list.", |
"id": "ListUpdateResponse", |
"properties": { |
- "newClientState": { |
- "description": "The new client state, in encrypted format. Opaque to clients.", |
- "format": "byte", |
- "type": "string" |
- }, |
"removals": { |
"description": "A set of entries to remove from a local threat type's list. In practice,\nthis field is empty or contains exactly one ThreatEntrySet.", |
"items": { |
@@ -649,6 +736,11 @@ |
}, |
"type": "array" |
}, |
+ "newClientState": { |
+ "description": "The new client state, in encrypted format. Opaque to clients.", |
+ "format": "byte", |
+ "type": "string" |
+ }, |
"platformType": { |
"description": "The platform type for which data is returned.", |
"enum": [ |
@@ -749,15 +841,6 @@ |
"description": "The constraints for this update.", |
"id": "Constraints", |
"properties": { |
- "maxDatabaseEntries": { |
- "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 between 2**10 and\n2**20. If zero, no database size limit is set.", |
- "format": "int32", |
- "type": "integer" |
- }, |
- "region": { |
- "description": "Requests the list for a specific geographic location. If not set the\nserver may pick that value based on the user's IP address. Expects ISO\n3166-1 alpha-2 format.", |
- "type": "string" |
- }, |
"supportedCompressions": { |
"description": "The compression types supported by the client.", |
"enumDescriptions": [ |
@@ -779,6 +862,15 @@ |
"description": "The maximum size in number of entries. The update 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.", |
"format": "int32", |
"type": "integer" |
+ }, |
+ "region": { |
+ "description": "Requests the list for a specific geographic location. If not set the\nserver may pick that value based on the user's IP address. Expects ISO\n3166-1 alpha-2 format.", |
+ "type": "string" |
+ }, |
+ "maxDatabaseEntries": { |
+ "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 between 2**10 and\n2**20. If zero, no database size limit is set.", |
+ "format": "int32", |
+ "type": "integer" |
} |
}, |
"type": "object" |
@@ -814,6 +906,10 @@ |
"format": "google-duration", |
"type": "string" |
}, |
+ "threatEntryMetadata": { |
+ "$ref": "ThreatEntryMetadata", |
+ "description": "Optional metadata associated with this threat." |
+ }, |
"threatType": { |
"description": "The threat type matching this threat.", |
"enum": [ |
@@ -834,10 +930,6 @@ |
], |
"type": "string" |
}, |
- "threatEntryMetadata": { |
- "$ref": "ThreatEntryMetadata", |
- "description": "Optional metadata associated with this threat." |
- }, |
"threat": { |
"$ref": "ThreatEntry", |
"description": "The threat matching this threat." |
@@ -888,16 +980,16 @@ |
"description": "The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or\ncompressed removal indices.", |
"id": "RiceDeltaEncoding", |
"properties": { |
- "firstValue": { |
- "description": "The offset of the first entry in the encoded data, or, if only a single\ninteger was encoded, that single integer's value.", |
- "format": "int64", |
- "type": "string" |
- }, |
"encodedData": { |
"description": "The encoded deltas that are encoded using the Golomb-Rice coder.", |
"format": "byte", |
"type": "string" |
}, |
+ "firstValue": { |
+ "description": "The offset of the first entry in the encoded data, or, if only a single\ninteger was encoded, that single integer's value.", |
+ "format": "int64", |
+ "type": "string" |
+ }, |
"numEntries": { |
"description": "The number of entries that are delta encoded in the encoded data. If only a\nsingle integer was encoded, this will be zero and the single value will be\nstored in `first_value`.", |
"format": "int32", |
@@ -944,98 +1036,6 @@ |
} |
}, |
"type": "object" |
- }, |
- "ThreatListDescriptor": { |
- "description": "Describes an individual threat list. A list is defined by three parameters:\nthe type of threat posed, the type of platform targeted by the threat, and\nthe type of entries in the list.", |
- "id": "ThreatListDescriptor", |
- "properties": { |
- "platformType": { |
- "description": "The platform type targeted by the list's entries.", |
- "enum": [ |
- "PLATFORM_TYPE_UNSPECIFIED", |
- "WINDOWS", |
- "LINUX", |
- "ANDROID", |
- "OSX", |
- "IOS", |
- "ANY_PLATFORM", |
- "ALL_PLATFORMS", |
- "CHROME" |
- ], |
- "enumDescriptions": [ |
- "Unknown platform.", |
- "Threat posed to Windows.", |
- "Threat posed to Linux.", |
- "Threat posed to Android.", |
- "Threat posed to OS X.", |
- "Threat posed to iOS.", |
- "Threat posed to at least one of the defined platforms.", |
- "Threat posed to all defined platforms.", |
- "Threat posed to Chrome." |
- ], |
- "type": "string" |
- }, |
- "threatType": { |
- "description": "The threat type posed by the list's entries.", |
- "enum": [ |
- "THREAT_TYPE_UNSPECIFIED", |
- "MALWARE", |
- "SOCIAL_ENGINEERING", |
- "UNWANTED_SOFTWARE", |
- "POTENTIALLY_HARMFUL_APPLICATION", |
- "MALICIOUS_BINARY" |
- ], |
- "enumDescriptions": [ |
- "Unknown.", |
- "Malware threat type.", |
- "Social engineering threat type.", |
- "Unwanted software threat type.", |
- "Potentially harmful application threat type.", |
- "Malicious binary threat type." |
- ], |
- "type": "string" |
- }, |
- "threatEntryType": { |
- "description": "The entry types contained in the list.", |
- "enum": [ |
- "THREAT_ENTRY_TYPE_UNSPECIFIED", |
- "URL", |
- "EXECUTABLE", |
- "IP_RANGE", |
- "CHROME_EXTENSION", |
- "FILENAME", |
- "CERT" |
- ], |
- "enumDescriptions": [ |
- "Unspecified.", |
- "A URL.", |
- "An executable program.", |
- "An IP range.", |
- "Chrome extension.", |
- "Filename.", |
- "CERT" |
- ], |
- "type": "string" |
- } |
- }, |
- "type": "object" |
- }, |
- "MetadataEntry": { |
- "description": "A single metadata entry.", |
- "id": "MetadataEntry", |
- "properties": { |
- "key": { |
- "description": "The metadata entry key. For JSON requests, the key is base64-encoded.", |
- "format": "byte", |
- "type": "string" |
- }, |
- "value": { |
- "description": "The metadata entry value. For JSON requests, the value is base64-encoded.", |
- "format": "byte", |
- "type": "string" |
- } |
- }, |
- "type": "object" |
} |
}, |
"servicePath": "", |