on develop help sign in
Updating kgsearch service definition
2d792a6Brendan Hay
gen/model/kgsearch/v1/kgsearch-api.json+186−176
@@ -1,184 +1,194 @@
1{
1{
2− "kind": "discovery#restDescription",
3− "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/MyGIPHuwU0Ku04gaZJZTvYYLLEQ\"",
4− "discoveryVersion": "v1",
5− "id": "kgsearch:v1",
2+ "id": "kgsearch:v1",
6− "name": "kgsearch",
7− "version": "v1",
8− "revision": "20151215",
9− "title": "Knowledge Graph Search API",
10− "description": "Knowledge Graph Search API allows developers to search the Google Knowledge Graph for entities.",
3+ "description": "Searches the Google Knowledge Graph for entities.",
11− "ownerDomain": "google.com",
12− "ownerName": "Google",
13− "icons": {
14− "x16": "http://www.google.com/images/icons/product/search-16.gif",
15− "x32": "http://www.google.com/images/icons/product/search-32.gif"
16− },
17− "documentationLink": "https://developers.google.com/knowledge-graph/",
18− "protocol": "rest",
4+ "protocol": "rest",
19− "baseUrl": "https://kgsearch.googleapis.com/",
5+ "title": "Knowledge Graph Search API",
20− "basePath": "",
6+ "resources": {
21− "rootUrl": "https://kgsearch.googleapis.com/",
7+ "entities": {
22− "servicePath": "",
8+ "methods": {
23− "batchPath": "batch",
9+ "search": {
24− "version_module": true,
10+ "id": "kgsearch.entities.search",
25− "parameters": {
11+ "response": {
26− "access_token": {
12+ "$ref": "SearchResponse"
27− "type": "string",
13+ },
28− "description": "OAuth access token.",
14+ "parameterOrder": [],
29− "location": "query"
15+ "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",
30− },
16+ "flatPath": "v1/entities:search",
31− "alt": {
17+ "httpMethod": "GET",
32− "type": "string",
18+ "parameters": {
33− "description": "Data format for response.",
19+ "limit": {
34− "default": "json",
20+ "description": "Limits the number of entities to be returned.",
35− "enumDescriptions": [
36− "Responses with Content-Type of application/json",
37− "Media download with context-dependent Content-Type",
38− "Responses with Content-Type of application/x-protobuf"
39− ],
40− "location": "query"
41− },
42− "bearer_token": {
43− "type": "string",
44− "description": "OAuth bearer token.",
45− "location": "query"
46− },
47− "callback": {
48− "type": "string",
49− "description": "JSONP",
50− "location": "query"
51− },
52− "fields": {
53− "type": "string",
54− "description": "Selector specifying which fields to include in a partial response.",
55− "location": "query"
56− },
57− "key": {
58− "type": "string",
59− "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.",
60− "location": "query"
21+ "location": "query",
61− },
22+ "type": "integer",
62− "oauth_token": {
23+ "format": "int32"
63− "type": "string",
24+ },
64− "description": "OAuth 2.0 token for the current user.",
25+ "ids": {
65− "location": "query"
26+ "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",
66− },
27+ "repeated": true,
67− "pp": {
28+ "location": "query",
68− "type": "boolean",
29+ "type": "string"
69− "description": "Pretty-print response.",
30+ },
70− "default": "true",
31+ "prefix": {
71− "location": "query"
32+ "description": "Enables prefix match against names and aliases of entities",
33+ "location": "query",
34+ "type": "boolean"
72− },
35+ },
73− "prettyPrint": {
36+ "query": {
74− "type": "boolean",
37+ "description": "The literal query string for search.",
75− "description": "Returns response with indentations and line breaks.",
38+ "location": "query",
76− "default": "true",
39+ "type": "string"
77− "location": "query"
40+ },
41+ "indent": {
42+ "description": "Enables indenting of json results.",
43+ "location": "query",
44+ "type": "boolean"
78− },
45+ },
79− "quotaUser": {
46+ "types": {
80− "type": "string",
47+ "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.",
81− "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.",
48+ "repeated": true,
49+ "location": "query",
50+ "type": "string"
51+ },
52+ "languages": {
53+ "description": "The list of language codes (defined in ISO 693) to run the query with,\ne.g. 'en'.",
54+ "repeated": true,
82− "location": "query"
55+ "location": "query",
56+ "type": "string"
57+ }
58+ },
59+ "path": "v1/entities:search"
60+ }
61+ }
62+ }
83 },
63 },
84− "upload_protocol": {
64+ "schemas": {
65+ "SearchResponse": {
66+ "description": "Response message includes the context and a list of matching results\nwhich contain the detail of associated entities.",
85− "type": "string",
67+ "type": "object",
86− "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
68+ "properties": {
87− "location": "query"
69+ "@context": {
70+ "description": "The local context applicable for the response. See more details at\nhttp://www.w3.org/TR/json-ld/#context-definitions.",
71+ "type": "any"
72+ },
73+ "@type": {
74+ "description": "The schema type of top-level JSON-LD object, e.g. ItemList.",
75+ "type": "any"
76+ },
77+ "itemListElement": {
78+ "description": "The item list of search results.",
79+ "type": "array",
80+ "items": {
81+ "type": "any"
82+ }
83+ }
84+ },
85+ "id": "SearchResponse"
86+ }
88 },
87 },
89− "uploadType": {
88+ "revision": "20170109",
90− "type": "string",
89+ "basePath": "",
91− "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
90+ "icons": {
92− "location": "query"
91+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
92+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
93 },
93 },
94− "$.xgafv": {
94+ "version_module": "True",
95+ "discoveryVersion": "v1",
96+ "baseUrl": "https://kgsearch.googleapis.com/",
97+ "name": "kgsearch",
98+ "parameters": {
99+ "access_token": {
100+ "description": "OAuth access token.",
95− "type": "string",
101+ "type": "string",
96− "description": "V1 error format.",
97− "enumDescriptions": [
98− "v1 error format",
99− "v2 error format"
100− ],
101− "location": "query"
102+ "location": "query"
102− }
103− },
104− "schemas": {
105− "SearchResponse": {
106− "id": "SearchResponse",
107− "type": "object",
108− "description": "Response message includes the context and a list of matching results which contain the detail of associated entities.",
109− "properties": {
110− "context": {
111− "type": "any",
112− "description": "The local context applicable for the response. See more details at http://www.w3.org/TR/json-ld/#context-definitions."
113 },
103 },
114− "type": {
104+ "prettyPrint": {
115− "type": "any",
105+ "description": "Returns response with indentations and line breaks.",
116− "description": "The schema type of top-level JSON-LD object, e.g. ItemList."
106+ "default": "true",
107+ "type": "boolean",
108+ "location": "query"
117 },
109 },
118− "itemListElement": {
110+ "key": {
119− "type": "array",
111+ "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.",
120− "description": "The item list of search results.",
112+ "type": "string",
121− "items": {
113+ "location": "query"
122− "type": "any"
114+ },
123− }
115+ "quotaUser": {
124− }
116+ "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.",
125− }
117+ "type": "string",
126− }
118+ "location": "query"
127− },
119+ },
128− "resources": {
120+ "pp": {
129− "entities": {
121+ "description": "Pretty-print response.",
130− "methods": {
122+ "default": "true",
131− "search": {
123+ "type": "boolean",
132− "id": "kgsearch.entities.search",
124+ "location": "query"
133− "path": "v1/entities:search",
125+ },
134− "httpMethod": "GET",
126+ "fields": {
135− "description": "Searches Knowledge Graph for entities that match the constraints. A list of matched entities will be returned in response, which will be in JSON-LD format and compatible with http://schema.org",
127+ "description": "Selector specifying which fields to include in a partial response.",
136− "parameters": {
137− "query": {
138− "type": "string",
128+ "type": "string",
139− "description": "The literal query string for search.",
140− "location": "query"
129+ "location": "query"
141− },
130+ },
142− "ids": {
131+ "alt": {
143− "type": "string",
132+ "description": "Data format for response.",
144− "description": "The list of entity id to be used for search instead of query string.",
145− "repeated": true,
146− "location": "query"
133+ "location": "query",
147− },
134+ "enum": [
148− "languages": {
135+ "json",
149− "type": "string",
136+ "media",
150− "description": "The list of language codes (defined in ISO 693) to run the query with, e.g. 'en'.",
137+ "proto"
151− "repeated": true,
152− "location": "query"
153− },
138+ ],
154− "types": {
139+ "default": "json",
155− "type": "string",
140+ "enumDescriptions": [
156− "description": "Restricts returned entities with these types, e.g. Person (as defined in http://schema.org/Person).",
141+ "Responses with Content-Type of application/json",
157− "repeated": true,
142+ "Media download with context-dependent Content-Type",
158− "location": "query"
143+ "Responses with Content-Type of application/x-protobuf"
159− },
160− "indent": {
161− "type": "boolean",
162− "description": "Enables indenting of json results.",
163− "location": "query"
164− },
165− "prefix": {
166− "type": "boolean",
167− "description": "Enables prefix match against names and aliases of entities",
168− "location": "query"
169− },
144+ ],
170− "limit": {
145+ "type": "string"
171− "type": "integer",
172− "description": "Limits the number of entities to be returned.",
173− "format": "int32",
174− "location": "query"
175− }
176− },
146+ },
177− "response": {
147+ "$.xgafv": {
178− "$ref": "SearchResponse"
148+ "description": "V1 error format.",
149+ "enum": [
150+ "1",
151+ "2"
152+ ],
153+ "enumDescriptions": [
154+ "v1 error format",
155+ "v2 error format"
156+ ],
157+ "type": "string",
158+ "location": "query"
179− }
159+ },
160+ "callback": {
161+ "description": "JSONP",
162+ "type": "string",
163+ "location": "query"
164+ },
165+ "oauth_token": {
166+ "description": "OAuth 2.0 token for the current user.",
167+ "type": "string",
168+ "location": "query"
169+ },
170+ "uploadType": {
171+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
172+ "type": "string",
173+ "location": "query"
174+ },
175+ "bearer_token": {
176+ "description": "OAuth bearer token.",
177+ "type": "string",
178+ "location": "query"
179+ },
180+ "upload_protocol": {
181+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
182+ "type": "string",
183+ "location": "query"
180 }
184 }
181− }
185+ },
182− }
186+ "documentationLink": "https://developers.google.com/knowledge-graph/",
183− }
187+ "ownerDomain": "google.com",
188+ "batchPath": "batch",
189+ "servicePath": "",
190+ "ownerName": "Google",
191+ "version": "v1",
192+ "rootUrl": "https://kgsearch.googleapis.com/",
193+ "kind": "discovery#restDescription"
184}
194}