restic/vendor/google.golang.org/api/kgsearch/v1/kgsearch-api.json
2017-08-06 21:47:56 +02:00

194 lines
6.3 KiB
JSON

{
"kind": "discovery#restDescription",
"description": "Searches the Google Knowledge Graph for entities.",
"servicePath": "",
"rootUrl": "https://kgsearch.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "kgsearch",
"batchPath": "batch",
"id": "kgsearch:v1",
"documentationLink": "https://developers.google.com/knowledge-graph/",
"revision": "20170109",
"title": "Knowledge Graph Search API",
"ownerName": "Google",
"discoveryVersion": "v1",
"version_module": "True",
"resources": {
"entities": {
"methods": {
"search": {
"description": "Searches Knowledge Graph for entities that match the constraints.\nA list of matched entities will be returned in response, which will be in\nJSON-LD format and compatible with http://schema.org",
"response": {
"$ref": "SearchResponse"
},
"parameterOrder": [],
"httpMethod": "GET",
"parameters": {
"limit": {
"location": "query",
"format": "int32",
"description": "Limits the number of entities to be returned.",
"type": "integer"
},
"prefix": {
"location": "query",
"description": "Enables prefix match against names and aliases of entities",
"type": "boolean"
},
"query": {
"description": "The literal query string for search.",
"type": "string",
"location": "query"
},
"types": {
"type": "string",
"repeated": true,
"location": "query",
"description": "Restricts returned entities with these types, e.g. Person\n(as defined in http://schema.org/Person). If multiple types are specified,\nreturned entities will contain one or more of these types."
},
"indent": {
"location": "query",
"description": "Enables indenting of json results.",
"type": "boolean"
},
"languages": {
"repeated": true,
"location": "query",
"description": "The list of language codes (defined in ISO 693) to run the query with,\ne.g. 'en'.",
"type": "string"
},
"ids": {
"location": "query",
"description": "The list of entity id to be used for search instead of query string.\nTo specify multiple ids in the HTTP request, repeat the parameter in the\nURL as in ...?ids=A&ids=B",
"type": "string",
"repeated": true
}
},
"flatPath": "v1/entities:search",
"id": "kgsearch.entities.search",
"path": "v1/entities:search"
}
}
}
},
"parameters": {
"access_token": {
"location": "query",
"description": "OAuth access token.",
"type": "string"
},
"key": {
"type": "string",
"location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"quotaUser": {
"location": "query",
"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.",
"type": "string"
},
"pp": {
"description": "Pretty-print response.",
"default": "true",
"type": "boolean",
"location": "query"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
"bearer_token": {
"description": "OAuth bearer token.",
"type": "string",
"location": "query"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
"default": "true",
"type": "boolean",
"location": "query"
},
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
"callback": {
"description": "JSONP",
"type": "string",
"location": "query"
},
"$.xgafv": {
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
"type": "string"
},
"alt": {
"location": "query",
"description": "Data format for response.",
"default": "json",
"enum": [
"json",
"media",
"proto"
],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
]
}
},
"schemas": {
"SearchResponse": {
"description": "Response message includes the context and a list of matching results\nwhich contain the detail of associated entities.",
"type": "object",
"properties": {
"itemListElement": {
"description": "The item list of search results.",
"items": {
"type": "any"
},
"type": "array"
},
"@context": {
"description": "The local context applicable for the response. See more details at\nhttp://www.w3.org/TR/json-ld/#context-definitions.",
"type": "any"
},
"@type": {
"description": "The schema type of top-level JSON-LD object, e.g. ItemList.",
"type": "any"
}
},
"id": "SearchResponse"
}
},
"protocol": "rest",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"version": "v1",
"baseUrl": "https://kgsearch.googleapis.com/"
}