paul-rogers commented on a change in pull request #1892: Drill-7437: Storage
Plugin for Generic HTTP REST API
URL: https://github.com/apache/drill/pull/1892#discussion_r352253816
##########
File path: contrib/storage-http/README.md
##########
@@ -0,0 +1,31 @@
+
+# Generic API Storage Plugin
+This plugin is intended to enable you to query APIs over HTTP/REST. At this
point, the API reader will only accept JSON as input however in the future, it
may be possible to
+ add additional format readers to allow for APIs which return XML, CSV or
other formats.
+
+Note: This plugin should **NOT** be used for interacting with tools which
have REST APIs such as Splunk or Solr. It will not be performant for those use
cases.
+
+## Configuration
+To configure the plugin, create a new storage plugin, and add the following
configuration options:
+
+```
+{
+ "type": "http",
+ "connection": "https://api.sunrise-sunset.org/";,
+ "resultKey": "results",
+ "enabled": true
Review comment:
Many APIs require some form of security key. Sometimes set as a cookie,
sometimes embedded in the REST request.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
