[GitHub] janl closed pull request #239: fixed source and target database instructions in the replication api

[GitBox <gi...@apache.org>]

janl closed pull request #239: fixed source and target database instructions in the replication api
URL: https://github.com/apache/couchdb-documentation/pull/239
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/src/api/server/common.rst b/src/api/server/common.rst
index 4cc31c8..e0c0963 100644
--- a/src/api/server/common.rst
+++ b/src/api/server/common.rst
@@ -484,11 +484,16 @@
     :<json string filter: The name of a :ref:`filter function <filterfun>`.
     :<json string proxy: Address of a proxy server through which replication
       should occur (protocol can be "http" or "socks5")
-    :<json string source: Source database name or URL
-    :<json string target: Target database name or URL
-    :<json object headers: Object with header info in key value pairs.
-      Eg: {"Authorization": "Basic Ym9iQGV4YW1wbGUuY29tOnBhc3N3b3Jk",
-      "header_name_2": "header_value_2",...}.
+    :<json string/object source: Source database name or URL or an object
+      which contains the full URL of the source database with additional
+      parameters like headers. Eg: 'source_db_name' or
+      'http://example.com/source_db_name' or
+      {"url":"url in here", "headers": {"header1":"value1", ...}}
+    :<json string/object target: Target database name or URL or an object
+      which contains the full URL of the target database with additional
+      parameters like headers. Eg: 'target_db_name' or
+      'http://example.com/target_db_name' or
+      {"url":"url in here", "headers": {"header1":"value1", ...}}
     :>header Content-Type: - :mimetype:`application/json`
                            - :mimetype:`text/plain; charset=utf-8`
     :>json array history: Replication history (see below)


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services