[MB-8347] [Doc'd] XDCR REST API endpoint is misspelled as "XCDR" Created: 23/May/13  Updated: 24/May/13  Resolved: 24/May/13

Status: Closed
Project: Couchbase Server
Component/s: cross-datacenter-replication, documentation, ns_server
Affects Version/s: 2.1.0
Fix Version/s: 2.1.0
Security Level: Public

Type: Bug Priority: Minor
Reporter: Junyi Xie (Inactive) Assignee: kzeller
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   
Hi Dipit,

The Couchbase manual should show the correct name of endpoints, but in kernel code, the endpoint is misspelled as XCDR in a few places, I am afraid this will

1) make users unable to use the correct endpoints if they follow the manual

2) if more and more users use incorrect endpoints, it would be more expensive for us to fix it later.

A patch has been uploaded to gerrit, please see review comments there.

http://review.couchbase.org/#/c/26472


Leave the decision to product management staff.

 Comments   
Comment by Aleksey Kondratenko [ 23/May/13 ]
Fixed via http://review.couchbase.org/#/c/26505/

Might be worth release notes. Probably not given that this path is not supposed to be documented or hardcoded but discovered. I.e. in order to cancel xdcr someone have to find it in tasks first and tasks entry will have full cancel path. If someone uses xdcr through that recommended path it will be 100% transparent change.
Comment by Aleksey Kondratenko [ 23/May/13 ]
No. Lets document. Release notes proposal:

One XDCR REST API endpoint had a typo which is now fixed.

I.e. /controller/cancelXCDR/:xid

typo is fixed now and correct path is:

/controller/cancelXDCR/:xid

Old path will continue to work for few more releases.

This change should not affect folks that take cancellation url that's "advertised" in xdcr task as recommended.
Comment by Dipti Borkar [ 23/May/13 ]
Team, please also try to add Karen as a watcher of the bug if you want doc changes. Its impossible to doc these minor things if she is not in the loop.
Comment by kzeller [ 24/May/13 ]
Ok added to 2.0.2 RN:


<rnentry type="fix">

<version ver="2.0.0m"/>

<class id="cmdline"/>

<issue type="cb" ref="MB-8347"/>


<rntext>

<para>
One XDCR REST API endpoint had a misspelling which is now fixed. The old endpoint was <literal>/controller/cancelXCDR/:xid</literal>. The new, correct endpoint is
<literal>/controller/cancelXDCR/:xid</literal>.

</para>


</rntext>

</rnentry>


------------

Added cross re to REST: See <xref linkend="couchbase-admin-restapi-xdcr-delete-repl">.

Updated endpoint in REST Chapter
Generated at Wed Jul 23 18:13:30 CDT 2014 using JIRA 5.2.4#845-sha1:c9f4cc41abe72fb236945343a1f485c2c844dac9.