Uploaded image for project: 'Couchbase Server'
  1. Couchbase Server
  2. MB-8347

[Doc'd] XDCR REST API endpoint is misspelled as "XCDR"

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 2.1.0
    • Fix Version/s: 2.1.0
    • Component/s: ns_server, XDCR
    • Security Level: Public
    • Labels:
      None

      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.

      # Subject Project Status CR V
      For Gerrit Dashboard: &For+MB-8347=message:MB-8347

        Activity

        junyi Junyi Xie (Inactive) created issue -
        Hide
        alkondratenko Aleksey Kondratenko (Inactive) added a comment -

        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.

        Show
        alkondratenko Aleksey Kondratenko (Inactive) added a comment - 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.
        alkondratenko Aleksey Kondratenko (Inactive) made changes -
        Field Original Value New Value
        Status Open [ 1 ] Resolved [ 5 ]
        Assignee Dipti Borkar [ dipti ] Aleksey Kondratenko [ alkondratenko ]
        Fix Version/s 2.0.2 [ 10418 ]
        Resolution Fixed [ 1 ]
        Hide
        alkondratenko Aleksey Kondratenko (Inactive) added a comment -

        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.

        Show
        alkondratenko Aleksey Kondratenko (Inactive) added a comment - 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.
        alkondratenko Aleksey Kondratenko (Inactive) made changes -
        Resolution Fixed [ 1 ]
        Status Resolved [ 5 ] Reopened [ 4 ]
        Assignee Aleksey Kondratenko [ alkondratenko ] Karen Zeller [ kzeller ]
        alkondratenko Aleksey Kondratenko (Inactive) made changes -
        Summary XDCR REST API endpoint is misspelled as "XCDR" [2.0.2 RN] XDCR REST API endpoint is misspelled as "XCDR"
        Hide
        dipti Dipti Borkar added a comment -

        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.

        Show
        dipti Dipti Borkar added a comment - 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.
        kzeller kzeller made changes -
        Component/s documentation [ 10012 ]
        Hide
        kzeller kzeller added a comment - - edited

        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

        Show
        kzeller kzeller added a comment - - edited 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
        kzeller kzeller made changes -
        Summary [2.0.2 RN] XDCR REST API endpoint is misspelled as "XCDR" [Doc'd] XDCR REST API endpoint is misspelled as "XCDR"
        kzeller kzeller made changes -
        Priority Critical [ 2 ] Minor [ 4 ]
        kzeller kzeller made changes -
        Status Reopened [ 4 ] Resolved [ 5 ]
        Resolution Fixed [ 1 ]
        kzeller kzeller made changes -
        Status Resolved [ 5 ] Closed [ 6 ]
        wayne Wayne Siu made changes -
        Component/s documentation-don't-use-put-in-doc-project [ 10012 ]

          People

          • Assignee:
            kzeller kzeller
            Reporter:
            junyi Junyi Xie (Inactive)
          • Votes:
            0 Vote for this issue
            Watchers:
            8 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Gerrit Reviews

              There are no open Gerrit changes