Repository: sqoop Updated Branches: refs/heads/sqoop2 1c6a8f4d6 -> 5b83a6b66
SQOOP-2923: Sqoop2: Reword documentation to make it clear that the api endpoints fall under /sqoop (Abraham Fine via Jarek Jarcec Cecho) Project: http://git-wip-us.apache.org/repos/asf/sqoop/repo Commit: http://git-wip-us.apache.org/repos/asf/sqoop/commit/5b83a6b6 Tree: http://git-wip-us.apache.org/repos/asf/sqoop/tree/5b83a6b6 Diff: http://git-wip-us.apache.org/repos/asf/sqoop/diff/5b83a6b6 Branch: refs/heads/sqoop2 Commit: 5b83a6b66c8ed528534a57bff95108f9abb0082a Parents: 1c6a8f4 Author: Jarek Jarcec Cecho <[email protected]> Authored: Wed May 18 11:52:07 2016 -0700 Committer: Jarek Jarcec Cecho <[email protected]> Committed: Wed May 18 11:52:07 2016 -0700 ---------------------------------------------------------------------- docs/src/site/sphinx/dev/RESTAPI.rst | 7 ++++++- docs/src/site/sphinx/security/API TLS-SSL.rst | 2 ++ 2 files changed, 8 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/sqoop/blob/5b83a6b6/docs/src/site/sphinx/dev/RESTAPI.rst ---------------------------------------------------------------------- diff --git a/docs/src/site/sphinx/dev/RESTAPI.rst b/docs/src/site/sphinx/dev/RESTAPI.rst index 7929b28..a7d0139 100644 --- a/docs/src/site/sphinx/dev/RESTAPI.rst +++ b/docs/src/site/sphinx/dev/RESTAPI.rst @@ -27,7 +27,12 @@ Initialization Before continuing further, make sure that the Sqoop server is running. -Then find out the details of the Sqoop server: ``host``, ``port`` and ``webapp``, and keep them in mind. Note that the sqoop server is running on Jetty. To exercise a REST API for Sqoop, you could assemble and send a HTTP request to an url corresponding to that API. Generally, the url contains the ``host`` on which the sqoop server is running, the ``port`` at which the sqoop server is listening to and ``webapp``, the context path at which the Sqoop server is registered in the Jetty engine. +The Sqoop 2 server exposes its REST API via Jetty. By default the server is accessible over HTTP but it can be configured to use HTTPS, please see: :ref:`apitlsssl` for more information. The endpoints are registered under the ``/sqoop`` path and the port is configurable (the default is 12000). For example, if the host running the Sqoop 2 server is ``example.com`` and we are using the default port, we can reach the version endpoint by sending a GET request to: + + :: + + http://example.com:12000/sqoop/v1/version + Certain requests might need to contain some additional query parameters and post data. These parameters could be given via the HTTP headers, request body or both. All the content in the HTTP body is in ``JSON`` format. http://git-wip-us.apache.org/repos/asf/sqoop/blob/5b83a6b6/docs/src/site/sphinx/security/API TLS-SSL.rst ---------------------------------------------------------------------- diff --git a/docs/src/site/sphinx/security/API TLS-SSL.rst b/docs/src/site/sphinx/security/API TLS-SSL.rst index e3eed0c..f68d67c 100644 --- a/docs/src/site/sphinx/security/API TLS-SSL.rst +++ b/docs/src/site/sphinx/security/API TLS-SSL.rst @@ -14,6 +14,8 @@ limitations under the License. +.. _apitlsssl: + =========== API TLS/SSL ===========
